Modifier and Type	Class and Description
pack-priv static enum	CircuitBreakerMetrics.Result

Modifier and Type	Field and Description
private final float	failureRateThreshold
private final Metrics	metrics
private int	minimumNumberOfCalls
private final LongAdder	numberOfNotPermittedCalls
private final long	slowCallDurationThresholdInNanos
private final float	slowCallRateThreshold

Access	Constructor and Description
private	CircuitBreakerMetrics(int slidingWindowSize, CircuitBreakerConfig.SlidingWindowType slidingWindowType, CircuitBreakerConfig circuitBreakerConfig)
private	CircuitBreakerMetrics(int slidingWindowSize, CircuitBreakerConfig circuitBreakerConfig)

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

failureRateThreshold	back to summary
private final float failureRateThreshold

metrics	back to summary
private final Metrics metrics

minimumNumberOfCalls	back to summary
private int minimumNumberOfCalls

numberOfNotPermittedCalls	back to summary
private final LongAdder numberOfNotPermittedCalls

slowCallDurationThresholdInNanos	back to summary
private final long slowCallDurationThresholdInNanos

slowCallRateThreshold	back to summary
private final float slowCallRateThreshold

Constructor Detail

CircuitBreakerMetrics	back to summary
private CircuitBreakerMetrics(int slidingWindowSize, CircuitBreakerConfig.SlidingWindowType slidingWindowType, CircuitBreakerConfig circuitBreakerConfig)

CircuitBreakerMetrics	back to summary
private CircuitBreakerMetrics(int slidingWindowSize, CircuitBreakerConfig circuitBreakerConfig)

Method Detail

buildCountBasedMetrics	back to summary
private Metrics buildCountBasedMetrics(int slidingWindowSize, CircuitBreakerConfig.SlidingWindowSynchronizationStrategy slidingWindowSynchronizationStrategy)

buildTimeBasedMetrics	back to summary
private Metrics buildTimeBasedMetrics(int slidingWindowSize, Clock clock, CircuitBreakerConfig.SlidingWindowSynchronizationStrategy slidingWindowSynchronizationStrategy)

checkIfThresholdsExceeded	back to summary
private CircuitBreakerMetrics.Result checkIfThresholdsExceeded(Snapshot snapshot) Checks if the failure rate is above the threshold or if the slow calls percentage is above the threshold. Parameters snapshot:Snapshot a metrics snapshot Returns:CircuitBreakerMetrics.Result false, if the thresholds haven't been exceeded.

checkIfThresholdsExceeded

back to summary

private CircuitBreakerMetrics.Result checkIfThresholdsExceeded(Snapshot snapshot)

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

Parameters

snapshot:Snapshot: a metrics snapshot

Returns:CircuitBreakerMetrics.Result

false, if the thresholds haven't been exceeded.

forClosed	back to summary
pack-priv static CircuitBreakerMetrics forClosed(CircuitBreakerConfig circuitBreakerConfig)

forDisabled	back to summary
pack-priv static CircuitBreakerMetrics forDisabled(CircuitBreakerConfig circuitBreakerConfig)

forForcedOpen	back to summary
pack-priv static CircuitBreakerMetrics forForcedOpen(CircuitBreakerConfig circuitBreakerConfig)

forHalfOpen	back to summary
pack-priv static CircuitBreakerMetrics forHalfOpen(int permittedNumberOfCallsInHalfOpenState, CircuitBreakerConfig circuitBreakerConfig)

forMetricsOnly	back to summary
pack-priv static CircuitBreakerMetrics forMetricsOnly(CircuitBreakerConfig circuitBreakerConfig)

getFailureRate	back to summary
private float getFailureRate(Snapshot snapshot)

getFailureRate	back to summary
public float getFailureRate() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getFailureRate. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.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. Returns:float the failure rate in percentage Annotations @Override

getFailureRate

back to summary

public float getFailureRate()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getFailureRate.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.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.

Returns:float

the failure rate in percentage

Annotations

@Override

getNumberOfBufferedCalls	back to summary
public int getNumberOfBufferedCalls() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfBufferedCalls. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfBufferedCalls. Returns the current total number of buffered calls in the ring buffer. Returns:int he current total number of buffered calls in the ring buffer Annotations @Override

getNumberOfBufferedCalls

back to summary

public int getNumberOfBufferedCalls()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfBufferedCalls.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfBufferedCalls.

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

Returns:int

he current total number of buffered calls in the ring buffer

Annotations

@Override

getNumberOfFailedCalls	back to summary
public int getNumberOfFailedCalls() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfFailedCalls. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfFailedCalls. Returns the current number of failed buffered calls in the ring buffer. Returns:int the current number of failed buffered calls in the ring buffer Annotations @Override

getNumberOfFailedCalls

back to summary

public int getNumberOfFailedCalls()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfFailedCalls.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfFailedCalls.

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

Returns:int

the current number of failed buffered calls in the ring buffer

Annotations

@Override

getNumberOfNotPermittedCalls	back to summary
public long getNumberOfNotPermittedCalls() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfNotPermittedCalls. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.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. Returns:long the current number of not permitted calls Annotations @Override

getNumberOfNotPermittedCalls

back to summary

public long getNumberOfNotPermittedCalls()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfNotPermittedCalls.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.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.

Returns:long

the current number of not permitted calls

Annotations

@Override

getNumberOfSlowCalls	back to summary
public int getNumberOfSlowCalls() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowCalls. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowCalls. Returns the current total number of calls which were slower than a certain threshold. Returns:int the current total number of calls which were slower than a certain threshold Annotations @Override

getNumberOfSlowCalls

back to summary

public int getNumberOfSlowCalls()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowCalls.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowCalls.

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

Returns:int

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

Annotations

@Override

getNumberOfSlowFailedCalls	back to summary
public int getNumberOfSlowFailedCalls() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowFailedCalls. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowFailedCalls. Returns the current number of failed calls which were slower than a certain threshold. Returns:int the current number of failed calls which were slower than a certain threshold Annotations @Override

getNumberOfSlowFailedCalls

back to summary

public int getNumberOfSlowFailedCalls()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowFailedCalls.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowFailedCalls.

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

Returns:int

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

Annotations

@Override

getNumberOfSlowSuccessfulCalls	back to summary
public int getNumberOfSlowSuccessfulCalls() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowSuccessfulCalls. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowSuccessfulCalls. Returns the current number of successful calls which were slower than a certain threshold. Returns:int the current number of successful calls which were slower than a certain threshold Annotations @Override

getNumberOfSlowSuccessfulCalls

back to summary

public int getNumberOfSlowSuccessfulCalls()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowSuccessfulCalls.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSlowSuccessfulCalls.

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

Returns:int

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

Annotations

@Override

getNumberOfSuccessfulCalls	back to summary
public int getNumberOfSuccessfulCalls() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSuccessfulCalls. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSuccessfulCalls. Returns the current number of successful buffered calls in the ring buffer. Returns:int the current number of successful buffered calls in the ring buffer Annotations @Override

getNumberOfSuccessfulCalls

back to summary

public int getNumberOfSuccessfulCalls()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSuccessfulCalls.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getNumberOfSuccessfulCalls.

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

Returns:int

the current number of successful buffered calls in the ring buffer

Annotations

@Override

getSlowCallRate	back to summary
private float getSlowCallRate(Snapshot snapshot)

getSlowCallRate	back to summary
public float getSlowCallRate() Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getSlowCallRate. Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.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. Returns:float the failure rate in percentage Annotations @Override

getSlowCallRate

back to summary

public float getSlowCallRate()

Implements io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.getSlowCallRate.

Doc from io.github.resilience4j.circuitbreaker.CircuitBreaker.Metrics.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.

Returns:float

the failure rate in percentage

Annotations

@Override

onCallNotPermitted	back to summary
pack-priv void onCallNotPermitted() Records a call which was not permitted, because the CircuitBreaker state is OPEN.

onError	back to summary
public CircuitBreakerMetrics.Result onError(long duration, TimeUnit durationUnit) Records a failed call and checks if the thresholds are exceeded. Returns:CircuitBreakerMetrics.Result the result of the check

onError

back to summary

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

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

Returns:CircuitBreakerMetrics.Result: the result of the check

onSuccess	back to summary
public CircuitBreakerMetrics.Result onSuccess(long duration, TimeUnit durationUnit) Records a successful call and checks if the thresholds are exceeded. Returns:CircuitBreakerMetrics.Result the result of the check

onSuccess

back to summary

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

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

Returns:CircuitBreakerMetrics.Result: the result of the check

io.github.resilience4j.circuitbreaker.internal back to summary

pack-priv final Enum CircuitBreakerMetrics.Result

Class Inheritance

extends Enum<CircuitBreakerMetrics.Result>

java.lang.Object
java.lang.Enum
io.github.resilience4j.circuitbreaker.internal.CircuitBreakerMetrics.Result

Field Summary

Modifier and Type	Field and Description
public static final CircuitBreakerMetrics.Result	ABOVE_THRESHOLDS
public static final CircuitBreakerMetrics.Result	BELOW_MINIMUM_CALLS_THRESHOLD
public static final CircuitBreakerMetrics.Result	BELOW_THRESHOLDS
public static final CircuitBreakerMetrics.Result	FAILURE_RATE_ABOVE_THRESHOLDS
public static final CircuitBreakerMetrics.Result	SLOW_CALL_RATE_ABOVE_THRESHOLDS

Constructor Summary

Access	Constructor and Description
private	Result()

Method Summary

Modifier and Type	Method and Description
public static boolean	hasExceededThresholds(CircuitBreakerMetrics.Result result)
public static boolean	hasFailureRateExceededThreshold(CircuitBreakerMetrics.Result result)
public static boolean	hasSlowCallRateExceededThreshold(CircuitBreakerMetrics.Result result)
public static CircuitBreakerMetrics.Result	valueOf(String name)
public static CircuitBreakerMetrics.Result[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ABOVE_THRESHOLDS	back to summary
public static final CircuitBreakerMetrics.Result ABOVE_THRESHOLDS

BELOW_MINIMUM_CALLS_THRESHOLD	back to summary
public static final CircuitBreakerMetrics.Result BELOW_MINIMUM_CALLS_THRESHOLD

BELOW_THRESHOLDS	back to summary
public static final CircuitBreakerMetrics.Result BELOW_THRESHOLDS

FAILURE_RATE_ABOVE_THRESHOLDS	back to summary
public static final CircuitBreakerMetrics.Result FAILURE_RATE_ABOVE_THRESHOLDS

SLOW_CALL_RATE_ABOVE_THRESHOLDS	back to summary
public static final CircuitBreakerMetrics.Result SLOW_CALL_RATE_ABOVE_THRESHOLDS

Constructor Detail

Result	back to summary
private Result()

Method Detail

hasExceededThresholds	back to summary
public static boolean hasExceededThresholds(CircuitBreakerMetrics.Result result)

hasFailureRateExceededThreshold	back to summary
public static boolean hasFailureRateExceededThreshold(CircuitBreakerMetrics.Result result)

hasSlowCallRateExceededThreshold	back to summary
public static boolean hasSlowCallRateExceededThreshold(CircuitBreakerMetrics.Result result)

valueOf	back to summary
public static CircuitBreakerMetrics.Result valueOf(String name)

values	back to summary
public static CircuitBreakerMetrics.Result[] values()

pack-priv Class CircuitBreakerMetrics

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum CircuitBreakerMetrics.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail