Module org.elasticsearch.server

Package org.elasticsearch.telemetry.metric

Record Class LongGaugeMetric

java.lang.Object

java.lang.Record

org.elasticsearch.telemetry.metric.LongGaugeMetric

public record LongGaugeMetric(AtomicLong value, LongGauge gauge)
extends Record

This wrapper allow us to record metric with APM (via LongGauge) while also access its current state via AtomicLong

Constructor Summary

Constructors

Constructor	Description
LongGaugeMetric(AtomicLong value, LongGauge gauge)	Creates an instance of a LongGaugeMetric record class.

Method Summary

Modifier and Type	Method	Description
static LongGaugeMetric	create(MeterRegistry meterRegistry, String name, String description, String unit)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
LongGauge	gauge()	Returns the value of the gauge record component.
long	get()
final int	hashCode()	Returns a hash code value for this object.
void	set(long l)
final String	toString()	Returns a string representation of this record class.
AtomicLong	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

LongGaugeMetric

public LongGaugeMetric(AtomicLong value,
 LongGauge gauge)

Creates an instance of a LongGaugeMetric record class.

Parameters:

value - the value for the value record component

gauge - the value for the gauge record component

Method Details

create

public static LongGaugeMetric create(MeterRegistry meterRegistry,
 String name,
 String description,
 String unit)

set

public void set(long l)

get

public long get()

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.

value

public AtomicLong value()

Returns the value of the value record component.

Returns:

the value of the value record component

gauge

public LongGauge gauge()

Returns the value of the gauge record component.

Returns:

the value of the gauge record component