Top Fields Constructors Methods
io.github.resilience4j.core.metrics

public Class SnapshotImpl

extends Object
implements Snapshot
Class Inheritance
All Implemented Interfaces
io.github.resilience4j.core.metrics.Snapshot
Imports
java.time.Duration, java.util.Objects

Field Summary

Modifier and TypeField and Description
private final long
totalDurationInMillis

private final int
totalNumberOfCalls

private final int
totalNumberOfFailedCalls

private final int
totalNumberOfSlowCalls

private final int
totalNumberOfSlowFailedCalls

Constructor Summary

AccessConstructor and Description
pack-priv
SnapshotImpl(MeasurementData measurementData)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public Duration
getAverageDuration()

Implements io.github.resilience4j.core.metrics.Snapshot.getAverageDuration.

Returns the current average duration of all calls.

public float
getFailureRate()

Implements io.github.resilience4j.core.metrics.Snapshot.getFailureRate.

Returns the current failure rate in percentage.

public int
getNumberOfFailedCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfFailedCalls.

Returns the current number of failed calls.

public int
getNumberOfSlowFailedCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfSlowFailedCalls.

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

public int
getNumberOfSlowSuccessfulCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfSlowSuccessfulCalls.

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

public int
getNumberOfSuccessfulCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfSuccessfulCalls.

Returns the current number of successful calls.

public float
getSlowCallRate()

Implements io.github.resilience4j.core.metrics.Snapshot.getSlowCallRate.

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

public Duration
getTotalDuration()

Implements io.github.resilience4j.core.metrics.Snapshot.getTotalDuration.

Returns the current total duration of all calls.

public int
getTotalNumberOfCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getTotalNumberOfCalls.

Returns the current total number of all calls.

public int
getTotalNumberOfSlowCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getTotalNumberOfSlowCalls.

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

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

totalDurationInMillisback to summary
private final long totalDurationInMillis
totalNumberOfCallsback to summary
private final int totalNumberOfCalls
totalNumberOfFailedCallsback to summary
private final int totalNumberOfFailedCalls
totalNumberOfSlowCallsback to summary
private final int totalNumberOfSlowCalls
totalNumberOfSlowFailedCallsback to summary
private final int totalNumberOfSlowFailedCalls

Constructor Detail

SnapshotImplback to summary
pack-priv SnapshotImpl(MeasurementData measurementData)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAverageDurationback to summary
public Duration getAverageDuration()

Implements io.github.resilience4j.core.metrics.Snapshot.getAverageDuration.

Doc from io.github.resilience4j.core.metrics.Snapshot.getAverageDuration.

Returns the current average duration of all calls.

Returns:Duration

the current average duration of all calls

Annotations
@Override
getFailureRateback to summary
public float getFailureRate()

Implements io.github.resilience4j.core.metrics.Snapshot.getFailureRate.

Doc from io.github.resilience4j.core.metrics.Snapshot.getFailureRate.

Returns the current failure rate in percentage.

Returns:float

the current failure rate in percentage

Annotations
@Override
getNumberOfFailedCallsback to summary
public int getNumberOfFailedCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfFailedCalls.

Doc from io.github.resilience4j.core.metrics.Snapshot.getNumberOfFailedCalls.

Returns the current number of failed calls.

Returns:int

the current number of failed calls

Annotations
@Override
getNumberOfSlowFailedCallsback to summary
public int getNumberOfSlowFailedCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfSlowFailedCalls.

Doc from io.github.resilience4j.core.metrics.Snapshot.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
getNumberOfSlowSuccessfulCallsback to summary
public int getNumberOfSlowSuccessfulCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfSlowSuccessfulCalls.

Doc from io.github.resilience4j.core.metrics.Snapshot.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
getNumberOfSuccessfulCallsback to summary
public int getNumberOfSuccessfulCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getNumberOfSuccessfulCalls.

Doc from io.github.resilience4j.core.metrics.Snapshot.getNumberOfSuccessfulCalls.

Returns the current number of successful calls.

Returns:int

the current number of successful calls

Annotations
@Override
getSlowCallRateback to summary
public float getSlowCallRate()

Implements io.github.resilience4j.core.metrics.Snapshot.getSlowCallRate.

Doc from io.github.resilience4j.core.metrics.Snapshot.getSlowCallRate.

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

Returns:float

the current percentage of calls which were slower than a certain threshold

Annotations
@Override
getTotalDurationback to summary
public Duration getTotalDuration()

Implements io.github.resilience4j.core.metrics.Snapshot.getTotalDuration.

Doc from io.github.resilience4j.core.metrics.Snapshot.getTotalDuration.

Returns the current total duration of all calls.

Returns:Duration

the current total duration of all calls

Annotations
@Override
getTotalNumberOfCallsback to summary
public int getTotalNumberOfCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getTotalNumberOfCalls.

Doc from io.github.resilience4j.core.metrics.Snapshot.getTotalNumberOfCalls.

Returns the current total number of all calls.

Returns:int

the current total number of all calls

Annotations
@Override
getTotalNumberOfSlowCallsback to summary
public int getTotalNumberOfSlowCalls()

Implements io.github.resilience4j.core.metrics.Snapshot.getTotalNumberOfSlowCalls.

Doc from io.github.resilience4j.core.metrics.Snapshot.getTotalNumberOfSlowCalls.

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

Returns:int

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

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override