io.opentelemetry.sdk.metrics.data

Class MetricData.Descriptor

java.lang.Object

io.opentelemetry.sdk.metrics.data.MetricData.Descriptor

Enclosing class:

MetricData

@Immutable
public abstract static class MetricData.Descriptor
extends Object

MetricData.Descriptor defines metadata about the MetricData type and its schema.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricData.Descriptor.Type The kind of metric.

Method Summary

Modifier and Type	Method and Description
static MetricData.Descriptor	create(String name, String description, String unit, MetricData.Descriptor.Type type, io.opentelemetry.common.Labels constantLabels)
abstract io.opentelemetry.common.Labels	getConstantLabels() Returns the constant labels associated with this metric descriptor.
abstract String	getDescription() Returns the description of this metric descriptor.
abstract String	getName() Returns the metric descriptor name.
abstract MetricData.Descriptor.Type	getType() Returns the type of this metric descriptor.
abstract String	getUnit() Returns the unit of this metric descriptor.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public abstract String getName()

Returns the metric descriptor name.

Returns:

the metric descriptor name.

Since:

0.1.0

getDescription

public abstract String getDescription()

Returns the description of this metric descriptor.

Returns:

the description of this metric descriptor.

Since:

0.1.0

getUnit

public abstract String getUnit()

Returns the unit of this metric descriptor.

Returns:

the unit of this metric descriptor.

Since:

0.1.0

getType

public abstract MetricData.Descriptor.Type getType()

Returns the type of this metric descriptor.

Returns:

the type of this metric descriptor.

Since:

0.1.0

getConstantLabels

public abstract io.opentelemetry.common.Labels getConstantLabels()

Returns the constant labels associated with this metric descriptor.

Returns:

the constant labels associated with this metric descriptor.

Since:

0.1.0

create

public static MetricData.Descriptor create(String name,
                                           String description,
                                           String unit,
                                           MetricData.Descriptor.Type type,
                                           io.opentelemetry.common.Labels constantLabels)