微米观察文档
可观测性 - 指标
以下是该项目声明的所有指标的列表。
监听器观察
对 Apache Kafka 监听器的观察。
指标名称 spring.kafka.listener
(由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention
定义)。类型 timer
。
指标名称 spring.kafka.listener.active
(由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention
定义)。 类型 long task timer
。
在启动 Observation 后添加的 KeyValues 可能会在 *.active metrics 中缺失。
Micrometer 内部使用 nanoseconds
作为基本单位。然而,每个后端决定实际的基本单位。(即,Prometheus 使用秒)
封闭类的名称 KafkaListenerObservation
。
表 1. 低基数键
名称 | 描述 |
---|---|
messaging.kafka.consumer.group (必需) | 消息传递的消费者组。 |
messaging.operation (必需) | 消息传递操作。 |
messaging.source.kind (必需) | 消息传递源类型。 |
messaging.source.name (必需) | 消息传递源名称。 |
messaging.system (必需) | 消息传递系统。 |
spring.kafka.listener.id (必需) | 监听器 ID(或监听器容器 bean 名称)。 |
模板观察
对 KafkaTemplates 的观察。
指标名称 spring.kafka.template
(由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention
定义)。 类型 timer
。
指标名称 spring.kafka.template.active
(由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention
定义)。 类型 long task timer
。
在启动 Observation 后添加的 KeyValues 可能会在 *.active metrics 中缺失。
Micrometer 内部使用 nanoseconds
作为基本单位。然而,每个后端决定实际的基本单位。(即,Prometheus 使用秒)
封闭类的名称 KafkaTemplateObservation
。
表 2. 低基数键
名称 | 描述 |
---|---|
messaging.destination.kind (必需) | Messaging destination kind. |
messaging.destination.name (必需) | Messaging destination name. |
messaging.operation (必需) | Messaging operation. |
messaging.system (必需) | Messaging system. |
spring.kafka.template.name (必需) | Bean name of the template. |
可观察性 - Spans
下面你可以找到这个项目声明的所有 span 的列表。
监听器观察范围
对 Apache Kafka 监听器的观察。
Span name spring.kafka.listener
(由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention
定义)。
封闭类的名称 KafkaListenerObservation
。
表 3. 标签键
名称 | 描述 |
---|---|
messaging.consumer.id (必填) | 消息消费者 ID(消费者组和客户端 ID)。 |
messaging.kafka.client_id (必填) | 消息客户端 ID。 |
messaging.kafka.consumer.group (必填) | 消息消费者组。 |
messaging.kafka.message.offset (必填) | 消息偏移量。 |
messaging.kafka.source.partition (必填) | 消息分区。 |
messaging.operation (必填) | 消息操作。 |
messaging.source.kind (必填) | 消息源类型。 |
messaging.source.name (必填) | 消息源名称。 |
messaging.system (必填) | 消息系统。 |
spring.kafka.listener.id (必填) | 监听器 ID(或监听器容器 bean 名称)。 |
模板观察跨度
对 KafkaTemplates 的观察。
Span name spring.kafka.template
(由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention
定义)。
封闭类的名称 KafkaTemplateObservation
。
表 4. 标签键
名称 | 描述 |
---|---|
messaging.destination.kind (必需) | 消息传递目的地类型。 |
messaging.destination.name (必需) | 消息传递目的地名称。 |
messaging.operation (必需) | 消息传递操作。 |
messaging.system (必需) | 消息传递系统。 |
spring.kafka.template.name (必需) | 模板的 Bean 名称。 |
可观察性 - 约定
下面您可以找到本项目声明的所有 GlobalObservationConvention
和 ObservationConvention
的列表。
表 5. ObservationConvention 实现
ObservationConvention 类名 | 适用的 ObservationContext 类名 |
---|---|
KafkaListenerObservation | KafkaRecordReceiverContext |
KafkaListenerObservation.DefaultKafkaListenerObservationConvention | KafkaRecordReceiverContext |
KafkaListenerObservationConvention | KafkaRecordReceiverContext |
KafkaTemplateObservation | KafkaRecordSenderContext |
KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention | KafkaRecordSenderContext |
KafkaTemplateObservationConvention | KafkaRecordSenderContext |