Package io.opentelemetry.sdk.metrics.data

Class MetricData

java.lang.Object

io.opentelemetry.sdk.metrics.data.MetricData

@Immutable
public abstract class MetricData
extends Object

A MetricData represents the data exported as part of aggregating one Instrument.

Method Summary

Modifier and Type	Method	Description
static MetricData	createDoubleGauge(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, DoubleGaugeData data)	Returns a new MetricData wih a MetricDataType.DOUBLE_GAUGE type.
static MetricData	createDoubleHistogram(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, DoubleHistogramData data)	Returns a new MetricData with a MetricDataType.HISTOGRAM type.
static MetricData	createDoubleSum(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, DoubleSumData data)	Returns a new MetricData wih a MetricDataType.DOUBLE_SUM type.
static MetricData	createDoubleSummary(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, DoubleSummaryData data)	Returns a new MetricData wih a MetricDataType.SUMMARY type.
static MetricData	createLongGauge(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, LongGaugeData data)	Returns a new MetricData wih a MetricDataType.LONG_GAUGE type.
static MetricData	createLongSum(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, LongSumData data)	Returns a new MetricData wih a MetricDataType.LONG_SUM type.
abstract String	getDescription()	Returns the description of this metric.
DoubleGaugeData	getDoubleGaugeData()	Returns the DoubleGaugeData if type is MetricDataType.DOUBLE_GAUGE, otherwise a default empty data.
DoubleHistogramData	getDoubleHistogramData()	Returns the DoubleHistogramData if type is MetricDataType.HISTOGRAM, otherwise a default empty data.
DoubleSumData	getDoubleSumData()	Returns the DoubleSumData if type is MetricDataType.DOUBLE_SUM, otherwise a default empty data.
DoubleSummaryData	getDoubleSummaryData()	Returns the DoubleSummaryData if type is MetricDataType.SUMMARY, otherwise a default empty data.
abstract io.opentelemetry.sdk.common.InstrumentationLibraryInfo	getInstrumentationLibraryInfo()	Returns the instrumentation library specified when creating the Meter which created the Instrument that produces MetricData.
LongGaugeData	getLongGaugeData()	Returns the LongGaugeData if type is MetricDataType.LONG_GAUGE, otherwise a default empty data.
LongSumData	getLongSumData()	Returns the LongSumData if type is MetricDataType.LONG_SUM, otherwise a default empty data.
abstract String	getName()	Returns the metric name.
abstract io.opentelemetry.sdk.resources.Resource	getResource()	Returns the resource of this MetricData.
abstract MetricDataType	getType()	Returns the type of this metric.
abstract String	getUnit()	Returns the unit of this metric.
boolean	isEmpty()	Returns true if there are no points associated with this metric.

Methods inherited from class java.lang.Object

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

Method Detail

createDoubleGauge

public static MetricData createDoubleGauge(io.opentelemetry.sdk.resources.Resource resource,
                                           io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
                                           String name,
                                           String description,
                                           String unit,
                                           DoubleGaugeData data)

Returns a new MetricData wih a MetricDataType.DOUBLE_GAUGE type.

Returns:

a new MetricData wih a MetricDataType.DOUBLE_GAUGE type.

createLongGauge

public static MetricData createLongGauge(io.opentelemetry.sdk.resources.Resource resource,
                                         io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
                                         String name,
                                         String description,
                                         String unit,
                                         LongGaugeData data)

Returns a new MetricData wih a MetricDataType.LONG_GAUGE type.

Returns:

a new MetricData wih a MetricDataType.LONG_GAUGE type.

createDoubleSum

public static MetricData createDoubleSum(io.opentelemetry.sdk.resources.Resource resource,
                                         io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
                                         String name,
                                         String description,
                                         String unit,
                                         DoubleSumData data)

Returns a new MetricData wih a MetricDataType.DOUBLE_SUM type.

Returns:

a new MetricData wih a MetricDataType.DOUBLE_SUM type.

createLongSum

public static MetricData createLongSum(io.opentelemetry.sdk.resources.Resource resource,
                                       io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
                                       String name,
                                       String description,
                                       String unit,
                                       LongSumData data)

Returns a new MetricData wih a MetricDataType.LONG_SUM type.

Returns:

a new MetricData wih a MetricDataType.LONG_SUM type.

createDoubleSummary

public static MetricData createDoubleSummary(io.opentelemetry.sdk.resources.Resource resource,
                                             io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
                                             String name,
                                             String description,
                                             String unit,
                                             DoubleSummaryData data)

Returns a new MetricData wih a MetricDataType.SUMMARY type.

Returns:

a new MetricData wih a MetricDataType.SUMMARY type.

createDoubleHistogram

public static MetricData createDoubleHistogram(io.opentelemetry.sdk.resources.Resource resource,
                                               io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
                                               String name,
                                               String description,
                                               String unit,
                                               DoubleHistogramData data)

Returns a new MetricData with a MetricDataType.HISTOGRAM type.

Returns:

a new MetricData wih a MetricDataType.HISTOGRAM type.

getResource

public abstract io.opentelemetry.sdk.resources.Resource getResource()

Returns the resource of this MetricData.

Returns:

the resource of this MetricData.

getInstrumentationLibraryInfo

public abstract io.opentelemetry.sdk.common.InstrumentationLibraryInfo getInstrumentationLibraryInfo()

Returns the instrumentation library specified when creating the Meter which created the Instrument that produces MetricData.

Returns:

an instance of InstrumentationLibraryInfo

getName

public abstract String getName()

Returns the metric name.

Returns:

the metric name.

getDescription

public abstract String getDescription()

Returns the description of this metric.

Returns:

the description of this metric.

getUnit

public abstract String getUnit()

Returns the unit of this metric.

Returns:

the unit of this metric.

getType

public abstract MetricDataType getType()

Returns the type of this metric.

Returns:

the type of this metric.

isEmpty

public boolean isEmpty()

Returns true if there are no points associated with this metric.

Returns:

true if there are no points associated with this metric.

getDoubleGaugeData

public final DoubleGaugeData getDoubleGaugeData()

Returns the DoubleGaugeData if type is MetricDataType.DOUBLE_GAUGE, otherwise a default empty data.

Returns:

the DoubleGaugeData if type is MetricDataType.DOUBLE_GAUGE, otherwise a default empty data.

getLongGaugeData

public final LongGaugeData getLongGaugeData()

Returns the LongGaugeData if type is MetricDataType.LONG_GAUGE, otherwise a default empty data.

Returns:

the LongGaugeData if type is MetricDataType.LONG_GAUGE, otherwise a default empty data.

getDoubleSumData

public final DoubleSumData getDoubleSumData()

Returns the DoubleSumData if type is MetricDataType.DOUBLE_SUM, otherwise a default empty data.

Returns:

the DoubleSumData if type is MetricDataType.DOUBLE_SUM, otherwise a default empty data.

getLongSumData

public final LongSumData getLongSumData()

Returns the LongSumData if type is MetricDataType.LONG_SUM, otherwise a default empty data.

Returns:

the LongSumData if type is MetricDataType.LONG_SUM, otherwise a default empty data.

getDoubleSummaryData

public final DoubleSummaryData getDoubleSummaryData()

Returns the DoubleSummaryData if type is MetricDataType.SUMMARY, otherwise a default empty data.

Returns:

the DoubleSummaryData if type is MetricDataType.SUMMARY, otherwise a default * empty data.

getDoubleHistogramData

public final DoubleHistogramData getDoubleHistogramData()

Returns the DoubleHistogramData if type is MetricDataType.HISTOGRAM, otherwise a default empty data.

Returns:

the DoubleHistogramData if type is MetricDataType.HISTOGRAM, otherwise a default empty data.