Skip to content

[DOCS] Document extended spec.telemetry OTel exporter/collector fields #397

Description

The telemetry schema shape was revised after design review, so the fields to document here have changed.

Instead of a top-level otlp block plus per-signal exporter enums, exporters are now nested under each signal following the OpenTelemetry SDK declarative-configuration model - the single key beneath exporter selects the exporter (no separate enum, no signal-agnostic protocol block):

    telemetry:
      enabled: true
      traces:
        exporter:
          otlp:
            endpoint: http://localhost:4318
            protocol: http/protobuf
      metrics:
        exporter:
          prometheus:   # pull; or otlp: to push
            host: ""
            port: 9464
  • traces.exporter accepts otlp; metrics.exporter accepts otlp or prometheus; exactly one key per signal.
  • Omitting a signal (or its exporter block) disables it -> OTEL_TRACES_EXPORTER=none / OTEL_METRICS_EXPORTER=none.
  • Every field maps 1:1 to a standard OTEL_* env var (shared OTEL_EXPORTER_OTLP_* when both signals match, else per-signal OTEL_EXPORTER_OTLP_{TRACES,METRICS}_*).
  • Headers, credentials, and sampling stay runtime-only (env), never in the manifest.

Authoritative field reference and env-var mapping table live in the ADL repo at docs/reference/telemetry.md. Schema PR: inference-gateway/adl#104 (supersedes the earlier shape in inference-gateway/adl#103).

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