Micrometer 观测文档
本节介绍 Micrometer 的集成。
可观测性 - 指标
以下您可以找到由该项目声明的所有指标列表。
监听器观察
对 Rabbit 监听器的观察。
指标名称 spring.rabbit.listener
(由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention
定义)。类型 timer
。
指标名称 spring.rabbit.listener.active
(由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention
定义)。类型 long task timer
。
在开始观察后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 纳秒
作为基本单位。然而,每个后端决定了实际的基本单位。(例如,Prometheus 使用秒)
封闭类的名称 RabbitListenerObservation
。
表 1. 低基数键
名称 | 描述 |
---|---|
messaging.destination.name (必填) | 监听器所连接的队列。 |
messaging.rabbitmq.message.delivery_tag (必填) | 交付标签。弃用后,此键不再作为低基数标签暴露。 |
spring.rabbit.listener.id (必填) | 监听器 ID。 |
流监听器观测
针对 Rabbit 流监听器的观察。
指标名称 spring.rabbit.stream.listener
(由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention
定义)。类型 timer
。
指标名称 spring.rabbit.stream.listener.active
(由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention
定义)。类型 long task timer
。
在开始观测后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 纳秒
作为基本单位。然而,每个后端决定实际的基本单位。(例如,Prometheus 使用秒)
封闭类的名称 RabbitStreamListenerObservation
。
:::重要
所有标签都必须以 spring.rabbit.stream.listener
为前缀!
:::
表 2. 低基数键
名称 | 描述 |
---|---|
spring.rabbit.stream.listener.id (必填) | 监听器 ID。 |
流模板观察
对
RabbitStreamTemplate
的观察。
指标名称 spring.rabbit.stream.template
(由约定类 RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention
定义)。类型 timer
。
指标名称 spring.rabbit.stream.template.active
(由约定类 RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention
定义)。类型 long task timer
。
在开始观测后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 纳秒
作为基本单位。然而,每个后端决定实际的基本单位。(例如,Prometheus 使用秒)
所属类的名称 RabbitStreamTemplateObservation
。
所有标签都必须以 spring.rabbit.stream.template
前缀开头!
表 3. 低基数键
名称 | 描述 |
---|---|
spring.rabbit.stream.template.name (必填) | 模板的 Bean 名称。 |
模板观测
对 RabbitTemplate 的观察。
指标名称 spring.rabbit.template
(由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention
定义)。类型 timer
。
指标名称 spring.rabbit.template.active
(由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention
定义)。类型 long task timer
。
在开始观察后添加的 KeyValues 可能会在 *.active 指标中缺失。
Micrometer 内部使用 纳秒
作为基本单位。然而,每个后端决定实际的基本单位。(例如,Prometheus 使用秒)
封闭类 RabbitTemplateObservation
的名称。
表 4. 低基数键
名称 | 描述 |
---|---|
messaging.destination.name (必填) | 目标交换器(如果使用默认交换器则为空)。 |
messaging.rabbitmq.destination.routing_key (必填) | 目标路由键。 |
spring.rabbit.template.name (必填) | 模板的 Bean 名称。 |
可观测性 - 跨度
以下列出了该项目声明的所有 spans。
监听器观察跨度
针对 Rabbit 监听器的观察。
Span 名称 spring.rabbit.listener
(由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention
定义)。
所属类的名称 RabbitListenerObservation
。
表 5. 标签键
名称 | 描述 |
---|---|
messaging.destination.name (必填) | 监听器所连接的队列。 |
messaging.rabbitmq.message.delivery_tag (必填) | 投递标签。弃用后,此键不再作为低基数标签暴露。 |
messaging.rabbitmq.message.delivery_tag (必填) | 投递标签。 |
spring.rabbit.listener.id (必填) | 监听器 ID。 |
流监听器观察跨度
对 Rabbit 流监听者的观察。
Span 名称 spring.rabbit.stream.listener
(由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention
定义)。
封闭类的名称 RabbitStreamListenerObservation
。
所有标签必须以 spring.rabbit.stream.listener
前缀开头!
表 6. 标签键
名称 | 描述 |
---|---|
spring.rabbit.stream.listener.id (必填) | 监听器 ID。 |
Stream Template 观察跨度
对 `RabbitStreamTemplate` 的观察。
Span 名称 spring.rabbit.stream.template
(由约定类 RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention
定义)。
所属类的名称 RabbitStreamTemplateObservation
。
所有标签必须以 spring.rabbit.stream.template
前缀开头!
表 7. 标签键
名称 | 描述 |
---|---|
spring.rabbit.stream.template.name (必填) | 模板的 Bean 名称。 |
模板观察跨度
对 RabbitTemplates 的观察。
Span 名称 spring.rabbit.template
(由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention
定义)。
封闭类的名称 RabbitTemplateObservation
。
表 8. 标签键
名称 | 描述 |
---|---|
messaging.destination.name (必填) | 目标交换器(如果使用默认交换器则为空)。 |
messaging.rabbitmq.destination.routing_key (必填) | 目标路由键。 |
spring.rabbit.template.name (必填) | 模板的 Bean 名称。 |
可观测性 - 约定
以下你可以找到本项目声明的所有 GlobalObservationConvention
和 ObservationConvention
的列表。
表 9. ObservationConvention 实现
观察约定类名 | 适用的观察上下文类名 |
---|---|
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 |