Skip to content

OTel Correlation Guides #30354

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 32 commits into from
Aug 7, 2025
Merged

OTel Correlation Guides #30354

merged 32 commits into from
Aug 7, 2025

Conversation

brett0000FF
Copy link
Contributor

@brett0000FF brett0000FF commented Jul 8, 2025

What does this PR do? What is the motivation?

Existing content was outdated and fragmented. This change unifies all correlation content into a set of guides.

Updates:

  • Logs info was outdated and overcomplicated--customers should use trace_id now.
  • DBM correlation info was missing. (Moved here OTel Correlation: DBM #30825)
  • Unified Service Tagging info was missing (existed in a totally separate part of the docs).
  • Metrics correlation info was hidden in host metrics documentation--create traces/metrics correlation page with initial info and link to host metrics to improve discoverability.

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:

Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass 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.

[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.

Additional notes

@brett0000FF brett0000FF requested a review from a team as a code owner July 8, 2025 23:28
Copy link
Contributor

github-actions bot commented Jul 8, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

@brett0000FF brett0000FF added the Do Not Merge Just do not merge this PR :) label Jul 8, 2025
@brett0000FF brett0000FF requested a review from dineshg13 July 9, 2025 00:56
@brett0000FF brett0000FF changed the title Create new OTel Correlation Guide OTel Correlation Guides Jul 14, 2025
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Jul 14, 2025
Copy link
Contributor

@shanelhuang shanelhuang left a comment

Choose a reason for hiding this comment

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

Looks good to me for the Trace and Metrics correlation page.

@brett0000FF
Copy link
Contributor Author

@jade-guiton-dd - Thanks a ton for your detailed review! Super helpful. I've updated the guide and believe I've addressed all of your points. I'd appreciate if you could take another look when you have a moment.

  • Updated the terminology throughout (for example, using "fields" instead of "attributes" where appropriate) and clarified how logging bridges work by converting logs into the OTel data model.
  • Rewrote the "Scrape logs from files" section based on your feedback. It now uses the much more robust approach of manually injecting trace context with a standard JSON logger. Would appreciate your eyes on this update in particular.
  • Defined the required format for trace_id and span_id.
  • Expanded the Datadog Agent section to better explain the reliance on dd.trace_id and the need for manual remapping when not using the OTel Collector.

Copy link
Contributor

@jade-guiton-dd jade-guiton-dd left a comment

Choose a reason for hiding this comment

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

Looks good to me on the logs side.

@jade-guiton-dd
Copy link
Contributor

jade-guiton-dd commented Jul 23, 2025

I like these recommendations (logs through OTLP first, scraping w/ manual context injection second, and not even mentioning using an OTel console exporter), but I'd be interested in feedback from other OTel team members.

@dineshg13 you brought up concerns about performance for OTLP logs vs. scraping; do you think it's worth a mention?

@brett0000FF brett0000FF mentioned this pull request Jul 31, 2025
1 task
@brett0000FF brett0000FF added editorial review Waiting on a more in-depth review and removed Do Not Merge Just do not merge this PR :) labels Jul 31, 2025
Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

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

Looks great! I left one comment, but it's not a blocker so I'm approving ✅

@brett0000FF brett0000FF merged commit 54c000b into master Aug 7, 2025
16 checks passed
@brett0000FF brett0000FF deleted the brett.blue/otel-correlation branch August 7, 2025 23:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants