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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricData.AggregationTemporality	An enumeration which describes the time period over which metrics should be aggregated.
static class	MetricData.DoubleGaugeData
static class	MetricData.DoublePoint	DoublePoint is a single data point in a timeseries that describes the time-varying value of a double metric.
static class	MetricData.DoubleSumData
static class	MetricData.DoubleSummaryData
static class	MetricData.DoubleSummaryPoint	SummaryPoint is a single data point that summarizes the values in a time series of numeric values.
static class	MetricData.LongGaugeData
static class	MetricData.LongPoint	LongPoint is a single data point in a timeseries that describes the time-varying values of a int64 metric.
static class	MetricData.LongSumData
static class	MetricData.Point
static class	MetricData.Type	The kind of metric.
static class	MetricData.ValueAtPercentile

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, MetricData.DoubleGaugeData data)
static MetricData	createDoubleSum(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, MetricData.DoubleSumData data)
static MetricData	createDoubleSummary(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, MetricData.DoubleSummaryData data)
static MetricData	createLongGauge(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, MetricData.LongGaugeData data)
static MetricData	createLongSum(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, MetricData.LongSumData data)
abstract String	getDescription()	Returns the description of this metric.
MetricData.DoubleGaugeData	getDoubleGaugeData()	Returns the DoubleGaugeData if type is MetricData.Type.DOUBLE_GAUGE, otherwise a default empty data.
MetricData.DoubleSumData	getDoubleSumData()	Returns the DoubleSumData if type is MetricData.Type.DOUBLE_SUM, otherwise a default empty data.
MetricData.DoubleSummaryData	getDoubleSummaryData()	Returns the DoubleSummaryData if type is MetricData.Type.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.
MetricData.LongGaugeData	getLongGaugeData()	Returns the LongGaugeData if type is MetricData.Type.LONG_GAUGE, otherwise a default empty data.
MetricData.LongSumData	getLongSumData()	Returns the LongSumData if type is MetricData.Type.LONG_SUM, otherwise a default empty data.
abstract String	getName()	Returns the metric name.
Collection<MetricData.Point>	getPoints()	This method will be removed soon.
abstract io.opentelemetry.sdk.resources.Resource	getResource()	Returns the resource of this MetricData.
abstract MetricData.Type	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,
                                           MetricData.DoubleGaugeData data)

createLongGauge

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

createDoubleSum

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

createLongSum

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

createDoubleSummary

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

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 MetricData.Type 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 MetricData.DoubleGaugeData getDoubleGaugeData()

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

Returns:

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

getLongGaugeData

public final MetricData.LongGaugeData getLongGaugeData()

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

Returns:

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

getDoubleSumData

public final MetricData.DoubleSumData getDoubleSumData()

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

Returns:

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

getLongSumData

public final MetricData.LongSumData getLongSumData()

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

Returns:

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

getDoubleSummaryData

public final MetricData.DoubleSummaryData getDoubleSummaryData()

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

Returns:

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

getPoints

public Collection<MetricData.Point> getPoints()

This method will be removed soon.