跟踪

  • 项目

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

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

警告

  • 仅允许跟踪用于调试目的的订阅。 与未经授权的用户共享允许跟踪的订阅密钥，可能会导致跟踪日志中包含的敏感信息泄露，例如密钥、访问令牌、密码、内部主机名和 IP 地址。
  • 在订阅上启用跟踪 1 小时后，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>

后续步骤

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