This version is still in development and is not considered stable yet. For the latest stable version, please use Spring Cloud Commons 4.1.4!

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.

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.

Circuit Breaker Function Observation

Observation created when we wrap a Function passed to the CircuitBreaker as fallback.

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

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

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.

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

Name

Description

spring.cloud.circuitbreaker.type (required)

Defines the type of wrapped lambda.

Circuit Breaker Supplier Observation

Observation created when we wrap a Supplier passed to the CircuitBreaker.

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

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

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.

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

Name

Description

spring.cloud.circuitbreaker.type (required)

Defines the type of wrapped lambda.

Observability - Spans

Below you can find a list of all spans declared by this project.

Circuit Breaker Function Observation Span

Observation created when we wrap a Function passed to the CircuitBreaker as fallback.

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

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.

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

Name

Description

spring.cloud.circuitbreaker.type (required)

Defines the type of wrapped lambda.

Circuit Breaker Supplier Observation Span

Observation created when we wrap a Supplier passed to the CircuitBreaker.

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

Fully qualified name of the enclosing class org.springframework.cloud.client.circuitbreaker.observation.CircuitBreakerObservationDocumentation.

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

Name

Description

spring.cloud.circuitbreaker.type (required)

Defines the type of wrapped lambda.