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.

Since:

0.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricData.Descriptor MetricData.Descriptor defines metadata about the MetricData type and its schema.
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.LongPoint LongPoint is a single data point in a timeseries that describes the time-varying values of a int64 metric.
static class	MetricData.Point
static class	MetricData.SummaryPoint SummaryPoint is a single data point that summarizes the values in a time series of numeric values.
static class	MetricData.ValueAtPercentile

Method Summary

Modifier and Type	Method and Description
static MetricData	create(MetricData.Descriptor descriptor, Resource resource, InstrumentationLibraryInfo instrumentationLibraryInfo, Collection<MetricData.Point> points)
abstract MetricData.Descriptor	getDescriptor() Returns the MetricData.Descriptor of this metric.
abstract InstrumentationLibraryInfo	getInstrumentationLibraryInfo() Returns the instrumentation library specified when creating the Meter which created the Instrument that produces MetricData.
abstract Collection<MetricData.Point>	getPoints() Returns the data MetricData.Points for this metric.
abstract Resource	getResource() Returns the resource of this MetricData.

Methods inherited from class java.lang.Object

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

Method Detail

getDescriptor

public abstract MetricData.Descriptor getDescriptor()

Returns the MetricData.Descriptor of this metric.

Returns:

the Descriptor of this metric.

Since:

0.1.0

getResource

public abstract Resource getResource()

Returns the resource of this MetricData.

Returns:

the resource of this MetricData.

Since:

0.1.0

getInstrumentationLibraryInfo

public abstract InstrumentationLibraryInfo getInstrumentationLibraryInfo()

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

Returns:

an instance of InstrumentationLibraryInfo

getPoints

public abstract Collection<MetricData.Point> getPoints()

Returns the data MetricData.Points for this metric.

Only one type of points are available at any moment for a MetricData, and the type is determined by the MetricData.Descriptor.Type.

Returns:

the data MetricData.Points for this metric, or empty Collection if no points.

Since:

0.3.0

create

public static MetricData create(MetricData.Descriptor descriptor,
                                Resource resource,
                                InstrumentationLibraryInfo instrumentationLibraryInfo,
                                Collection<MetricData.Point> points)