你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
诊断日志设置参考：API 管理
适用于：所有 API 管理层级
本参考文章介绍 API 管理实例中 API 诊断日志记录的设置。 若要启用 API 请求的日志记录，请参阅以下指南：
注意
某些设置（在注明的情况下）仅适用于 Application Insights 的日志记录。
| 设置 | 类型 | 说明 |
|---|---|---|
| 启用 | boolean | 指定是否要启用此 API 的日志记录。 可以为所有 API 或单个 API 启用日志记录。 单个 API 的设置会替代所有 API 的设置（如果已启用）。 |
| 目标 | Azure Application Insights 记录器 | 指定要用于 Application Insights 日志记录的记录器。 |
| 采样率 | decimal | 值为 0 到 100（百分比）。 指定记录的请求的百分比。 0% 采样表示不记录任何请求，100% 采样表示记录所有请求。 默认值：100 有关 Application Insights 日志记录的性能影响，请参阅性能影响和日志采样。 |
| 始终记录错误 | boolean | 如果启用此设置，则会记录所有失败，不管“采样”设置如何。 |
| 记录客户端 IP 地址 | boolean | 如果启用此设置，则会记录 API 请求的客户端 IP 地址。 |
| 详细程度 | 指定日志的详细程度以及是否记录在跟踪策略中配置的自定义跟踪。 * 错误 - 失败的请求和严重性为“ error”的自定义跟踪* 信息 - 失败的和成功的请求，以及严重性为“ error”和“information”的自定义跟踪* 详细 - 失败的和成功的请求，以及严重性为“ error”、“information”和“verbose”的自定义跟踪默认值：信息 |
|
| 关联协议 | 指定用于关联由多个组件发送到 Application Insights 的遥测数据的协议。 默认值：旧版 有关信息，请参阅 Application Insights 中的遥测关联。 |
|
| 要记录的头 | list | 指定要记录的请求头和响应头。 默认值：不记录标头。 |
| 要记录的有效负载（正文）字节数 | integer | 指定记录的前端或后端请求或响应正文的初始字节数。 最大值：8,192。 默认值：0 |
| 前端请求 | 指定是否记录以及如何记录前端请求（传入到 API 管理网关的请求）。 如果启用了此设置，请指定“要记录的头”和/或“要记录的有效负载字节数”。 |
|
| 前端响应 | 指定是否记录以及如何记录前端响应（从 API 管理网关传出的响应）。 如果启用了此设置，请指定“要记录的头”和/或“要记录的有效负载字节数”。 |
|
| 后端请求 | 指定是否记录以及如何记录后端请求（从 API 管理网关传出的请求）。 如果启用了此设置，请指定“要记录的头”和/或“要记录的有效负载字节数”。 |
|
| 后端响应 | 指定是否记录以及如何记录后端响应（传入到 API 管理网关的响应）。 如果启用了此设置，请指定“要记录的头”和/或“要记录的有效负载字节数”。 |
重要
如果启用，则记录的请求或响应有效负载最多可为 8,192 字节。 API 管理还对发送到 Azure Monitor 的诊断日志条目强制实施 32 KB 限制，这包括有效负载和其他属性（如状态代码、标头和时间戳）。 如果属性的组合大小超过 32 KB，API 管理则会删除所有正文和跟踪内容来剪裁条目。