Skip to content

Commit

Permalink
Add moratorium on relying on schema transformations for telemetry sta…
Browse files Browse the repository at this point in the history
…bility (#3380)
  • Loading branch information
trask committed Apr 13, 2023
1 parent 25f513d commit ae82b77
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
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
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
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

0 comments on commit ae82b77

Please sign in to comment.