Skip to content

Commit

Permalink
More fixes based on comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tigrannajaryan committed Dec 10, 2021
1 parent ba788d6 commit 7bf6381
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions specification/versioning-and-stability.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 7bf6381

Please sign in to comment.