From 7bf6381ba247f8f82122cbd525bafc26b391acb4 Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Thu, 2 Dec 2021 12:45:14 -0500 Subject: [PATCH] More fixes based on comments --- specification/versioning-and-stability.md | 25 +++++++++++++---------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/specification/versioning-and-stability.md b/specification/versioning-and-stability.md index f0bc85106cc..1999ddb2a6e 100644 --- a/specification/versioning-and-stability.md +++ b/specification/versioning-and-stability.md @@ -134,11 +134,14 @@ Languages which ship binary artifacts SHOULD offer [ABI compatibility](glossary. #### Contrib Stability -**NOTE: Until telemetry stability is defined, Contrib instrumentation MUST NOT be marked as stable. See below.** - -Plugins, instrumentation, and other contrib packages SHOULD be kept up to date and compatible with the latest versions of the API, SDK, and Semantic Conventions. -If a release of the API, SDK, or Semantic Conventions contains changes which are relevant to a contrib package, that package SHOULD be updated and released in a timely fashion. -The goal is to ensure users can update to the latest version of OpenTelemetry, and not be held back by the plugins that they depend on. +Plugins, instrumentation, and other contrib packages SHOULD be kept up to date +and compatible with the latest versions of the API, SDK, and Semantic +Conventions. If a release of the API, SDK, or Semantic Conventions contains +changes which are relevant to a contrib package, that package SHOULD be updated +and released in a timely fashion. (See limitations on instrumentation stability +in [Telemetry Stability](#telemetry-stability)). The goal is to ensure users can +update to the latest version of OpenTelemetry, and not be held back by the +plugins that they depend on. Public portions of contrib packages (constructors, configuration, interfaces) SHOULD remain backwards compatible. @@ -211,14 +214,14 @@ OpenTelemetry semantic conventions. Note that adding of new attributes, metrics, spans, span events or log records are considered additive, non-breaking changes and are always allowed, whether -the instrumentation includes the Schema URL in the produced telemetry or no. +the instrumentation includes the Schema URL in the produced telemetry or not. OpenTelemetry instrumentations SHOULD NOT produce telemetry that is not -described by OpenTelemetry semantic conventions. If, however, this rule is -broken the instrumentations MUST NOT change such telemetry, regardless of -whether they include the Schema URL in the produced telemetry. Once the produced -telemetry is added to the semantic conventions changes will be allowed as -described above. +described by OpenTelemetry semantic conventions, unless the instrumentation is +clearly marked as unstable. If, however, this rule is broken the +instrumentations MUST NOT change such telemetry, regardless of whether they +include the Schema URL in the produced telemetry. Once the produced telemetry is +added to the semantic conventions changes will be allowed as described above. ### Deprecated