Skip to content
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

Update SFN Trace Merging #28180

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

Update SFN Trace Merging #28180

wants to merge 9 commits into from

Conversation

avedmala
Copy link
Contributor

What does this PR do? What is the motivation?

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

Copy link
Contributor

@kimi-p kimi-p left a comment

Choose a reason for hiding this comment

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

2 comments, otherwise lgtm

@@ -8,51 +8,160 @@ further_reading:

This page describes how to merge your AWS Step Functions traces with related AWS Lambda traces or nested Step Functions traces. These instructions assume that you have already instrumented these [AWS Step Functions][1] and [Lambda functions][2] to send traces to Datadog.

<div class="alert alert-info">Datadog recommends using <code>JSONata</code> to define your Step Function payloads for the most complete end-to-end tracing experience. If you are using <code>JSONPath</code> to define your Step Function payloads, see the below sections for supported configurations</a>.</div>
<div class="alert alert-info">Datadog recommends using <code>JSONata</code> to define your Step Function definitions for the most complete end-to-end tracing experience. This approach will ensure that any context upstream to the Step Function will be preserved and passed down. If you are using <code>JSONPath</code> to define your Step Function definitions, see the below sections for supported configurations</a>.</div>
Copy link
Contributor

Choose a reason for hiding this comment

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

If you are using JSONPath to define your Step Function definitions, see the below sections for supported configurations.

Not because of the PR, but I think what section is about JSONPath is not clear to me. Looks like only the last two sections are about JSONata. We could either create two tabs (one for JSONPath; one for JSONata) or simply state see the last two sections.

  • Merge with downstream Lambda traces (JSONPath)
  • Merge with nested Step Functions traces (JSONPath)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since we have tabs in the JSONPath section, I couldn't get the nested tabs to work

I can come back and figure out how to do it but for now I just said "see bottom of the page"

Copy link
Contributor

@kimi-p kimi-p Mar 20, 2025

Choose a reason for hiding this comment

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

Or last two sections to be more specific. Either way sgtm.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants