Metric SDK

Package exemplar provides an implementation of the OpenTelemetry exemplar reservoir to be used in metric collection pipelines.

DefaultAggregationSelector returns the default aggregation and parameters that will be used to summarize measurement made from an instrument of InstrumentKind.

DefaultExemplarReservoirProviderSelector returns the default [exemplar.ReservoirProvider] for the provided [Aggregation].

DefaultTemporalitySelector is the default TemporalitySelector used if WithTemporalitySelector is not provided.

NewManualReader returns a Reader which is directly called to collect metrics.

NewMeterProvider returns a new and configured MeterProvider.

NewPeriodicReader returns a Reader that collects and exports metric data to the exporter at a defined interval.

NewView returns a View that applies the Stream mask for all instruments that match criteria.

WithAggregationSelector sets the AggregationSelector a reader will use to determine the aggregation to use for an instrument based on its kind.

WithExemplarFilter configures the exemplar filter.

WithInterval configures the intervening time between exports for a PeriodicReader.

WithProducer registers producers as an external Producer of metric data for this Reader.

WithReader associates Reader r with a MeterProvider.

WithResource associates a Resource with a MeterProvider.

WithTemporalitySelector sets the TemporalitySelector a reader will use to determine the Temporality of an instrument based on its kind.

WithTimeout configures the time a PeriodicReader waits for an export to complete before canceling it.

WithView associates views with a MeterProvider.

InstrumentKindCounter identifies a group of instruments that record increasing values synchronously with the code path they are measuring.

InstrumentKindGauge identifies a group of instruments that record instantaneous values synchronously with the code path they are measuring.

InstrumentKindHistogram identifies a group of instruments that record a distribution of values synchronously with the code path they are measuring.

InstrumentKindObservableCounter identifies a group of instruments that record increasing values in an asynchronous callback.

InstrumentKindObservableGauge identifies a group of instruments that record current values in an asynchronous callback.

InstrumentKindObservableUpDownCounter identifies a group of instruments that record increasing and decreasing values in an asynchronous callback.

InstrumentKindUpDownCounter identifies a group of instruments that record increasing and decreasing values synchronously with the code path they are measuring.

ErrExporterShutdown is returned if Export or Shutdown are called after an Exporter has been Shutdown.

ErrInstrumentName indicates the created instrument has an invalid name.

ErrReaderNotRegistered is returned if Collect or Shutdown are called before the reader is registered with a MeterProvider.

ErrReaderShutdown is returned if Collect or Shutdown are called after a reader has been Shutdown once.

AggregationBase2ExponentialHistogram is an Aggregation that summarizes a set of measurements as an histogram with bucket widths that grow exponentially.

AggregationDefault is an Aggregation that uses the default instrument kind selection mapping to select another Aggregation.

AggregationDrop is an Aggregation that drops all recorded data.

AggregationExplicitBucketHistogram is an Aggregation that summarizes a set of measurements as an histogram with explicitly defined buckets.

AggregationLastValue is an Aggregation that summarizes a set of measurements as the last one made.

AggregationSum is an Aggregation that summarizes a set of measurements as their arithmetic sum.

Instrument describes properties an instrument is created with.

ManualReader is a simple Reader that allows an application to read metrics on demand.

MeterProvider handles the creation and coordination of Meters.

PeriodicReader is a Reader that continuously collects and exports metric data at a set interval.

Stream describes the stream of data an instrument produces.

Aggregation is the aggregation used to summarize recorded measurements.

Exporter handles the delivery of metric data to external receivers.

ManualReaderOption applies a configuration option value to a ManualReader.

Option applies a configuration option value to a MeterProvider.

PeriodicReaderOption applies a configuration option value to a PeriodicReader.

Producer produces metrics for a Reader from an external source.

Reader is the interface used between the SDK and an exporter.

ReaderOption is an option which can be applied to manual or Periodic readers.

AggregationSelector selects the aggregation and the parameters to use for that aggregation based on the InstrumentKind.

ExemplarReservoirProviderSelector selects the [exemplar.ReservoirProvider] to use based on the [Aggregation] of the metric.

InstrumentKind is the identifier of a group of instruments that all performing the same function.

TemporalitySelector selects the temporality to use based on the InstrumentKind.

View is an override to the default behavior of the SDK.