From a7624f6831790723dd1a18020939ad036ef3301e Mon Sep 17 00:00:00 2001 From: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com> Date: Tue, 10 Dec 2024 17:10:11 +0100 Subject: [PATCH] PR review --- docs/attributes-registry/messaging.md | 4 ++-- docs/messaging/azure-messaging.md | 8 ++++---- docs/messaging/gcp-pubsub.md | 4 ++-- docs/messaging/kafka.md | 4 ++-- docs/messaging/messaging-metrics.md | 16 ++++++++-------- docs/messaging/messaging-spans.md | 9 +++++---- docs/messaging/rabbitmq.md | 4 ++-- docs/messaging/rocketmq.md | 4 ++-- model/messaging/registry.yaml | 5 +---- 9 files changed, 28 insertions(+), 30 deletions(-) diff --git a/docs/attributes-registry/messaging.md b/docs/attributes-registry/messaging.md index 010682a38d..b21661f4df 100644 --- a/docs/attributes-registry/messaging.md +++ b/docs/attributes-registry/messaging.md @@ -42,8 +42,8 @@ Attributes describing telemetry around messaging systems and messaging activitie **[2] `messaging.consumer.group.name`:** Semantic conventions for individual messaging systems SHOULD document whether `messaging.consumer.group.name` is applicable and what it means in the context of that system. -**[3] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[3] `messaging.destination.name`:** 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] `messaging.destination.subscription.name`:** Semantic conventions for individual messaging systems SHOULD document whether `messaging.destination.subscription.name` is applicable and what it means in the context of that system. diff --git a/docs/messaging/azure-messaging.md b/docs/messaging/azure-messaging.md index 2f393821eb..2bae085ae8 100644 --- a/docs/messaging/azure-messaging.md +++ b/docs/messaging/azure-messaging.md @@ -101,8 +101,8 @@ it's RECOMMENDED to: **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. -**[5] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[5] `messaging.destination.name`:** 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] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. @@ -224,8 +224,8 @@ it's RECOMMENDED to: **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. -**[5] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[5] `messaging.destination.name`:** 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] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. diff --git a/docs/messaging/gcp-pubsub.md b/docs/messaging/gcp-pubsub.md index 3711f83126..e372374e12 100644 --- a/docs/messaging/gcp-pubsub.md +++ b/docs/messaging/gcp-pubsub.md @@ -98,8 +98,8 @@ it's RECOMMENDED to: **[4] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. -**[5] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[5] `messaging.destination.name`:** 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] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. diff --git a/docs/messaging/kafka.md b/docs/messaging/kafka.md index 2dec9b746b..cb45185042 100644 --- a/docs/messaging/kafka.md +++ b/docs/messaging/kafka.md @@ -99,8 +99,8 @@ it's RECOMMENDED to: **[3] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. -**[4] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[4] `messaging.destination.name`:** 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. **[5] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md index b92f3faee7..87e6ff8467 100644 --- a/docs/messaging/messaging-metrics.md +++ b/docs/messaging/messaging-metrics.md @@ -107,8 +107,8 @@ it's RECOMMENDED to: **[3] `messaging.consumer.group.name`:** Semantic conventions for individual messaging systems SHOULD document whether `messaging.consumer.group.name` is applicable and what it means in the context of that system. -**[4] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[4] `messaging.destination.name`:** 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. **[5] `messaging.destination.name`:** if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated. @@ -217,8 +217,8 @@ 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] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[3] `messaging.destination.name`:** 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] `messaging.destination.name`:** if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated. @@ -316,8 +316,8 @@ it's RECOMMENDED to: **[3] `messaging.consumer.group.name`:** Semantic conventions for individual messaging systems SHOULD document whether `messaging.consumer.group.name` is applicable and what it means in the context of that system. -**[4] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[4] `messaging.destination.name`:** 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. **[5] `messaging.destination.name`:** if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated. @@ -420,8 +420,8 @@ it's RECOMMENDED to: **[3] `messaging.consumer.group.name`:** Semantic conventions for individual messaging systems SHOULD document whether `messaging.consumer.group.name` is applicable and what it means in the context of that system. -**[4] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[4] `messaging.destination.name`:** 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. **[5] `messaging.destination.name`:** if and only if `messaging.destination.name` is known to have low cardinality. Otherwise, `messaging.destination.template` MAY be populated. diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index 0b48491663..13cf0114f4 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -207,10 +207,11 @@ and SHOULD adhere to one of the following values, provided they are accessible: 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). +4. The placeholder `(temporary)` SHOULD be used when the destination is [temporary or anonymous](#temporary-and-anonymous-destinations) + and neither `messaging.destination.template` or `server.address:server.port` are available. If a `{destination}` value is not available, the instrumentation -SHOULD omit the `{destination}` from the span name. The same applies for -[temporary or anonymous](#temporary-and-anonymous-destinations) destinations. +SHOULD omit the `{destination}` from the span name. Examples: @@ -424,8 +425,8 @@ it's RECOMMENDED to: **[6] `messaging.destination.anonymous`:** If value is `true`. When missing, the value is assumed to be `false`. -**[7] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[7] `messaging.destination.name`:** 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] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. diff --git a/docs/messaging/rabbitmq.md b/docs/messaging/rabbitmq.md index 9e82117a83..2e00ee1954 100644 --- a/docs/messaging/rabbitmq.md +++ b/docs/messaging/rabbitmq.md @@ -86,8 +86,8 @@ 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. -**[2] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[2] `messaging.destination.name`:** 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. **[3] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. diff --git a/docs/messaging/rocketmq.md b/docs/messaging/rocketmq.md index 9de67d0f8e..e4380657af 100644 --- a/docs/messaging/rocketmq.md +++ b/docs/messaging/rocketmq.md @@ -95,8 +95,8 @@ it's RECOMMENDED to: **[3] `messaging.batch.message_count`:** If the span describes an operation on a batch of messages. -**[4] `messaging.destination.name`:** 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. -If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, `messaging.destination.name` SHOULD be set to `(temporary)`. +**[4] `messaging.destination.name`:** 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. **[5] `messaging.destination.name`:** If span describes operation on a single message or if the value applies to all messages in the batch. diff --git a/model/messaging/registry.yaml b/model/messaging/registry.yaml index 3a9bff8b4d..74f0471838 100644 --- a/model/messaging/registry.yaml +++ b/model/messaging/registry.yaml @@ -33,12 +33,9 @@ groups: type: string stability: experimental brief: 'The message destination name' - note: > + note: | 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. - - If `messaging.destination.anonymous` or `messaging.destination.temporary` is set to true, - `messaging.destination.name` SHOULD be set to `(temporary)`. examples: ['MyQueue', 'MyTopic'] - id: messaging.destination.subscription.name type: string