Merge pull request #1716 from iinuwa/fix/change-otel-attribute-name

Change OTel attribute messaging.operation to messaging.operation.type
rabbitmq · Nov 1, 2024 · 4525c6d · 4525c6d
2 parents 898c21f + e2c246f
commit 4525c6d
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 15 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -76,6 +76,39 @@ Here's the recommended workflow:
 If what you are going to work on is a substantial change, please first
 ask the core team for their opinion on the [RabbitMQ users mailing list][rmq-users].
 
+### Building Source
+
+It is good practice to make sure you can build the project before making any
+changes to confirm that your development environment is set up correctly.
+Verifying that the tests pass is also a good practice (see
+[RUNNING_TESTS.md](/RUNNING_TESTS.md)).
+
+All together, this looks like:
+
+* Linux
+
+```shell
+git clone --recurse-submodules https://github.com/rabbitmq/rabbitmq-dotnet-client
+cd rabbitmq-dotnet-client
+
+# On any Linux distribution with Docker installed
+./.ci/ubuntu/gha-setup.sh toxiproxy pull
+
+make build
+make test
+```
+
+* Windows
+
+Note that this will _NOT_ run toxiproxy tests.
+
+```powershell
+git clone --recurse-submodules https://github.com/rabbitmq/rabbitmq-dotnet-client
+cd rabbitmq-dotnet-client
+.\.ci\windows\gha-setup.ps1 # On Windows. Note that this installs RabbitMQ
+.\build.ps1 -RunTests:$true
+```
+
 ### Running Tests
 
 See [RUNNING_TESTS.md](/RUNNING_TESTS.md).

diff --git a/projects/RabbitMQ.Client/Impl/RabbitMQActivitySource.cs b/projects/RabbitMQ.Client/Impl/RabbitMQActivitySource.cs
@@ -15,7 +15,10 @@ public static class RabbitMQActivitySource
         // https://opentelemetry.io/docs/specs/semconv/messaging/messaging-spans/#messaging-attributes
         internal const string MessageId = "messaging.message.id";
         internal const string MessageConversationId = "messaging.message.conversation_id";
-        internal const string MessagingOperation = "messaging.operation";
+        internal const string MessagingOperationType = "messaging.operation.type";
+        internal const string MessagingOperationTypeSend = "send";
+        internal const string MessagingOperationTypeProcess = "process";
+        internal const string MessagingOperationTypeReceive = "receive";
         internal const string MessagingSystem = "messaging.system";
         internal const string MessagingDestination = "messaging.destination.name";
         internal const string MessagingDestinationRoutingKey = "messaging.rabbitmq.destination.routing_key";
@@ -63,14 +66,14 @@ public static class RabbitMQActivitySource
 
             Activity? activity = linkedContext == default
                 ? s_publisherSource.StartRabbitMQActivity(
-                    UseRoutingKeyAsOperationName ? $"{routingKey} publish" : "publish",
+                    UseRoutingKeyAsOperationName ? $"{routingKey} {MessagingOperationTypeSend}" : MessagingOperationTypeSend,
                     ActivityKind.Producer)
                 : s_publisherSource.StartLinkedRabbitMQActivity(
-                    UseRoutingKeyAsOperationName ? $"{routingKey} publish" : "publish",
+                    UseRoutingKeyAsOperationName ? $"{routingKey} {MessagingOperationTypeSend}" : MessagingOperationTypeSend,
                     ActivityKind.Producer, linkedContext);
             if (activity != null && activity.IsAllDataRequested)
             {
-                PopulateMessagingTags("publish", routingKey, exchange, 0, bodySize, activity);
+                PopulateMessagingTags(MessagingOperationTypeSend, routingKey, exchange, 0, bodySize, activity);
             }
 
             return activity;
@@ -85,12 +88,12 @@ public static class RabbitMQActivitySource
             }
 
             Activity? activity = s_subscriberSource.StartRabbitMQActivity(
-                UseRoutingKeyAsOperationName ? $"{queue} receive" : "receive",
+                UseRoutingKeyAsOperationName ? $"{queue} {MessagingOperationTypeReceive}" : MessagingOperationTypeReceive,
                 ActivityKind.Consumer);
             if (activity != null && activity.IsAllDataRequested)
             {
                 activity
-                    .SetTag(MessagingOperation, "receive")
+                    .SetTag(MessagingOperationType, MessagingOperationTypeReceive)
                     .SetTag(MessagingDestination, "amq.default");
             }
 
@@ -107,11 +110,11 @@ public static class RabbitMQActivitySource
 
             // Extract the PropagationContext of the upstream parent from the message headers.
             Activity? activity = s_subscriberSource.StartLinkedRabbitMQActivity(
-                UseRoutingKeyAsOperationName ? $"{routingKey} receive" : "receive", ActivityKind.Consumer,
+                UseRoutingKeyAsOperationName ? $"{routingKey} {MessagingOperationTypeReceive}" : MessagingOperationTypeReceive, ActivityKind.Consumer,
                 ContextExtractor(readOnlyBasicProperties));
             if (activity != null && activity.IsAllDataRequested)
             {
-                PopulateMessagingTags("receive", routingKey, exchange, deliveryTag, readOnlyBasicProperties,
+                PopulateMessagingTags(MessagingOperationTypeReceive, routingKey, exchange, deliveryTag, readOnlyBasicProperties,
                     bodySize, activity);
             }
 
@@ -128,11 +131,11 @@ public static class RabbitMQActivitySource
 
             // Extract the PropagationContext of the upstream parent from the message headers.
             Activity? activity = s_subscriberSource.StartLinkedRabbitMQActivity(
-                UseRoutingKeyAsOperationName ? $"{routingKey} deliver" : "deliver",
+                UseRoutingKeyAsOperationName ? $"{routingKey} {MessagingOperationTypeProcess}" : MessagingOperationTypeProcess,
                 ActivityKind.Consumer, ContextExtractor(basicProperties));
             if (activity != null && activity.IsAllDataRequested)
             {
-                PopulateMessagingTags("deliver", routingKey, exchange,
+                PopulateMessagingTags(MessagingOperationTypeProcess, routingKey, exchange,
                     deliveryTag, basicProperties, bodySize, activity);
             }
 
@@ -174,7 +177,7 @@ private static void PopulateMessagingTags(string operation, string routingKey, s
             ulong deliveryTag, int bodySize, Activity activity)
         {
             activity
-                .SetTag(MessagingOperation, operation)
+                .SetTag(MessagingOperationType, operation)
                 .SetTag(MessagingDestination, string.IsNullOrEmpty(exchange) ? "amq.default" : exchange)
                 .SetTag(MessagingDestinationRoutingKey, routingKey)
                 .SetTag(MessagingBodySize, bodySize);

diff --git a/projects/Test/SequentialIntegration/TestActivitySource.cs b/projects/Test/SequentialIntegration/TestActivitySource.cs
@@ -402,7 +402,7 @@ private static ActivityListener StartActivityListener(List<Activity> activities)
         private void AssertActivityData(bool useRoutingKeyAsOperationName, string queueName,
             List<Activity> activityList, bool isDeliver = false)
         {
-            string childName = isDeliver ? "deliver" : "receive";
+            string childName = isDeliver ? "process" : "receive";
             Activity[] activities = activityList.ToArray();
             Assert.NotEmpty(activities);
 
@@ -418,7 +418,7 @@ private void AssertActivityData(bool useRoutingKeyAsOperationName, string queueN
             }
 
             Activity sendActivity = activities.First(x =>
-                x.OperationName == (useRoutingKeyAsOperationName ? $"{queueName} publish" : "publish") &&
+                x.OperationName == (useRoutingKeyAsOperationName ? $"{queueName} send" : "send") &&
                 x.GetTagItem(RabbitMQActivitySource.MessagingDestinationRoutingKey) is string routingKeyTag &&
                 routingKeyTag == $"{queueName}");
             Activity receiveActivity = activities.Single(x =>

diff --git a/projects/Test/SequentialIntegration/TestOpenTelemetry.cs b/projects/Test/SequentialIntegration/TestOpenTelemetry.cs
@@ -342,7 +342,7 @@ public async Task TestPublisherAndBasicGetActivityTags(bool useRoutingKeyAsOpera
         private void AssertActivityData(bool useRoutingKeyAsOperationName, string queueName,
             List<Activity> activityList, bool isDeliver = false, string baggageGuid = null)
         {
-            string childName = isDeliver ? "deliver" : "receive";
+            string childName = isDeliver ? "process" : "receive";
             Activity[] activities = activityList.ToArray();
             Assert.NotEmpty(activities);
             foreach (var item in activities)
@@ -354,7 +354,7 @@ private void AssertActivityData(bool useRoutingKeyAsOperationName, string queueN
             }
 
             Activity sendActivity = activities.First(x =>
-                x.OperationName == (useRoutingKeyAsOperationName ? $"{queueName} publish" : "publish") &&
+                x.OperationName == (useRoutingKeyAsOperationName ? $"{queueName} send" : "send") &&
                 x.GetTagItem(RabbitMQActivitySource.MessagingDestinationRoutingKey) is string routingKeyTag &&
                 routingKeyTag == $"{queueName}");
             Activity receiveActivity = activities.Single(x =>