V1
Table of Contents
Namespaces
- ExponentialHistogramDataPoint
- SummaryDataPoint
Classes
- AggregationTemporality
- AggregationTemporality defines how a metric aggregator reports aggregated
values. It describes how those values relate to the time interval over
which they are aggregated.
- DataPointFlags
- DataPointFlags is defined as a protobuf 'uint32' type and is to be used as a
bit-field representing 32 distinct boolean flags. Each flag defined in this
enum is a bit-mask. To test the presence of a single flag in the flags of
a data point, for example, use an expression like:
(point.flags & DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK) == DATA_POINT_FLAGS_NO_RECORDED_VALUE_MASK
- Exemplar
- A representation of an exemplar, which is a sample input measurement.
- ExponentialHistogram
- ExponentialHistogram represents the type of a metric that is calculated by aggregating
as a ExponentialHistogram of all reported double measurements over a time interval.
- ExponentialHistogramDataPoint
- ExponentialHistogramDataPoint is a single data point in a timeseries that describes the
time-varying values of a ExponentialHistogram of double values. A ExponentialHistogram contains
summary statistics for a population of values, it may optionally contain the
distribution of those values across a set of buckets.
- ExponentialHistogramDataPoint_Buckets
- This class is deprecated. Use Opentelemetry\Proto\Metrics\V1\ExponentialHistogramDataPoint\Buckets instead.
- Gauge
- Gauge represents the type of a scalar metric that always exports the
"current value" for every data point. It should be used for an "unknown"
aggregation.
- Histogram
- Histogram represents the type of a metric that is calculated by aggregating
as a Histogram of all reported measurements over a time interval.
- HistogramDataPoint
- HistogramDataPoint is a single data point in a timeseries that describes the
time-varying values of a Histogram. A Histogram contains summary statistics
for a population of values, it may optionally contain the distribution of
those values across a set of buckets.
- InstrumentationLibraryMetrics
- A collection of Metrics produced by an InstrumentationLibrary.
- IntDataPoint
- IntDataPoint is deprecated. Use integer value in NumberDataPoint.
- IntExemplar
- IntExemplar is deprecated. Use Exemplar with as_int for value
- IntGauge
- IntGauge is deprecated. Use Gauge with an integer value in NumberDataPoint.
- IntHistogram
- IntHistogram is deprecated, replaced by Histogram points using double-
valued exemplars.
- IntHistogramDataPoint
- IntHistogramDataPoint is deprecated; use HistogramDataPoint.
- IntSum
- IntSum is deprecated. Use Sum with an integer value in NumberDataPoint.
- Metric
- Defines a Metric which has one or more timeseries. The following is a
brief summary of the Metric data model. For more details, see:
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/data-model.md
The data model and relation between entities is shown in the
diagram below. Here, "DataPoint" is the term used to refer to any
one of the specific data point value types, and "points" is the term used
to refer to any one of the lists of points contained in the Metric.
- MetricsData
- MetricsData represents the metrics data that can be stored in a persistent
storage, OR can be embedded by other protocols that transfer OTLP metrics
data but do not implement the OTLP protocol.
- NumberDataPoint
- NumberDataPoint is a single data point in a timeseries that describes the
time-varying scalar value of a metric.
- ResourceMetrics
- A collection of ScopeMetrics from a Resource.
- ScopeMetrics
- A collection of Metrics produced by an Scope.
- Sum
- Sum represents the type of a scalar metric that is calculated as a sum of all
reported measurements over a time interval.
- Summary
- Summary metric data are used to convey quantile summaries,
a Prometheus (see: https://prometheus.io/docs/concepts/metric_types/#summary)
and OpenMetrics (see: https://github.com/OpenObservability/OpenMetrics/blob/4dbf6075567ab43296eed941037c12951faafb92/protos/prometheus.proto#L45)
data type. These data points cannot always be merged in a meaningful way.
- SummaryDataPoint
- SummaryDataPoint is a single data point in a timeseries that describes the
time-varying values of a Summary metric.
- SummaryDataPoint_ValueAtQuantile
- This class is deprecated. Use Opentelemetry\Proto\Metrics\V1\SummaryDataPoint\ValueAtQuantile instead.