Redis: Adding the ability to disable adding Events to Activities (#416)

open-telemetry · Jun 24, 2022 · e252892 · e252892
1 parent 338d5b2
commit e252892
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 3 deletions.
diff --git a/...penTelemetry.Instrumentation.StackExchangeRedis/.publicApi/net462/PublicAPI.Unshipped.txt b/...penTelemetry.Instrumentation.StackExchangeRedis/.publicApi/net462/PublicAPI.Unshipped.txt
@@ -6,5 +6,7 @@ OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrume
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.SetVerboseDatabaseStatements.get -> bool
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.SetVerboseDatabaseStatements.set -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.StackExchangeRedisCallsInstrumentationOptions() -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.EnrichActivityWithTimingEvents.get -> bool
+OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.EnrichActivityWithTimingEvents.set -> void
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, StackExchange.Redis.IConnectionMultiplexer connection = null, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions> configure = null) -> OpenTelemetry.Trace.TracerProviderBuilder
diff --git a/...etry.Instrumentation.StackExchangeRedis/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt b/...etry.Instrumentation.StackExchangeRedis/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt
@@ -6,5 +6,7 @@ OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrume
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.SetVerboseDatabaseStatements.get -> bool
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.SetVerboseDatabaseStatements.set -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.StackExchangeRedisCallsInstrumentationOptions() -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.EnrichActivityWithTimingEvents.get -> bool
+OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.EnrichActivityWithTimingEvents.set -> void
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
 static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, StackExchange.Redis.IConnectionMultiplexer connection = null, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions> configure = null) -> OpenTelemetry.Trace.TracerProviderBuilder
diff --git a/src/OpenTelemetry.Instrumentation.StackExchangeRedis/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.StackExchangeRedis/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+* Added the EnrichActivityWithTimingEvents option to
+  StackExchangeRedisCallsInstrumentationOptions to be able to disable adding
+  ActivityEvents (Enqueued, Sent, ResponseReceived) for Redis commands to
+  Activities since there is no way to clear these after they have been added.
+  This defaults to true to maintain current functionality.
+
 ## 1.0.0-rc9.5 (source code moved to contrib repo)
 
 Released 2022-Jun-06

diff --git a/...nstrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryToActivityConverter.cs b/...nstrumentation.StackExchangeRedis/Implementation/RedisProfilerEntryToActivityConverter.cs
@@ -164,9 +164,12 @@ public static Activity ProfilerCommandToActivity(Activity parentActivity, IProfi
                 var send = enqueued.Add(command.EnqueuedToSending);
                 var response = send.Add(command.SentToResponse);
 
-                activity.AddEvent(new ActivityEvent("Enqueued", enqueued));
-                activity.AddEvent(new ActivityEvent("Sent", send));
-                activity.AddEvent(new ActivityEvent("ResponseReceived", response));
+                if (options.EnrichActivityWithTimingEvents)
+                {
+                    activity.AddEvent(new ActivityEvent("Enqueued", enqueued));
+                    activity.AddEvent(new ActivityEvent("Sent", send));
+                    activity.AddEvent(new ActivityEvent("ResponseReceived", response));
+                }
 
                 options.Enrich?.Invoke(activity, command);
             }

diff --git a/...metry.Instrumentation.StackExchangeRedis/StackExchangeRedisCallsInstrumentationOptions.cs b/...metry.Instrumentation.StackExchangeRedis/StackExchangeRedisCallsInstrumentationOptions.cs
@@ -44,5 +44,10 @@ public class StackExchangeRedisCallsInstrumentationOptions
         /// <para><see cref="IProfiledCommand"/>: the profiled redis command from which additional information can be extracted to enrich the activity.</para>
         /// </remarks>
         public Action<Activity, IProfiledCommand> Enrich { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether or not the <see cref="StackExchangeRedisCallsInstrumentation"/> should enrich Activity with <see cref="ActivityEvent"/> entries about the Redis command processing/lifetime. Defaults to <see cref="bool">true</see>.
+        /// </summary>
+        public bool EnrichActivityWithTimingEvents { get; set; } = true;
     }
 }