[Traces] Support named options in gRPC instrumentation (#3665)

* Support named options in grpc instrumentation. * CHANGELOG update.
open-telemetry · Sep 15, 2022 · 960908c · 960908c
1 parent 928d770
commit 960908c
Show file tree

Hide file tree

Showing 5 changed files with 73 additions and 12 deletions.
diff --git a/...Telemetry.Instrumentation.GrpcNetClient/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt b/...Telemetry.Instrumentation.GrpcNetClient/.publicApi/netstandard2.0/PublicAPI.Unshipped.txt
@@ -5,4 +5,6 @@ OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions.Grp
 OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions.SuppressDownstreamInstrumentation.get -> bool
 OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions.SuppressDownstreamInstrumentation.set -> void
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
-static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, System.Action<OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions> configure = null) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, string name, System.Action<OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, System.Action<OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
diff --git a/...Telemetry.Instrumentation.GrpcNetClient/.publicApi/netstandard2.1/PublicAPI.Unshipped.txt b/...Telemetry.Instrumentation.GrpcNetClient/.publicApi/netstandard2.1/PublicAPI.Unshipped.txt
@@ -5,4 +5,6 @@ OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions.Grp
 OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions.SuppressDownstreamInstrumentation.get -> bool
 OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions.SuppressDownstreamInstrumentation.set -> void
 OpenTelemetry.Trace.TracerProviderBuilderExtensions
-static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, System.Action<OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions> configure = null) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, string name, System.Action<OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
+static OpenTelemetry.Trace.TracerProviderBuilderExtensions.AddGrpcClientInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, System.Action<OpenTelemetry.Instrumentation.GrpcNetClient.GrpcClientInstrumentationOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder
diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md b/src/OpenTelemetry.Instrumentation.GrpcNetClient/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+* Added overloads which accept a name to the `TracerProviderBuilder`
+  `AddGrpcClientInstrumentation` extension to allow for more fine-grained
+  options management
+  ([#3665](https://github.com/open-telemetry/opentelemetry-dotnet/pull/3665))
+
 ## 1.0.0-rc9.6
 
 Released 2022-Aug-18

diff --git a/src/OpenTelemetry.Instrumentation.GrpcNetClient/TracerProviderBuilderExtensions.cs b/src/OpenTelemetry.Instrumentation.GrpcNetClient/TracerProviderBuilderExtensions.cs
@@ -15,38 +15,68 @@
 // </copyright>
 
 using System;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
 using OpenTelemetry.Instrumentation.GrpcNetClient;
 using OpenTelemetry.Instrumentation.GrpcNetClient.Implementation;
 using OpenTelemetry.Internal;
 
 namespace OpenTelemetry.Trace
 {
     /// <summary>
-    /// Extension methods to simplify registering of gRPClient
+    /// Extension methods to simplify registering of gRPC client
     /// instrumentation.
     /// </summary>
     public static class TracerProviderBuilderExtensions
     {
         /// <summary>
-        /// Enables gRPClient Instrumentation.
+        /// Enables gRPC client instrumentation.
         /// </summary>
         /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
-        /// <param name="configure">GrpcClient configuration options.</param>
+        /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
+        public static TracerProviderBuilder AddGrpcClientInstrumentation(this TracerProviderBuilder builder)
+            => AddGrpcClientInstrumentation(builder, name: null, configure: null);
+
+        /// <summary>
+        /// Enables gRPC client instrumentation.
+        /// </summary>
+        /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
+        /// <param name="configure">Callback action for configuring <see cref="GrpcClientInstrumentationOptions"/>.</param>
         /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
         public static TracerProviderBuilder AddGrpcClientInstrumentation(
             this TracerProviderBuilder builder,
-            Action<GrpcClientInstrumentationOptions> configure = null)
+            Action<GrpcClientInstrumentationOptions> configure)
+            => AddGrpcClientInstrumentation(builder, name: null, configure);
+
+        /// <summary>
+        /// Enables gRPC client instrumentation.
+        /// </summary>
+        /// <param name="builder"><see cref="TracerProviderBuilder"/> being configured.</param>
+        /// <param name="name">Name which is used when retrieving options.</param>
+        /// <param name="configure">Callback action for configuring <see cref="GrpcClientInstrumentationOptions"/>.</param>
+        /// <returns>The instance of <see cref="TracerProviderBuilder"/> to chain the calls.</returns>
+        public static TracerProviderBuilder AddGrpcClientInstrumentation(
+            this TracerProviderBuilder builder,
+            string name,
+            Action<GrpcClientInstrumentationOptions> configure)
         {
             Guard.ThrowIfNull(builder);
 
-            var grpcOptions = new GrpcClientInstrumentationOptions();
-            configure?.Invoke(grpcOptions);
+            name ??= Options.DefaultName;
+
+            if (configure != null)
+            {
+                builder.ConfigureServices(services => services.Configure(name, configure));
+            }
 
-            builder.AddInstrumentation(() => new GrpcClientInstrumentation(grpcOptions));
-            builder.AddSource(GrpcClientDiagnosticListener.ActivitySourceName);
-            builder.AddLegacySource("Grpc.Net.Client.GrpcOut");
+            return builder.ConfigureBuilder((sp, builder) =>
+            {
+                var options = sp.GetRequiredService<IOptionsMonitor<GrpcClientInstrumentationOptions>>().Get(name);
 
-            return builder;
+                builder.AddInstrumentation(() => new GrpcClientInstrumentation(options));
+                builder.AddSource(GrpcClientDiagnosticListener.ActivitySourceName);
+                builder.AddLegacySource("Grpc.Net.Client.GrpcOut");
+            });
         }
     }
 }
diff --git a/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs b/test/OpenTelemetry.Instrumentation.Grpc.Tests/GrpcTests.client.cs
@@ -23,6 +23,7 @@
 using Greet;
 using Grpc.Core;
 using Grpc.Net.Client;
+using Microsoft.Extensions.DependencyInjection;
 #if NET6_0_OR_GREATER
 using Microsoft.AspNetCore.Http;
 #endif
@@ -442,6 +443,27 @@ public void GrpcClientInstrumentationRespectsSdkSuppressInstrumentation()
         }
 #endif
 
+        [Fact]
+        public void AddGrpcClientInstrumentationNamedOptionsSupported()
+        {
+            int defaultExporterOptionsConfigureOptionsInvocations = 0;
+            int namedExporterOptionsConfigureOptionsInvocations = 0;
+
+            using var tracerProvider = Sdk.CreateTracerProviderBuilder()
+                .ConfigureServices(services =>
+                {
+                    services.Configure<GrpcClientInstrumentationOptions>(o => defaultExporterOptionsConfigureOptionsInvocations++);
+
+                    services.Configure<GrpcClientInstrumentationOptions>("Instrumentation2", o => namedExporterOptionsConfigureOptionsInvocations++);
+                })
+                .AddGrpcClientInstrumentation()
+                .AddGrpcClientInstrumentation("Instrumentation2", configure: null)
+                .Build();
+
+            Assert.Equal(1, defaultExporterOptionsConfigureOptionsInvocations);
+            Assert.Equal(1, namedExporterOptionsConfigureOptionsInvocations);
+        }
+
         [Fact]
         public void Grpc_BadArgs()
         {