Messaging enum

messaging.* attribute keys from the OpenTelemetry semantic-conventions attribute registry.

Inheritance
Implemented types
Available extensions

Values

messagingBatchMessageCount → const Messaging

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

Examples: 0, 1, 2

Stability: development

const Messaging('messaging.batch.message_count')
messagingClientId → const Messaging

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

Examples: client-5, myhost@8742@s8083jm

Stability: development

const Messaging('messaging.client.id')
messagingConsumerGroupName → const Messaging

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

Examples: my-group, indexer

Stability: development

const Messaging('messaging.consumer.group.name')
messagingDestinationAnonymous → const Messaging

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

Stability: development

const Messaging('messaging.destination.anonymous')
messagingDestinationName → const Messaging

The message destination name

Examples: MyQueue, MyTopic

Stability: development

const Messaging('messaging.destination.name')
messagingDestinationPartitionId → const Messaging

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

Examples: 1

Stability: development

const Messaging('messaging.destination.partition.id')
messagingDestinationSubscriptionName → const Messaging

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

Examples: subscription-a

Stability: development

const Messaging('messaging.destination.subscription.name')
messagingDestinationTemplate → const Messaging

Low cardinality representation of the messaging destination name

Examples: /customers/{customerId}

Stability: development

const Messaging('messaging.destination.template')
messagingDestinationTemporary → const Messaging

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

Stability: development

const Messaging('messaging.destination.temporary')
messagingDestinationPublishAnonymous → const Messaging

Deprecated, no replacement at this time.

Stability: development

const Messaging('messaging.destination_publish.anonymous')
messagingDestinationPublishName → const Messaging

Deprecated, no replacement at this time.

Examples: MyQueue, MyTopic

Stability: development

const Messaging('messaging.destination_publish.name')
messagingEventhubsConsumerGroup → const Messaging

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

Examples: $Default

Stability: development

const Messaging('messaging.eventhubs.consumer.group')
messagingEventhubsMessageEnqueuedTime → const Messaging

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

Examples: 1701393730

Stability: development

const Messaging('messaging.eventhubs.message.enqueued_time')
messagingGcpPubsubMessageAckDeadline → const Messaging

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

Examples: 10

Stability: development

const Messaging('messaging.gcp_pubsub.message.ack_deadline')
messagingGcpPubsubMessageAckId → const Messaging

The ack ID for a given message.

Examples: ack_id

Stability: development

const Messaging('messaging.gcp_pubsub.message.ack_id')
messagingGcpPubsubMessageDeliveryAttempt → const Messaging

The delivery attempt for a given message.

Examples: 2

Stability: development

const Messaging('messaging.gcp_pubsub.message.delivery_attempt')
messagingGcpPubsubMessageOrderingKey → const Messaging

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

Examples: ordering_key

Stability: development

const Messaging('messaging.gcp_pubsub.message.ordering_key')
messagingKafkaClusterId → const Messaging

The Kafka cluster ID, obtained from the broker metadata exposed through the Kafka client (or AdminClient) API.

Examples: MkU3OEVBNTcwNTJENDM2Qk

Stability: development

const Messaging('messaging.kafka.cluster.id')
messagingKafkaConsumerGroup → const Messaging

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

Examples: my-group

Stability: development

const Messaging('messaging.kafka.consumer.group')
messagingKafkaDestinationPartition → const Messaging

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

Examples: 2

Stability: development

const Messaging('messaging.kafka.destination.partition')
messagingKafkaMessageKey → const Messaging

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.

Examples: myKey

Stability: development

const Messaging('messaging.kafka.message.key')
messagingKafkaMessageOffset → const Messaging

Deprecated, use messaging.kafka.offset instead.

Examples: 42

Stability: development

const Messaging('messaging.kafka.message.offset')
messagingKafkaMessageTombstone → const Messaging

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

Stability: development

const Messaging('messaging.kafka.message.tombstone')
messagingKafkaOffset → const Messaging

The offset of a record in the corresponding Kafka partition.

Examples: 42

Stability: development

const Messaging('messaging.kafka.offset')
messagingMessageBodySize → const Messaging

The size of the message body in bytes.

Examples: 1439

Stability: development

const Messaging('messaging.message.body.size')
messagingMessageConversationId → const Messaging

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

Examples: MyConversationId

Stability: development

const Messaging('messaging.message.conversation_id')
messagingMessageEnvelopeSize → const Messaging

The size of the message body and metadata in bytes.

Examples: 2738

Stability: development

const Messaging('messaging.message.envelope.size')
messagingMessageId → const Messaging

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

Examples: 452a7c7c7c7048c2f887f61572b18fc2

Stability: development

const Messaging('messaging.message.id')
messagingOperation → const Messaging

Deprecated, use messaging.operation.type instead.

Examples: publish, create, process

Stability: development

const Messaging('messaging.operation')
messagingOperationName → const Messaging

The system-specific name of the messaging operation.

Examples: ack, nack, send

Stability: development

const Messaging('messaging.operation.name')
messagingOperationType → const Messaging

A string identifying the type of the messaging operation.

Stability: development

const Messaging('messaging.operation.type')
messagingRabbitmqDestinationRoutingKey → const Messaging

RabbitMQ message routing key.

Examples: myKey

Stability: development

const Messaging('messaging.rabbitmq.destination.routing_key')
messagingRabbitmqMessageDeliveryTag → const Messaging

RabbitMQ message delivery tag

Examples: 123

Stability: development

const Messaging('messaging.rabbitmq.message.delivery_tag')
messagingRocketmqClientGroup → const Messaging

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

Examples: myConsumerGroup

Stability: development

const Messaging('messaging.rocketmq.client_group')
messagingRocketmqConsumptionModel → const Messaging

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

Stability: development

const Messaging('messaging.rocketmq.consumption_model')
messagingRocketmqMessageDelayTimeLevel → const Messaging

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

Examples: 3

Stability: development

const Messaging('messaging.rocketmq.message.delay_time_level')
messagingRocketmqMessageDeliveryTimestamp → const Messaging

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

Examples: 1665987217045

Stability: development

const Messaging('messaging.rocketmq.message.delivery_timestamp')
messagingRocketmqMessageGroup → const Messaging

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: myMessageGroup

Stability: development

const Messaging('messaging.rocketmq.message.group')
messagingRocketmqMessageKeys → const Messaging

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

Examples: ["keyA", "keyB"]

Stability: development

const Messaging('messaging.rocketmq.message.keys')
messagingRocketmqMessageTag → const Messaging

The secondary classifier of message besides topic.

Examples: tagA

Stability: development

const Messaging('messaging.rocketmq.message.tag')
messagingRocketmqMessageType → const Messaging

Type of message.

Stability: development

const Messaging('messaging.rocketmq.message.type')
messagingRocketmqNamespace → const Messaging

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

Examples: myNamespace

Stability: development

const Messaging('messaging.rocketmq.namespace')
messagingServicebusDestinationSubscriptionName → const Messaging

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

Examples: subscription-a

Stability: development

const Messaging('messaging.servicebus.destination.subscription_name')
messagingServicebusDispositionStatus → const Messaging

Describes the settlement type .

Stability: development

const Messaging('messaging.servicebus.disposition_status')
messagingServicebusMessageDeliveryCount → const Messaging

Number of deliveries that have been attempted for this message.

Examples: 2

Stability: development

const Messaging('messaging.servicebus.message.delivery_count')
messagingServicebusMessageEnqueuedTime → const Messaging

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

Examples: 1701393730

Stability: development

const Messaging('messaging.servicebus.message.enqueued_time')
messagingSystem → const Messaging

The messaging system as identified by the client instrumentation.

Stability: development

const Messaging('messaging.system')

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
key → String
The attribute key string as defined in the OpenTelemetry specification.
final
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMapEntry(Object value) → MapEntry<String, Object>

Available on OTelSemantic, provided by the OTelSemanticExtension extension

Converts this semantic attribute and its value to a MapEntry.
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<Messaging>
A constant List of the values in this enum, in order of their declaration.