RocketMQ 的语义约定

状态: 开发中

Apache RocketMQ 的语义约定扩展并覆盖了消息语义约定。

messaging.system 必须设置为 "rocketmq"，并且应该在创建 span 时提供。

Apache RocketMQ 属性

Apache RocketMQ 的特定属性定义如下。

Attributes

键	Stability	需求级别	Value Type	描述	Example Values
messaging.consumer.group.name		必需	字符串	RocketMQ 的消费者组名称。	my-group; indexer
messaging.operation.name		必需	字符串	消息操作的系统特定名称。	ack; nack; send
messaging.rocketmq.namespace		必需	字符串	RocketMQ 资源的命名空间，不同命名空间下的资源是独立的。	myNamespace
error.type		条件必需 仅当消息操作失败时。	字符串	描述操作最终结束的一类错误。[1]	amqp:decode-error; KAFKA_STORAGE_ERROR; channel-error
messaging.batch.message_count		有条件地必需 [2]	int	批处理操作范围内发送、接收或处理的消息数量。[3]	0; 1; 2
messaging.destination.name		有条件地必需 [4]	字符串	消息目标名称 [5]	MyQueue; MyTopic
messaging.operation.type		条件必需 如果适用。	字符串	一个识别消息操作类型的字符串。[6]	create; send; receive
messaging.rocketmq.message.delay_time_level		有条件地必需 [7]	int	延迟消息的延迟时间级别，它决定了消息的延迟时间。	3
messaging.rocketmq.message.delivery_timestamp		有条件地必需 [8]	int	延迟消息预计送达消费者的毫秒级时间戳。	1665987217045
messaging.rocketmq.message.group		条件必需 如果消息类型是 FIFO。	字符串	对于 FIFO 消息至关重要。属于同一消息组的消息在同一消费者组内总是逐条处理。	myMessageGroup
server.address		有条件必需 如果可用。	字符串	如果可用且无需反向 DNS 查找，则为服务器域名；否则，为 IP 地址或 Unix 域套接字名称。[9]	example.com；10.1.2.80；/tmp/my.sock
messaging.client.id		推荐	字符串	标识消耗或生成消息的客户端的唯一标识符。	client-5; myhost@8742@s8083jm
messaging.message.id		推荐 如果 span 描述的是单条消息的操作。	字符串	消息传递系统用作消息标识符的值，表示为字符串。	452a7c7c7c7048c2f887f61572b18fc2
messaging.rocketmq.consumption_model		推荐	字符串	消息的消费模式。这仅适用于消费者 span。	clustering; broadcasting
messaging.rocketmq.message.keys		推荐	string[]	消息的键，除了消息 ID 之外标记消息的另一种方式。	["keyA", "keyB"]
messaging.rocketmq.message.tag		推荐	字符串	除了主题之外，消息的二级分类器。	tagA
messaging.rocketmq.message.type		推荐	字符串	消息的类型。	normal; fifo; delay
server.port		推荐	int	服务器端口号。[10]	80; 8080; 443
messaging.message.body.size		选择加入	int	消息体的字节大小。[11]	1439

[1] error.type： error.type 应该可预测，并且应该具有低基数性。

当 error.type 设置为某个类型（例如，异常类型）时，应该使用该工件内识别类型的规范类名。

Instrumentations 应该记录它们报告的错误列表。

一个仪器库内的 error.type 基数性应该低。从多个仪器库和应用程序聚合数据的遥测消费者，在没有额外过滤时，应准备好 error.type 在查询时具有高基数性。

如果操作已成功完成，Instrumentations 不应设置 error.type。

如果特定域定义了自己的一组错误标识符（例如 HTTP 或 gRPC 状态码），则建议

• 使用特定于域的属性
• 设置 error.type 以捕获所有错误，无论它们是否包含在特定于域的集合中。

[2] messaging.batch.message_count: 如果 span 描述的是一个消息批次的操作。

[3] messaging.batch.message_count: Instrumentation 不应该在操作单个消息的 span 上设置 messaging.batch.message_count。当消息客户端库为相同的操作支持批量和单消息 API 时，Instrumentation 应该为批量 API 使用 messaging.batch.message_count，而不应为单消息 API 使用它。

[4] messaging.destination.name: 如果 span 描述的是对单个消息的操作，或者该值适用于批次中的所有消息。

[5] messaging.destination.name: 目标名称应唯一标识代理中的特定队列、主题或其他实体。如果代理没有此类概念，则目标名称应唯一标识代理。

[6] messaging.operation.type: 如果使用自定义值，它必须是低基数的。

[7] messaging.rocketmq.message.delay_time_level: 如果消息类型是延迟消息且未指定送达时间戳。

[8] messaging.rocketmq.message.delivery_timestamp: 如果消息类型是延迟消息且未指定延迟时间级别。

[9] server.address: 如果可用且无需反向 DNS 查找，则为代理的服务器域名；否则，为 IP 地址或 Unix 域套接字名称。

[10] server.port: 当从客户端观察到并且通过中间件通信时，server.port 应代表任何中间件（例如代理）之后的服务器端口，如果可用。

[11] messaging.message.body.size: 这可以指压缩或未压缩的消息体大小。如果两种大小都已知，应使用未压缩的消息体大小。

以下属性对于做出采样决策可能很重要，并且应在跨度创建时提供（如果提供的话）

• messaging.consumer.group.name
• messaging.destination.name
• messaging.operation.name
• messaging.operation.type
• server.address
• server.port

error.type 具有以下已知值列表。如果其中一个适用，则必须使用相应的值；否则，可以使用自定义值。

值	描述	Stability
_OTHER	当检测不到自定义值时使用的回退错误值。

messaging.operation.type 具有以下一系列已知值。如果适用其中一个，则必须使用相应的值；否则，可以使用自定义值。

值	描述	Stability
create	创建消息。“Create”跨度始终指单条消息，用于为批量发送场景中的消息提供唯一的创建上下文。
process	一个或多个消息由消费者处理。
receive	一个或多个消息由消费者请求。此操作指拉取式场景，其中消费者显式调用消息 SDK 的方法来接收消息。
send	提供一个或多个消息以发送到中介。如果发送了单条消息，“Send”跨度的上下文可用作创建上下文，无需创建“Create”跨度。
settle	一个或多个消息已结算。

messaging.rocketmq.consumption_model 具有以下已知值列表。如果其中一个适用，则必须使用相应的值；否则，可以改用自定义值。

值	描述	Stability
broadcasting	广播消费模式
clustering	集群消费模式

messaging.rocketmq.message.type 具有以下已知值列表。如果其中一个适用，则必须使用相应的值；否则，可以改用自定义值。

值	描述	Stability
delay	延迟消息
fifo	FIFO 消息
normal	普通消息
transaction	事务消息

messaging.client.id 应设置为 Apache RocketMQ SDK 自动生成的客户端 ID。