附录 B:Micrometer 观察文档

B.1. 可观测性 - 指标

以下列出了本项目声明的所有指标。spring-doc.cadn.net.cn

B.1.1. Listener Observation

观察 Apache Kafka 监听器。spring-doc.cadn.net.cn

指标名称 spring.kafka.listener(由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention 定义)。类型 timerspring-doc.cadn.net.cn

指标名称 spring.kafka.listener.active(由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention 定义)。类型 long task timerspring-doc.cadn.net.cn

在启动 Observation 后添加的 KeyValues 可能会缺失于 *.active 指标中。
Micrometer 内部使用 nanoseconds 作为基本单位。然而,每个后端决定实际的基本单位。(即 Prometheus 使用秒)

包含类的名称 KafkaListenerObservationspring-doc.cadn.net.cn

所有标签都必须以 spring.kafka.listener 前缀开头!
表5. 低基数键

spring.kafka.listener.id (必填)spring-doc.cadn.net.cn

监听器 id(或监听器容器的 bean 名称)。spring-doc.cadn.net.cn

模板观察

Kafka Templates 的观察。spring-doc.cadn.net.cn

指标名称 spring.kafka.template(由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention 定义)。类型 timerspring-doc.cadn.net.cn

指标名称 spring.kafka.template.active(由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention 定义)。类型 long task timerspring-doc.cadn.net.cn

在启动 Observation 后添加的 KeyValues 可能会缺失于 *.active 指标中。
Micrometer 内部使用 nanoseconds 作为基本单位。然而,每个后端决定实际的基本单位。(即 Prometheus 使用秒)

包含类的名称 KafkaTemplateObservationspring-doc.cadn.net.cn

所有标签都必须以 spring.kafka.template 前缀开头!
表6. 低基数键

spring.kafka.template.name (必填)spring-doc.cadn.net.cn

模板的 Bean 名称。spring-doc.cadn.net.cn

B.2. 可观测性 - 跨程

以下列出了本项目声明的所有 span。spring-doc.cadn.net.cn

B.2.1. Listener Observation Span

观察 Apache Kafka 监听器。spring-doc.cadn.net.cn

Span 名称 spring.kafka.listener(由约定类 KafkaListenerObservation$DefaultKafkaListenerObservationConvention 定义)。spring-doc.cadn.net.cn

包含类的名称 KafkaListenerObservationspring-doc.cadn.net.cn

所有标签都必须以 spring.kafka.listener 前缀开头!
表7. 标签键

姓名spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

spring.kafka.listener.id (必填)spring-doc.cadn.net.cn

监听器 id(或监听器容器的 bean 名称)。spring-doc.cadn.net.cn

模板观察跨度 B.2.2.

Kafka Templates 的观察。spring-doc.cadn.net.cn

Span 名称 spring.kafka.template(由约定类 KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention 定义)。spring-doc.cadn.net.cn

包含类的名称 KafkaTemplateObservationspring-doc.cadn.net.cn

所有标签都必须以 spring.kafka.template 前缀开头!
表 8. 标记键

姓名spring-doc.cadn.net.cn

描述spring-doc.cadn.net.cn

spring.kafka.template.name (必填)spring-doc.cadn.net.cn

模板的 Bean 名称。spring-doc.cadn.net.cn

可观测性 - 约定

以下列出了本项目声明的所有 GlobalObservationConventionObservationConventionspring-doc.cadn.net.cn

表9. ObservationConvention 实现

ObservationConvention 类名spring-doc.cadn.net.cn

适用的 ObservationContext 类名spring-doc.cadn.net.cn

KafkaListenerObservationspring-doc.cadn.net.cn

KafkaRecordReceiverContextspring-doc.cadn.net.cn

KafkaListenerObservation.DefaultKafkaListenerObservationConventionspring-doc.cadn.net.cn

KafkaRecordReceiverContextspring-doc.cadn.net.cn

KafkaListenerObservationConventionspring-doc.cadn.net.cn

KafkaRecordReceiverContextspring-doc.cadn.net.cn

KafkaTemplateObservationspring-doc.cadn.net.cn

KafkaRecordSenderContextspring-doc.cadn.net.cn

KafkaTemplateObservation.DefaultKafkaTemplateObservationConventionspring-doc.cadn.net.cn

KafkaRecordSenderContextspring-doc.cadn.net.cn

KafkaTemplateObservationConventionspring-doc.cadn.net.cn

KafkaRecordSenderContextspring-doc.cadn.net.cn