diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md index 6f0d6c9659..2f68b2212f 100644 --- a/docs/messaging/messaging-metrics.md +++ b/docs/messaging/messaging-metrics.md @@ -25,7 +25,7 @@ This metric is [required][MetricRequired]. -When this metric is reported alongside an messaging publish span, the metric value SHOULD be the same as the corresponding span duration. +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.21.0/specification/metrics/api.md#instrument-advice) @@ -41,7 +41,7 @@ of `[ 0, 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | | [`network.protocol.name`](../general/attributes.md) | string | [OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `amqp`; `mqtt` | Recommended | @@ -89,7 +89,7 @@ For example, RabbitMQ does not support batch publishing and corresponding instru | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | | [`network.protocol.name`](../general/attributes.md) | string | [OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `amqp`; `mqtt` | Recommended | @@ -138,7 +138,7 @@ When this metric is reported alongside a messaging receive span, the metric valu | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | | [`network.protocol.name`](../general/attributes.md) | string | [OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `amqp`; `mqtt` | Recommended | @@ -185,7 +185,7 @@ _Note: The need to report `messaging.receive.messages` depends on the messaging | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | | [`network.protocol.name`](../general/attributes.md) | string | [OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `amqp`; `mqtt` | Recommended | @@ -220,7 +220,7 @@ the broker does not have such notion, the destination name SHOULD uniquely ident This metric is [required][MetricRequired] when messaging system supports push-based deliver operations. -When this metric is reported alongside an messaging deliver span, the metric value SHOULD be the same as the corresponding span duration. +When this metric is reported alongside a messaging deliver span, the metric value SHOULD be the same as the corresponding span duration. | Name | Instrument Type | Unit (UCUM) | Description | @@ -232,7 +232,7 @@ When this metric is reported alongside an messaging deliver span, the metric val | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | | [`network.protocol.name`](../general/attributes.md) | string | [OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `amqp`; `mqtt` | Recommended | @@ -279,7 +279,7 @@ _Note: The need to report `messaging.deliver.messages` depends on the messaging | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | | [`network.protocol.name`](../general/attributes.md) | string | [OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `amqp`; `mqtt` | Recommended | @@ -314,7 +314,7 @@ the broker does not have such notion, the destination name SHOULD uniquely ident This metric is [required][MetricRequired] when messaging system supports settle operations. -When this metric is reported alongside an messaging settle span, the metric value SHOULD be the same as the corresponding span duration. +When this metric is reported alongside a messaging settle span, the metric value SHOULD be the same as the corresponding span duration. | Name | Instrument Type | Unit (UCUM) | Description | @@ -326,7 +326,7 @@ When this metric is reported alongside an messaging settle span, the metric valu | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.todo_settlement.status` | string | The status of the settlement: acknowledged, rejected, TODO | `ack`; `nack` | Recommended | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | @@ -375,7 +375,7 @@ _Note: The need to report `messaging.settle.messages` depends on the messaging s | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `messaging.system` | string | A string identifying the messaging system. | `kafka`; `rabbitmq`; `rocketmq`; `activemq`; `AmazonSQS` | Required | -| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR`; `TIMEOUT` | Required | +| `messaging.status.code` | string | The status of the operation. [1] | `OK`; `ERROR` | Required | | `messaging.destination.name` | string | The message destination name [2] | `MyQueue`; `MyTopic` | Conditionally Required: [3] | | `messaging.destination.template` | string | Low cardinality representation of the messaging destination name [4] | `/customers/{customerId}` | Conditionally Required: if available. | | [`network.protocol.name`](../general/attributes.md) | string | [OSI Application Layer](https://osi-model.com/application-layer/) or non-OSI equivalent. The value SHOULD be normalized to lowercase. | `amqp`; `mqtt` | Recommended |