Package io.opentelemetry.sdk.metrics.data

Interface MetricData

@Immutable
public interface MetricData

A MetricDataImpl 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, GaugeData<DoublePointData> 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, HistogramData 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, SumData<DoublePointData> 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, SummaryData data)	Returns a new MetricData wih a MetricDataType.SUMMARY type.
static MetricData	createExponentialHistogram(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, io.opentelemetry.sdk.metrics.internal.data.exponentialhistogram.ExponentialHistogramData data)	Returns a new MetricData with a MetricDataType.EXPONENTIAL_HISTOGRAM type.
static MetricData	createLongGauge(io.opentelemetry.sdk.resources.Resource resource, io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo, String name, String description, String unit, GaugeData<LongPointData> 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, SumData<LongPointData> data)	Returns a new MetricData wih a MetricDataType.LONG_SUM type.
Data<?>	getData()
String	getDescription()	Returns the description of this metric.
default GaugeData<DoublePointData>	getDoubleGaugeData()	Returns the DoubleGaugeData if type is MetricDataType.DOUBLE_GAUGE, otherwise a default empty data.
default SumData<DoublePointData>	getDoubleSumData()	Returns the DoubleSumData if type is MetricDataType.DOUBLE_SUM, otherwise a default empty data.
default HistogramData	getHistogramData()	Returns the DoubleHistogramData if type is MetricDataType.HISTOGRAM, otherwise a default empty data.
io.opentelemetry.sdk.common.InstrumentationLibraryInfo	getInstrumentationLibraryInfo()	Returns the instrumentation library specified when creating the Meter which created the Instrument that produces MetricData.
default GaugeData<LongPointData>	getLongGaugeData()	Returns the LongGaugeData if type is MetricDataType.LONG_GAUGE, otherwise a default empty data.
default SumData<LongPointData>	getLongSumData()	Returns the LongSumData if type is MetricDataType.LONG_SUM, otherwise a default empty data.
String	getName()	Returns the metric name.
io.opentelemetry.sdk.resources.Resource	getResource()	Returns the resource of this MetricData.
default SummaryData	getSummaryData()	Returns the DoubleSummaryData if type is MetricDataType.SUMMARY, otherwise a default empty data.
MetricDataType	getType()	Returns the type of this metric.
String	getUnit()	Returns the unit of this metric.
default boolean	isEmpty()	Returns true if there are no points associated with this metric.

Method Details

createDoubleGauge

static MetricData createDoubleGauge(io.opentelemetry.sdk.resources.Resource resource,
 io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
 String name,
 String description,
 String unit,
 GaugeData<DoublePointData> data)

Returns a new MetricData wih a MetricDataType.DOUBLE_GAUGE type.

Returns:

a new MetricData wih a MetricDataType.DOUBLE_GAUGE type.

createLongGauge

static MetricData createLongGauge(io.opentelemetry.sdk.resources.Resource resource,
 io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
 String name,
 String description,
 String unit,
 GaugeData<LongPointData> data)

Returns a new MetricData wih a MetricDataType.LONG_GAUGE type.

Returns:

a new MetricData wih a MetricDataType.LONG_GAUGE type.

createDoubleSum

static MetricData createDoubleSum(io.opentelemetry.sdk.resources.Resource resource,
 io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
 String name,
 String description,
 String unit,
 SumData<DoublePointData> data)

Returns a new MetricData wih a MetricDataType.DOUBLE_SUM type.

Returns:

a new MetricData wih a MetricDataType.DOUBLE_SUM type.

createLongSum

static MetricData createLongSum(io.opentelemetry.sdk.resources.Resource resource,
 io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
 String name,
 String description,
 String unit,
 SumData<LongPointData> data)

Returns a new MetricData wih a MetricDataType.LONG_SUM type.

Returns:

a new MetricData wih a MetricDataType.LONG_SUM type.

createDoubleSummary

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

Returns a new MetricData wih a MetricDataType.SUMMARY type.

Returns:

a new MetricData wih a MetricDataType.SUMMARY type.

createDoubleHistogram

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

Returns a new MetricData with a MetricDataType.HISTOGRAM type.

Returns:

a new MetricData wih a MetricDataType.HISTOGRAM type.

createExponentialHistogram

static MetricData createExponentialHistogram(io.opentelemetry.sdk.resources.Resource resource,
 io.opentelemetry.sdk.common.InstrumentationLibraryInfo instrumentationLibraryInfo,
 String name,
 String description,
 String unit,
 io.opentelemetry.sdk.metrics.internal.data.exponentialhistogram.ExponentialHistogramData data)

Returns a new MetricData with a MetricDataType.EXPONENTIAL_HISTOGRAM type.

Returns:

a new MetricData wih a MetricDataType.EXPONENTIAL_HISTOGRAM type.

getResource

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

Returns the resource of this MetricData.

Returns:

the resource of this MetricData.

getInstrumentationLibraryInfo

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

String getName()

Returns the metric name.

Returns:

the metric name.

getDescription

String getDescription()

Returns the description of this metric.

Returns:

the description of this metric.

getUnit

String getUnit()

Returns the unit of this metric.

Returns:

the unit of this metric.

getType

MetricDataType getType()

Returns the type of this metric.

Returns:

the type of this metric.

getData

Data<?> getData()

isEmpty

default 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

default GaugeData<DoublePointData> 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

default GaugeData<LongPointData> 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

default SumData<DoublePointData> 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

default SumData<LongPointData> 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.

getSummaryData

default SummaryData getSummaryData()

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.

getHistogramData

default HistogramData getHistogramData()

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.