Messaging

Messaging Attributes

AttributeTypeDescriptionExamples
messaging.batch.message_countintThe number of messages sent, received, or processed in the scope of the batching operation. [1]0; 1; 2
messaging.client_idstringA unique identifier for the client that consumes or produces a message.client-5; myhost@8742@s8083jm
messaging.destination.anonymousbooleanA boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).
messaging.destination.namestringThe message destination name [2]MyQueue; MyTopic
messaging.destination.templatestringLow cardinality representation of the messaging destination name [3]/customers/{customerId}
messaging.destination.temporarybooleanA boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.
messaging.destination_publish.anonymousbooleanA boolean that is true if the publish message destination is anonymous (could be unnamed or have auto-generated name).
messaging.destination_publish.namestringThe name of the original destination the message was published to [4]MyQueue; MyTopic
messaging.gcp_pubsub.message.ordering_keystringThe ordering key for a given message. If the attribute is not present, the message does not have an ordering key.ordering_key
messaging.kafka.consumer.groupstringName of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers.my-group
messaging.kafka.destination.partitionintPartition the message is sent to.2
messaging.kafka.message.keystringMessage keys in Kafka are used for grouping alike messages to ensure they’re processed on the same partition. They differ from messaging.message.id in that they’re not unique. If the key is null, the attribute MUST NOT be set. [5]myKey
messaging.kafka.message.offsetintThe offset of a record in the corresponding Kafka partition.42
messaging.kafka.message.tombstonebooleanA boolean that is true if the message is a tombstone.
messaging.message.body.sizeintThe size of the message body in bytes. [6]1439
messaging.message.conversation_idstringThe conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called “Correlation ID”.MyConversationId
messaging.message.envelope.sizeintThe size of the message body and metadata in bytes. [7]2738
messaging.message.idstringA value used by the messaging system as an identifier for the message, represented as a string.452a7c7c7c7048c2f887f61572b18fc2
messaging.operationstringA string identifying the kind of messaging operation. [8]publish
messaging.rabbitmq.destination.routing_keystringRabbitMQ message routing key.myKey
messaging.rocketmq.client_groupstringName of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind.myConsumerGroup
messaging.rocketmq.consumption_modelstringModel of message consumption. This only applies to consumer spans.clustering
messaging.rocketmq.message.delay_time_levelintThe delay time level for delay message, which determines the message delay time.3
messaging.rocketmq.message.delivery_timestampintThe timestamp in milliseconds that the delay message is expected to be delivered to consumer.1665987217045
messaging.rocketmq.message.groupstringIt is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group.myMessageGroup
messaging.rocketmq.message.keysstring[]Key(s) of message, another way to mark message besides message id.[keyA, keyB]
messaging.rocketmq.message.tagstringThe secondary classifier of message besides topic.tagA
messaging.rocketmq.message.typestringType of message.normal
messaging.rocketmq.namespacestringNamespace of RocketMQ resources, resources in different namespaces are individual.myNamespace
messaging.systemstringAn identifier for the messaging system being used. See below for a list of well-known identifiers.activemq

[1]: 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.

[2]: 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.

[3]: Destination names could be constructed from templates. An example would be a destination name involving a user name 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.

[4]: The name SHOULD uniquely identify a specific queue, topic, or other entity within the broker. If the broker doesn’t have such notion, the original destination name SHOULD uniquely identify the broker.

[5]: If the key type is not string, it’s string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don’t include its value.

[6]: This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed body size should be used.

[7]: This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed size should be used.

[8]: If a custom value is used, it MUST be of low cardinality.

messaging.operation 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.

ValueDescription
publishOne or more messages are provided for publishing to an intermediary. If a single message is published, the context of the “Publish” span can be used as the creation context and no “Create” span needs to be created.
createA message is created. “Create” spans always refer to a single message and are used to provide a unique creation context for messages in batch publishing scenarios.
receiveOne 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.
deliverOne or more messages are passed to a consumer. This operation refers to push-based scenarios, where consumer register callbacks which get called by messaging SDKs.

messaging.rocketmq.consumption_model MUST be one of the following:

ValueDescription
clusteringClustering consumption model
broadcastingBroadcasting consumption model

messaging.rocketmq.message.type MUST be one of the following:

ValueDescription
normalNormal message
fifoFIFO message
delayDelay message
transactionTransaction message

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.

ValueDescription
activemqApache ActiveMQ
aws_sqsAmazon Simple Queue Service (SQS)
azure_eventgridAzure Event Grid
azure_eventhubsAzure Event Hubs
azure_servicebusAzure Service Bus
gcp_pubsubGoogle Cloud Pub/Sub
jmsJava Message Service
kafkaApache Kafka
rabbitmqRabbitMQ
rocketmqApache RocketMQ