Micrometer 观测文档

可观测性 - 指标 (Metrics)

您可以在下方找到此项目声明的所有指标列表。

监听器观测 (Listener Observation)

针对 Apache Kafka 监听器的观测。

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

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

在 Observation 启动后添加的 KeyValues 可能不会出现在 *.active 指标中。
Micrometer 内部使用 nanoseconds 作为基本单位。然而,每个后端会确定实际的基本单位。(例如 Prometheus 使用 seconds)

包含类名称 KafkaListenerObservation

表 1. 低基数键 (Low cardinality Keys)

名称

描述

messaging.kafka.consumer.group (必需)

消息 Consumer Group。

messaging.operation (必需)

消息操作。

messaging.source.kind (必需)

消息源类型。

messaging.source.name (必需)

消息源名称。

messaging.system (必需)

消息系统。

spring.kafka.listener.id (必需)

监听器 ID (或监听器容器 Bean 名称)。

Template 观测 (Template Observation)

针对 KafkaTemplate 的观测。

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

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

在 Observation 启动后添加的 KeyValues 可能不会出现在 *.active 指标中。
Micrometer 内部使用 nanoseconds 作为基本单位。然而,每个后端会确定实际的基本单位。(例如 Prometheus 使用 seconds)

包含类名称 KafkaTemplateObservation

表 2. 低基数键 (Low cardinality Keys)

名称

描述

messaging.destination.kind (必需)

消息目标类型。

messaging.destination.name (必需)

消息目标名称。

messaging.operation (必需)

消息操作。

messaging.system (必需)

消息系统。

spring.kafka.template.name (必需)

Template 的 Bean 名称。

可观测性 - Span

您可以在下方找到此项目声明的所有 span 列表。

监听器观测 Span (Listener Observation Span)

针对 Apache Kafka 监听器的观测。

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

包含类名称 KafkaListenerObservation

表 3. Tag 键

名称

描述

messaging.consumer.id (必需)

消息 Consumer ID (Consumer Group 和 Client ID)。

messaging.kafka.client_id (必需)

消息 Client ID。

messaging.kafka.consumer.group (必需)

消息 Consumer Group。

messaging.kafka.message.offset (必需)

消息 Offset。

messaging.kafka.source.partition (必需)

消息分区。

messaging.operation (必需)

消息操作。

messaging.source.kind (必需)

消息源类型。

messaging.source.name (必需)

消息源名称。

messaging.system (必需)

消息系统。

spring.kafka.listener.id (必需)

监听器 ID (或监听器容器 Bean 名称)。

Template 观测 Span (Template Observation Span)

针对 KafkaTemplate 的观测。

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

包含类名称 KafkaTemplateObservation

表 4. Tag 键

名称

描述

messaging.destination.kind (必需)

消息目标类型。

messaging.destination.name (必需)

消息目标名称。

messaging.operation (必需)

消息操作。

messaging.system (必需)

消息系统。

spring.kafka.template.name (必需)

Template 的 Bean 名称。

可观测性 - 约定 (Conventions)

您可以在下方找到此项目声明的所有 GlobalObservationConventionObservationConvention 列表。

表 5. ObservationConvention 实现

ObservationConvention 类名称

适用 ObservationContext 类名称

KafkaListenerObservation

KafkaRecordReceiverContext

KafkaListenerObservation.DefaultKafkaListenerObservationConvention

KafkaRecordReceiverContext

KafkaListenerObservationConvention

KafkaRecordReceiverContext

KafkaTemplateObservation

KafkaRecordSenderContext

KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention

KafkaRecordSenderContext

KafkaTemplateObservationConvention

KafkaRecordSenderContext