From ed9f5b9448468b09b6c81635e3dd26ec1c25f2f2 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Thu, 16 Feb 2023 13:18:54 -0500 Subject: [PATCH 1/3] Mark telemetry schema readme stable. --- specification/schemas/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/schemas/README.md b/specification/schemas/README.md index 69be97f6f1f..0e1e57927b6 100644 --- a/specification/schemas/README.md +++ b/specification/schemas/README.md @@ -5,7 +5,7 @@ aliases: [/docs/reference/specification/schemas/overview] # Telemetry Schemas -**Status**: [Experimental](../document-status.md) +**Status**: [Stable](../document-status.md)
Table of Contents From cbd45f581fd2ebce4786e96538555a8966d5d126 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Tue, 21 Feb 2023 09:49:46 -0500 Subject: [PATCH 2/3] Fix normative language of the specification readme. --- specification/schemas/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/schemas/README.md b/specification/schemas/README.md index 0e1e57927b6..bdfd8827eeb 100644 --- a/specification/schemas/README.md +++ b/specification/schemas/README.md @@ -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. @@ -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 @@ -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. From 5d9dcc32d654ec2fb0b0c3f3a8e05f533c1462fb Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Tue, 21 Feb 2023 09:50:43 -0500 Subject: [PATCH 3/3] Another missed word. --- specification/schemas/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/schemas/README.md b/specification/schemas/README.md index bdfd8827eeb..ff3502ef917 100644 --- a/specification/schemas/README.md +++ b/specification/schemas/README.md @@ -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