Module org.elasticsearch.server

Package org.elasticsearch.repositories

Record Class RepositoriesMetrics

java.lang.Object

java.lang.Record

org.elasticsearch.repositories.RepositoriesMetrics

public record RepositoriesMetrics(LongCounter requestCounter, LongCounter exceptionCounter, LongCounter throttleCounter, LongCounter operationCounter, LongCounter unsuccessfulOperationCounter, LongHistogram exceptionHistogram, LongHistogram throttleHistogram, LongHistogram httpRequestTimeInMicroHistogram)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HTTP_REQUEST_TIME_IN_MICROS_HISTOGRAM
static final String	METRIC_EXCEPTIONS_HISTOGRAM
static final String	METRIC_EXCEPTIONS_TOTAL
static final String	METRIC_OPERATIONS_TOTAL
static final String	METRIC_REQUESTS_TOTAL
static final String	METRIC_THROTTLES_HISTOGRAM
static final String	METRIC_THROTTLES_TOTAL
static final String	METRIC_UNSUCCESSFUL_OPERATIONS_TOTAL
static RepositoriesMetrics	NOOP

Constructor Summary

Constructors

Constructor	Description
RepositoriesMetrics(LongCounter requestCounter, LongCounter exceptionCounter, LongCounter throttleCounter, LongCounter operationCounter, LongCounter unsuccessfulOperationCounter, LongHistogram exceptionHistogram, LongHistogram throttleHistogram, LongHistogram httpRequestTimeInMicroHistogram)	Creates an instance of a RepositoriesMetrics record class.
RepositoriesMetrics(MeterRegistry meterRegistry)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
LongCounter	exceptionCounter()	Returns the value of the exceptionCounter record component.
LongHistogram	exceptionHistogram()	Returns the value of the exceptionHistogram record component.
final int	hashCode()	Returns a hash code value for this object.
LongHistogram	httpRequestTimeInMicroHistogram()	Returns the value of the httpRequestTimeInMicroHistogram record component.
LongCounter	operationCounter()	Returns the value of the operationCounter record component.
LongCounter	requestCounter()	Returns the value of the requestCounter record component.
LongCounter	throttleCounter()	Returns the value of the throttleCounter record component.
LongHistogram	throttleHistogram()	Returns the value of the throttleHistogram record component.
final String	toString()	Returns a string representation of this record class.
LongCounter	unsuccessfulOperationCounter()	Returns the value of the unsuccessfulOperationCounter record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NOOP

public static RepositoriesMetrics NOOP

METRIC_REQUESTS_TOTAL

public static final String METRIC_REQUESTS_TOTAL

See Also:

• Constant Field Values

METRIC_EXCEPTIONS_TOTAL

public static final String METRIC_EXCEPTIONS_TOTAL

See Also:

• Constant Field Values

METRIC_THROTTLES_TOTAL

public static final String METRIC_THROTTLES_TOTAL

See Also:

• Constant Field Values

METRIC_OPERATIONS_TOTAL

public static final String METRIC_OPERATIONS_TOTAL

See Also:

• Constant Field Values

METRIC_UNSUCCESSFUL_OPERATIONS_TOTAL

public static final String METRIC_UNSUCCESSFUL_OPERATIONS_TOTAL

See Also:

• Constant Field Values

METRIC_EXCEPTIONS_HISTOGRAM

public static final String METRIC_EXCEPTIONS_HISTOGRAM

See Also:

• Constant Field Values

METRIC_THROTTLES_HISTOGRAM

public static final String METRIC_THROTTLES_HISTOGRAM

See Also:

• Constant Field Values

HTTP_REQUEST_TIME_IN_MICROS_HISTOGRAM

public static final String HTTP_REQUEST_TIME_IN_MICROS_HISTOGRAM

See Also:

• Constant Field Values

Constructor Details

RepositoriesMetrics

public RepositoriesMetrics(MeterRegistry meterRegistry)

RepositoriesMetrics

public RepositoriesMetrics(LongCounter requestCounter,
 LongCounter exceptionCounter,
 LongCounter throttleCounter,
 LongCounter operationCounter,
 LongCounter unsuccessfulOperationCounter,
 LongHistogram exceptionHistogram,
 LongHistogram throttleHistogram,
 LongHistogram httpRequestTimeInMicroHistogram)

Creates an instance of a RepositoriesMetrics record class.

Parameters:

requestCounter - the value for the requestCounter record component

exceptionCounter - the value for the exceptionCounter record component

throttleCounter - the value for the throttleCounter record component

operationCounter - the value for the operationCounter record component

unsuccessfulOperationCounter - the value for the unsuccessfulOperationCounter record component

exceptionHistogram - the value for the exceptionHistogram record component

throttleHistogram - the value for the throttleHistogram record component

httpRequestTimeInMicroHistogram - the value for the httpRequestTimeInMicroHistogram record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

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

requestCounter

public LongCounter requestCounter()

Returns the value of the requestCounter record component.

Returns:

the value of the requestCounter record component

exceptionCounter

public LongCounter exceptionCounter()

Returns the value of the exceptionCounter record component.

Returns:

the value of the exceptionCounter record component

throttleCounter

public LongCounter throttleCounter()

Returns the value of the throttleCounter record component.

Returns:

the value of the throttleCounter record component

operationCounter

public LongCounter operationCounter()

Returns the value of the operationCounter record component.

Returns:

the value of the operationCounter record component

unsuccessfulOperationCounter

public LongCounter unsuccessfulOperationCounter()

Returns the value of the unsuccessfulOperationCounter record component.

Returns:

the value of the unsuccessfulOperationCounter record component

exceptionHistogram

public LongHistogram exceptionHistogram()

Returns the value of the exceptionHistogram record component.

Returns:

the value of the exceptionHistogram record component

throttleHistogram

public LongHistogram throttleHistogram()

Returns the value of the throttleHistogram record component.

Returns:

the value of the throttleHistogram record component

httpRequestTimeInMicroHistogram

public LongHistogram httpRequestTimeInMicroHistogram()

Returns the value of the httpRequestTimeInMicroHistogram record component.

Returns:

the value of the httpRequestTimeInMicroHistogram record component