messaging.md

Messaging

• General Messaging Attributes
• Azure Event Hubs Attributes
• GCP Pub/Sub Attributes
• Kafka Attributes
• RabbitMQ Attributes
• RocketMQ Attributes
• Azure Service Bus Attributes
• Deprecated Messaging Attributes

General Messaging Attributes

Attributes describing telemetry around messaging systems and messaging activities.

Attribute	Type	Description	Examples	Stability
messaging.batch.message_count	int	The number of messages sent, received, or processed in the scope of the batching operation. [1]	0; 1; 2
messaging.client.id	string	A unique identifier for the client that consumes or produces a message.	client-5; myhost@8742@s8083jm
messaging.consumer.group.name	string	The name of the consumer group with which a consumer is associated. [2]	my-group; indexer
messaging.destination.anonymous	boolean	A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).
messaging.destination.name	string	The message destination name [3]	MyQueue; MyTopic
messaging.destination.partition.id	string	The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name.	1
messaging.destination.subscription.name	string	The name of the destination subscription from which a message is consumed. [4]	subscription-a
messaging.destination.template	string	Low cardinality representation of the messaging destination name [5]	/customers/{customerId}
messaging.destination.temporary	boolean	A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.
messaging.message.body.size	int	The size of the message body in bytes. [6]	1439
messaging.message.conversation_id	string	The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".	MyConversationId
messaging.message.envelope.size	int	The size of the message body and metadata in bytes. [7]	2738
messaging.message.id	string	A value used by the messaging system as an identifier for the message, represented as a string.	452a7c7c7c7048c2f887f61572b18fc2
messaging.operation.name	string	The system-specific name of the messaging operation.	ack; nack; send
messaging.operation.type	string	A string identifying the type of the messaging operation. [8]	publish; create; receive
messaging.system	string	The messaging system as identified by the client instrumentation. [9]	activemq; aws_sqs; eventgrid

[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]: Semantic conventions for individual messaging systems SHOULD document whether messaging.consumer.group.name is applicable and what it means in the context of that system.

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

[4]: Semantic conventions for individual messaging systems SHOULD document whether messaging.destination.subscription.name is applicable and what it means in the context of that system.

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

[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.

[9]: The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the messaging.system is set to kafka based on the instrumentation's best knowledge.

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 publishing scenarios.
deliver	Deprecated. Use process instead.	Replaced by process.
process	One or more messages are processed by a consumer.
publish	One 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.
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.
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_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

Azure Event Hubs Attributes

This group describes attributes specific to Azure Event Hubs.

Attribute	Type	Description	Examples	Stability
messaging.eventhubs.message.enqueued_time	int	The UTC epoch seconds at which the message has been accepted and stored in the entity.	1701393730

GCP Pub/Sub Attributes

This group describes attributes specific to GCP Pub/Sub.

Attribute	Type	Description	Examples	Stability
messaging.gcp_pubsub.message.ack_deadline	int	The ack deadline in seconds set for the modify ack deadline request.	10
messaging.gcp_pubsub.message.ack_id	string	The ack id for a given message.	ack_id
messaging.gcp_pubsub.message.delivery_attempt	int	The delivery attempt for a given message.	2
messaging.gcp_pubsub.message.ordering_key	string	The ordering key for a given message. If the attribute is not present, the message does not have an ordering key.	ordering_key

Kafka Attributes

This group describes attributes specific to Apache Kafka.

Attribute	Type	Description	Examples	Stability
messaging.kafka.message.key	string	Message 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. [10]	myKey
messaging.kafka.message.tombstone	boolean	A boolean that is true if the message is a tombstone.
messaging.kafka.offset	int	The offset of a record in the corresponding Kafka partition.	42

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

RabbitMQ Attributes

This group describes attributes specific to RabbitMQ.

Attribute	Type	Description	Examples	Stability
messaging.rabbitmq.destination.routing_key	string	RabbitMQ message routing key.	myKey
messaging.rabbitmq.message.delivery_tag	int	RabbitMQ message delivery tag	123

RocketMQ Attributes

This group describes attributes specific to RocketMQ.

Attribute	Type	Description	Examples	Stability
messaging.rocketmq.consumption_model	string	Model of message consumption. This only applies to consumer spans.	clustering; broadcasting
messaging.rocketmq.message.delay_time_level	int	The delay time level for delay message, which determines the message delay time.	3
messaging.rocketmq.message.delivery_timestamp	int	The timestamp in milliseconds that the delay message is expected to be delivered to consumer.	1665987217045
messaging.rocketmq.message.group	string	It 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.keys	string[]	Key(s) of message, another way to mark message besides message id.	["keyA", "keyB"]
messaging.rocketmq.message.tag	string	The secondary classifier of message besides topic.	tagA
messaging.rocketmq.message.type	string	Type of message.	normal; fifo; delay
messaging.rocketmq.namespace	string	Namespace of RocketMQ resources, resources in different namespaces are individual.	myNamespace

messaging.rocketmq.consumption_model 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
broadcasting	Broadcasting consumption model
clustering	Clustering consumption model

messaging.rocketmq.message.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
delay	Delay message
fifo	FIFO message
normal	Normal message
transaction	Transaction message

Azure Service Bus Attributes

This group describes attributes specific to Azure Service Bus.

Attribute	Type	Description	Examples	Stability
messaging.servicebus.disposition_status	string	Describes the settlement type.	complete; abandon; dead_letter
messaging.servicebus.message.delivery_count	int	Number of deliveries that have been attempted for this message.	2
messaging.servicebus.message.enqueued_time	int	The UTC epoch seconds at which the message has been accepted and stored in the entity.	1701393730

messaging.servicebus.disposition_status 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
abandon	Message is abandoned
complete	Message is completed
dead_letter	Message is sent to dead letter queue
defer	Message is deferred

Deprecated Messaging Attributes

Describes deprecated messaging attributes.

Attribute	Type	Description	Examples	Stability
messaging.client_id	string	Deprecated, use messaging.client.id instead.	client-5; myhost@8742@s8083jm	Replaced by messaging.client.id.
messaging.destination_publish.anonymous	boolean	Deprecated, no replacement at this time.		No replacement at this time.
messaging.destination_publish.name	string	Deprecated, no replacement at this time.	MyQueue; MyTopic	No replacement at this time.
messaging.eventhubs.consumer.group	string	Deprecated, use messaging.consumer.group.name instead.	$Default	Replaced by messaging.consumer.group.name.
messaging.kafka.consumer.group	string	Deprecated, use messaging.consumer.group.name instead.	my-group	Replaced by messaging.consumer.group.name.
messaging.kafka.destination.partition	int	Deprecated, use messaging.destination.partition.id instead.	2	Replaced by messaging.destination.partition.id.
messaging.kafka.message.offset	int	Deprecated, use messaging.kafka.offset instead.	42	Replaced by messaging.kafka.offset.
messaging.operation	string	Deprecated, use messaging.operation.type instead.	publish; create; process	Replaced by messaging.operation.type.
messaging.rocketmq.client_group	string	Deprecated, use messaging.consumer.group.name instead.	myConsumerGroup	Replaced by messaging.consumer.group.name on the consumer spans. No replacement for producer spans.
messaging.servicebus.destination.subscription_name	string	Deprecated, use messaging.destination.subscription.name instead.	subscription-a	Replaced by messaging.destination.subscription.name.