Module: OpenTelemetry::SemConv::Incubating::MESSAGING

Defined in:

lib/opentelemetry/semconv/incubating/messaging/metrics.rb,
lib/opentelemetry/semconv/incubating/messaging/attributes.rb

Metrics Names

MESSAGING_CLIENT_CONSUMED_MESSAGES =

Note:

Stability Level: development

Number of messages that were delivered to the application.

Records the number of messages pulled from the broker or number of messages dispatched to the application in push-based scenarios. The metric SHOULD be reported once per message delivery. For example, if receiving and processing operations are both instrumented for a single message delivery, this counter is incremented when the message is received and not reported when it is processed.

'messaging.client.consumed.messages'

MESSAGING_CLIENT_OPERATION_DURATION =

Note:

Stability Level: development

Duration of messaging operation initiated by a producer or consumer client.

This metric SHOULD NOT be used to report processing duration - processing duration is reported in messaging.process.duration metric.

'messaging.client.operation.duration'

MESSAGING_CLIENT_PUBLISHED_MESSAGES =

Deprecated.

“Replaced by messaging.client.sent.messages.”, “reason”: “renamed”, “renamed_to”: “messaging.client.sent.messages”

Note:

Stability Level: development

Deprecated. Use messaging.client.sent.messages instead.

'messaging.client.published.messages'

MESSAGING_CLIENT_SENT_MESSAGES =

Note:

Stability Level: development

Number of messages producer attempted to send to the broker.

This metric MUST NOT count messages that were created but haven’t yet been sent.

'messaging.client.sent.messages'

MESSAGING_PROCESS_DURATION =

Note:

Stability Level: development

Duration of processing operation.

This metric MUST be reported for operations with messaging.operation.type that matches process.

'messaging.process.duration'

MESSAGING_PROCESS_MESSAGES =

Deprecated.

“Replaced by messaging.client.consumed.messages.”, “reason”: “renamed”, “renamed_to”: “messaging.client.consumed.messages”

Note:

Stability Level: development

Deprecated. Use messaging.client.consumed.messages instead.

'messaging.process.messages'

MESSAGING_PUBLISH_DURATION =

Deprecated.

“Replaced by messaging.client.operation.duration.”, “reason”: “renamed”, “renamed_to”: “messaging.client.operation.duration”

Note:

Stability Level: development

Deprecated. Use messaging.client.operation.duration instead.

'messaging.publish.duration'

MESSAGING_PUBLISH_MESSAGES =

Deprecated.

“Replaced by messaging.client.sent.messages.”, “reason”: “renamed”, “renamed_to”: “messaging.client.sent.messages”

Note:

Stability Level: development

Deprecated. Use messaging.client.sent.messages instead.

'messaging.publish.messages'

MESSAGING_RECEIVE_DURATION =

Deprecated.

“Replaced by messaging.client.operation.duration.”, “reason”: “renamed”, “renamed_to”: “messaging.client.operation.duration”

Note:

Stability Level: development

Deprecated. Use messaging.client.operation.duration instead.

'messaging.receive.duration'

MESSAGING_RECEIVE_MESSAGES =

Deprecated.

“Replaced by messaging.client.consumed.messages.”, “reason”: “renamed”, “renamed_to”: “messaging.client.consumed.messages”

Note:

Stability Level: development

Deprecated. Use messaging.client.consumed.messages instead.

'messaging.receive.messages'

Attribute Names

MESSAGING_BATCH_MESSAGE_COUNT =

Note:

Stability Level: development

The number of messages sent, received, or processed in the scope of the batching operation.

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.

Examples:

Sample Values

0
1
2

'messaging.batch.message_count'

MESSAGING_CLIENT_ID =

Note:

Stability Level: development

A unique identifier for the client that consumes or produces a message.

Examples:

Sample Values

client-5
myhost@8742@s8083jm

'messaging.client.id'

MESSAGING_CONSUMER_GROUP_NAME =

Note:

Stability Level: development

The name of the consumer group with which a consumer is associated.

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.

Examples:

Sample Values

my-group
indexer

'messaging.consumer.group.name'

MESSAGING_DESTINATION_ANONYMOUS =

Note:

Stability Level: development

A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).

'messaging.destination.anonymous'

MESSAGING_DESTINATION_NAME =

Note:

Stability Level: development

The message destination name

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.

Examples:

Sample Values

MyQueue
MyTopic

'messaging.destination.name'

MESSAGING_DESTINATION_PARTITION_ID =

Note:

Stability Level: development

The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name.

Examples:

Sample Values

1

'messaging.destination.partition.id'

MESSAGING_DESTINATION_SUBSCRIPTION_NAME =

Note:

Stability Level: development

The name of the destination subscription from which a message is consumed.

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.

Examples:

Sample Values

subscription-a

'messaging.destination.subscription.name'

MESSAGING_DESTINATION_TEMPLATE =

Note:

Stability Level: development

Low cardinality representation of the messaging destination name

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.

Examples:

Sample Values

/customers/{customerId}

'messaging.destination.template'

MESSAGING_DESTINATION_TEMPORARY =

Note:

Stability Level: development

A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.

'messaging.destination.temporary'

MESSAGING_DESTINATION_PUBLISH_ANONYMOUS =

Deprecated.

“Removed. No replacement at this time.”, “reason”: “obsoleted”

Note:

Stability Level: development

Deprecated, no replacement at this time.

'messaging.destination_publish.anonymous'

MESSAGING_DESTINATION_PUBLISH_NAME =

Deprecated.

“Removed. No replacement at this time.”, “reason”: “obsoleted”

Note:

Stability Level: development

Deprecated, no replacement at this time.

Examples:

Sample Values

MyQueue
MyTopic

'messaging.destination_publish.name'

MESSAGING_EVENTHUBS_CONSUMER_GROUP =

Deprecated.

“Replaced by messaging.consumer.group.name.”, “reason”: “renamed”, “renamed_to”: “messaging.consumer.group.name”

Note:

Stability Level: development

Deprecated, use messaging.consumer.group.name instead.

Examples:

Sample Values

$Default

'messaging.eventhubs.consumer.group'

MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME =

Note:

Stability Level: development

The UTC epoch seconds at which the message has been accepted and stored in the entity.

Examples:

Sample Values

1701393730

'messaging.eventhubs.message.enqueued_time'

MESSAGING_GCP_PUBSUB_MESSAGE_ACK_DEADLINE =

Note:

Stability Level: development

The ack deadline in seconds set for the modify ack deadline request.

Examples:

Sample Values

10

'messaging.gcp_pubsub.message.ack_deadline'

MESSAGING_GCP_PUBSUB_MESSAGE_ACK_ID =

Note:

Stability Level: development

The ack id for a given message.

Examples:

Sample Values

ack_id

'messaging.gcp_pubsub.message.ack_id'

MESSAGING_GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT =

Note:

Stability Level: development

The delivery attempt for a given message.

Examples:

Sample Values

2

'messaging.gcp_pubsub.message.delivery_attempt'

MESSAGING_GCP_PUBSUB_MESSAGE_ORDERING_KEY =

Note:

Stability Level: development

The ordering key for a given message. If the attribute is not present, the message does not have an ordering key.

Examples:

Sample Values

ordering_key

'messaging.gcp_pubsub.message.ordering_key'

MESSAGING_KAFKA_CONSUMER_GROUP =

Deprecated.

“Replaced by messaging.consumer.group.name.”, “reason”: “renamed”, “renamed_to”: “messaging.consumer.group.name”

Note:

Stability Level: development

Deprecated, use messaging.consumer.group.name instead.

Examples:

Sample Values

my-group

'messaging.kafka.consumer.group'

MESSAGING_KAFKA_DESTINATION_PARTITION =

Deprecated.

“Replaced by messaging.destination.partition.id.”, “reason”: “renamed”, “renamed_to”: “messaging.destination.partition.id”

Note:

Stability Level: development

Deprecated, use messaging.destination.partition.id instead.

Examples:

Sample Values

2

'messaging.kafka.destination.partition'

MESSAGING_KAFKA_MESSAGE_KEY =

Note:

Stability Level: development

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.

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.

Examples:

Sample Values

myKey

'messaging.kafka.message.key'

MESSAGING_KAFKA_MESSAGE_OFFSET =

Deprecated.

“Replaced by messaging.kafka.offset.”, “reason”: “renamed”, “renamed_to”: “messaging.kafka.offset”

Note:

Stability Level: development

Deprecated, use messaging.kafka.offset instead.

Examples:

Sample Values

42

'messaging.kafka.message.offset'

MESSAGING_KAFKA_MESSAGE_TOMBSTONE =

Note:

Stability Level: development

A boolean that is true if the message is a tombstone.

'messaging.kafka.message.tombstone'

MESSAGING_KAFKA_OFFSET =

Note:

Stability Level: development

The offset of a record in the corresponding Kafka partition.

Examples:

Sample Values

42

'messaging.kafka.offset'

MESSAGING_MESSAGE_BODY_SIZE =

Note:

Stability Level: development

The size of the message body in bytes.

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

Examples:

Sample Values

1439

'messaging.message.body.size'

MESSAGING_MESSAGE_CONVERSATION_ID =

Note:

Stability Level: development

The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called “Correlation ID”.

Examples:

Sample Values

MyConversationId

'messaging.message.conversation_id'

MESSAGING_MESSAGE_ENVELOPE_SIZE =

Note:

Stability Level: development

The size of the message body and metadata in bytes.

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

Examples:

Sample Values

2738

'messaging.message.envelope.size'

MESSAGING_MESSAGE_ID =

Note:

Stability Level: development

A value used by the messaging system as an identifier for the message, represented as a string.

Examples:

Sample Values

452a7c7c7c7048c2f887f61572b18fc2

'messaging.message.id'

MESSAGING_OPERATION =

Deprecated.

“Replaced by messaging.operation.type.”, “reason”: “renamed”, “renamed_to”: “messaging.operation.type”

Note:

Stability Level: development

Deprecated, use messaging.operation.type instead.

Examples:

Sample Values

publish
create
process

'messaging.operation'

MESSAGING_OPERATION_NAME =

Note:

Stability Level: development

The system-specific name of the messaging operation.

Examples:

Sample Values

ack
nack
send

'messaging.operation.name'

MESSAGING_OPERATION_TYPE =

Note:

Stability Level: development

A string identifying the type of the messaging operation.

If a custom value is used, it MUST be of low cardinality.

'messaging.operation.type'

MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY =

Note:

Stability Level: development

RabbitMQ message routing key.

Examples:

Sample Values

myKey

'messaging.rabbitmq.destination.routing_key'

MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG =

Note:

Stability Level: development

RabbitMQ message delivery tag

Examples:

Sample Values

123

'messaging.rabbitmq.message.delivery_tag'

MESSAGING_ROCKETMQ_CLIENT_GROUP =

Deprecated.

“Replaced by messaging.consumer.group.name on the consumer spans. No replacement for producer spans.\n”, “reason”: “uncategorized”

Note:

Stability Level: development

Deprecated, use messaging.consumer.group.name instead.

Examples:

Sample Values

myConsumerGroup

'messaging.rocketmq.client_group'

MESSAGING_ROCKETMQ_CONSUMPTION_MODEL =

Note:

Stability Level: development

Model of message consumption. This only applies to consumer spans.

'messaging.rocketmq.consumption_model'

MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL =

Note:

Stability Level: development

The delay time level for delay message, which determines the message delay time.

Examples:

Sample Values

3

'messaging.rocketmq.message.delay_time_level'

MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP =

Note:

Stability Level: development

The timestamp in milliseconds that the delay message is expected to be delivered to consumer.

Examples:

Sample Values

1665987217045

'messaging.rocketmq.message.delivery_timestamp'

MESSAGING_ROCKETMQ_MESSAGE_GROUP =

Note:

Stability Level: development

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.

Examples:

Sample Values

myMessageGroup

'messaging.rocketmq.message.group'

MESSAGING_ROCKETMQ_MESSAGE_KEYS =

Note:

Stability Level: development

Key(s) of message, another way to mark message besides message id.

Examples:

Sample Values

["keyA", "keyB"]

'messaging.rocketmq.message.keys'

MESSAGING_ROCKETMQ_MESSAGE_TAG =

Note:

Stability Level: development

The secondary classifier of message besides topic.

Examples:

Sample Values

tagA

'messaging.rocketmq.message.tag'

MESSAGING_ROCKETMQ_MESSAGE_TYPE =

Note:

Stability Level: development

Type of message.

'messaging.rocketmq.message.type'

MESSAGING_ROCKETMQ_NAMESPACE =

Note:

Stability Level: development

Namespace of RocketMQ resources, resources in different namespaces are individual.

Examples:

Sample Values

myNamespace

'messaging.rocketmq.namespace'

MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME =

Deprecated.

“Replaced by messaging.destination.subscription.name.”, “reason”: “renamed”, “renamed_to”: “messaging.destination.subscription.name”

Note:

Stability Level: development

Deprecated, use messaging.destination.subscription.name instead.

Examples:

Sample Values

subscription-a

'messaging.servicebus.destination.subscription_name'

MESSAGING_SERVICEBUS_DISPOSITION_STATUS =

Note:

Stability Level: development

Describes the settlement type.

'messaging.servicebus.disposition_status'

MESSAGING_SERVICEBUS_MESSAGE_DELIVERY_COUNT =

Note:

Stability Level: development

Number of deliveries that have been attempted for this message.

Examples:

Sample Values

2

'messaging.servicebus.message.delivery_count'

MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME =

Note:

Stability Level: development

The UTC epoch seconds at which the message has been accepted and stored in the entity.

Examples:

Sample Values

1701393730

'messaging.servicebus.message.enqueued_time'

MESSAGING_SYSTEM =

Note:

Stability Level: development

The messaging system as identified by the client instrumentation.

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.system'