Add documentation for enabling OTLP traces in APM SDKs#36498
Add documentation for enabling OTLP traces in APM SDKs#36498zacharycmontoya wants to merge 1 commit intomasterfrom
Conversation
mcculls
left a comment
There was a problem hiding this comment.
LGTM from an SDK perspective
Preview links (active after the
|
buraizu
left a comment
There was a problem hiding this comment.
Thanks for the PR, just requesting some minor updates and posted a question
| : **Description**: Enables the Datadog SDK's OpenTelemetry interoperability for traces. <br> | ||
| **Default**: `false`<br> | ||
| **Notes**: The default is `true` in the Java SDK. | ||
| **Notes**: This configuration only enables the OpenTelemetry Tracing API. See `OTEL_TRACES_EXPORTER` to emit traces using OTLP. |
There was a problem hiding this comment.
| **Notes**: This configuration only enables the OpenTelemetry Tracing API. See `OTEL_TRACES_EXPORTER` to emit traces using OTLP. | |
| **Note**: This configuration only enables the OpenTelemetry Tracing API. See `OTEL_TRACES_EXPORTER` to emit traces using OTLP. |
| : **Description**: Specifies the timeout (in milliseconds) for a single outgoing OTLP logs request. Takes precedence over the general `OTEL_EXPORTER_OTLP_TIMEOUT`. <br> | ||
| **Default**: `10000` (10s). | ||
|
|
||
| ### Traces-specific OTLP configuration |
There was a problem hiding this comment.
| ### Traces-specific OTLP configuration | |
| ### Trace-specific OTLP configuration |
| `OTEL_TRACES_EXPORTER` | ||
| : **Description**: Specifies the trace exporter to be used. <br> | ||
| **Accepted values**: `otlp`, `none`. A value of `none` disables the emission of OTel and Datadog traces. <br> | ||
| **Default**: `otlp` |
There was a problem hiding this comment.
| **Default**: `otlp` | |
| **Default**: `otlp`<br> |
| | Signal Source | Protocol | Port | Destination Component | | ||
| |---------------|----------|------|----------------------| | ||
| | OTel Metrics and Logs API | OTLP (gRPC/HTTP) | 4317 / 4318 | Datadog Agent OTLP Receiver or DDOT Collector | | ||
| | OTel Metrics, Logs, and Traces | OTLP (gRPC/HTTP) | 4317 / 4318 | Datadog Agent OTLP Receiver or DDOT Collector | |
There was a problem hiding this comment.
This uses the order Metrics, Logs, and Traces but the other file (line 51) uses Traces, Metrics, and Logs. Should one or the other be updated for consistency?
| **Notes**: The Java SDK requires `DD_TRACE_OTEL_ENABLED=true` for this configuration to take effect.<br> | ||
| OTLP export is not available for the Ruby, PHP, or Rust language SDKs. |
There was a problem hiding this comment.
| **Notes**: The Java SDK requires `DD_TRACE_OTEL_ENABLED=true` for this configuration to take effect.<br> | |
| OTLP export is not available for the Ruby, PHP, or Rust language SDKs. | |
| **Notes**: | |
| - The Java SDK requires `DD_TRACE_OTEL_ENABLED=true` for this configuration to take effect. | |
| - OTLP export is not available for the Ruby, PHP, or Rust SDKs. |
There was a problem hiding this comment.
Two suggestions here:
- Remove
languageas this seems to be the only place in the file that SDKs are referred to aslanguage SDKs. - Add the two distinct notes as an unordered list to make them easier to notice and scan.
duncanhewett
left a comment
There was a problem hiding this comment.
Somewhere (can be a separate PR) we'll need to document use cases for OTLP export, current limitations (semantics etc), what features work with different setups, etc.
I also think we should label OTLP export as preview for now.
| `OTEL_TRACES_EXPORTER` | ||
| : **Description**: Specifies the trace exporter to be used. <br> | ||
| **Accepted values**: `otlp`, `none`. A value of `none` disables the emission of OTel and Datadog traces. <br> | ||
| **Default**: `otlp` |
There was a problem hiding this comment.
I didn't think the default was otlp. Isn't the default null meaning don't export traces in OTLP?
What does this PR do? What is the motivation?
Documents how to configure the APM SDKs to export traces using OTLP rather than the default Datadog protocol. This allows users to send traces to any OTLP-compatible receiver, rather than just the Datadog Agent.
This change was recently released in several language SDKs.
Merge instructions
N/A
Merge readiness:
AI assistance
N/A
Additional notes
N/A