Semantic Conventions for RocketMQ

Status: Experimental

The Semantic Conventions for Apache RocketMQ extend and override the Messaging Semantic Conventions.

messaging.system MUST be set to "rocketmq" and SHOULD be provided at span creation time.

Apache RocketMQ attributes

Specific attributes for Apache RocketMQ are defined below.

AttributeTypeDescriptionExamplesRequirement LevelStability
messaging.consumer.group.namestringRocketMQ consumer group name.my-group; indexerRequiredExperimental
messaging.operation.namestringThe system-specific name of the messaging operation.ack; nack; sendRequiredExperimental
messaging.rocketmq.namespacestringNamespace of RocketMQ resources, resources in different namespaces are individual.myNamespaceRequiredExperimental
error.typestringDescribes a class of error the operation ended with. [1]amqp:decode-error; KAFKA_STORAGE_ERROR; channel-errorConditionally Required If and only if the messaging operation has failed.Stable
messaging.batch.message_countintThe number of messages sent, received, or processed in the scope of the batching operation. [2]0; 1; 2Conditionally Required [3]Experimental
messaging.destination.namestringThe message destination name [4]MyQueue; MyTopicConditionally Required [5]Experimental
messaging.operation.typestringA string identifying the type of the messaging operation. [6]send; create; receiveConditionally Required If applicable.Experimental
messaging.rocketmq.message.delay_time_levelintThe delay time level for delay message, which determines the message delay time.3Conditionally Required [7]Experimental
messaging.rocketmq.message.delivery_timestampintThe timestamp in milliseconds that the delay message is expected to be delivered to consumer.1665987217045Conditionally Required [8]Experimental
messaging.rocketmq.message.groupstringIt is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group.myMessageGroupConditionally Required If the message type is FIFO.Experimental
server.addressstringServer domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. [9]example.com; 10.1.2.80; /tmp/my.sockConditionally Required If available.Stable
messaging.client.idstringA unique identifier for the client that consumes or produces a message.client-5; myhost@8742@s8083jmRecommendedExperimental
messaging.message.idstringA value used by the messaging system as an identifier for the message, represented as a string.452a7c7c7c7048c2f887f61572b18fc2Recommended If span describes operation on a single message.Experimental
messaging.rocketmq.consumption_modelstringModel of message consumption. This only applies to consumer spans.clustering; broadcastingRecommendedExperimental
messaging.rocketmq.message.keysstring[]Key(s) of message, another way to mark message besides message id.["keyA", "keyB"]RecommendedExperimental
messaging.rocketmq.message.tagstringThe secondary classifier of message besides topic.tagARecommendedExperimental
messaging.rocketmq.message.typestringType of message.normal; fifo; delayRecommendedExperimental
server.portintServer port number. [10]80; 8080; 443RecommendedStable
messaging.message.body.sizeintThe size of the message body in bytes. [11]1439Opt-InExperimental

[1]: The error.type SHOULD be predictable, and SHOULD have low cardinality.

When error.type is set to a type (e.g., an exception type), its canonical class name identifying the type within the artifact SHOULD be used.

Instrumentations SHOULD document the list of errors they report.

The cardinality of error.type within one instrumentation library SHOULD be low. Telemetry consumers that aggregate data from multiple instrumentation libraries and applications should be prepared for error.type to have high cardinality at query time when no additional filters are applied.

If the operation has completed successfully, instrumentations SHOULD NOT set error.type.

If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), it’s RECOMMENDED to:

  • Use a domain-specific attribute
  • Set error.type to capture all errors, regardless of whether they are defined within the domain-specific set or not.

[2]: Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs.

[3]: If the span describes an operation on a batch of messages.

[4]: Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If the broker doesn’t have such notion, the destination name SHOULD uniquely identify the broker.

[5]: If span describes operation on a single message or if the value applies to all messages in the batch.

[6]: If a custom value is used, it MUST be of low cardinality.

[7]: If the message type is delay and delivery timestamp is not specified.

[8]: If the message type is delay and delay time level is not specified.

[9]: Server domain name of the broker if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.

[10]: When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it’s available.

[11]: This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed body size should be used.

The following attributes can be important for making sampling decisions and SHOULD be provided at span creation time (if provided at all):

error.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

ValueDescriptionStability
_OTHERA fallback error value to be used when the instrumentation doesn’t define a custom value.Stable

messaging.operation.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

ValueDescriptionStability
createA message is created. “Create” spans always refer to a single message and are used to provide a unique creation context for messages in batch sending scenarios.Experimental
processOne or more messages are processed by a consumer.Experimental
receiveOne or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages.Experimental
sendOne or more messages are provided for sending to an intermediary. If a single message is sent, the context of the “Send” span can be used as the creation context and no “Create” span needs to be created.Experimental
settleOne or more messages are settled.Experimental

messaging.rocketmq.consumption_model has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

ValueDescriptionStability
broadcastingBroadcasting consumption modelExperimental
clusteringClustering consumption modelExperimental

messaging.rocketmq.message.type has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

ValueDescriptionStability
delayDelay messageExperimental
fifoFIFO messageExperimental
normalNormal messageExperimental
transactionTransaction messageExperimental

messaging.client.id SHOULD be set to the client ID that is automatically generated by the Apache RocketMQ SDK.