Skip to content

docs(configuration): publish a declarative config spec conformance matrix #5346

Description

@MikeGoldsmith

Background

There is no published view of which fields of the OpenTelemetry declarative configuration schema the Python implementation currently supports. This makes it hard to:

  • Define "most use cases covered" for a 1.0 recommendation.
  • Communicate gaps to users and vendors.
  • Compare coverage against other languages (Go, Java, JS).

JS just published its matrix in open-telemetry/opentelemetry-js#6846 (tracked via open-telemetry/opentelemetry-js#6809). Python should produce the equivalent.

Proposal

A new markdown doc under opentelemetry-sdk/src/opentelemetry/sdk/_configuration/ (or docs/sdk/) mapping config schema sections — resource, propagator, tracer_provider (sampler, limits, processors, exporters), meter_provider, logger_provider, attribute_limits, etc. — to supported / partial / unsupported, with links to tracking issues for the gaps.

Sources of truth to cross-check each row against:

Output

  • A spec-conformance.md doc with the tri-state matrix.
  • The SDK config README links to the matrix.
  • A changelog entry under Documentation.

Part of #3631.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions