[Instrumentation.StackExchangeRedis] Connection registration changes

examples/redis/Examples.StackExchangeRedis/Program.cs

@@ -28,19 +28,21 @@ public static void Main()
          * docker run --name opentelemetry-redis-test -d -p 6379:6379 redis
          */
 
-        // connect to the redis server. The default port 6379 will be used.
-        var connection = ConnectionMultiplexer.Connect("localhost");
-
         // Configure exporter to export traces to Zipkin
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
                 .AddConsoleExporter()
-                .AddRedisInstrumentation(connection, options =>
+                .AddRedisInstrumentation(out var registry, options =>
                 {
                     // changing flush interval from 10s to 5s
                     options.FlushInterval = TimeSpan.FromSeconds(5);
                 })
                 .Build();
 
+        // Connect to the Redis server. The default port 6379 will be used.
+
+        var connection = ConnectionMultiplexer.Connect("localhost");
+        registry.Register(connection);
+
         // select a database (by default, DB = 0)
         var db = connection.GetDatabase();
         db.StringSet("key", "value " + DateTime.Now.ToLongDateString());

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

@@ -1,3 +1,8 @@
+OpenTelemetry.Instrumentation.StackExchangeRedis.ConnectionRegistry
+OpenTelemetry.Instrumentation.StackExchangeRedis.ConnectionRegistry.ConnectionRegistry() -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.ConnectionRegistry.Register(StackExchange.Redis.IConnectionMultiplexer connectionMultiplexer) -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry
+OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry.Register(StackExchange.Redis.IConnectionMultiplexer connectionMultiplexer) -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.Enrich.get -> System.Action<System.Diagnostics.Activity, StackExchange.Redis.Profiling.IProfiledCommand>
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.Enrich.set -> void
@@ -9,4 +14,7 @@ OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrume
 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
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, out OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry connectionRegistry) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, out OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry connectionRegistry, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, StackExchange.Redis.IConnectionMultiplexer connection, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder

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

@@ -1,3 +1,8 @@
+OpenTelemetry.Instrumentation.StackExchangeRedis.ConnectionRegistry
+OpenTelemetry.Instrumentation.StackExchangeRedis.ConnectionRegistry.ConnectionRegistry() -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.ConnectionRegistry.Register(StackExchange.Redis.IConnectionMultiplexer connectionMultiplexer) -> void
+OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry
+OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry.Register(StackExchange.Redis.IConnectionMultiplexer connectionMultiplexer) -> void
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.Enrich.get -> System.Action<System.Diagnostics.Activity, StackExchange.Redis.Profiling.IProfiledCommand>
 OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions.Enrich.set -> void
@@ -9,4 +14,7 @@ OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrume
 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
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, out OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry connectionRegistry) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, out OpenTelemetry.Instrumentation.StackExchangeRedis.IConnectionRegistry connectionRegistry, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddRedisInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, StackExchange.Redis.IConnectionMultiplexer connection, System.Action<OpenTelemetry.Instrumentation.StackExchangeRedis.StackExchangeRedisCallsInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder

src/OpenTelemetry.Instrumentation.StackExchangeRedis/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Add an ability to track connections created after tracer is initialized.
+  ([#1139](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/pull/1139))
+
 ## 1.0.0-rc9.8
 
 Released 2023-Feb-27

src/OpenTelemetry.Instrumentation.StackExchangeRedis/ConnectionRegistry.cs

@@ -0,0 +1,37 @@
+// <copyright file="ConnectionRegistry.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using System;
+using StackExchange.Redis;
+
+namespace OpenTelemetry.Instrumentation.StackExchangeRedis;
+
+/// <inheritdoc />
+public class ConnectionRegistry : IConnectionRegistry
+{
+    private Action<IConnectionMultiplexer> registrationCallback;
+
+    /// <inheritdoc />
+    public void Register(IConnectionMultiplexer connectionMultiplexer)
+    {
+        this.registrationCallback?.Invoke(connectionMultiplexer);
+    }
+
+    internal void Initialize(Action<IConnectionMultiplexer> callback)
+    {
+        this.registrationCallback = callback;
+    }
+}

src/OpenTelemetry.Instrumentation.StackExchangeRedis/IConnectionRegistry.cs

@@ -0,0 +1,31 @@
+// <copyright file="IConnectionRegistry.cs" company="OpenTelemetry Authors">
+// Copyright The OpenTelemetry Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+
+using StackExchange.Redis;
+
+namespace OpenTelemetry.Instrumentation.StackExchangeRedis;
+
+/// <summary>
+/// Registers connection for instrumentation purposes.
+/// </summary>
+public interface IConnectionRegistry
+{
+    /// <summary>
+    /// Registers connection with current instrumentation instance.
+    /// </summary>
+    /// <param name="connectionMultiplexer">Connection to be tracked by instrumentation.</param>
+    void Register(IConnectionMultiplexer connectionMultiplexer);
+}

src/OpenTelemetry.Instrumentation.StackExchangeRedis/README.md

@@ -36,9 +36,9 @@ dotnet add package OpenTelemetry.Instrumentation.StackExchangeRedis
 
 StackExchange.Redis instrumentation must be enabled at application startup.
 `AddRedisInstrumentation` method on `TracerProviderBuilder` must be called to
-enable Redis instrumentation, passing the `IConnectionMultiplexer` instance used
-to make Redis calls. Only those Redis calls made using the same instance of the
-`IConnectionMultiplexer` will be instrumented.
+enable Redis instrumentation. `AddRedisInstrumentation` returns
+`ConnectionRegistry` instance, that allows to register new connections with
+instrumentation instance.
 
 The following example demonstrates adding StackExchange.Redis instrumentation to
 a console application. This example also sets up the OpenTelemetry Console
@@ -53,13 +53,14 @@ public class Program
 {
     public static void Main(string[] args)
     {
-        // Connect to the server.
-        using var connection = ConnectionMultiplexer.Connect("localhost:6379");
-
         using var tracerProvider = Sdk.CreateTracerProviderBuilder()
-            .AddRedisInstrumentation(connection)
+            .AddRedisInstrumentation(out var connectionRegistry)
             .AddConsoleExporter()
             .Build();
+
+        // Connect to the server.
+        using var connection = ConnectionMultiplexer.Connect("localhost:6379");
+        connectionRegistry.Register(connection);
     }
 }
 ```

src/OpenTelemetry.Instrumentation.StackExchangeRedis/StackExchangeRedisCallsInstrumentation.cs

@@ -20,9 +20,7 @@
 using System.Diagnostics;
 using System.Threading;
 using OpenTelemetry.Instrumentation.StackExchangeRedis.Implementation;
-using OpenTelemetry.Internal;
 using OpenTelemetry.Trace;
-using StackExchange.Redis;
 using StackExchange.Redis.Profiling;
 
 namespace OpenTelemetry.Instrumentation.StackExchangeRedis;
@@ -55,12 +53,9 @@ internal class StackExchangeRedisCallsInstrumentation : IDisposable
     /// <summary>
     /// Initializes a new instance of the <see cref="StackExchangeRedisCallsInstrumentation"/> class.
     /// </summary>
-    /// <param name="connection"><see cref="IConnectionMultiplexer"/> to instrument.</param>
     /// <param name="options">Configuration options for redis instrumentation.</param>
-    public StackExchangeRedisCallsInstrumentation(IConnectionMultiplexer connection, StackExchangeRedisCallsInstrumentationOptions options)
+    public StackExchangeRedisCallsInstrumentation(StackExchangeRedisCallsInstrumentationOptions options)
     {
-        Guard.ThrowIfNull(connection);
-
         this.options = options ?? new StackExchangeRedisCallsInstrumentationOptions();
 
         this.drainThread = new Thread(this.DrainEntries)
@@ -69,8 +64,6 @@ public StackExchangeRedisCallsInstrumentation(IConnectionMultiplexer connection,
             IsBackground = true,
         };
         this.drainThread.Start();
-
-        connection.RegisterProfiler(this.GetProfilerSessionsFactory());
     }
 
     /// <summary>

src/OpenTelemetry.Instrumentation.StackExchangeRedis/TracerProviderBuilderExtensions.cs

@@ -26,6 +26,13 @@ namespace OpenTelemetry.Trace;
 /// </summary>
 public static class TracerProviderBuilderExtensions
 {
+    /// <summary>
+    /// Enables automatic data collection of outgoing requests to Redis.
+    /// </summary>
+    /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
+    /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
+    public static TracerProviderBuilder AddRedisInstrumentation(this TracerProviderBuilder builder) => AddRedisInstrumentation(builder, null, null);
+
     /// <summary>
     /// Enables automatic data collection of outgoing requests to Redis.
     /// </summary>
@@ -40,8 +47,8 @@ public static class TracerProviderBuilderExtensions
     /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
     public static TracerProviderBuilder AddRedisInstrumentation(
         this TracerProviderBuilder builder,
-        IConnectionMultiplexer connection = null,
-        Action<StackExchangeRedisCallsInstrumentationOptions> configure = null)
+        IConnectionMultiplexer connection,
+        Action<StackExchangeRedisCallsInstrumentationOptions> configure)
     {
         Guard.ThrowIfNull(builder);
 
@@ -52,7 +59,7 @@ public static TracerProviderBuilder AddRedisInstrumentation(
                 throw new NotSupportedException($"StackExchange.Redis {nameof(IConnectionMultiplexer)} must be supplied when dependency injection is unavailable - to enable dependency injection use the OpenTelemetry.Extensions.Hosting package");
             }
 
-            return AddRedisInstrumentation(builder, connection, new StackExchangeRedisCallsInstrumentationOptions(), configure);
+            return AddRedisInstrumentation(builder, new StackExchangeRedisCallsInstrumentationOptions(), configure, null, connection);
         }
 
         return deferredTracerProviderBuilder.Configure((sp, builder) =>
@@ -68,22 +75,77 @@ public static TracerProviderBuilder AddRedisInstrumentation(
 
             AddRedisInstrumentation(
                 builder,
-                connection,
                 sp.GetOptions<StackExchangeRedisCallsInstrumentationOptions>(),
-                configure);
+                configure,
+                null,
+                connection);
+        });
+    }
+
+    /// <summary>
+    /// Enables automatic data collection of outgoing requests to Redis.
+    /// </summary>
+    /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
+    /// <param name="connectionRegistry">Registry to register connections with.</param>
+    /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
+    public static TracerProviderBuilder AddRedisInstrumentation(
+        this TracerProviderBuilder builder,
+        out IConnectionRegistry connectionRegistry) => AddRedisInstrumentation(builder, out connectionRegistry, null);
+
+    /// <summary>
+    /// Enables automatic data collection of outgoing requests to Redis.
+    /// </summary>
+    /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
+    /// <param name="connectionRegistry">Registry to register connections with.</param>
+    /// <param name="configure">Optional callback to configure options.</param>
+    /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
+    public static TracerProviderBuilder AddRedisInstrumentation(
+        this TracerProviderBuilder builder,
+        out IConnectionRegistry connectionRegistry,
+        Action<StackExchangeRedisCallsInstrumentationOptions> configure)
+    {
+        Guard.ThrowIfNull(builder);
+
+        var defaultRegistry = new ConnectionRegistry();
+        connectionRegistry = defaultRegistry;
+
+        if (builder is not IDeferredTracerProviderBuilder deferredTracerProviderBuilder)
+        {
+            return AddRedisInstrumentation(builder, new StackExchangeRedisCallsInstrumentationOptions(), configure, defaultRegistry);
+        }
+
+        return deferredTracerProviderBuilder.Configure((sp, builder) =>
+        {
+            AddRedisInstrumentation(
+                builder,
+                sp.GetOptions<StackExchangeRedisCallsInstrumentationOptions>(),
+                configure,
+                defaultRegistry);
         });
     }
 
     private static TracerProviderBuilder AddRedisInstrumentation(
         TracerProviderBuilder builder,
-        IConnectionMultiplexer connection,
         StackExchangeRedisCallsInstrumentationOptions options,
-        Action<StackExchangeRedisCallsInstrumentationOptions> configure)
+        Action<StackExchangeRedisCallsInstrumentationOptions> configure,
+        ConnectionRegistry registry,
+        IConnectionMultiplexer connection = null)
     {
         configure?.Invoke(options);
 
-        return builder
-            .AddInstrumentation(() => new StackExchangeRedisCallsInstrumentation(connection, options))
+        StackExchangeRedisCallsInstrumentation stackExchangeRedisCallsInstrumentation = null;
+
+        var redisInstrumentation = builder
+            .AddInstrumentation(() =>
+            {
+                stackExchangeRedisCallsInstrumentation = new StackExchangeRedisCallsInstrumentation(options);
+                connection?.RegisterProfiler(stackExchangeRedisCallsInstrumentation?.GetProfilerSessionsFactory());
+
+                return stackExchangeRedisCallsInstrumentation;
+            })
             .AddSource(StackExchangeRedisCallsInstrumentation.ActivitySourceName);
+
+        registry?.Initialize(connectionMultiplexer => connectionMultiplexer.RegisterProfiler(stackExchangeRedisCallsInstrumentation?.GetProfilerSessionsFactory()));
+        return redisInstrumentation;
     }
 }

test/OpenTelemetry.Instrumentation.StackExchangeRedis.Tests/Implementation/RedisProfilerEntryToActivityConverterTests.cs

@@ -44,8 +44,9 @@ public RedisProfilerEntryToActivityConverterTests()
         this.connection = ConnectionMultiplexer.Connect(connectionOptions);
 
         this.tracerProvider = Sdk.CreateTracerProviderBuilder()
-            .AddRedisInstrumentation(this.connection)
+            .AddRedisInstrumentation(out var connectionRegistry)
             .Build();
+        connectionRegistry.Register(this.connection);
     }
 
     public void Dispose()