Package io.github.resilience4j.prometheus

Class AbstractCircuitBreakerMetrics.MetricNames

java.lang.Object

io.github.resilience4j.prometheus.AbstractCircuitBreakerMetrics.MetricNames

Enclosing class:

AbstractCircuitBreakerMetrics

public static class AbstractCircuitBreakerMetrics.MetricNames
extends java.lang.Object

Defines possible configuration for metric names.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS
static java.lang.String	DEFAULT_CIRCUIT_BREAKER_CALLS
static java.lang.String	DEFAULT_CIRCUIT_BREAKER_FAILURE_RATE
static java.lang.String	DEFAULT_CIRCUIT_BREAKER_SLOW_CALL_RATE
static java.lang.String	DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS
static java.lang.String	DEFAULT_CIRCUIT_BREAKER_STATE

Method Summary

Modifier and Type	Method	Description
static AbstractCircuitBreakerMetrics.MetricNames.Builder	custom()	Returns a builder for creating custom metric names.
java.lang.String	getBufferedCallsMetricName()	Returns the metric name for currently buffered calls, defaults to "resilience4j_circuitbreaker_buffered_calls".
java.lang.String	getCallsMetricName()	Returns the metric name for circuit breaker calls, defaults to "resilience4j_circuitbreaker_calls".
java.lang.String	getFailureRateMetricName()	Returns the metric name for failure rate, defaults to "resilience4j_circuitbreaker_failure_rate".
java.lang.String	getSlowCallRateMetricName()	Returns the metric name for slow call rate, defaults to "resilience4j_circuitbreaker_slow_call_rate".
java.lang.String	getSlowCallsMetricName()	Returns the metric name for currently slow calls, defaults to "resilience4j_circuitbreaker_slow_calls".
java.lang.String	getStateMetricName()	Returns the metric name for state, defaults to "resilience4j_circuitbreaker_state".
static AbstractCircuitBreakerMetrics.MetricNames	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 java.lang.String DEFAULT_CIRCUIT_BREAKER_CALLS

See Also:

Constant Field Values

DEFAULT_CIRCUIT_BREAKER_STATE

public static final java.lang.String DEFAULT_CIRCUIT_BREAKER_STATE

See Also:

Constant Field Values

DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS

public static final java.lang.String DEFAULT_CIRCUIT_BREAKER_BUFFERED_CALLS

See Also:

Constant Field Values

DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS

public static final java.lang.String DEFAULT_CIRCUIT_BREAKER_SLOW_CALLS

See Also:

Constant Field Values

DEFAULT_CIRCUIT_BREAKER_FAILURE_RATE

public static final java.lang.String DEFAULT_CIRCUIT_BREAKER_FAILURE_RATE

See Also:

Constant Field Values

DEFAULT_CIRCUIT_BREAKER_SLOW_CALL_RATE

public static final java.lang.String DEFAULT_CIRCUIT_BREAKER_SLOW_CALL_RATE

See Also:

Constant Field Values

Method Details

custom

public static AbstractCircuitBreakerMetrics.MetricNames.Builder custom()

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

ofDefaults

public static AbstractCircuitBreakerMetrics.MetricNames ofDefaults()

Returns default metric names.

getCallsMetricName

public java.lang.String getCallsMetricName()

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

getBufferedCallsMetricName

public java.lang.String getBufferedCallsMetricName()

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

getSlowCallsMetricName

public java.lang.String getSlowCallsMetricName()

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

getFailureRateMetricName

public java.lang.String getFailureRateMetricName()

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

getSlowCallRateMetricName

public java.lang.String getSlowCallRateMetricName()

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

getStateMetricName

public java.lang.String getStateMetricName()

Returns the metric name for state, defaults to "resilience4j_circuitbreaker_state".