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

[APM][Tracing] Add documentation for DD_TRACE_OTEL_ENABLED and related integrations #20107

Merged
merged 9 commits into from
Feb 9, 2024

Conversation

pierotibou
Copy link
Contributor

@pierotibou pierotibou commented Oct 9, 2023

What does this PR do? What is the motivation?

Documents DD_TRACE_OTEL_ENABLED. It also starts listing integrations that we explicitly test with this setup.
I've chosen to list those in a separated table to better explain the need to set DD_TRACE_OTEL_ENABLED to true. But maybe one table with an extra column would be better?

Merge instructions

  • Please merge after reviewing

Additional notes

@zacharycmontoya
Copy link
Contributor

zacharycmontoya commented Oct 10, 2023

Hey Pierre, the application also needs to add a setting so that the Azure SDK will generate OpenTelemetry spans to begin with: https://devblogs.microsoft.com/azure-sdk/introducing-experimental-opentelemetry-support-in-the-azure-sdk-for-net/

@zacharycmontoya
Copy link
Contributor

@pierotibou pierotibou marked this pull request as ready for review December 12, 2023 21:59
@pierotibou pierotibou requested review from a team as code owners December 12, 2023 21:59
@cswatt
Copy link
Contributor

cswatt commented Dec 12, 2023

Added DOCS-6901 to review.

@cswatt cswatt added the editorial review Waiting on a more in-depth review label Dec 12, 2023
Copy link
Contributor

@zacharycmontoya zacharycmontoya left a comment

Choose a reason for hiding this comment

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

The .NET content looks good to me

Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

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

Thanks for adding this content! Please see a few of my suggestions and questions for consideration. 🙏


## OTEL based integrations

Some libraries provide built in [Activity based tracing][13]. This is the same mechanism the OpenTelemetry project relies on. By setting `DD_TRACE_OTEL_ENABLED` to `true`, the .NET tracer will automatically resurface traces provided by the libraries themselves. This is possible since [version 2.21.0][4]. Here are a list of libraries that are tested with this setup (more libraries provide such tracing though, they aren't yet expliciitly tested).
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
Some libraries provide built in [Activity based tracing][13]. This is the same mechanism the OpenTelemetry project relies on. By setting `DD_TRACE_OTEL_ENABLED` to `true`, the .NET tracer will automatically resurface traces provided by the libraries themselves. This is possible since [version 2.21.0][4]. Here are a list of libraries that are tested with this setup (more libraries provide such tracing though, they aren't yet expliciitly tested).
Some libraries provide built-in [Activity based tracing][13]. This is the same mechanism that OpenTelemetry is based on.
For these libraries, set `DD_TRACE_OTEL_ENABLED` to `true`, and the .NET tracer automatically captures traces their traces. This is supported since [version 2.21.0][4].
The following list of libraries have been tested with this setup:

Is the distinction about Activity-based tracing important, or could we simply say "Some libraries provide built-in support for OpenTelemetry"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I assume it's not that important. we could maybe switch to talking about OpenTelemetry only. @zacharycmontoya will know better though

@pierotibou
Copy link
Contributor Author

Thanks a lot @brett0000FF, I had completely missed your review and just realized today this hadn't been merged.

@brett0000FF brett0000FF merged commit a115b21 into master Feb 9, 2024
10 checks passed
@brett0000FF brett0000FF deleted the pierre/otel branch February 9, 2024 16:19
@pierotibou
Copy link
Contributor Author

Thanks again @brett0000FF !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants