Implement Otel semantic convention stability opt-in (#1987)

open-telemetry · Nov 10, 2023 · b6d77f1 · b6d77f1
1 parent 7166de6
commit b6d77f1
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,13 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
-## Version 1.21.0/0.42b0 ()
+### Added
 
-- `opentelemetry-instrumentation-aiohttp-server` Add instrumentor and auto instrumentation support for aiohttp-server
-  ([#1800](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1800))
+- `opentelemetry-instrumentation` Added Otel semantic convention opt-in mechanism
+  ([#1987](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1987))
+
+## Version 1.21.0/0.42b0 (2023-11-01)
 
 ### Added
 
+- `opentelemetry-instrumentation-aiohttp-server` Add instrumentor and auto instrumentation support for aiohttp-server
+  ([#1800](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1800))
 - `opentelemetry-instrumentation-botocore` Include SNS topic ARN as a span attribute with name `messaging.destination.name` to uniquely identify the SNS topic
   ([#1995](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1995))
 - `opentelemetry-instrumentation-system-metrics` Add support for collecting process metrics

diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py
@@ -25,6 +25,9 @@
     DependencyConflict,
     get_dependency_conflicts,
 )
+from opentelemetry.instrumentation.utils import (
+    _OpenTelemetrySemanticConventionStability,
+)
 
 _LOG = getLogger(__name__)
 
@@ -105,6 +108,9 @@ def instrument(self, **kwargs):
                 _LOG.error(conflict)
                 return None
 
+        # initialize semantic conventions opt-in if needed
+        _OpenTelemetrySemanticConventionStability._initialize()
+
         result = self._instrument(  # pylint: disable=assignment-from-no-return
             **kwargs
         )

diff --git a/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py b/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py
@@ -12,7 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
+import threading
 import urllib.parse
+from enum import Enum
 from re import escape, sub
 from typing import Dict, Sequence
 
@@ -152,3 +155,60 @@ def _python_path_without_directory(python_path, directory, path_separator):
         "",
         python_path,
     )
+
+
+_OTEL_SEMCONV_STABILITY_OPT_IN_KEY = "OTEL_SEMCONV_STABILITY_OPT_IN"
+
+
+class _OpenTelemetryStabilitySignalType:
+    HTTP = "http"
+
+
+class _OpenTelemetryStabilityMode(Enum):
+    # http - emit the new, stable HTTP and networking conventions ONLY
+    HTTP = "http"
+    # http/dup - emit both the old and the stable HTTP and networking conventions
+    HTTP_DUP = "http/dup"
+    # default - continue emitting old experimental HTTP and networking conventions
+    DEFAULT = "default"
+
+
+class _OpenTelemetrySemanticConventionStability:
+    _initialized = False
+    _lock = threading.Lock()
+    _OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING = {}
+
+    @classmethod
+    def _initialize(cls):
+        with _OpenTelemetrySemanticConventionStability._lock:
+            if not _OpenTelemetrySemanticConventionStability._initialized:
+                # Users can pass in comma delimited string for opt-in options
+                # Only values for http stability are supported for now
+                opt_in = os.environ.get(_OTEL_SEMCONV_STABILITY_OPT_IN_KEY, "")
+                opt_in_list = []
+                if opt_in:
+                    opt_in_list = [s.strip() for s in opt_in.split(",")]
+                http_opt_in = _OpenTelemetryStabilityMode.DEFAULT
+                if opt_in_list:
+                    # Process http opt-in
+                    # http/dup takes priority over http
+                    if (
+                        _OpenTelemetryStabilityMode.HTTP_DUP.value
+                        in opt_in_list
+                    ):
+                        http_opt_in = _OpenTelemetryStabilityMode.HTTP_DUP
+                    elif _OpenTelemetryStabilityMode.HTTP.value in opt_in_list:
+                        http_opt_in = _OpenTelemetryStabilityMode.HTTP
+                _OpenTelemetrySemanticConventionStability._OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING[
+                    _OpenTelemetryStabilitySignalType.HTTP
+                ] = http_opt_in
+                _OpenTelemetrySemanticConventionStability._initialized = True
+
+    @classmethod
+    def _get_opentelemetry_stability_opt_in(
+        type: _OpenTelemetryStabilitySignalType,
+    ) -> _OpenTelemetryStabilityMode:
+        with _OpenTelemetrySemanticConventionStability._lock:
+            return _OpenTelemetrySemanticConventionStability._OTEL_SEMCONV_STABILITY_SIGNAL_MAPPING.get(
+                type, _OpenTelemetryStabilityMode.DEFAULT
+            )