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

Micrometer Observation Documentation

This section describes the Micrometer integration.spring-doc.cn

Observability - Metrics

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

Listener Observation

Observation for Rabbit listeners.spring-doc.cn

Metric name spring.rabbit.listener (defined by convention class RabbitListenerObservation$DefaultRabbitListenerObservationConvention). Type timer.spring-doc.cn

Metric name spring.rabbit.listener.active (defined by convention class RabbitListenerObservation$DefaultRabbitListenerObservationConvention). 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 RabbitListenerObservation.spring-doc.cn

Table 1. Low cardinality Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.destination.name` (required)spring-doc.cn	The queue the listener is plugged to.spring-doc.cn
`spring.rabbit.listener.id` (required)spring-doc.cn	Listener id.spring-doc.cn

Stream Listener Observation

Observation for Rabbit stream listeners.spring-doc.cn

Metric name spring.rabbit.stream.listener (defined by convention class RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention). Type timer.spring-doc.cn

Metric name spring.rabbit.stream.listener.active (defined by convention class RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention). 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 RabbitStreamListenerObservation.spring-doc.cn

All tags must be prefixed with spring.rabbit.stream.listener prefix!

Table 2. Low cardinality Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`spring.rabbit.stream.listener.id` (required)spring-doc.cn	Listener id.spring-doc.cn

Stream Template Observation

Observation for `RabbitStreamTemplate`s.spring-doc.cn

Metric name spring.rabbit.stream.template (defined by convention class RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention). Type timer.spring-doc.cn

Metric name spring.rabbit.stream.template.active (defined by convention class RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention). 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 RabbitStreamTemplateObservation.spring-doc.cn

All tags must be prefixed with spring.rabbit.stream.template prefix!

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

Template Observation

Observation for RabbitTemplates.spring-doc.cn

Metric name spring.rabbit.template (defined by convention class RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention). Type timer.spring-doc.cn

Metric name spring.rabbit.template.active (defined by convention class RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention). 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 RabbitTemplateObservation.spring-doc.cn

Table 4. Low cardinality Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.destination.name` (required)spring-doc.cn	The destination exchange (empty if default exchange).spring-doc.cn
`messaging.rabbitmq.destination.routing_key` (required)spring-doc.cn	The destination routing key.spring-doc.cn
`spring.rabbit.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 Rabbit listeners.spring-doc.cn

Span name spring.rabbit.listener (defined by convention class RabbitListenerObservation$DefaultRabbitListenerObservationConvention).spring-doc.cn

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

Table 5. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.destination.name` (required)spring-doc.cn	The queue the listener is plugged to.spring-doc.cn
`messaging.rabbitmq.message.delivery_tag` (required)spring-doc.cn	The delivery tag.spring-doc.cn
`spring.rabbit.listener.id` (required)spring-doc.cn	Listener id.spring-doc.cn

Stream Listener Observation Span

Observation for Rabbit stream listeners.spring-doc.cn

Span name spring.rabbit.stream.listener (defined by convention class RabbitStreamListenerObservation$DefaultRabbitStreamListenerObservationConvention).spring-doc.cn

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

All tags must be prefixed with spring.rabbit.stream.listener prefix!

Table 6. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`spring.rabbit.stream.listener.id` (required)spring-doc.cn	Listener id.spring-doc.cn

Stream Template Observation Span

Observation for `RabbitStreamTemplate`s.spring-doc.cn

Span name spring.rabbit.stream.template (defined by convention class RabbitStreamTemplateObservation$DefaultRabbitStreamTemplateObservationConvention).spring-doc.cn

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

All tags must be prefixed with spring.rabbit.stream.template prefix!

Table 7. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`spring.rabbit.stream.template.name` (required)spring-doc.cn	Bean name of the template.spring-doc.cn

Template Observation Span

Observation for RabbitTemplates.spring-doc.cn

Span name spring.rabbit.template (defined by convention class RabbitTemplateObservation$DefaultRabbitTemplateObservationConvention).spring-doc.cn

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

Table 8. Tag Keys
Namespring-doc.cn	Descriptionspring-doc.cn
`messaging.destination.name` (required)spring-doc.cn	The destination exchange (empty if default exchange).spring-doc.cn
`messaging.rabbitmq.destination.routing_key` (required)spring-doc.cn	The destination routing key.spring-doc.cn
`spring.rabbit.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 9. ObservationConvention implementations
ObservationConvention Class Namespring-doc.cn	Applicable ObservationContext Class Namespring-doc.cn
`RabbitListenerObservation`spring-doc.cn	`RabbitMessageReceiverContext`spring-doc.cn
`RabbitListenerObservation.DefaultRabbitListenerObservationConvention`spring-doc.cn	`RabbitMessageReceiverContext`spring-doc.cn
`RabbitListenerObservationConvention`spring-doc.cn	`RabbitMessageReceiverContext`spring-doc.cn
`RabbitStreamMessageReceiverContext`spring-doc.cn	`RabbitMessageReceiverContext`spring-doc.cn
`RabbitStreamMessageReceiverContext.DefaultRabbitListenerObservationConvention`spring-doc.cn	`RabbitMessageReceiverContext`spring-doc.cn
`RabbitTemplateObservation`spring-doc.cn	`RabbitMessageSenderContext`spring-doc.cn
`RabbitTemplateObservation.DefaultRabbitTemplateObservationConvention`spring-doc.cn	`RabbitMessageSenderContext`spring-doc.cn
`RabbitTemplateObservationConvention`spring-doc.cn	`RabbitMessageSenderContext`spring-doc.cn
`RabbitStreamListenerObservation`spring-doc.cn	`RabbitStreamMessageReceiverContext`spring-doc.cn
`RabbitStreamListenerObservation.DefaultRabbitStreamListenerObservationConvention`spring-doc.cn	`RabbitStreamMessageReceiverContext`spring-doc.cn
`RabbitStreamListenerObservationConvention`spring-doc.cn	`RabbitStreamMessageReceiverContext`spring-doc.cn
`RabbitStreamTemplateObservation`spring-doc.cn	`RabbitStreamMessageSenderContext`spring-doc.cn
`RabbitStreamTemplateObservation.DefaultRabbitStreamTemplateObservationConvention`spring-doc.cn	`RabbitStreamMessageSenderContext`spring-doc.cn
`RabbitStreamTemplateObservationConvention`spring-doc.cn	`RabbitStreamMessageSenderContext`spring-doc.cn