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)

您可以在下方找到此專案宣告的所有 GlobalObservationConvention 和 ObservationConvention 列表。

表 5. ObservationConvention 實現

ObservationConvention 類名稱

適用 ObservationContext 類名稱

KafkaListenerObservation

KafkaRecordReceiverContext

KafkaListenerObservation.DefaultKafkaListenerObservationConvention

KafkaRecordReceiverContext

KafkaListenerObservationConvention

KafkaRecordReceiverContext

KafkaTemplateObservation

KafkaRecordSenderContext

KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention

KafkaRecordSenderContext

KafkaTemplateObservationConvention

KafkaRecordSenderContext