* Removed the BaggagePropagation configuration value.

stebet · stebet · commit 7c182411a7a7 · 2024-04-03T09:02:53.000Z
* Use the DefaultTextMapPropagator and make it possible for uses to configure their own.
* Updated tests to configure the propagator.
* Updating README.md with basic instructions for use
diff --git a/projects/RabbitMQ.Client.OpenTelemetry/README.md b/projects/RabbitMQ.Client.OpenTelemetry/README.md
@@ -1 +1,54 @@
-# RabbitMQ .NET Client - OAuth2
+# RabbitMQ .NET Client - OpenTelemetry Instrumentation
+
+## Introduction
+This library makes it easy to instrument your RabbitMQ .NET Client applications with OpenTelemetry.
+
+## Examples
+The following examples demonstrate how to use the RabbitMQ .NET Client OpenTelemetry Instrumentation.
+
+### Basic Usage
+
+#### ASP.NET Core Configuration Example
+```csharp
+using OpenTelemetry.Trace;
+
+// Configure the OpenTelemetry SDK to trace ASP.NET Core, the RabbitMQ .NET Client and export the traces to the console.
+// Also configures context propagation to propagate the TraceContext and Baggage using the W3C specification.
+
+var compositeTextMapPropagator = new CompositeTextMapPropagator(new TextMapPropagator[]
+{
+    new TraceContextPropagator(),
+    new BaggagePropagator()
+});
+
+Sdk.SetDefaultTextMapPropagator(compositeTextMapPropagator);
+
+builder.Services.AddOpenTelemetry()
+    .ConfigureResource(resource => resource
+        .AddService(serviceName: builder.Environment.ApplicationName))
+    .WithTracing(tracing => tracing
+        .AddAspNetCoreInstrumentation()
+        .AddRabbitMQInstrumentation()
+        .AddConsoleExporter());
+```
+
+#### Console Application Configuration Example
+```csharp
+using OpenTelemetry.Trace;
+
+// Configure the OpenTelemetry SDK to trace ASP.NET Core, the RabbitMQ .NET Client and export the traces to the console.
+// Also configures context propagation to propagate the TraceContext and Baggage using the W3C specification.
+
+var compositeTextMapPropagator = new CompositeTextMapPropagator(new TextMapPropagator[]
+{
+    new TraceContextPropagator(),
+    new BaggagePropagator()
+});
+
+Sdk.SetDefaultTextMapPropagator(compositeTextMapPropagator);
+
+var tracerProvider = Sdk.CreateTracerProviderBuilder()
+    .AddRabbitMQInstrumentation()
+    .AddConsoleExporter()
+    .Build();
+```
diff --git a/projects/RabbitMQ.Client.OpenTelemetry/RabbitMQOpenTelemetryConfiguration.cs b/projects/RabbitMQ.Client.OpenTelemetry/RabbitMQOpenTelemetryConfiguration.cs
@@ -2,9 +2,18 @@ namespace RabbitMQ.Client.OpenTelemetry
 {
     public class RabbitMQOpenTelemetryConfiguration
     {
-        public bool PropagateBaggage { get; set; } = true;
-        public bool UseRoutingKeyAsOperationName { get; set; } = true;
-        public bool IncludePublishers { get; set; } = true;
-        public bool IncludeSubscribers { get; set; } = true;
+        public RabbitMQOpenTelemetryConfiguration(bool useRoutingKeyAsOperationName = true,
+            bool includePublishers = true,
+            bool includeSubscribers = true)
+        {
+            UseRoutingKeyAsOperationName = useRoutingKeyAsOperationName;
+            IncludePublishers = includePublishers;
+            IncludeSubscribers = includeSubscribers;
+        }
+
+        public bool UseRoutingKeyAsOperationName { get; }
+        public bool IncludePublishers { get; }
+        public bool IncludeSubscribers { get; }
+        public static RabbitMQOpenTelemetryConfiguration Default { get; } = new RabbitMQOpenTelemetryConfiguration();
     }
 }
diff --git a/projects/RabbitMQ.Client.OpenTelemetry/TraceProviderBuilderExtensions.cs b/projects/RabbitMQ.Client.OpenTelemetry/TraceProviderBuilderExtensions.cs
@@ -11,23 +11,14 @@ namespace OpenTelemetry.Trace
 {
     public static class OpenTelemetryExtensions
     {
-        internal static TextMapPropagator s_propagator = Propagators.DefaultTextMapPropagator;
-
-        public static TracerProviderBuilder AddRabbitMQ(this TracerProviderBuilder builder,
-            RabbitMQOpenTelemetryConfiguration configuration)
+        public static TracerProviderBuilder AddRabbitMQInstrumentation(this TracerProviderBuilder builder,
+            RabbitMQOpenTelemetryConfiguration configuration = null)
         {
-            if (configuration.PropagateBaggage)
+            if (configuration == null)
             {
-                s_propagator = new CompositeTextMapPropagator(new TextMapPropagator[]
-                {
-                    new TraceContextPropagator(), new BaggagePropagator()
-                });
+                configuration = RabbitMQOpenTelemetryConfiguration.Default;
             }
-            else
-            {
-                s_propagator = new TraceContextPropagator();
-            }
-
+            
             RabbitMQActivitySource.UseRoutingKeyAsOperationName = configuration.UseRoutingKeyAsOperationName;
             RabbitMQActivitySource.ContextExtractor = OpenTelemetryContextExtractor;
             RabbitMQActivitySource.ContextInjector = OpenTelemetryContextInjector;
@@ -48,7 +39,7 @@ public static TracerProviderBuilder AddRabbitMQ(this TracerProviderBuilder build
         private static ActivityContext OpenTelemetryContextExtractor(IReadOnlyBasicProperties props)
         {
             // Extract the PropagationContext of the upstream parent from the message headers.
-            var parentContext = s_propagator.Extract(default, props.Headers, OpenTelemetryContextGetter);
+            var parentContext =  Propagators.DefaultTextMapPropagator.Extract(default, props.Headers, OpenTelemetryContextGetter);
             Baggage.Current = parentContext.Baggage;
             return parentContext.ActivityContext;
         }
@@ -57,9 +48,8 @@ private static IEnumerable<string> OpenTelemetryContextGetter(IDictionary<string
         {
             try
             {
-                if (carrier.TryGetValue(key, out object value))
+                if (carrier.TryGetValue(key, out object value) && value is byte[] bytes)
                 {
-                    byte[] bytes = value as byte[];
                     return new[] { Encoding.UTF8.GetString(bytes) };
                 }
             }
@@ -74,7 +64,7 @@ private static IEnumerable<string> OpenTelemetryContextGetter(IDictionary<string
         private static void OpenTelemetryContextInjector(Activity activity, IDictionary<string, object> props)
         {
             // Inject the current Activity's context into the message headers.
-            s_propagator.Inject(new PropagationContext(activity.Context, Baggage.Current), props, OpenTelemetryContextSetter);
+            Propagators.DefaultTextMapPropagator.Inject(new PropagationContext(activity.Context, Baggage.Current), props, OpenTelemetryContextSetter);
         }
 
         private static void OpenTelemetryContextSetter(IDictionary<string, object> carrier, string key, string value)
diff --git a/projects/Test/OTel/TestOpenTelemetry.cs b/projects/Test/OTel/TestOpenTelemetry.cs
@@ -36,6 +36,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using OpenTelemetry;
+using OpenTelemetry.Context.Propagation;
 using OpenTelemetry.Trace;
 using RabbitMQ.Client;
 using RabbitMQ.Client.Events;
@@ -51,6 +52,10 @@ public class TestOpenTelemetry : SequentialIntegrationFixture
     {
         public TestOpenTelemetry(ITestOutputHelper output) : base(output)
         {
+            Sdk.SetDefaultTextMapPropagator(new CompositeTextMapPropagator(new TextMapPropagator[]
+            {
+                new TraceContextPropagator(), new BaggagePropagator()
+            }));
         }
 
         void AssertStringTagEquals(Activity activity, string name, string expected)
@@ -86,7 +91,7 @@ public async Task TestPublisherAndConsumerActivityTags(bool useRoutingKeyAsOpera
         {
             var exportedItems = new List<Activity>();
             using (var tracer = Sdk.CreateTracerProviderBuilder()
-                       .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())
+                       .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())
                        .AddInMemoryExporter(exportedItems)
                        .Build())
             {
@@ -141,7 +146,7 @@ public async Task TestPublisherAndConsumerActivityTagsAsync(bool useRoutingKeyAs
         {
             var exportedItems = new List<Activity>();
             using (var tracer = Sdk.CreateTracerProviderBuilder()
-                       .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())
+                       .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())
                        .AddInMemoryExporter(exportedItems)
                        .Build())
             {
@@ -197,7 +202,7 @@ public async Task TestPublisherWithPublicationAddressAndConsumerActivityTagsAsyn
         {
             var exportedItems = new List<Activity>();
             using (var tracer = Sdk.CreateTracerProviderBuilder()
-                       .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())
+                       .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())
                        .AddInMemoryExporter(exportedItems)
                        .Build())
             {
@@ -254,7 +259,7 @@ public async Task TestPublisherWithCachedStringsAndConsumerActivityTagsAsync(boo
         {
             var exportedItems = new List<Activity>();
             using (var tracer = Sdk.CreateTracerProviderBuilder()
-                       .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())
+                       .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())
                        .AddInMemoryExporter(exportedItems)
                        .Build())
             {
@@ -312,7 +317,7 @@ public async Task TestPublisherAndBasicGetActivityTags(bool useRoutingKeyAsOpera
         {
             var exportedItems = new List<Activity>();
             using (var tracer = Sdk.CreateTracerProviderBuilder()
-                       .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())
+                       .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())
                        .AddInMemoryExporter(exportedItems)
                        .Build())
             {

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,18 @@ namespace RabbitMQ.Client.OpenTelemetry`
`2`	`2`	`{`
`3`	`3`	`public class RabbitMQOpenTelemetryConfiguration`
`4`	`4`	`{`
`5`		`- public bool PropagateBaggage { get; set; } = true;`
`6`		`- public bool UseRoutingKeyAsOperationName { get; set; } = true;`
`7`		`- public bool IncludePublishers { get; set; } = true;`
`8`		`- public bool IncludeSubscribers { get; set; } = true;`
	`5`	`+ public RabbitMQOpenTelemetryConfiguration(bool useRoutingKeyAsOperationName = true,`
	`6`	`+ bool includePublishers = true,`
	`7`	`+ bool includeSubscribers = true)`
	`8`	`+ {`
	`9`	`+ UseRoutingKeyAsOperationName = useRoutingKeyAsOperationName;`
	`10`	`+ IncludePublishers = includePublishers;`
	`11`	`+ IncludeSubscribers = includeSubscribers;`
	`12`	`+ }`
	`13`	`+`
	`14`	`+ public bool UseRoutingKeyAsOperationName { get; }`
	`15`	`+ public bool IncludePublishers { get; }`
	`16`	`+ public bool IncludeSubscribers { get; }`
	`17`	`+ public static RabbitMQOpenTelemetryConfiguration Default { get; } = new RabbitMQOpenTelemetryConfiguration();`
`9`	`18`	`}`
`10`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,23 +11,14 @@ namespace OpenTelemetry.Trace`
`11`	`11`	`{`
`12`	`12`	`public static class OpenTelemetryExtensions`
`13`	`13`	`{`
`14`		`- internal static TextMapPropagator s_propagator = Propagators.DefaultTextMapPropagator;`
`15`		`-`
`16`		`- public static TracerProviderBuilder AddRabbitMQ(this TracerProviderBuilder builder,`
`17`		`- RabbitMQOpenTelemetryConfiguration configuration)`
	`14`	`+ public static TracerProviderBuilder AddRabbitMQInstrumentation(this TracerProviderBuilder builder,`
	`15`	`+ RabbitMQOpenTelemetryConfiguration configuration = null)`
`18`	`16`	`{`
`19`		`- if (configuration.PropagateBaggage)`
	`17`	`+ if (configuration == null)`
`20`	`18`	`{`
`21`		`- s_propagator = new CompositeTextMapPropagator(new TextMapPropagator[]`
`22`		`- {`
`23`		`- new TraceContextPropagator(), new BaggagePropagator()`
`24`		`- });`
	`19`	`+ configuration = RabbitMQOpenTelemetryConfiguration.Default;`
`25`	`20`	`}`
`26`		`- else`
`27`		`- {`
`28`		`- s_propagator = new TraceContextPropagator();`
`29`		`- }`
`30`		`-`
	`21`	`+`
`31`	`22`	`RabbitMQActivitySource.UseRoutingKeyAsOperationName = configuration.UseRoutingKeyAsOperationName;`
`32`	`23`	`RabbitMQActivitySource.ContextExtractor = OpenTelemetryContextExtractor;`
`33`	`24`	`RabbitMQActivitySource.ContextInjector = OpenTelemetryContextInjector;`
`@@ -48,7 +39,7 @@ public static TracerProviderBuilder AddRabbitMQ(this TracerProviderBuilder build`
`48`	`39`	`private static ActivityContext OpenTelemetryContextExtractor(IReadOnlyBasicProperties props)`
`49`	`40`	`{`
`50`	`41`	`// Extract the PropagationContext of the upstream parent from the message headers.`
`51`		`- var parentContext = s_propagator.Extract(default, props.Headers, OpenTelemetryContextGetter);`
	`42`	`+ var parentContext = Propagators.DefaultTextMapPropagator.Extract(default, props.Headers, OpenTelemetryContextGetter);`
`52`	`43`	`Baggage.Current = parentContext.Baggage;`
`53`	`44`	`return parentContext.ActivityContext;`
`54`	`45`	`}`
`@@ -57,9 +48,8 @@ private static IEnumerable<string> OpenTelemetryContextGetter(IDictionary<string`
`57`	`48`	`{`
`58`	`49`	`try`
`59`	`50`	`{`
`60`		`- if (carrier.TryGetValue(key, out object value))`
	`51`	`+ if (carrier.TryGetValue(key, out object value) && value is byte[] bytes)`
`61`	`52`	`{`
`62`		`- byte[] bytes = value as byte[];`
`63`	`53`	`return new[] { Encoding.UTF8.GetString(bytes) };`
`64`	`54`	`}`
`65`	`55`	`}`
`@@ -74,7 +64,7 @@ private static IEnumerable<string> OpenTelemetryContextGetter(IDictionary<string`
`74`	`64`	`private static void OpenTelemetryContextInjector(Activity activity, IDictionary<string, object> props)`
`75`	`65`	`{`
`76`	`66`	`// Inject the current Activity's context into the message headers.`
`77`		`- s_propagator.Inject(new PropagationContext(activity.Context, Baggage.Current), props, OpenTelemetryContextSetter);`
	`67`	`+ Propagators.DefaultTextMapPropagator.Inject(new PropagationContext(activity.Context, Baggage.Current), props, OpenTelemetryContextSetter);`
`78`	`68`	`}`
`79`	`69`
`80`	`70`	`private static void OpenTelemetryContextSetter(IDictionary<string, object> carrier, string key, string value)`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@`
`36`	`36`	`using System.Text;`
`37`	`37`	`using System.Threading.Tasks;`
`38`	`38`	`using OpenTelemetry;`
	`39`	`+using OpenTelemetry.Context.Propagation;`
`39`	`40`	`using OpenTelemetry.Trace;`
`40`	`41`	`using RabbitMQ.Client;`
`41`	`42`	`using RabbitMQ.Client.Events;`
`@@ -51,6 +52,10 @@ public class TestOpenTelemetry : SequentialIntegrationFixture`
`51`	`52`	`{`
`52`	`53`	`public TestOpenTelemetry(ITestOutputHelper output) : base(output)`
`53`	`54`	`{`
	`55`	`+ Sdk.SetDefaultTextMapPropagator(new CompositeTextMapPropagator(new TextMapPropagator[]`
	`56`	`+ {`
	`57`	`+ new TraceContextPropagator(), new BaggagePropagator()`
	`58`	`+ }));`
`54`	`59`	`}`
`55`	`60`
`56`	`61`	`void AssertStringTagEquals(Activity activity, string name, string expected)`
`@@ -86,7 +91,7 @@ public async Task TestPublisherAndConsumerActivityTags(bool useRoutingKeyAsOpera`
`86`	`91`	`{`
`87`	`92`	`var exportedItems = new List<Activity>();`
`88`	`93`	`using (var tracer = Sdk.CreateTracerProviderBuilder()`
`89`		`- .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())`
	`94`	`+ .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())`
`90`	`95`	`.AddInMemoryExporter(exportedItems)`
`91`	`96`	`.Build())`
`92`	`97`	`{`
`@@ -141,7 +146,7 @@ public async Task TestPublisherAndConsumerActivityTagsAsync(bool useRoutingKeyAs`
`141`	`146`	`{`
`142`	`147`	`var exportedItems = new List<Activity>();`
`143`	`148`	`using (var tracer = Sdk.CreateTracerProviderBuilder()`
`144`		`- .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())`
	`149`	`+ .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())`
`145`	`150`	`.AddInMemoryExporter(exportedItems)`
`146`	`151`	`.Build())`
`147`	`152`	`{`
`@@ -197,7 +202,7 @@ public async Task TestPublisherWithPublicationAddressAndConsumerActivityTagsAsyn`
`197`	`202`	`{`
`198`	`203`	`var exportedItems = new List<Activity>();`
`199`	`204`	`using (var tracer = Sdk.CreateTracerProviderBuilder()`
`200`		`- .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())`
	`205`	`+ .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())`
`201`	`206`	`.AddInMemoryExporter(exportedItems)`
`202`	`207`	`.Build())`
`203`	`208`	`{`
`@@ -254,7 +259,7 @@ public async Task TestPublisherWithCachedStringsAndConsumerActivityTagsAsync(boo`
`254`	`259`	`{`
`255`	`260`	`var exportedItems = new List<Activity>();`
`256`	`261`	`using (var tracer = Sdk.CreateTracerProviderBuilder()`
`257`		`- .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())`
	`262`	`+ .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())`
`258`	`263`	`.AddInMemoryExporter(exportedItems)`
`259`	`264`	`.Build())`
`260`	`265`	`{`
`@@ -312,7 +317,7 @@ public async Task TestPublisherAndBasicGetActivityTags(bool useRoutingKeyAsOpera`
`312`	`317`	`{`
`313`	`318`	`var exportedItems = new List<Activity>();`
`314`	`319`	`using (var tracer = Sdk.CreateTracerProviderBuilder()`
`315`		`- .AddRabbitMQ(new RabbitMQOpenTelemetryConfiguration())`
	`320`	`+ .AddRabbitMQInstrumentation(new RabbitMQOpenTelemetryConfiguration())`
`316`	`321`	`.AddInMemoryExporter(exportedItems)`
`317`	`322`	`.Build())`
`318`	`323`	`{`