[Step Function] 9. Update README #166

lym953 · 2025-01-16T22:19:14Z

What does this PR do?

Update README by adding step function related doc.

Details:

Add what this macro does to instrument a step function
Add stepFunctionForwarderArn param, which is required for instrumenting a step function
Update env, service, version, tags params, saying they will be set as tags on the step functions as well.
Delete "How it works" section. I think it's largely the same as a paragraph at the beginning:

The macro automatically configures ingestion of metrics, traces, and logs from your serverless applications by: ...

Motivation

To make customers aware that this CloudFormation Macro will instrument their step functions as well.

Testing Guidelines

Additional Notes

Types of changes

Bug fix
New feature
Breaking change
Misc (docs, refactoring, dependency upgrade, etc.)

Check all that apply

This PR's description is comprehensive
This PR contains breaking changes that are documented in the description
This PR introduces new APIs or parameters that are documented and unlikely to change in the foreseeable future
This PR impacts documentation, and it has been updated (or a ticket has been logged)
This PR's changes are covered by the automated tests
This PR collects user input/sensitive content into Datadog

estherk15

Left some suggestions to make the Configuration consistent.

estherk15 · 2025-01-17T19:39:43Z

serverless/README.md

- Installing and configuring the Datadog Lambda Library and Lambda Extension for your [Python][1], [Node.js][2], [.NET][9], and [Java][10] Lambda functions.
- Enabling the collection of enhanced Lambda metrics and custom metrics from your Lambda functions.
- Managing subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.
+- For Lambda functions, this macro:


Suggested change

- For Lambda functions, this macro:

For Lambda functions, this macro:

estherk15 · 2025-01-17T19:42:12Z

serverless/README.md

+- For Lambda functions, this macro:
+  - Installs and configures the Datadog Lambda Library and Lambda Extension for your [Python][1], [Node.js][2], [.NET][9], and [Java][10] Lambda functions.
+  - Enables the collection of enhanced Lambda metrics and custom metrics from your Lambda functions.
+  - Managing subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.


Suggested change

- Managing subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.

- Manages subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.

estherk15 · 2025-01-17T19:43:20Z

serverless/README.md

+  - Installs and configures the Datadog Lambda Library and Lambda Extension for your [Python][1], [Node.js][2], [.NET][9], and [Java][10] Lambda functions.
+  - Enables the collection of enhanced Lambda metrics and custom metrics from your Lambda functions.
+  - Managing subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.
+- For Step Functions, this macro:


Suggested change

- For Step Functions, this macro:

For Step Functions, this macro:

estherk15 · 2025-01-17T19:43:59Z

serverless/README.md

+  - Managing subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.
+- For Step Functions, this macro:
+  - Creates a log group and subscribes the Datadog forwarder Lambda to it.
+  - Adds tags to enable tracing and Unified Service Tagging


Suggested change

- Adds tags to enable tracing and Unified Service Tagging

- Adds tags to enable tracing and Unified Service Tagging.

estherk15 · 2025-01-17T19:59:19Z

serverless/README.md

@@ -41,7 +46,7 @@ aws cloudformation create-stack \

 ## Usage with AWS SAM

-To deploy your serverless application with SAM, add the Datadog Serverless CloudFormation macro under the `Transform` section in your `template.yml` file, after the required SAM transform. Also add a `DDGitData` parameter and pass it to the macro to enable Datadog Source Code Integration:
+To deploy your serverless application with SAM, add the Datadog Serverless CloudFormation macro under the `Transform` section in your `template.yml` file, after the required SAM transform. Also add a `DDGitData` parameter and pass it to the macro to enable Datadog Source Code Integration. Here is an example for instrumenting your Lambda functions and Step Functions:


Suggested change

To deploy your serverless application with SAM, add the Datadog Serverless CloudFormation macro under the `Transform` section in your `template.yml` file, after the required SAM transform. Also add a `DDGitData` parameter and pass it to the macro to enable Datadog Source Code Integration. Here is an example for instrumenting your Lambda functions and Step Functions:

To deploy your serverless application with SAM, add the Datadog Serverless CloudFormation macro under the `Transform` section in your `template.yml` file, after the required SAM transform. Add a `DDGitData` parameter passed to the macro to enable Datadog Source Code Integration. See the following example on instrumenting your Lambda functions and Step Functions:

estherk15 · 2025-01-17T20:25:10Z

serverless/README.md

+| `tags`                      | A comma separated list of key:value pairs as a single string. When set along with `extensionLayerVersion`, a `DD_TAGS` environment variable is added on all Lambda functions with the provided value. When set along with `forwarderArn`, the macro parses the string and sets each key:value pair as a tag on all Lambda functions. The macro also sets these tags to all the State Machines.                                                                                                                                                                 |
+| `logLevel`                  | Sets the log level. Set to `DEBUG` for extended logging.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `captureLambdaPayload`      | Automatically tags the function execution span with request and response payloads, so they can be displayed in the APM application.                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `enableColdStartTracing`    | Set to `false` to disable Cold Start Tracing. Used in NodeJS and Python. Defaults to `true`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |


Suggested change

| `enableColdStartTracing` | Set to `false` to disable Cold Start Tracing. Used in NodeJS and Python. Defaults to `true`. |

| `enableColdStartTracing` | Set to `false` to disable Cold Start Tracing. Used in Node.js and Python. Defaults to `true`. |

estherk15 · 2025-01-17T20:26:09Z

serverless/README.md

+| `logLevel`                  | Sets the log level. Set to `DEBUG` for extended logging.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| `captureLambdaPayload`      | Automatically tags the function execution span with request and response payloads, so they can be displayed in the APM application.                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `enableColdStartTracing`    | Set to `false` to disable Cold Start Tracing. Used in NodeJS and Python. Defaults to `true`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `coldStartTraceMinDuration` | Sets the minimum duration (in milliseconds) for a module load event to be traced via Cold Start Tracing. Number. Defaults to `3`.                                                                                                                                                                                                                                                                                                                                                                                                                              |


Is Number significant?

Suggested change

| `coldStartTraceMinDuration` | Sets the minimum duration (in milliseconds) for a module load event to be traced via Cold Start Tracing. Number. Defaults to `3`. |

| `coldStartTraceMinDuration` | Sets the minimum duration (in milliseconds) for a module load event to be traced through Cold Start Tracing. Defaults to `3`. |

estherk15 · 2025-01-17T20:26:30Z

serverless/README.md

+| `captureLambdaPayload`      | Automatically tags the function execution span with request and response payloads, so they can be displayed in the APM application.                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| `enableColdStartTracing`    | Set to `false` to disable Cold Start Tracing. Used in NodeJS and Python. Defaults to `true`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `coldStartTraceMinDuration` | Sets the minimum duration (in milliseconds) for a module load event to be traced via Cold Start Tracing. Number. Defaults to `3`.                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| `coldStartTraceSkipLibs`    | optionally skip creating Cold Start Spans for a comma-separated list of libraries. Useful to limit depth or skip known libraries. Default depends on runtime.                                                                                                                                                                                                                                                                                                                                                                                                  |


Suggested change

| `coldStartTraceSkipLibs` | optionally skip creating Cold Start Spans for a comma-separated list of libraries. Useful to limit depth or skip known libraries. Default depends on runtime. |

| `coldStartTraceSkipLibs` | Optionally skip creating Cold Start Spans for a comma-separated list of libraries. Useful to limit depth or skip known libraries. Default depends on runtime. |

estherk15 · 2025-01-17T20:26:58Z

serverless/README.md

+| `enableColdStartTracing`    | Set to `false` to disable Cold Start Tracing. Used in NodeJS and Python. Defaults to `true`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `coldStartTraceMinDuration` | Sets the minimum duration (in milliseconds) for a module load event to be traced via Cold Start Tracing. Number. Defaults to `3`.                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| `coldStartTraceSkipLibs`    | optionally skip creating Cold Start Spans for a comma-separated list of libraries. Useful to limit depth or skip known libraries. Default depends on runtime.                                                                                                                                                                                                                                                                                                                                                                                                  |
+| `enableProfiling`           | Enable the Datadog Continuous Profiler with `true`. Supported in Beta for NodeJS and Python. Defaults to `false`.                                                                                                                                                                                                                                                                                                                                                                                                                                              |


Suggested change

| `enableProfiling` | Enable the Datadog Continuous Profiler with `true`. Supported in Beta for NodeJS and Python. Defaults to `false`. |

| `enableProfiling` | Enable the Datadog Continuous Profiler with `true`. Supported in Beta for Node.js and Python. Defaults to `false`. |

estherk15 · 2025-01-17T20:28:49Z

serverless/README.md

+| `encodeAuthorizerContext`   | When set to `true` for Lambda authorizers, the tracing context will be encoded into the response for propagation. Supported for NodeJS and Python. Defaults to `true`.                                                                                                                                                                                                                                                                                                                                                                                         |
+| `decodeAuthorizerContext`   | When set to `true` for Lambdas that are authorized via Lambda authorizers, it will parse and use the encoded tracing context (if found). Supported for NodeJS and Python. Defaults to `true`.                                                                                                                                                                                                                                                                                                                                                                  |
+| `apmFlushDeadline`          | Used to determine when to submit spans before a timeout occurs, in milliseconds. When the remaining time in an AWS Lambda invocation is less than the value set, the tracer attempts to submit the current active spans and all finished spans. Supported for NodeJS and Python. Defaults to `100` milliseconds.                                                                                                                                                                                                                                               |
+| `stepFunctionForwarderArn`  | When set, the forwarder will subscribe to all the State Machine' log groups. It is required for instrumenting Step Functions.                                                                                                                                                                                                                                                                                                                                                                                                                                  |


Suggested change

| `encodeAuthorizerContext` | When set to `true` for Lambda authorizers, the tracing context will be encoded into the response for propagation. Supported for NodeJS and Python. Defaults to `true`. |

| `decodeAuthorizerContext` | When set to `true` for Lambdas that are authorized via Lambda authorizers, it will parse and use the encoded tracing context (if found). Supported for NodeJS and Python. Defaults to `true`. |

| `apmFlushDeadline` | Used to determine when to submit spans before a timeout occurs, in milliseconds. When the remaining time in an AWS Lambda invocation is less than the value set, the tracer attempts to submit the current active spans and all finished spans. Supported for NodeJS and Python. Defaults to `100` milliseconds. |

| `stepFunctionForwarderArn` | When set, the forwarder will subscribe to all the State Machine' log groups. It is required for instrumenting Step Functions. |

| `encodeAuthorizerContext` | When set to `true` for Lambda authorizers, the tracing context is encoded into the response for propagation. Supported for Node.js and Python. Defaults to `true`. |

| `decodeAuthorizerContext` | When set to `true` for Lambdas that are authorized through Lambda authorizers, it parses and use the encoded tracing context (if found). Supported for Node.js and Python. Defaults to `true`. |

| `apmFlushDeadline` | Used to determine when to submit spans before a timeout occurs, in milliseconds. When the remaining time in an AWS Lambda invocation is less than the value set, the tracer attempts to submit the current active spans and all finished spans. Supported for Node.js and Python. Defaults to `100` milliseconds. |

| `stepFunctionForwarderArn` | When set, the forwarder subscribes to all the State Machine' log groups. It is required for instrumenting Step Functions. |

lym953 force-pushed the yiming.luo/step-function-24 branch from 71dc5f5 to df0e5f6 Compare January 17, 2025 17:31

lym953 force-pushed the yiming.luo/step-function-25 branch from 3dc6515 to c9b1d3f Compare January 17, 2025 17:41

lym953 marked this pull request as ready for review January 17, 2025 17:46

lym953 requested review from a team as code owners January 17, 2025 17:46

estherk15 approved these changes Jan 17, 2025

View reviewed changes

lym953 force-pushed the yiming.luo/step-function-25 branch from c9b1d3f to a734595 Compare January 21, 2025 19:49

Base automatically changed from yiming.luo/step-function-24 to yiming.luo/step-function January 23, 2025 16:31

[Step Function] 9. Update README

b3274b8

lym953 force-pushed the yiming.luo/step-function-25 branch from a734595 to b3274b8 Compare January 23, 2025 16:32

lym953 merged commit 95fce93 into yiming.luo/step-function Jan 23, 2025
10 checks passed

lym953 deleted the yiming.luo/step-function-25 branch January 23, 2025 16:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Step Function] 9. Update README #166

[Step Function] 9. Update README #166

lym953 commented Jan 16, 2025 •

edited

Loading

estherk15 left a comment

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

estherk15 Jan 17, 2025

	- For Lambda functions, this macro:
	For Lambda functions, this macro:

	- Managing subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.
	- Manages subscriptions from the Datadog Forwarder to your Lambda function log groups, if desired.

	- For Step Functions, this macro:

	For Step Functions, this macro:

	- Adds tags to enable tracing and Unified Service Tagging
	- Adds tags to enable tracing and Unified Service Tagging.

	To deploy your serverless application with SAM, add the Datadog Serverless CloudFormation macro under the `Transform` section in your `template.yml` file, after the required SAM transform. Also add a `DDGitData` parameter and pass it to the macro to enable Datadog Source Code Integration. Here is an example for instrumenting your Lambda functions and Step Functions:
	To deploy your serverless application with SAM, add the Datadog Serverless CloudFormation macro under the `Transform` section in your `template.yml` file, after the required SAM transform. Add a `DDGitData` parameter passed to the macro to enable Datadog Source Code Integration. See the following example on instrumenting your Lambda functions and Step Functions:

	\| `enableColdStartTracing` \| Set to `false` to disable Cold Start Tracing. Used in NodeJS and Python. Defaults to `true`. \|
	\| `enableColdStartTracing` \| Set to `false` to disable Cold Start Tracing. Used in Node.js and Python. Defaults to `true`. \|

	\| `coldStartTraceMinDuration` \| Sets the minimum duration (in milliseconds) for a module load event to be traced via Cold Start Tracing. Number. Defaults to `3`. \|
	\| `coldStartTraceMinDuration` \| Sets the minimum duration (in milliseconds) for a module load event to be traced through Cold Start Tracing. Defaults to `3`. \|

	\| `coldStartTraceSkipLibs` \| optionally skip creating Cold Start Spans for a comma-separated list of libraries. Useful to limit depth or skip known libraries. Default depends on runtime. \|
	\| `coldStartTraceSkipLibs` \| Optionally skip creating Cold Start Spans for a comma-separated list of libraries. Useful to limit depth or skip known libraries. Default depends on runtime. \|

	\| `enableProfiling` \| Enable the Datadog Continuous Profiler with `true`. Supported in Beta for NodeJS and Python. Defaults to `false`. \|
	\| `enableProfiling` \| Enable the Datadog Continuous Profiler with `true`. Supported in Beta for Node.js and Python. Defaults to `false`. \|

[Step Function] 9. Update README #166

[Step Function] 9. Update README #166

Conversation

lym953 commented Jan 16, 2025 • edited Loading

What does this PR do?

Motivation

Testing Guidelines

Additional Notes

Types of changes

Check all that apply

estherk15 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lym953 commented Jan 16, 2025 •

edited

Loading