Trace
trace ポリシーでは、テスト コンソール、Application Insights テレメトリ、リソース ログの要求トレース出力にカスタム トレースを追加します。
- トレースがトリガーされたときに、ポリシーによってテスト コンソールの要求トレース出力にカスタム トレースが追加されます。つまり、
Ocp-Apim-Trace要求ヘッダーが存在し、trueに設定され、Ocp-Apim-Subscription-Key要求ヘッダーが存在し、トレースを許可する有効なキーが保持されます。 - Application Insights の統合が有効で、ポリシーに指定されている が診断設定に指定されている 以上である場合、このポリシーによって Application Insights にトレース テレメトリが作成されます。
- リソース ログが有効で、ポリシーに指定されている重大度レベルが診断設定に指定されている詳細レベル以上である場合、このポリシーによってログ エントリにプロパティが追加されます。
- このポリシーは、Application Insights のサンプリングの影響は受けません。 ポリシーのすべての呼び出しがログに記録されます。
警告
- デバッグの目的でのみサブスクリプションのトレースを許可します。 トレースが許可されたサブスクリプション キーを承認されていないユーザーと共有すると、キー、アクセス トークン、パスワード、内部ホスト名、IP アドレスなどのトレース ログに含まれる機密情報が漏えいする可能性があります。
- API Management により、トレースはサブスクリプションで有効になってから 1 時間後に自動的に無効になります。
注意
ポリシーの要素と子要素を、ポリシー ステートメントで指定された順序で設定します。 API Management ポリシーを設定または編集する方法について説明します。
ポリシー ステートメント
<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>
属性
| 属性 | 説明 | 必須 | Default |
|---|---|---|---|
| source | メッセージのソースを指定する、トレース ビューアーにとって意味のある文字列リテラル。 | はい | 該当なし |
| severity | トレースの重大度レベルを指定します。 使用できる値は、verbose、information、error (最低から最高) です。 |
No | verbose |
要素
| 名前 | 説明 | 必須 |
|---|---|---|
| message | ログに記録される文字列または式。 | Yes |
| metadata | カスタム プロパティを Application Insights のトレース テレメトリに追加します。 | No |
metadata の属性
| 属性 | 説明 | 必須 | Default |
|---|---|---|---|
| name | プロパティ名。 | はい | 該当なし |
| value | プロパティの値。 | はい | なし |
使用法
- ポリシー セクション: inbound、outbound、backend
- ポリシー スコープ: グローバル、製品、API、操作
- ゲートウェイ: 専用、従量課金、セルフホステッド
例
<trace source="PetStore API" severity="verbose">
<message>@((string)context.Variables["clientConnectionID"])</message>
<metadata name="Operation Name" value="New-Order"/>
</trace>
関連ポリシー
次のステップ
ポリシーに対する処理の詳細については、次のトピックを参照してください。
- チュートリアル:API を変換および保護する
- ポリシー ステートメントとその設定の一覧に関するポリシー リファレンス
- ポリシー式
- ポリシーの設定または編集
- ポリシー構成を再利用する
- ポリシーのサンプル