This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /guides/document-engine/monitoring/opentelemetry.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. OpenTelemetry support in Document Engine

OpenTelemetry support

Markdown version of this page, suitable for AI agents and automation

Document Engine enables reporting OpenTelemetry(opens in a new tab) traces. To enable them, use the ENABLE_OPENTELEMETRY configuration option.

For metrics export with Prometheus and Grafana, refer to our metrics export guide.

Document Engine 1.18 and later propagates inbound W3C trace context. If a request includes traceparent or tracestate headers, Document Engine creates request spans as children of the upstream trace instead of starting a new root trace.

Setting up OpenTelemetry exporting

Standard OpenTelemetry project environment variables are supported. Refer to the official documentation(opens in a new tab).

When deploying with Helm, as we recommend, simplified values(opens in a new tab) from the observability.opentelemetry section are available:

observability:
  opentelemetry:
    # Enable OpenTelemetry (`ENABLE_OPENTELEMETRY`),
    # only tracing is currently supported
    enabled: false
    # `OTEL_EXPORTER_OTLP_ENDPOINT`,
    # if not set, defaults to `http://localhost:4317`
    otlpExporterEndpoint: ""
    # `OTEL_EXPORTER_OTLP_PROTOCOL`,
    # if not set, defaults to `grpc`
    otlpExporterProtocol: ""
    # `OTEL_SERVICE_NAME`, service name
    otelServiceName: ""
    # `OTEL_RESOURCE_ATTRIBUTES`, resource attributes
    otelResourceAttributes: ""
    # `OTEL_PROPAGATORS`, propagators
    otelPropagators: ""
    # `OTEL_TRACES_SAMPLER`, should normally not be touched
    # to allow custom `parent_based` work,
    # but something like `parentbased_traceidratio` may be considered
    otelTracesSampler: ""
    # `OTEL_TRACES_SAMPLER_ARG`, argument for the sampler
    otelTracesSamplerArg: ""
# Extra environment variables
extraEnvs: []