診断ログ設定のリファレンス: API Management
適用対象: すべての API Management レベル
このリファレンスでは、API Management インスタンスからの API 診断ログ記録の設定について説明します。 API 要求のログ記録を有効にするには、次のガイダンスを参照してください。
Note
一部の設定 (明記されている場合) は、Application Insights へのログ記録にのみ適用されます。
| 設定 | Type | 説明 |
|---|---|---|
| 有効化 | boolean | この API のログ記録が有効になっているかどうかを指定します。 ログ記録は、すべての API に対してまたは個々の API に対して有効にすることができます。 個々の API に対する設定は、すべての API に対する設定 (有効になっている場合) をオーバーライドします。 |
| 宛先 | Azure Application Insights ロガー | Application Insights のログ記録に使用されるロガーを指定します。 |
| [Sampling (%)](サンプリング (%)) | decimal | 0 から 100 までの値 (パーセント)。 ログに記録される要求の割合を指定します。 0% サンプリングの場合、要求はまったく記録されません。100% サンプリングの場合、すべての要求が記録されます。 既定値は100 Application Insights のログ記録がもたらすパフォーマンス上の影響については、「パフォーマンス上の影響とログ サンプリング」を参照してください。 |
| [Always log errors](エラーは常に記録する) | boolean | この設定が有効になっている場合は、[サンプリング] 設定に関係なく、すべての失敗がログに記録されます。 |
| [Log client IP address](クライアント IP アドレスを記録する) | boolean | この設定が有効になっている場合は、API 要求のクライアント IP アドレスがログに記録されます。 |
| 詳細度 | ログの詳細度と、トレース ポリシーで構成されているカスタム トレースがログに記録されるかどうかを指定します。 * エラー - 失敗した要求、および重大度 error のカスタム トレース* 情報 - 失敗した要求と成功した要求、および重大度 error と information のカスタム トレース* 詳細 - 失敗した要求と成功した要求、および重大度 error、information、verbose のカスタム トレース既定値: 情報 |
|
| [Correlation protocol](相関プロトコル) | 複数のコンポーネントによって送信されたテレメトリを Application Insights に関連付けるために使用されるプロトコルを指定します。 既定値: レガシ 詳細については、「Application Insights におけるテレメトリの相関付け」を参照してください。 |
|
| [Headers to log] (ログに記録するヘッダー) | list | 要求と応答についてログに記録されるヘッダーを指定します。 既定値: ヘッダーはログに記録されません。 |
| ログに記録するペイロード (本文) バイト数 | integer | ログに記録されるフロントエンドまたはバックエンド要求または応答本文の初期バイト数を指定します。 最大: 8,192。 既定値は0 |
| [Frontend Request](フロントエンド要求) | "フロントエンド要求" (API Management ゲートウェイで受信される要求) がログに記録されるかどうか、およびその方法を指定します。 この設定が有効になっている場合は、[Headers to log] (ログに記録するヘッダー)、[Number of payload bytes to log] (ログに記録するペイロードのバイト数)、またはその両方を指定します。 |
|
| [Frontend Response](フロントエンド応答) | "フロントエンド応答" (API Management ゲートウェイから送信される応答) がログに記録されるかどうか、およびその方法を指定します。 この設定が有効になっている場合は、[Headers to log] (ログに記録するヘッダー)、[Number of payload bytes to log] (ログに記録するペイロードのバイト数)、またはその両方を指定します。 |
|
| [Backend Request](バックエンド要求) | "バックエンド要求" (API Management ゲートウェイから送信される要求) がログに記録されるかどうか、およびその方法を指定します。 この設定が有効になっている場合は、[Headers to log] (ログに記録するヘッダー)、[Number of payload bytes to log] (ログに記録するペイロードのバイト数)、またはその両方を指定します。 |
|
| [Backend Response](バックエンド応答) | "バックエンド応答" (API Management ゲートウェイで受信される応答) がログに記録されるかどうか、およびその方法を指定します。 この設定が有効になっている場合は、[Headers to log] (ログに記録するヘッダー)、[Number of payload bytes to log] (ログに記録するペイロードのバイト数)、またはその両方を指定します。 |
重要
有効にすると、ログされる要求または応答のペイロードは最大 8,192 バイトになります。 API Management では、Azure Monitor に送信される診断ログ エントリに対して 32 KB の制限も適用されます。これには、ペイロードと、状態コード、ヘッダー、タイムスタンプなどのその他の属性が含まれます。 属性の合計サイズが 32 KB を超える場合、API Management はすべての本文とトレースのコンテンツを削除してエントリをトリミングします。