Micrometer 观测文档
本节描述 Micrometer 集成。
可观测性——指标
下面列出了本项目声明的所有指标。
Listener 观测
对 Rabbit listener 的观测。
指标名称 spring.rabbit.listener（由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention 定义）。类型 timer。
指标名称 spring.rabbit.listener.active（由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention 定义）。类型 long task timer。
在启动 Observation 之后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 nanoseconds 作为基本单位。不过，实际的基本单位由各后端决定（例如 Prometheus 使用秒）。
外围类名称为 RabbitListenerObservation。
表 1. 低基数 Keys
| 名称 | 描述 |
|---|---|
messaging.destination.name (required) | listener 所连接的队列。 |
spring.rabbit.listener.id (required) | Listener id。 |
Stream Listener 观测
对 Rabbit stream listener 的观测。
指标名称 spring.rabbit.stream.listener（由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention 定义）。类型 timer。
指标名称 spring.rabbit.stream.listener.active（由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention 定义）。类型 long task timer。
在启动 Observation 之后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 nanoseconds 作为基本单位。不过，实际的基本单位由各后端决定（例如 Prometheus 使用秒）。
外围类名称为 RabbitStreamListenerObservation。
所有标签都必须加上 spring.rabbit.stream.listener 前缀！
表 2. 低基数 Keys
| 名称 | 描述 |
|---|---|
spring.rabbit.stream.listener.id (required) | Listener id。 |
Stream Template 观测
对
RabbitStreamTemplate的观测。
指标名称 spring.rabbit.stream.template（由约定类 RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention 定义）。类型 timer。
指标名称 spring.rabbit.stream.template.active（由约定类 RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention 定义）。类型 long task timer。
在启动 Observation 之后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 nanoseconds 作为基本单位。不过，实际的基本单位由各后端决定（例如 Prometheus 使用秒）。
外围类名称为 RabbitStreamTemplateObservation。
所有标签都必须加上 spring.rabbit.stream.template 前缀！
表 3. 低基数 Keys
| 名称 | 描述 |
|---|---|
spring.rabbit.stream.template.name (required) | template 的 Bean 名称。 |
Template 观测
对 RabbitTemplate 的观测。
指标名称 spring.rabbit.template（由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention 定义）。类型 timer。
指标名称 spring.rabbit.template.active（由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention 定义）。类型 long task timer。
在启动 Observation 之后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 nanoseconds 作为基本单位。不过，实际的基本单位由各后端决定（例如 Prometheus 使用秒）。
外围类名称为 RabbitTemplateObservation。
表 4. 低基数 Keys
| 名称 | 描述 |
|---|---|
messaging.destination.name (required) | 目标 exchange（如果是默认 exchange 则为空）。 |
messaging.rabbitmq.destination.routing_key (required) | 目标 routing key。 |
spring.rabbit.template.name (required) | template 的 Bean 名称。 |
可观测性——Span
下面列出了本项目声明的所有 Span。
Listener 观测 Span
对 Rabbit listener 的观测。
Span 名称 spring.rabbit.listener（由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention 定义）。
外围类名称为 RabbitListenerObservation。
表 5. Tag Keys
| 名称 | 描述 |
|---|---|
messaging.destination.name (required) | listener 所连接的队列。 |
messaging.rabbitmq.message.delivery_tag (required) | delivery tag。 |
spring.rabbit.listener.id (required) | Listener id。 |
Stream Listener 观测 Span
对 Rabbit stream listener 的观测。
Span 名称 spring.rabbit.stream.listener（由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention 定义）。
外围类名称为 RabbitStreamListenerObservation。
所有标签都必须加上 spring.rabbit.stream.listener 前缀！
表 6. Tag Keys
| 名称 | 描述 |
|---|---|
spring.rabbit.stream.listener.id (required) | Listener id。 |
Stream Template 观测 Span
对
RabbitStreamTemplate的观测。
Span 名称 spring.rabbit.stream.template（由约定类 RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention 定义）。
外围类名称为 RabbitStreamTemplateObservation。
所有标签都必须加上 spring.rabbit.stream.template 前缀！
表 7. Tag Keys
| 名称 | 描述 |
|---|---|
spring.rabbit.stream.template.name (required) | template 的 Bean 名称。 |
Template 观测 Span
对 RabbitTemplate 的观测。
Span 名称 spring.rabbit.template（由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention 定义）。
外围类名称为 RabbitTemplateObservation。
表 8. Tag Keys
| 名称 | 描述 |
|---|---|
messaging.destination.name (required) | 目标 exchange（如果是默认 exchange 则为空）。 |
messaging.rabbitmq.destination.routing_key (required) | 目标 routing key。 |
spring.rabbit.template.name (required) | template 的 Bean 名称。 |
可观测性——约定
下面列出了本项目声明的所有 GlobalObservationConvention 和 ObservationConvention。
表 9. ObservationConvention 实现
| ObservationConvention 类名 | 适用的 ObservationContext 类名 |
|---|---|
RabbitListenerObservation | RabbitMessageReceiverContext |
RabbitListenerObservation.DefaultRabbitListenerObservationConvention | RabbitMessageReceiverContext |
RabbitListenerObservationConvention | RabbitMessageReceiverContext |
RabbitStreamMessageReceiverContext | RabbitMessageReceiverContext |
RabbitStreamMessageReceiverContext.DefaultRabbitListenerObservationConvention | RabbitMessageReceiverContext |
RabbitTemplateObservation | RabbitMessageSenderContext |
RabbitTemplateObservation.DefaultRabbitTemplateObservationConvention | RabbitMessageSenderContext |
RabbitTemplateObservationConvention | RabbitMessageSenderContext |
RabbitStreamListenerObservation | RabbitStreamMessageReceiverContext |
RabbitStreamListenerObservation.DefaultRabbitStreamListenerObservationConvention | RabbitStreamMessageReceiverContext |
RabbitStreamListenerObservationConvention | RabbitStreamMessageReceiverContext |
RabbitStreamTemplateObservation | RabbitStreamMessageSenderContext |
RabbitStreamTemplateObservation.DefaultRabbitStreamTemplateObservationConvention | RabbitStreamMessageSenderContext |
RabbitStreamTemplateObservationConvention | RabbitStreamMessageSenderContext |