リクエストコードとレスポンスコードの相関 ID との照合

相関 ID を使用して特定のリクエストと特定のレスポンスを照合することで、内部サーバーエラーなど予期せぬ問題のトラブルシューティングを簡単に行えるようになります。

SCAPI エンドポイントへのリクエストで correlation-id ヘッダーが渡された場合、レスポンスには correlation-id の値を含む x-correlation-id ヘッダーが含められます。また、API によって、各レスポンスのための独自の相関 ID が生成されます。x-correlation-id ヘッダーで渡される文字列は、ユーザーが指定する相関 ID と SCAPI が生成する相関 ID をコンマで区切って組み合わせたものになります。

ヘッダーの例:

correlation-id の値はユニバーサルに一意の識別子 (UUID) であり、かつ UUID 規格バージョン 4 に従っていなければなりません。3 つのハイフンを含む 36 文字に従うことが必要です。書式の詳細については、ウィキペディアの Universally unique identifier の記事 (日本語版記事タイトルは「UUID」) を参照してください。

SCAPI によって生成される相関 ID の方が短く、UUID 規格に準拠していません。

大部分の Commerce API エンドポイントで、correlation-id はフックとともにログメッセージに自動的に追加されます。これらのメッセージは、Log Center で、externalID フィールドに基いてメッセージをフィルターする LCQL (Log Center Query Language) 式でクエリできます。externalID フィールドには x-correlation-id ヘッダーの値が含まれているため、ユーザーが指定した相関 ID、SCAPI によって生成された相関 ID、または組み合わせ文字列をクエリできます。

sfdc_verbose ヘッダーを correlation-id と組み合わせて使用すると、Log Center で詳細ログ出力を生成および検索できます。