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

Common application properties

Various properties can be specified inside your application.properties file, inside your application.yml file, or as command line switches. This appendix provides a list of common Spring Cloud Commons properties and references to the underlying classes that consume them.spring-doc.cn

Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. Also, you can define your own properties.

Observability metadata

Observability - Metrics

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

Circuit Breaker Function Observation

Observation created when we wrap a Function passed to the CircuitBreaker as fallback.spring-doc.cn

Metric name spring.cloud.circuitbreaker (defined by convention class org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention). Type timer.spring-doc.cn

Metric name spring.cloud.circuitbreaker.active (defined by convention class org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention). 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)

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.spring-doc.cn

All tags must be prefixed with spring.cloud.circuitbreaker prefix!
Table 1. Low cardinality Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.cloud.circuitbreaker.type (required)spring-doc.cn

Defines the type of wrapped lambda.spring-doc.cn

Circuit Breaker Supplier Observation

Observation created when we wrap a Supplier passed to the CircuitBreaker.spring-doc.cn

Metric name spring.cloud.circuitbreaker (defined by convention class org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention). Type timer.spring-doc.cn

Metric name spring.cloud.circuitbreaker.active (defined by convention class org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention). 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)

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.spring-doc.cn

All tags must be prefixed with spring.cloud.circuitbreaker prefix!
Table 2. Low cardinality Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.cloud.circuitbreaker.type (required)spring-doc.cn

Defines the type of wrapped lambda.spring-doc.cn

Observability - Spans

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

Circuit Breaker Function Observation Span

Observation created when we wrap a Function passed to the CircuitBreaker as fallback.spring-doc.cn

Span name spring.cloud.circuitbreaker (defined by convention class org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention).spring-doc.cn

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.spring-doc.cn

All tags must be prefixed with spring.cloud.circuitbreaker prefix!
Table 3. Tag Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.cloud.circuitbreaker.type (required)spring-doc.cn

Defines the type of wrapped lambda.spring-doc.cn

Circuit Breaker Supplier Observation Span

Observation created when we wrap a Supplier passed to the CircuitBreaker.spring-doc.cn

Span name spring.cloud.circuitbreaker (defined by convention class org.springframework.cloud.client.circuitbreaker.observation.DefaultCircuitBreakerObservationConvention).spring-doc.cn

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.spring-doc.cn

All tags must be prefixed with spring.cloud.circuitbreaker prefix!
Table 4. Tag Keys

Namespring-doc.cn

Descriptionspring-doc.cn

spring.cloud.circuitbreaker.type (required)spring-doc.cn

Defines the type of wrapped lambda.spring-doc.cn