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

Mark telemetry schema readme stable. #3221

Merged
merged 4 commits into from
Feb 24, 2023
Merged

Mark telemetry schema readme stable. #3221

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ed9f5b9
Mark telemetry schema readme stable.
jsuereth Feb 16, 2023
cbd45f5
Fix normative language of the specification readme.
jsuereth Feb 21, 2023
5d9dcc3
Another missed word.
jsuereth Feb 21, 2023
02e843d
Merge branch 'main' into pr-mark-telemetry-schema-readme-stable
jsuereth Feb 23, 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
12 changes: 6 additions & 6 deletions specification/schemas/README.md
View file
Open in desktop
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