metric

package module
v0.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 11, 2022 License: Apache-2.0 Imports: 6 Imported by: 1,904

Documentation

Overview

Package metric provides an implementation of the metrics part of the OpenTelemetry API.

This package is currently in a pre-GA phase. Backwards incompatible changes may be introduced in subsequent minor version releases as we work to track the evolving OpenTelemetry specification and user feedback.

Measurements can be made about an operation being performed or the state of a system in general. These measurements can be crucial to the reliable operation of code and provide valuable insights about the inner workings of a system.

Measurements are made using instruments provided by this package. The type of instrument used will depend on the type of measurement being made and of what part of a system is being measured.

Instruments are categorized as Synchronous or Asynchronous and independently as Adding or Grouping. Synchronous instruments are called by the user with a Context. Asynchronous instruments are called by the SDK during collection. Adding instruments are semantically intended for capturing a sum. Grouping instruments are intended for capturing a distribution.

Adding instruments may be monotonic, in which case they are non-decreasing and naturally define a rate.

The synchronous instrument names are: 

Counter:           adding, monotonic
UpDownCounter:     adding
Histogram:         grouping

and the asynchronous instruments are: 

CounterObserver:       adding, monotonic
UpDownCounterObserver: adding
GaugeObserver:         grouping

All instruments are provided with support for either float64 or int64 input values.

An instrument is created using a Meter. Additionally, a Meter is used to record batches of synchronous measurements or asynchronous observations. A Meter is obtained using a MeterProvider. A Meter, like a Tracer, is unique to the instrumentation it instruments and must be named and versioned when created with a MeterProvider with the name and version of the instrumentation library.

Instrumentation should be designed to accept a MeterProvider from which it can create its own unique Meter. Alternatively, the registered global MeterProvider from the go.opentelemetry.io/otel package can be used as a default.

Index

Constants

This section is empty.

Variables

View Source 
var ErrSDKReturnedNilImpl = errors.New("SDK returned a nil implementation")

ErrSDKReturnedNilImpl is returned when a new `MeterImpl` returns nil.

Functions

This section is empty.

Types

type BatchObserver 

type BatchObserver struct {
	// contains filtered or unexported fields
}

BatchObserver represents an Observer callback that can report observations for multiple instruments.

func (BatchObserver) NewFloat64CounterObserver added in v0.23.0 

func (b BatchObserver) NewFloat64CounterObserver(name string, opts ...InstrumentOption) (Float64CounterObserver, error)

NewFloat64CounterObserver creates a new floating point CounterObserver with the given name, running in a batch callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (BatchObserver) NewFloat64GaugeObserver added in v0.23.0 

func (b BatchObserver) NewFloat64GaugeObserver(name string, opts ...InstrumentOption) (Float64GaugeObserver, error)

NewFloat64GaugeObserver creates a new floating point GaugeObserver with the given name, running in a batch callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (BatchObserver) NewFloat64UpDownCounterObserver added in v0.23.0 

func (b BatchObserver) NewFloat64UpDownCounterObserver(name string, opts ...InstrumentOption) (Float64UpDownCounterObserver, error)

NewFloat64UpDownCounterObserver creates a new floating point UpDownCounterObserver with the given name, running in a batch callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (BatchObserver) NewInt64CounterObserver added in v0.23.0 

func (b BatchObserver) NewInt64CounterObserver(name string, opts ...InstrumentOption) (Int64CounterObserver, error)

NewInt64CounterObserver creates a new integer CounterObserver instrument with the given name, running in a batch callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (BatchObserver) NewInt64GaugeObserver added in v0.23.0 

func (b BatchObserver) NewInt64GaugeObserver(name string, opts ...InstrumentOption) (Int64GaugeObserver, error)

NewInt64GaugeObserver creates a new integer GaugeObserver instrument with the given name, running in a batch callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (BatchObserver) NewInt64UpDownCounterObserver added in v0.23.0 

func (b BatchObserver) NewInt64UpDownCounterObserver(name string, opts ...InstrumentOption) (Int64UpDownCounterObserver, error)

NewInt64UpDownCounterObserver creates a new integer UpDownCounterObserver instrument with the given name, running in a batch callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

type BatchObserverFunc 

type BatchObserverFunc func(context.Context, BatchObserverResult)

BatchObserverFunc is a callback argument for use with any Observer instrument that will be reported as a batch of observations.

func (*BatchObserverFunc) AnyRunner 

func (*BatchObserverFunc) AnyRunner()

AnyRunner implements AsyncRunner.

func (*BatchObserverFunc) Run 

func (b *BatchObserverFunc) Run(ctx context.Context, function func([]attribute.KeyValue, ...Observation))

Run implements AsyncBatchRunner.

type BatchObserverMust 

type BatchObserverMust struct {
	// contains filtered or unexported fields
}

BatchObserverMust is a wrapper for BatchObserver that panics when any instrument constructor encounters an error.

func (BatchObserverMust) NewFloat64CounterObserver added in v0.23.0 

func (bm BatchObserverMust) NewFloat64CounterObserver(name string, oos ...InstrumentOption) Float64CounterObserver

NewFloat64CounterObserver calls `BatchObserver.NewFloat64CounterObserver` and returns the instrument, panicking if it encounters an error.

func (BatchObserverMust) NewFloat64GaugeObserver added in v0.23.0 

func (bm BatchObserverMust) NewFloat64GaugeObserver(name string, oos ...InstrumentOption) Float64GaugeObserver

NewFloat64GaugeObserver calls `BatchObserver.NewFloat64GaugeObserver` and returns the instrument, panicking if it encounters an error.

func (BatchObserverMust) NewFloat64UpDownCounterObserver added in v0.23.0 

func (bm BatchObserverMust) NewFloat64UpDownCounterObserver(name string, oos ...InstrumentOption) Float64UpDownCounterObserver

NewFloat64UpDownCounterObserver calls `BatchObserver.NewFloat64UpDownCounterObserver` and returns the instrument, panicking if it encounters an error.

func (BatchObserverMust) NewInt64CounterObserver added in v0.23.0 

func (bm BatchObserverMust) NewInt64CounterObserver(name string, oos ...InstrumentOption) Int64CounterObserver

NewInt64CounterObserver calls `BatchObserver.NewInt64CounterObserver` and returns the instrument, panicking if it encounters an error.

func (BatchObserverMust) NewInt64GaugeObserver added in v0.23.0 

func (bm BatchObserverMust) NewInt64GaugeObserver(name string, oos ...InstrumentOption) Int64GaugeObserver

NewInt64GaugeObserver calls `BatchObserver.NewInt64GaugeObserver` and returns the instrument, panicking if it encounters an error.

func (BatchObserverMust) NewInt64UpDownCounterObserver added in v0.23.0 

func (bm BatchObserverMust) NewInt64UpDownCounterObserver(name string, oos ...InstrumentOption) Int64UpDownCounterObserver

NewInt64UpDownCounterObserver calls `BatchObserver.NewInt64UpDownCounterObserver` and returns the instrument, panicking if it encounters an error.

type BatchObserverResult 

type BatchObserverResult struct {
	// contains filtered or unexported fields
}

BatchObserverResult is passed to a batch observer callback to capture observations for multiple asynchronous instruments.

func (BatchObserverResult) Observe 

func (br BatchObserverResult) Observe(labels []attribute.KeyValue, obs ...Observation)

Observe captures a multiple observations from the associated batch instrument callback, with the given labels.

type Float64Counter 

type Float64Counter struct {
	// contains filtered or unexported fields
}

Float64Counter is a metric that accumulates float64 values.

func (Float64Counter) Add 

func (c Float64Counter) Add(ctx context.Context, value float64, labels ...attribute.KeyValue)

Add adds the value to the counter's sum. The labels should contain the keys and values to be associated with this value.

func (Float64Counter) Measurement 

func (c Float64Counter) Measurement(value float64) Measurement

Measurement creates a Measurement object to use with batch recording.

func (Float64Counter) SyncImpl 

func (s Float64Counter) SyncImpl() sdkapi.SyncImpl

SyncImpl returns the implementation object for synchronous instruments.

type Float64CounterObserver added in v0.23.0 

type Float64CounterObserver struct {
	// contains filtered or unexported fields
}

Float64CounterObserver is a metric that captures a precomputed sum of float64 values at a point in time.

func (Float64CounterObserver) AsyncImpl added in v0.23.0 

func (a Float64CounterObserver) AsyncImpl() sdkapi.AsyncImpl

AsyncImpl implements AsyncImpl.

func (Float64CounterObserver) Observation added in v0.23.0 

func (f Float64CounterObserver) Observation(v float64) Observation

Observation returns an Observation, a BatchObserverFunc argument, for an asynchronous integer instrument. This returns an implementation-level object for use by the SDK, users should not refer to this.

type Float64GaugeObserver added in v0.23.0 

type Float64GaugeObserver struct {
	// contains filtered or unexported fields
}

Float64GaugeObserver is a metric that captures a set of float64 values at a point in time.

func (Float64GaugeObserver) AsyncImpl added in v0.23.0 

func (a Float64GaugeObserver) AsyncImpl() sdkapi.AsyncImpl

AsyncImpl implements AsyncImpl.

func (Float64GaugeObserver) Observation added in v0.23.0 

func (f Float64GaugeObserver) Observation(v float64) Observation

Observation returns an Observation, a BatchObserverFunc argument, for an asynchronous integer instrument. This returns an implementation-level object for use by the SDK, users should not refer to this.

type Float64Histogram added in v0.23.0 

type Float64Histogram struct {
	// contains filtered or unexported fields
}

Float64Histogram is a metric that records float64 values.

func (Float64Histogram) Measurement added in v0.23.0 

func (c Float64Histogram) Measurement(value float64) Measurement

Measurement creates a Measurement object to use with batch recording.

func (Float64Histogram) Record added in v0.23.0 

func (c Float64Histogram) Record(ctx context.Context, value float64, labels ...attribute.KeyValue)

Record adds a new value to the list of Histogram's records. The labels should contain the keys and values to be associated with this value.

func (Float64Histogram) SyncImpl added in v0.23.0 

func (s Float64Histogram) SyncImpl() sdkapi.SyncImpl

SyncImpl returns the implementation object for synchronous instruments.

type Float64ObserverFunc 

type Float64ObserverFunc func(context.Context, Float64ObserverResult)

Float64ObserverFunc is a type of callback that floating point observers run.

func (*Float64ObserverFunc) AnyRunner 

func (*Float64ObserverFunc) AnyRunner()

AnyRunner implements AsyncRunner.

func (*Float64ObserverFunc) Run 

func (f *Float64ObserverFunc) Run(ctx context.Context, impl sdkapi.AsyncImpl, function func([]attribute.KeyValue, ...Observation))

Run implements AsyncSingleRunner.

type Float64ObserverResult 

type Float64ObserverResult struct {
	// contains filtered or unexported fields
}

Float64ObserverResult is passed to an observer callback to capture observations for one asynchronous floating point metric instrument.

func (Float64ObserverResult) Observe 

func (fr Float64ObserverResult) Observe(value float64, labels ...attribute.KeyValue)

Observe captures a single floating point value from the associated instrument callback, with the given labels.

type Float64UpDownCounter 

type Float64UpDownCounter struct {
	// contains filtered or unexported fields
}

Float64UpDownCounter is a metric instrument that sums floating point values.

func (Float64UpDownCounter) Add 

func (c Float64UpDownCounter) Add(ctx context.Context, value float64, labels ...attribute.KeyValue)

Add adds the value to the counter's sum. The labels should contain the keys and values to be associated with this value.

func (Float64UpDownCounter) Measurement 

func (c Float64UpDownCounter) Measurement(value float64) Measurement

Measurement creates a Measurement object to use with batch recording.

func (Float64UpDownCounter) SyncImpl 

func (s Float64UpDownCounter) SyncImpl() sdkapi.SyncImpl

SyncImpl returns the implementation object for synchronous instruments.

type Float64UpDownCounterObserver added in v0.23.0 

type Float64UpDownCounterObserver struct {
	// contains filtered or unexported fields
}

Float64UpDownCounterObserver is a metric that captures a precomputed sum of float64 values at a point in time.

func (Float64UpDownCounterObserver) AsyncImpl added in v0.23.0 

func (a Float64UpDownCounterObserver) AsyncImpl() sdkapi.AsyncImpl

AsyncImpl implements AsyncImpl.

func (Float64UpDownCounterObserver) Observation added in v0.23.0 

func (f Float64UpDownCounterObserver) Observation(v float64) Observation

Observation returns an Observation, a BatchObserverFunc argument, for an asynchronous integer instrument. This returns an implementation-level object for use by the SDK, users should not refer to this.

type InstrumentConfig 

type InstrumentConfig struct {
	// contains filtered or unexported fields
}

InstrumentConfig contains options for metric instrument descriptors.

func NewInstrumentConfig 

func NewInstrumentConfig(opts ...InstrumentOption) InstrumentConfig

NewInstrumentConfig creates a new InstrumentConfig and applies all the given options.

func (*InstrumentConfig) Description 

func (cfg *InstrumentConfig) Description() string

Description describes the instrument in human-readable terms.

func (*InstrumentConfig) Unit 

func (cfg *InstrumentConfig) Unit() unit.Unit

Unit describes the measurement unit for a instrument.

type InstrumentOption 

type InstrumentOption interface {
	// contains filtered or unexported methods
}

InstrumentOption is an interface for applying metric instrument options.

func WithDescription 

func WithDescription(desc string) InstrumentOption

WithDescription applies provided description.

func WithUnit 

func WithUnit(unit unit.Unit) InstrumentOption

WithUnit applies provided unit.

type Int64Counter 

type Int64Counter struct {
	// contains filtered or unexported fields
}

Int64Counter is a metric that accumulates int64 values.

func (Int64Counter) Add 

func (c Int64Counter) Add(ctx context.Context, value int64, labels ...attribute.KeyValue)

Add adds the value to the counter's sum. The labels should contain the keys and values to be associated with this value.

func (Int64Counter) Measurement 

func (c Int64Counter) Measurement(value int64) Measurement

Measurement creates a Measurement object to use with batch recording.

func (Int64Counter) SyncImpl 

func (s Int64Counter) SyncImpl() sdkapi.SyncImpl

SyncImpl returns the implementation object for synchronous instruments.

type Int64CounterObserver added in v0.23.0 

type Int64CounterObserver struct {
	// contains filtered or unexported fields
}

Int64CounterObserver is a metric that captures a precomputed sum of int64 values at a point in time.

func (Int64CounterObserver) AsyncImpl added in v0.23.0 

func (a Int64CounterObserver) AsyncImpl() sdkapi.AsyncImpl

AsyncImpl implements AsyncImpl.

func (Int64CounterObserver) Observation added in v0.23.0 

func (i Int64CounterObserver) Observation(v int64) Observation

Observation returns an Observation, a BatchObserverFunc argument, for an asynchronous integer instrument. This returns an implementation-level object for use by the SDK, users should not refer to this.

type Int64GaugeObserver added in v0.23.0 

type Int64GaugeObserver struct {
	// contains filtered or unexported fields
}

Int64GaugeObserver is a metric that captures a set of int64 values at a point in time.

func (Int64GaugeObserver) AsyncImpl added in v0.23.0 

func (a Int64GaugeObserver) AsyncImpl() sdkapi.AsyncImpl

AsyncImpl implements AsyncImpl.

func (Int64GaugeObserver) Observation added in v0.23.0 

func (i Int64GaugeObserver) Observation(v int64) Observation

Observation returns an Observation, a BatchObserverFunc argument, for an asynchronous integer instrument. This returns an implementation-level object for use by the SDK, users should not refer to this.

type Int64Histogram added in v0.23.0 

type Int64Histogram struct {
	// contains filtered or unexported fields
}

Int64Histogram is a metric that records int64 values.

func (Int64Histogram) Measurement added in v0.23.0 

func (c Int64Histogram) Measurement(value int64) Measurement

Measurement creates a Measurement object to use with batch recording.

func (Int64Histogram) Record added in v0.23.0 

func (c Int64Histogram) Record(ctx context.Context, value int64, labels ...attribute.KeyValue)

Record adds a new value to the Histogram's distribution. The labels should contain the keys and values to be associated with this value.

func (Int64Histogram) SyncImpl added in v0.23.0 

func (s Int64Histogram) SyncImpl() sdkapi.SyncImpl

SyncImpl returns the implementation object for synchronous instruments.

type Int64ObserverFunc 

type Int64ObserverFunc func(context.Context, Int64ObserverResult)

Int64ObserverFunc is a type of callback that integral observers run.

func (*Int64ObserverFunc) AnyRunner 

func (*Int64ObserverFunc) AnyRunner()

AnyRunner implements AsyncRunner.

func (*Int64ObserverFunc) Run 

func (i *Int64ObserverFunc) Run(ctx context.Context, impl sdkapi.AsyncImpl, function func([]attribute.KeyValue, ...Observation))

Run implements AsyncSingleRunner.

type Int64ObserverResult 

type Int64ObserverResult struct {
	// contains filtered or unexported fields
}

Int64ObserverResult is passed to an observer callback to capture observations for one asynchronous integer metric instrument.

func (Int64ObserverResult) Observe 

func (ir Int64ObserverResult) Observe(value int64, labels ...attribute.KeyValue)

Observe captures a single integer value from the associated instrument callback, with the given labels.

type Int64UpDownCounter 

type Int64UpDownCounter struct {
	// contains filtered or unexported fields
}

Int64UpDownCounter is a metric instrument that sums integer values.

func (Int64UpDownCounter) Add 

func (c Int64UpDownCounter) Add(ctx context.Context, value int64, labels ...attribute.KeyValue)

Add adds the value to the counter's sum. The labels should contain the keys and values to be associated with this value.

func (Int64UpDownCounter) Measurement 

func (c Int64UpDownCounter) Measurement(value int64) Measurement

Measurement creates a Measurement object to use with batch recording.

func (Int64UpDownCounter) SyncImpl 

func (s Int64UpDownCounter) SyncImpl() sdkapi.SyncImpl

SyncImpl returns the implementation object for synchronous instruments.

type Int64UpDownCounterObserver added in v0.23.0 

type Int64UpDownCounterObserver struct {
	// contains filtered or unexported fields
}

Int64UpDownCounterObserver is a metric that captures a precomputed sum of int64 values at a point in time.

func (Int64UpDownCounterObserver) AsyncImpl added in v0.23.0 

func (a Int64UpDownCounterObserver) AsyncImpl() sdkapi.AsyncImpl

AsyncImpl implements AsyncImpl.

func (Int64UpDownCounterObserver) Observation added in v0.23.0 

func (i Int64UpDownCounterObserver) Observation(v int64) Observation

Observation returns an Observation, a BatchObserverFunc argument, for an asynchronous integer instrument. This returns an implementation-level object for use by the SDK, users should not refer to this.

type Measurement 

type Measurement = sdkapi.Measurement

Measurement is used for reporting a synchronous batch of metric values. Instances of this type should be created by synchronous instruments (e.g., Int64Counter.Measurement()).

Note: This is an alias because it is a first-class member of the API but is also part of the lower-level sdkapi interface.

type Meter 

type Meter struct {
	// contains filtered or unexported fields
}

Meter is the creator of metric instruments.

An uninitialized Meter is a no-op implementation.

func WrapMeterImpl 

func WrapMeterImpl(impl sdkapi.MeterImpl) Meter

WrapMeterImpl constructs a `Meter` implementation from a `MeterImpl` implementation.

func (Meter) MeterImpl 

func (m Meter) MeterImpl() sdkapi.MeterImpl

MeterImpl returns the underlying MeterImpl of this Meter.

func (Meter) NewBatchObserver 

func (m Meter) NewBatchObserver(callback BatchObserverFunc) BatchObserver

NewBatchObserver creates a new BatchObserver that supports making batches of observations for multiple instruments.

func (Meter) NewFloat64Counter 

func (m Meter) NewFloat64Counter(name string, options ...InstrumentOption) (Float64Counter, error)

NewFloat64Counter creates a new floating point Counter with the given name, customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewFloat64CounterObserver added in v0.23.0 

func (m Meter) NewFloat64CounterObserver(name string, callback Float64ObserverFunc, opts ...InstrumentOption) (Float64CounterObserver, error)

NewFloat64CounterObserver creates a new floating point CounterObserver with the given name, running a given callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewFloat64GaugeObserver added in v0.23.0 

func (m Meter) NewFloat64GaugeObserver(name string, callback Float64ObserverFunc, opts ...InstrumentOption) (Float64GaugeObserver, error)

NewFloat64GaugeObserver creates a new floating point GaugeObserver with the given name, running a given callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewFloat64Histogram added in v0.23.0 

func (m Meter) NewFloat64Histogram(name string, opts ...InstrumentOption) (Float64Histogram, error)

NewFloat64Histogram creates a new floating point Histogram with the given name, customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewFloat64UpDownCounter 

func (m Meter) NewFloat64UpDownCounter(name string, options ...InstrumentOption) (Float64UpDownCounter, error)

NewFloat64UpDownCounter creates a new floating point UpDownCounter with the given name, customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewFloat64UpDownCounterObserver added in v0.23.0 

func (m Meter) NewFloat64UpDownCounterObserver(name string, callback Float64ObserverFunc, opts ...InstrumentOption) (Float64UpDownCounterObserver, error)

NewFloat64UpDownCounterObserver creates a new floating point UpDownCounterObserver with the given name, running a given callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewInt64Counter 

func (m Meter) NewInt64Counter(name string, options ...InstrumentOption) (Int64Counter, error)

NewInt64Counter creates a new integer Counter instrument with the given name, customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewInt64CounterObserver added in v0.23.0 

func (m Meter) NewInt64CounterObserver(name string, callback Int64ObserverFunc, opts ...InstrumentOption) (Int64CounterObserver, error)

NewInt64CounterObserver creates a new integer CounterObserver instrument with the given name, running a given callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewInt64GaugeObserver added in v0.23.0 

func (m Meter) NewInt64GaugeObserver(name string, callback Int64ObserverFunc, opts ...InstrumentOption) (Int64GaugeObserver, error)

NewInt64GaugeObserver creates a new integer GaugeObserver instrument with the given name, running a given callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewInt64Histogram added in v0.23.0 

func (m Meter) NewInt64Histogram(name string, opts ...InstrumentOption) (Int64Histogram, error)

NewInt64Histogram creates a new integer Histogram instrument with the given name, customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewInt64UpDownCounter 

func (m Meter) NewInt64UpDownCounter(name string, options ...InstrumentOption) (Int64UpDownCounter, error)

NewInt64UpDownCounter creates a new integer UpDownCounter instrument with the given name, customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) NewInt64UpDownCounterObserver added in v0.23.0 

func (m Meter) NewInt64UpDownCounterObserver(name string, callback Int64ObserverFunc, opts ...InstrumentOption) (Int64UpDownCounterObserver, error)

NewInt64UpDownCounterObserver creates a new integer UpDownCounterObserver instrument with the given name, running a given callback, and customized with options. May return an error if the name is invalid (e.g., empty) or improperly registered (e.g., duplicate registration).

func (Meter) RecordBatch 

func (m Meter) RecordBatch(ctx context.Context, ls []attribute.KeyValue, ms ...Measurement)

RecordBatch atomically records a batch of measurements.

type MeterConfig 

type MeterConfig struct {
	// contains filtered or unexported fields
}

MeterConfig contains options for Meters.

func NewMeterConfig 

func NewMeterConfig(opts ...MeterOption) MeterConfig

NewMeterConfig creates a new MeterConfig and applies all the given options.

func (*MeterConfig) InstrumentationVersion 

func (cfg *MeterConfig) InstrumentationVersion() string

InstrumentationVersion is the version of the library providing instrumentation.

func (*MeterConfig) SchemaURL added in v0.24.0 

func (cfg *MeterConfig) SchemaURL() string

SchemaURL is the schema_url of the library providing instrumentation.

type MeterMust 

type MeterMust struct {
	// contains filtered or unexported fields
}

MeterMust is a wrapper for Meter interfaces that panics when any instrument constructor encounters an error.

func Must 

func Must(meter Meter) MeterMust

Must constructs a MeterMust implementation from a Meter, allowing the application to panic when any instrument constructor yields an error.

func (MeterMust) NewBatchObserver 

func (mm MeterMust) NewBatchObserver(callback BatchObserverFunc) BatchObserverMust

NewBatchObserver returns a wrapper around BatchObserver that panics when any instrument constructor returns an error.

func (MeterMust) NewFloat64Counter 

func (mm MeterMust) NewFloat64Counter(name string, cos ...InstrumentOption) Float64Counter

NewFloat64Counter calls `Meter.NewFloat64Counter` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewFloat64CounterObserver added in v0.23.0 

func (mm MeterMust) NewFloat64CounterObserver(name string, callback Float64ObserverFunc, oos ...InstrumentOption) Float64CounterObserver

NewFloat64CounterObserver calls `Meter.NewFloat64CounterObserver` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewFloat64GaugeObserver added in v0.23.0 

func (mm MeterMust) NewFloat64GaugeObserver(name string, callback Float64ObserverFunc, oos ...InstrumentOption) Float64GaugeObserver

NewFloat64GaugeObserver calls `Meter.NewFloat64GaugeObserver` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewFloat64Histogram added in v0.23.0 

func (mm MeterMust) NewFloat64Histogram(name string, mos ...InstrumentOption) Float64Histogram

NewFloat64Histogram calls `Meter.NewFloat64Histogram` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewFloat64UpDownCounter 

func (mm MeterMust) NewFloat64UpDownCounter(name string, cos ...InstrumentOption) Float64UpDownCounter

NewFloat64UpDownCounter calls `Meter.NewFloat64UpDownCounter` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewFloat64UpDownCounterObserver added in v0.23.0 

func (mm MeterMust) NewFloat64UpDownCounterObserver(name string, callback Float64ObserverFunc, oos ...InstrumentOption) Float64UpDownCounterObserver

NewFloat64UpDownCounterObserver calls `Meter.NewFloat64UpDownCounterObserver` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewInt64Counter 

func (mm MeterMust) NewInt64Counter(name string, cos ...InstrumentOption) Int64Counter

NewInt64Counter calls `Meter.NewInt64Counter` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewInt64CounterObserver added in v0.23.0 

func (mm MeterMust) NewInt64CounterObserver(name string, callback Int64ObserverFunc, oos ...InstrumentOption) Int64CounterObserver

NewInt64CounterObserver calls `Meter.NewInt64CounterObserver` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewInt64GaugeObserver added in v0.23.0 

func (mm MeterMust) NewInt64GaugeObserver(name string, callback Int64ObserverFunc, oos ...InstrumentOption) Int64GaugeObserver

NewInt64GaugeObserver calls `Meter.NewInt64GaugeObserver` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewInt64Histogram added in v0.23.0 

func (mm MeterMust) NewInt64Histogram(name string, mos ...InstrumentOption) Int64Histogram

NewInt64Histogram calls `Meter.NewInt64Histogram` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewInt64UpDownCounter 

func (mm MeterMust) NewInt64UpDownCounter(name string, cos ...InstrumentOption) Int64UpDownCounter

NewInt64UpDownCounter calls `Meter.NewInt64UpDownCounter` and returns the instrument, panicking if it encounters an error.

func (MeterMust) NewInt64UpDownCounterObserver added in v0.23.0 

func (mm MeterMust) NewInt64UpDownCounterObserver(name string, callback Int64ObserverFunc, oos ...InstrumentOption) Int64UpDownCounterObserver

NewInt64UpDownCounterObserver calls `Meter.NewInt64UpDownCounterObserver` and returns the instrument, panicking if it encounters an error.

type MeterOption 

type MeterOption interface {
	// contains filtered or unexported methods
}

MeterOption is an interface for applying Meter options.

func WithInstrumentationVersion 

func WithInstrumentationVersion(version string) MeterOption

WithInstrumentationVersion sets the instrumentation version.

func WithSchemaURL added in v0.24.0 

func WithSchemaURL(schemaURL string) MeterOption

WithSchemaURL sets the schema URL.

type MeterProvider 

type MeterProvider interface {
	// Meter creates an implementation of the Meter interface.
	// The instrumentationName must be the name of the library providing
	// instrumentation. This name may be the same as the instrumented code
	// only if that code provides built-in instrumentation. If the
	// instrumentationName is empty, then a implementation defined default
	// name will be used instead.
	Meter(instrumentationName string, opts ...MeterOption) Meter
}

MeterProvider supports named Meter instances.

func NewNoopMeterProvider added in v0.24.0 

func NewNoopMeterProvider() MeterProvider

NewNoopMeterProvider returns an implementation of MeterProvider that performs no operations. The Meter and Instrument created from the returned MeterProvider also perform no operations.

type Observation 

type Observation = sdkapi.Observation

Observation is used for reporting an asynchronous batch of metric values. Instances of this type should be created by asynchronous instruments (e.g., Int64GaugeObserver.Observation()).

Note: This is an alias because it is a first-class member of the API but is also part of the lower-level sdkapi interface.

Source Files

View all Source files

Directories

Path Synopsis
Package number provides a number abstraction for instruments that either support int64 or float64 input values.
 Package number provides a number abstraction for instruments that either support int64 or float64 input values.
Package unit provides units.
 Package unit provides units.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.