feat: update opentelemetry hook to latest version of semantic conventions

Signed-off-by: Federico Bond <[email protected]>

Author: federicobond

hooks/openfeature-hooks-opentelemetry/pyproject.toml

@@ -18,6 +18,7 @@ keywords = []
 dependencies = [
     "openfeature-sdk>=0.6.0",
     "opentelemetry-api",
+    "opentelemetry-semantic-conventions",
 ]
 requires-python = ">=3.9"
 

hooks/openfeature-hooks-opentelemetry/src/openfeature/contrib/hook/opentelemetry/__init__.py

@@ -1,16 +1,23 @@
 import json
 
-from openfeature.flag_evaluation import FlagEvaluationDetails
+from openfeature.exception import ErrorCode
+from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
 from openfeature.hook import Hook, HookContext, HookHints
 from opentelemetry import trace
+from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
 
-OTEL_EVENT_NAME = "feature_flag"
+OTEL_EVENT_NAME = "feature_flag.evaluation"
 
 
 class EventAttributes:
-    FLAG_KEY = f"{OTEL_EVENT_NAME}.key"
-    FLAG_VARIANT = f"{OTEL_EVENT_NAME}.variant"
-    PROVIDER_NAME = f"{OTEL_EVENT_NAME}.provider_name"
+    KEY = "feature_flag.key"
+    RESULT_VALUE = "feature_flag.result.value"
+    RESULT_VARIANT = "feature_flag.result.variant"
+    CONTEXT_ID = "feature_flag.context.id"
+    PROVIDER_NAME = "feature_flag.provider.name"
+    RESULT_REASON = "feature_flag.result.reason"
+    SET_ID = "feature_flag.set.id"
+    VERSION = "feature_flag.version"
 
 
 class TracingHook(Hook):
@@ -22,18 +29,28 @@ def after(
     ) -> None:
         current_span = trace.get_current_span()
 
-        variant = details.variant
-        if variant is None:
-            if isinstance(details.value, str):
-                variant = str(details.value)
-            else:
-                variant = json.dumps(details.value)
-
         event_attributes = {
-            EventAttributes.FLAG_KEY: details.flag_key,
-            EventAttributes.FLAG_VARIANT: variant,
+            EventAttributes.KEY: details.flag_key,
+            EventAttributes.RESULT_VALUE: json.dumps(details.value),
+            EventAttributes.RESULT_REASON: str(details.reason or Reason.UNKNOWN).lower()
         }
 
+        if details.variant:
+            event_attributes[EventAttributes.RESULT_VARIANT] = details.variant
+
+        if details.reason:
+            event_attributes[EventAttributes.RESULT_REASON] = str(details.reason).lower()
+
+            if details.reason == Reason.ERROR:
+                error_type = (details.error_code or ErrorCode.GENERAL).lower()
+                event_attributes[ERROR_TYPE] = error_type
+                if details.error_message:
+                    event_attributes["error.message"] = details.error_message
+
+        context = hook_context.evaluation_context
+        if context.targeting_key:
+            event_attributes[EventAttributes.CONTEXT_ID] = context.targeting_key
+
         if hook_context.provider_metadata:
             event_attributes[EventAttributes.PROVIDER_NAME] = (
                 hook_context.provider_metadata.name

hooks/openfeature-hooks-opentelemetry/tests/test_otel.py

@@ -6,29 +6,32 @@
 
 from openfeature.contrib.hook.opentelemetry import TracingHook
 from openfeature.evaluation_context import EvaluationContext
-from openfeature.flag_evaluation import FlagEvaluationDetails, FlagType
+from openfeature.exception import ErrorCode
+from openfeature.flag_evaluation import FlagEvaluationDetails, FlagType, Reason
 from openfeature.hook import HookContext
+from openfeature.provider.metadata import Metadata
 
 
 @pytest.fixture
 def mock_get_current_span(monkeypatch):
     monkeypatch.setattr(trace, "get_current_span", Mock())
 
 
-def test_before(mock_get_current_span):
+def test_after(mock_get_current_span):
     # Given
     hook = TracingHook()
     hook_context = HookContext(
         flag_key="flag_key",
         flag_type=FlagType.BOOLEAN,
         default_value=False,
-        evaluation_context=EvaluationContext(),
+        evaluation_context=EvaluationContext("123"),
+        provider_metadata=Metadata(name="test-provider")
     )
     details = FlagEvaluationDetails(
         flag_key="flag_key",
         value=True,
         variant="enabled",
-        reason=None,
+        reason=Reason.TARGETING_MATCH,
         error_code=None,
         error_message=None,
     )
@@ -41,14 +44,55 @@ def test_before(mock_get_current_span):
 
     # Then
     mock_span.add_event.assert_called_once_with(
-        "feature_flag",
+        "feature_flag.evaluation",
         {
             "feature_flag.key": "flag_key",
-            "feature_flag.variant": "enabled",
+            "feature_flag.result.value": "true",
+            "feature_flag.result.variant": "enabled",
+            "feature_flag.result.reason": "targeting_match",
+            "feature_flag.context.id": "123",
+            "feature_flag.provider.name": "test-provider",
         },
     )
 
 
+def test_after_evaluation_error(mock_get_current_span):
+    # Given
+    hook = TracingHook()
+    hook_context = HookContext(
+        flag_key="flag_key",
+        flag_type=FlagType.BOOLEAN,
+        default_value=False,
+        evaluation_context=EvaluationContext(),
+        provider_metadata=None,
+    )
+    details = FlagEvaluationDetails(
+        flag_key="flag_key",
+        value=False,
+        variant=None,
+        reason=Reason.ERROR,
+        error_code=ErrorCode.FLAG_NOT_FOUND,
+        error_message="Flag not found: flag_key",
+    )
+
+    mock_span = Mock(spec=Span)
+    trace.get_current_span.return_value = mock_span
+
+    # When
+    hook.after(hook_context, details, hints={})
+
+    # Then
+    mock_span.add_event.assert_called_once_with(
+        "feature_flag.evaluation",
+        {
+            "feature_flag.key": "flag_key",
+            "feature_flag.result.value": "false",
+            "feature_flag.result.reason": "error",
+            "error.type": "flag_not_found",
+            "error.message": "Flag not found: flag_key",
+        },
+    )
+
 def test_error(mock_get_current_span):
     # Given
     hook = TracingHook()