From 070b2617f5f6969367d94add3b4950cc69eb761b Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Thu, 14 Mar 2024 15:17:11 -0700 Subject: [PATCH] sync with suggested changes on the db semconv --- docs/messaging/messaging-spans.md | 5 ++--- docs/messaging/rabbitmq.md | 2 +- model/trace/messaging.yaml | 7 ++----- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index a3955ebefe..e4cc45f60d 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -294,7 +294,7 @@ as described in [Attributes specific to certain messaging systems](#attributes-s | [`messaging.message.id`](../attributes-registry/messaging.md) | string | A value used by the messaging system as an identifier for the message, represented as a string. | `452a7c7c7c7048c2f887f61572b18fc2` | Recommended | | [`messaging.operation`](../attributes-registry/messaging.md) | string | A string identifying the kind of messaging operation. [13] | `publish` | Required | | [`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.peer.address`](../attributes-registry/network.md) | string | Peer address of the messaging intermediary node operation was performed on. [14] | `10.1.2.80`; `/tmp/my.sock` | Recommended: If applicable for this messaging system. | +| [`network.peer.address`](../attributes-registry/network.md) | string | Peer address of the messaging intermediary node where the operation was performed. [14] | `10.1.2.80`; `/tmp/my.sock` | Recommended: If applicable for this messaging system. | | [`network.peer.port`](../attributes-registry/network.md) | int | Peer port number of the network connection. | `65123` | Recommended: if and only if `network.peer.address` is set. | | [`server.address`](../attributes-registry/server.md) | string | Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [15] | `example.com`; `10.1.2.80`; `/tmp/my.sock` | Conditionally Required: If available. | | [`server.port`](../attributes-registry/server.md) | int | Server port number. [16] | `80`; `8080`; `443` | Recommended | @@ -343,8 +343,7 @@ size should be used. **[13]:** If a custom value is used, it MUST be of low cardinality. **[14]:** 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, for example, when messaging intermediary is self-hosted. -Instrumentations for messaging systems that don't provide self-hosted mode SHOULD NOT set this attribute. +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. **[15]:** Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. diff --git a/docs/messaging/rabbitmq.md b/docs/messaging/rabbitmq.md index e2d1b095ca..362fd162a8 100644 --- a/docs/messaging/rabbitmq.md +++ b/docs/messaging/rabbitmq.md @@ -22,7 +22,7 @@ In RabbitMQ, the destination is defined by an *exchange* and a *routing key*. |---|---|---|---|---| | [`messaging.rabbitmq.destination.routing_key`](../attributes-registry/messaging.md) | string | RabbitMQ message routing key. | `myKey` | Conditionally Required: If not empty. | | [`messaging.rabbitmq.message.delivery_tag`](../attributes-registry/messaging.md) | int | RabbitMQ message delivery tag | `123` | Conditionally Required: When available. | -| [`network.peer.address`](../attributes-registry/network.md) | string | Peer address of the messaging intermediary node operation was performed on. [1] | `10.1.2.80`; `/tmp/my.sock` | Recommended | +| [`network.peer.address`](../attributes-registry/network.md) | string | Peer address of the messaging intermediary node where the operation was performed. [1] | `10.1.2.80`; `/tmp/my.sock` | Recommended | | [`network.peer.port`](../attributes-registry/network.md) | int | Peer port number of the network connection. | `65123` | Recommended | **[1]:** If an operation involved multiple network calls (for example retries), the address of the last contacted node SHOULD be used. diff --git a/model/trace/messaging.yaml b/model/trace/messaging.yaml index a6ef5d92a6..88759eb3f8 100644 --- a/model/trace/messaging.yaml +++ b/model/trace/messaging.yaml @@ -81,16 +81,13 @@ groups: - ref: messaging.message.envelope.size - ref: messaging.message.body.size - ref: network.peer.address - brief: Peer address of the messaging intermediary node operation was performed on. + brief: Peer address of the messaging intermediary node where the operation was performed. requirement_level: recommended: If applicable for this messaging system. note: > 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, - for example, when messaging intermediary is self-hosted. - - Instrumentations for messaging systems that don't provide self-hosted mode SHOULD NOT set this attribute. + 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. - ref: network.peer.port