Skip to content

Commit

Permalink
review
Browse files Browse the repository at this point in the history
  • Loading branch information
@lmolkova
lmolkova committed Jul 29, 2023
1 parent dc6e3fe commit fec893f
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/messaging/messaging-metrics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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 |
Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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.

<!-- semconv metric.messaging.deliver.duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
Expand All @@ -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 |
Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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.

<!-- semconv metric.messaging.settle.duration(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
Expand All @@ -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. |
Expand Down Expand Up @@ -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 |
Expand Down

0 comments on commit fec893f

Please sign in to comment.