Micrometer 観測資料

可観測性 - メトリクス

以下に、このプロジェクトで宣言されたすべての指標のリストを示します。

リスナーの観察

Apache Kafka リスナーの観察。

指標名  spring.kafka.listener (規約クラス KafkaListenerObservation$DefaultKafkaListenerObservationConvention で定義)。タイプ  timer.

指標名  spring.kafka.listener.active (規約クラス KafkaListenerObservation$DefaultKafkaListenerObservationConvention で定義)。タイプ  long task timer.

観測の開始後に追加された KeyValues は、*.active メトリクスから欠落している可能性があります。
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 名)。

表 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 は、ベースユニットに nanoseconds を内部的に使用します。ただし、各バックエンドが実際のベースユニットを決定します。(つまり、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 (required)

Messaging consumer id (consumer group and client id).

messaging.kafka.client_id (required)

Messaging client id.

messaging.kafka.consumer.group (required)

Messaging the consumer group.

messaging.kafka.message.offset (required)

Messaging message offset.

messaging.kafka.source.partition (required)

Messaging partition.

messaging.operation (required)

Messaging operation.

messaging.source.kind (required)

Messaging source kind.

messaging.source.name (required)

Messaging source name.

messaging.system (required)

Messaging system.

spring.kafka.listener.id (required)

Listener id (or listener container bean name).

Template Observation Span

Observation for KafkaTemplates.

Span name spring.kafka.template (defined by convention class KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention).

Name of the enclosing class KafkaTemplateObservation.

Table 5. Tag Keys

Name

Description

messaging.destination.kind (required)

Messaging destination kind.

messaging.destination.name (required)

Messaging destination name.

messaging.operation (required)

Messaging operation.

messaging.system (required)

Messaging system.

spring.kafka.template.name (required)

Bean name of the template.

Observability - Conventions

Below you can find a list of all GlobalObservationConvention and ObservationConvention declared by this project.

Table 6. ObservationConvention implementations

ObservationConvention Class Name

Applicable ObservationContext Class Name

KafkaListenerObservation

KafkaRecordReceiverContext

KafkaListenerObservation.DefaultKafkaListenerObservationConvention

KafkaRecordReceiverContext

KafkaListenerObservationConvention

KafkaRecordReceiverContext

KafkaTemplateObservation

KafkaRecordSenderContext

KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention

KafkaRecordSenderContext

KafkaTemplateObservationConvention

KafkaRecordSenderContext