Appendix B: Micrometer Observation Documentation (Appendix B: Micrometer Observation Documentation) _ Spring for Apache Kafkaversion 3.0.17中文文档(官方文档中文翻译)|Spring 教程 —

Appendix B: Micrometer Observation Documentation

B.1. Observability - Metrics

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

B.1.1. 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

All tags must be prefixed with spring.kafka.listener prefix!

Table 5. Low cardinality Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`spring.kafka.listener.id` (required)spring-doc.cn	Listener id (or listener container bean name).spring-doc.cn

B.1.2. 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

All tags must be prefixed with spring.kafka.template prefix!

Table 6. Low cardinality Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`spring.kafka.template.name` (required)spring-doc.cn	Bean name of the template.spring-doc.cn

B.2. Observability - Spans

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

B.2.1. 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

All tags must be prefixed with spring.kafka.listener prefix!

Table 7. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`spring.kafka.listener.id` (required)spring-doc.cn	Listener id (or listener container bean name).spring-doc.cn

B.2.2. 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

All tags must be prefixed with spring.kafka.template prefix!

Table 8. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`spring.kafka.template.name` (required)spring-doc.cn	Bean name of the template.spring-doc.cn

B.3. Observability - Conventions

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

Table 9. 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