Micrometer Observation 文档

Doubao 中英对照 Micrometer Observation Documentation

可观测性 - 指标

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

监听器 Observation

用于 Apache Kafka 监听器的 Observation。

指标名称 spring.kafka.listener（由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention 定义）。类型 timer。

指标名称 spring.kafka.listener.active（由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention 定义）。类型 long task timer。

important

在启动 Observation 之后添加的 KeyValues 可能不会出现在 *.active 指标中。

important

Micrometer 内部使用 nanoseconds 作为基准单位。不过，每个后端决定实际的基准单位。（例如 Prometheus 使用秒）

封闭类的名称 KafkaListenerObservation。

表 1. 低基数键

名称	描述
messaging.kafka.consumer.group (required)	消费者组。
messaging.operation	消息操作。
messaging.source.kind (required)	消息来源种类。
messaging.source.name (required)	消息来源名称。
messaging.system (required)	消息系统。
spring.kafka.listener.id (required)	监听器 id（或监听器容器 bean 名称）。

模板 Observation

用于 KafkaTemplate 的 Observation。

指标名称 spring.kafka.template（由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention 定义）。类型 timer。

指标名称 spring.kafka.template.active（由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention 定义）。类型 long task timer。

important

在启动 Observation 之后添加的 KeyValues 可能不会出现在 *.active 指标中。

important

Micrometer 内部使用 nanoseconds 作为基准单位。不过，每个后端决定实际的基准单位。（例如 Prometheus 使用秒）

封闭类的名称 KafkaTemplateObservation。

表 2. 低基数键

名称	描述
messaging.destination.kind (required)	消息目标种类。
messaging.destination.name (required)	消息目标名称。
messaging.operation (required)	消息操作。
messaging.system (required)	消息系统。
spring.kafka.template.name (required)	模板的 bean 名称。

可观测性 - Span

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

监听器 Observation Span

用于 Apache Kafka 监听器的 Observation。

Span 名称 spring.kafka.listener（由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention 定义）。

封闭类的名称 KafkaListenerObservation。

表 3. 标签键

名称	描述
messaging.consumer.id (required)	消息消费者 id（消费者组和客户端 id）。
messaging.kafka.client_id (required)	消息客户端 id。
messaging.kafka.consumer.group (required)	消费者组。
messaging.kafka.message.offset (required)	消息偏移量。
messaging.kafka.source.partition (required)	消息分区。
messaging.operation (required)	消息操作。
messaging.source.kind (required)	消息来源种类。
messaging.source.name (required)	消息来源名称。
messaging.system (required)	消息系统。
spring.kafka.listener.id (required)	监听器 id（或监听器容器 bean 名称）。

模板 Observation Span

用于 KafkaTemplate 的 Observation。

Span 名称 spring.kafka.template（由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention 定义）。

封闭类的名称 KafkaTemplateObservation。

表 4. 标签键

名称	描述
messaging.destination.kind (required)	消息目标种类。
messaging.destination.name (required)	消息目标名称。
messaging.operation (required)	消息操作。
messaging.system (required)	消息系统。
spring.kafka.template.name (required)	模板的 bean 名称。

可观测性 - 约定

下面列出了本项目声明的所有 GlobalObservationConvention 和 ObservationConvention。

表 5. ObservationConvention 实现

ObservationConvention 类名	适用的 ObservationContext 类名
KafkaListenerObservation	KafkaRecordReceiverContext
KafkaListenerObservation.DefaultKafkaListenerObservationConvention	KafkaRecordReceiverContext
KafkaListenerObservationConvention	KafkaRecordReceiverContext
KafkaTemplateObservation	KafkaRecordSenderContext
KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention	KafkaRecordSenderContext
KafkaTemplateObservationConvention	KafkaRecordSenderContext