refactor: Replace OtelHook with TracingHook. Deprecating OtelHook (#116)

Signed-off-by: André Silva <[email protected]>
open-feature · Dec 18, 2023 · 755c549 · 755c549
1 parent 7697585
commit 755c549
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 26 deletions.
diff --git a/src/OpenFeature.Contrib.Hooks.Otel/OtelHook.cs b/src/OpenFeature.Contrib.Hooks.Otel/OtelHook.cs
@@ -1,18 +1,20 @@
-using OpenFeature;
-using OpenFeature.Model;
+using OpenFeature.Model;
 using System.Threading.Tasks;
 using System.Collections.Generic;
-using OpenTelemetry.Context.Propagation;
-using OpenTelemetry.Trace;
+using System.Diagnostics.CodeAnalysis;
+using System;
 
 namespace OpenFeature.Contrib.Hooks.Otel
 
 {
     /// <summary>
     /// Stub.
     /// </summary>
+    [ExcludeFromCodeCoverage]
+    [Obsolete("This class is obsolete and will be removed in a future version. Please use TracingHook instead.")]
     public class OtelHook : Hook
     {
+        private readonly TracingHook _tracingHook = new TracingHook();
 
         /// <summary>
         ///     After is executed after a feature flag has been evaluated.
@@ -24,17 +26,7 @@ public class OtelHook : Hook
         public override Task After<T>(HookContext<T> context, FlagEvaluationDetails<T> details,
             IReadOnlyDictionary<string, object> hints = null)
         {
-            var span = Tracer.CurrentSpan;
-            if (span != null)
-            {
-                var attributes = new Dictionary<string, object>
-                {
-                    {"feature_flag.key", details.FlagKey},
-                    {"feature_flag.variant", details.Variant},
-                    {"feature_flag.provider_name", context.ProviderMetadata.Name}
-                };
-                span.AddEvent("feature_flag", new SpanAttributes(attributes));
-            }
+            _tracingHook.After(context, details, hints);
 
             return Task.CompletedTask;
         }
@@ -49,11 +41,7 @@ public override Task After<T>(HookContext<T> context, FlagEvaluationDetails<T> d
         public override Task Error<T>(HookContext<T> context, System.Exception error,
             IReadOnlyDictionary<string, object> hints = null)
         {
-            var span = Tracer.CurrentSpan;
-            if (span != null)
-            {
-                span.RecordException(error);
-            }
+            _tracingHook.Error(context, error, hints);
 
             return Task.CompletedTask;
         }

diff --git a/src/OpenFeature.Contrib.Hooks.Otel/README.md b/src/OpenFeature.Contrib.Hooks.Otel/README.md
@@ -12,6 +12,7 @@ The `open telemetry hook` taps into the after and error methods of the hook life
 For this, an active span must be set in the `Tracer`, otherwise the hook will no-op.
 
 ### Example
+
 The following example demonstrates the use of the `OpenTelemetry hook` with the `OpenFeature dotnet-sdk`. The traces are sent to a `jaeger` OTLP collector running at `localhost:4317`.
 
 ```csharp
@@ -38,7 +39,7 @@ namespace OpenFeatureTestApp
                     .Build();
 
 			// add the Otel Hook to the OpenFeature instance
-		    OpenFeature.Api.Instance.AddHooks(new OtelHook());
+		    OpenFeature.Api.Instance.AddHooks(new TracingHook());
 
             var flagdProvider = new FlagdProvider(new Uri("http://localhost:8013"));
 

diff --git a/src/OpenFeature.Contrib.Hooks.Otel/TracingHook.cs b/src/OpenFeature.Contrib.Hooks.Otel/TracingHook.cs
@@ -0,0 +1,62 @@
+using OpenFeature.Model;
+using System.Threading.Tasks;
+using System.Collections.Generic;
+using OpenTelemetry.Trace;
+
+namespace OpenFeature.Contrib.Hooks.Otel
+
+{
+    /// <summary>
+    /// Stub.
+    /// </summary>
+    public class TracingHook : Hook
+    {
+
+        /// <summary>
+        ///     After is executed after a feature flag has been evaluated.
+        /// </summary>
+        /// <param name="context">The hook context</param>
+        /// <param name="details">The result of the feature flag evaluation</param>
+        /// <param name="hints">Hints for the feature flag evaluation</param>
+        /// <returns>An awaitable Task object</returns>
+        public override Task After<T>(HookContext<T> context, FlagEvaluationDetails<T> details,
+            IReadOnlyDictionary<string, object> hints = null)
+        {
+            var span = Tracer.CurrentSpan;
+            if (span != null)
+            {
+                var attributes = new Dictionary<string, object>
+                {
+                    {"feature_flag.key", details.FlagKey},
+                    {"feature_flag.variant", details.Variant},
+                    {"feature_flag.provider_name", context.ProviderMetadata.Name}
+                };
+                span.AddEvent("feature_flag", new SpanAttributes(attributes));
+            }
+
+            return Task.CompletedTask;
+        }
+
+        /// <summary>
+        ///     Error is executed when an error during a feature flag evaluation occured.
+        /// </summary>
+        /// <param name="context">The hook context</param>
+        /// <param name="error">The exception thrown by feature flag provider</param>
+        /// <param name="hints">Hints for the feature flag evaluation</param>
+        /// <returns>An awaitable Task object</returns>
+        public override Task Error<T>(HookContext<T> context, System.Exception error,
+            IReadOnlyDictionary<string, object> hints = null)
+        {
+            var span = Tracer.CurrentSpan;
+            if (span != null)
+            {
+                span.RecordException(error);
+            }
+
+            return Task.CompletedTask;
+        }
+
+    }
+}
+
+
diff --git a/...e.Contrib.Hooks.Otel.Test/OtelHookTest.cs → ...ontrib.Hooks.Otel.Test/TracingHookTest.cs b/...e.Contrib.Hooks.Otel.Test/OtelHookTest.cs → ...ontrib.Hooks.Otel.Test/TracingHookTest.cs
@@ -10,7 +10,7 @@
 
 namespace OpenFeature.Contrib.Hooks.Otel.Test
 {
-    public class OtelHookTest
+    public class TracingHookTest
     {
         [Fact]
         public void TestAfter()
@@ -32,7 +32,7 @@ public void TestAfter()
 
             var span = tracer.StartActiveSpan("my-span");
 
-            var otelHook = new OtelHook();
+            var otelHook = new TracingHook();
 
             var evaluationContext = OpenFeature.Model.EvaluationContext.Empty;
 
@@ -93,7 +93,7 @@ public void TestAfterNoSpan()
 
             var tracer = tracerProvider.GetTracer("my-tracer");
 
-            var otelHook = new OtelHook();
+            var otelHook = new TracingHook();
 
             var evaluationContext = OpenFeature.Model.EvaluationContext.Empty;
 
@@ -126,7 +126,7 @@ public void TestError()
 
             var span = tracer.StartActiveSpan("my-span");
 
-            var otelHook = new OtelHook();
+            var otelHook = new TracingHook();
 
             var evaluationContext = OpenFeature.Model.EvaluationContext.Empty;
 
@@ -175,7 +175,7 @@ public void TestErrorNoSpan()
 
             var tracer = tracerProvider.GetTracer("my-tracer");
 
-            var otelHook = new OtelHook();
+            var otelHook = new TracingHook();
 
             var evaluationContext = OpenFeature.Model.EvaluationContext.Empty;