Skip to content

docs(config): publish declarative config spec conformance matrix#5347

Open
MikeGoldsmith wants to merge 3 commits into
open-telemetry:mainfrom
MikeGoldsmith:mike/config-conformance-matrix
Open

docs(config): publish declarative config spec conformance matrix#5347
MikeGoldsmith wants to merge 3 commits into
open-telemetry:mainfrom
MikeGoldsmith:mike/config-conformance-matrix

Conversation

@MikeGoldsmith

Copy link
Copy Markdown
Member

Description

There is no published view of which fields of the OpenTelemetry declarative configuration schema the Python SDK currently applies. That makes it hard to define "most use cases covered" for a 1.0 recommendation, to communicate gaps to users and vendors, and to compare coverage against Go, Java, and JS.

This PR adds the matrix:

  • New doc at opentelemetry-sdk/src/opentelemetry/sdk/_configuration/spec-conformance.md listing every schema section (resource, propagator, tracer/meter/logger providers, attribute_limits, OTLP exporter properties, sampler, id_generator, configurators, exemplar filter, views) with a tri-state status (✅ Supported / ⚠️ Partial / ❌ Unsupported) and links to tracking issues for the gaps.
  • SDK configuration package README links to the matrix.
  • Changelog entry under Documentation.

Mirrors the equivalent JS doc landed in open-telemetry/opentelemetry-js#6846 (tracked via open-telemetry/opentelemetry-js#6809).

Fixes #5346. Part of #3631.

Type of change

  • This change requires a documentation update

How Has This Been Tested?

Does This PR Require a Contrib Repo Change?

  • Yes.
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

@MikeGoldsmith MikeGoldsmith requested a review from a team as a code owner June 24, 2026 12:42
@MikeGoldsmith MikeGoldsmith changed the title docs(configuration): publish declarative config spec conformance matrix docs(config): publish declarative config spec conformance matrix Jun 24, 2026
@herin049

Copy link
Copy Markdown
Contributor

Does adding it here not work?

@ocelotl

ocelotl commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Does adding it here not work?

@MikeGoldsmith I wonder what is the motivation for this PR, is the compliance matrix in the spec not detailed enough?

In any case, having this new matrix here is harmless but I understand the point of @herin049 above, I am also curious.

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

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

3 participants