Package io.opentelemetry.sdk.metrics.data

Interface MetricData

@Immutable
public interface MetricData

Metric data represents the aggregated measurements of an instrument.

Since:

1.14.0

Method Summary

Modifier and Type	Method	Description
Data<?>	getData()	Returns the unconstrained metric data.
String	getDescription()	Returns the metric description.
default GaugeData<DoublePointData>	getDoubleGaugeData()	Returns the double GaugeData if type is MetricDataType.DOUBLE_GAUGE, otherwise a default empty data.
default SumData<DoublePointData>	getDoubleSumData()	Returns the double SumData if type is MetricDataType.DOUBLE_SUM, otherwise a default empty data.
default HistogramData	getHistogramData()	Returns the HistogramData if type is MetricDataType.HISTOGRAM, otherwise a default empty data.
io.opentelemetry.sdk.common.InstrumentationScopeInfo	getInstrumentationScopeInfo()	Returns the metric InstrumentationScopeInfo.
default GaugeData<LongPointData>	getLongGaugeData()	Returns the long GaugeData if type is MetricDataType.LONG_GAUGE, otherwise a default empty data.
default SumData<LongPointData>	getLongSumData()	Returns the long SumData 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 metric Resource.
default SummaryData	getSummaryData()	Returns the SummaryData if type is MetricDataType.SUMMARY, otherwise a default empty data.
MetricDataType	getType()	Returns the type of this metric.
String	getUnit()	Returns the metric unit.
default boolean	isEmpty()	Returns true if there are no points associated with this metric.

Method Details

getResource

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

Returns the metric Resource.

The Resource is configured via SdkMeterProviderBuilder.setResource(Resource).

getInstrumentationScopeInfo

io.opentelemetry.sdk.common.InstrumentationScopeInfo getInstrumentationScopeInfo()

Returns the metric InstrumentationScopeInfo.

The InstrumentationScopeInfo is determined from the options used when MeterBuilder.build()ing the Meter.

getName

String getName()

Returns the metric name.

The metric name is typically the instrument name, but may be optionally overridden by a View.

getDescription

String getDescription()

Returns the metric description.

The metric name is typically the instrument description, but may be optionally overridden by a View.

getUnit

String getUnit()

Returns the metric unit.

getType

MetricDataType getType()

Returns the type of this metric.

getData

Data<?> getData()

Returns the unconstrained metric data.

Most will instead prefer to access the constrained metric data after first checking the getType():

 //  if (metricData.getType() == MetricDataType.LONG_SUM) {
 //    SumData<LongPointData> sumData = metricData.getLongSumData();
 //    ... // Process long sum data
 //  }
 

See Also:

• getDoubleGaugeData()
• getLongGaugeData()
• getDoubleSumData()
• getLongSumData()
• getHistogramData()
• getSummaryData()

isEmpty

default boolean isEmpty()

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

getDoubleGaugeData

default GaugeData<DoublePointData> getDoubleGaugeData()

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

getLongGaugeData

default GaugeData<LongPointData> getLongGaugeData()

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

getDoubleSumData

default SumData<DoublePointData> getDoubleSumData()

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

getLongSumData

default SumData<LongPointData> getLongSumData()

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

getSummaryData

default SummaryData getSummaryData()

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

getHistogramData

default HistogramData getHistogramData()

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