Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add moratorium on relying on schema transformations for telemetry stability #3380

Merged
merged 2 commits into from
Apr 13, 2023
Merged

Add moratorium on relying on schema transformations for telemetry stability #3380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cbdc54
Add moratorium on relying on schema transformations for telemetry sta…
trask Apr 11, 2023
6c9324d
Merge branch 'main' into schema-transformation-moratorium
trask Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ release.

### Semantic Conventions

- Add moratorium on relying on schema transformations for telemetry stability
([#3380](https://github.com/open-telemetry/opentelemetry-specification/pull/3380))

### Compatibility

### OpenTelemetry Protocol
Expand Down
12 changes: 6 additions & 6 deletions specification/telemetry-stability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ coming from an unstable instrumentation.

## Stable Instrumentations

> **Warning**
> There is a moratorium on relying on schema transformations for telemetry stability.

Stable telemetry-producing instrumentations (stable instrumentations for short) SHOULD
be clearly labeled so by any means the instrumentations authors consider idiomatic for
their language, e.g. via version numbers, artifact names, documentation, etc.
Expand Down Expand Up @@ -80,18 +83,15 @@ Stable instrumentations that include the Schema URL in the produced telemetry ar
called Schema-File Driven Telemetry Producers.

Such instrumentations are prohibited from changing the produced telemetry until
April 1, 2023 and until that date are subject to exactly the same restrictions as
the moratorium on relying on schema transformations for telemetry stability is lifted
and until that date are subject to exactly the same restrictions as
[Fixed Schema Telemetry Producers](#fixed-schema-telemetry-producers).

After April 1, 2023, stable instrumentations are allowed to change the produced telemetry
After the moratorium is lifted, stable instrumentations are allowed to change the produced telemetry
if all the following conditions are fulfilled:

- The change is part of OpenTelemetry semantic conventions and is in a released
version of the specification.
- The change has a corresponding [published](schemas/README.md#opentelemetry-schema)
OpenTelemetry Schema File that describes the change.
- The produced telemetry correctly specifies the respective Schema URL.

If the change was introduced in the semantic conventions specification before
April 1, 2023, the instrumentations must wait until April 1, 2023 before they can adopt
the change and begin producing the changed telemetry.
3 changes: 3 additions & 0 deletions specification/versioning-and-stability.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,9 @@ A new, incompatible version of an integration SHOULD be released as a separate c

#### Semantic Conventions Stability

> **Warning**
> There is a moratorium on relying on schema transformations for telemetry stability.

Semantic conventions define a contract between the signals that instrumentation
will provide and analysis tools that consumes the instrumentation (e.g.
dashboards, alerts, queries, etc.).
Expand Down