Revamp messaging metrics to support generic operations (#1006)
This commit is contained in:
Liudmila Molkova
GitHub
parent
3df6e56ca6
commit
cde003cd37
|
|
@ -0,0 +1,13 @@
|
|||
change_type: breaking
|
||||
|
||||
component: messaging
|
||||
|
||||
note: |
|
||||
Support generic operations in messaging and rename metrics:
|
||||
|
||||
- Make `messaging.operation.name` required and `messaging.operation.type` conditionally required when type is applicable.
|
||||
- Rename `messaging.publish.messages` metric to `messaging.client.published.messages`
|
||||
- Unify `messaging.publish.duration` and `messaging.receive.duration` metrics into `messaging.client.operation.duration`
|
||||
- Unify `messaging.receive.messages` and `messaging.process.messages` metrics into `messaging.client.consumed.messages`
|
||||
|
||||
issues: [1006, 947, 937]
|
||||
|
|
@ -60,13 +60,14 @@ size should be used.
|
|||
|
||||
`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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
| 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 publishing scenarios. |  |
|
||||
| `deliver` | Deprecated. Use `process` instead. | <br>Replaced by `process`. |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
||||
`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.
|
||||
|
||||
|
|
|
|||
|
|
@ -259,14 +259,15 @@ Function F: | Span ProcBatch |
|
|||
|
||||
| Field or Attribute | Span Prod1 | Span Prod2 | Span ProcBatch | Span Proc1 | Span Proc2 |
|
||||
|-|-|-|-|-|-|
|
||||
| Span name | `Q send` | `Q send` | `Q process` | `Q process` | `Q process` |
|
||||
| Span name | `send Q` | `send Q` | `process Q` | `process Q` | `process Q` |
|
||||
| Parent | | | | Span ProcBatch | Span ProcBatch |
|
||||
| Links | | | | Span Prod1 | Span Prod2 |
|
||||
| SpanKind | `PRODUCER` | `PRODUCER` | `CONSUMER` | `CONSUMER` | `CONSUMER` |
|
||||
| Status | `Ok` | `Ok` | `Ok` | `Ok` | `Ok` |
|
||||
| `messaging.system` | `aws_sqs` | `aws_sqs` | `aws_sqs` | `aws_sqs` | `aws_sqs` |
|
||||
| `messaging.destination.name` | `Q` | `Q` | `Q` | `Q` | `Q` |
|
||||
| `messaging.operation.type` | | | `process` | `process` | `process` |
|
||||
| `messaging.operation.name` | `send` | `send` | `process` | `process` | `process` |
|
||||
| `messaging.operation.type` | `publish` | `publish` | `process` | `process` | `process` |
|
||||
| `messaging.message.id` | | | | `"a1"` | `"a2"` |
|
||||
|
||||
Note that if Span Prod1 and Span Prod2 were sent to different queues, Span ProcBatch would not have
|
||||
|
|
|
|||
|
|
@ -24,23 +24,21 @@ The following additional attributes are defined:
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [1] | `publish`; `create`; `receive` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [3] | `0`; `1`; `2` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [5] | `MyQueue`; `MyTopic` | `Conditionally Required` [6] |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | Azure Service Bus operation name. | `send`; `receive`; `complete`; `process`; `peek` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [2] | `0`; `1`; `2` | `Conditionally Required` [3] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [4] | `MyQueue`; `MyTopic` | `Conditionally Required` [5] |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [6] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`messaging.servicebus.destination.subscription_name`](/docs/attributes-registry/messaging.md) | string | The name of the subscription in the topic messages are received from. | `mySubscription` | `Conditionally Required` If messages are received from the subscription. |  |
|
||||
| [`messaging.servicebus.disposition_status`](/docs/attributes-registry/messaging.md) | string | Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). | `complete`; `abandon`; `dead_letter` | `Conditionally Required` if and only if `messaging.operation` is `settle`. |  |
|
||||
| [`messaging.servicebus.message.delivery_count`](/docs/attributes-registry/messaging.md) | int | Number of deliveries that have been attempted for this message. | `2` | `Conditionally Required` [7] |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [8] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.message.conversation_id`](/docs/attributes-registry/messaging.md) | string | Message [correlation Id](https://learn.microsoft.com/azure/service-bus-messaging/service-bus-messages-payloads#message-routing-and-correlation) property. | `MyConversationId` | `Recommended` |  |
|
||||
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Recommended` [9] |  |
|
||||
| [`messaging.servicebus.message.enqueued_time`](/docs/attributes-registry/messaging.md) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [10] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [9] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[2]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||
**[1]:** 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.
|
||||
|
|
@ -60,22 +58,22 @@ 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.
|
||||
|
||||
**[3]:** 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.
|
||||
**[2]:** 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.
|
||||
|
||||
**[4]:** If the span describes an operation on a batch of messages.
|
||||
**[3]:** If the span describes an operation on a batch of messages.
|
||||
|
||||
**[5]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
**[4]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[6]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
**[5]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
||||
**[6]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[7]:** If delivery count is available and is bigger than 0.
|
||||
|
||||
**[8]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
**[9]:** If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
|
||||
**[10]:** 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.
|
||||
**[9]:** 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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -91,7 +89,7 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
| 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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
|
@ -129,21 +127,19 @@ The following additional attributes are defined:
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [1] | `publish`; `create`; `receive` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [3] | `0`; `1`; `2` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [5] | `MyQueue`; `MyTopic` | `Conditionally Required` [6] |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | Azure Event Hubs operation name. | `send`; `receive`; `checkpoint` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [2] | `0`; `1`; `2` | `Conditionally Required` [3] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [4] | `MyQueue`; `MyTopic` | `Conditionally Required` [5] |  |
|
||||
| [`messaging.destination.partition.id`](/docs/attributes-registry/messaging.md) | string | String representation of the partition id messages are sent to or received from, unique within the Event Hub. | `1` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.eventhubs.consumer.group`](/docs/attributes-registry/messaging.md) | string | The name of the consumer group the event consumer is associated with. | `indexer` | `Conditionally Required` If not default ("$Default"). |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [6] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.eventhubs.message.enqueued_time`](/docs/attributes-registry/messaging.md) | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | `Recommended` |  |
|
||||
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Recommended` [8] |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [9] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [8] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[2]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||
**[1]:** 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.
|
||||
|
|
@ -163,20 +159,20 @@ 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.
|
||||
|
||||
**[3]:** 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.
|
||||
**[2]:** 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.
|
||||
|
||||
**[4]:** If the span describes an operation on a batch of messages.
|
||||
**[3]:** If the span describes an operation on a batch of messages.
|
||||
|
||||
**[5]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
**[4]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[6]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
**[5]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
||||
**[6]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[7]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
**[8]:** If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
|
||||
**[9]:** 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.
|
||||
**[8]:** 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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -192,7 +188,7 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
| 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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
|
|
|||
|
|
@ -23,20 +23,27 @@ For Google Cloud Pub/Sub, the following additional attributes are defined:
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [1] | `publish`; `create`; `receive` | `Required` |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. [1] | `ack`; `nack`; `send` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [3] | `0`; `1`; `2` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [5] | `MyQueue`; `MyTopic` | `Conditionally Required` [6] |  |
|
||||
| [`messaging.gcp_pubsub.message.ordering_key`](/docs/attributes-registry/messaging.md) | string | The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. | `ordering_key` | `Conditionally Required` If the message type has an ordering key set. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [7] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [8] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.gcp_pubsub.message.ack_deadline`](/docs/attributes-registry/messaging.md) | int | The ack deadline in seconds set for the modify ack deadline request. | `10` | `Recommended` |  |
|
||||
| [`messaging.gcp_pubsub.message.ack_id`](/docs/attributes-registry/messaging.md) | string | The ack id for a given message. | `ack_id` | `Recommended` |  |
|
||||
| [`messaging.gcp_pubsub.message.delivery_attempt`](/docs/attributes-registry/messaging.md) | int | The delivery attempt for a given message. | `2` | `Recommended` |  |
|
||||
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Recommended` [8] |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [9] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** If a custom value is used, it MUST be of low cardinality.
|
||||
**[1]:** The `messaging.operation.name` has the following list of well-known values in the context of Google Pub/Sub.
|
||||
If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
- `ack` and `nack` for settlement operations
|
||||
- `send` for publishing operations
|
||||
- `modack` for extending the lease for a single message or batch of messages
|
||||
- `subscribe` for operations that represent the time from after the message was received to when the message is acknowledged, negatively acknowledged, or expired.
|
||||
- `create` and `receive` for [common messaging operations](/docs/messaging/messaging-spans.md#common-messaging-operations)
|
||||
|
||||
**[2]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||
|
||||
|
|
@ -67,9 +74,9 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
|
||||
**[6]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
||||
**[7]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
**[7]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[8]:** If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
**[8]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
**[9]:** 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.
|
||||
|
||||
|
|
@ -87,7 +94,7 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
| 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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
|
@ -99,19 +106,6 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
## Span names
|
||||
|
||||
The span name SHOULD follow the [general messaging span name pattern](../messaging/gcp-pubsub.md): it SHOULD start with the messaging destination name (Topic/Subscription) and contain a low-cardinality name of an operation the span describes:
|
||||
|
||||
- Spans for `settle` operations SHOULD follow the `<destination name> ack` or `<destination name> nack` pattern.
|
||||
- Spans names for `publish` operations SHOULD follow the `<destination name> send` pattern.
|
||||
- Spans for `create`, `receive`, and `publish` operations SHOULD follow the general `<destination name> <operation name>` pattern.
|
||||
|
||||
In addition there are the following operations are GCP specific:
|
||||
|
||||
- Spans that represents the time from after the message was received to when the message is acknowledged, negatively acknowledged, or expire (used by streaming pull) SHOULD follow the `<destination name> subscribe` pattern.
|
||||
- Spans that represent extending the lease for a single message or batch of messages SHOULD follow the`<destination name> modack` pattern.
|
||||
|
||||
## Examples
|
||||
|
||||
### Asynchronous Batch Publish Example
|
||||
|
|
@ -138,13 +132,14 @@ flowchart LR;
|
|||
|
||||
| Field or Attribute | Span Create A | Span Create B | Span Publish A B |
|
||||
|-|-|-|-|
|
||||
| Span name | `T create` | `T create` | `publish` |
|
||||
| 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"` | `"publish"` |
|
||||
| `messaging.message.id` | `"a1"` | `"a2"` | |
|
||||
| `messaging.message.envelope.size` | `1` | `1` | |
|
||||
|
|
@ -196,14 +191,15 @@ flowchart TD;
|
|||
|
||||
| Field or Attribute | Span Create A | Span Publish A | Span Receive A | Span Modack A | Span Ack A |
|
||||
|-|-|-|-|-|-|
|
||||
| Span name | `T create` | `publish` | `S receive` | `S modack` |`S ack` |
|
||||
| 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` | `PRODUCER` | `CONSUMER` |`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` | `"create"` | `"publish"` | `"receive"` | `"extend"` | `"settle"` |
|
||||
| `messaging.operation.name` | `"create"` | `"send"` | `"receive"` | `"modack"` | `"ack"` |
|
||||
| `messaging.operation.type` | `"create"` | `"publish"` | `"receive"` | | `"settle"` |
|
||||
| `messaging.message.id` | `"a1"` | | `"a1"` | | |
|
||||
| `messaging.message.envelope.size` | `1` | `1` | `1` | | |
|
||||
| `messaging.gcp_pubsub.message.ack_id` | | | | `"ack_id1"` |`"ack_id1"` |
|
||||
|
|
|
|||
|
|
@ -33,11 +33,12 @@ For Apache Kafka, the following additional attributes are defined:
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [1] | `publish`; `create`; `receive` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [3] | `0`; `1`; `2` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [5] | `MyQueue`; `MyTopic` | `Conditionally Required` [6] |  |
|
||||
| [`messaging.kafka.message.tombstone`](/docs/attributes-registry/messaging.md) | boolean | A boolean that is true if the message is a tombstone. | | `Conditionally Required` [7] |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [2] | `0`; `1`; `2` | `Conditionally Required` [3] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [4] | `MyQueue`; `MyTopic` | `Conditionally Required` [5] |  |
|
||||
| [`messaging.kafka.message.tombstone`](/docs/attributes-registry/messaging.md) | boolean | A boolean that is true if the message is a tombstone. | | `Conditionally Required` [6] |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [7] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [8] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.client.id`](/docs/attributes-registry/messaging.md) | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | `Recommended` |  |
|
||||
| [`messaging.destination.partition.id`](/docs/attributes-registry/messaging.md) | string | String representation of the partition id the message (or batch) is sent to or received from. | `1` | `Recommended` |  |
|
||||
|
|
@ -46,12 +47,9 @@ For Apache Kafka, the following additional attributes are defined:
|
|||
| [`messaging.kafka.message.offset`](/docs/attributes-registry/messaging.md) | int | The offset of a record in the corresponding Kafka partition. | `42` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.message.body.size`](/docs/attributes-registry/messaging.md) | int | The size of the message body in bytes. [10] | `1439` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Recommended` [11] |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [12] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [11] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[2]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||
**[1]:** 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.
|
||||
|
|
@ -71,16 +69,18 @@ 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.
|
||||
|
||||
**[3]:** 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.
|
||||
**[2]:** 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.
|
||||
|
||||
**[4]:** If the span describes an operation on a batch of messages.
|
||||
**[3]:** If the span describes an operation on a batch of messages.
|
||||
|
||||
**[5]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
**[4]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[6]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
**[5]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
||||
**[7]:** If value is `true`. When missing, the value is assumed to be `false`.
|
||||
**[6]:** If value is `true`. When missing, the value is assumed to be `false`.
|
||||
|
||||
**[7]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[8]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
|
|
@ -89,9 +89,7 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
**[10]:** This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
|
||||
body size should be used.
|
||||
|
||||
**[11]:** If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
|
||||
**[12]:** 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]:** 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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -107,7 +105,7 @@ body size should 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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
|
@ -134,7 +132,7 @@ One process, CA, receives the message and publishes a new message to a topic T2
|
|||
|
||||
Frameworks such as Quarkus and Spring Boot separate processing of a received message from producing subsequent messages out.
|
||||
For this reason, receiving (Span Rcv1) is the parent of both processing (Span Proc1) and producing a new message (Span Prod2).
|
||||
The span representing message receiving (Span Rcv1) should not set `messaging.operation.type` to `receive`,
|
||||
The span representing message receiving (Span Rcv1) should set `messaging.operation.type` to `process`,
|
||||
as it does not only receive the message but also converts the input message to something suitable for the processing operation to consume and creates the output message from the result of processing.
|
||||
|
||||
```
|
||||
|
|
@ -149,7 +147,7 @@ Process CB: | Span Rcv2 |
|
|||
|
||||
| Field or Attribute | Span Prod1 | Span Rcv1 | Span Proc1 | Span Prod2 | Span Rcv2 |
|
||||
|-|-|-|-|-|-|
|
||||
| Span name | `"T1 publish"` | `"T1 receive"` | `"T1 process"` | `"T2 publish"` | `"T2 receive`" |
|
||||
| Span name | `"send T1"` | `"send T1"` | `"process T1"` | `"send T2"` | `"poll T2`" |
|
||||
| Parent | | Span Prod1 | Span Rcv1 | Span Rcv1 | Span Prod2 |
|
||||
| Links | | | | | |
|
||||
| SpanKind | `PRODUCER` | `CONSUMER` | `CONSUMER` | `PRODUCER` | `CONSUMER` |
|
||||
|
|
@ -158,7 +156,8 @@ Process CB: | Span Rcv2 |
|
|||
| `service.name` | | `"myConsumer1"` | `"myConsumer1"` | | `"myConsumer2"` |
|
||||
| `messaging.system` | `"kafka"` | `"kafka"` | `"kafka"` | `"kafka"` | `"kafka"` |
|
||||
| `messaging.destination.name` | `"T1"` | `"T1"` | `"T1"` | `"T2"` | `"T2"` |
|
||||
| `messaging.operation.type` | | | `"process"` | | `"receive"` |
|
||||
| `messaging.operation.name` | `send` | `send` | `"process"` | `send` | `"poll"` |
|
||||
| `messaging.operation.type` | `publish` | `publish` | `"process"` | `publish` | `"receive"` |
|
||||
| `messaging.client.id` | | `"5"` | `"5"` | `"5"` | `"8"` |
|
||||
| `messaging.kafka.message.key` | `"myKey"` | `"myKey"` | `"myKey"` | `"anotherKey"` | `"anotherKey"` |
|
||||
| `messaging.kafka.consumer.group` | | `"my-group"` | `"my-group"` | | `"another-group"` |
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
# Semantic Conventions for Messaging Metrics
|
||||
# Semantic Conventions for Messaging Client Metrics
|
||||
|
||||
**Status**: [Experimental][DocumentStatus]
|
||||
|
||||
|
|
@ -6,15 +6,13 @@
|
|||
|
||||
<!-- toc -->
|
||||
|
||||
- [Common attributes](#common-attributes)
|
||||
- [Common metrics](#common-metrics)
|
||||
- [Metric: `messaging.client.operation.duration`](#metric-messagingclientoperationduration)
|
||||
- [Producer metrics](#producer-metrics)
|
||||
- [Metric: `messaging.publish.duration`](#metric-messagingpublishduration)
|
||||
- [Metric: `messaging.publish.messages`](#metric-messagingpublishmessages)
|
||||
- [Metric: `messaging.client.published.messages`](#metric-messagingclientpublishedmessages)
|
||||
- [Consumer metrics](#consumer-metrics)
|
||||
- [Metric: `messaging.receive.duration`](#metric-messagingreceiveduration)
|
||||
- [Metric: `messaging.receive.messages`](#metric-messagingreceivemessages)
|
||||
- [Metric: `messaging.client.consumed.messages`](#metric-messagingclientconsumedmessages)
|
||||
- [Metric: `messaging.process.duration`](#metric-messagingprocessduration)
|
||||
- [Metric: `messaging.process.messages`](#metric-messagingprocessmessages)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
|
|
@ -25,11 +23,40 @@
|
|||
> until a transition plan to the (future) stable semantic conventions has been published.
|
||||
> Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
|
||||
|
||||
## Common attributes
|
||||
## Common metrics
|
||||
|
||||
All messaging metrics share the same set of attributes:
|
||||
### Metric: `messaging.client.operation.duration`
|
||||
|
||||
<!-- semconv metric.messaging.attributes(full) -->
|
||||
When this metric is reported alongside a messaging span, the metric value SHOULD be the same as the corresponding span duration.
|
||||
|
||||
This metric is [required][MetricRequired].
|
||||
|
||||
This metric SHOULD be specified with
|
||||
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/metrics/api.md#instrument-advice)
|
||||
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
|
||||
|
||||
<!-- semconv metric.messaging.client.operation.duration(metric_table) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.client.operation.duration` | Histogram | `s` | Duration of messaging operation initiated by a producer or consumer client. [1] |  |
|
||||
|
||||
|
||||
**[1]:** This metric SHOULD NOT be used to report processing duration - processing duration is reported in `messaging.process.duration` metric.
|
||||
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
<!-- semconv metric.messaging.client.operation.duration(full) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
|
|
@ -38,6 +65,131 @@ All messaging metrics share the same set of attributes:
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `send`; `receive`; `ack` | `Required` |  |
|
||||
| [`messaging.system`](/docs/attributes-registry/messaging.md) | string | The messaging system as identified by the client instrumentation. [1] | `activemq`; `aws_sqs`; `eventgrid` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [3] | `MyQueue`; `MyTopic` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.template`](/docs/attributes-registry/messaging.md) | string | Low cardinality representation of the messaging destination name [5] | `/customers/{customerId}` | `Conditionally Required` if available. |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [6] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [7] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.destination.partition.id`](/docs/attributes-registry/messaging.md) | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [8] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge.
|
||||
|
||||
**[2]:** 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.
|
||||
|
||||
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 gRPC 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.
|
||||
|
||||
**[3]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[4]:** if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated.
|
||||
|
||||
**[5]:** Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
|
||||
|
||||
**[6]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[7]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
**[8]:** 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.
|
||||
|
||||
|
||||
|
||||
`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. |  |
|
||||
|
||||
|
||||
`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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
||||
|
||||
`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 |  |
|
||||
| `aws_sqs` | Amazon Simple Queue Service (SQS) |  |
|
||||
| `eventgrid` | Azure Event Grid |  |
|
||||
| `eventhubs` | Azure Event Hubs |  |
|
||||
| `gcp_pubsub` | Google Cloud Pub/Sub |  |
|
||||
| `jms` | Java Message Service |  |
|
||||
| `kafka` | Apache Kafka |  |
|
||||
| `pulsar` | Apache Pulsar |  |
|
||||
| `rabbitmq` | RabbitMQ |  |
|
||||
| `rocketmq` | Apache RocketMQ |  |
|
||||
| `servicebus` | Azure Service Bus |  |
|
||||
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
## Producer metrics
|
||||
|
||||
### Metric: `messaging.client.published.messages`
|
||||
|
||||
This metric is [required][MetricRequired].
|
||||
|
||||
<!-- semconv metric.messaging.client.published.messages(metric_table) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.client.published.messages` | Counter | `{message}` | Number of messages producer attempted to publish to the broker. [1] |  |
|
||||
|
||||
|
||||
**[1]:** This metric MUST NOT count messages that were created haven't yet been attempted to be published.
|
||||
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
<!-- semconv metric.messaging.client.published.messages(full) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `send`; `schedule`; `enqueue` | `Required` |  |
|
||||
| [`messaging.system`](/docs/attributes-registry/messaging.md) | string | The messaging system as identified by the client instrumentation. [1] | `activemq`; `aws_sqs`; `eventgrid` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [3] | `MyQueue`; `MyTopic` | `Conditionally Required` [4] |  |
|
||||
|
|
@ -111,19 +263,13 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
## Producer metrics
|
||||
## Consumer metrics
|
||||
|
||||
### Metric: `messaging.publish.duration`
|
||||
### Metric: `messaging.client.consumed.messages`
|
||||
|
||||
This metric is [required][MetricRequired].
|
||||
|
||||
When this metric is reported alongside a messaging publish span, the metric value SHOULD be the same as the corresponding span duration.
|
||||
|
||||
This metric SHOULD be specified with
|
||||
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/metrics/api.md#instrument-advice)
|
||||
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
|
||||
|
||||
<!-- semconv metric.messaging.publish.duration(metric_table) -->
|
||||
<!-- semconv metric.messaging.client.consumed.messages(metric_table) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
|
|
@ -132,7 +278,12 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
|
|||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.publish.duration` | Histogram | `s` | Measures the duration of publish operation. |  |
|
||||
| `messaging.client.consumed.messages` | Counter | `{message}` | Number of messages that were delivered to the application. [1] |  |
|
||||
|
||||
|
||||
**[1]:** Records the number of messages pulled from the broker or number of messages dispatched to the application in push-based scenarios.
|
||||
The metric SHOULD be reported once per message delivery. For example, if receiving and processing operations are both instrumented for a single message delivery, this counter is incremented when the message is received and not reported when it is processed.
|
||||
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
|
|
@ -140,74 +291,82 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
|
|||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
### Metric: `messaging.publish.messages`
|
||||
|
||||
This metric is [required][MetricRequired] when the messaging system supports batch publishing. It's [opt-in][MetricOptIn] when the messaging system does not support batch publishing, since the message count can be derived from the `messaging.publish.duration` histogram.
|
||||
|
||||
<!-- semconv metric.messaging.publish.messages(metric_table) -->
|
||||
<!-- semconv metric.messaging.client.consumed.messages(full) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.publish.messages` | Counter | `{message}` | Measures the number of published messages. |  |
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `receive`; `peek`; `poll`; `consume` | `Required` |  |
|
||||
| [`messaging.system`](/docs/attributes-registry/messaging.md) | string | The messaging system as identified by the client instrumentation. [1] | `activemq`; `aws_sqs`; `eventgrid` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [3] | `MyQueue`; `MyTopic` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.template`](/docs/attributes-registry/messaging.md) | string | Low cardinality representation of the messaging destination name [5] | `/customers/{customerId}` | `Conditionally Required` if available. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.destination.partition.id`](/docs/attributes-registry/messaging.md) | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [7] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge.
|
||||
|
||||
**[2]:** 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.
|
||||
|
||||
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 gRPC 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.
|
||||
|
||||
**[3]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[4]:** if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated.
|
||||
|
||||
**[5]:** Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
|
||||
|
||||
**[6]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
**[7]:** 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.
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
> The need to report `messaging.publish.messages` depends on the messaging system capabilities and not application scenarios or client library limitations. For example, RabbitMQ does not support batch publishing and corresponding instrumentations don't need to report `messaging.publish.messages`. Kafka supports both, single and batch publishing, and instrumentations MUST report `messaging.publish.messages` counter regardless of application scenarios or APIs available in the client library.
|
||||
`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.
|
||||
|
||||
## Consumer metrics
|
||||
|
||||
### Metric: `messaging.receive.duration`
|
||||
|
||||
This metric is [required][MetricRequired] for operations that are initiated by the application code (pull-based).
|
||||
|
||||
This metric SHOULD be specified with
|
||||
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/metrics/api.md#instrument-advice)
|
||||
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
|
||||
|
||||
When this metric is reported alongside a messaging receive span, the metric value SHOULD be the same as the corresponding span duration.
|
||||
|
||||
<!-- semconv metric.messaging.receive.duration(metric_table) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.receive.duration` | Histogram | `s` | Measures the duration of receive operation. |  |
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. |  |
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
<!-- prettier-ignore-end -->
|
||||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
`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.
|
||||
|
||||
### Metric: `messaging.receive.messages`
|
||||
| Value | Description | Stability |
|
||||
|---|---|---|
|
||||
| `activemq` | Apache ActiveMQ |  |
|
||||
| `aws_sqs` | Amazon Simple Queue Service (SQS) |  |
|
||||
| `eventgrid` | Azure Event Grid |  |
|
||||
| `eventhubs` | Azure Event Hubs |  |
|
||||
| `gcp_pubsub` | Google Cloud Pub/Sub |  |
|
||||
| `jms` | Java Message Service |  |
|
||||
| `kafka` | Apache Kafka |  |
|
||||
| `pulsar` | Apache Pulsar |  |
|
||||
| `rabbitmq` | RabbitMQ |  |
|
||||
| `rocketmq` | Apache RocketMQ |  |
|
||||
| `servicebus` | Azure Service Bus |  |
|
||||
|
||||
This metric is [required][MetricRequired] for batch receive operations. It's [opt-in][MetricOptIn] when the messaging system does not support batch receive since the message count can be derived from the `messaging.receive.duration` histogram.
|
||||
|
||||
_Note: The need to report `messaging.receive.messages` depends on the messaging system capabilities and not application scenarios or client library limitations._
|
||||
|
||||
<!-- semconv metric.messaging.receive.messages(metric_table) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.receive.messages` | Counter | `{message}` | Measures the number of received messages. |  |
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
|
|
@ -217,10 +376,10 @@ _Note: The need to report `messaging.receive.messages` depends on the messaging
|
|||
|
||||
### Metric: `messaging.process.duration`
|
||||
|
||||
This metric is [required][MetricRequired] for operations that are not initiated by the application code (push-based deliver), and [recommended][MetricRecommended] for processing operations instrumented for pull-based scenarios.
|
||||
|
||||
When this metric is reported alongside a messaging process span, the metric value SHOULD be the same as the corresponding span duration.
|
||||
|
||||
This metric is [required][MetricRequired] for push-based message delivery and is [recommended][MetricRecommended] for processing operations instrumented for pull-based scenarios.
|
||||
|
||||
This metric SHOULD be specified with
|
||||
[`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/metrics/api.md#instrument-advice)
|
||||
of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 ]`.
|
||||
|
|
@ -234,7 +393,11 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
|
|||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.process.duration` | Histogram | `s` | Measures the duration of process operation. |  |
|
||||
| `messaging.process.duration` | Histogram | `s` | Duration of processing operation. [1] |  |
|
||||
|
||||
|
||||
**[1]:** This metric MUST be reported for operations with `messaging.operation.type` that matches `process`.
|
||||
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
|
|
@ -242,22 +405,82 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10
|
|||
<!-- END AUTOGENERATED TEXT -->
|
||||
<!-- endsemconv -->
|
||||
|
||||
### Metric: `messaging.process.messages`
|
||||
|
||||
This metric is [required][MetricRequired] for batch process operations, and [recommended][MetricRecommended] for batch processing operations instrumented for pull-based scenarios. It's [opt-in][MetricOptIn] when the messaging system does not support batch processing since the message count can be derived from the `messaging.process.duration` histogram.
|
||||
|
||||
_Note: The need to report `messaging.process.messages` depends on the messaging system capabilities and not application scenarios or client library limitations._
|
||||
|
||||
<!-- semconv metric.messaging.process.messages(metric_table) -->
|
||||
<!-- semconv metric.messaging.process.duration(full) -->
|
||||
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
||||
<!-- see templates/registry/markdown/snippet.md.j2 -->
|
||||
<!-- prettier-ignore-start -->
|
||||
<!-- markdownlint-capture -->
|
||||
<!-- markdownlint-disable -->
|
||||
|
||||
| Name | Instrument Type | Unit (UCUM) | Description | Stability |
|
||||
| -------- | --------------- | ----------- | -------------- | --------- |
|
||||
| `messaging.process.messages` | Counter | `{message}` | Measures the number of processed messages. |  |
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `process`; `consume`; `handle` | `Required` |  |
|
||||
| [`messaging.system`](/docs/attributes-registry/messaging.md) | string | The messaging system as identified by the client instrumentation. [1] | `activemq`; `aws_sqs`; `eventgrid` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [3] | `MyQueue`; `MyTopic` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.template`](/docs/attributes-registry/messaging.md) | string | Low cardinality representation of the messaging destination name [5] | `/customers/{customerId}` | `Conditionally Required` if available. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [6] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.destination.partition.id`](/docs/attributes-registry/messaging.md) | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [7] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge.
|
||||
|
||||
**[2]:** 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.
|
||||
|
||||
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 gRPC 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.
|
||||
|
||||
**[3]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[4]:** if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated.
|
||||
|
||||
**[5]:** Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
|
||||
|
||||
**[6]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
**[7]:** 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.
|
||||
|
||||
|
||||
|
||||
`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. |  |
|
||||
|
||||
|
||||
`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 |  |
|
||||
| `aws_sqs` | Amazon Simple Queue Service (SQS) |  |
|
||||
| `eventgrid` | Azure Event Grid |  |
|
||||
| `eventhubs` | Azure Event Hubs |  |
|
||||
| `gcp_pubsub` | Google Cloud Pub/Sub |  |
|
||||
| `jms` | Java Message Service |  |
|
||||
| `kafka` | Apache Kafka |  |
|
||||
| `pulsar` | Apache Pulsar |  |
|
||||
| `rabbitmq` | RabbitMQ |  |
|
||||
| `rocketmq` | Apache RocketMQ |  |
|
||||
| `servicebus` | Azure Service Bus |  |
|
||||
|
||||
|
||||
|
||||
<!-- markdownlint-restore -->
|
||||
|
|
@ -268,4 +491,3 @@ _Note: The need to report `messaging.process.messages` depends on the messaging
|
|||
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
|
||||
[MetricRequired]: /docs/general/metric-requirement-level.md#required
|
||||
[MetricRecommended]: /docs/general/metric-requirement-level.md#recommended
|
||||
[MetricOptIn]: /docs/general/metric-requirement-level.md#opt-in
|
||||
|
|
|
|||
|
|
@ -153,36 +153,32 @@ in such a way that it cannot be changed by intermediaries.
|
|||
|
||||
### Span name
|
||||
|
||||
The span name SHOULD be set to the message destination name and the name of the operation being performed (as captured in [`messaging.operation.name`](../attributes-registry/messaging.md)) in the following format:
|
||||
Messaging spans SHOULD follow the overall [guidelines for span names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/trace/api.md#span).
|
||||
|
||||
```
|
||||
<destination name> <operation name>
|
||||
```
|
||||
<!-- markdown-link-check-disable -->
|
||||
<!-- HTML anchors are not supported https://github.com/tcort/markdown-link-check/issues/225-->
|
||||
The **span name** SHOULD be `{messaging.operation.name} {destination}` (see below for the exact definition of the [`{destination}`](#destination-placeholder) placeholder).
|
||||
<!-- markdown-link-check-enable -->
|
||||
|
||||
If the operation name is not specified by the messaging system, then the operation type as defined in [Operation types](#operation-types) SHOULD be used:
|
||||
Semantic conventions for individual messaging systems MAY specify different span name format and then MUST document it in [semantic conventions for specific messaging technologies](#semantic-conventions-for-specific-messaging-technologies).
|
||||
|
||||
```
|
||||
<destination name> <operation type>
|
||||
```
|
||||
The <span id="destination-placeholder">`{destination}`</span> SHOULD describe the entity that the operation is performed against
|
||||
and SHOULD adhere to one of the following values, provided they are accessible:
|
||||
|
||||
The destination name SHOULD only be used for the span name if it is known to be of low cardinality (cf. [general span name guidelines](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/trace/api.md#span)).
|
||||
This can be assumed if it is statically derived from application code or configuration.
|
||||
Wherever possible, the real destination names after resolving logical or aliased names SHOULD be used.
|
||||
If the destination name is dynamic, such as a [conversation ID](#conversations) or a value obtained from a `Reply-To` header, it SHOULD NOT be used for the span name.
|
||||
In these cases, an artificial destination name that best expresses the destination, or a generic, static fallback like `"(anonymous)"` for [anonymous destinations](#temporary-and-anonymous-destinations) SHOULD be used instead.
|
||||
1. `messaging.destination.template` SHOULD be used when it is available.
|
||||
2. `messaging.destination.name` SHOULD be used when the destination is known to be neither [temporary nor anonymous](#temporary-and-anonymous-destinations).
|
||||
3. `server.address:server.port` SHOULD be used only for operations not targeting any specific destination(s).
|
||||
|
||||
If a corresponding `{destination}` value is not available for a specific operation, the instrumentation SHOULD omit the `{destination}`.
|
||||
|
||||
Examples:
|
||||
|
||||
* `shop.orders publish`
|
||||
* `shop.orders subscribe`
|
||||
* `shop.orders settle`
|
||||
* `print_jobs publish`
|
||||
* `print_jobs nack`
|
||||
* `topic with spaces process`
|
||||
* `AuthenticationRequest-Conversations settle`
|
||||
* `(anonymous) send` (`(anonymous)` being a stable identifier for an unnamed destination)
|
||||
|
||||
Messaging system specific adaptions to span naming MUST be documented in [semantic conventions for specific messaging technologies](#semantic-conventions-for-specific-messaging-technologies).
|
||||
* `publish shop.orders`
|
||||
* `subscribe shop.orders`
|
||||
* `ack shop.orders`
|
||||
* `nack print_jobs`
|
||||
* `process topic with spaces`
|
||||
* `settle AuthenticationRequest-Conversations`
|
||||
|
||||
### Operation types
|
||||
|
||||
|
|
@ -193,20 +189,19 @@ The following operation types related to messages are defined for these semantic
|
|||
| `create` | A message is created or passed to a client library for publishing. "Create" spans always refer to a single message and are used to provide a unique creation context for messages in batch publishing scenarios. |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |
|
||||
| `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. |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |
|
||||
| `process` | One or more messages are processed by a consumer. |
|
||||
| `settle` | One or more messages are settled. |
|
||||
|
||||
### Span kind
|
||||
|
||||
[Span kinds](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/trace/api.md#spankind)
|
||||
SHOULD be set according to the following table, based on the operation type a span describes.
|
||||
Span kind SHOULD be set according to the following table, based on the operation type a span describes.
|
||||
|
||||
| Operation type | Span kind|
|
||||
|----------------|-------------|
|
||||
| `create` | `PRODUCER` |
|
||||
| `publish` | `PRODUCER` if the context of the "Publish" span is used as creation context. |
|
||||
| `receive` | `CONSUMER` |
|
||||
| `process` | `CONSUMER` for push-based scenarios where no `receive` span exists. |
|
||||
| `process` | `CONSUMER` for push-based scenarios where no "Receive" span exists. |
|
||||
|
||||
For cases not covered by the table above, the span kind should be set according
|
||||
to the [generic specification about span kinds](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/trace/api.md#spankind),
|
||||
|
|
@ -292,31 +287,29 @@ as described in [Attributes specific to certain messaging systems](#attributes-s
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [1] | `publish`; `create`; `receive` | `Required` |  |
|
||||
| [`messaging.system`](/docs/attributes-registry/messaging.md) | string | The messaging system as identified by the client instrumentation. [2] | `activemq`; `aws_sqs`; `eventgrid` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [3] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [4] | `0`; `1`; `2` | `Conditionally Required` [5] |  |
|
||||
| [`messaging.destination.anonymous`](/docs/attributes-registry/messaging.md) | boolean | A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). | | `Conditionally Required` [6] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [7] | `MyQueue`; `MyTopic` | `Conditionally Required` [8] |  |
|
||||
| [`messaging.destination.template`](/docs/attributes-registry/messaging.md) | string | Low cardinality representation of the messaging destination name [9] | `/customers/{customerId}` | `Conditionally Required` [10] |  |
|
||||
| [`messaging.destination.temporary`](/docs/attributes-registry/messaging.md) | boolean | A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. | | `Conditionally Required` [11] |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Required` |  |
|
||||
| [`messaging.system`](/docs/attributes-registry/messaging.md) | string | The messaging system as identified by the client instrumentation. [1] | `activemq`; `aws_sqs`; `eventgrid` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [3] | `0`; `1`; `2` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.anonymous`](/docs/attributes-registry/messaging.md) | boolean | A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). | | `Conditionally Required` [5] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [6] | `MyQueue`; `MyTopic` | `Conditionally Required` [7] |  |
|
||||
| [`messaging.destination.template`](/docs/attributes-registry/messaging.md) | string | Low cardinality representation of the messaging destination name [8] | `/customers/{customerId}` | `Conditionally Required` [9] |  |
|
||||
| [`messaging.destination.temporary`](/docs/attributes-registry/messaging.md) | boolean | A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. | | `Conditionally Required` [10] |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [11] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | 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` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.client.id`](/docs/attributes-registry/messaging.md) | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | `Recommended` If a client id is available |  |
|
||||
| [`messaging.client.id`](/docs/attributes-registry/messaging.md) | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | `Recommended` |  |
|
||||
| [`messaging.destination.partition.id`](/docs/attributes-registry/messaging.md) | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | `Recommended` When applicable. |  |
|
||||
| [`messaging.message.body.size`](/docs/attributes-registry/messaging.md) | int | The size of the message body in bytes. [13] | `1439` | `Recommended` |  |
|
||||
| [`messaging.message.conversation_id`](/docs/attributes-registry/messaging.md) | string | The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". | `MyConversationId` | `Recommended` |  |
|
||||
| [`messaging.message.envelope.size`](/docs/attributes-registry/messaging.md) | int | The size of the message body and metadata in bytes. [14] | `2738` | `Recommended` |  |
|
||||
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Recommended` [15] |  |
|
||||
| [`network.peer.address`](/docs/attributes-registry/network.md) | string | Peer address of the messaging intermediary node where the operation was performed. [16] | `10.1.2.80`; `/tmp/my.sock` | `Recommended` If applicable for this messaging system. |  |
|
||||
| [`network.peer.address`](/docs/attributes-registry/network.md) | string | Peer address of the messaging intermediary node where the operation was performed. [15] | `10.1.2.80`; `/tmp/my.sock` | `Recommended` If applicable for this messaging system. |  |
|
||||
| [`network.peer.port`](/docs/attributes-registry/network.md) | int | Peer port of the messaging intermediary node where the operation was performed. | `65123` | `Recommended` if and only if `network.peer.address` is set. |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [17] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [16] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** If a custom value is used, it MUST be of low cardinality.
|
||||
**[1]:** The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge.
|
||||
|
||||
**[2]:** The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge.
|
||||
|
||||
**[3]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||
**[2]:** 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.
|
||||
|
|
@ -336,22 +329,24 @@ 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]:** 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.
|
||||
**[3]:** 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.
|
||||
|
||||
**[5]:** If the span describes an operation on a batch of messages.
|
||||
**[4]:** If the span describes an operation on a batch of messages.
|
||||
|
||||
**[6]:** If value is `true`. When missing, the value is assumed to be `false`.
|
||||
**[5]:** If value is `true`. When missing, the value is assumed to be `false`.
|
||||
|
||||
**[7]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
**[6]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[8]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
**[7]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
||||
**[9]:** Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
|
||||
**[8]:** Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation.
|
||||
|
||||
**[10]:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed.
|
||||
**[9]:** If available. Instrumentations MUST NOT use `messaging.destination.name` as template unless low-cardinality of destination name is guaranteed.
|
||||
|
||||
**[11]:** If value is `true`. When missing, the value is assumed to be `false`.
|
||||
**[10]:** If value is `true`. When missing, the value is assumed to be `false`.
|
||||
|
||||
**[11]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[12]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
|
|
@ -361,13 +356,11 @@ body size should be used.
|
|||
**[14]:** This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed
|
||||
size should be used.
|
||||
|
||||
**[15]:** If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
|
||||
**[16]:** Semantic conventions for individual messaging systems SHOULD document whether `network.peer.*` attributes are applicable.
|
||||
**[15]:** 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.
|
||||
|
||||
**[17]:** 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.
|
||||
**[16]:** 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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -383,7 +376,7 @@ If a messaging operation involved multiple network calls (for example retries),
|
|||
| 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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
|
@ -503,14 +496,15 @@ flowchart LR;
|
|||
|
||||
| Field or Attribute | Span Publish A | Span Process A 1| Span Process A 2 |
|
||||
|-|-|-|-|
|
||||
| Span name | `T publish` | `T process` | `T process` |
|
||||
| Span name | `publish T` | `consume T` | `consume T` |
|
||||
| Parent | | | |
|
||||
| Links | | `T publish` | `T publish` |
|
||||
| Links | | `publish T` | `publish T` |
|
||||
| SpanKind | `PRODUCER` | `CONSUMER` | `CONSUMER` |
|
||||
| `server.address` | `"ms"` | `"ms"` | `"ms"` |
|
||||
| `server.port` | `1234` | `1234` | `1234` |
|
||||
| `messaging.system` | `"rabbitmq"` | `"rabbitmq"` | `"rabbitmq"` |
|
||||
| `messaging.destination.name` | `"T"` | `"T"` | `"T"` |
|
||||
| `messaging.operation.name` | `"publish"` | `"consume"` | `"consume"` |
|
||||
| `messaging.operation.type` | `"publish"` | `"process"` | `"process"` |
|
||||
| `messaging.message.id` | `"a"` | `"a"`| `"a"` |
|
||||
|
||||
|
|
@ -539,7 +533,7 @@ flowchart LR;
|
|||
|
||||
| Field or Attribute | Span Publish A | Span Publish B | Span Receive A B |
|
||||
|-|-|-|-|
|
||||
| Span name | `Q publish` | `Q publish` | `Q receive` |
|
||||
| Span name | `send Q` | `send Q` | `poll Q` |
|
||||
| Parent | | | |
|
||||
| Links | | | Span Publish A, Span Publish B |
|
||||
| Link attributes | | | Span Publish A: `messaging.message.id`: `"a1"` |
|
||||
|
|
@ -549,6 +543,7 @@ flowchart LR;
|
|||
| `server.port` | `1234` | `1234` | `1234` |
|
||||
| `messaging.system` | `"kafka"` | `"kafka"` | `"kafka"` |
|
||||
| `messaging.destination.name` | `"Q"` | `"Q"` | `"Q"` |
|
||||
| `messaging.operation.name` | `"send"` | `"send"` | `"poll"` |
|
||||
| `messaging.operation.type` | `"publish"` | `"publish"` | `"receive"` |
|
||||
| `messaging.message.id` | `"a1"` | `"a2"` | |
|
||||
| `messaging.batch.message_count` | | | 2 |
|
||||
|
|
@ -586,7 +581,7 @@ flowchart LR;
|
|||
|
||||
| Field or Attribute | Span Create A | Span Create B | Span Publish | Span Receive A | Span Receive B |
|
||||
|-|-|-|-|-|-|
|
||||
| Span name | `Q create` | `Q create` | `Q publish` | `Q receive` | `Q receive` |
|
||||
| Span name | `create Q` | `create Q` | `send Q` | `poll Q` | `poll Q` |
|
||||
| Parent | | | | | |
|
||||
| Links | | | | Span Create A | Span Create B |
|
||||
| SpanKind | `PRODUCER` | `PRODUCER` | `CLIENT` | `CONSUMER` | `CONSUMER` |
|
||||
|
|
@ -594,6 +589,7 @@ flowchart LR;
|
|||
| `server.port` | `1234` | `1234` | `1234` | `1234` | `1234` |
|
||||
| `messaging.system` | `"kafka"` | `"kafka"` | `"kafka"` | `"kafka"` | `"kafka"` |
|
||||
| `messaging.destination.name` | `"Q"` | `"Q"` | `"Q"` | `"Q"` | `"Q"` |
|
||||
| `messaging.operation.name` | `"create"` | `"create"` | `"send"` | `"poll"` | `"poll"` |
|
||||
| `messaging.operation.type` | `"create"` | `"create"` | `"publish"` | `"receive"` | `"receive"` |
|
||||
| `messaging.message.id` | `"a1"` | `"a2"` | | `"a1"` | `"a2"` |
|
||||
| `messaging.batch.message_count` | | | 2 | | |
|
||||
|
|
|
|||
|
|
@ -26,23 +26,21 @@ In RabbitMQ, the destination is defined by an *exchange* and a *routing key*.
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [1] | `publish`; `create`; `receive` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [3] | `MyQueue`; `MyTopic` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [2] | `MyQueue`; `MyTopic` | `Conditionally Required` [3] |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [4] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`messaging.rabbitmq.destination.routing_key`](/docs/attributes-registry/messaging.md) | string | RabbitMQ message routing key. | `myKey` | `Conditionally Required` If not empty. |  |
|
||||
| [`messaging.rabbitmq.message.delivery_tag`](/docs/attributes-registry/messaging.md) | int | RabbitMQ message delivery tag | `123` | `Conditionally Required` When available. |  |
|
||||
| [`server.address`](/docs/attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [5] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | `Conditionally Required` If available. |  |
|
||||
| [`messaging.message.body.size`](/docs/attributes-registry/messaging.md) | int | The size of the message body in bytes. [6] | `1439` | `Recommended` |  |
|
||||
| [`messaging.message.conversation_id`](/docs/attributes-registry/messaging.md) | string | Message [correlation Id](https://www.rabbitmq.com/tutorials/tutorial-six-java#correlation-id) property. | `MyConversationId` | `Recommended` |  |
|
||||
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Recommended` [7] |  |
|
||||
| [`network.peer.address`](/docs/attributes-registry/network.md) | string | Peer address of the network connection - IP address or Unix domain socket name. [8] | `10.1.2.80`; `/tmp/my.sock` | `Recommended` |  |
|
||||
| [`network.peer.address`](/docs/attributes-registry/network.md) | string | Peer address of the network connection - IP address or Unix domain socket name. [7] | `10.1.2.80`; `/tmp/my.sock` | `Recommended` |  |
|
||||
| [`network.peer.port`](/docs/attributes-registry/network.md) | int | Peer port number of the network connection. | `65123` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [9] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [8] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[2]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||
**[1]:** 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.
|
||||
|
|
@ -62,21 +60,21 @@ 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.
|
||||
|
||||
**[3]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
**[2]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[4]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
**[3]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
||||
**[4]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[5]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
||||
|
||||
**[6]:** This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
|
||||
body size should be used.
|
||||
|
||||
**[7]:** If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
**[7]:** If an operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
|
||||
|
||||
**[8]:** If an operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used.
|
||||
|
||||
**[9]:** 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.
|
||||
**[8]:** 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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -92,7 +90,7 @@ body size should 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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
|
|
|||
|
|
@ -25,12 +25,13 @@ Specific attributes for Apache RocketMQ are defined below.
|
|||
|
||||
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
||||
|---|---|---|---|---|---|
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [1] | `publish`; `create`; `receive` | `Required` |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Required` |  |
|
||||
| [`messaging.rocketmq.client_group`](/docs/attributes-registry/messaging.md) | string | Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind. | `myConsumerGroup` | `Required` |  |
|
||||
| [`messaging.rocketmq.namespace`](/docs/attributes-registry/messaging.md) | string | Namespace of RocketMQ resources, resources in different namespaces are individual. | `myNamespace` | `Required` |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [2] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [3] | `0`; `1`; `2` | `Conditionally Required` [4] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [5] | `MyQueue`; `MyTopic` | `Conditionally Required` [6] |  |
|
||||
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `amqp:decode-error`; `KAFKA_STORAGE_ERROR`; `channel-error` | `Conditionally Required` If and only if the messaging operation has failed. |  |
|
||||
| [`messaging.batch.message_count`](/docs/attributes-registry/messaging.md) | int | The number of messages sent, received, or processed in the scope of the batching operation. [2] | `0`; `1`; `2` | `Conditionally Required` [3] |  |
|
||||
| [`messaging.destination.name`](/docs/attributes-registry/messaging.md) | string | The message destination name [4] | `MyQueue`; `MyTopic` | `Conditionally Required` [5] |  |
|
||||
| [`messaging.operation.type`](/docs/attributes-registry/messaging.md) | string | A string identifying the type of the messaging operation. [6] | `publish`; `create`; `receive` | `Conditionally Required` If applicable. |  |
|
||||
| [`messaging.rocketmq.message.delay_time_level`](/docs/attributes-registry/messaging.md) | int | The delay time level for delay message, which determines the message delay time. | `3` | `Conditionally Required` [7] |  |
|
||||
| [`messaging.rocketmq.message.delivery_timestamp`](/docs/attributes-registry/messaging.md) | int | The timestamp in milliseconds that the delay message is expected to be delivered to consumer. | `1665987217045` | `Conditionally Required` [8] |  |
|
||||
| [`messaging.rocketmq.message.group`](/docs/attributes-registry/messaging.md) | string | It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group. | `myMessageGroup` | `Conditionally Required` If the message type is FIFO. |  |
|
||||
|
|
@ -38,16 +39,13 @@ Specific attributes for Apache RocketMQ are defined below.
|
|||
| [`messaging.client.id`](/docs/attributes-registry/messaging.md) | string | A unique identifier for the client that consumes or produces a message. | `client-5`; `myhost@8742@s8083jm` | `Recommended` |  |
|
||||
| [`messaging.message.body.size`](/docs/attributes-registry/messaging.md) | int | The size of the message body in bytes. [10] | `1439` | `Recommended` |  |
|
||||
| [`messaging.message.id`](/docs/attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | `Recommended` If span describes operation on a single message. |  |
|
||||
| [`messaging.operation.name`](/docs/attributes-registry/messaging.md) | string | The system-specific name of the messaging operation. | `ack`; `nack`; `send` | `Recommended` [11] |  |
|
||||
| [`messaging.rocketmq.consumption_model`](/docs/attributes-registry/messaging.md) | string | Model of message consumption. This only applies to consumer spans. | `clustering`; `broadcasting` | `Recommended` |  |
|
||||
| [`messaging.rocketmq.message.keys`](/docs/attributes-registry/messaging.md) | string[] | Key(s) of message, another way to mark message besides message id. | `["keyA", "keyB"]` | `Recommended` |  |
|
||||
| [`messaging.rocketmq.message.tag`](/docs/attributes-registry/messaging.md) | string | The secondary classifier of message besides topic. | `tagA` | `Recommended` |  |
|
||||
| [`messaging.rocketmq.message.type`](/docs/attributes-registry/messaging.md) | string | Type of message. | `normal`; `fifo`; `delay` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [12] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
| [`server.port`](/docs/attributes-registry/server.md) | int | Server port number. [11] | `80`; `8080`; `443` | `Recommended` |  |
|
||||
|
||||
**[1]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[2]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.
|
||||
**[1]:** 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.
|
||||
|
|
@ -67,14 +65,16 @@ 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.
|
||||
|
||||
**[3]:** 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.
|
||||
**[2]:** 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.
|
||||
|
||||
**[4]:** If the span describes an operation on a batch of messages.
|
||||
**[3]:** If the span describes an operation on a batch of messages.
|
||||
|
||||
**[5]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
**[4]:** Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If
|
||||
the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker.
|
||||
|
||||
**[6]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
**[5]:** If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
||||
**[6]:** If a custom value is used, it MUST be of low cardinality.
|
||||
|
||||
**[7]:** If the message type is delay and delivery timestamp is not specified.
|
||||
|
||||
|
|
@ -85,9 +85,7 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi
|
|||
**[10]:** This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed
|
||||
body size should be used.
|
||||
|
||||
**[11]:** If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
|
||||
**[12]:** 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]:** 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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -103,7 +101,7 @@ body size should 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 publishing scenarios. |  |
|
||||
| `process` | One or more messages are delivered to or processed by a consumer. |  |
|
||||
| `process` | One or more messages are processed by a consumer. |  |
|
||||
| `publish` | One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. |  |
|
||||
| `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. |  |
|
||||
| `settle` | One or more messages are settled. |  |
|
||||
|
|
|
|||
|
|
@ -15,3 +15,5 @@ groups:
|
|||
requirement_level:
|
||||
conditionally_required: If available.
|
||||
- ref: server.port
|
||||
- ref: messaging.operation.name
|
||||
requirement_level: required
|
||||
|
|
|
|||
|
|
@ -0,0 +1,50 @@
|
|||
groups:
|
||||
- id: metric.messaging.publish.duration
|
||||
type: metric
|
||||
metric_name: messaging.publish.duration
|
||||
brief: "Deprecated. Use `messaging.client.operation.duration` instead."
|
||||
deprecated: "Replaced by `messaging.client.operation.duration`."
|
||||
stability: experimental
|
||||
instrument: histogram
|
||||
unit: "s"
|
||||
extends: attributes.messaging.common.minimal
|
||||
|
||||
- id: metric.messaging.receive.duration
|
||||
type: metric
|
||||
metric_name: messaging.receive.duration
|
||||
brief: "Deprecated. Use `messaging.client.operation.duration` instead."
|
||||
deprecated: "Replaced by `messaging.client.operation.duration`."
|
||||
stability: experimental
|
||||
instrument: histogram
|
||||
unit: "s"
|
||||
extends: attributes.messaging.common.minimal
|
||||
|
||||
- id: metric.messaging.process.messages
|
||||
type: metric
|
||||
metric_name: messaging.process.messages
|
||||
brief: "Deprecated. Use `messaging.client.consumed.messages` instead."
|
||||
deprecated: "Replaced by `messaging.client.consumed.messages`."
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: attributes.messaging.common.minimal
|
||||
|
||||
- id: metric.messaging.publish.messages
|
||||
type: metric
|
||||
metric_name: messaging.publish.messages
|
||||
brief: "Deprecated. Use `messaging.client.produced.messages` instead."
|
||||
deprecated: "Replaced by `messaging.client.produced.messages`."
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: attributes.messaging.common.minimal
|
||||
|
||||
- id: metric.messaging.receive.messages
|
||||
type: metric
|
||||
metric_name: messaging.receive.messages
|
||||
brief: "Deprecated. Use `messaging.client.consumed.messages` instead."
|
||||
deprecated: "Replaced by `messaging.client.consumed.messages`."
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: attributes.messaging.common.minimal
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
groups:
|
||||
- id: metric.messaging.attributes
|
||||
type: attribute_group
|
||||
stability: experimental
|
||||
brief: "Common messaging metrics attributes."
|
||||
extends: attributes.messaging.common.minimal
|
||||
attributes:
|
||||
- ref: messaging.system
|
||||
requirement_level: required
|
||||
- ref: messaging.destination.partition.id
|
||||
- ref: messaging.destination.name
|
||||
requirement_level:
|
||||
conditionally_required: if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated.
|
||||
- ref: messaging.destination.template
|
||||
requirement_level:
|
||||
conditionally_required: if available.
|
||||
|
||||
# durations
|
||||
- id: metric.messaging.client.operation.duration
|
||||
type: metric
|
||||
metric_name: messaging.client.operation.duration
|
||||
brief: "Duration of messaging operation initiated by a producer or consumer client."
|
||||
note: >
|
||||
This metric SHOULD NOT be used to report processing duration - processing duration is reported in `messaging.process.duration` metric.
|
||||
stability: experimental
|
||||
instrument: histogram
|
||||
unit: "s"
|
||||
extends: metric.messaging.attributes
|
||||
attributes:
|
||||
- ref: messaging.operation.type
|
||||
requirement_level:
|
||||
conditionally_required: If applicable.
|
||||
- ref: messaging.operation.name
|
||||
examples: ["send", "receive", "ack"]
|
||||
|
||||
- id: metric.messaging.process.duration
|
||||
type: metric
|
||||
metric_name: messaging.process.duration
|
||||
brief: "Duration of processing operation."
|
||||
note: >
|
||||
This metric MUST be reported for operations with `messaging.operation.type` that matches `process`.
|
||||
stability: experimental
|
||||
instrument: histogram
|
||||
unit: "s"
|
||||
extends: metric.messaging.attributes
|
||||
attributes:
|
||||
- ref: messaging.operation.name
|
||||
examples: ["process", "consume", "handle"]
|
||||
|
||||
# counters
|
||||
- id: metric.messaging.client.published.messages
|
||||
type: metric
|
||||
metric_name: messaging.client.published.messages
|
||||
brief: "Number of messages producer attempted to publish to the broker."
|
||||
note: >
|
||||
This metric MUST NOT count messages that were created haven't yet been attempted to be published.
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: metric.messaging.attributes
|
||||
attributes:
|
||||
- ref: messaging.operation.name
|
||||
examples: ["send", "schedule", "enqueue"]
|
||||
|
||||
- id: metric.messaging.client.consumed.messages
|
||||
type: metric
|
||||
metric_name: messaging.client.consumed.messages
|
||||
brief: "Number of messages that were delivered to the application."
|
||||
note: >
|
||||
Records the number of messages pulled from the broker or number of messages dispatched to the application in push-based scenarios.
|
||||
|
||||
The metric SHOULD be reported once per message delivery. For example, if receiving and
|
||||
processing operations are both instrumented for a single message delivery, this counter
|
||||
is incremented when the message is received and not reported when it is processed.
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: metric.messaging.attributes
|
||||
attributes:
|
||||
- ref: messaging.operation.name
|
||||
examples: ["receive", "peek", "poll", "consume"]
|
||||
|
|
@ -1,72 +0,0 @@
|
|||
groups:
|
||||
- id: metric.messaging.attributes
|
||||
type: attribute_group
|
||||
stability: experimental
|
||||
brief: "Common messaging metrics attributes."
|
||||
extends: attributes.messaging.common.minimal
|
||||
attributes:
|
||||
- ref: messaging.system
|
||||
requirement_level: required
|
||||
- ref: messaging.destination.partition.id
|
||||
- ref: messaging.destination.name
|
||||
requirement_level:
|
||||
conditionally_required: if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated.
|
||||
- ref: messaging.destination.template
|
||||
requirement_level:
|
||||
conditionally_required: if available.
|
||||
|
||||
# durations
|
||||
- id: metric.messaging.publish.duration
|
||||
type: metric
|
||||
metric_name: messaging.publish.duration
|
||||
brief: "Measures the duration of publish operation."
|
||||
stability: experimental
|
||||
instrument: histogram
|
||||
unit: "s"
|
||||
extends: metric.messaging.attributes
|
||||
|
||||
- id: metric.messaging.receive.duration
|
||||
type: metric
|
||||
metric_name: messaging.receive.duration
|
||||
brief: "Measures the duration of receive operation."
|
||||
stability: experimental
|
||||
instrument: histogram
|
||||
unit: "s"
|
||||
extends: metric.messaging.attributes
|
||||
|
||||
- id: metric.messaging.process.duration
|
||||
type: metric
|
||||
metric_name: messaging.process.duration
|
||||
brief: "Measures the duration of process operation."
|
||||
stability: experimental
|
||||
instrument: histogram
|
||||
unit: "s"
|
||||
extends: metric.messaging.attributes
|
||||
|
||||
# counters
|
||||
- id: metric.messaging.publish.messages
|
||||
type: metric
|
||||
metric_name: messaging.publish.messages
|
||||
brief: "Measures the number of published messages."
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: metric.messaging.attributes
|
||||
|
||||
- id: metric.messaging.receive.messages
|
||||
type: metric
|
||||
metric_name: messaging.receive.messages
|
||||
brief: "Measures the number of received messages."
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: metric.messaging.attributes
|
||||
|
||||
- id: metric.messaging.process.messages
|
||||
type: metric
|
||||
metric_name: messaging.process.messages
|
||||
brief: "Measures the number of processed messages."
|
||||
stability: experimental
|
||||
instrument: counter
|
||||
unit: "{message}"
|
||||
extends: metric.messaging.attributes
|
||||
|
|
@ -116,16 +116,22 @@ groups:
|
|||
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.
|
||||
stability: experimental
|
||||
- id: deliver
|
||||
- id: process
|
||||
value: "process"
|
||||
brief: >
|
||||
One or more messages are delivered to or processed by a consumer.
|
||||
One or more messages are processed by a consumer.
|
||||
stability: experimental
|
||||
- id: settle
|
||||
value: "settle"
|
||||
brief: >
|
||||
One or more messages are settled.
|
||||
stability: experimental
|
||||
- id: deliver
|
||||
value: "deliver"
|
||||
brief: "Deprecated. Use `process` instead."
|
||||
deprecated: "Replaced by `process`."
|
||||
stability: experimental
|
||||
|
||||
stability: experimental
|
||||
brief: >
|
||||
A string identifying the type of the messaging operation.
|
||||
|
|
|
|||
|
|
@ -53,11 +53,11 @@ groups:
|
|||
Defines minimal set of attributes used by all messaging systems.
|
||||
extends: attributes.messaging.common.minimal
|
||||
attributes:
|
||||
- ref: messaging.operation.type
|
||||
requirement_level: required
|
||||
- ref: messaging.operation.name
|
||||
requirement_level: required
|
||||
- ref: messaging.operation.type
|
||||
requirement_level:
|
||||
recommended: If the operation is not sufficiently described by `messaging.operation.type`.
|
||||
conditionally_required: If applicable.
|
||||
- ref: messaging.destination.name
|
||||
requirement_level:
|
||||
conditionally_required: If span describes operation on a single message or if the value applies to all messages in the batch.
|
||||
|
|
@ -74,8 +74,7 @@ groups:
|
|||
- ref: messaging.system
|
||||
requirement_level: required
|
||||
- ref: messaging.client.id
|
||||
requirement_level:
|
||||
recommended: If a client id is available
|
||||
requirement_level: recommended
|
||||
- ref: messaging.destination.partition.id
|
||||
requirement_level:
|
||||
recommended: When applicable.
|
||||
|
|
@ -213,14 +212,22 @@ groups:
|
|||
- ref: messaging.batch.message_count
|
||||
requirement_level:
|
||||
conditionally_required: If the span describes an operation on a batch of messages.
|
||||
- ref: messaging.operation.name
|
||||
note: |
|
||||
The `messaging.operation.name` has the following list of well-known values in the context of Google Pub/Sub.
|
||||
If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
|
||||
|
||||
- `ack` and `nack` for settlement operations
|
||||
- `send` for publishing operations
|
||||
- `modack` for extending the lease for a single message or batch of messages
|
||||
- `subscribe` for operations that represent the time from after the message was received to when the message is acknowledged, negatively acknowledged, or expired.
|
||||
- `create` and `receive` for [common messaging operations](/docs/messaging/messaging-spans.md#common-messaging-operations)
|
||||
- id: messaging.servicebus
|
||||
type: attribute_group
|
||||
extends: attributes.messaging.trace.minimal
|
||||
brief: >
|
||||
Attributes for Azure Service Bus
|
||||
attributes:
|
||||
- ref: messaging.operation.name
|
||||
- ref: messaging.servicebus.message.delivery_count
|
||||
requirement_level:
|
||||
conditionally_required: If delivery count is available and is bigger than 0.
|
||||
|
|
@ -236,13 +243,16 @@ groups:
|
|||
- ref: messaging.batch.message_count
|
||||
requirement_level:
|
||||
conditionally_required: If the span describes an operation on a batch of messages.
|
||||
- ref: messaging.operation.name
|
||||
brief: Azure Service Bus operation name.
|
||||
examples: ['send', 'receive', 'complete', 'process', 'peek']
|
||||
|
||||
- id: messaging.eventhubs
|
||||
type: attribute_group
|
||||
extends: attributes.messaging.trace.minimal
|
||||
brief: >
|
||||
Attributes for Azure Event Hubs
|
||||
attributes:
|
||||
- ref: messaging.operation.name
|
||||
- ref: messaging.destination.partition.id
|
||||
brief: >
|
||||
String representation of the partition id messages are sent to or received from, unique within the Event Hub.
|
||||
|
|
@ -255,3 +265,6 @@ groups:
|
|||
- ref: messaging.batch.message_count
|
||||
requirement_level:
|
||||
conditionally_required: If the span describes an operation on a batch of messages.
|
||||
- ref: messaging.operation.name
|
||||
brief: Azure Event Hubs operation name.
|
||||
examples: ['send', 'receive', 'checkpoint']
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ versions:
|
|||
db.elasticsearch.cluster.name: db.namespace
|
||||
metrics:
|
||||
changes:
|
||||
# https://github.com/open-telemetry/semantic-conventions/pull/1125
|
||||
- rename_attributes:
|
||||
attribute_map:
|
||||
db.client.connections.state: db.client.connection.state
|
||||
|
|
@ -28,6 +29,10 @@ versions:
|
|||
- db.client.connection.create_time
|
||||
- db.client.connection.wait_time
|
||||
- db.client.connection.use_time
|
||||
# https://github.com/open-telemetry/semantic-conventions/pull/1006
|
||||
- rename_metrics:
|
||||
messaging.publish.messages: messaging.client.published.messages
|
||||
|
||||
1.26.0:
|
||||
metrics:
|
||||
changes:
|
||||
|
|
|
|||
Loading…
Reference in New Issue