Package io.github.resilience4j.micrometer.tagged

Class CircuitBreakerMetricNames

java.lang.Object

io.github.resilience4j.micrometer.tagged.CircuitBreakerMetricNames

public class CircuitBreakerMetricNames
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CircuitBreakerMetricNames.Builder	Helps building custom instance of CircuitBreakerMetricNames.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS
static final String	DEFAULT_CIRCUIT_BREAKER_CALLS
static final String	DEFAULT_CIRCUIT_BREAKER_FAILURE_RATE
static final String	DEFAULT_CIRCUIT_BREAKER_NOT_PERMITTED_CALLS
static final String	DEFAULT_CIRCUIT_BREAKER_SLOW_CALL_RATE
static final String	DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS
static final String	DEFAULT_CIRCUIT_BREAKER_STATE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CircuitBreakerMetricNames()

Method Summary

Modifier and Type	Method	Description
static CircuitBreakerMetricNames.Builder	custom()	Returns a builder for creating custom metric names.
String	getBufferedCallsMetricName()	Returns the metric name for currently buffered calls, defaults to "resilience4j.circuitbreaker.buffered.calls".
String	getCallsMetricName()	Returns the metric name for circuit breaker calls, defaults to "resilience4j.circuitbreaker.calls".
String	getFailureRateMetricName()	Returns the metric name for failure rate, defaults to "resilience4j.circuitbreaker.failure.rate".
String	getNotPermittedCallsMetricName()	Returns the metric name for circuit breaker not permitted calls, defaults to "resilience4j.circuitbreaker.not.permitted.calls".
String	getSlowCallRateMetricName()	Returns the metric name for slow call rate, defaults to "resilience4j.circuitbreaker.slow.call.rate".
String	getSlowCallsMetricName()	Returns the metric name for currently slow calls, defaults to "resilience4j.circuitbreaker.slow.calls".
String	getStateMetricName()	Returns the metric name for state, defaults to "resilience4j.circuitbreaker.state".
static CircuitBreakerMetricNames	ofDefaults()	Returns default metric names.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_CIRCUIT_BREAKER_CALLS

public static final String DEFAULT_CIRCUIT_BREAKER_CALLS

See Also:

• Constant Field Values

DEFAULT_CIRCUIT_BREAKER_NOT_PERMITTED_CALLS

public static final String DEFAULT_CIRCUIT_BREAKER_NOT_PERMITTED_CALLS

See Also:

• Constant Field Values

DEFAULT_CIRCUIT_BREAKER_STATE

public static final String DEFAULT_CIRCUIT_BREAKER_STATE

See Also:

• Constant Field Values

DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS

public static final String DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS

See Also:

• Constant Field Values

DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS

public static final String DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS

See Also:

• Constant Field Values

DEFAULT_CIRCUIT_BREAKER_FAILURE_RATE

public static final String DEFAULT_CIRCUIT_BREAKER_FAILURE_RATE

See Also:

• Constant Field Values

DEFAULT_CIRCUIT_BREAKER_SLOW_CALL_RATE

public static final String DEFAULT_CIRCUIT_BREAKER_SLOW_CALL_RATE

See Also:

• Constant Field Values

Constructor Details

CircuitBreakerMetricNames

protected CircuitBreakerMetricNames()

Method Details

custom

public static CircuitBreakerMetricNames.Builder custom()

Returns a builder for creating custom metric names. Note that names have default values, so only desired metrics can be renamed.

Returns:

The builder.

ofDefaults

public static CircuitBreakerMetricNames ofDefaults()

Returns default metric names.

Returns:

The default CircuitBreakerMetricNames instance.

getCallsMetricName

public String getCallsMetricName()

Returns the metric name for circuit breaker calls, defaults to "resilience4j.circuitbreaker.calls".

Returns:

The circuit breaker calls metric name.

getNotPermittedCallsMetricName

public String getNotPermittedCallsMetricName()

Returns the metric name for circuit breaker not permitted calls, defaults to "resilience4j.circuitbreaker.not.permitted.calls".

Returns:

The circuit breaker not permitted calls metric name.

getBufferedCallsMetricName

public String getBufferedCallsMetricName()

Returns the metric name for currently buffered calls, defaults to "resilience4j.circuitbreaker.buffered.calls".

Returns:

The buffered calls metric name.

getSlowCallsMetricName

public String getSlowCallsMetricName()

Returns the metric name for currently slow calls, defaults to "resilience4j.circuitbreaker.slow.calls".

Returns:

The slow calls metric name.

getStateMetricName

public String getStateMetricName()

Returns the metric name for state, defaults to "resilience4j.circuitbreaker.state".

Returns:

The state metric name.

getFailureRateMetricName

public String getFailureRateMetricName()

Returns the metric name for failure rate, defaults to "resilience4j.circuitbreaker.failure.rate".

Returns:

The failure rate metric name.

getSlowCallRateMetricName

public String getSlowCallRateMetricName()

Returns the metric name for slow call rate, defaults to "resilience4j.circuitbreaker.slow.call.rate".

Returns:

The failure rate metric name.