Semantic conventions for RabbitMQ
Status: Development
The Semantic Conventions for RabbitMQ extend and override the Messaging Semantic Conventions.
Existing messaging instrumentations that are using v1.24.0 of this document (or prior):
- SHOULD NOT change the version of the messaging conventions that they emit by default until the messaging semantic conventions are marked stable. Conventions include, but are not limited to, attributes, metric and span names, span kind and unit of measure.
- SHOULD introduce an environment variable
OTEL_SEMCONV_STABILITY_OPT_INin the existing major version as a comma-separated list of category-specific values (e.g., http, databases, messaging). The list of values includes:messaging- emit the new, stable messaging conventions, and stop emitting the old experimental messaging conventions that the instrumentation emitted previously.messaging/dup- emit both the old and the stable messaging conventions, allowing for a seamless transition.- The default behavior (in the absence of one of these values) is to continue emitting whatever version of the old experimental messaging conventions the instrumentation was emitting previously.
- Note:
messaging/duphas higher precedence thanmessagingin case both values are present
- SHOULD maintain (security patching at a minimum) the existing major version for at least six months after it starts emitting both sets of conventions.
- SHOULD drop the environment variable in the next major version.
- SHOULD emit the new, stable values for span name, span kind and similar “single”
valued concepts when
messaging/dupis present in the list.
RabbitMQ spans
Send span (producer)
Status:
Describes a producer publishing one or more messages to RabbitMQ.
Use this span when no separate “Create” span exists and the “Send” span’s context is injected into the message(s) as the creation context. See Producer spans for details.
Span kind SHOULD be PRODUCER.
Span status SHOULD follow the Recording Errors document.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
messaging.destination.name |  | Required | string | The message destination name [1] | direct_logs:warning; logs; amq.default |
messaging.operation.name | | Required | string | The system-specific name of the messaging operation. | send; publish |
messaging.system | | Required | string | The messaging system as identified by the client instrumentation. [2] | rabbitmq |
error.type |  | Conditionally Required If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | amqp:decode-error; amqp:resource-limit-exceeded; connection-forced |
messaging.batch.message_count | | Conditionally Required [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | 0; 1; 2 |
messaging.destination.anonymous | | Conditionally Required [6] | boolean | A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). | |
messaging.destination.template | | Conditionally Required [7] | string | Low cardinality representation of the messaging destination name [8] | /customers/{customerId} |
messaging.destination.temporary | | Conditionally Required [9] | boolean | A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. | |
messaging.operation.type | | Conditionally Required If applicable. | string | A string identifying the type of the messaging operation. [10] | send |
messaging.rabbitmq.destination.routing_key | | Conditionally Required If not empty. | string | RabbitMQ message routing key. | myKey |
messaging.client.id | | Recommended | string | A unique identifier for the client that consumes or produces a message. | client-5; myhost@8742@s8083jm |
messaging.destination.partition.id | | Recommended When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name. | 1 |
messaging.message.conversation_id | | Recommended | string | Message correlation ID property. | MyConversationId |
messaging.message.id | | Recommended If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | 452a7c7c7c7048c2f887f61572b18fc2 |
network.peer.address | | Recommended | string | Peer address of the messaging intermediary node where the operation was performed. [11] | 10.1.2.80; /tmp/my.sock |
network.peer.port | | Recommended if and only if network.peer.address is set. | int | Peer port of the messaging intermediary node where the operation was performed. | 65123 |
server.address | | Recommended | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [12] | example.com; 10.1.2.80; /tmp/my.sock |
server.port | | Recommended | int | Server port number. [13] | 80; 8080; 443 |
messaging.message.body.size | | Opt-In | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [14] | 1439 |
messaging.message.envelope.size | | Opt-In | int | The size of the message body and metadata in bytes. [15] | 2738 |
[1] messaging.destination.name: The RabbitMQ destination is defined by an exchange and a routing key.
SHOULD be set to {exchange}:{routing key} when both values are present and non-empty.
When only one is available, only that value SHOULD be used, e.g. {exchange} or {routing key}.
Otherwise, it SHOULD be set to amq.default when the default exchange is used and no routing key is provided.
[2] messaging.system: MUST be set to "rabbitmq".
[3] error.type: The error.type SHOULD be predictable, and SHOULD have low cardinality.
When error.type is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.
If the recorded error type is a wrapper that is not meaningful for
failure classification, instrumentation MAY use the type of the inner
error instead. For example, in Go, errors created with fmt.Errorf
using %w MAY be unwrapped when the wrapper type does not help
classify the failure.
Instrumentations SHOULD document the list of errors they report.
The cardinality of error.type within one instrumentation library SHOULD be low.
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
should be prepared for error.type to have high cardinality at query time when no
additional filters are applied.
If the operation has completed successfully, instrumentations SHOULD NOT set error.type.
If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it’s RECOMMENDED to:
- Use a domain-specific attribute
- Set
error.typeto capture all errors, regardless of whether they are defined within the domain-specific set or not.
[4] messaging.batch.message_count: If the span describes an operation on a batch of messages.
[5] messaging.batch.message_count: Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs.
[6] messaging.destination.anonymous: If value is true. When missing, the value is assumed to be false.
[7] messaging.destination.template: If available. Instrumentations MUST NOT use messaging.destination.name as template unless low-cardinality of destination name is guaranteed.
[8] messaging.destination.template: Destination names could be constructed from templates. An example would be a destination name involving a username or product ID. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
[9] messaging.destination.temporary: If value is true. When missing, the value is assumed to be false.
[10] messaging.operation.type: SHOULD be set to send.
[11] network.peer.address: Semantic conventions for individual messaging systems SHOULD document whether network.peer.* attributes are applicable.
Network peer address and port are important when the application interacts with individual intermediary nodes directly,
If a messaging operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
[12] server.address: Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
[13] server.port: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it’s available.
[14] messaging.message.body.size: This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
body size should be used.
[15] messaging.message.envelope.size: This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed
size should be used.
The following attributes can be important for making sampling decisions and SHOULD be provided at span creation time (if provided at all):
messaging.destination.namemessaging.destination.partition.idmessaging.destination.templatemessaging.operation.namemessaging.operation.typemessaging.systemserver.addressserver.port
error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
_OTHER | A fallback error value to be used when the instrumentation doesn’t define a custom value. | |
messaging.operation.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
create | A message is created. “Create” spans always refer to a single message and are used to provide a unique creation context for messages in batch sending scenarios. | |
process | One or more messages are processed by a consumer. | |
receive | One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. | |
send | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the “Send” span can be used as the creation context and no “Create” span needs to be created. | |
settle | One or more messages are settled. | |
messaging.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
activemq | Apache ActiveMQ | |
aws.sns | Amazon Simple Notification Service (SNS) | |
aws_sqs | Amazon Simple Queue Service (SQS) | |
eventgrid | Azure Event Grid | |
eventhubs | Azure Event Hubs | |
gcp_pubsub | Google Cloud Pub/Sub | |
jms | Java Message Service | |
kafka | Apache Kafka | |
pulsar | Apache Pulsar | |
rabbitmq | RabbitMQ | |
rocketmq | Apache RocketMQ | |
servicebus | Azure Service Bus | |
Receive span
Status:
Describes a consumer receiving one or more messages from RabbitMQ (pull-based).
“Receive” spans are created for pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. See Consumer spans for details.
Span kind SHOULD be CLIENT.
Span status SHOULD follow the Recording Errors document.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
messaging.destination.name | | Required | string | The message destination name [1] | direct_logs:warning:my_queue; direct_logs:warning; logs |
messaging.operation.name | | Required | string | The system-specific name of the messaging operation. | receive; poll |
messaging.system | | Required | string | The messaging system as identified by the client instrumentation. [2] | rabbitmq |
error.type | | Conditionally Required If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | amqp:decode-error; amqp:resource-limit-exceeded; connection-forced |
messaging.batch.message_count | | Conditionally Required [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | 0; 1; 2 |
messaging.destination.anonymous | | Conditionally Required [6] | boolean | A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). | |
messaging.destination.template | | Conditionally Required [7] | string | Low cardinality representation of the messaging destination name [8] | /customers/{customerId} |
messaging.destination.temporary | | Conditionally Required [9] | boolean | A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. | |
messaging.operation.type | | Conditionally Required If applicable. | string | A string identifying the type of the messaging operation. [10] | receive |
messaging.rabbitmq.destination.routing_key | | Conditionally Required If not empty. | string | RabbitMQ message routing key. | myKey |
messaging.rabbitmq.message.delivery_tag | | Conditionally Required When available. | int | RabbitMQ message delivery tag | 123 |
messaging.client.id | | Recommended | string | A unique identifier for the client that consumes or produces a message. | client-5; myhost@8742@s8083jm |
messaging.destination.partition.id | | Recommended When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name. | 1 |
messaging.message.conversation_id | | Recommended | string | Message correlation ID property. | MyConversationId |
messaging.message.id | | Recommended If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | 452a7c7c7c7048c2f887f61572b18fc2 |
network.peer.address | | Recommended | string | Peer address of the messaging intermediary node where the operation was performed. [11] | 10.1.2.80; /tmp/my.sock |
network.peer.port | | Recommended if and only if network.peer.address is set. | int | Peer port of the messaging intermediary node where the operation was performed. | 65123 |
server.address | | Recommended | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [12] | example.com; 10.1.2.80; /tmp/my.sock |
server.port | | Recommended | int | Server port number. [13] | 80; 8080; 443 |
messaging.message.body.size | | Opt-In | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [14] | 1439 |
messaging.message.envelope.size | | Opt-In | int | The size of the message body and metadata in bytes. [15] | 2738 |
[1] messaging.destination.name: The RabbitMQ destination is defined by an exchange, a routing key, and a queue.
SHOULD be set to {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.
When {routing key} and {queue} are equal, only one of them SHOULD be used,
e.g. {exchange}:{routing key}.
[2] messaging.system: MUST be set to "rabbitmq".
[3] error.type: The error.type SHOULD be predictable, and SHOULD have low cardinality.
When error.type is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.
If the recorded error type is a wrapper that is not meaningful for
failure classification, instrumentation MAY use the type of the inner
error instead. For example, in Go, errors created with fmt.Errorf
using %w MAY be unwrapped when the wrapper type does not help
classify the failure.
Instrumentations SHOULD document the list of errors they report.
The cardinality of error.type within one instrumentation library SHOULD be low.
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
should be prepared for error.type to have high cardinality at query time when no
additional filters are applied.
If the operation has completed successfully, instrumentations SHOULD NOT set error.type.
If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it’s RECOMMENDED to:
- Use a domain-specific attribute
- Set
error.typeto capture all errors, regardless of whether they are defined within the domain-specific set or not.
[4] messaging.batch.message_count: If the span describes an operation on a batch of messages.
[5] messaging.batch.message_count: Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs.
[6] messaging.destination.anonymous: If value is true. When missing, the value is assumed to be false.
[7] messaging.destination.template: If available. Instrumentations MUST NOT use messaging.destination.name as template unless low-cardinality of destination name is guaranteed.
[8] messaging.destination.template: Destination names could be constructed from templates. An example would be a destination name involving a username or product ID. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
[9] messaging.destination.temporary: If value is true. When missing, the value is assumed to be false.
[10] messaging.operation.type: SHOULD be set to receive.
[11] network.peer.address: Semantic conventions for individual messaging systems SHOULD document whether network.peer.* attributes are applicable.
Network peer address and port are important when the application interacts with individual intermediary nodes directly,
If a messaging operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
[12] server.address: Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
[13] server.port: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it’s available.
[14] messaging.message.body.size: This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
body size should be used.
[15] messaging.message.envelope.size: This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed
size should be used.
The following attributes can be important for making sampling decisions and SHOULD be provided at span creation time (if provided at all):
messaging.destination.namemessaging.destination.partition.idmessaging.destination.templatemessaging.operation.namemessaging.operation.typemessaging.systemserver.addressserver.port
error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
_OTHER | A fallback error value to be used when the instrumentation doesn’t define a custom value. | |
messaging.operation.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
create | A message is created. “Create” spans always refer to a single message and are used to provide a unique creation context for messages in batch sending scenarios. | |
process | One or more messages are processed by a consumer. | |
receive | One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. | |
send | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the “Send” span can be used as the creation context and no “Create” span needs to be created. | |
settle | One or more messages are settled. | |
messaging.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
activemq | Apache ActiveMQ | |
aws.sns | Amazon Simple Notification Service (SNS) | |
aws_sqs | Amazon Simple Queue Service (SQS) | |
eventgrid | Azure Event Grid | |
eventhubs | Azure Event Hubs | |
gcp_pubsub | Google Cloud Pub/Sub | |
jms | Java Message Service | |
kafka | Apache Kafka | |
pulsar | Apache Pulsar | |
rabbitmq | RabbitMQ | |
rocketmq | Apache RocketMQ | |
servicebus | Azure Service Bus | |
Process span
Status:
Describes a consumer processing one or more messages from RabbitMQ (push-based).
“Process” spans are created for push-based scenarios, where messages are passed to the application through a callback or handler. See Consumer spans for details.
Exclusively for single-message scenarios, when the message creation context is used as the parent, see Message creation context as parent of “Process” span.
Span kind SHOULD be CONSUMER.
Span status SHOULD follow the Recording Errors document.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
messaging.destination.name | | Required | string | The message destination name [1] | direct_logs:warning:my_queue; direct_logs:warning; logs |
messaging.operation.name | | Required | string | The system-specific name of the messaging operation. | process; consume |
messaging.system | | Required | string | The messaging system as identified by the client instrumentation. [2] | rabbitmq |
error.type | | Conditionally Required If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | amqp:decode-error; amqp:resource-limit-exceeded; connection-forced |
messaging.batch.message_count | | Conditionally Required [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | 0; 1; 2 |
messaging.destination.anonymous | | Conditionally Required [6] | boolean | A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). | |
messaging.destination.template | | Conditionally Required [7] | string | Low cardinality representation of the messaging destination name [8] | /customers/{customerId} |
messaging.destination.temporary | | Conditionally Required [9] | boolean | A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. | |
messaging.operation.type | | Conditionally Required If applicable. | string | A string identifying the type of the messaging operation. [10] | process |
messaging.rabbitmq.destination.routing_key | | Conditionally Required If not empty. | string | RabbitMQ message routing key. | myKey |
messaging.rabbitmq.message.delivery_tag | | Conditionally Required When available. | int | RabbitMQ message delivery tag | 123 |
messaging.client.id | | Recommended | string | A unique identifier for the client that consumes or produces a message. | client-5; myhost@8742@s8083jm |
messaging.destination.partition.id | | Recommended When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name. | 1 |
messaging.message.conversation_id | | Recommended | string | Message correlation ID property. | MyConversationId |
messaging.message.id | | Recommended If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | 452a7c7c7c7048c2f887f61572b18fc2 |
server.address | | Recommended | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [11] | example.com; 10.1.2.80; /tmp/my.sock |
server.port | | Recommended | int | Server port number. [12] | 80; 8080; 443 |
messaging.message.body.size | | Opt-In | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [13] | 1439 |
messaging.message.envelope.size | | Opt-In | int | The size of the message body and metadata in bytes. [14] | 2738 |
[1] messaging.destination.name: The RabbitMQ destination is defined by an exchange, a routing key, and a queue.
SHOULD be set to {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.
When {routing key} and {queue} are equal, only one of them SHOULD be used,
e.g. {exchange}:{routing key}.
[2] messaging.system: MUST be set to "rabbitmq".
[3] error.type: The error.type SHOULD be predictable, and SHOULD have low cardinality.
When error.type is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.
If the recorded error type is a wrapper that is not meaningful for
failure classification, instrumentation MAY use the type of the inner
error instead. For example, in Go, errors created with fmt.Errorf
using %w MAY be unwrapped when the wrapper type does not help
classify the failure.
Instrumentations SHOULD document the list of errors they report.
The cardinality of error.type within one instrumentation library SHOULD be low.
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
should be prepared for error.type to have high cardinality at query time when no
additional filters are applied.
If the operation has completed successfully, instrumentations SHOULD NOT set error.type.
If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it’s RECOMMENDED to:
- Use a domain-specific attribute
- Set
error.typeto capture all errors, regardless of whether they are defined within the domain-specific set or not.
[4] messaging.batch.message_count: If the span describes an operation on a batch of messages.
[5] messaging.batch.message_count: Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs.
[6] messaging.destination.anonymous: If value is true. When missing, the value is assumed to be false.
[7] messaging.destination.template: If available. Instrumentations MUST NOT use messaging.destination.name as template unless low-cardinality of destination name is guaranteed.
[8] messaging.destination.template: Destination names could be constructed from templates. An example would be a destination name involving a username or product ID. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
[9] messaging.destination.temporary: If value is true. When missing, the value is assumed to be false.
[10] messaging.operation.type: SHOULD be set to process.
[11] server.address: Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
[12] server.port: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it’s available.
[13] messaging.message.body.size: This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
body size should be used.
[14] messaging.message.envelope.size: This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed
size should be used.
The following attributes can be important for making sampling decisions and SHOULD be provided at span creation time (if provided at all):
messaging.destination.namemessaging.destination.partition.idmessaging.destination.templatemessaging.operation.namemessaging.operation.typemessaging.systemserver.addressserver.port
error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
_OTHER | A fallback error value to be used when the instrumentation doesn’t define a custom value. | |
messaging.operation.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
create | A message is created. “Create” spans always refer to a single message and are used to provide a unique creation context for messages in batch sending scenarios. | |
process | One or more messages are processed by a consumer. | |
receive | One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. | |
send | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the “Send” span can be used as the creation context and no “Create” span needs to be created. | |
settle | One or more messages are settled. | |
messaging.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
activemq | Apache ActiveMQ | |
aws.sns | Amazon Simple Notification Service (SNS) | |
aws_sqs | Amazon Simple Queue Service (SQS) | |
eventgrid | Azure Event Grid | |
eventhubs | Azure Event Hubs | |
gcp_pubsub | Google Cloud Pub/Sub | |
jms | Java Message Service | |
kafka | Apache Kafka | |
pulsar | Apache Pulsar | |
rabbitmq | RabbitMQ | |
rocketmq | Apache RocketMQ | |
servicebus | Azure Service Bus | |
Settle span
Status:
Describes a consumer settling (ack/nack/reject) one or more messages on RabbitMQ.
“Settle” spans are created for every manually or automatically triggered settlement operation. See Consumer spans for details.
Span kind SHOULD be CLIENT.
Span status SHOULD follow the Recording Errors document.
Attributes:
| Key | Stability | Requirement Level | Value Type | Description | Example Values |
|---|---|---|---|---|---|
messaging.destination.name | | Required | string | The message destination name [1] | direct_logs:warning:my_queue; direct_logs:warning; logs |
messaging.operation.name | | Required | string | The system-specific name of the messaging operation. | ack; nack; settle |
messaging.system | | Required | string | The messaging system as identified by the client instrumentation. [2] | rabbitmq |
error.type | | Conditionally Required If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | amqp:decode-error; amqp:resource-limit-exceeded; connection-forced |
messaging.batch.message_count | | Conditionally Required [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | 0; 1; 2 |
messaging.destination.template | | Conditionally Required [6] | string | Low cardinality representation of the messaging destination name [7] | /customers/{customerId} |
messaging.operation.type | | Conditionally Required If applicable. | string | A string identifying the type of the messaging operation. [8] | settle |
messaging.rabbitmq.message.delivery_tag | | Conditionally Required When available. | int | RabbitMQ message delivery tag | 123 |
messaging.client.id | | Recommended | string | A unique identifier for the client that consumes or produces a message. | client-5; myhost@8742@s8083jm |
messaging.destination.partition.id | | Recommended When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name. | 1 |
messaging.message.conversation_id | | Recommended | string | Message correlation ID property. | MyConversationId |
messaging.message.id | | Recommended If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | 452a7c7c7c7048c2f887f61572b18fc2 |
network.peer.address | | Recommended | string | Peer address of the messaging intermediary node where the operation was performed. [9] | 10.1.2.80; /tmp/my.sock |
network.peer.port | | Recommended if and only if network.peer.address is set. | int | Peer port of the messaging intermediary node where the operation was performed. | 65123 |
server.address | | Recommended | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [10] | example.com; 10.1.2.80; /tmp/my.sock |
server.port | | Recommended | int | Server port number. [11] | 80; 8080; 443 |
[1] messaging.destination.name: The RabbitMQ destination is defined by an exchange, a routing key, and a queue.
SHOULD be set to {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.
When {routing key} and {queue} are equal, only one of them SHOULD be used,
e.g. {exchange}:{routing key}.
[2] messaging.system: MUST be set to "rabbitmq".
[3] error.type: The error.type SHOULD be predictable, and SHOULD have low cardinality.
When error.type is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.
If the recorded error type is a wrapper that is not meaningful for
failure classification, instrumentation MAY use the type of the inner
error instead. For example, in Go, errors created with fmt.Errorf
using %w MAY be unwrapped when the wrapper type does not help
classify the failure.
Instrumentations SHOULD document the list of errors they report.
The cardinality of error.type within one instrumentation library SHOULD be low.
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
should be prepared for error.type to have high cardinality at query time when no
additional filters are applied.
If the operation has completed successfully, instrumentations SHOULD NOT set error.type.
If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it’s RECOMMENDED to:
- Use a domain-specific attribute
- Set
error.typeto capture all errors, regardless of whether they are defined within the domain-specific set or not.
[4] messaging.batch.message_count: If the span describes an operation on a batch of messages.
[5] messaging.batch.message_count: Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs.
[6] messaging.destination.template: If available. Instrumentations MUST NOT use messaging.destination.name as template unless low-cardinality of destination name is guaranteed.
[7] messaging.destination.template: Destination names could be constructed from templates. An example would be a destination name involving a username or product ID. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
[8] messaging.operation.type: SHOULD be set to settle.
[9] network.peer.address: Semantic conventions for individual messaging systems SHOULD document whether network.peer.* attributes are applicable.
Network peer address and port are important when the application interacts with individual intermediary nodes directly,
If a messaging operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
[10] server.address: Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
[11] server.port: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it’s available.
The following attributes can be important for making sampling decisions and SHOULD be provided at span creation time (if provided at all):
messaging.destination.namemessaging.destination.partition.idmessaging.destination.templatemessaging.operation.namemessaging.operation.typemessaging.systemserver.addressserver.port
error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
_OTHER | A fallback error value to be used when the instrumentation doesn’t define a custom value. | |
messaging.operation.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
create | A message is created. “Create” spans always refer to a single message and are used to provide a unique creation context for messages in batch sending scenarios. | |
process | One or more messages are processed by a consumer. | |
receive | One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. | |
send | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the “Send” span can be used as the creation context and no “Create” span needs to be created. | |
settle | One or more messages are settled. | |
messaging.system has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
activemq | Apache ActiveMQ | |
aws.sns | Amazon Simple Notification Service (SNS) | |
aws_sqs | Amazon Simple Queue Service (SQS) | |
eventgrid | Azure Event Grid | |
eventhubs | Azure Event Hubs | |
gcp_pubsub | Google Cloud Pub/Sub | |
jms | Java Message Service | |
kafka | Apache Kafka | |
pulsar | Apache Pulsar | |
rabbitmq | RabbitMQ | |
rocketmq | Apache RocketMQ | |
servicebus | Azure Service Bus | |
Feedback
Was this page helpful?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!