Clarify that OTEL_SEMCONV_STABILITY_OPT_IN is a comma-separated list of values (#104)

Co-authored-by: Reiley Yang <reyang@microsoft.com>
This commit is contained in:
Trask Stalnaker 2023-06-13 10:53:21 -07:00 committed by GitHub
parent eb62d3957a
commit cf4c173027
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 32 additions and 24 deletions

View File

@ -78,3 +78,5 @@ release.
([#69](https://github.com/open-telemetry/semantic-conventions/pull/69)) ([#69](https://github.com/open-telemetry/semantic-conventions/pull/69))
- Clarify when HTTP client spans should end. - Clarify when HTTP client spans should end.
([#70](https://github.com/open-telemetry/semantic-conventions/pull/70)) ([#70](https://github.com/open-telemetry/semantic-conventions/pull/70))
- Clarify that OTEL_SEMCONV_STABILITY_OPT_IN is a comma-separated list of values
([#104](https://github.com/open-telemetry/semantic-conventions/pull/104))

View File

@ -36,15 +36,16 @@ operations. By adding HTTP attributes to metric events it allows for finely tune
> include stabilization of a core set of networking attributes which are also used > include stabilization of a core set of networking attributes which are also used
> in HTTP instrumentations). > in HTTP instrumentations).
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which supports the following values: > in the existing major version which is a comma-separated list of values.
> * `none` - continue emitting whatever version of the old experimental > The only values defined so far are:
> HTTP and networking attributes the instrumentation was emitting previously.
> This is the default value.
> * `http` - emit the new, stable HTTP and networking attributes, > * `http` - emit the new, stable HTTP and networking attributes,
> and stop emitting the old experimental HTTP and networking attributes > and stop emitting the old experimental HTTP and networking attributes
> that the instrumentation emitted previously. > that the instrumentation emitted previously.
> * `http/dup` - emit both the old and the stable HTTP and networking attributes, > * `http/dup` - emit both the old and the stable HTTP and networking attributes,
> allowing for a seamless transition. > allowing for a seamless transition.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental HTTP and networking attributes
> the instrumentation was emitting previously.
> * SHOULD maintain (security patching at a minimum) the existing major version > * SHOULD maintain (security patching at a minimum) the existing major version
> for at least six months after it starts emitting both sets of attributes. > for at least six months after it starts emitting both sets of attributes.
> * SHOULD drop the environment variable in the next major version (stable > * SHOULD drop the environment variable in the next major version (stable

View File

@ -38,15 +38,16 @@ metrics can be filtered for finer grain analysis.
> include stabilization of a core set of networking attributes which are also used > include stabilization of a core set of networking attributes which are also used
> in RPC instrumentations). > in RPC instrumentations).
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which supports the following values: > in the existing major version which is a comma-separated list of values.
> * `none` - continue emitting whatever version of the old experimental > The only values defined so far are:
> networking attributes the instrumentation was emitting previously.
> This is the default value.
> * `http` - emit the new, stable networking attributes, > * `http` - emit the new, stable networking attributes,
> and stop emitting the old experimental networking attributes > and stop emitting the old experimental networking attributes
> that the instrumentation emitted previously. > that the instrumentation emitted previously.
> * `http/dup` - emit both the old and the stable networking attributes, > * `http/dup` - emit both the old and the stable networking attributes,
> allowing for a seamless transition. > allowing for a seamless transition.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental networking attributes
> the instrumentation was emitting previously.
> * SHOULD maintain (security patching at a minimum) the existing major version > * SHOULD maintain (security patching at a minimum) the existing major version
> for at least six months after it starts emitting both sets of attributes. > for at least six months after it starts emitting both sets of attributes.
> * SHOULD drop the environment variable in the next major version (stable > * SHOULD drop the environment variable in the next major version (stable

View File

@ -31,15 +31,16 @@
> include stabilization of a core set of networking attributes which are also used > include stabilization of a core set of networking attributes which are also used
> in Database instrumentations). > in Database instrumentations).
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which supports the following values: > in the existing major version which is a comma-separated list of values.
> * `none` - continue emitting whatever version of the old experimental > The only values defined so far are:
> database attributes the instrumentation was emitting previously.
> This is the default value.
> * `http` - emit the new, stable networking attributes, > * `http` - emit the new, stable networking attributes,
> and stop emitting the old experimental networking attributes > and stop emitting the old experimental networking attributes
> that the instrumentation emitted previously. > that the instrumentation emitted previously.
> * `http/dup` - emit both the old and the stable networking attributes, > * `http/dup` - emit both the old and the stable networking attributes,
> allowing for a seamless transition. > allowing for a seamless transition.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental networking attributes
> the instrumentation was emitting previously.
> * SHOULD maintain (security patching at a minimum) the existing major version > * SHOULD maintain (security patching at a minimum) the existing major version
> for at least six months after it starts emitting both sets of attributes. > for at least six months after it starts emitting both sets of attributes.
> * SHOULD drop the environment variable in the next major version (stable > * SHOULD drop the environment variable in the next major version (stable

View File

@ -38,15 +38,16 @@ and various HTTP versions like 1.1, 2 and SPDY.
> include stabilization of a core set of networking attributes which are also used > include stabilization of a core set of networking attributes which are also used
> in HTTP instrumentations). > in HTTP instrumentations).
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which supports the following values: > in the existing major version which is a comma-separated list of values.
> * `none` - continue emitting whatever version of the old experimental > The only values defined so far are:
> HTTP and networking attributes the instrumentation was emitting previously.
> This is the default value.
> * `http` - emit the new, stable HTTP and networking attributes, > * `http` - emit the new, stable HTTP and networking attributes,
> and stop emitting the old experimental HTTP and networking attributes > and stop emitting the old experimental HTTP and networking attributes
> that the instrumentation emitted previously. > that the instrumentation emitted previously.
> * `http/dup` - emit both the old and the stable HTTP and networking attributes, > * `http/dup` - emit both the old and the stable HTTP and networking attributes,
> allowing for a seamless transition. > allowing for a seamless transition.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental HTTP and networking attributes
> the instrumentation was emitting previously.
> * SHOULD maintain (security patching at a minimum) the existing major version > * SHOULD maintain (security patching at a minimum) the existing major version
> for at least six months after it starts emitting both sets of attributes. > for at least six months after it starts emitting both sets of attributes.
> * SHOULD drop the environment variable in the next major version (stable > * SHOULD drop the environment variable in the next major version (stable

View File

@ -47,15 +47,16 @@
> include stabilization of a core set of networking attributes which are also used > include stabilization of a core set of networking attributes which are also used
> in Messaging instrumentations). > in Messaging instrumentations).
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which supports the following values: > in the existing major version which is a comma-separated list of values.
> * `none` - continue emitting whatever version of the old experimental > The only values defined so far are:
> networking attributes the instrumentation was emitting previously.
> This is the default value.
> * `http` - emit the new, stable networking attributes, > * `http` - emit the new, stable networking attributes,
> and stop emitting the old experimental networking attributes > and stop emitting the old experimental networking attributes
> that the instrumentation emitted previously. > that the instrumentation emitted previously.
> * `http/dup` - emit both the old and the stable networking attributes, > * `http/dup` - emit both the old and the stable networking attributes,
> allowing for a seamless transition. > allowing for a seamless transition.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental networking attributes
> the instrumentation was emitting previously.
> * SHOULD maintain (security patching at a minimum) the existing major version > * SHOULD maintain (security patching at a minimum) the existing major version
> for at least six months after it starts emitting both sets of attributes. > for at least six months after it starts emitting both sets of attributes.
> * SHOULD drop the environment variable in the next major version (stable > * SHOULD drop the environment variable in the next major version (stable

View File

@ -40,15 +40,16 @@ This document defines how to describe remote procedure calls
> include stabilization of a core set of networking attributes which are also used > include stabilization of a core set of networking attributes which are also used
> in RPC instrumentations). > in RPC instrumentations).
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version which supports the following values: > in the existing major version which is a comma-separated list of values.
> * `none` - continue emitting whatever version of the old experimental > The only values defined so far are:
> networking attributes the instrumentation was emitting previously.
> This is the default value.
> * `http` - emit the new, stable networking attributes, > * `http` - emit the new, stable networking attributes,
> and stop emitting the old experimental networking attributes > and stop emitting the old experimental networking attributes
> that the instrumentation emitted previously. > that the instrumentation emitted previously.
> * `http/dup` - emit both the old and the stable networking attributes, > * `http/dup` - emit both the old and the stable networking attributes,
> allowing for a seamless transition. > allowing for a seamless transition.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental networking attributes
> the instrumentation was emitting previously.
> * SHOULD maintain (security patching at a minimum) the existing major version > * SHOULD maintain (security patching at a minimum) the existing major version
> for at least six months after it starts emitting both sets of attributes. > for at least six months after it starts emitting both sets of attributes.
> * SHOULD drop the environment variable in the next major version (stable > * SHOULD drop the environment variable in the next major version (stable