Micrometer 观测文档

可观测性 - 指标

以下列出了此项目声明的所有指标。

Apache Kafka 侦听器的观测。

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

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

在启动观测后添加的 KeyValues 可能在 *.active 指标中缺失。

Micrometer 在内部使用 纳秒 作为基本单位。但是，每个后端都会确定实际的基本单位。（例如，Prometheus 使用秒）

封闭类的名称 KafkaListenerObservation。

表 1. 低基数键
名称	描述
`messaging.kafka.consumer.group` (必需)	消息传递的消费者组。
`messaging.operation` (必需)	消息操作。
`messaging.source.kind` (必填)	消息源类型。
`messaging.source.name` (必填)	消息源名称。
`messaging.system` (必填)	消息系统。
`spring.kafka.listener.id` (必填)	监听器 ID（或监听器容器 bean 名称）。

表 2. 高基数键
名称	描述
`messaging.consumer.id` (必填)	消息消费者 ID（消费者组和客户端 ID）。
`messaging.kafka.client_id` (必填)	消息客户端 ID。
`messaging.kafka.message.offset` (必填)	消息偏移量。
`messaging.kafka.source.partition` (必填)	消息分区。

KafkaTemplates 的观测。

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

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

在启动观测后添加的 KeyValues 可能在 *.active 指标中缺失。

Micrometer 在内部使用 纳秒 作为基本单位。但是，每个后端都会确定实际的基本单位。（例如，Prometheus 使用秒）

封闭类 KafkaTemplateObservation 的名称。

表 3. 低基数键
名称	描述
`messaging.destination.kind` (必填)	消息目标类型。
`messaging.destination.name` (必填)	消息目标名称。
`messaging.operation` (必需)	消息操作。
`messaging.system` (必填)	消息系统。
`spring.kafka.template.name` (必填)	模板的 bean 名称。

以下列出了此项目声明的所有跨度。

Apache Kafka 侦听器的观测。

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

封闭类的名称 KafkaListenerObservation。

表 4. 标签键
名称	描述
`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 的观测。

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

封闭类 KafkaTemplateObservation 的名称。

表 5. 标签键
名称	描述
`messaging.destination.kind` (必填)	消息目标类型。
`messaging.destination.name` (必填)	消息目标名称。
`messaging.operation` (必需)	消息操作。
`messaging.system` (必填)	消息系统。
`spring.kafka.template.name` (必填)	模板的 bean 名称。

以下列出了此项目声明的所有 GlobalObservationConvention 和 ObservationConvention。

表 6. ObservationConvention 实现
ObservationConvention 类名称	适用的 ObservationContext 类名称
`KafkaListenerObservation`	`KafkaRecordReceiverContext`
`KafkaListenerObservation.DefaultKafkaListenerObservationConvention`	`KafkaRecordReceiverContext`
`KafkaListenerObservationConvention`	`KafkaRecordReceiverContext`
`KafkaTemplateObservation`	`KafkaRecordSenderContext`
`KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention`	`KafkaRecordSenderContext`
`KafkaTemplateObservationConvention`	`KafkaRecordSenderContext`