通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

跟踪

  • 项目

适用于：所有 API 管理层级

trace 策略将自定义跟踪添加到测试控制台、Application Insights 遥测和/或资源日志中的请求跟踪输出中。

  • 触发跟踪时，该策略将自定义跟踪添加到测试控制台中的请求跟踪输出中。
  • 当 Application Insights 集成已启用并且此策略中指定的 severity 等于或大于诊断设置中指定的 verbosity 时，此策略会在 Application Insights 中创建跟踪遥测。
  • 当启用资源日志并且策略中指定的严重级别等于或高于诊断设置中指定的详细级别时，策略将在日志条目中添加属性。
  • 该策略不受 Application Insights 采样的影响。 策略的所有调用都会被记录。

重要

  • API 管理不再支持用于跟踪或 Ocp-Apim-Trace 标头。
  • 为了提高安全性，现在可以通过以下方法在单个 API 级别启用跟踪：使用 API 管理 REST API 获取限时令牌，并在请求中将该令牌传递到网关。 有关详细信息，请参阅启用 API 跟踪。
  • 启用跟踪时请务必小心，因为这可能会泄露跟踪数据中的敏感信息。 确保已采取适当的安全措施来保护跟踪数据。

注意

按照策略声明中提供的顺序设置策略的元素和子元素。 详细了解如何设置或编辑 API 管理策略。

策略语句

<trace source="arbitrary string literal" severity="verbose | information | error">
    <message>String literal or expressions</message>
    <metadata name="string literal or expressions" value="string literal or expressions"/>
</trace>

属性

属性 说明 需要 默认
source 对跟踪查看器有意义的字符串文本，指定消息的源。 不允许使用策略表达式。 是 空值
severity 指定跟踪的严重性级别。 允许的值为 verbose、information、error（从低到高）。 不允许使用策略表达式。 否 verbose

元素

名称 说明 必需
message 要记录的字符串或表达式。 允许使用策略表达式。 是
metadata 将自定义属性添加到 Application Insights 跟踪遥测。 否

元数据属性

属性 说明 需要 默认
name 属性的名称。 是 空值
value 属性的名称。 是 空值

使用情况

示例

<trace source="PetStore API" severity="verbose">
    <message>@((string)context.Variables["clientConnectionID"])</message>
    <metadata name="Operation Name" value="New-Order"/>
</trace>

相关内容

有关使用策略的详细信息，请参阅：