Semantic Conventions for Azure Messaging systems

Status: Experimental

The Semantic Conventions for Azure Service Bus and Azure Event Hubs extend and override the Messaging Semantic Conventions that describe common messaging operations attributes in addition to the Semantic Conventions described on this page.

Azure Service Bus

messaging.system MUST be set to "servicebus".

Span names

The span name SHOULD follow the general messaging span name pattern: it SHOULD start with the messaging destination name (Event Hubs queue or topic name) and contain a low-cardinality name of the operation the span describes:

• Spans names for settle operations SHOULD follow the <destination name> {messaging.servicebus.disposition_status} pattern. For example, my-queue complete or my-queue abandon.
• Spans names for publish operations SHOULD follow the <destination name> send pattern.
• Spans for create, receive, and publish operations SHOULD follow the general <destination name> <operation name> pattern.

Span attributes

The following additional attributes are defined:

Attribute	Type	Description	Examples	Requirement Level	Stability
messaging.servicebus.destination.subscription_name	string	The name of the subscription in the topic messages are received from.	mySubscription	Conditionally Required If messages are received from the subscription.
messaging.servicebus.disposition_status	string	Describes the settlement type.	complete	Conditionally Required if and only if messaging.operation is settle.
messaging.servicebus.message.delivery_count	int	Number of deliveries that have been attempted for this message.	2	Conditionally Required [1]
messaging.servicebus.message.enqueued_time	int	The UTC epoch seconds at which the message has been accepted and stored in the entity.	1701393730	Recommended

[1]: If delivery count is available and is bigger than 0.

Azure Event Hubs

messaging.system MUST be set to "eventhubs".

Span names

The span name SHOULD follow the general messaging span name pattern: it SHOULD start with the messaging destination name (Event Hubs namespace) and contain a low-cardinality name of an operation the span describes:

• Spans for settle operations SHOULD follow the <destination name> checkpoint pattern (matching Event Hubs terminology).
• Spans names for publish operations SHOULD follow the <destination name> send pattern.
• Spans for create, receive, and publish operations SHOULD follow the general <destination name> <operation name> pattern.

Span attributes

The following additional attributes are defined:

Attribute	Type	Description	Examples	Requirement Level	Stability
messaging.destination.partition.id	string	String representation of the partition id messages are sent to or received from, unique within the Event Hub.	1	Conditionally Required If available.
messaging.eventhubs.consumer.group	string	The name of the consumer group the event consumer is associated with.	indexer	Conditionally Required If not default ("$Default").
messaging.eventhubs.message.enqueued_time	int	The UTC epoch seconds at which the message has been accepted and stored in the entity.	1701393730	Recommended