Amazon EventBridge Pipes のログ記録

EventBridge Pipes ログ記録を使用すると、 EventBridge パイプのパフォーマンスを詳細に説明したレコードをサポートされている AWS のサービスに送信できます。ログを使用して得たパイプの実行パフォーマンスへのインサイトを、トラブルシューティングやデバッグに役立てることができます。

EventBridge Pipes がレコードを配信するログ送信先として、次の AWS サービスを選択できます。

• CloudWatch ログ

  EventBridge は、指定された Logs CloudWatch ロググループにログレコードを配信します。

  CloudWatch Logs を使用して、使用するすべてのシステム、アプリケーション、および AWS サービスのログを 1 つの高度にスケーラブルなサービスに一元化します。詳細については、「Amazon Logs ユーザーガイド」の「ロググループとログストリームの操作」を参照してください。 CloudWatch

• Firehose ストリームログ

  EventBridge は、Firehose 配信ストリームにログレコードを配信します。

  Amazon Data Firehose は、特定のサービス、およびサポートされているサードパーティーサービスプロバイダーが所有する AWS カスタム HTTP エンドポイントや HTTP エンドポイントなどの宛先にリアルタイムのストリーミングデータを配信するためのフルマネージドサービスです。詳細については、「Amazon Data Firehose ユーザーガイド」の「Amazon Data Firehose 配信ストリームの作成」を参照してください。

• Amazon S3 ログ

  EventBridge は、ログレコードを Amazon S3 オブジェクトとして指定されたバケットに配信します。

  Amazon S3 は、業界をリードするスケーラビリティ、データ可用性、セキュリティ、パフォーマンスを提供するオブジェクトストレージサービスです。詳細については、「Amazon Simple Storage Service ユーザーガイド」の「Amazon S3 でのオブジェクトのアップロード、ダウンロード、操作」を参照してください。

Amazon EventBridge Pipes ログ記録の仕組み

パイプの実行は、パイプによって受信され、エンリッチメントやターゲットに送信されるイベントまたはイベントのバッチです。有効にすると、イベントバッチが処理されるときに実行する実行ステップごとにログレコード EventBridge が生成されます。レコード内の情報は、イベントバッチ (単一のイベントから最大 10,000 までのイベント) に適用されます。

パイプのソースとターゲットでイベントバッチのサイズを設定できます。詳細については、「Amazon EventBridge Pipes のバッチ処理と同時実行」を参照してください。

各ログ送信先に送信されるレコードデータは同じです。

Amazon CloudWatch Logs の送信先が設定されている場合、すべての送信先に配信されるログレコードの制限は 256 KB です。フィールドは必要に応じて切り捨てられます。

選択したログ送信先に EventBridge 送信されるレコードは、次の方法でカスタマイズできます。

• ログレベル を指定できます。これにより、 が選択したログの送信先にレコード EventBridge を送信する実行ステップが決まります。詳細については、「 EventBridge Pipes ログレベルの指定」を参照してください。

• EventBridge Pipes が関連する実行ステップの実行データをレコードに含めるかどうかを指定できます。これには、以下のデータが含まれます。

  • イベントバッチのペイロード

  • AWS エンリッチメントまたはターゲットサービスに送信されたリクエスト

  • エン AWS リッチメントまたはターゲットサービスによって返されるレスポンス

  詳細については、「 EventBridge Pipes ログに実行データを含める」を参照してください。

EventBridge Pipes ログレベルの指定

が選択したログ送信先にレコード EventBridge を送信する実行ステップのタイプを指定できます。

ログレコードに含める詳細レベルを以下から選択します。ログレベルは、パイプに指定したすべてのログ送信先に適用されます。各ログレベルには、以前のログレベルの実行ステップが含まれます。

• OFF – EventBridge 指定されたログ送信先にレコードを送信しません。これはデフォルトの設定です。

• ERROR – パイプの実行中に生成されたエラーに関連するレコードを、指定されたログ送信先 EventBridge に送信します。

• INFO – エラーに関連するレコード EventBridge を送信し、パイプの実行中に実行される他のステップを指定されたログ送信先に送信します。

• TRACE – パイプ実行の任意のステップ中に生成されたレコードを、指定されたログ送信先 EventBridge に送信します。

EventBridge コンソールでは、 CloudWatch ログレベルと同様に、ログがデフォルトでERRORログの送信先として選択されます。そのため、Pipes EventBridge はデフォルトで新しい CloudWatch ロググループを作成し、そのグループに詳細ERRORレベルを含むログレコードを送信します。ログをプログラムで設定する場合、デフォルトは選択されません。

次の表は、各ログレベルに含まれる実行ステップを示しています。

[ステップ]	TRACE	INFO	ERROR	VOFF
実行の失敗	x	x	x
実行が部分的に失敗	x	x	x
実行の開始	x	x
実行の成功	x	x
実行がスロットリング	x	x	x
実行タイムアウト	x	x	x
エンリッチメントの呼び出しが失敗	x	x	x
エンリッチメント呼び出しをスキップ	x	x
エンリッチメント呼び出しが開始	x
エンリッチメント呼び出しが成功	x
エンリッチメントステージ開始	x	x
エンリッチメントステージが失敗	x	x	x
エンリッチメントステージが成功	x	x
エンリッチメント変換が失敗	x	x	x
エンリッチメント変換が開始	x
エンリッチメント変換が成功	x
ターゲット呼び出しが失敗	x	x	x
ターゲット呼び出しが部分的に失敗	x	x	x
ターゲット呼び出しをスキップ	x
ターゲット呼び出しが開始	x
ターゲット呼び出しが成功	x
ターゲットステージ開始	x	x
ターゲットステージが失敗	x	x	x
ターゲットステージが部分的に失敗	x	x	x
ターゲットステージをスキップ	x
ターゲットステージが成功	x	x
ターゲット変換が失敗	x	x	x
ターゲット変換が開始	x
ターゲット変換が成功	x

EventBridge Pipes ログに実行データを含める

が生成するレコード EventBridge に実行データを含めるように に指定できます。実行データには、イベントバッチペイロード、エンリッチメントとターゲットに送信されたリクエスト、エンリッチメントとターゲットからの応答を表すフィールドが含まれます。

実行データは、トラブルシューティングやデバッグに役立ちます。payload フィールドには、バッチに含まれる各イベントの実際の内容が含まれているため、個々のイベントを特定のパイプ実行に関連付けることができます。

実行データを含めることを選択した場合、実行データはパイプに指定したすべてのログ送信先に含まれます。

重要

これらのフィールドには機密情報が含まれている場合があります。 EventBridge は、ログ記録中にこれらのフィールドの内容を編集しようとしません。

実行データを含めると、 は関連するレコードに次のフィールド EventBridge を追加します。

• payload

  パイプで処理しているイベントバッチの内容を表します。

  EventBridge は、イベントバッチの内容が更新された可能性のあるステップで生成されたレコードに payloadフィールドを含めます。これには以下のステップが含まれます。

  • EXECUTION_STARTED

  • ENRICHMENT_TRANSFORMATION_SUCCEEDED

  • ENRICHMENT_STAGE_SUCCEEDED

  • TARGET_TRANSFORMATION_SUCCEEDED

  • TARGET_STAGE_SUCCEEDED

• awsRequest

  エンリッチメントまたはターゲットに送信された JSON 文字列のリクエストを表します。API 送信先に送信されるリクエストの場合、これはそのエンドポイントに送信された HTTP リクエストを表します。

  EventBridge は、エンリッチメントとターゲット化の最終ステップで生成されたレコードに awsRequestフィールドを含めます。つまり、 が指定されたエンリッチメントまたはターゲットサービスに対してリクエスト EventBridge を実行または実行しようとした後です。これには以下のステップが含まれます。

  • ENRICHMENT_INVOCATION_FAILED

  • ENRICHMENT_INVOCATION_SUCCEEDED

  • TARGET_INVOCATION_FAILED

  • TARGET_INVOCATION_PARTIALLY_FAILED

  • TARGET_INVOCATION_SUCCEEDED

• awsResponse

  エンリッチメントまたはターゲットから返された JSON 形式のレスポンスを表します。API 送信先に送信されたリクエストの場合、これはそのエンドポイントから返された HTTP レスポンスを表します。

  と同様にawsRequest、 は、エンリッチメントとターゲット化の最終ステップで生成されたレコードに awsResponseフィールド EventBridge を含めます。つまり、 が指定されたエンリッチメントまたはターゲットサービスに対してリクエスト EventBridge を実行または実行を試み、レスポンスを受信した後です。これには以下のステップが含まれます。

  • ENRICHMENT_INVOCATION_FAILED

  • ENRICHMENT_INVOCATION_SUCCEEDED

  • TARGET_INVOCATION_FAILED

  • TARGET_INVOCATION_PARTIALLY_FAILED

  • TARGET_INVOCATION_SUCCEEDED

パイプ実行ステップの説明については、「 EventBridge パイプ実行ステップ」を参照してください。

Pipes ログレコードの実行データの EventBridge切り捨て

パイプのログレコードに実行データ EventBridge を含めることを選択した場合、レコードが 256 KB のサイズ制限を超える可能性があります。これを防ぐために、 EventBridge は実行データフィールドを自動的に切り捨てます。 は、次のフィールドを切り捨てに進む前に、各フィールドを完全に EventBridge 切り捨てます。 は、データ文字列の末尾から文字を削除するだけでフィールドデータ EventBridge を切り捨てます。データの重要度に基づいて切り捨てようとはせず、切り捨ては JSON 形式を無効にします。

• payload

• awsRequest

• awsResponse

EventBridge がイベントのフィールドを切り捨てる場合、 truncatedFieldsフィールドには切り捨てられたデータフィールドのリストが含まれます。

EventBridge Pipes ログレコードでのエラーレポート

EventBridge には、障害状態を表すパイプ実行ステップに、エラーデータも含まれます。ステップには以下が含まれます。

• ExecutionThrottled

• ExecutionTimeout

• ExecutionFailed

• ExecutionPartiallyFailed

• EnrichmentTransformationFailed

• EnrichmentInvocationFailed

• EnrichmentStageFailed

• TargetTransformationFailed

• TargetInvocationFailed

• TargetInvocationPartiallyFailed

• TargetStageFailed

• TargetStagePartiallyFailed