Index
All Classes and Interfaces|All Packages
A
- Aggregation - Interface in io.opentelemetry.sdk.metrics
-
Configures how measurements are combined into metrics.
- AggregationTemporality - Enum in io.opentelemetry.sdk.metrics.data
-
An enumeration which describes the time period over which metrics should be aggregated.
- alwaysCumulative(InstrumentType) - Static method in interface io.opentelemetry.sdk.metrics.export.MetricExporter
-
A common implementation of
MetricExporter.getAggregationTemporality(InstrumentType)
which returnsAggregationTemporality.CUMULATIVE
for all instruments.
B
- build() - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReaderBuilder
-
Returns a new
PeriodicMetricReader
with the configuration of this builder which can be registered with aSdkMeterProvider
. - build() - Method in class io.opentelemetry.sdk.metrics.InstrumentSelectorBuilder
-
Returns an InstrumentSelector instance with the content of this builder.
- build() - Method in class io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder
-
Returns a new
SdkMeterProvider
built with the configuration of thisSdkMeterProviderBuilder
. - build() - Method in class io.opentelemetry.sdk.metrics.ViewBuilder
-
Returns a
View
with the configuration of this builder. - builder() - Static method in class io.opentelemetry.sdk.metrics.InstrumentSelector
-
Returns a new
InstrumentSelectorBuilder
forInstrumentSelector
. - builder() - Static method in class io.opentelemetry.sdk.metrics.SdkMeterProvider
-
Returns a new
SdkMeterProviderBuilder
forSdkMeterProvider
. - builder() - Static method in class io.opentelemetry.sdk.metrics.View
- builder(MetricExporter) - Static method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReader
-
Returns a new
PeriodicMetricReaderBuilder
.
C
- close() - Method in interface io.opentelemetry.sdk.metrics.export.MetricExporter
-
Closes this
MetricExporter
, releasing any resources. - close() - Method in class io.opentelemetry.sdk.metrics.SdkMeterProvider
-
Close the meter provider.
- CollectionRegistration - Interface in io.opentelemetry.sdk.metrics.export
-
A
CollectionRegistration
is passed to eachMetricReader
registered withSdkMeterProvider
, and provides readers the ability to trigger metric collections. - COUNTER - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentType
- create(MetricExporter) - Static method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReader
-
Returns a new
PeriodicMetricReader
which can be registered to aSdkMeterProvider
to start aPeriodicMetricReader
exporting once every minute on a new daemon thread. - CUMULATIVE - Enum constant in enum io.opentelemetry.sdk.metrics.data.AggregationTemporality
-
Metrics will be aggregated over the lifetime of the associated Instrument.
D
- Data<T extends PointData> - Interface in io.opentelemetry.sdk.metrics.data
-
A collection of data points associated to a metric.
- defaultAggregation() - Static method in interface io.opentelemetry.sdk.metrics.Aggregation
-
The default aggregation for an instrument will be chosen.
- DELTA - Enum constant in enum io.opentelemetry.sdk.metrics.data.AggregationTemporality
-
Metrics will be aggregated only over the most recent collection interval.
- deltaPreferred(InstrumentType) - Static method in interface io.opentelemetry.sdk.metrics.export.MetricExporter
-
A common implementation of
MetricExporter.getAggregationTemporality(InstrumentType)
which indicates delta preference. - DOUBLE - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentValueType
- DOUBLE_GAUGE - Enum constant in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
A Gauge represents a measurement of a double value at a moment in time.
- DOUBLE_SUM - Enum constant in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
A sum of non negative double values.
- DoubleExemplarData - Interface in io.opentelemetry.sdk.metrics.data
-
An
ExemplarData
withdouble
measurements. - DoublePointData - Interface in io.opentelemetry.sdk.metrics.data
-
A single data point in a timeseries that describes the time-varying value of a double metric.
- drop() - Static method in interface io.opentelemetry.sdk.metrics.Aggregation
-
The drop Aggregation will ignore/drop all Instrument Measurements.
E
- ExemplarData - Interface in io.opentelemetry.sdk.metrics.data
-
A sample input measurement.
- explicitBucketHistogram() - Static method in interface io.opentelemetry.sdk.metrics.Aggregation
-
Aggregates measurements into an explicit bucket histogram using the default bucket boundaries.
- explicitBucketHistogram(List<Double>) - Static method in interface io.opentelemetry.sdk.metrics.Aggregation
-
Aggregates measurements into an explicit bucket histogram.
- EXPONENTIAL_HISTOGRAM - Enum constant in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
An Exponential Histogram represents an approximate representation of the distribution of measurements recorded.
- export(Collection<MetricData>) - Method in interface io.opentelemetry.sdk.metrics.export.MetricExporter
-
Exports the collection of given
MetricData
.
F
- flush() - Method in interface io.opentelemetry.sdk.metrics.export.MetricExporter
-
Exports the collection of
MetricData
that have not yet been exported. - flush() - Method in interface io.opentelemetry.sdk.metrics.export.MetricReader
-
Flushes metrics read by this reader.
- flush() - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReader
- forceFlush() - Method in class io.opentelemetry.sdk.metrics.SdkMeterProvider
-
Call
MetricReader.flush()
on all metric readers associated with this provider.
G
- GaugeData<T extends PointData> - Interface in io.opentelemetry.sdk.metrics.data
-
A gauge metric point.
- getAggregation() - Method in class io.opentelemetry.sdk.metrics.View
-
The aggregation used for this view.
- getAggregationTemporality() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramData
-
Returns the
AggregationTemporality
of this metric, - getAggregationTemporality() - Method in interface io.opentelemetry.sdk.metrics.data.SumData
-
Returns the
AggregationTemporality
of this metric, - getAggregationTemporality(InstrumentType) - Method in interface io.opentelemetry.sdk.metrics.export.MetricExporter
-
Return the default aggregation temporality for the
InstrumentType
. - getAggregationTemporality(InstrumentType) - Method in interface io.opentelemetry.sdk.metrics.export.MetricReader
-
Return the default aggregation temporality for the
InstrumentType
. - getAggregationTemporality(InstrumentType) - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReader
- getAttributes() - Method in interface io.opentelemetry.sdk.metrics.data.PointData
-
Returns the attributes associated with this
Point
. - getBoundaries() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
The bucket boundaries.
- getCount() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
The number of measurements taken.
- getCount() - Method in interface io.opentelemetry.sdk.metrics.data.SummaryPointData
-
Returns the number of values that are being summarized.
- getCounts() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
The counts in each bucket.
- getData() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
- getDescription() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the description of this metric.
- getDescription() - Method in class io.opentelemetry.sdk.metrics.View
-
The name of the resulting metric to generate, or
null
if the same as the instrument. - getDoubleGaugeData() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the
DoubleGaugeData
if type isMetricDataType.DOUBLE_GAUGE
, otherwise a default empty data. - getDoubleSumData() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the
DoubleSumData
if type isMetricDataType.DOUBLE_SUM
, otherwise a default empty data. - getEpochNanos() - Method in interface io.opentelemetry.sdk.metrics.data.ExemplarData
-
Returns the timestamp in nanos when measurement was collected.
- getEpochNanos() - Method in interface io.opentelemetry.sdk.metrics.data.PointData
-
Returns the epoch timestamp in nanos when data were collected, usually it represents the moment when
Instrument.getData()
was called. - getExemplars() - Method in interface io.opentelemetry.sdk.metrics.data.PointData
-
List of exemplars collected from measurements that were used to form the data point.
- getFilteredAttributes() - Method in interface io.opentelemetry.sdk.metrics.data.ExemplarData
-
The set of key/value pairs that were filtered out by the aggregator, but recorded alongside the original measurement.
- getHistogramData() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the
DoubleHistogramData
if type isMetricDataType.HISTOGRAM
, otherwise a default empty data. - getInstrumentationScopeInfo() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the instrumentation scope specified when creating the
Meter
which created theInstrument
that producesMetricData
. - getInstrumentName() - Method in class io.opentelemetry.sdk.metrics.InstrumentSelector
-
Returns the selection criteria for instrument name.
- getInstrumentType() - Method in class io.opentelemetry.sdk.metrics.InstrumentSelector
-
Returns selection criteria for
InstrumentType
. - getLongGaugeData() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the
LongGaugeData
if type isMetricDataType.LONG_GAUGE
, otherwise a default empty data. - getLongSumData() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the
LongSumData
if type isMetricDataType.LONG_SUM
, otherwise a default empty data. - getMax() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
The max of all measurements recorded, if
HistogramPointData.hasMax()
istrue
. - getMeterName() - Method in class io.opentelemetry.sdk.metrics.InstrumentSelector
-
Returns the selection criteria for meter name.
- getMeterSchemaUrl() - Method in class io.opentelemetry.sdk.metrics.InstrumentSelector
-
Returns the selection criteria for meter schema url.
- getMeterVersion() - Method in class io.opentelemetry.sdk.metrics.InstrumentSelector
-
Returns the selection criteria for meter version.
- getMin() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
The min of all measurements recorded, if
HistogramPointData.hasMin()
istrue
. - getName() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the metric name.
- getName() - Method in class io.opentelemetry.sdk.metrics.View
-
The name of the resulting metric to generate, or
null
if the same as the instrument. - getPoints() - Method in interface io.opentelemetry.sdk.metrics.data.Data
-
Returns the data
PointData
s for this metric. - getPoints() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramData
- getQuantile() - Method in interface io.opentelemetry.sdk.metrics.data.ValueAtQuantile
-
Returns the quantile of a distribution.
- getResource() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the resource of this
MetricData
. - getSpanContext() - Method in interface io.opentelemetry.sdk.metrics.data.ExemplarData
-
Returns the
SpanContext
associated with this exemplar. - getStartEpochNanos() - Method in interface io.opentelemetry.sdk.metrics.data.PointData
-
Returns the start epoch timestamp in nanos of this
Instrument
, usually the time when the metric was created or an aggregation was enabled. - getSum() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
The sum of all measurements recorded.
- getSum() - Method in interface io.opentelemetry.sdk.metrics.data.SummaryPointData
-
Returns the sum of all the values that are being summarized.
- getSummaryData() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the
DoubleSummaryData
if type isMetricDataType.SUMMARY
, otherwise a default empty data. - getType() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the type of this metric.
- getUnit() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns the unit of this metric.
- getValue() - Method in interface io.opentelemetry.sdk.metrics.data.DoubleExemplarData
-
Numerical value of the measurement that was recorded.
- getValue() - Method in interface io.opentelemetry.sdk.metrics.data.DoublePointData
-
Returns the value of the data point.
- getValue() - Method in interface io.opentelemetry.sdk.metrics.data.LongExemplarData
-
Numerical value of the measurement that was recorded.
- getValue() - Method in interface io.opentelemetry.sdk.metrics.data.LongPointData
-
Returns the value of the data point.
- getValue() - Method in interface io.opentelemetry.sdk.metrics.data.ValueAtQuantile
-
Returns the value at the given percentile of a distribution.
- getValues() - Method in interface io.opentelemetry.sdk.metrics.data.SummaryPointData
-
Returns the values in the summarization.
H
- hasMax() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
Return
true
ifHistogramPointData.getMax()
is set. - hasMin() - Method in interface io.opentelemetry.sdk.metrics.data.HistogramPointData
-
Return
true
ifHistogramPointData.getMin()
is set. - HISTOGRAM - Enum constant in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
A Histogram represents an approximate representation of the distribution of measurements recorded.
- HISTOGRAM - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentType
- HistogramData - Interface in io.opentelemetry.sdk.metrics.data
-
A histogram metric recording.
- HistogramPointData - Interface in io.opentelemetry.sdk.metrics.data
-
A histogram metric point.
I
- InstrumentSelector - Class in io.opentelemetry.sdk.metrics
-
Provides means for selecting one or more instruments.
- InstrumentSelectorBuilder - Class in io.opentelemetry.sdk.metrics
-
Builder for
InstrumentSelector
. - InstrumentType - Enum in io.opentelemetry.sdk.metrics
-
All instrument types available in the metric package.
- InstrumentValueType - Enum in io.opentelemetry.sdk.metrics
-
All possible types for the values recorded via the instruments.
- io.opentelemetry.sdk.metrics - package io.opentelemetry.sdk.metrics
-
The SDK implementation of metrics.
- io.opentelemetry.sdk.metrics.data - package io.opentelemetry.sdk.metrics.data
-
The data format to model metrics for export.
- io.opentelemetry.sdk.metrics.export - package io.opentelemetry.sdk.metrics.export
-
Utilities that allow to export metrics to the OpenTelemetry exporters.
- isEmpty() - Method in interface io.opentelemetry.sdk.metrics.data.MetricData
-
Returns
true
if there are no points associated with this metric. - isMonotonic() - Method in interface io.opentelemetry.sdk.metrics.data.SumData
-
Returns "true" if the sum is monotonic.
L
- lastValue() - Static method in interface io.opentelemetry.sdk.metrics.Aggregation
-
Remembers the last seen measurement and reports as a Gauge.
- LONG - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentValueType
- LONG_GAUGE - Enum constant in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
A Gauge represents a measurement of a long value at a moment in time.
- LONG_SUM - Enum constant in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
A sum of non negative long (int64) values.
- LongExemplarData - Interface in io.opentelemetry.sdk.metrics.data
-
An
ExemplarData
withlong
measurements. - LongPointData - Interface in io.opentelemetry.sdk.metrics.data
M
- meterBuilder(String) - Method in class io.opentelemetry.sdk.metrics.SdkMeterProvider
- MetricData - Interface in io.opentelemetry.sdk.metrics.data
-
A
ImmutableMetricData
represents the data exported as part of aggregating oneInstrument
. - MetricDataType - Enum in io.opentelemetry.sdk.metrics.data
-
The kind of metric.
- MetricExporter - Interface in io.opentelemetry.sdk.metrics.export
-
MetricExporter
is the interface that all "push based" metric libraries should use to export metrics to the OpenTelemetry exporters. - MetricReader - Interface in io.opentelemetry.sdk.metrics.export
-
A reader of metrics from
SdkMeterProvider
.
O
- OBSERVABLE_COUNTER - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentType
- OBSERVABLE_GAUGE - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentType
- OBSERVABLE_UP_DOWN_COUNTER - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentType
P
- PeriodicMetricReader - Class in io.opentelemetry.sdk.metrics.export
-
A
MetricReader
which wraps aMetricExporter
and automatically reads and exports the metrics every export interval. - PeriodicMetricReaderBuilder - Class in io.opentelemetry.sdk.metrics.export
-
A builder for
PeriodicMetricReader
. - PointData - Interface in io.opentelemetry.sdk.metrics.data
-
A point in the "Metric stream" data model.
R
- register(CollectionRegistration) - Method in interface io.opentelemetry.sdk.metrics.export.MetricReader
-
Called by
SdkMeterProvider
and supplies theMetricReader
with a handle to collect metrics. - register(CollectionRegistration) - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReader
- registerMetricReader(MetricReader) - Method in class io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder
-
Registers a
MetricReader
for this SDK. - registerView(InstrumentSelector, View) - Method in class io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder
-
Register a view with the given
InstrumentSelector
.
S
- SdkMeterProvider - Class in io.opentelemetry.sdk.metrics
-
SDK implementation for
MeterProvider
. - SdkMeterProviderBuilder - Class in io.opentelemetry.sdk.metrics
-
Builder class for the
SdkMeterProvider
. - setAggregation(Aggregation) - Method in class io.opentelemetry.sdk.metrics.ViewBuilder
-
Sets
Aggregation
. - setAttributeFilter(Predicate<String>) - Method in class io.opentelemetry.sdk.metrics.ViewBuilder
-
Sets a filter for attributes, where only attribute names that pass the supplied
Predicate
will be included in the output. - setClock(Clock) - Method in class io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder
-
Assign a
Clock
. - setDescription(String) - Method in class io.opentelemetry.sdk.metrics.ViewBuilder
-
Sets the description of the resulting metric.
- setExecutor(ScheduledExecutorService) - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReaderBuilder
-
Sets the
ScheduledExecutorService
to schedule reads on. - setInterval(long, TimeUnit) - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReaderBuilder
-
Sets the interval of reads.
- setInterval(Duration) - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReaderBuilder
-
Sets the interval of reads.
- setMeterName(String) - Method in class io.opentelemetry.sdk.metrics.InstrumentSelectorBuilder
-
Sets a specifier for selecting instruments by the name of their associated
Meter
. - setMeterSchemaUrl(String) - Method in class io.opentelemetry.sdk.metrics.InstrumentSelectorBuilder
-
Sets a specifier for selecting instruments by the schema URL of their associated
Meter
. - setMeterVersion(String) - Method in class io.opentelemetry.sdk.metrics.InstrumentSelectorBuilder
-
Sets a specifier for selecting instruments by the version of their associated
Meter
. - setName(String) - Method in class io.opentelemetry.sdk.metrics.InstrumentSelectorBuilder
-
Sets the exact instrument name that will be selected.
- setName(String) - Method in class io.opentelemetry.sdk.metrics.ViewBuilder
-
Sets the name of the resulting metric.
- setResource(Resource) - Method in class io.opentelemetry.sdk.metrics.SdkMeterProviderBuilder
-
Assign a
Resource
to be attached to all metrics created by Meters. - setType(InstrumentType) - Method in class io.opentelemetry.sdk.metrics.InstrumentSelectorBuilder
-
Sets a specifier for
InstrumentType
. - shutdown() - Method in interface io.opentelemetry.sdk.metrics.export.MetricExporter
-
Called when the associated IntervalMetricReader is shutdown.
- shutdown() - Method in interface io.opentelemetry.sdk.metrics.export.MetricReader
-
Shuts down the metric reader.
- shutdown() - Method in class io.opentelemetry.sdk.metrics.export.PeriodicMetricReader
- shutdown() - Method in class io.opentelemetry.sdk.metrics.SdkMeterProvider
-
Shutdown the provider.
- sum() - Static method in interface io.opentelemetry.sdk.metrics.Aggregation
-
Instrument measurements will be combined into a metric Sum.
- SumData<T extends PointData> - Interface in io.opentelemetry.sdk.metrics.data
-
A sum metric point.
- SUMMARY - Enum constant in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
A Summary of measurements of numeric values, containing the minimum value recorded, the maximum value recorded, the sum of all measurements and the total number of measurements recorded.
- SummaryData - Interface in io.opentelemetry.sdk.metrics.data
-
A summary metric.
- SummaryPointData - Interface in io.opentelemetry.sdk.metrics.data
-
A single data point that summarizes the values in a time series of numeric values.
U
- UP_DOWN_COUNTER - Enum constant in enum io.opentelemetry.sdk.metrics.InstrumentType
V
- ValueAtQuantile - Interface in io.opentelemetry.sdk.metrics.data
-
A value within a summary.
- valueOf(String) - Static method in enum io.opentelemetry.sdk.metrics.data.AggregationTemporality
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.opentelemetry.sdk.metrics.InstrumentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum io.opentelemetry.sdk.metrics.InstrumentValueType
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum io.opentelemetry.sdk.metrics.data.AggregationTemporality
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.opentelemetry.sdk.metrics.data.MetricDataType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.opentelemetry.sdk.metrics.InstrumentType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum io.opentelemetry.sdk.metrics.InstrumentValueType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- View - Class in io.opentelemetry.sdk.metrics
-
A configuration for a metric stream transformation.
- ViewBuilder - Class in io.opentelemetry.sdk.metrics
-
A builder for
View
.
All Classes and Interfaces|All Packages