From 86ee3c9823f281ceceec179313f5fcb798eb88e3 Mon Sep 17 00:00:00 2001 From: Liudmila Molkova Date: Fri, 3 May 2024 22:10:37 -0700 Subject: [PATCH] lint --- docs/messaging/messaging-metrics.md | 14 ++--- docs/messaging/messaging-spans.md | 4 +- model/messaging-common.yaml | 1 - .../messaging-metrics-deprecated.yaml | 60 ------------------- .../metrics/deprecated/messaging-metrics.yaml | 2 +- 5 files changed, 9 insertions(+), 72 deletions(-) delete mode 100644 model/metrics/deprecated/messaging-metrics-deprecated.yaml diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md index 6749db3d5c..ad4afe0ae8 100644 --- a/docs/messaging/messaging-metrics.md +++ b/docs/messaging/messaging-metrics.md @@ -7,14 +7,12 @@ - [Common attributes](#common-attributes) +- [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.process.duration`](#metric-messagingprocessduration) - - [Metric: `messaging.process.messages`](#metric-messagingprocessmessages) + - [Metric: `messaging.client.consumed.messages`](#metric-messagingclientconsumedmessages) + - [Metric: `messaging.consumer.process.duration`](#metric-messagingconsumerprocessduration) @@ -101,7 +99,7 @@ This metric is [required][MetricRequired]. When this metric is reported alongside a messaging span, the metric value SHOULD be the same as the corresponding span duration. This metric applies measures duration of operations that application initiates to communicate with the broker. It SHOULD NOT be used -to report processing duration. Processing is covered by [`messaging.consumer.process.duration`](#metric-messagingprocessduration) metric. +to report processing duration. Processing is covered by [`messaging.consumer.process.duration`](#metric-messagingconsumerprocessduration) metric. This metric SHOULD be specified with [`ExplicitBucketBoundaries`](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/metrics/api.md#instrument-advice) @@ -152,7 +150,7 @@ _Note: The need to report `messaging.client.consumed.messages` depends on the me 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. -Processing operation covers application-specific message processing logic and errors. Processing duration SHOULD NOT be reported as a part of the [`messaging.consumer.process.duration`](#metric-messagingclientoperationduration). +Processing operation covers application-specific message processing logic and errors. Processing duration SHOULD NOT be reported as a part of the [`messaging.client.operation.duration`](#metric-messagingclientoperationduration). When this metric is reported alongside a messaging process span, the metric value SHOULD be the same as the corresponding span duration. diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index f268758282..651b1eabd6 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -18,7 +18,7 @@ - [Conventions](#conventions) - [Context propagation](#context-propagation) - [Span name](#span-name) - - [Operation types](#operation-types) + - [Common messaging operations](#common-messaging-operations) - [Span kind](#span-kind) - [Trace structure](#trace-structure) - [Producer spans](#producer-spans) @@ -157,7 +157,7 @@ Messaging spans MUST follow the overall [guidelines for span names](https://gith -The **span name** SHOULD be `{messaging.operation.name} {destination}` (see below for the exact definition of the [`{target}`](#target-placeholder) placeholder). +The **span name** SHOULD be `{messaging.operation.name} {destination}` (see below for the exact definition of the [`{destination}`](#destination-placeholder) placeholder). 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). diff --git a/model/messaging-common.yaml b/model/messaging-common.yaml index 6e9348ca20..5923a929d7 100644 --- a/model/messaging-common.yaml +++ b/model/messaging-common.yaml @@ -19,4 +19,3 @@ groups: - ref: server.port - ref: messaging.operation.name requirement_level: required - diff --git a/model/metrics/deprecated/messaging-metrics-deprecated.yaml b/model/metrics/deprecated/messaging-metrics-deprecated.yaml deleted file mode 100644 index f50a3083e4..0000000000 --- a/model/metrics/deprecated/messaging-metrics-deprecated.yaml +++ /dev/null @@ -1,60 +0,0 @@ -groups: - - id: metric.messaging.process.duration - type: metric - metric_name: messaging.process.duration - brief: "Deprecated. Use `messaging.consumer.process.duration` instead." - deprecated: "Replaced by `messaging.consumer.process.duration`." - stability: experimental - instrument: histogram - unit: "s" - extends: metric.messaging.attributes - - - 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: metric.messaging.attributes - - - 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: metric.messaging.attributes - - - 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: metric.messaging.attributes - - - id: metric.messaging.publish.messages - type: metric - metric_name: messaging.publish.messages - brief: "Deprecated. Use `messaging.client.published.messages` instead." - deprecated: "Replaced by `messaging.client.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: "Deprecated. Use `messaging.client.consumed.messages` instead." - deprecated: "Replaced by `messaging.client.consumed.messages`." - stability: experimental - instrument: counter - unit: "{message}" - extends: metric.messaging.attributes \ No newline at end of file diff --git a/model/metrics/deprecated/messaging-metrics.yaml b/model/metrics/deprecated/messaging-metrics.yaml index f50a3083e4..3862796b0e 100644 --- a/model/metrics/deprecated/messaging-metrics.yaml +++ b/model/metrics/deprecated/messaging-metrics.yaml @@ -57,4 +57,4 @@ groups: stability: experimental instrument: counter unit: "{message}" - extends: metric.messaging.attributes \ No newline at end of file + extends: metric.messaging.attributes