メインコンテンツまでスキップ

Stdout Log

概要​

stdout-logポリシーは、APIリクエストおよびレスポンスデータをコンソール（標準出力）にログするために使用されます。リクエスト処理中のヘッダー、ボディ、およびカスタムフィールドの詳細なログを提供します。これは、特に障害の診断やサービス間のデータフローの追跡に役立つため、デバッグや監視の目的に有用です。ただし、大きなリクエスト/レスポンスペイロードをログすることは、パフォーマンスの問題や過剰なログボリュームにつながる可能性があるため、注意が必要です。

このポリシーは、フルボディ、ヘッダー、またはエラーレスポンスのみを選択的にログすることができ、カスタムフィールドの挿入と機密データのマスキングの両方をサポートしています。

設定の詳細​

フィールドタイプ説明
withBodyLogトグル有効にすると、リクエストとレスポンスの両方のボディをログします。大きなログボリュームにつながる可能性があります。
withHeaderLogトグル有効にすると、リクエストヘッダーをログします。
withErrorBodyLogトグル有効にすると、失敗したレスポンス（HTTPステータスコード >= 300）のみのリクエスト/レスポンスボディをログします。
customFieldsJSONエディタログデータに追加のカスタムフィールドを挿入することを許可します。値は有効なJSONでなければなりません。例: "request_uri": "xyz"
maskingFieldsフォームプライバシーのためにログでマスキングされるフィールドを定義します。リクエストボディ、レスポンスボディ、またはリクエストヘッダーに適用されます。withBodyLogまたはwithHeaderLogを有効にする必要があります。
注記

変更できません: このポリシーが削除されるのを防ぐためのトグル。

設定値を変更できません: セットアップ後に構成値の変更を防ぐためのトグル。

もしwithBodyLogまたはwithHeaderLogが無効になっている間にマスキングがまだアクティブな場合、ログの不整合を避けるためにマスキングルールの削除を提案する警告モーダルが表示されます。

マスキングフィールドオプション​

各マスキングルールには以下が必要です：

  • タイプ：リクエストボディ、レスポンスボディ、またはリクエストヘッダーのいずれか。
  • フィールド名：マスキングするフィールド（例：account、phone）。
  • マスキング値：フィールドを置き換える値（例：***またはマスキングパターン）。

ユーザーは青い追加ボタンをクリックして新しいマスキングフィールドを追加するか、対応するフィールドの赤いマイナスボタンをクリックして削除できます。

例​

すべてのペイロードのログ​

"withBodyLog": true,
"withHeaderLog": true,
"withErrorBodyLog": false
  • すべてのリクエストのリクエストおよびレスポンスボディとすべてのヘッダーをログに記録します。
  • 開発環境に適しています。

エラーのみのログ​

"withErrorBodyLog": true
  • レスポンスステータスが300以上の場合のみ、ボディとヘッダーをログに記録します。
  • 重要なエラーをキャプチャしながらログのボリュームを削減するのに役立ちます。

ログ内のカスタムフィールド​

{
	"customFields": {
	"request_id": "abc123",
	"env": "staging"
	}
}
  • 各ログエントリにカスタムメタデータを追加します。

機密情報のマスキング​

タイプフィールドマスキング値
リクエストボディaccount*****
リクエストボディphone010--

これらの値は、ログに記録されたリクエスト/レスポンスボディ出力で自動的にマスキングされます。