56 lines
4.5 KiB
Markdown
56 lines
4.5 KiB
Markdown
<!--- Hugo front matter used to generate the website version of this page:
|
|
linkTitle: RocketMQ
|
|
--->
|
|
|
|
# Semantic Conventions for RocketMQ
|
|
|
|
**Status**: [Experimental][DocumentStatus]
|
|
|
|
The Semantic Conventions for [Apache RocketMQ](https://rocketmq.apache.org/) extend and override the [Messaging Semantic Conventions](README.md)
|
|
that describe common messaging operations attributes in addition to the Semantic Conventions
|
|
described on this page.
|
|
|
|
`messaging.system` MUST be set to `"rocketmq"`.
|
|
|
|
## Apache RocketMQ attributes
|
|
|
|
Specific attributes for Apache RocketMQ are defined below.
|
|
|
|
<!-- semconv messaging.rocketmq(full,tag=tech-specific) -->
|
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
|
|---|---|---|---|---|---|
|
|
| [`messaging.rocketmq.client_group`](../attributes-registry/messaging.md) | string | Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind. | `myConsumerGroup` | `Required` |  |
|
|
| [`messaging.rocketmq.namespace`](../attributes-registry/messaging.md) | string | Namespace of RocketMQ resources, resources in different namespaces are individual. | `myNamespace` | `Required` |  |
|
|
| [`messaging.rocketmq.message.delay_time_level`](../attributes-registry/messaging.md) | int | The delay time level for delay message, which determines the message delay time. | `3` | `Conditionally Required` [1] |  |
|
|
| [`messaging.rocketmq.message.delivery_timestamp`](../attributes-registry/messaging.md) | int | The timestamp in milliseconds that the delay message is expected to be delivered to consumer. | `1665987217045` | `Conditionally Required` [2] |  |
|
|
| [`messaging.rocketmq.message.group`](../attributes-registry/messaging.md) | string | It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group. | `myMessageGroup` | `Conditionally Required` If the message type is FIFO. |  |
|
|
| [`messaging.rocketmq.consumption_model`](../attributes-registry/messaging.md) | string | Model of message consumption. This only applies to consumer spans. | `clustering` | `Recommended` |  |
|
|
| [`messaging.rocketmq.message.keys`](../attributes-registry/messaging.md) | string[] | Key(s) of message, another way to mark message besides message id. | `[keyA, keyB]` | `Recommended` |  |
|
|
| [`messaging.rocketmq.message.tag`](../attributes-registry/messaging.md) | string | The secondary classifier of message besides topic. | `tagA` | `Recommended` |  |
|
|
| [`messaging.rocketmq.message.type`](../attributes-registry/messaging.md) | string | Type of message. | `normal` | `Recommended` |  |
|
|
|
|
**[1]:** If the message type is delay and delivery timestamp is not specified.
|
|
|
|
**[2]:** If the message type is delay and delay time level is not specified.
|
|
|
|
`messaging.rocketmq.consumption_model` MUST be one of the following:
|
|
|
|
| Value | Description | Stability |
|
|
|---|---|---|
|
|
| `clustering` | Clustering consumption model |  |
|
|
| `broadcasting` | Broadcasting consumption model |  |
|
|
|
|
`messaging.rocketmq.message.type` MUST be one of the following:
|
|
|
|
| Value | Description | Stability |
|
|
|---|---|---|
|
|
| `normal` | Normal message |  |
|
|
| `fifo` | FIFO message |  |
|
|
| `delay` | Delay message |  |
|
|
| `transaction` | Transaction message |  |
|
|
<!-- endsemconv -->
|
|
|
|
`messaging.client_id` SHOULD be set to the client ID that is automatically generated by the Apache RocketMQ SDK.
|
|
|
|
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/document-status.md
|