This version is still in development and is not considered stable yet. For the latest stable version, please use Spring for Apache Kafka 3.3.0!spring-doc.cn

Micrometer Observation Documentation

Observability - Metrics

Below you can find a list of all metrics declared by this project.spring-doc.cn

Listener Observation

Observation for Apache Kafka listeners.spring-doc.cn

Metric name spring.kafka.listener (defined by convention class KafkaListenerObservation$DefaultKafkaListenerObservationConvention). Type timer.spring-doc.cn

Metric name spring.kafka.listener.active (defined by convention class KafkaListenerObservation$DefaultKafkaListenerObservationConvention). Type long task timer.spring-doc.cn

KeyValues that are added after starting the Observation might be missing from the *.active metrics.

Micrometer internally uses nanoseconds for the baseunit. However, each backend determines the actual baseunit. (i.e. Prometheus uses seconds)

Name of the enclosing class KafkaListenerObservation.spring-doc.cn

Table 1. Low cardinality Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.kafka.consumer.group` (required)spring-doc.cn	Messaging the consumer group.spring-doc.cn
`messaging.operation` (required)spring-doc.cn	Messaging operation.spring-doc.cn
`messaging.source.kind` (required)spring-doc.cn	Messaging source kind.spring-doc.cn
`messaging.source.name` (required)spring-doc.cn	Messaging source name.spring-doc.cn
`messaging.system` (required)spring-doc.cn	Messaging system.spring-doc.cn
`spring.kafka.listener.id` (required)spring-doc.cn	Listener id (or listener container bean name).spring-doc.cn

Template Observation

Observation for KafkaTemplates.spring-doc.cn

Metric name spring.kafka.template (defined by convention class KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention). Type timer.spring-doc.cn

Metric name spring.kafka.template.active (defined by convention class KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention). Type long task timer.spring-doc.cn

KeyValues that are added after starting the Observation might be missing from the *.active metrics.

Micrometer internally uses nanoseconds for the baseunit. However, each backend determines the actual baseunit. (i.e. Prometheus uses seconds)

Name of the enclosing class KafkaTemplateObservation.spring-doc.cn

Table 2. Low cardinality Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.destination.kind` (required)spring-doc.cn	Messaging destination kind.spring-doc.cn
`messaging.destination.name` (required)spring-doc.cn	Messaging destination name.spring-doc.cn
`messaging.operation` (required)spring-doc.cn	Messaging operation.spring-doc.cn
`messaging.system` (required)spring-doc.cn	Messaging system.spring-doc.cn
`spring.kafka.template.name` (required)spring-doc.cn	Bean name of the template.spring-doc.cn

Observability - Spans

Below you can find a list of all spans declared by this project.spring-doc.cn

Listener Observation Span

Observation for Apache Kafka listeners.spring-doc.cn

Span name spring.kafka.listener (defined by convention class KafkaListenerObservation$DefaultKafkaListenerObservationConvention).spring-doc.cn

Name of the enclosing class KafkaListenerObservation.spring-doc.cn

Table 3. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.consumer.id` (required)spring-doc.cn	Messaging consumer id (consumer group and client id).spring-doc.cn
`messaging.kafka.client_id` (required)spring-doc.cn	Messaging client id.spring-doc.cn
`messaging.kafka.consumer.group` (required)spring-doc.cn	Messaging the consumer group.spring-doc.cn
`messaging.kafka.message.offset` (required)spring-doc.cn	Messaging message offset.spring-doc.cn
`messaging.kafka.source.partition` (required)spring-doc.cn	Messaging partition.spring-doc.cn
`messaging.operation` (required)spring-doc.cn	Messaging operation.spring-doc.cn
`messaging.source.kind` (required)spring-doc.cn	Messaging source kind.spring-doc.cn
`messaging.source.name` (required)spring-doc.cn	Messaging source name.spring-doc.cn
`messaging.system` (required)spring-doc.cn	Messaging system.spring-doc.cn
`spring.kafka.listener.id` (required)spring-doc.cn	Listener id (or listener container bean name).spring-doc.cn

Template Observation Span

Observation for KafkaTemplates.spring-doc.cn

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

Name of the enclosing class KafkaTemplateObservation.spring-doc.cn

Table 4. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.destination.kind` (required)spring-doc.cn	Messaging destination kind.spring-doc.cn
`messaging.destination.name` (required)spring-doc.cn	Messaging destination name.spring-doc.cn
`messaging.operation` (required)spring-doc.cn	Messaging operation.spring-doc.cn
`messaging.system` (required)spring-doc.cn	Messaging system.spring-doc.cn
`spring.kafka.template.name` (required)spring-doc.cn	Bean name of the template.spring-doc.cn

Observability - Conventions

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

Table 5. ObservationConvention implementations
ObservationConvention Class Namespring-doc.cn	Applicable ObservationContext Class Namespring-doc.cn
`KafkaListenerObservation`spring-doc.cn	`KafkaRecordReceiverContext`spring-doc.cn
`KafkaListenerObservation.DefaultKafkaListenerObservationConvention`spring-doc.cn	`KafkaRecordReceiverContext`spring-doc.cn
`KafkaListenerObservationConvention`spring-doc.cn	`KafkaRecordReceiverContext`spring-doc.cn
`KafkaTemplateObservation`spring-doc.cn	`KafkaRecordSenderContext`spring-doc.cn
`KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention`spring-doc.cn	`KafkaRecordSenderContext`spring-doc.cn
`KafkaTemplateObservationConvention`spring-doc.cn	`KafkaRecordSenderContext`spring-doc.cn