1. If you haven’t already, install the Datadog CLI v2.18.0+.

   npm install -g @datadog/datadog-ci
   

   Copy

2. Ensure you have deployed the Datadog Lambda Forwarder, and that you are using v3.130.0+. You might need to update your Forwarder. As an alternative, you can also use Amazon Data Firehose, which can subscribe to Amazon CloudWatch log groups across multiple AWS regions. Your Step Functions log group name should use this format:

   /aws/vendedlogs/states/<STEP_FUNCTION_NAME>-Logs
   

   Optionally, you can add your environment to this log group name: /aws/vendedlogs/states/<STEP_FUNCTION_NAME>-Logs-<ENV>

   Take note of your Forwarder’s ARN.

3. Run:

   datadog-ci stepfunctions instrument \
    --step-function <STEP_FUNCTION_ARN> \
    --forwarder <FORWARDER_ARN> \
    --env <ENVIRONMENT> \
    --propagate-upstream-trace \
    --merge-step-function-and-lambda-traces
   

   Copy
   • Replace <STEP_FUNCTION_ARN> with the ARN of your Step Function. Repeat the --step-function flag for each Step Function you wish to instrument.
   • Replace <FORWARDER_ARN> with the ARN of your Datadog Lambda Forwarder. This step configures the log stream subscription for the Forwarder.
   • Replace <ENVIRONMENT> with the environment tag you would like to apply to your Step Functions.

   For more information about the datadog-ci stepfunctions command, see the Datadog CLI documentation.

Note: The datadog-ci stepfunctions instrument command automatically enables tracing.

1. If you haven’t already, install the Datadog Serverless Framework Plugin v5.40.0+:

   serverless plugin install --name serverless-plugin-datadog
   

   Copy

2. Ensure you have deployed the Datadog Lambda Forwarder, and that you are using v3.130.0+. You might need to update your Forwarder. As an alternative, you can also use Amazon Data Firehose, which can subscribe to Amazon CloudWatch log groups across multiple AWS regions. Your Step Functions log group name should use this format:

   /aws/vendedlogs/states/<STEP_FUNCTION_NAME>-Logs-<STAGE>
   

3. Add the following to your serverless.yml:

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

   Copy
   • Replace <DATADOG_SITE> with datadoghq.com (ensure the correct DATADOG SITE is selected on the right of this docs page).
   • Replace <DATADOG_API_KEY_SECRET_ARN> with the ARN of the AWS secret where your Datadog API key is securely stored. The key needs to be stored as a plaintext string (not a JSON blob). The secretsmanager:GetSecretValue permission is required. For quick testing, you can instead use apiKey and set the Datadog API key in plaintext.
   • Replace <FORWARDER_ARN> with the ARN of your Datadog Lambda Forwarder. This step configures the log stream subscription for the Forwarder.

   For additional settings, see Datadog Serverless Framework Plugin - Configuration parameters.

   Note: The enableStepFunctionsTracing: true line automatically enables tracing.

1. Ensure you have deployed the Datadog Lambda Forwarder, and that you are using v3.130.0+. You might need to update your Forwarder.

2. Install Datadog’s CDK Construct Library, which automatically sets up logging and subscribes the Forwarder to the log group.

Example

from aws_cdk import (
    aws_stepfunctions as sfn,
    aws_stepfunctions_tasks as tasks,
)
from datadog_cdk_constructs_v2 import DatadogStepFunctions, DatadogLambda

state_machine = sfn.StateMachine(...)
datadog_sfn = DatadogStepFunctions(
    self,
    "DatadogSfn",
    env="<ENV>", # e.g. "dev"
    service="<SERVICE>", # e.g. "my-cdk-service"
    version="<VERSION>", # e.g. "1.0.0"
    forwarderArn="<FORWARDER_ARN>", # e.g. "arn:test:forwarder:sa-east-1:12345678:1"
    tags=<TAGS>, # optional, e.g. "custom-tag-1:tag-value-1,custom-tag-2:tag-value-2"
)
datadog_sfn.add_state_machines([child_state_machine, parent_state_machine])

For sample stacks and additional code examples, see CDK Examples for Instrumenting AWS Step Functions.

Note: The Datadog Step Functions CDK construct automatically enables tracing.