对于最新稳定版本，请使用Spring for Apache Kafka 4.0.4！spring-doc.cadn.net.cn

Micrometer 观测文档

可观测性 - 指标

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

监听器观察

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

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

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

在启动 Observation 后添加的 KeyValues 可能会缺失于 *.active 指标中。

Micrometer 内部使用 nanoseconds 作为基本单位。然而，每个后端决定实际的基本单位。（即 Prometheus 使用秒）

包含类的名称 KafkaListenerObservation。spring-doc.cadn.net.cn

表1. 低基数键
姓名spring-doc.cadn.net.cn	描述spring-doc.cadn.net.cn
`messaging.kafka.consumer.group` （必填）spring-doc.cadn.net.cn	消息发送到消费者组。spring-doc.cadn.net.cn
`messaging.operation` （必填）spring-doc.cadn.net.cn	消息传递操作。spring-doc.cadn.net.cn
`messaging.source.kind` （必填）spring-doc.cadn.net.cn	消息源类型。spring-doc.cadn.net.cn
`messaging.source.name` （必填）spring-doc.cadn.net.cn	消息源名称。spring-doc.cadn.net.cn
`messaging.system` （必填）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

模板观察

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

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

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

在启动 Observation 后添加的 KeyValues 可能会缺失于 *.active 指标中。

Micrometer 内部使用 nanoseconds 作为基本单位。然而，每个后端决定实际的基本单位。（即 Prometheus 使用秒）

包含类的名称 KafkaTemplateObservation。spring-doc.cadn.net.cn

表2. 低基数键
姓名spring-doc.cadn.net.cn	描述spring-doc.cadn.net.cn
`messaging.destination.kind` （必填）spring-doc.cadn.net.cn	消息传递目标类型。spring-doc.cadn.net.cn
`messaging.destination.name` （必填）spring-doc.cadn.net.cn	消息传递目的地名称。spring-doc.cadn.net.cn
`messaging.operation` （必填）spring-doc.cadn.net.cn	消息传递操作。spring-doc.cadn.net.cn
`messaging.system` （必填）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

可观测性 - 跨度

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

监听器观测范围

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

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

包含类的名称 KafkaListenerObservation。spring-doc.cadn.net.cn

表3. 标签键
姓名spring-doc.cadn.net.cn	描述spring-doc.cadn.net.cn
`messaging.consumer.id` （必填）spring-doc.cadn.net.cn	消息消费者ID（消费者组和客户端ID）。spring-doc.cadn.net.cn
`messaging.kafka.client_id` （必填）spring-doc.cadn.net.cn	消息传递客户端ID。spring-doc.cadn.net.cn
`messaging.kafka.consumer.group` （必填）spring-doc.cadn.net.cn	消息发送到消费者组。spring-doc.cadn.net.cn
`messaging.kafka.message.offset` （必填）spring-doc.cadn.net.cn	消息偏移量。spring-doc.cadn.net.cn
`messaging.kafka.source.partition` （必填）spring-doc.cadn.net.cn	消息分区。spring-doc.cadn.net.cn
`messaging.operation` （必填）spring-doc.cadn.net.cn	消息传递操作。spring-doc.cadn.net.cn
`messaging.source.kind` （必填）spring-doc.cadn.net.cn	消息源类型。spring-doc.cadn.net.cn
`messaging.source.name` （必填）spring-doc.cadn.net.cn	消息源名称。spring-doc.cadn.net.cn
`messaging.system` （必填）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

模板观察跨度

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

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

包含类的名称 KafkaTemplateObservation。spring-doc.cadn.net.cn

表4. 标签键
姓名spring-doc.cadn.net.cn	描述spring-doc.cadn.net.cn
`messaging.destination.kind` （必填）spring-doc.cadn.net.cn	消息传递目标类型。spring-doc.cadn.net.cn
`messaging.destination.name` （必填）spring-doc.cadn.net.cn	消息传递目的地名称。spring-doc.cadn.net.cn
`messaging.operation` （必填）spring-doc.cadn.net.cn	消息传递操作。spring-doc.cadn.net.cn
`messaging.system` （必填）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

可观测性 - 约定

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

表5. Observation Convention 实现
ObservationConvention 类名spring-doc.cadn.net.cn	适用的 ObservationContext 类名spring-doc.cadn.net.cn
`KafkaListenerObservation`spring-doc.cadn.net.cn	`KafkaRecordReceiverContext`spring-doc.cadn.net.cn
`KafkaListenerObservation.DefaultKafkaListenerObservationConvention`spring-doc.cadn.net.cn	`KafkaRecordReceiverContext`spring-doc.cadn.net.cn
`KafkaListenerObservationConvention`spring-doc.cadn.net.cn	`KafkaRecordReceiverContext`spring-doc.cadn.net.cn
`KafkaTemplateObservation`spring-doc.cadn.net.cn	`KafkaRecordSenderContext`spring-doc.cadn.net.cn
`KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention`spring-doc.cadn.net.cn	`KafkaRecordSenderContext`spring-doc.cadn.net.cn
`KafkaTemplateObservationConvention`spring-doc.cadn.net.cn	`KafkaRecordSenderContext`spring-doc.cadn.net.cn