Add clarification about OTEL_SEMCONV_STABILITY_OPT_IN (#1758)

Co-authored-by: Joao Grassi <[email protected]>
open-telemetry · Jan 20, 2025 · f249173 · f249173
1 parent f805348
commit f249173
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/non-normative/db-migration.md b/docs/non-normative/db-migration.md
@@ -22,6 +22,10 @@ updated to the stable database semantic conventions, they:
 - May drop the environment variable in their next major version and emit only
   the stable database conventions.
 
+> [!NOTE]
+> `OTEL_SEMCONV_STABILITY_OPT_IN` is only intended to be used when migrating
+> from an experimental semantic convention to its initial stable version.
+
 ## Summary of changes
 
 This section summarizes the changes made to the HTTP semantic conventions

diff --git a/docs/non-normative/http-migration.md b/docs/non-normative/http-migration.md
@@ -29,6 +29,10 @@ updated to the stable HTTP semantic conventions, they:
 - May drop the environment variable in their next major version and emit only
   the stable HTTP and networking conventions.
 
+> [!NOTE]
+> `OTEL_SEMCONV_STABILITY_OPT_IN` is only intended to be used when migrating
+> from an experimental semantic convention to its initial stable version.
+
 ## Summary of changes
 
 This section summarizes the changes made to the HTTP semantic conventions