追蹤

  • 發行項

適用於：所有 API 管理 層

trace 原則會將自訂追蹤新增至測試主控台、Application Insights 遙測和/或資源記錄中。

  • 原則會在追蹤觸發時將自訂追蹤新增至要求追蹤，也就是會顯示 Ocp-Apim-Trace 要求標頭並將其設定為 true，並且顯示 Ocp-Apim-Subscription-Key 要求標頭，其中包含允許追蹤的有效金鑰。
  • Application Insights 整合啟用時，若原則中指定的 severity 大於或等於診斷設定中指定的 verbosity 時，原則就會在 Application Insights 中建立追蹤遙測。
  • 資源記錄啟用時，若原則中指定的嚴重性層級高於或等於診斷設定中指定的詳細程度層級，原則就會在記錄項目中新增屬性。
  • 此原則不會受到 Application Insights 取樣的影響。 系統會記錄所有原則呼叫。

警告

  • 僅允許追蹤用於偵錯用途的訂用帳戶。 與未經授權的使用者共用允許追蹤的共用訂用帳戶金鑰，可能會揭露追蹤記錄中包含的敏感性資訊，例如金鑰、存取權杖、密碼、內部主機名稱和 IP 位址。
  • 在測試控制台中，API 管理 在訂用帳戶上啟用追蹤 1 小時後自動停用追蹤。

注意

目前，基本 v2 和標準 v2 層不支援 API 要求追蹤。

注意

請依照原則陳述式中提供的順序，來設定原則的元素和子元素。 深入了解如何設定或編輯 APIM 原則。

原則陳述式

<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>

屬性

屬性 描述 是必要欄位 預設
來源 對追蹤檢視器有意義，並指定了訊息來源的字串常值。 不允許使用原則運算式。 Yes N/A
severity 指定追蹤的嚴重性層級。 允許的值為 verbose、information、error (從最低到最高)。 不允許使用原則運算式。 No verbose

元素

名稱 描述 必要
message 要記錄的字串或運算式。 允許使用原則運算式。 Yes
中繼資料 將自訂屬性新增至 Application Insights 追蹤遙測。 No

中繼資料屬性

屬性 描述 是必要欄位 預設
NAME 屬性的名稱。 Yes N/A
value 屬性的值。 Yes N/A

使用方式

範例

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

相關內容

如需使用原則的詳細資訊，請參閱：