# Semantic conventions for Google Cloud Pub/Sub Site [llms.txt](/llms.txt) --- **Status**: [Development][DocumentStatus] - [Google Cloud Pub/Sub spans](#google-cloud-pubsub-spans) - [Create span](#create-span) - [Send span (producer)](#send-span-producer) - [Send span (client)](#send-span-client) - [Receive span](#receive-span) - [Process span](#process-span) - [Settle span](#settle-span) - [Examples](#examples) - [Asynchronous batch publish example](#asynchronous-batch-publish-example) - [Unary pull example](#unary-pull-example) The Semantic Conventions for [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) extend and override the [Messaging Semantic Conventions](README.md). > [!IMPORTANT] > > Existing messaging instrumentations that are using > [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/messaging/messaging-spans.md) > (or prior): > > * SHOULD NOT change the version of the messaging conventions that they emit by default > until the messaging semantic conventions are marked stable. > Conventions include, but are not limited to, attributes, > metric and span names, span kind and unit of measure. > * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` > in the existing major version as a comma-separated list of category-specific values > (e.g., http, databases, messaging). The list of values includes: > * `messaging` - emit the new, stable messaging conventions, > and stop emitting the old experimental messaging conventions > that the instrumentation emitted previously. > * `messaging/dup` - emit both the old and the stable messaging conventions, > allowing for a seamless transition. > * The default behavior (in the absence of one of these values) is to continue > emitting whatever version of the old experimental messaging conventions > the instrumentation was emitting previously. > * Note: `messaging/dup` has higher precedence than `messaging` in case both values are present > * SHOULD maintain (security patching at a minimum) the existing major version > for at least six months after it starts emitting both sets of conventions. > * SHOULD drop the environment variable in the next major version. > * SHOULD emit the new, stable values for span name, span kind and similar "single" > valued concepts when `messaging/dup` is present in the list. ## Google Cloud Pub/Sub spans ### Create span **Status:** ![Development](https://img.shields.io/badge/-development-blue) Describes a message being created for publishing to Google Cloud Pub/Sub. "Create" spans always refer to a single message and are used to provide a unique creation context for messages in batch sending scenarios. A "Create" span is only used together with a client "Send" span (`messaging.send.client`) that links to it; when the "Send" span itself serves as the creation context, use the producer "Send" span (`messaging.send.producer`) instead and omit the "Create" span. See [Producer spans](/docs/specs/semconv/messaging/messaging-spans.md#producer-spans) for details. **Span kind** SHOULD be `PRODUCER`. **Span status** SHOULD follow the [Recording Errors](/docs/specs/semconv/general/recording-errors.md) document. **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The system-specific name of the messaging operation. [1] | `create` | | [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The messaging system as identified by the client instrumentation. [2] | `gcp_pubsub` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | `NOT_FOUND`; `RESOURCE_EXHAUSTED`; `UNAVAILABLE` | | [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [4] | string | The message destination name [5] | `MyTopic` | | [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [6] | string | Low cardinality representation of the messaging destination name [7] | `/customers/{customerId}` | | [`messaging.gcp_pubsub.message.ordering_key`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If the message type has an ordering key set. | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | | [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | A string identifying the type of the messaging operation. [8] | `create` | | [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | | [`messaging.message.conversation_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | | [`messaging.message.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | | [`server.address`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [9] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`server.port`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | Server port number. [10] | `80`; `8080`; `443` | | [`messaging.message.body.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [11] | `1439` | | [`messaging.message.envelope.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body and metadata in bytes. [12] | `2738` | **[1] `messaging.operation.name`:** SHOULD be set to `create`. **[2] `messaging.system`:** MUST be set to `"gcp_pubsub"`. **[3] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality. When `error.type` is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used. If the recorded error type is a wrapper that is not meaningful for failure classification, instrumentation MAY use the type of the inner error instead. For example, in Go, errors created with `fmt.Errorf` using `%w` MAY be unwrapped when the wrapper type does not help classify the failure. Instrumentations SHOULD document the list of errors they report. The cardinality of `error.type` within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for `error.type` to have high cardinality at query time when no additional filters are applied. If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it's RECOMMENDED to: - Use a domain-specific attribute - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. **[4] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. **[5] `messaging.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. **[6] `messaging.destination.template`:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed. **[7] `messaging.destination.template`:** 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. **[8] `messaging.operation.type`:** SHOULD be set to `create`. **[9] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. **[10] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. **[11] `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. **[12] `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. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) * [`server.address`](/docs/specs/semconv/registry/attributes/server.md) * [`server.port`](/docs/specs/semconv/registry/attributes/server.md) --- `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | --- `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `process` | One or more messages are processed by a consumer. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) | --- `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `activemq` | Apache ActiveMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.sns` | Amazon Simple Notification Service (SNS) | ![Development](https://img.shields.io/badge/-development-blue) | | `aws_sqs` | Amazon Simple Queue Service (SQS) | ![Development](https://img.shields.io/badge/-development-blue) | | `eventgrid` | Azure Event Grid | ![Development](https://img.shields.io/badge/-development-blue) | | `eventhubs` | Azure Event Hubs | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp_pubsub` | Google Cloud Pub/Sub | ![Development](https://img.shields.io/badge/-development-blue) | | `jms` | Java Message Service | ![Development](https://img.shields.io/badge/-development-blue) | | `kafka` | Apache Kafka | ![Development](https://img.shields.io/badge/-development-blue) | | `pulsar` | Apache Pulsar | ![Development](https://img.shields.io/badge/-development-blue) | | `rabbitmq` | RabbitMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | ### Send span (producer) **Status:** ![Development](https://img.shields.io/badge/-development-blue) Describes a producer publishing one or more messages to Google Cloud Pub/Sub. Use this span when no separate "Create" span exists and the "Send" span's context is injected into the message(s) as the creation context. See [Producer spans](/docs/specs/semconv/messaging/messaging-spans.md#producer-spans) for details. **Span kind** SHOULD be `PRODUCER`. **Span status** SHOULD follow the [Recording Errors](/docs/specs/semconv/general/recording-errors.md) document. **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The system-specific name of the messaging operation. [1] | `send` | | [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The messaging system as identified by the client instrumentation. [2] | `gcp_pubsub` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | `NOT_FOUND`; `RESOURCE_EXHAUSTED`; `UNAVAILABLE` | | [`messaging.batch.message_count`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | `0`; `1`; `2` | | [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [6] | string | The message destination name [7] | `MyTopic` | | [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [8] | string | Low cardinality representation of the messaging destination name [9] | `/customers/{customerId}` | | [`messaging.gcp_pubsub.message.ordering_key`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If the message type has an ordering key set. | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | | [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | A string identifying the type of the messaging operation. [10] | `send` | | [`messaging.client.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | | [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | | [`messaging.message.conversation_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | | [`messaging.message.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | | [`network.peer.address`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` If applicable for this messaging system. | string | Peer address of the messaging intermediary node where the operation was performed. [11] | `10.1.2.80`; `/tmp/my.sock` | | [`network.peer.port`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` if and only if `network.peer.address` is set. | int | Peer port of the messaging intermediary node where the operation was performed. | `65123` | | [`server.address`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [12] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`server.port`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | Server port number. [13] | `80`; `8080`; `443` | | [`messaging.message.body.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [14] | `1439` | | [`messaging.message.envelope.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body and metadata in bytes. [15] | `2738` | **[1] `messaging.operation.name`:** SHOULD be set to `send`. **[2] `messaging.system`:** MUST be set to `"gcp_pubsub"`. **[3] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality. When `error.type` is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used. If the recorded error type is a wrapper that is not meaningful for failure classification, instrumentation MAY use the type of the inner error instead. For example, in Go, errors created with `fmt.Errorf` using `%w` MAY be unwrapped when the wrapper type does not help classify the failure. Instrumentations SHOULD document the list of errors they report. The cardinality of `error.type` within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for `error.type` to have high cardinality at query time when no additional filters are applied. If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it's RECOMMENDED to: - Use a domain-specific attribute - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. **[5] `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. **[6] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. **[7] `messaging.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. **[8] `messaging.destination.template`:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed. **[9] `messaging.destination.template`:** 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. **[10] `messaging.operation.type`:** SHOULD be set to `send`. **[11] `network.peer.address`:** Semantic conventions for individual messaging systems SHOULD document whether `network.peer.*` attributes are applicable. Network peer address and port are important when the application interacts with individual intermediary nodes directly, If a messaging operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used. **[12] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. **[13] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. **[14] `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. **[15] `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. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) * [`server.address`](/docs/specs/semconv/registry/attributes/server.md) * [`server.port`](/docs/specs/semconv/registry/attributes/server.md) --- `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | --- `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `process` | One or more messages are processed by a consumer. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) | --- `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `activemq` | Apache ActiveMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.sns` | Amazon Simple Notification Service (SNS) | ![Development](https://img.shields.io/badge/-development-blue) | | `aws_sqs` | Amazon Simple Queue Service (SQS) | ![Development](https://img.shields.io/badge/-development-blue) | | `eventgrid` | Azure Event Grid | ![Development](https://img.shields.io/badge/-development-blue) | | `eventhubs` | Azure Event Hubs | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp_pubsub` | Google Cloud Pub/Sub | ![Development](https://img.shields.io/badge/-development-blue) | | `jms` | Java Message Service | ![Development](https://img.shields.io/badge/-development-blue) | | `kafka` | Apache Kafka | ![Development](https://img.shields.io/badge/-development-blue) | | `pulsar` | Apache Pulsar | ![Development](https://img.shields.io/badge/-development-blue) | | `rabbitmq` | RabbitMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | ### Send span (client) **Status:** ![Development](https://img.shields.io/badge/-development-blue) Describes a producer publishing one or more messages to Google Cloud Pub/Sub. Use this span when a "Create" span (or a custom creation context) already exists for the message(s): the "Send" span describes only the transport operation and links to the creation context that was injected into the message. See [Producer spans](/docs/specs/semconv/messaging/messaging-spans.md#producer-spans) for details. **Span kind** SHOULD be `CLIENT`. **Span status** SHOULD follow the [Recording Errors](/docs/specs/semconv/general/recording-errors.md) document. **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The system-specific name of the messaging operation. [1] | `send` | | [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The messaging system as identified by the client instrumentation. [2] | `gcp_pubsub` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | `NOT_FOUND`; `RESOURCE_EXHAUSTED`; `UNAVAILABLE` | | [`messaging.batch.message_count`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | `0`; `1`; `2` | | [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [6] | string | The message destination name [7] | `MyTopic` | | [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [8] | string | Low cardinality representation of the messaging destination name [9] | `/customers/{customerId}` | | [`messaging.gcp_pubsub.message.ordering_key`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If the message type has an ordering key set. | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | | [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | A string identifying the type of the messaging operation. [10] | `send` | | [`messaging.client.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | | [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | | [`messaging.message.conversation_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | | [`messaging.message.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | | [`network.peer.address`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` If applicable for this messaging system. | string | Peer address of the messaging intermediary node where the operation was performed. [11] | `10.1.2.80`; `/tmp/my.sock` | | [`network.peer.port`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` if and only if `network.peer.address` is set. | int | Peer port of the messaging intermediary node where the operation was performed. | `65123` | | [`server.address`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [12] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`server.port`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | Server port number. [13] | `80`; `8080`; `443` | | [`messaging.message.body.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [14] | `1439` | | [`messaging.message.envelope.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body and metadata in bytes. [15] | `2738` | **[1] `messaging.operation.name`:** SHOULD be set to `send`. **[2] `messaging.system`:** MUST be set to `"gcp_pubsub"`. **[3] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality. When `error.type` is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used. If the recorded error type is a wrapper that is not meaningful for failure classification, instrumentation MAY use the type of the inner error instead. For example, in Go, errors created with `fmt.Errorf` using `%w` MAY be unwrapped when the wrapper type does not help classify the failure. Instrumentations SHOULD document the list of errors they report. The cardinality of `error.type` within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for `error.type` to have high cardinality at query time when no additional filters are applied. If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it's RECOMMENDED to: - Use a domain-specific attribute - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. **[5] `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. **[6] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. **[7] `messaging.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. **[8] `messaging.destination.template`:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed. **[9] `messaging.destination.template`:** 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. **[10] `messaging.operation.type`:** SHOULD be set to `send`. **[11] `network.peer.address`:** Semantic conventions for individual messaging systems SHOULD document whether `network.peer.*` attributes are applicable. Network peer address and port are important when the application interacts with individual intermediary nodes directly, If a messaging operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used. **[12] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. **[13] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. **[14] `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. **[15] `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. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) * [`server.address`](/docs/specs/semconv/registry/attributes/server.md) * [`server.port`](/docs/specs/semconv/registry/attributes/server.md) --- `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | --- `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `process` | One or more messages are processed by a consumer. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) | --- `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `activemq` | Apache ActiveMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.sns` | Amazon Simple Notification Service (SNS) | ![Development](https://img.shields.io/badge/-development-blue) | | `aws_sqs` | Amazon Simple Queue Service (SQS) | ![Development](https://img.shields.io/badge/-development-blue) | | `eventgrid` | Azure Event Grid | ![Development](https://img.shields.io/badge/-development-blue) | | `eventhubs` | Azure Event Hubs | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp_pubsub` | Google Cloud Pub/Sub | ![Development](https://img.shields.io/badge/-development-blue) | | `jms` | Java Message Service | ![Development](https://img.shields.io/badge/-development-blue) | | `kafka` | Apache Kafka | ![Development](https://img.shields.io/badge/-development-blue) | | `pulsar` | Apache Pulsar | ![Development](https://img.shields.io/badge/-development-blue) | | `rabbitmq` | RabbitMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | ### Receive span **Status:** ![Development](https://img.shields.io/badge/-development-blue) Describes a consumer receiving one or more messages from Google Cloud Pub/Sub (pull-based). "Receive" spans are created for pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. See [Consumer spans](/docs/specs/semconv/messaging/messaging-spans.md#consumer-spans) for details. **Span kind** SHOULD be `CLIENT`. **Span status** SHOULD follow the [Recording Errors](/docs/specs/semconv/general/recording-errors.md) document. **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The system-specific name of the messaging operation. [1] | `receive` | | [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The messaging system as identified by the client instrumentation. [2] | `gcp_pubsub` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | `NOT_FOUND`; `RESOURCE_EXHAUSTED`; `UNAVAILABLE` | | [`messaging.batch.message_count`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | `0`; `1`; `2` | | [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [6] | string | The message destination name [7] | `MyTopic` | | [`messaging.destination.subscription.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | Google Pub/Sub [subscription name](https://cloud.google.com/pubsub/docs/subscription-overview). | `subscription-a` | | [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [8] | string | Low cardinality representation of the messaging destination name [9] | `/customers/{customerId}` | | [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | A string identifying the type of the messaging operation. [10] | `receive` | | [`messaging.client.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | | [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | | [`messaging.gcp_pubsub.message.ack_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The ack ID for a given message. | `ack_id` | | [`messaging.gcp_pubsub.message.delivery_attempt`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The delivery attempt for a given message. | `2` | | [`messaging.message.conversation_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | | [`messaging.message.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | | [`network.peer.address`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` If applicable for this messaging system. | string | Peer address of the messaging intermediary node where the operation was performed. [11] | `10.1.2.80`; `/tmp/my.sock` | | [`network.peer.port`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` if and only if `network.peer.address` is set. | int | Peer port of the messaging intermediary node where the operation was performed. | `65123` | | [`server.address`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [12] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`server.port`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | Server port number. [13] | `80`; `8080`; `443` | | [`messaging.message.body.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [14] | `1439` | | [`messaging.message.envelope.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body and metadata in bytes. [15] | `2738` | **[1] `messaging.operation.name`:** SHOULD be set to `receive`. **[2] `messaging.system`:** MUST be set to `"gcp_pubsub"`. **[3] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality. When `error.type` is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used. If the recorded error type is a wrapper that is not meaningful for failure classification, instrumentation MAY use the type of the inner error instead. For example, in Go, errors created with `fmt.Errorf` using `%w` MAY be unwrapped when the wrapper type does not help classify the failure. Instrumentations SHOULD document the list of errors they report. The cardinality of `error.type` within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for `error.type` to have high cardinality at query time when no additional filters are applied. If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it's RECOMMENDED to: - Use a domain-specific attribute - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. **[5] `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. **[6] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. **[7] `messaging.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. **[8] `messaging.destination.template`:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed. **[9] `messaging.destination.template`:** 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. **[10] `messaging.operation.type`:** SHOULD be set to `receive`. **[11] `network.peer.address`:** Semantic conventions for individual messaging systems SHOULD document whether `network.peer.*` attributes are applicable. Network peer address and port are important when the application interacts with individual intermediary nodes directly, If a messaging operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used. **[12] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. **[13] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. **[14] `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. **[15] `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. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.subscription.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) * [`server.address`](/docs/specs/semconv/registry/attributes/server.md) * [`server.port`](/docs/specs/semconv/registry/attributes/server.md) --- `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | --- `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `process` | One or more messages are processed by a consumer. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) | --- `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `activemq` | Apache ActiveMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.sns` | Amazon Simple Notification Service (SNS) | ![Development](https://img.shields.io/badge/-development-blue) | | `aws_sqs` | Amazon Simple Queue Service (SQS) | ![Development](https://img.shields.io/badge/-development-blue) | | `eventgrid` | Azure Event Grid | ![Development](https://img.shields.io/badge/-development-blue) | | `eventhubs` | Azure Event Hubs | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp_pubsub` | Google Cloud Pub/Sub | ![Development](https://img.shields.io/badge/-development-blue) | | `jms` | Java Message Service | ![Development](https://img.shields.io/badge/-development-blue) | | `kafka` | Apache Kafka | ![Development](https://img.shields.io/badge/-development-blue) | | `pulsar` | Apache Pulsar | ![Development](https://img.shields.io/badge/-development-blue) | | `rabbitmq` | RabbitMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | ### Process span **Status:** ![Development](https://img.shields.io/badge/-development-blue) Describes a consumer processing one or more messages from Google Cloud Pub/Sub (push-based). "Process" spans are created for push-based scenarios, where messages are passed to the application through a callback or handler. See [Consumer spans](/docs/specs/semconv/messaging/messaging-spans.md#consumer-spans) for details. Exclusively for single-message scenarios, when the message creation context is used as the parent, see [Message creation context as parent of "Process" span](/docs/specs/semconv/messaging/messaging-spans.md#message-creation-context-as-parent-of-process-span). **Span kind** SHOULD be `CONSUMER`. **Span status** SHOULD follow the [Recording Errors](/docs/specs/semconv/general/recording-errors.md) document. **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The system-specific name of the messaging operation. [1] | `subscribe` | | [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The messaging system as identified by the client instrumentation. [2] | `gcp_pubsub` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | `NOT_FOUND`; `RESOURCE_EXHAUSTED`; `UNAVAILABLE` | | [`messaging.batch.message_count`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | `0`; `1`; `2` | | [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [6] | string | The message destination name [7] | `MyTopic` | | [`messaging.destination.subscription.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | Google Pub/Sub [subscription name](https://cloud.google.com/pubsub/docs/subscription-overview). | `subscription-a` | | [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [8] | string | Low cardinality representation of the messaging destination name [9] | `/customers/{customerId}` | | [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | A string identifying the type of the messaging operation. [10] | `process` | | [`messaging.client.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | | [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | | [`messaging.gcp_pubsub.message.ack_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The ack ID for a given message. | `ack_id` | | [`messaging.gcp_pubsub.message.delivery_attempt`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The delivery attempt for a given message. | `2` | | [`messaging.message.conversation_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | | [`messaging.message.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | | [`server.address`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [11] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`server.port`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | Server port number. [12] | `80`; `8080`; `443` | | [`messaging.message.body.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body in bytes. Only applicable for spans describing single message operations. [13] | `1439` | | [`messaging.message.envelope.size`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | int | The size of the message body and metadata in bytes. [14] | `2738` | **[1] `messaging.operation.name`:** SHOULD be set to `subscribe`, representing the time from after the message was received to when it is acknowledged, negatively acknowledged, or expired. **[2] `messaging.system`:** MUST be set to `"gcp_pubsub"`. **[3] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality. When `error.type` is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used. If the recorded error type is a wrapper that is not meaningful for failure classification, instrumentation MAY use the type of the inner error instead. For example, in Go, errors created with `fmt.Errorf` using `%w` MAY be unwrapped when the wrapper type does not help classify the failure. Instrumentations SHOULD document the list of errors they report. The cardinality of `error.type` within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for `error.type` to have high cardinality at query time when no additional filters are applied. If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it's RECOMMENDED to: - Use a domain-specific attribute - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. **[5] `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. **[6] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. **[7] `messaging.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. **[8] `messaging.destination.template`:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed. **[9] `messaging.destination.template`:** 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. **[10] `messaging.operation.type`:** SHOULD be set to `process`. **[11] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. **[12] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. **[13] `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. **[14] `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. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.subscription.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) * [`server.address`](/docs/specs/semconv/registry/attributes/server.md) * [`server.port`](/docs/specs/semconv/registry/attributes/server.md) --- `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | --- `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `process` | One or more messages are processed by a consumer. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) | --- `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `activemq` | Apache ActiveMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.sns` | Amazon Simple Notification Service (SNS) | ![Development](https://img.shields.io/badge/-development-blue) | | `aws_sqs` | Amazon Simple Queue Service (SQS) | ![Development](https://img.shields.io/badge/-development-blue) | | `eventgrid` | Azure Event Grid | ![Development](https://img.shields.io/badge/-development-blue) | | `eventhubs` | Azure Event Hubs | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp_pubsub` | Google Cloud Pub/Sub | ![Development](https://img.shields.io/badge/-development-blue) | | `jms` | Java Message Service | ![Development](https://img.shields.io/badge/-development-blue) | | `kafka` | Apache Kafka | ![Development](https://img.shields.io/badge/-development-blue) | | `pulsar` | Apache Pulsar | ![Development](https://img.shields.io/badge/-development-blue) | | `rabbitmq` | RabbitMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | ### Settle span **Status:** ![Development](https://img.shields.io/badge/-development-blue) Describes settling (ack/nack/modack) one or more Google Cloud Pub/Sub messages. "Settle" spans are created for every manually or automatically triggered settlement operation. See [Consumer spans](/docs/specs/semconv/messaging/messaging-spans.md#consumer-spans) for details. **Span kind** SHOULD be `CLIENT`. **Span status** SHOULD follow the [Recording Errors](/docs/specs/semconv/general/recording-errors.md) document. **Attributes:** | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | | [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The system-specific name of the messaging operation. [1] | `ack`; `nack`; `modack` | | [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The messaging system as identified by the client instrumentation. [2] | `gcp_pubsub` | | [`error.type`](/docs/specs/semconv/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the messaging operation has failed. | string | Describes a class of error the operation ended with. [3] | `NOT_FOUND`; `RESOURCE_EXHAUSTED`; `UNAVAILABLE` | | [`messaging.batch.message_count`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [4] | int | The number of messages sent, received, or processed in the scope of the batching operation. [5] | `0`; `1`; `2` | | [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [6] | string | The message destination name [7] | `MyTopic` | | [`messaging.destination.subscription.name`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | Google Pub/Sub [subscription name](https://cloud.google.com/pubsub/docs/subscription-overview). | `subscription-a` | | [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` [8] | string | Low cardinality representation of the messaging destination name [9] | `/customers/{customerId}` | | [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Conditionally Required` If applicable. | string | A string identifying the type of the messaging operation. [10] | `settle` | | [`messaging.client.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | | [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` When applicable. | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | | [`messaging.gcp_pubsub.message.ack_deadline`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | | [`messaging.gcp_pubsub.message.ack_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The ack ID for a given message. | `ack_id` | | [`messaging.gcp_pubsub.message.delivery_attempt`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The delivery attempt for a given message. | `2` | | [`messaging.message.conversation_id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | | [`messaging.message.id`](/docs/specs/semconv/registry/attributes/messaging.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` If span describes operation on a single message. | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | | [`network.peer.address`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` If applicable for this messaging system. | string | Peer address of the messaging intermediary node where the operation was performed. [11] | `10.1.2.80`; `/tmp/my.sock` | | [`network.peer.port`](/docs/specs/semconv/registry/attributes/network.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` if and only if `network.peer.address` is set. | int | Peer port of the messaging intermediary node where the operation was performed. | `65123` | | [`server.address`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. [12] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | | [`server.port`](/docs/specs/semconv/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | Server port number. [13] | `80`; `8080`; `443` | **[1] `messaging.operation.name`:** Has the following well-known values for Google Cloud Pub/Sub settlement. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. - `ack` and `nack` for acknowledging or negatively acknowledging a message - `modack` for extending the lease for a single message or batch of messages **[2] `messaging.system`:** MUST be set to `"gcp_pubsub"`. **[3] `error.type`:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality. When `error.type` is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used. If the recorded error type is a wrapper that is not meaningful for failure classification, instrumentation MAY use the type of the inner error instead. For example, in Go, errors created with `fmt.Errorf` using `%w` MAY be unwrapped when the wrapper type does not help classify the failure. Instrumentations SHOULD document the list of errors they report. The cardinality of `error.type` within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for `error.type` to have high cardinality at query time when no additional filters are applied. If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. If a specific domain defines its own set of error identifiers (such as HTTP or RPC status codes), it's RECOMMENDED to: - Use a domain-specific attribute - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. **[5] `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. **[6] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. **[7] `messaging.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. **[8] `messaging.destination.template`:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed. **[9] `messaging.destination.template`:** 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. **[10] `messaging.operation.type`:** SHOULD be set to `settle`. **[11] `network.peer.address`:** Semantic conventions for individual messaging systems SHOULD document whether `network.peer.*` attributes are applicable. Network peer address and port are important when the application interacts with individual intermediary nodes directly, If a messaging operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used. **[12] `server.address`:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name. **[13] `server.port`:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. The following attributes can be important for making sampling decisions and SHOULD be provided **at span creation time** (if provided at all): * [`messaging.destination.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.partition.id`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.subscription.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.destination.template`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.name`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.operation.type`](/docs/specs/semconv/registry/attributes/messaging.md) * [`messaging.system`](/docs/specs/semconv/registry/attributes/messaging.md) * [`server.address`](/docs/specs/semconv/registry/attributes/server.md) * [`server.port`](/docs/specs/semconv/registry/attributes/server.md) --- `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | --- `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `process` | One or more messages are processed by a consumer. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `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. | ![Development](https://img.shields.io/badge/-development-blue) | | `settle` | One or more messages are settled. | ![Development](https://img.shields.io/badge/-development-blue) | --- `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | | --- | --- | --- | | `activemq` | Apache ActiveMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `aws.sns` | Amazon Simple Notification Service (SNS) | ![Development](https://img.shields.io/badge/-development-blue) | | `aws_sqs` | Amazon Simple Queue Service (SQS) | ![Development](https://img.shields.io/badge/-development-blue) | | `eventgrid` | Azure Event Grid | ![Development](https://img.shields.io/badge/-development-blue) | | `eventhubs` | Azure Event Hubs | ![Development](https://img.shields.io/badge/-development-blue) | | `gcp_pubsub` | Google Cloud Pub/Sub | ![Development](https://img.shields.io/badge/-development-blue) | | `jms` | Java Message Service | ![Development](https://img.shields.io/badge/-development-blue) | | `kafka` | Apache Kafka | ![Development](https://img.shields.io/badge/-development-blue) | | `pulsar` | Apache Pulsar | ![Development](https://img.shields.io/badge/-development-blue) | | `rabbitmq` | RabbitMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `rocketmq` | Apache RocketMQ | ![Development](https://img.shields.io/badge/-development-blue) | | `servicebus` | Azure Service Bus | ![Development](https://img.shields.io/badge/-development-blue) | ## Examples ### Asynchronous batch publish example Given is a process P that asynchronously publishes 2 messages in a batch to a topic T on Pub/Sub. ```mermaid flowchart LR; subgraph PRODUCER direction LR CA[Span Create A] CB[Span Create B] P[Span Send A B] end CA-. link .-P; CB-. link .-P; classDef producer fill:green class P,CA,CB producer classDef normal fill:green class PA,PB,D1 normal linkStyle 0,1 color:green,stroke:green ``` | Field or Attribute | Producer Span Create A | Producer Span Create B | Producer Span Send A B | | --- | --- | --- | --- | | Span name | `create T` | `create T` | `send T` | | Parent | | | | | Links | | | Span Create A, Span Create B | | SpanKind | `PRODUCER` | `PRODUCER` | `CLIENT` | | Status | `Ok` | `Ok` | `Ok` | | `messaging.batch.message_count` | | | 2 | | `messaging.destination.name` | `"T"` | `"T"` | `"T"` | | `messaging.operation.name` | `"create"` | `"create"` | `"send"` | | `messaging.operation.type` | `"create"` | `"create"` | `"send"` | | `messaging.message.id` | `"a1"` | `"a2"` | | | `messaging.message.envelope.size` | `1` | `1` | | | `messaging.system` | `"gcp_pubsub"` | `"gcp_pubsub"` | `"gcp_pubsub"` | ### Unary pull example ```mermaid flowchart TD; subgraph CONSUMER direction LR R1[Receive A] SM1[Ack A] EM1[Modack A] end subgraph PRODUCER direction LR CM1[Create A] PM1[Send] end %% Link 0 CM1-. link .-PM1; %% Link 1 CM1-. link .-R1; %% Link 2 R1-. link .-SM1; %% Link 3 R1-. link .-EM1; %% Style the node and corresponding link %% Producer links and nodes classDef producer fill:green class PM1,CM1 producer linkStyle 0 color:green,stroke:green %% Consumer links and nodes classDef consumer fill:#49fcdc class R1 consumer linkStyle 1 color:#49fcdc,stroke:#49fcdc classDef ack fill:#577eb5 class SM1 ack linkStyle 2 color:#577eb5,stroke:#577eb5 classDef modack fill:#0560f2 class EM1 modack linkStyle 3 color:#0560f2,stroke:#0560f2 ``` | Field or Attribute | Producer Span Create A | Producer Span Send | Consumer Span Receive A | Consumer Span Modack A | Consumer Span Ack A | | --- | --- | --- | --- | --- | --- | | Span name | `create T` | `send T` | `receive S` | `modack S` | `ack S` | | Parent | | | | | | | Links | | Span Create A | Span Create A | Span Receive A | Span Receive A | | SpanKind | `PRODUCER` | `CLIENT` | `CLIENT` | `CLIENT` | `CLIENT` | | Status | `Ok` | `Ok` | `Ok` | `Ok` | `Ok` | | `messaging.destination.name` | `"T"` | `"T"` | `"S"` | `"S"` | `"S"` | | `messaging.system` | `"gcp_pubsub"` | `"gcp_pubsub"` | `"gcp_pubsub"` | `"gcp_pubsub"` | `"gcp_pubsub"` | | `messaging.operation.name` | `"create"` | `"send"` | `"receive"` | `"modack"` | `"ack"` | | `messaging.operation.type` | `"create"` | `"send"` | `"receive"` | | `"settle"` | | `messaging.message.id` | `"a1"` | | `"a1"` | | | | `messaging.message.envelope.size` | `1` | `1` | `1` | | | | `messaging.gcp_pubsub.message.ack_id` | | | | `"ack_id1"` | `"ack_id1"` | | `messaging.gcp_pubsub.message.delivery_attempt` | | | | `0` | | | `messaging.gcp_pubsub.message.ack_deadline` | | | | | `0` | [DocumentStatus]: /docs/specs/otel/document-status