Micrometer 可观测性文档

本节介绍 Micrometer 集成。

可观测性 - 指标

下面列出了本项目声明的所有指标。

监听器可观测性

Rabbit 监听器的可观测性。

指标名称 spring.rabbit.listener (由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention 定义)。类型 timer

指标名称 spring.rabbit.listener.active (由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention 定义)。类型 long task timer

在 Observation 开始后添加的 KeyValues 可能不会出现在 *.active 指标中。
Micrometer 内部使用纳秒作为基本单位。但是,每个后端会确定实际的基本单位。(例如 Prometheus 使用秒)

封闭类名称 RabbitListenerObservation

表 1. 低基数键

名称

描述

messaging.destination.name (必需)

监听器连接的队列。

messaging.rabbitmq.message.delivery_tag (必需)

Delivery tag。弃用后,此键将不再作为低基数标签公开。

spring.rabbit.listener.id (必需)

监听器 ID。

Stream 监听器可观测性

Rabbit Stream 监听器的可观测性。

指标名称 spring.rabbit.stream.listener (由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention 定义)。类型 timer

指标名称 spring.rabbit.stream.listener.active (由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention 定义)。类型 long task timer

在 Observation 开始后添加的 KeyValues 可能不会出现在 *.active 指标中。
Micrometer 内部使用纳秒作为基本单位。但是,每个后端会确定实际的基本单位。(例如 Prometheus 使用秒)

封闭类名称 RabbitStreamListenerObservation

所有标签必须带有 spring.rabbit.stream.listener 前缀!
表 2. 低基数键

名称

描述

spring.rabbit.stream.listener.id (必需)

监听器 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 内部使用纳秒作为基本单位。但是,每个后端会确定实际的基本单位。(例如 Prometheus 使用秒)

封闭类名称 RabbitStreamTemplateObservation

所有标签必须带有 spring.rabbit.stream.template 前缀!
表 3. 低基数键

名称

描述

spring.rabbit.stream.template.name (必需)

Template 的 Bean 名称。

Template 可观测性

RabbitTemplates 的可观测性。

指标名称 spring.rabbit.template (由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention 定义)。类型 timer

指标名称 spring.rabbit.template.active (由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention 定义)。类型 long task timer

在 Observation 开始后添加的 KeyValues 可能不会出现在 *.active 指标中。
Micrometer 内部使用纳秒作为基本单位。但是,每个后端会确定实际的基本单位。(例如 Prometheus 使用秒)

封闭类名称 RabbitTemplateObservation

表 4. 低基数键

名称

描述

messaging.destination.name (必需)

目标交换器(如果是默认交换器则为空)。

messaging.rabbitmq.destination.routing_key (必需)

目标路由键。

spring.rabbit.template.name (必需)

Template 的 Bean 名称。

可观测性 - Span

下面列出了本项目声明的所有 Span。

监听器可观测性 Span

Rabbit 监听器的可观测性。

Span 名称 spring.rabbit.listener (由约定类 RabbitListenerObservation$DefaultRabbitListenerObservationConvention 定义)。

封闭类名称 RabbitListenerObservation

表 5. 标签键

名称

描述

messaging.destination.name (必需)

监听器连接的队列。

messaging.rabbitmq.message.delivery_tag (必需)

Delivery tag。弃用后,此键将不再作为低基数标签公开。

messaging.rabbitmq.message.delivery_tag (必需)

Delivery tag。

spring.rabbit.listener.id (必需)

监听器 ID。

Stream 监听器可观测性 Span

Rabbit Stream 监听器的可观测性。

Span 名称 spring.rabbit.stream.listener (由约定类 RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention 定义)。

封闭类名称 RabbitStreamListenerObservation

所有标签必须带有 spring.rabbit.stream.listener 前缀!
表 6. 标签键

名称

描述

spring.rabbit.stream.listener.id (必需)

监听器 ID。

Stream Template 可观测性 Span

RabbitStreamTemplate 的可观测性。

Span 名称 spring.rabbit.stream.template (由约定类 RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention 定义)。

封闭类名称 RabbitStreamTemplateObservation

所有标签必须带有 spring.rabbit.stream.template 前缀!
表 7. 标签键

名称

描述

spring.rabbit.stream.template.name (必需)

Template 的 Bean 名称。

Template 可观测性 Span

RabbitTemplates 的可观测性。

Span 名称 spring.rabbit.template (由约定类 RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention 定义)。

封闭类名称 RabbitTemplateObservation

表 8. 标签键

名称

描述

messaging.destination.name (必需)

目标交换器(如果是默认交换器则为空)。

messaging.rabbitmq.destination.routing_key (必需)

目标路由键。

spring.rabbit.template.name (必需)

Template 的 Bean 名称。

可观测性 - 约定

下面列出了本项目声明的所有 GlobalObservationConventionObservationConvention

表 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