[StackExchangeRedis] Pass ParentActivity to Filter and Enrich to compensate for Activity.Current always being null (#2977)

Co-authored-by: Piotr Kiełkowicz <[email protected]>

Author: aradalvand

src/OpenTelemetry.Instrumentation.StackExchangeRedis/.publicApi/PublicAPI.Unshipped.txt

@@ -1,20 +1,31 @@
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.Deconstruct(out System.Diagnostics.Activity? ParentActivity, out StackExchange.Redis.Profiling.IProfiledCommand! ProfiledCommand) -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.ParentActivity.get -> System.Diagnostics.Activity?
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.ParentActivity.init -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.ProfiledCommand.get -> StackExchange.Redis.Profiling.IProfiledCommand!
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.ProfiledCommand.init -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.RedisInstrumentationContext() -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.RedisInstrumentationContext(System.Diagnostics.Activity? ParentActivity, StackExchange.Redis.Profiling.IProfiledCommand! ProfiledCommand) -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentation
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentation.AddConnection(StackExchange.Redis.IConnectionMultiplexer! connection) -> System.IDisposable!
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentation.AddConnection(string! name, StackExchange.Redis.IConnectionMultiplexer! connection) -> System.IDisposable!
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentation.Dispose() -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions
-OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.Enrich.get -> System.Action<System.Diagnostics.Activity!, StackExchange.Redis.Profiling.IProfiledCommand!>?
+OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.Enrich.get -> System.Action<System.Diagnostics.Activity!, OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext>?
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.Enrich.set -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.EnrichActivityWithTimingEvents.get -> bool
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.EnrichActivityWithTimingEvents.set -> void
-OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.Filter.get -> System.Func<StackExchange.Redis.Profiling.IProfiledCommand!, bool>?
+OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.Filter.get -> System.Func<OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext, bool>?
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.Filter.set -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.FlushInterval.get -> System.TimeSpan
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.FlushInterval.set -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.SetVerboseDatabaseStatements.get -> bool
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.SetVerboseDatabaseStatements.set -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions.StackExchangeRedisInstrumentationOptions() -> void
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
+override OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.GetHashCode() -> int
+static OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.operator ==(OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext left, OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext right) -> bool
+static OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.operator !=(OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext left, OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext right) -> bool
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder! builder) -> OpenTelemetry.Trace.TracerProviderBuilder!
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder! builder, object! serviceKey) -> OpenTelemetry.Trace.TracerProviderBuilder!
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder! builder, StackExchange.Redis.IConnectionMultiplexer! connection) -> OpenTelemetry.Trace.TracerProviderBuilder!
@@ -24,3 +35,6 @@ static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentati
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder! builder, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentationOptions!>! configure) -> OpenTelemetry.Trace.TracerProviderBuilder!
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder! builder, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentation!>! configure) -> OpenTelemetry.Trace.TracerProviderBuilder!
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.ConfigureRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder! builder, System.Action<System.IServiceProvider!, OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisInstrumentation!>! configure) -> OpenTelemetry.Trace.TracerProviderBuilder!
+~override OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.ToString() -> string
+~override OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.Equals(object obj) -> bool
+OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext.Equals(OpenTelemetry.Instrumentation.StackExchangeRedis.RedisInstrumentationContext other) -> bool

src/OpenTelemetry.Instrumentation.StackExchangeRedis/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+* **Breaking change** Introduce `RedisInstrumentationContext` and use it
+  as context for `Filter`
+  ([#2977](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2977))
+
 * Removed the `db.redis.flags` attribute from the implementation
   as it is not part of the Semantic Conventions for Database Client Calls.
  ([#2982](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/2982))

src/OpenTelemetry.Instrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryToActivityConverter.cs

@@ -75,7 +75,7 @@ static bool GetCommandAndKey(
     {
         try
         {
-            if (options.Filter != null && !options.Filter(command))
+            if (options.Filter != null && !options.Filter(new(parentActivity, command)))
             {
                 return null;
             }
@@ -184,7 +184,7 @@ static bool GetCommandAndKey(
                 activity.AddEvent(new ActivityEvent("ResponseReceived", response));
             }
 
-            options.Enrich?.Invoke(activity, command);
+            options.Enrich?.Invoke(activity, new(parentActivity, command));
         }
 
         activity.Stop();

src/OpenTelemetry.Instrumentation.StackExchangeRedis/IsExternalInit.cs

@@ -0,0 +1,7 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+namespace System.Runtime.CompilerServices;
+
+// NOTE: Needed for C# 9 record types in projects that target frameworks prior to .NET 5. See https://stackoverflow.com/a/64749403
+internal static class IsExternalInit;

src/OpenTelemetry.Instrumentation.StackExchangeRedis/RedisInstrumentationContext.cs

@@ -0,0 +1,21 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+using System.Diagnostics;
+using StackExchange.Redis.Profiling;
+
+namespace OpenTelemetry.Instrumentation.StackExchangeRedis;
+
+/// <summary>
+/// Represents contextual information about a profiled Redis command off of which an <see cref="Activity"/> can be created.
+/// </summary>
+/// <param name="ParentActivity">
+/// The parent activity associated with the profiled command.
+/// <see cref="Activity.Current"/> is not guaranteed to be the parent activity since commands are profiled asynchronously.
+/// </param>
+/// <param name="ProfiledCommand">
+/// The profiled Redis command.
+/// </param>
+public readonly record struct RedisInstrumentationContext(
+    Activity? ParentActivity,
+    IProfiledCommand ProfiledCommand);

src/OpenTelemetry.Instrumentation.StackExchangeRedis/StackExchangeRedisInstrumentationOptions.cs

@@ -3,7 +3,6 @@
 
 using System.Diagnostics;
 using OpenTelemetry.Trace;
-using StackExchange.Redis.Profiling;
 
 namespace OpenTelemetry.Instrumentation.StackExchangeRedis;
 
@@ -23,26 +22,26 @@ public class StackExchangeRedisInstrumentationOptions
     public bool SetVerboseDatabaseStatements { get; set; }
 
     /// <summary>
-    /// Gets or sets a callback method allowing to filter out particular <see cref="IProfiledCommand"/> instances.
+    /// Gets or sets a callback method allowing to filter out particular <see cref="RedisInstrumentationContext"/> instances.
     /// </summary>
     /// <remarks>
-    /// The filter callback receives the <see cref="IProfiledCommand"/> for the
+    /// The filter callback receives the <see cref="RedisInstrumentationContext"/> for the
     /// processed profiled command and returns a boolean indicating whether it should be filtered out.
     /// <list type="bullet">
     /// <item>If filter returns <see langword="true"/> the event is collected.</item>
     /// <item>If filter returns <see langword="false"/> or throws an exception the event is filtered out (NOT collected).</item>
     /// </list>
     /// </remarks>
-    public Func<IProfiledCommand, bool>? Filter { get; set; }
+    public Func<RedisInstrumentationContext, bool>? Filter { get; set; }
 
     /// <summary>
     /// Gets or sets an action to enrich an Activity.
     /// </summary>
     /// <remarks>
     /// <para><see cref="Activity"/>: the activity being enriched.</para>
-    /// <para><see cref="IProfiledCommand"/>: the profiled redis command from which additional information can be extracted to enrich the activity.</para>
+    /// <para><see cref="RedisInstrumentationContext"/>: the profiled redis command from which additional information can be extracted to enrich the activity.</para>
     /// </remarks>
-    public Action<Activity, IProfiledCommand>? Enrich { get; set; }
+    public Action<Activity, RedisInstrumentationContext>? Enrich { get; set; }
 
     /// <summary>
     /// Gets or sets a value indicating whether the <see cref="StackExchangeRedisConnectionInstrumentation"/> should enrich Activity with <see cref="ActivityEvent"/> entries about the Redis command processing/lifetime. Defaults to <see langword="true"/>.

test/OpenTelemetry.Instrumentation.StackExchangeRedis.Tests/StackExchangeRedisCallsInstrumentationTests.cs

@@ -184,9 +184,9 @@ public void CanEnrichActivityFromCommand(string value)
         var builder = Sdk.CreateTracerProviderBuilder()
             .AddInMemoryExporter(exportedItems)
             .SetSampler(sampler)
-            .AddRedisInstrumentation(c => c.Enrich = (activity, command) =>
+            .AddRedisInstrumentation(c => c.Enrich = (activity, context) =>
             {
-                if (command.ElapsedTime < TimeSpan.FromMilliseconds(100))
+                if (context.ProfiledCommand.ElapsedTime < TimeSpan.FromMilliseconds(100))
                 {
                     activity.AddTag("is_fast", true);
                 }
@@ -367,9 +367,9 @@ public void StackExchangeRedis_StackExchangeRedisInstrumentation_Test()
 
         var builder = Sdk.CreateTracerProviderBuilder()
             .SetSampler(sampler)
-            .AddRedisInstrumentation(c => c.Enrich = (activity, command) =>
+            .AddRedisInstrumentation(c => c.Enrich = (activity, context) =>
             {
-                if (command.ElapsedTime < TimeSpan.FromMilliseconds(100))
+                if (context.ProfiledCommand.ElapsedTime < TimeSpan.FromMilliseconds(100))
                 {
                     activity.AddTag("is_fast", true);
                 }
@@ -414,7 +414,7 @@ public void FilterOption_FiltersOutSpecifiedCommands(string value)
             .AddInMemoryExporter(exportedItems)
             .AddRedisInstrumentation(connection, options =>
             {
-                options.Filter = command => !string.Equals(command.Command, "GET", StringComparison.OrdinalIgnoreCase);
+                options.Filter = context => !string.Equals(context.ProfiledCommand.Command, "GET", StringComparison.OrdinalIgnoreCase);
             })
             .Build())
         {