diff --git a/docs/messaging/kafka.md b/docs/messaging/kafka.md index 4f6866ed83..2b359cd26a 100644 --- a/docs/messaging/kafka.md +++ b/docs/messaging/kafka.md @@ -27,7 +27,7 @@ For Apache Kafka, the following additional attributes are defined: | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| [`messaging.destination.partition.id`](../attributes-registry/messaging.md) | string | "String representation of the partition id the message (or batch) is sent to or received from."" | `1` | Recommended | +| [`messaging.destination.partition.id`](../attributes-registry/messaging.md) | string | String representation of the partition id the message (or batch) is sent to or received from. | `1` | Recommended | | [`messaging.kafka.consumer.group`](../attributes-registry/messaging.md) | string | Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers. | `my-group` | Recommended | | [`messaging.kafka.message.key`](../attributes-registry/messaging.md) | string | Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from `messaging.message.id` in that they're not unique. If the key is `null`, the attribute MUST NOT be set. [1] | `myKey` | Recommended | | [`messaging.kafka.message.offset`](../attributes-registry/messaging.md) | int | The offset of a record in the corresponding Kafka partition. | `42` | Recommended | diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md index 24b644c19c..026f6b7a10 100644 --- a/docs/messaging/messaging-metrics.md +++ b/docs/messaging/messaging-metrics.md @@ -34,7 +34,7 @@ All messaging metrics share the same set of attributes: |---|---|---|---|---| | [`error.type`](../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: [2] | | [`messaging.destination.name`](../attributes-registry/messaging.md) | string | The message destination name [3] | `MyQueue`; `MyTopic` | Conditionally Required: [4] | -| [`messaging.destination.partition.id`](../attributes-registry/messaging.md) | string | The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. | `1` | Conditionally Required: if available. | +| [`messaging.destination.partition.id`](../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 | | [`messaging.destination.template`](../attributes-registry/messaging.md) | string | Low cardinality representation of the messaging destination name [5] | `/customers/{customerId}` | Conditionally Required: if available. | | [`messaging.system`](../attributes-registry/messaging.md) | string | An identifier for the messaging system being used. See below for a list of well-known identifiers. | `activemq` | Required | | [`network.protocol.name`](../attributes-registry/network.md) | string | [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. [6] | `amqp`; `mqtt` | Conditionally Required: [7] | diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index 7cff828c2c..e3cd478173 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -288,6 +288,7 @@ as described in [Attributes specific to certain messaging systems](#attributes-s | [`messaging.client_id`](../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.destination.anonymous`](../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`](../attributes-registry/messaging.md) | string | The message destination name [6] | `MyQueue`; `MyTopic` | Conditionally Required: [7] | +| [`messaging.destination.partition.id`](../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 | | [`messaging.destination.template`](../attributes-registry/messaging.md) | string | Low cardinality representation of the messaging destination name [8] | `/customers/{customerId}` | Conditionally Required: [9] | | [`messaging.destination.temporary`](../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.message.body.size`](../attributes-registry/messaging.md) | int | The size of the message body in bytes. [11] | `1439` | Recommended | diff --git a/model/messaging-common.yaml b/model/messaging-common.yaml index f5505a0baf..62de61072d 100644 --- a/model/messaging-common.yaml +++ b/model/messaging-common.yaml @@ -6,6 +6,7 @@ groups: attributes: - ref: messaging.system requirement_level: required + - ref: messaging.destination.partition.id - ref: error.type examples: ['amqp:decode-error', 'KAFKA_STORAGE_ERROR', 'channel-error'] requirement_level: diff --git a/model/metrics/messaging.yaml b/model/metrics/messaging.yaml index 3e05f15a0a..03a1a5b44b 100644 --- a/model/metrics/messaging.yaml +++ b/model/metrics/messaging.yaml @@ -11,10 +11,6 @@ groups: - ref: messaging.destination.template requirement_level: conditionally_required: if available. - - ref: messaging.destination.partition.id - requirement_level: - conditionally_required: if available. - # durations - id: metric.messaging.publish.duration diff --git a/model/trace/messaging.yaml b/model/trace/messaging.yaml index 362eaab9f4..4e641a5130 100644 --- a/model/trace/messaging.yaml +++ b/model/trace/messaging.yaml @@ -111,7 +111,7 @@ groups: attributes: - ref: messaging.destination.partition.id brief: > - "String representation of the partition id the message (or batch) is sent to or received from."" + String representation of the partition id the message (or batch) is sent to or received from. tag: tech-specific-kafka - ref: messaging.kafka.message.key tag: tech-specific-kafka