OpenTelemetry PHP

MessagingIncubatingAttributes

Semantic attributes and corresponding values for messaging.

Tags
see
https://opentelemetry.io/docs/specs/semconv/registry/attributes/messaging/

May contain @experimental Semantic Conventions which may change or be removed in the future.

Table of Contents

Constants

MESSAGING_BATCH_MESSAGE_COUNT  : mixed = 'messaging.batch.message_count'
The number of messages sent, received, or processed in the scope of the batching operation.
MESSAGING_CLIENT_ID  : mixed = 'messaging.client.id'
A unique identifier for the client that consumes or produces a message.
MESSAGING_CONSUMER_GROUP_NAME  : mixed = 'messaging.consumer.group.name'
The name of the consumer group with which a consumer is associated.
MESSAGING_DESTINATION_ANONYMOUS  : mixed = 'messaging.destination.anonymous'
A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name).
MESSAGING_DESTINATION_NAME  : mixed = 'messaging.destination.name'
The message destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If the broker doesn't have such notion, it SHOULD uniquely identify the broker.
MESSAGING_DESTINATION_PARTITION_ID  : mixed = 'messaging.destination.partition.id'
The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`.
MESSAGING_DESTINATION_SUBSCRIPTION_NAME  : mixed = 'messaging.destination.subscription.name'
The name of the destination subscription from which a message is consumed.
MESSAGING_DESTINATION_TEMPLATE  : mixed = 'messaging.destination.template'
Low cardinality representation of the messaging destination name Destination names could be constructed from templates. An example would be a destination name involving a username 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.
MESSAGING_DESTINATION_TEMPORARY  : mixed = 'messaging.destination.temporary'
A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed.
MESSAGING_MESSAGE_BODY_SIZE  : mixed = 'messaging.message.body.size'
The size of the message body in bytes.
MESSAGING_MESSAGE_CONVERSATION_ID  : mixed = 'messaging.message.conversation_id'
The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID".
MESSAGING_MESSAGE_ENVELOPE_SIZE  : mixed = 'messaging.message.envelope.size'
The size of the message body and metadata in bytes.
MESSAGING_MESSAGE_ID  : mixed = 'messaging.message.id'
A value used by the messaging system as an identifier for the message, represented as a string.
MESSAGING_OPERATION_NAME  : mixed = 'messaging.operation.name'
The system-specific name of the messaging operation.
MESSAGING_OPERATION_TYPE  : mixed = 'messaging.operation.type'
A string identifying the type of the messaging operation.
MESSAGING_OPERATION_TYPE_VALUE_CREATE  : mixed = '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 sending scenarios.
MESSAGING_OPERATION_TYPE_VALUE_PROCESS  : mixed = 'process'
One or more messages are processed by a consumer.
MESSAGING_OPERATION_TYPE_VALUE_RECEIVE  : mixed = '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.
MESSAGING_OPERATION_TYPE_VALUE_SEND  : mixed = 'send'
One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created.
MESSAGING_OPERATION_TYPE_VALUE_SETTLE  : mixed = 'settle'
One or more messages are settled.
MESSAGING_SYSTEM_NAME  : mixed = 'messaging.system.name'
The messaging system as identified by the client instrumentation.
MESSAGING_SYSTEM_NAME_VALUE_ACTIVEMQ  : mixed = 'activemq'
Apache ActiveMQ
MESSAGING_SYSTEM_NAME_VALUE_AWS_SNS  : mixed = 'aws.sns'
Amazon Simple Notification Service (SNS)
MESSAGING_SYSTEM_NAME_VALUE_AWS_SQS  : mixed = 'aws.sqs'
Amazon Simple Queue Service (SQS)
MESSAGING_SYSTEM_NAME_VALUE_AZURE_EVENTGRID  : mixed = 'azure.eventgrid'
Azure Event Grid
MESSAGING_SYSTEM_NAME_VALUE_AZURE_EVENTHUBS  : mixed = 'azure.eventhubs'
Azure Event Hubs
MESSAGING_SYSTEM_NAME_VALUE_AZURE_SERVICEBUS  : mixed = 'azure.servicebus'
Azure Service Bus
MESSAGING_SYSTEM_NAME_VALUE_GCP_PUBSUB  : mixed = 'gcp.pubsub'
Google Cloud Pub/Sub
MESSAGING_SYSTEM_NAME_VALUE_JMS  : mixed = 'jms'
Java Message Service
MESSAGING_SYSTEM_NAME_VALUE_KAFKA  : mixed = 'kafka'
Apache Kafka
MESSAGING_SYSTEM_NAME_VALUE_PULSAR  : mixed = 'pulsar'
Apache Pulsar
MESSAGING_SYSTEM_NAME_VALUE_RABBITMQ  : mixed = 'rabbitmq'
RabbitMQ
MESSAGING_SYSTEM_NAME_VALUE_ROCKETMQ  : mixed = 'rocketmq'
Apache RocketMQ

Constants

MESSAGING_BATCH_MESSAGE_COUNT

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

public mixed MESSAGING_BATCH_MESSAGE_COUNT = 'messaging.batch.message_count'

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.

Tags
experimental

MESSAGING_CLIENT_ID

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

public mixed MESSAGING_CLIENT_ID = 'messaging.client.id'
Tags
experimental

MESSAGING_CONSUMER_GROUP_NAME

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

public mixed MESSAGING_CONSUMER_GROUP_NAME = 'messaging.consumer.group.name'

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.

Tags
experimental

MESSAGING_DESTINATION_ANONYMOUS

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

public mixed MESSAGING_DESTINATION_ANONYMOUS = 'messaging.destination.anonymous'
Tags
experimental

MESSAGING_DESTINATION_NAME

The message destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If the broker doesn't have such notion, it SHOULD uniquely identify the broker.

public mixed MESSAGING_DESTINATION_NAME = 'messaging.destination.name'
Tags
experimental

MESSAGING_DESTINATION_PARTITION_ID

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

public mixed MESSAGING_DESTINATION_PARTITION_ID = 'messaging.destination.partition.id'
Tags
experimental

MESSAGING_DESTINATION_SUBSCRIPTION_NAME

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

public mixed MESSAGING_DESTINATION_SUBSCRIPTION_NAME = 'messaging.destination.subscription.name'

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.

Tags
experimental

MESSAGING_DESTINATION_TEMPLATE

Low cardinality representation of the messaging destination name Destination names could be constructed from templates. An example would be a destination name involving a username 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.

public mixed MESSAGING_DESTINATION_TEMPLATE = 'messaging.destination.template'
Tags
experimental

MESSAGING_DESTINATION_TEMPORARY

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

public mixed MESSAGING_DESTINATION_TEMPORARY = 'messaging.destination.temporary'
Tags
experimental

MESSAGING_MESSAGE_BODY_SIZE

The size of the message body in bytes.

public mixed MESSAGING_MESSAGE_BODY_SIZE = 'messaging.message.body.size'

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

Tags
experimental

MESSAGING_MESSAGE_CONVERSATION_ID

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

public mixed MESSAGING_MESSAGE_CONVERSATION_ID = 'messaging.message.conversation_id'
Tags
experimental

MESSAGING_MESSAGE_ENVELOPE_SIZE

The size of the message body and metadata in bytes.

public mixed MESSAGING_MESSAGE_ENVELOPE_SIZE = 'messaging.message.envelope.size'

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

Tags
experimental

MESSAGING_MESSAGE_ID

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

public mixed MESSAGING_MESSAGE_ID = 'messaging.message.id'
Tags
experimental

MESSAGING_OPERATION_NAME

The system-specific name of the messaging operation.

public mixed MESSAGING_OPERATION_NAME = 'messaging.operation.name'
Tags
experimental

MESSAGING_OPERATION_TYPE

A string identifying the type of the messaging operation.

public mixed MESSAGING_OPERATION_TYPE = 'messaging.operation.type'

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

Tags
experimental

MESSAGING_OPERATION_TYPE_VALUE_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 sending scenarios.

public mixed MESSAGING_OPERATION_TYPE_VALUE_CREATE = 'create'
Tags
experimental

MESSAGING_OPERATION_TYPE_VALUE_PROCESS

One or more messages are processed by a consumer.

public mixed MESSAGING_OPERATION_TYPE_VALUE_PROCESS = 'process'
Tags
experimental

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

public mixed MESSAGING_OPERATION_TYPE_VALUE_RECEIVE = 'receive'
Tags
experimental

MESSAGING_OPERATION_TYPE_VALUE_SEND

One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created.

public mixed MESSAGING_OPERATION_TYPE_VALUE_SEND = 'send'
Tags
experimental

MESSAGING_OPERATION_TYPE_VALUE_SETTLE

One or more messages are settled.

public mixed MESSAGING_OPERATION_TYPE_VALUE_SETTLE = 'settle'
Tags
experimental

MESSAGING_SYSTEM_NAME

The messaging system as identified by the client instrumentation.

public mixed MESSAGING_SYSTEM_NAME = 'messaging.system.name'

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.name is set to kafka based on the instrumentation's best knowledge.

Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_ACTIVEMQ

Apache ActiveMQ

public mixed MESSAGING_SYSTEM_NAME_VALUE_ACTIVEMQ = 'activemq'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_AWS_SNS

Amazon Simple Notification Service (SNS)

public mixed MESSAGING_SYSTEM_NAME_VALUE_AWS_SNS = 'aws.sns'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_AWS_SQS

Amazon Simple Queue Service (SQS)

public mixed MESSAGING_SYSTEM_NAME_VALUE_AWS_SQS = 'aws.sqs'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_AZURE_EVENTGRID

Azure Event Grid

public mixed MESSAGING_SYSTEM_NAME_VALUE_AZURE_EVENTGRID = 'azure.eventgrid'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_AZURE_EVENTHUBS

Azure Event Hubs

public mixed MESSAGING_SYSTEM_NAME_VALUE_AZURE_EVENTHUBS = 'azure.eventhubs'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_AZURE_SERVICEBUS

Azure Service Bus

public mixed MESSAGING_SYSTEM_NAME_VALUE_AZURE_SERVICEBUS = 'azure.servicebus'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_GCP_PUBSUB

Google Cloud Pub/Sub

public mixed MESSAGING_SYSTEM_NAME_VALUE_GCP_PUBSUB = 'gcp.pubsub'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_JMS

Java Message Service

public mixed MESSAGING_SYSTEM_NAME_VALUE_JMS = 'jms'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_PULSAR

Apache Pulsar

public mixed MESSAGING_SYSTEM_NAME_VALUE_PULSAR = 'pulsar'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_RABBITMQ

RabbitMQ

public mixed MESSAGING_SYSTEM_NAME_VALUE_RABBITMQ = 'rabbitmq'
Tags
experimental

MESSAGING_SYSTEM_NAME_VALUE_ROCKETMQ

Apache RocketMQ

public mixed MESSAGING_SYSTEM_NAME_VALUE_ROCKETMQ = 'rocketmq'
Tags
experimental
On this page

Search results