Package io.opentelemetry.sdk.metrics.internal.descriptor

Class MetricDescriptor

java.lang.Object

io.opentelemetry.sdk.metrics.internal.descriptor.MetricDescriptor

Direct Known Subclasses:

AutoValue_MetricDescriptor

@Immutable
public abstract class MetricDescriptor
extends java.lang.Object

Describes a metric that will be output.

Provides equality/identity semantics for detecting duplicate metrics of incompatible.

This class is internal and is hence not for public use. Its APIs are unstable and can change at any time.

Field Summary

Fields

Modifier and Type	Field	Description
private int	hashcode
private java.util.concurrent.atomic.AtomicReference<SourceInfo>	viewSourceInfo

Constructor Summary

Constructors

Constructor	Description
MetricDescriptor()

Method Summary

Modifier and Type	Method	Description
static MetricDescriptor	create(View view, SourceInfo viewSourceInfo, InstrumentDescriptor instrument)	Constructs a metric descriptor for a given View + instrument.
static MetricDescriptor	create(java.lang.String name, java.lang.String description, java.lang.String unit)	Constructs a metric descriptor with no instrument and default view.
boolean	equals(java.lang.Object o)	Uses case-insensitive version of getName().
java.lang.String	getAggregationName()	The AggregationUtil.aggregationName(Aggregation) of the view aggregation.
abstract java.lang.String	getDescription()	The description of the descriptor, equal to View.getDescription() if not null, else InstrumentDescriptor.getDescription().
abstract java.lang.String	getName()	The name of the descriptor, equal to View.getName() if not null, else InstrumentDescriptor.getName().
abstract InstrumentDescriptor	getSourceInstrument()	The instrument which lead to the creation of this metric.
abstract View	getView()	The view that lead to the creation of this metric.
SourceInfo	getViewSourceInfo()	The SourceInfo from where the view was registered.
int	hashCode()	Uses case-insensitive version of getName().

Methods inherited from class java.lang.Object

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

Field Detail

viewSourceInfo

private final java.util.concurrent.atomic.AtomicReference<SourceInfo> viewSourceInfo

hashcode

private int hashcode

Constructor Detail

MetricDescriptor

MetricDescriptor()

Method Detail

create

public static MetricDescriptor create(java.lang.String name,
                                      java.lang.String description,
                                      java.lang.String unit)

Constructs a metric descriptor with no instrument and default view.

Used for testing + empty-storage only.

create

public static MetricDescriptor create(View view,
                                      SourceInfo viewSourceInfo,
                                      InstrumentDescriptor instrument)

Constructs a metric descriptor for a given View + instrument.

getName

public abstract java.lang.String getName()

The name of the descriptor, equal to View.getName() if not null, else InstrumentDescriptor.getName().

getDescription

public abstract java.lang.String getDescription()

The description of the descriptor, equal to View.getDescription() if not null, else InstrumentDescriptor.getDescription().

getView

public abstract View getView()

The view that lead to the creation of this metric.

getViewSourceInfo

public final SourceInfo getViewSourceInfo()

The SourceInfo from where the view was registered. Ignored from equals(Object) and Object.toString().

getSourceInstrument

public abstract InstrumentDescriptor getSourceInstrument()

The instrument which lead to the creation of this metric.

getAggregationName

public java.lang.String getAggregationName()

The AggregationUtil.aggregationName(Aggregation) of the view aggregation.

hashCode

public final int hashCode()

Uses case-insensitive version of getName().

Overrides:

hashCode in class java.lang.Object

equals

public final boolean equals(java.lang.Object o)

Uses case-insensitive version of getName().

Overrides:

equals in class java.lang.Object