RabbitMQ: Specify how to populate messaging.destination.name

.chloggen/rabbitmq-destination-name.yaml

@@ -0,0 +1,4 @@
+change_type: breaking
+component: messaging
+note: "RabbitMQ: Specify how to populate `messaging.destination.name`"
+issues: [1529]

docs/messaging/rabbitmq.md

@@ -40,9 +40,6 @@ The Semantic Conventions for [RabbitMQ](https://www.rabbitmq.com/) extend and ov
 
 ## RabbitMQ attributes
 
-In RabbitMQ, the destination is defined by an *exchange* and a *routing key*.
-`messaging.destination.name` MUST be set to the name of the exchange. This will be an empty string if the default exchange is used.
-
 <!-- semconv messaging.rabbitmq -->
 <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
 <!-- see templates/registry/markdown/snippet.md.j2 -->
@@ -54,7 +51,7 @@ In RabbitMQ, the destination is defined by an *exchange* and a *routing key*.
 |---|---|---|---|---|---|
 | [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |
-| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [2] | `MyQueue`; `MyTopic` | `Conditionally Required` [3] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [2] | `direct_logs:warning`; `logs` | `Conditionally Required` [3] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [4] | `create`; `send`; `receive` | `Conditionally Required` If applicable. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`messaging.rabbitmq.destination.routing_key`](/docs/attributes-registry/messaging.md) | string | RabbitMQ message routing key. | `myKey` | `Conditionally Required` If not empty. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`messaging.rabbitmq.message.delivery_tag`](/docs/attributes-registry/messaging.md) | int | RabbitMQ message delivery tag | `123` | `Conditionally Required` When available. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
@@ -86,8 +83,17 @@ it's RECOMMENDED to:
 - Use a domain-specific attribute
 - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.
 
-**[2] `messaging.destination.name`:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
-the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
+**[2] `messaging.destination.name`:** In RabbitMQ, the destination is defined by an *exchange*, a *routing key* and for consumers, a *queue*.
+
+`messaging.destination.name` SHOULD be set to:
+
+- **Producers**: `{exchange}:{routing key}` when both values are present and non-empty.
+Otherwise: `amq.default` when the default exchange is used and no routing key is provided
+
+- **Consumers**: `{exchange}:{routing key}:{queue}` when all values are present and non-empty.
+If any has an empty value (e.g., the default exchange is used) it SHOULD be omitted.
+For cases when `{routing key}` and `{queue}` are equal, only one of them SHOULD
+be used, e.g., `{exchange}:{routing key}`.
 
 **[3] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch.
 

model/messaging/spans.yaml

@@ -118,6 +118,22 @@ groups:
           Message [correlation Id](https://www.rabbitmq.com/tutorials/tutorial-six-java#correlation-id) property.
       - ref: messaging.message.body.size
         requirement_level: opt_in
+      - ref: messaging.destination.name
+        note: |
+          In RabbitMQ, the destination is defined by an *exchange*, a *routing key* and for consumers, a *queue*.
+
+          `messaging.destination.name` SHOULD be set to:
+
+          - **Producers**: `{exchange}:{routing key}` when both values are present and non-empty.
+          Otherwise: `amq.default` when the default exchange is used and no routing key is provided
+
+          - **Consumers**: `{exchange}:{routing key}:{queue}` when all values are present and non-empty.
+          If any has an empty value (e.g., the default exchange is used) it SHOULD be omitted.
+          For cases when `{routing key}` and `{queue}` are equal, only one of them SHOULD
+          be used, e.g., `{exchange}:{routing key}`.
+        examples: ['direct_logs:warning', 'logs']
+        requirement_level:
+          conditionally_required: If span describes operation on a single message or if the value applies to all messages in the batch.
 
   - id: messaging.kafka
     type: attribute_group