docs: add OTLP exporter documentation to OpenTelemetry section#6813
Open
dpk-jr wants to merge 1 commit into
Open
docs: add OTLP exporter documentation to OpenTelemetry section#6813dpk-jr wants to merge 1 commit into
dpk-jr wants to merge 1 commit into
Conversation
Add configuration examples for OTLP trace export including: - OTEL_TRACES_EXPORTER=otlp environment variable - gRPC protocol (default, port 4317) - HTTP/protobuf protocol (port 4318) - Links to compatible backends (Jaeger, Grafana Tempo, Datadog, AWS X-Ray) - Reference to OpenTelemetry environment variable specification Closes moby#4001
Member
|
@dpk-jr Missing DCO |
tonistiigi
reviewed
Jun 3, 2026
tonistiigi
left a comment
Member
There was a problem hiding this comment.
We should change this whole section so that:
- it is not Jaeger specific. No need to mention
JAEGER_TRACEat all. Just OpenTelemetry - Keep the Jaeger-all-in-one example but just use the OTEL envs
- No need to document separate options for grpc/http. Users can find that from OTEL docs.
- Can keep the mention of other OTEL backends. If you tested a specific one then you can provide a quick example.
Member
|
doctoc error also real in CI |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
Adds documentation for OTLP trace export configuration to the OpenTelemetry section of the README.
Changes
OTEL_TRACES_EXPORTER=otlpenvironment variable documentationRelated Issue
Closes #4001
The current OpenTelemetry section only documents Jaeger trace capture via
JAEGER_TRACE. This PR adds OTLP exporter documentation, which is the standard protocol supported by OpenTelemetry and allows sending traces to any OTLP-compatible backend.