Allow parent/child linking in opentelemetry spans

Update more tests

Change to always link, optionally parent/child

Don't create list unless needed

Co-authored-by: Liudmila Molkova <[email protected]>

Change default to AlwaysParentChildAndLink

Remove TracingLinkType enum, use bool UsePublisherAsParent instead

Author: meum

projects/RabbitMQ.Client.OpenTelemetry/PublicAPI.Unshipped.txt

@@ -0,0 +1 @@
+~static OpenTelemetry.Trace.OpenTelemetryExtensions.AddRabbitMQInstrumentation(this OpenTelemetry.Trace.TracerProviderBuilder builder, System.Action<RabbitMQ.Client.RabbitMQTracingOptions> configure) -> OpenTelemetry.Trace.TracerProviderBuilder

projects/RabbitMQ.Client.OpenTelemetry/TraceProviderBuilderExtensions.cs

@@ -8,16 +8,26 @@
 
 namespace OpenTelemetry.Trace
 {
+
     public static class OpenTelemetryExtensions
     {
-        public static TracerProviderBuilder AddRabbitMQInstrumentation(this TracerProviderBuilder builder)
+        public static TracerProviderBuilder AddRabbitMQInstrumentation(this TracerProviderBuilder builder, Action<RabbitMQTracingOptions> configure)
         {
+            var options = new RabbitMQTracingOptions();
+            configure?.Invoke(options);
+            RabbitMQActivitySource.TracingOptions = options;
+
             RabbitMQActivitySource.ContextExtractor = OpenTelemetryContextExtractor;
             RabbitMQActivitySource.ContextInjector = OpenTelemetryContextInjector;
             builder.AddSource("RabbitMQ.Client.*");
             return builder;
         }
 
+        public static TracerProviderBuilder AddRabbitMQInstrumentation(this TracerProviderBuilder builder)
+        {
+            return AddRabbitMQInstrumentation(builder, null);
+        }
+
         private static ActivityContext OpenTelemetryContextExtractor(IReadOnlyBasicProperties props)
         {
             // Extract the PropagationContext of the upstream parent from the message headers.

projects/RabbitMQ.Client/Impl/RabbitMQActivitySource.cs

@@ -51,7 +51,12 @@ public static class RabbitMQActivitySource
         public static Func<IReadOnlyBasicProperties, ActivityContext> ContextExtractor { get; set; } =
             DefaultContextExtractor;
 
-        public static bool UseRoutingKeyAsOperationName { get; set; } = true;
+        public static bool UseRoutingKeyAsOperationName
+        {
+            get => TracingOptions.UseRoutingKeyAsOperationName;
+            set => TracingOptions.UseRoutingKeyAsOperationName = value;
+        }
+        public static RabbitMQTracingOptions TracingOptions { get; set; } = new RabbitMQTracingOptions();
         internal static bool PublisherHasListeners => s_publisherSource.HasListeners();
 
         internal static readonly IEnumerable<KeyValuePair<string, object?>> CreationTags = new[]
@@ -115,9 +120,14 @@ public static class RabbitMQActivitySource
             }
 
             // Extract the PropagationContext of the upstream parent from the message headers.
+            ActivityContext linkedContext = ContextExtractor(readOnlyBasicProperties);
+            ActivityContext parentContext = TracingOptions.UsePublisherAsParent ? linkedContext : default;
+
             Activity? activity = s_subscriberSource.StartLinkedRabbitMQActivity(
                 UseRoutingKeyAsOperationName ? $"{MessagingOperationNameBasicGet} {routingKey}" : MessagingOperationNameBasicGet, ActivityKind.Consumer,
-                ContextExtractor(readOnlyBasicProperties));
+                linkedContext, parentContext);
+
+
             if (activity != null && activity.IsAllDataRequested)
             {
                 PopulateMessagingTags(MessagingOperationTypeReceive, MessagingOperationNameBasicGet, routingKey, exchange, deliveryTag, readOnlyBasicProperties,
@@ -128,21 +138,24 @@ public static class RabbitMQActivitySource
         }
 
         internal static Activity? Deliver(string routingKey, string exchange, ulong deliveryTag,
-            IReadOnlyBasicProperties basicProperties, int bodySize)
+            IReadOnlyBasicProperties readOnlyBasicProperties, int bodySize)
         {
             if (!s_subscriberSource.HasListeners())
             {
                 return null;
             }
 
             // Extract the PropagationContext of the upstream parent from the message headers.
+            ActivityContext linkedContext = ContextExtractor(readOnlyBasicProperties);
+            ActivityContext parentContext = TracingOptions.UsePublisherAsParent ? linkedContext : default;
+
             Activity? activity = s_subscriberSource.StartLinkedRabbitMQActivity(
                 UseRoutingKeyAsOperationName ? $"{MessagingOperationNameBasicDeliver} {routingKey}" : MessagingOperationNameBasicDeliver,
-                ActivityKind.Consumer, ContextExtractor(basicProperties));
+                ActivityKind.Consumer, linkedContext, parentContext);
             if (activity != null && activity.IsAllDataRequested)
             {
                 PopulateMessagingTags(MessagingOperationTypeProcess, MessagingOperationNameBasicDeliver, routingKey, exchange,
-                    deliveryTag, basicProperties, bodySize, activity);
+                    deliveryTag, readOnlyBasicProperties, bodySize, activity);
             }
 
             return activity;
@@ -157,8 +170,14 @@ public static class RabbitMQActivitySource
         private static Activity? StartLinkedRabbitMQActivity(this ActivitySource source, string name, ActivityKind kind,
             ActivityContext linkedContext = default, ActivityContext parentContext = default)
         {
+            List<ActivityLink>? links = null;
+            if (linkedContext != default)
+            {
+                links = new List<ActivityLink>();
+                links.Add(new ActivityLink(linkedContext));
+            }
             return source.CreateActivity(name, kind, parentContext: parentContext,
-                    links: new[] { new ActivityLink(linkedContext) }, idFormat: ActivityIdFormat.W3C,
+                    links: links, idFormat: ActivityIdFormat.W3C,
                     tags: CreationTags)
                 ?.Start();
         }

projects/RabbitMQ.Client/Impl/RabbitMQTracingOptions.cs

@@ -0,0 +1,8 @@
+namespace RabbitMQ.Client
+{
+    public class RabbitMQTracingOptions
+    {
+        public bool UseRoutingKeyAsOperationName { get; set; } = true;
+        public bool UsePublisherAsParent { get; set; } = true;
+    }
+}

projects/RabbitMQ.Client/PublicAPI.Unshipped.txt

@@ -4,4 +4,12 @@ RabbitMQ.Client.Exceptions.PublishReturnException.Exchange.get -> string!
 RabbitMQ.Client.Exceptions.PublishReturnException.PublishReturnException(ulong publishSequenceNumber, string! message, string? exchange = null, string? routingKey = null, ushort? replyCode = null, string? replyText = null) -> void
 RabbitMQ.Client.Exceptions.PublishReturnException.ReplyCode.get -> ushort
 RabbitMQ.Client.Exceptions.PublishReturnException.ReplyText.get -> string!
-RabbitMQ.Client.Exceptions.PublishReturnException.RoutingKey.get -> string!
+RabbitMQ.Client.Exceptions.PublishReturnException.RoutingKey.get -> string!
+RabbitMQ.Client.RabbitMQTracingOptions
+RabbitMQ.Client.RabbitMQTracingOptions.RabbitMQTracingOptions() -> void
+RabbitMQ.Client.RabbitMQTracingOptions.UsePublisherAsParent.get -> bool
+RabbitMQ.Client.RabbitMQTracingOptions.UsePublisherAsParent.set -> void
+RabbitMQ.Client.RabbitMQTracingOptions.UseRoutingKeyAsOperationName.get -> bool
+RabbitMQ.Client.RabbitMQTracingOptions.UseRoutingKeyAsOperationName.set -> void
+static RabbitMQ.Client.RabbitMQActivitySource.TracingOptions.get -> RabbitMQ.Client.RabbitMQTracingOptions!
+static RabbitMQ.Client.RabbitMQActivitySource.TracingOptions.set -> void