Serverless Framework を使用してサーバーレスアプリケーションをデプロイする開発者には、Datadog Serverless Framework Plugin を使用します。

1. まだインストールしていない場合は、Datadog Serverless Framework Plugin v5.40.0+ をインストールします。

   serverless plugin install --name serverless-plugin-datadog
   

2. AWS から Datadog にログを転送する Lambda 関数の Datadog Lambda Forwarder をデプロイし、v3.74.0+ を使用していることを確認してください。Forwarder を更新する必要があるかもしれません。

   Forwarder の ARN をメモしてください。

3. 以下を serverless.yml に追加します。

   custom:
     datadog:
       site: <DATADOG_SITE>
       apiKeySecretArn: <DATADOG_API_KEY_SECRET_ARN>
       forwarderArn: <FORWARDER_ARN>
       enableStepFunctionsTracing: true
   

   • <DATADOG_SITE> を に置き換えます。(右側で正しい SITE が選択されていることを確認してください)。
   • <DATADOG_API_KEY_SECRET_ARN> を、Datadog API キーが安全に保存されている AWS シークレットの ARN に置き換えます。キーはプレーンテキスト文字列として保存する必要があります (JSON blob ではありません)。また、secretsmanager:GetSecretValue権限が必要です。迅速なテストのために、代わりに apiKey を使用して、Datadog API キーをプレーンテキストで設定することができます。
   • <FORWARDER_ARN> は、前述のように Datadog Lambda Forwarder の ARN に置き換えます。

   その他の設定については、Datadog Serverless Framework Plugin - 構成パラメーターを参照してください。

4. Node.js と Python のランタイムでは、serverless.yaml ファイルで mergeStepFunctionAndLambdaTraces:true を設定します。これにより、Step Function のトレースと Lambda のトレースがリンクされます。Lambda 関数をインスツルメンテーションしてトレースを送信していない場合は、お好みのランタイム用の Lambda レイヤーを追加する手順に従ってください。

1. まだインストールしていない場合は、Datadog CLI v2.18.0+ をインストールします。

   npm install -g @datadog/datadog-ci
   

2. AWS から Datadog にログを転送する Lambda 関数の Datadog Lambda Forwarder をデプロイし、v3.74.0+ を使用していることを確認してください。Forwarder を更新する必要があるかもしれません。

   Forwarder の ARN をメモしてください。

3. Step Function をインスツルメンテーションします。

   datadog-ci stepfunctions instrument --step-function <STEP_FUNCTION_ARN> --forwarder <FORWARDER_ARN>
   

   • <STEP_FUNCTION_ARN> を Step Function の ARN に置き換えます。
   • <FORWARDER_ARN> は、前述のように Datadog Lambda Forwarder の ARN に置き換えます。

   datadog-ci stepfunctions コマンドの詳細については、Datadog CLI ドキュメントを参照してください。

4. Node.js と Python のランタイムでは、datadog-ci コマンドにフラグ --merge-step-function-and-lambda-traces を追加します。これにより、Step Function のトレースと Lambda のトレースがリンクされます。まだ Lambda 関数をインスツルメンテーションしてトレースを送信していない場合は、お好みのランタイム用の Lambda レイヤーを追加する手順に従ってください。

1. Step Function のすべてのログを有効にします。AWS コンソールで、ステートマシンを開きます。Edit をクリックし、Logging セクションを見つけます。そこで、Log level を ALL に設定し、Include execution data チェックボックスを有効にします。

2. AWS から Datadog にログを転送する Lambda 関数の Datadog Lambda Forwarder をデプロイし、v3.74.0+ を使用していることを確認してください。Forwarder を更新する必要があるかもしれません。

   Forwarder の ARN をメモしてください。

3. CloudWatch のログを Datadog Lambda Forwarder にサブスクライブします。これには 2 つのオプションがあります。

   • Datadog-AWS インテグレーション (推奨)

     1. Datadog-AWS インテグレーションが設定されていることを確認します。
     2. Datadog で AWS インテグレーションタイルを開き、* Configuration* タブを表示します。
     3. 左側で、Step Function が実行されている AWS アカウントを選択します。Log Collection タブを開きます。
     4. Log Autosubscription セクションの Autosubscribe Forwarder Lambda Functions に、前述のように Datadog Lambda Forwarder の ARN を入力します。Add をクリックします。
     5. Step Functions CloudWatch Logs をトグルします。変更が有効になるまで 15 分かかります。

     注: Log Autosubscription では、Lambda Forwarder と Step Function が同じリージョンにある必要があります。

   • 手動

     1. ロググループ名のプレフィックスが /aws/vendedlogs/states であることを確認してください。
     2. AWS コンソールを開き、Datadog Lambda Forwarder に移動します。Function overview セクションで、Add trigger をクリックします。
     3. Add trigger で、Trigger configuration セクションで、Select a source ドロップダウンを使用して、CloudWatch Logs を選択します。
     4. Log group で、ステートマシンのロググループを選択します。例: /aws/vendedlogs/states/my-state-machine
     5. フィルター名を入力します。“empty filter” という名前を選択し、Filter pattern ボックスを空白のままにすることもできます。

4. DD_TRACE_ENABLED タグを追加して、Step Function のトレースを有効にします。値を true に設定します。

5. タグを設定します。AWS コンソールを開き、Step Function のステートマシンに移動します。Tags セクションを開き、env:<ENV_NAME> タグと service:<SERVICE_NAME> タグを追加します。env タグは Datadog でトレースを見るために必要で、デフォルトは dev です。service タグのデフォルトはステートマシンの名前です。

6. Node.js と Python のランタイムでは、Step Function のトレースを Lambda のトレースにリンクすることができます。Lambda Task で Parameters キーを以下のように設定します。

   "Parameters": {
     "Payload.$": "States.JsonMerge($$, $, false)",
     ...
   }
   

   JsonMerge 組み込み関数は Step 関数コンテキストオブジェクト ($$) と元の Lambda の入力ペイロード ($) をマージします。元のペイロードのフィールドは、キーが同じ場合、Step Functions コンテキストオブジェクトを上書きします。

例:

"Lambda Read From DynamoDB": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Parameters": {
        "Payload.$": "States.JsonMerge($$, $, false)",
        "FunctionName": "${lambdaArn}"
      },
      "End": true
    }

また、ペイロードにビジネスロジックが定義されている場合は、以下のようにすることもできます。

"Lambda Read From DynamoDB": {
      "Type": "Task",
      "Resource": "arn:aws:states:::lambda:invoke",
      "Parameters": {
        "Payload": {
          ...
          "Execution.$": "$$.Execution",
          "State.$": "$$.State",
          "StateMachine.$": "$$.StateMachine"
        },
        "FunctionName": "${lambdaArn}"
      },
      "End": true
    }

Lambda 関数をインスツルメンテーションしてトレースを送信していない場合は、お好みのランタイム用の Lambda レイヤーを追加する手順に従ってください。