Skip to content

[SVLS-3965] Add doc for instrumenting Step Functions using AWS SAM #29156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 6, 2025

Conversation

lym953
Copy link
Contributor

@lym953 lym953 commented May 5, 2025

What does this PR do? What is the motivation?

Add doc for instrumenting Step Functions using AWS SAM.

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@lym953 lym953 requested review from a team as code owners May 5, 2025 19:44
@lym953 lym953 changed the title [SVLS-3965] Add doc for instrumentiong Step Functions using AWS SAM [SVLS-3965] Add doc for instrumenting Step Functions using AWS SAM May 5, 2025
Copy link
Contributor

github-actions bot commented May 5, 2025

Preview links (active after the build_preview check completes)

Modified Files

@maycmlee maycmlee self-assigned this May 5, 2025
Copy link
Contributor

@maycmlee maycmlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have a question and a small suggestion.

@@ -185,6 +185,28 @@ For sample stacks and additional code examples, see [CDK Examples for Instrument
[3]: https://github.com/DataDog/datadog-cdk-constructs
[4]: /serverless/guide/step_functions_cdk
{{% /tab %}}
{{% tab "AWS SAM" %}}
1. Ensure you have deployed the [Datadog Lambda Forwarder][1], and that you are using v3.130.0+. You might need to [update your Forwarder][1].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When would the user need to update the Forwarder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is copied from other tabs. I think it means user need to update the forwarder if the version is too old.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, it does seem a bit redundant to say. I'll remove that line entirely.

@@ -185,6 +185,28 @@ For sample stacks and additional code examples, see [CDK Examples for Instrument
[3]: https://github.com/DataDog/datadog-cdk-constructs
[4]: /serverless/guide/step_functions_cdk
{{% /tab %}}
{{% tab "AWS SAM" %}}
1. Ensure you have deployed the [Datadog Lambda Forwarder][1], and that you are using v3.130.0+. You might need to [update your Forwarder][1].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cswatt Would you be able help update this instruction for all of the tabs?

@cswatt cswatt requested a review from maycmlee May 5, 2025 20:47
@cswatt
Copy link
Contributor

cswatt commented May 6, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented May 6, 2025

View all feedbacks in Devflow UI.

2025-05-06 19:21:07 UTC ℹ️ Start processing command /merge


2025-05-06 19:21:13 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 22m (p90).


2025-05-06 19:38:09 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit fdc2cd7 into master May 6, 2025
21 of 25 checks passed
@dd-mergequeue dd-mergequeue bot deleted the yiming.luo/cfn-macro-sfn branch May 6, 2025 19:38
aldrickdev pushed a commit that referenced this pull request May 7, 2025
estherk15 pushed a commit that referenced this pull request May 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants