Stable semconv migration clarification

trask · Aug 2, 2024 · c75eb35 · c75eb35
1 parent 01c542c
commit c75eb35
Show file tree

Hide file tree

Showing 10 changed files with 10 additions and 10 deletions.
diff --git a/docs/database/README.md b/docs/database/README.md
@@ -15,7 +15,7 @@ database metrics and logs.
 > **Warning**
 > Existing database instrumentations that are using
 > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/README.md)
-> (or prior) SHOULD NOT change the version of the database conventions that they emit
+> (or prior) SHOULD NOT change the version of the database conventions that they emit by default
 > until a transition plan to the (future) stable semantic conventions has been published.
 > Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
 

diff --git a/docs/database/database-metrics.md b/docs/database/database-metrics.md
@@ -36,7 +36,7 @@ and attributes but more may be added in the future.
 > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
 > (or prior):
 >
-> * SHOULD NOT change the version of the database conventions that they emit
+> * SHOULD NOT change the version of the database conventions that they emit by default
 >   until the database semantic conventions are marked stable.
 >   Conventions include, but are not limited to, attributes,
 >   metric and span names, and unit of measure.

diff --git a/docs/database/database-spans.md b/docs/database/database-spans.md
@@ -24,7 +24,7 @@ linkTitle: Client Calls
 > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
 > (or prior):
 >
-> * SHOULD NOT change the version of the database conventions that they emit
+> * SHOULD NOT change the version of the database conventions that they emit by default
 >   until the database semantic conventions are marked stable.
 >   Conventions include, but are not limited to, attributes,
 >   metric and span names, and unit of measure.

diff --git a/docs/http/README.md b/docs/http/README.md
@@ -18,7 +18,7 @@ and various HTTP versions like 1.1, 2 and SPDY.
 > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/http.md)
 > (or prior):
 >
-> * SHOULD NOT change the version of the HTTP or networking conventions that they emit
+> * SHOULD NOT change the version of the HTTP or networking conventions that they emit by default
 >   until the HTTP semantic conventions are marked stable (HTTP stabilization will
 >   include stabilization of a core set of networking conventions which are also used
 >   in HTTP instrumentations). Conventions include, but are not limited to, attributes,

diff --git a/docs/http/http-metrics.md b/docs/http/http-metrics.md
@@ -35,7 +35,7 @@ operations. By adding HTTP attributes to metric events it allows for finely tune
 > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/metrics/semantic_conventions/http-metrics.md)
 > (or prior):
 >
-> * SHOULD NOT change the version of the HTTP or networking conventions that they emit
+> * SHOULD NOT change the version of the HTTP or networking conventions that they emit by default
 >   until the HTTP semantic conventions are marked stable (HTTP stabilization will
 >   include stabilization of a core set of networking conventions which are also used
 >   in HTTP instrumentations). Conventions include, but are not limited to, attributes,

diff --git a/docs/http/http-spans.md b/docs/http/http-spans.md
@@ -43,7 +43,7 @@ and various HTTP versions like 1.1, 2 and SPDY.
 > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/http.md)
 > (or prior):
 >
-> * SHOULD NOT change the version of the HTTP or networking conventions that they emit
+> * SHOULD NOT change the version of the HTTP or networking conventions that they emit by default
 >   until the HTTP semantic conventions are marked stable (HTTP stabilization will
 >   include stabilization of a core set of networking conventions which are also used
 >   in HTTP instrumentations). Conventions include, but are not limited to, attributes,

diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md
@@ -19,7 +19,7 @@
 > **Warning**
 > Existing messaging instrumentations that are using
 > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-metrics.md)
-> (or prior) SHOULD NOT change the version of the messaging conventions that they emit
+> (or prior) SHOULD NOT change the version of the messaging conventions that they emit by default
 > until a transition plan to the (future) stable semantic conventions has been published.
 > Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
 

diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md
@@ -37,7 +37,7 @@
 > **Warning**
 > Existing messaging instrumentations that are using
 > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md)
-> (or prior) SHOULD NOT change the version of the messaging conventions that they emit
+> (or prior) SHOULD NOT change the version of the messaging conventions that they emit by default
 > until a transition plan to the (future) stable semantic conventions has been published.
 > Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
 

diff --git a/docs/rpc/rpc-metrics.md b/docs/rpc/rpc-metrics.md
@@ -40,7 +40,7 @@ metrics can be filtered for finer grain analysis.
 > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/metrics/semantic_conventions/rpc-metrics.md)
 > (or prior):
 >
-> * SHOULD NOT change the version of the networking conventions that they emit
+> * SHOULD NOT change the version of the networking conventions that they emit by default
 >   until the HTTP semantic conventions are marked stable (HTTP stabilization will
 >   include stabilization of a core set of networking conventions which are also used
 >   in RPC instrumentations). Conventions include, but are not limited to, attributes,

diff --git a/docs/rpc/rpc-spans.md b/docs/rpc/rpc-spans.md
@@ -29,7 +29,7 @@ This document defines how to describe remote procedure calls
 > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/rpc.md)
 > (or prior):
 >
-> * SHOULD NOT change the version of the networking conventions that they emit
+> * SHOULD NOT change the version of the networking conventions that they emit by default
 >   until the HTTP semantic conventions are marked stable (HTTP stabilization will
 >   include stabilization of a core set of networking conventions which are also used
 >   in RPC instrumentations). Conventions include, but are not limited to, attributes,