diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f6cbc18d2..73f7e9a753 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -78,3 +78,5 @@ release. ([#69](https://github.com/open-telemetry/semantic-conventions/pull/69)) - Clarify when HTTP client spans should end. ([#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)) diff --git a/specification/metrics/semantic_conventions/http-metrics.md b/specification/metrics/semantic_conventions/http-metrics.md index 41239f296c..97285e062d 100644 --- a/specification/metrics/semantic_conventions/http-metrics.md +++ b/specification/metrics/semantic_conventions/http-metrics.md @@ -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 > in HTTP instrumentations). > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` -> in the existing major version which supports the following values: -> * `none` - continue emitting whatever version of the old experimental -> HTTP and networking attributes the instrumentation was emitting previously. -> This is the default value. +> in the existing major version which is a comma-separated list of values. +> The only values defined so far are: > * `http` - emit the new, stable HTTP and networking attributes, > and stop emitting the old experimental HTTP and networking attributes > that the instrumentation emitted previously. > * `http/dup` - emit both the old and the stable HTTP and networking attributes, > 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 > for at least six months after it starts emitting both sets of attributes. > * SHOULD drop the environment variable in the next major version (stable diff --git a/specification/metrics/semantic_conventions/rpc-metrics.md b/specification/metrics/semantic_conventions/rpc-metrics.md index ac3da50756..c1c330edb6 100644 --- a/specification/metrics/semantic_conventions/rpc-metrics.md +++ b/specification/metrics/semantic_conventions/rpc-metrics.md @@ -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 > in RPC instrumentations). > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` -> in the existing major version which supports the following values: -> * `none` - continue emitting whatever version of the old experimental -> networking attributes the instrumentation was emitting previously. -> This is the default value. +> in the existing major version which is a comma-separated list of values. +> The only values defined so far are: > * `http` - emit the new, stable networking attributes, > and stop emitting the old experimental networking attributes > that the instrumentation emitted previously. > * `http/dup` - emit both the old and the stable networking attributes, > 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 > for at least six months after it starts emitting both sets of attributes. > * SHOULD drop the environment variable in the next major version (stable diff --git a/specification/trace/semantic_conventions/database.md b/specification/trace/semantic_conventions/database.md index bf14d6a8d9..4d19688711 100644 --- a/specification/trace/semantic_conventions/database.md +++ b/specification/trace/semantic_conventions/database.md @@ -31,15 +31,16 @@ > include stabilization of a core set of networking attributes which are also used > in Database instrumentations). > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` -> in the existing major version which supports the following values: -> * `none` - continue emitting whatever version of the old experimental -> database attributes the instrumentation was emitting previously. -> This is the default value. +> in the existing major version which is a comma-separated list of values. +> The only values defined so far are: > * `http` - emit the new, stable networking attributes, > and stop emitting the old experimental networking attributes > that the instrumentation emitted previously. > * `http/dup` - emit both the old and the stable networking attributes, > 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 > for at least six months after it starts emitting both sets of attributes. > * SHOULD drop the environment variable in the next major version (stable diff --git a/specification/trace/semantic_conventions/http.md b/specification/trace/semantic_conventions/http.md index 0e3187d6ca..1eb6f3bc7a 100644 --- a/specification/trace/semantic_conventions/http.md +++ b/specification/trace/semantic_conventions/http.md @@ -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 > in HTTP instrumentations). > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` -> in the existing major version which supports the following values: -> * `none` - continue emitting whatever version of the old experimental -> HTTP and networking attributes the instrumentation was emitting previously. -> This is the default value. +> in the existing major version which is a comma-separated list of values. +> The only values defined so far are: > * `http` - emit the new, stable HTTP and networking attributes, > and stop emitting the old experimental HTTP and networking attributes > that the instrumentation emitted previously. > * `http/dup` - emit both the old and the stable HTTP and networking attributes, > 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 > for at least six months after it starts emitting both sets of attributes. > * SHOULD drop the environment variable in the next major version (stable diff --git a/specification/trace/semantic_conventions/messaging.md b/specification/trace/semantic_conventions/messaging.md index 3cbc9132c5..70cf1520c0 100644 --- a/specification/trace/semantic_conventions/messaging.md +++ b/specification/trace/semantic_conventions/messaging.md @@ -47,15 +47,16 @@ > include stabilization of a core set of networking attributes which are also used > in Messaging instrumentations). > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` -> in the existing major version which supports the following values: -> * `none` - continue emitting whatever version of the old experimental -> networking attributes the instrumentation was emitting previously. -> This is the default value. +> in the existing major version which is a comma-separated list of values. +> The only values defined so far are: > * `http` - emit the new, stable networking attributes, > and stop emitting the old experimental networking attributes > that the instrumentation emitted previously. > * `http/dup` - emit both the old and the stable networking attributes, > 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 > for at least six months after it starts emitting both sets of attributes. > * SHOULD drop the environment variable in the next major version (stable diff --git a/specification/trace/semantic_conventions/rpc.md b/specification/trace/semantic_conventions/rpc.md index 2e27c16072..f823282270 100644 --- a/specification/trace/semantic_conventions/rpc.md +++ b/specification/trace/semantic_conventions/rpc.md @@ -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 > in RPC instrumentations). > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` -> in the existing major version which supports the following values: -> * `none` - continue emitting whatever version of the old experimental -> networking attributes the instrumentation was emitting previously. -> This is the default value. +> in the existing major version which is a comma-separated list of values. +> The only values defined so far are: > * `http` - emit the new, stable networking attributes, > and stop emitting the old experimental networking attributes > that the instrumentation emitted previously. > * `http/dup` - emit both the old and the stable networking attributes, > 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 > for at least six months after it starts emitting both sets of attributes. > * SHOULD drop the environment variable in the next major version (stable