Skip to content

Commit

Permalink
Mark telemetry schema readme stable. (open-telemetry#3221)
Browse files Browse the repository at this point in the history
  • Loading branch information
jsuereth authored Feb 24, 2023
1 parent 49dd352 commit 6e89f7f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions specification/schemas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ aliases: [/docs/reference/specification/schemas/overview]

# Telemetry Schemas

**Status**: [Experimental](../document-status.md)
**Status**: [Stable](../document-status.md)

<details>
<summary>Table of Contents</summary>
Expand Down Expand Up @@ -81,7 +81,7 @@ address these needs.

## How Schemas Work

We believe that the 3 parties described above should be able to evolve
We believe that the 3 parties described above are able to evolve
independently over time, while continuously retaining the ability to correctly
work together.

Expand All @@ -102,10 +102,10 @@ how the schemas work:
- Telemetry schemas are identified by Schema URLs, that are unique for each
schema version.

- Telemetry sources (e.g. instrumentation libraries) should include a schema URL
- Telemetry sources (e.g. instrumentation libraries) will include a schema URL
in the emitted telemetry.

- Telemetry consumers should pay attention to the schema of the received
- Telemetry consumers will pay attention to the schema of the received
telemetry. If necessary, telemetry consumers may transform the telemetry data
from the received schema version to the target schema version as expected at
the point of use (e.g. a dashboard may define which schema version it
Expand Down Expand Up @@ -148,7 +148,7 @@ how the schemas work:
attempt to support a comprehensive set of possible transformation types that
can handle all possible changes to schemas that we can imagine. That would be
too complicated and very likely superfluous. Any new transformation types
should be proposed and added in the future to the schema file format when
MUST be proposed and added in the future to the schema file format when
there is an evidence that they are necessary for the evolution of
OpenTelemetry.

Expand Down Expand Up @@ -215,7 +215,7 @@ identifiers.

To create a new version of the schema copy the schema file for the last version
in the schema family and add the definition of the new version. The schema file
that corresponds to the new version must be retrievable at a new URL.
that corresponds to the new version MUST be retrievable at a new URL.

Important: schema files are immutable once they are published. Once the schema
file is retrieved it is recommended to be cached permanently. Schema files may
Expand Down

0 comments on commit 6e89f7f

Please sign in to comment.