Appendix A: Micrometer Observation Documentation

A.1. Observability - Metrics

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

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

All tags must be prefixed with spring.rabbit.listener prefix!
Table 5. Low cardinality Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.rabbit.listener.id (required)spring-doc.cn

Listener id.spring-doc.cn

A.1.2. 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 6. Low cardinality Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.rabbit.stream.listener.id (required)spring-doc.cn

Listener id.spring-doc.cn

A.1.3. 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 7. 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

A.1.4. 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

All tags must be prefixed with spring.rabbit.template prefix!
Table 8. Low cardinality Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.rabbit.template.name (required)spring-doc.cn

Bean name of the template.spring-doc.cn

A.2. Observability - Spans

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

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

All tags must be prefixed with spring.rabbit.listener prefix!
Table 9. Tag Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.rabbit.listener.id (required)spring-doc.cn

Listener id.spring-doc.cn

A.2.2. 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 10. Tag Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.rabbit.stream.listener.id (required)spring-doc.cn

Listener id.spring-doc.cn

A.2.3. 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 11. 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

A.2.4. 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

All tags must be prefixed with spring.rabbit.template prefix!
Table 12. Tag Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.rabbit.template.name (required)spring-doc.cn

Bean name of the template.spring-doc.cn

A.3. Observability - Conventions

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

Table 13. ObservationConvention implementations

ObservationConvention Class Namespring-doc.cn

Applicable ObservationContext Class Namespring-doc.cn

RabbitListenerObservationspring-doc.cn

RabbitMessageReceiverContextspring-doc.cn

RabbitListenerObservation.DefaultRabbitListenerObservationConventionspring-doc.cn

RabbitMessageReceiverContextspring-doc.cn

RabbitListenerObservationConventionspring-doc.cn

RabbitMessageReceiverContextspring-doc.cn

RabbitStreamMessageReceiverContextspring-doc.cn

RabbitMessageReceiverContextspring-doc.cn

RabbitStreamMessageReceiverContext.DefaultRabbitListenerObservationConventionspring-doc.cn

RabbitMessageReceiverContextspring-doc.cn

RabbitTemplateObservationspring-doc.cn

RabbitMessageSenderContextspring-doc.cn

RabbitTemplateObservation.DefaultRabbitTemplateObservationConventionspring-doc.cn

RabbitMessageSenderContextspring-doc.cn

RabbitTemplateObservationConventionspring-doc.cn

RabbitMessageSenderContextspring-doc.cn

RabbitStreamListenerObservationspring-doc.cn

RabbitStreamMessageReceiverContextspring-doc.cn

RabbitStreamListenerObservation.DefaultRabbitStreamListenerObservationConventionspring-doc.cn

RabbitStreamMessageReceiverContextspring-doc.cn

RabbitStreamListenerObservationConventionspring-doc.cn

RabbitStreamMessageReceiverContextspring-doc.cn

RabbitStreamTemplateObservationspring-doc.cn

RabbitStreamMessageSenderContextspring-doc.cn

RabbitStreamTemplateObservation.DefaultRabbitStreamTemplateObservationConventionspring-doc.cn

RabbitStreamMessageSenderContextspring-doc.cn

RabbitStreamTemplateObservationConventionspring-doc.cn

RabbitStreamMessageSenderContextspring-doc.cn