Package io.grpc

Class LongGaugeMetricInstrument

java.lang.Object

io.grpc.LongGaugeMetricInstrument

All Implemented Interfaces:

CallbackMetricInstrument, MetricInstrument

@Internal
public final class LongGaugeMetricInstrument
extends Object
implements CallbackMetricInstrument

Represents a long-valued gauge metric instrument.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	description
protected final boolean	enableByDefault
protected final int	index
protected final String	name
protected final List<String>	optionalLabelKeys
protected final List<String>	requiredLabelKeys
protected final String	unit

Constructor Summary

Constructors

Constructor	Description
LongGaugeMetricInstrument(int index, String name, String description, String unit, List<String> requiredLabelKeys, List<String> optionalLabelKeys, boolean enableByDefault)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a description of the metric.
int	getIndex()	Returns the unique index of this metric instrument.
String	getName()	Returns the name of the metric.
List<String>	getOptionalLabelKeys()	Returns a list of optional label keys for this metric instrument.
List<String>	getRequiredLabelKeys()	Returns a list of required label keys for this metric instrument.
String	getUnit()	Returns the unit of measurement for the metric.
boolean	isEnableByDefault()	Indicates whether this metric instrument is enabled by default.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.grpc.MetricInstrument

getDescription, getIndex, getName, getOptionalLabelKeys, getRequiredLabelKeys, getUnit, isEnableByDefault

Field Details

index

protected final int index

name

protected final String name

description

protected final String description

unit

protected final String unit

requiredLabelKeys

protected final List<String> requiredLabelKeys

optionalLabelKeys

protected final List<String> optionalLabelKeys

enableByDefault

protected final boolean enableByDefault

Constructor Details

LongGaugeMetricInstrument

public LongGaugeMetricInstrument(int index,
 String name,
 String description,
 String unit,
 List<String> requiredLabelKeys,
 List<String> optionalLabelKeys,
 boolean enableByDefault)

Method Details

getIndex

public int getIndex()

Description copied from interface: MetricInstrument

Returns the unique index of this metric instrument.

Specified by:

getIndex in interface MetricInstrument

Returns:

the index of the metric instrument.

getName

public String getName()

Description copied from interface: MetricInstrument

Returns the name of the metric.

Specified by:

getName in interface MetricInstrument

Returns:

the name of the metric.

getDescription

public String getDescription()

Description copied from interface: MetricInstrument

Returns a description of the metric.

Specified by:

getDescription in interface MetricInstrument

Returns:

a description of the metric.

getUnit

public String getUnit()

Description copied from interface: MetricInstrument

Returns the unit of measurement for the metric.

Specified by:

getUnit in interface MetricInstrument

Returns:

the unit of measurement.

getRequiredLabelKeys

public List<String> getRequiredLabelKeys()

Description copied from interface: MetricInstrument

Returns a list of required label keys for this metric instrument.

Specified by:

getRequiredLabelKeys in interface MetricInstrument

Returns:

a list of required label keys.

getOptionalLabelKeys

public List<String> getOptionalLabelKeys()

Description copied from interface: MetricInstrument

Returns a list of optional label keys for this metric instrument.

Specified by:

getOptionalLabelKeys in interface MetricInstrument

Returns:

a list of optional label keys.

isEnableByDefault

public boolean isEnableByDefault()

Description copied from interface: MetricInstrument

Indicates whether this metric instrument is enabled by default.

Specified by:

isEnableByDefault in interface MetricInstrument

Returns:

true if this metric instrument is enabled by default, false otherwise.

toString

public String toString()

Overrides:

toString in class Object