Class CircuitBreakerMetrics

java.lang.Object

io.github.resilience4j.circuitbreaker.internal.CircuitBreakerMetrics

All Implemented Interfaces:

CircuitBreaker.Metrics

class CircuitBreakerMetrics
extends Object
implements CircuitBreaker.Metrics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	CircuitBreakerMetrics.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final float	failureRateThreshold
private final io.github.resilience4j.core.metrics.Metrics	metrics
private int	minimumNumberOfCalls
private final LongAdder	numberOfNotPermittedCalls
private final long	slowCallDurationThresholdInNanos
private final float	slowCallRateThreshold

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CircuitBreakerMetrics(int slidingWindowSize, CircuitBreakerConfig.SlidingWindowType slidingWindowType, CircuitBreakerConfig circuitBreakerConfig, Clock clock)
private	CircuitBreakerMetrics(int slidingWindowSize, CircuitBreakerConfig circuitBreakerConfig, Clock clock)

Method Summary

Modifier and Type	Method	Description
private CircuitBreakerMetrics.Result	checkIfThresholdsExceeded(io.github.resilience4j.core.metrics.Snapshot snapshot)	Checks if the failure rate is above the threshold or if the slow calls percentage is above the threshold.
(package private) static CircuitBreakerMetrics	forClosed(CircuitBreakerConfig circuitBreakerConfig, Clock clock)
(package private) static CircuitBreakerMetrics	forDisabled(CircuitBreakerConfig circuitBreakerConfig, Clock clock)
(package private) static CircuitBreakerMetrics	forForcedOpen(CircuitBreakerConfig circuitBreakerConfig, Clock clock)
(package private) static CircuitBreakerMetrics	forHalfOpen(int permittedNumberOfCallsInHalfOpenState, CircuitBreakerConfig circuitBreakerConfig, Clock clock)
(package private) static CircuitBreakerMetrics	forMetricsOnly(CircuitBreakerConfig circuitBreakerConfig, Clock clock)
float	getFailureRate()	Returns the current failure rate in percentage.
private float	getFailureRate(io.github.resilience4j.core.metrics.Snapshot snapshot)
int	getNumberOfBufferedCalls()	Returns the current total number of buffered calls in the ring buffer.
int	getNumberOfFailedCalls()	Returns the current number of failed buffered calls in the ring buffer.
long	getNumberOfNotPermittedCalls()	Returns the current number of not permitted calls, when the state is OPEN.
int	getNumberOfSlowCalls()	Returns the current total number of calls which were slower than a certain threshold.
int	getNumberOfSlowFailedCalls()	Returns the current number of failed calls which were slower than a certain threshold.
int	getNumberOfSlowSuccessfulCalls()	Returns the current number of successful calls which were slower than a certain threshold.
int	getNumberOfSuccessfulCalls()	Returns the current number of successful buffered calls in the ring buffer.
float	getSlowCallRate()	Returns the current percentage of calls which were slower than a certain threshold.
private float	getSlowCallRate(io.github.resilience4j.core.metrics.Snapshot snapshot)
(package private) void	onCallNotPermitted()	Records a call which was not permitted, because the CircuitBreaker state is OPEN.
CircuitBreakerMetrics.Result	onError(long duration, TimeUnit durationUnit)	Records a failed call and checks if the thresholds are exceeded.
CircuitBreakerMetrics.Result	onSuccess(long duration, TimeUnit durationUnit)	Records a successful call and checks if the thresholds are exceeded.

Methods inherited from class Object

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

Field Details

metrics

private final io.github.resilience4j.core.metrics.Metrics metrics

failureRateThreshold

private final float failureRateThreshold

slowCallRateThreshold

private final float slowCallRateThreshold

slowCallDurationThresholdInNanos

private final long slowCallDurationThresholdInNanos

numberOfNotPermittedCalls

private final LongAdder numberOfNotPermittedCalls

minimumNumberOfCalls

private int minimumNumberOfCalls

Constructor Details

CircuitBreakerMetrics

private CircuitBreakerMetrics(int slidingWindowSize,
 CircuitBreakerConfig.SlidingWindowType slidingWindowType,
 CircuitBreakerConfig circuitBreakerConfig,
 Clock clock)

CircuitBreakerMetrics

private CircuitBreakerMetrics(int slidingWindowSize,
 CircuitBreakerConfig circuitBreakerConfig,
 Clock clock)

Method Details

forClosed

static CircuitBreakerMetrics forClosed(CircuitBreakerConfig circuitBreakerConfig,
 Clock clock)

forHalfOpen

static CircuitBreakerMetrics forHalfOpen(int permittedNumberOfCallsInHalfOpenState,
 CircuitBreakerConfig circuitBreakerConfig,
 Clock clock)

forForcedOpen

static CircuitBreakerMetrics forForcedOpen(CircuitBreakerConfig circuitBreakerConfig,
 Clock clock)

forDisabled

static CircuitBreakerMetrics forDisabled(CircuitBreakerConfig circuitBreakerConfig,
 Clock clock)

forMetricsOnly

static CircuitBreakerMetrics forMetricsOnly(CircuitBreakerConfig circuitBreakerConfig,
 Clock clock)

onCallNotPermitted

void onCallNotPermitted()

Records a call which was not permitted, because the CircuitBreaker state is OPEN.

onSuccess

public CircuitBreakerMetrics.Result onSuccess(long duration,
 TimeUnit durationUnit)

Records a successful call and checks if the thresholds are exceeded.

Returns:

the result of the check

onError

public CircuitBreakerMetrics.Result onError(long duration,
 TimeUnit durationUnit)

Records a failed call and checks if the thresholds are exceeded.

Returns:

the result of the check

checkIfThresholdsExceeded

private CircuitBreakerMetrics.Result checkIfThresholdsExceeded(io.github.resilience4j.core.metrics.Snapshot snapshot)

Checks if the failure rate is above the threshold or if the slow calls percentage is above the threshold.

Parameters:

snapshot - a metrics snapshot

Returns:

false, if the thresholds haven't been exceeded.

getSlowCallRate

private float getSlowCallRate(io.github.resilience4j.core.metrics.Snapshot snapshot)

getFailureRate

private float getFailureRate(io.github.resilience4j.core.metrics.Snapshot snapshot)

getFailureRate

public float getFailureRate()

Returns the current failure rate in percentage. If the number of measured calls is below the minimum number of measured calls, it returns -1.

Specified by:

getFailureRate in interface CircuitBreaker.Metrics

Returns:

the failure rate in percentage

getSlowCallRate

public float getSlowCallRate()

Returns the current percentage of calls which were slower than a certain threshold. If the number of measured calls is below the minimum number of measured calls, it returns -1.

Specified by:

getSlowCallRate in interface CircuitBreaker.Metrics

Returns:

the failure rate in percentage

getNumberOfSuccessfulCalls

public int getNumberOfSuccessfulCalls()

Returns the current number of successful buffered calls in the ring buffer.

Specified by:

getNumberOfSuccessfulCalls in interface CircuitBreaker.Metrics

Returns:

the current number of successful buffered calls in the ring buffer

getNumberOfBufferedCalls

public int getNumberOfBufferedCalls()

Returns the current total number of buffered calls in the ring buffer.

Specified by:

getNumberOfBufferedCalls in interface CircuitBreaker.Metrics

Returns:

he current total number of buffered calls in the ring buffer

getNumberOfFailedCalls

public int getNumberOfFailedCalls()

Description copied from interface: CircuitBreaker.Metrics

Returns the current number of failed buffered calls in the ring buffer.

Specified by:

getNumberOfFailedCalls in interface CircuitBreaker.Metrics

Returns:

the current number of failed buffered calls in the ring buffer

getNumberOfSlowCalls

public int getNumberOfSlowCalls()

Description copied from interface: CircuitBreaker.Metrics

Returns the current total number of calls which were slower than a certain threshold.

Specified by:

getNumberOfSlowCalls in interface CircuitBreaker.Metrics

Returns:

the current total number of calls which were slower than a certain threshold

getNumberOfSlowSuccessfulCalls

public int getNumberOfSlowSuccessfulCalls()

Description copied from interface: CircuitBreaker.Metrics

Returns the current number of successful calls which were slower than a certain threshold.

Specified by:

getNumberOfSlowSuccessfulCalls in interface CircuitBreaker.Metrics

Returns:

the current number of successful calls which were slower than a certain threshold

getNumberOfSlowFailedCalls

public int getNumberOfSlowFailedCalls()

Description copied from interface: CircuitBreaker.Metrics

Returns the current number of failed calls which were slower than a certain threshold.

Specified by:

getNumberOfSlowFailedCalls in interface CircuitBreaker.Metrics

Returns:

the current number of failed calls which were slower than a certain threshold

getNumberOfNotPermittedCalls

public long getNumberOfNotPermittedCalls()

Returns the current number of not permitted calls, when the state is OPEN.

The number of denied calls is always 0, when the CircuitBreaker state is CLOSED or HALF_OPEN. The number of denied calls is only increased when the CircuitBreaker state is OPEN.

Specified by:

getNumberOfNotPermittedCalls in interface CircuitBreaker.Metrics

Returns:

the current number of not permitted calls