Messaging
as of v1.44.0Queues, topics and brokers — producing, receiving, processing and settling a message.
messaging 48cloudevents 5message 4
- attributes
- 57
- metrics
- 10
- signals
- 13
- stable
- 0
- deprecated
- 14
Signals
What this domain emits, and the attributes each one carries, most strongly required first. An attribute marked * is required on that signal; * is conditionally required.
Spans 8
- messaging.create.producerproducerDevelopmentDescribes a message being created or passed to a client library for sending.
messaging.operation.name*messaging.system*error.type*messaging.destination.name*messaging.destination.template*messaging.operation.type*messaging.destination.partition.idmessaging.message.conversation_idmessaging.message.idserver.addressserver.portmessaging.message.body.size+1 more
- messaging.eventhubs.generic.clientclientDevelopmentDescribes an Azure Event Hubs client operation that is not covered by a more specific (create, send, receive, process, o
messaging.operation.name*messaging.system*error.type*messaging.batch.message_count*messaging.destination.name*messaging.destination.partition.id*messaging.destination.template*messaging.operation.type*messaging.client.idmessaging.message.conversation_idmessaging.message.idnetwork.peer.address+3 more
- messaging.process.consumerconsumerDevelopmentDescribes one or more messages being processed by a consumer (push-based).
messaging.operation.name*messaging.system*error.type*messaging.batch.message_count*messaging.destination.name*messaging.destination.template*messaging.operation.type*messaging.client.idmessaging.destination.partition.idmessaging.message.conversation_idmessaging.message.idserver.address+3 more
- messaging.receive.clientclientDevelopmentDescribes one or more messages being requested by a consumer (pull-based).
messaging.operation.name*messaging.system*error.type*messaging.batch.message_count*messaging.destination.name*messaging.destination.template*messaging.operation.type*messaging.client.idmessaging.destination.partition.idmessaging.message.conversation_idmessaging.message.idnetwork.peer.address+5 more
- messaging.send.clientclientDevelopmentDescribes one or more messages being sent to an intermediary when a separate message creation context ("Create" span or
messaging.operation.name*messaging.system*error.type*messaging.batch.message_count*messaging.destination.name*messaging.destination.template*messaging.operation.type*messaging.client.idmessaging.destination.partition.idmessaging.message.conversation_idmessaging.message.idnetwork.peer.address+5 more
- messaging.send.producerproducerDevelopmentDescribes one or more messages being sent to an intermediary, where the "Send" span's context is used as the message cre
messaging.operation.name*messaging.system*error.type*messaging.batch.message_count*messaging.destination.name*messaging.destination.template*messaging.operation.type*messaging.client.idmessaging.destination.partition.idmessaging.message.conversation_idmessaging.message.idnetwork.peer.address+5 more
- messaging.servicebus.generic.clientclientDevelopmentDescribes an Azure Service Bus client operation that is not covered by a more specific (create, send, receive, process,
messaging.operation.name*messaging.system*error.type*messaging.batch.message_count*messaging.destination.name*messaging.destination.subscription.name*messaging.destination.template*messaging.operation.type*messaging.client.idmessaging.destination.partition.idmessaging.message.conversation_idmessaging.message.id+4 more
- messaging.settle.clientclientDevelopmentDescribes one or more messages being settled.
messaging.operation.name*messaging.system*error.type*messaging.batch.message_count*messaging.destination.name*messaging.destination.template*messaging.operation.type*messaging.client.idmessaging.destination.partition.idmessaging.message.conversation_idmessaging.message.idnetwork.peer.address+3 more
Events 5
- messaging.create.exceptionDevelopmentThis event represents an exception that occurred during a messaging create operation.
- messaging.process.exceptionDevelopmentThis event represents an exception that occurred during messaging process operations.
- messaging.receive.exceptionDevelopmentThis event represents an exception that occurred during a messaging receive operation.
- messaging.send.exceptionDevelopmentThis event represents an exception that occurred during a messaging send operation.
- messaging.settle.exceptionDevelopmentThis event represents an exception that occurred during a messaging settle operation.
Metrics 10
- messaging.client.consumed.messagesDevelopmentcounter · {message}Number of messages that were delivered to the application.
- messaging.client.operation.durationDevelopmenthistogram · sDuration of messaging operation initiated by a producer or consumer client.
- messaging.client.published.messagesDeprecatedcounter · {message}Deprecated. Use messaging.client.sent.messages instead.
- messaging.client.sent.messagesDevelopmentcounter · {message}Number of messages producer attempted to send to the broker.
- messaging.process.durationDevelopmenthistogram · sDuration of processing operation.
- messaging.process.messagesDeprecatedcounter · {message}Deprecated. Use messaging.client.consumed.messages instead.
- messaging.publish.durationDeprecatedhistogram · sDeprecated. Use messaging.client.operation.duration instead.
- messaging.publish.messagesDeprecatedcounter · {message}Deprecated. Use messaging.client.sent.messages instead.
- messaging.receive.durationDeprecatedhistogram · sDeprecated. Use messaging.client.operation.duration instead.
- messaging.receive.messagesDeprecatedcounter · {message}Deprecated. Use messaging.client.consumed.messages instead.
Specification
- Spansare bound by the trace specification — 289 requirements across 7 documents, 166 of them MUST or SHALL.
- Metricsare bound by the metrics specification — 548 requirements across 8 documents, 279 of them MUST or SHALL.
- Eventsare bound by the logs specification — 162 requirements across 5 documents, 83 of them MUST or SHALL.
The specification prose never names this domain. That is not an omission: the specification defines signals, not subject matter — what binds messaging telemetry is the general rules above, and the conventions themselves carry the rest.
On the wire, this lands in trace/v1/trace, metrics/v1/metrics, logs/v1/logs. Field-by-field definitions are under OTLP.
Attributes 57
messaging48 attributes
- messaging.batch.message_countDevelopmentThe number of messages sent, received, or processed in the scope of the batching operation.
- messaging.client_id
- messaging.client.idDevelopmentA unique identifier for the client that consumes or produces a message.
- messaging.consumer.group.nameDevelopmentThe name of the consumer group with which a consumer is associated.
- messaging.destination_publish.anonymousDeprecatedDeprecated, no replacement at this time.
- messaging.destination_publish.nameDeprecatedDeprecated, no replacement at this time.
- messaging.destination.anonymousDevelopmentA boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).
- messaging.destination.nameDevelopmentThe message destination name
- messaging.destination.partition.idDevelopmentThe identifier of the partition messages are sent to or received from, unique within the messaging.destination.name.
- messaging.destination.subscription.nameDevelopmentThe name of the destination subscription from which a message is consumed.
- messaging.destination.templateDevelopmentLow cardinality representation of the messaging destination name
- messaging.destination.temporaryDevelopmentA boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.
- messaging.eventhubs.consumer.group
- messaging.eventhubs.message.enqueued_timeDevelopmentThe UTC epoch seconds at which the message has been accepted and stored in the entity.
- messaging.gcp_pubsub.message.ack_deadlineDevelopmentThe ack deadline in seconds set for the modify ack deadline request.
- messaging.gcp_pubsub.message.ack_idDevelopmentThe ack ID for a given message.
- messaging.gcp_pubsub.message.delivery_attemptDevelopmentThe delivery attempt for a given message.
- messaging.gcp_pubsub.message.ordering_keyDevelopmentThe ordering key for a given message. If the attribute is not present, the message does not have an ordering key.
- messaging.kafka.cluster.idDevelopmentThe Kafka cluster ID, obtained from the broker metadata exposed through the Kafka client (or AdminClient) API.
- messaging.kafka.consumer.group
- messaging.kafka.destination.partitionDeprecatedDeprecated, use messaging.destination.partition.id instead.
- messaging.kafka.message.keyDevelopmentMessage 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
- messaging.kafka.message.offset
- messaging.kafka.message.tombstoneDevelopmentA boolean that is true if the message is a tombstone.
- messaging.kafka.offsetDevelopmentThe offset of a record in the corresponding Kafka partition.
- messaging.message.body.sizeDevelopmentThe size of the message body in bytes.
- messaging.message.conversation_idDevelopmentThe conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".
- messaging.message.envelope.sizeDevelopmentThe size of the message body and metadata in bytes.
- messaging.message.idDevelopmentA value used by the messaging system as an identifier for the message, represented as a string.
- messaging.operation
- messaging.operation.nameDevelopmentThe system-specific name of the messaging operation.
- messaging.operation.typeDevelopmentA string identifying the type of the messaging operation.
- messaging.rabbitmq.destination.routing_keyDevelopmentRabbitMQ message routing key.
- messaging.rabbitmq.message.delivery_tagDevelopmentRabbitMQ message delivery tag
- messaging.rocketmq.client_groupDeprecatedDeprecated, use messaging.consumer.group.name instead.
- messaging.rocketmq.consumption_modelDevelopmentModel of message consumption. This only applies to consumer spans.
- messaging.rocketmq.message.delay_time_levelDevelopmentThe delay time level for delay message, which determines the message delay time.
- messaging.rocketmq.message.delivery_timestampDevelopmentThe timestamp in milliseconds that the delay message is expected to be delivered to consumer.
- messaging.rocketmq.message.groupDevelopmentIt is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group.
- messaging.rocketmq.message.keysDevelopmentKey(s) of message, another way to mark message besides message ID.
- messaging.rocketmq.message.tagDevelopmentThe secondary classifier of message besides topic.
- messaging.rocketmq.message.typeDevelopmentType of message.
- messaging.rocketmq.namespaceDevelopmentNamespace of RocketMQ resources, resources in different namespaces are individual.
- messaging.servicebus.destination.subscription_nameDeprecated→ messaging.destination.subscription.nameDeprecated, use messaging.destination.subscription.name instead.
- messaging.servicebus.disposition_statusDevelopmentDescribes the settlement type.
- messaging.servicebus.message.delivery_countDevelopmentNumber of deliveries that have been attempted for this message.
- messaging.servicebus.message.enqueued_timeDevelopmentThe UTC epoch seconds at which the message has been accepted and stored in the entity.
- messaging.systemDevelopmentThe messaging system as identified by the client instrumentation.
cloudevents5 attributes
- cloudevents.event_idDevelopmentThe event_id uniquely identifies the event.
- cloudevents.event_sourceDevelopmentThe source identifies the context in which an event happened.
- cloudevents.event_spec_versionDevelopmentThe version of the CloudEvents specification which the event uses.
- cloudevents.event_subjectDevelopmentThe subject of the event in the context of the event producer (identified by source).
- cloudevents.event_typeDevelopmentThe event_type contains a value describing the type of event related to the originating occurrence.
message4 attributes
- message.compressed_sizeDeprecatedDeprecated, no replacement at this time.
- message.idDeprecatedDeprecated, no replacement at this time.
- message.typeDeprecatedDeprecated, no replacement at this time.
- message.uncompressed_sizeDeprecatedDeprecated, no replacement at this time.
Recent changes
Breaking and notable changes to this domain across the last 6 semantic-conventions releases.
- deprecatedattributemessage.compressed_sizeDeprecated, no replacement at this time.
- deprecatedattributemessage.idDeprecated, no replacement at this time.
- deprecatedattributemessage.typeDeprecated, no replacement at this time.
- deprecatedattributemessage.uncompressed_sizeDeprecated, no replacement at this time.
Topics are this site's grouping of upstream namespaces, not a structure the OpenTelemetry project publishes. JSON · All domains