Skip to content

[DOCS] OTel-aligned ADK telemetry config (OTEL_* env vars, OTLP metrics, configurable keys) #398

Description

What changed

The A2A ADK telemetry configuration was aligned with OpenTelemetry conventions in inference-gateway/adk#228 (closes inference-gateway/adk#227). This introduces new public config env vars that should be documented on the user-facing docs site.

New / changed configuration

Standard OpenTelemetry variables (read without a prefix; take precedence over the deprecated TELEMETRY_* aliases):

  • OTEL_METRICS_EXPORTER - prometheus (default) | otlp | none
  • OTEL_TRACES_EXPORTER - otlp | none (default)
  • OTEL_EXPORTER_OTLP_ENDPOINT - OTLP base URL shared by traces and metrics
  • OTEL_EXPORTER_OTLP_PROTOCOL - http/protobuf (default) | grpc
  • OTEL_EXPORTER_PROMETHEUS_HOST / OTEL_EXPORTER_PROMETHEUS_PORT

Deprecated aliases (still honored): TELEMETRY_METRICS_HOST/PORT, TELEMETRY_TRACE_ENABLE, TELEMETRY_TRACE_ENDPOINT, TELEMETRY_TRACE_HEADERS.

Configurable attribute / baggage keys (default to OTel semantic conventions):

  • TELEMETRY_ATTR_SESSION_ID_KEY - default session.id
  • TELEMETRY_ATTR_TOOL_CALL_ID_KEY - default gen_ai.tool.call.id

New capability: OTLP metrics push (periodic reader) alongside the existing Prometheus pull endpoint. The Prometheus pull server only runs when metrics resolve to the prometheus exporter.

Affected pages

  • Telemetry / observability configuration reference for the ADK.
  • Any env-var matrix that lists TELEMETRY_* variables.

Source

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Fields

    No fields configured for Task.

    Projects

    Status
    QA

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions