This version is still in development and is not considered stable yet. For the latest stable version, please use Spring for Apache Kafka 3.2.3! |
Micrometer Observation Documentation
Observability - Metrics
Below you can find a list of all metrics declared by this project.
Listener Observation
Observation for Apache Kafka listeners.
Metric name spring.kafka.listener
(defined by convention class KafkaListenerObservation$DefaultKafkaListenerObservationConvention
). Type timer
.
Metric name spring.kafka.listener.active
(defined by convention class KafkaListenerObservation$DefaultKafkaListenerObservationConvention
). Type long task timer
.
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
.
Name |
Description |
|
Messaging the consumer group. |
|
Messaging operation. |
|
Messaging source kind. |
|
Messaging source name. |
|
Messaging system. |
|
Listener id (or listener container bean name). |
Template Observation
Observation for KafkaTemplates.
Metric name spring.kafka.template
(defined by convention class KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention
). Type timer
.
Metric name spring.kafka.template.active
(defined by convention class KafkaTemplateObservation$DefaultKafkaTemplateObservationConvention
). Type long task timer
.
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
.
Name |
Description |
|
Messaging destination kind. |
|
Messaging destination name. |
|
Messaging operation. |
|
Messaging system. |
|
Bean name of the template. |
Observability - Spans
Below you can find a list of all spans declared by this project.
Listener Observation Span
Observation for Apache Kafka listeners.
Span name spring.kafka.listener
(defined by convention class KafkaListenerObservation$DefaultKafkaListenerObservationConvention
).
Name of the enclosing class KafkaListenerObservation
.
Name |
Description |
|
Messaging consumer id (consumer group and client id). |
|
Messaging client id. |
|
Messaging the consumer group. |
|
Messaging message offset. |
|
Messaging partition. |
|
Messaging operation. |
|
Messaging source kind. |
|
Messaging source name. |
|
Messaging system. |
|
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
.
Name |
Description |
|
Messaging destination kind. |
|
Messaging destination name. |
|
Messaging operation. |
|
Messaging system. |
|
Bean name of the template. |
Observability - Conventions
Below you can find a list of all GlobalObservationConvention
and ObservationConvention
declared by this project.
ObservationConvention Class Name |
Applicable ObservationContext Class Name |
|
|
|
|
|
|
|
|
|
|
|
|