Skip to content

docs: add OTLP exporter documentation to OpenTelemetry section#6813

Open
dpk-jr wants to merge 1 commit into
moby:masterfrom
dpk-jr:docs/add-otlp-otlp-documentation
Open

docs: add OTLP exporter documentation to OpenTelemetry section#6813
dpk-jr wants to merge 1 commit into
moby:masterfrom
dpk-jr:docs/add-otlp-otlp-documentation

Conversation

@dpk-jr

@dpk-jr dpk-jr commented May 31, 2026

Copy link
Copy Markdown

What this PR does

Adds documentation for OTLP trace export configuration to the OpenTelemetry section of the README.

Changes

  • Added OTEL_TRACES_EXPORTER=otlp environment variable documentation
  • Added gRPC protocol configuration example (default, port 4317)
  • Added HTTP/protobuf protocol configuration example (port 4318)
  • Added links to compatible OTLP backends (Jaeger, Grafana Tempo, Datadog, AWS X-Ray)
  • Added reference to OpenTelemetry environment variable specification

Related 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.

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
@tonistiigi

Copy link
Copy Markdown
Member

@dpk-jr Missing DCO

@tonistiigi tonistiigi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should change this whole section so that:

  • it is not Jaeger specific. No need to mention JAEGER_TRACE at 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.

@tonistiigi

Copy link
Copy Markdown
Member

doctoc error also real in CI

@tonistiigi tonistiigi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Tracing documention only covers Jaeger

2 participants