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. Additive instruments are semantically intended for capturing a sum. Grouping instruments are intended for capturing a distribution.

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

    The synchronous instrument names are:

    Counter:           additive, monotonic
    UpDownCounter:     additive
    ValueRecorder:     grouping
    

    and the asynchronous instruments are:

    SumObserver:       additive, monotonic
    UpDownSumObserver: additive
    ValueObserver:     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 AsyncBatchRunner

      type AsyncBatchRunner interface {
      	// Run accepts a function for capturing observations of
      	// multiple instruments.
      	Run(ctx context.Context, capture func([]label.KeyValue, ...Observation))
      
      	AsyncRunner
      }

        AsyncBatchRunner is an interface implemented by batch-observer callbacks.

        type AsyncImpl

        type AsyncImpl interface {
        	InstrumentImpl
        }

          AsyncImpl is an implementation-level interface to an asynchronous instrument (e.g., Observer instruments).

          type AsyncRunner

          type AsyncRunner interface {
          	// AnyRunner() is a non-exported method with no functional use
          	// other than to make this a non-empty interface.
          	AnyRunner()
          }

            AsyncRunner is expected to convert into an AsyncSingleRunner or an AsyncBatchRunner. SDKs will encounter an error if the AsyncRunner does not satisfy one of these interfaces.

            type AsyncSingleRunner

            type AsyncSingleRunner interface {
            	// Run accepts a single instrument and function for capturing
            	// observations of that instrument.  Each call to the function
            	// receives one captured observation.  (The function accepts
            	// multiple observations so the same implementation can be
            	// used for batch runners.)
            	Run(ctx context.Context, single AsyncImpl, capture func([]label.KeyValue, ...Observation))
            
            	AsyncRunner
            }

              AsyncSingleRunner is an interface implemented by single-observer callbacks.

              type BatchObserver

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

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

                func (BatchObserver) NewFloat64SumObserver

                func (b BatchObserver) NewFloat64SumObserver(name string, opts ...InstrumentOption) (Float64SumObserver, error)

                  NewFloat64SumObserver creates a new floating point SumObserver 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) NewFloat64UpDownSumObserver

                  func (b BatchObserver) NewFloat64UpDownSumObserver(name string, opts ...InstrumentOption) (Float64UpDownSumObserver, error)

                    NewFloat64UpDownSumObserver creates a new floating point UpDownSumObserver 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) NewFloat64ValueObserver

                    func (b BatchObserver) NewFloat64ValueObserver(name string, opts ...InstrumentOption) (Float64ValueObserver, error)

                      NewFloat64ValueObserver creates a new floating point ValueObserver 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) NewInt64SumObserver

                      func (b BatchObserver) NewInt64SumObserver(name string, opts ...InstrumentOption) (Int64SumObserver, error)

                        NewInt64SumObserver creates a new integer SumObserver 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) NewInt64UpDownSumObserver

                        func (b BatchObserver) NewInt64UpDownSumObserver(name string, opts ...InstrumentOption) (Int64UpDownSumObserver, error)

                          NewInt64UpDownSumObserver creates a new integer UpDownSumObserver 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) NewInt64ValueObserver

                          func (b BatchObserver) NewInt64ValueObserver(name string, opts ...InstrumentOption) (Int64ValueObserver, error)

                            NewInt64ValueObserver creates a new integer ValueObserver 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([]label.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) NewFloat64SumObserver

                                    func (bm BatchObserverMust) NewFloat64SumObserver(name string, oos ...InstrumentOption) Float64SumObserver

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

                                      func (BatchObserverMust) NewFloat64UpDownSumObserver

                                      func (bm BatchObserverMust) NewFloat64UpDownSumObserver(name string, oos ...InstrumentOption) Float64UpDownSumObserver

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

                                        func (BatchObserverMust) NewFloat64ValueObserver

                                        func (bm BatchObserverMust) NewFloat64ValueObserver(name string, oos ...InstrumentOption) Float64ValueObserver

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

                                          func (BatchObserverMust) NewInt64SumObserver

                                          func (bm BatchObserverMust) NewInt64SumObserver(name string, oos ...InstrumentOption) Int64SumObserver

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

                                            func (BatchObserverMust) NewInt64UpDownSumObserver

                                            func (bm BatchObserverMust) NewInt64UpDownSumObserver(name string, oos ...InstrumentOption) Int64UpDownSumObserver

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

                                              func (BatchObserverMust) NewInt64ValueObserver

                                              func (bm BatchObserverMust) NewInt64ValueObserver(name string, oos ...InstrumentOption) Int64ValueObserver

                                                NewInt64ValueObserver calls `BatchObserver.NewInt64ValueObserver` 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 []label.KeyValue, obs ...Observation)

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

                                                    type BoundFloat64Counter

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

                                                      BoundFloat64Counter is a bound instrument for Float64Counter.

                                                      It inherits the Unbind function from syncBoundInstrument.

                                                      func (BoundFloat64Counter) Add

                                                      func (b BoundFloat64Counter) Add(ctx context.Context, value float64)

                                                        Add adds the value to the counter's sum using the labels previously bound to this counter via Bind()

                                                        func (BoundFloat64Counter) Unbind

                                                        func (h BoundFloat64Counter) Unbind()

                                                          Unbind calls SyncImpl.Unbind.

                                                          type BoundFloat64UpDownCounter

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

                                                            BoundFloat64UpDownCounter is a bound instrument for Float64UpDownCounter.

                                                            It inherits the Unbind function from syncBoundInstrument.

                                                            func (BoundFloat64UpDownCounter) Add

                                                              Add adds the value to the counter's sum using the labels previously bound to this counter via Bind()

                                                              func (BoundFloat64UpDownCounter) Unbind

                                                              func (h BoundFloat64UpDownCounter) Unbind()

                                                                Unbind calls SyncImpl.Unbind.

                                                                type BoundFloat64ValueRecorder

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

                                                                  BoundFloat64ValueRecorder is a bound instrument for Float64ValueRecorder.

                                                                  It inherits the Unbind function from syncBoundInstrument.

                                                                  func (BoundFloat64ValueRecorder) Record

                                                                  func (b BoundFloat64ValueRecorder) Record(ctx context.Context, value float64)

                                                                    Record adds a new value to the ValueRecorder's distribution using the labels previously bound to the ValueRecorder via Bind().

                                                                    func (BoundFloat64ValueRecorder) Unbind

                                                                    func (h BoundFloat64ValueRecorder) Unbind()

                                                                      Unbind calls SyncImpl.Unbind.

                                                                      type BoundInt64Counter

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

                                                                        BoundInt64Counter is a boundInstrument for Int64Counter.

                                                                        It inherits the Unbind function from syncBoundInstrument.

                                                                        func (BoundInt64Counter) Add

                                                                        func (b BoundInt64Counter) Add(ctx context.Context, value int64)

                                                                          Add adds the value to the counter's sum using the labels previously bound to this counter via Bind()

                                                                          func (BoundInt64Counter) Unbind

                                                                          func (h BoundInt64Counter) Unbind()

                                                                            Unbind calls SyncImpl.Unbind.

                                                                            type BoundInt64UpDownCounter

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

                                                                              BoundInt64UpDownCounter is a boundInstrument for Int64UpDownCounter.

                                                                              It inherits the Unbind function from syncBoundInstrument.

                                                                              func (BoundInt64UpDownCounter) Add

                                                                              func (b BoundInt64UpDownCounter) Add(ctx context.Context, value int64)

                                                                                Add adds the value to the counter's sum using the labels previously bound to this counter via Bind()

                                                                                func (BoundInt64UpDownCounter) Unbind

                                                                                func (h BoundInt64UpDownCounter) Unbind()

                                                                                  Unbind calls SyncImpl.Unbind.

                                                                                  type BoundInt64ValueRecorder

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

                                                                                    BoundInt64ValueRecorder is a bound instrument for Int64ValueRecorder.

                                                                                    It inherits the Unbind function from syncBoundInstrument.

                                                                                    func (BoundInt64ValueRecorder) Record

                                                                                    func (b BoundInt64ValueRecorder) Record(ctx context.Context, value int64)

                                                                                      Record adds a new value to the ValueRecorder's distribution using the labels previously bound to the ValueRecorder via Bind().

                                                                                      func (BoundInt64ValueRecorder) Unbind

                                                                                      func (h BoundInt64ValueRecorder) Unbind()

                                                                                        Unbind calls SyncImpl.Unbind.

                                                                                        type BoundSyncImpl

                                                                                        type BoundSyncImpl interface {
                                                                                        
                                                                                        	// RecordOne captures a single synchronous metric event.
                                                                                        	RecordOne(ctx context.Context, number number.Number)
                                                                                        
                                                                                        	// Unbind frees the resources associated with this bound instrument. It
                                                                                        	// does not affect the metric this bound instrument was created through.
                                                                                        	Unbind()
                                                                                        }

                                                                                          BoundSyncImpl is the implementation-level interface to a generic bound synchronous instrument

                                                                                          type Descriptor

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

                                                                                            Descriptor contains all the settings that describe an instrument, including its name, metric kind, number kind, and the configurable options.

                                                                                            func NewDescriptor

                                                                                            func NewDescriptor(name string, ikind InstrumentKind, nkind number.Kind, opts ...InstrumentOption) Descriptor

                                                                                              NewDescriptor returns a Descriptor with the given contents.

                                                                                              func (Descriptor) Description

                                                                                              func (d Descriptor) Description() string

                                                                                                Description provides a human-readable description of the metric instrument.

                                                                                                func (Descriptor) InstrumentKind

                                                                                                func (d Descriptor) InstrumentKind() InstrumentKind

                                                                                                  InstrumentKind returns the specific kind of instrument.

                                                                                                  func (Descriptor) InstrumentationName

                                                                                                  func (d Descriptor) InstrumentationName() string

                                                                                                    InstrumentationName returns the name of the library that provided instrumentation for this instrument.

                                                                                                    func (Descriptor) InstrumentationVersion

                                                                                                    func (d Descriptor) InstrumentationVersion() string

                                                                                                      InstrumentationVersion returns the version of the library that provided instrumentation for this instrument.

                                                                                                      func (Descriptor) Name

                                                                                                      func (d Descriptor) Name() string

                                                                                                        Name returns the metric instrument's name.

                                                                                                        func (Descriptor) NumberKind

                                                                                                        func (d Descriptor) NumberKind() number.Kind

                                                                                                          NumberKind returns whether this instrument is declared over int64, float64, or uint64 values.

                                                                                                          func (Descriptor) Unit

                                                                                                          func (d Descriptor) Unit() unit.Unit

                                                                                                            Unit describes the units of the metric instrument. Unitless metrics return the empty string.

                                                                                                            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 ...label.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) Bind

                                                                                                                func (c Float64Counter) Bind(labels ...label.KeyValue) (h BoundFloat64Counter)

                                                                                                                  Bind creates a bound instrument for this counter. The labels are associated with values recorded via subsequent calls to Record.

                                                                                                                  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() 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 AsyncImpl, function func([]label.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 ...label.KeyValue)

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

                                                                                                                                type Float64SumObserver

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

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

                                                                                                                                  func (Float64SumObserver) AsyncImpl

                                                                                                                                  func (a Float64SumObserver) AsyncImpl() AsyncImpl

                                                                                                                                    AsyncImpl implements AsyncImpl.

                                                                                                                                    func (Float64SumObserver) Observation

                                                                                                                                    func (f Float64SumObserver) 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 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 ...label.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) Bind

                                                                                                                                            Bind creates a bound instrument for this counter. The labels are associated with values recorded via subsequent calls to Record.

                                                                                                                                            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() SyncImpl

                                                                                                                                                SyncImpl returns the implementation object for synchronous instruments.

                                                                                                                                                type Float64UpDownSumObserver

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

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

                                                                                                                                                  func (Float64UpDownSumObserver) AsyncImpl

                                                                                                                                                  func (a Float64UpDownSumObserver) AsyncImpl() AsyncImpl

                                                                                                                                                    AsyncImpl implements AsyncImpl.

                                                                                                                                                    func (Float64UpDownSumObserver) Observation

                                                                                                                                                    func (f Float64UpDownSumObserver) 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 Float64ValueObserver

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

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

                                                                                                                                                        func (Float64ValueObserver) AsyncImpl

                                                                                                                                                        func (a Float64ValueObserver) AsyncImpl() AsyncImpl

                                                                                                                                                          AsyncImpl implements AsyncImpl.

                                                                                                                                                          func (Float64ValueObserver) Observation

                                                                                                                                                          func (f Float64ValueObserver) 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 Float64ValueRecorder

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

                                                                                                                                                              Float64ValueRecorder is a metric that records float64 values.

                                                                                                                                                              func (Float64ValueRecorder) Bind

                                                                                                                                                                Bind creates a bound instrument for this ValueRecorder. The labels are associated with values recorded via subsequent calls to Record.

                                                                                                                                                                func (Float64ValueRecorder) Measurement

                                                                                                                                                                func (c Float64ValueRecorder) Measurement(value float64) Measurement

                                                                                                                                                                  Measurement creates a Measurement object to use with batch recording.

                                                                                                                                                                  func (Float64ValueRecorder) Record

                                                                                                                                                                  func (c Float64ValueRecorder) Record(ctx context.Context, value float64, labels ...label.KeyValue)

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

                                                                                                                                                                    func (Float64ValueRecorder) SyncImpl

                                                                                                                                                                    func (s Float64ValueRecorder) SyncImpl() SyncImpl

                                                                                                                                                                      SyncImpl returns the implementation object for synchronous instruments.

                                                                                                                                                                      type InstrumentConfig

                                                                                                                                                                      type InstrumentConfig struct {
                                                                                                                                                                      	// Description describes the instrument in human-readable terms.
                                                                                                                                                                      	Description string
                                                                                                                                                                      	// Unit describes the measurement unit for a instrument.
                                                                                                                                                                      	Unit unit.Unit
                                                                                                                                                                      	// InstrumentationName is the name of the library providing
                                                                                                                                                                      	// instrumentation.
                                                                                                                                                                      	InstrumentationName string
                                                                                                                                                                      	// InstrumentationVersion is the version of the library providing
                                                                                                                                                                      	// instrumentation.
                                                                                                                                                                      	InstrumentationVersion string
                                                                                                                                                                      }

                                                                                                                                                                        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.

                                                                                                                                                                          type InstrumentImpl

                                                                                                                                                                          type InstrumentImpl interface {
                                                                                                                                                                          	// Implementation returns the underlying implementation of the
                                                                                                                                                                          	// instrument, which allows the implementation to gain access
                                                                                                                                                                          	// to its own representation especially from a `Measurement`.
                                                                                                                                                                          	Implementation() interface{}
                                                                                                                                                                          
                                                                                                                                                                          	// Descriptor returns a copy of the instrument's Descriptor.
                                                                                                                                                                          	Descriptor() Descriptor
                                                                                                                                                                          }

                                                                                                                                                                            InstrumentImpl is a common interface for synchronous and asynchronous instruments.

                                                                                                                                                                            type InstrumentKind

                                                                                                                                                                            type InstrumentKind int8

                                                                                                                                                                              InstrumentKind describes the kind of instrument.

                                                                                                                                                                              const (
                                                                                                                                                                              	// ValueRecorderInstrumentKind indicates a ValueRecorder instrument.
                                                                                                                                                                              	ValueRecorderInstrumentKind InstrumentKind = iota
                                                                                                                                                                              	// ValueObserverInstrumentKind indicates an ValueObserver instrument.
                                                                                                                                                                              	ValueObserverInstrumentKind
                                                                                                                                                                              
                                                                                                                                                                              	// CounterInstrumentKind indicates a Counter instrument.
                                                                                                                                                                              	CounterInstrumentKind
                                                                                                                                                                              	// UpDownCounterInstrumentKind indicates a UpDownCounter instrument.
                                                                                                                                                                              	UpDownCounterInstrumentKind
                                                                                                                                                                              
                                                                                                                                                                              	// SumObserverInstrumentKind indicates a SumObserver instrument.
                                                                                                                                                                              	SumObserverInstrumentKind
                                                                                                                                                                              	// UpDownSumObserverInstrumentKind indicates a UpDownSumObserver
                                                                                                                                                                              	// instrument.
                                                                                                                                                                              	UpDownSumObserverInstrumentKind
                                                                                                                                                                              )

                                                                                                                                                                              func (InstrumentKind) Adding

                                                                                                                                                                              func (k InstrumentKind) Adding() bool

                                                                                                                                                                                Adding returns whether this kind of instrument adds its inputs (as opposed to Grouping).

                                                                                                                                                                                func (InstrumentKind) Asynchronous

                                                                                                                                                                                func (k InstrumentKind) Asynchronous() bool

                                                                                                                                                                                  Asynchronous returns whether this is an asynchronous kind of instrument.

                                                                                                                                                                                  func (InstrumentKind) Grouping

                                                                                                                                                                                  func (k InstrumentKind) Grouping() bool

                                                                                                                                                                                    Grouping returns whether this kind of instrument groups its inputs (as opposed to Adding).

                                                                                                                                                                                    func (InstrumentKind) Monotonic

                                                                                                                                                                                    func (k InstrumentKind) Monotonic() bool

                                                                                                                                                                                      Monotonic returns whether this kind of instrument exposes a non-decreasing sum.

                                                                                                                                                                                      func (InstrumentKind) PrecomputedSum

                                                                                                                                                                                      func (k InstrumentKind) PrecomputedSum() bool

                                                                                                                                                                                        PrecomputedSum returns whether this kind of instrument receives precomputed sums.

                                                                                                                                                                                        func (InstrumentKind) String

                                                                                                                                                                                        func (i InstrumentKind) String() string

                                                                                                                                                                                        func (InstrumentKind) Synchronous

                                                                                                                                                                                        func (k InstrumentKind) Synchronous() bool

                                                                                                                                                                                          Synchronous returns whether this is a synchronous kind of instrument.

                                                                                                                                                                                          type InstrumentOption

                                                                                                                                                                                          type InstrumentOption interface {
                                                                                                                                                                                          	// ApplyMeter is used to set a InstrumentOption value of a
                                                                                                                                                                                          	// InstrumentConfig.
                                                                                                                                                                                          	ApplyInstrument(*InstrumentConfig)
                                                                                                                                                                                          }

                                                                                                                                                                                            InstrumentOption is an interface for applying metric instrument options.

                                                                                                                                                                                            func WithDescription

                                                                                                                                                                                            func WithDescription(desc string) InstrumentOption

                                                                                                                                                                                              WithDescription applies provided description.

                                                                                                                                                                                              func WithInstrumentationName

                                                                                                                                                                                              func WithInstrumentationName(name string) InstrumentOption

                                                                                                                                                                                                WithInstrumentationName sets the instrumentation name.

                                                                                                                                                                                                func WithUnit

                                                                                                                                                                                                func WithUnit(unit unit.Unit) InstrumentOption

                                                                                                                                                                                                  WithUnit applies provided unit.

                                                                                                                                                                                                  type InstrumentationOption

                                                                                                                                                                                                  type InstrumentationOption interface {
                                                                                                                                                                                                  	InstrumentOption
                                                                                                                                                                                                  	MeterOption
                                                                                                                                                                                                  }

                                                                                                                                                                                                    InstrumentationOption is an interface for applying instrumentation specific options.

                                                                                                                                                                                                    func WithInstrumentationVersion

                                                                                                                                                                                                    func WithInstrumentationVersion(version string) InstrumentationOption

                                                                                                                                                                                                      WithInstrumentationVersion sets the instrumentation version.

                                                                                                                                                                                                      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 ...label.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) Bind

                                                                                                                                                                                                          func (c Int64Counter) Bind(labels ...label.KeyValue) (h BoundInt64Counter)

                                                                                                                                                                                                            Bind creates a bound instrument for this counter. The labels are associated with values recorded via subsequent calls to Record.

                                                                                                                                                                                                            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() 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 AsyncImpl, function func([]label.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 ...label.KeyValue)

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

                                                                                                                                                                                                                          type Int64SumObserver

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

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

                                                                                                                                                                                                                            func (Int64SumObserver) AsyncImpl

                                                                                                                                                                                                                            func (a Int64SumObserver) AsyncImpl() AsyncImpl

                                                                                                                                                                                                                              AsyncImpl implements AsyncImpl.

                                                                                                                                                                                                                              func (Int64SumObserver) Observation

                                                                                                                                                                                                                              func (i Int64SumObserver) 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 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 ...label.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) Bind

                                                                                                                                                                                                                                      Bind creates a bound instrument for this counter. The labels are associated with values recorded via subsequent calls to Record.

                                                                                                                                                                                                                                      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() SyncImpl

                                                                                                                                                                                                                                          SyncImpl returns the implementation object for synchronous instruments.

                                                                                                                                                                                                                                          type Int64UpDownSumObserver

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

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

                                                                                                                                                                                                                                            func (Int64UpDownSumObserver) AsyncImpl

                                                                                                                                                                                                                                            func (a Int64UpDownSumObserver) AsyncImpl() AsyncImpl

                                                                                                                                                                                                                                              AsyncImpl implements AsyncImpl.

                                                                                                                                                                                                                                              func (Int64UpDownSumObserver) Observation

                                                                                                                                                                                                                                              func (i Int64UpDownSumObserver) 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 Int64ValueObserver

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

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

                                                                                                                                                                                                                                                  func (Int64ValueObserver) AsyncImpl

                                                                                                                                                                                                                                                  func (a Int64ValueObserver) AsyncImpl() AsyncImpl

                                                                                                                                                                                                                                                    AsyncImpl implements AsyncImpl.

                                                                                                                                                                                                                                                    func (Int64ValueObserver) Observation

                                                                                                                                                                                                                                                    func (i Int64ValueObserver) 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 Int64ValueRecorder

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

                                                                                                                                                                                                                                                        Int64ValueRecorder is a metric that records int64 values.

                                                                                                                                                                                                                                                        func (Int64ValueRecorder) Bind

                                                                                                                                                                                                                                                          Bind creates a bound instrument for this ValueRecorder. The labels are associated with values recorded via subsequent calls to Record.

                                                                                                                                                                                                                                                          func (Int64ValueRecorder) Measurement

                                                                                                                                                                                                                                                          func (c Int64ValueRecorder) Measurement(value int64) Measurement

                                                                                                                                                                                                                                                            Measurement creates a Measurement object to use with batch recording.

                                                                                                                                                                                                                                                            func (Int64ValueRecorder) Record

                                                                                                                                                                                                                                                            func (c Int64ValueRecorder) Record(ctx context.Context, value int64, labels ...label.KeyValue)

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

                                                                                                                                                                                                                                                              func (Int64ValueRecorder) SyncImpl

                                                                                                                                                                                                                                                              func (s Int64ValueRecorder) SyncImpl() SyncImpl

                                                                                                                                                                                                                                                                SyncImpl returns the implementation object for synchronous instruments.

                                                                                                                                                                                                                                                                type Measurement

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

                                                                                                                                                                                                                                                                  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()).

                                                                                                                                                                                                                                                                  func (Measurement) Number

                                                                                                                                                                                                                                                                  func (m Measurement) Number() number.Number

                                                                                                                                                                                                                                                                    Number returns a number recorded in this measurement.

                                                                                                                                                                                                                                                                    func (Measurement) SyncImpl

                                                                                                                                                                                                                                                                    func (m Measurement) SyncImpl() SyncImpl

                                                                                                                                                                                                                                                                      SyncImpl returns the instrument that created this measurement. This returns an implementation-level object for use by the SDK, users should not refer to this.

                                                                                                                                                                                                                                                                      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 MeterImpl, instrumentationName string, opts ...MeterOption) Meter

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

                                                                                                                                                                                                                                                                          func (Meter) MeterImpl

                                                                                                                                                                                                                                                                          func (m Meter) MeterImpl() 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) NewFloat64SumObserver

                                                                                                                                                                                                                                                                                func (m Meter) NewFloat64SumObserver(name string, callback Float64ObserverFunc, opts ...InstrumentOption) (Float64SumObserver, error)

                                                                                                                                                                                                                                                                                  NewFloat64SumObserver creates a new floating point SumObserver 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) 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) NewFloat64UpDownSumObserver

                                                                                                                                                                                                                                                                                    func (m Meter) NewFloat64UpDownSumObserver(name string, callback Float64ObserverFunc, opts ...InstrumentOption) (Float64UpDownSumObserver, error)

                                                                                                                                                                                                                                                                                      NewFloat64UpDownSumObserver creates a new floating point UpDownSumObserver 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) NewFloat64ValueObserver

                                                                                                                                                                                                                                                                                      func (m Meter) NewFloat64ValueObserver(name string, callback Float64ObserverFunc, opts ...InstrumentOption) (Float64ValueObserver, error)

                                                                                                                                                                                                                                                                                        NewFloat64ValueObserver creates a new floating point ValueObserver 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) NewFloat64ValueRecorder

                                                                                                                                                                                                                                                                                        func (m Meter) NewFloat64ValueRecorder(name string, opts ...InstrumentOption) (Float64ValueRecorder, error)

                                                                                                                                                                                                                                                                                          NewFloat64ValueRecorder creates a new floating point ValueRecorder 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) 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) NewInt64SumObserver

                                                                                                                                                                                                                                                                                            func (m Meter) NewInt64SumObserver(name string, callback Int64ObserverFunc, opts ...InstrumentOption) (Int64SumObserver, error)

                                                                                                                                                                                                                                                                                              NewInt64SumObserver creates a new integer SumObserver 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) 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) NewInt64UpDownSumObserver

                                                                                                                                                                                                                                                                                                func (m Meter) NewInt64UpDownSumObserver(name string, callback Int64ObserverFunc, opts ...InstrumentOption) (Int64UpDownSumObserver, error)

                                                                                                                                                                                                                                                                                                  NewInt64UpDownSumObserver creates a new integer UpDownSumObserver 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) NewInt64ValueObserver

                                                                                                                                                                                                                                                                                                  func (m Meter) NewInt64ValueObserver(name string, callback Int64ObserverFunc, opts ...InstrumentOption) (Int64ValueObserver, error)

                                                                                                                                                                                                                                                                                                    NewInt64ValueObserver creates a new integer ValueObserver 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) NewInt64ValueRecorder

                                                                                                                                                                                                                                                                                                    func (m Meter) NewInt64ValueRecorder(name string, opts ...InstrumentOption) (Int64ValueRecorder, error)

                                                                                                                                                                                                                                                                                                      NewInt64ValueRecorder creates a new integer ValueRecorder 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) RecordBatch

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

                                                                                                                                                                                                                                                                                                        RecordBatch atomically records a batch of measurements.

                                                                                                                                                                                                                                                                                                        type MeterConfig

                                                                                                                                                                                                                                                                                                        type MeterConfig struct {
                                                                                                                                                                                                                                                                                                        	// InstrumentationVersion is the version of the library providing
                                                                                                                                                                                                                                                                                                        	// instrumentation.
                                                                                                                                                                                                                                                                                                        	InstrumentationVersion string
                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                          MeterConfig contains options for Meters.

                                                                                                                                                                                                                                                                                                          func NewMeterConfig

                                                                                                                                                                                                                                                                                                          func NewMeterConfig(opts ...MeterOption) MeterConfig

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

                                                                                                                                                                                                                                                                                                            type MeterImpl

                                                                                                                                                                                                                                                                                                            type MeterImpl interface {
                                                                                                                                                                                                                                                                                                            	// RecordBatch atomically records a batch of measurements.
                                                                                                                                                                                                                                                                                                            	RecordBatch(ctx context.Context, labels []label.KeyValue, measurement ...Measurement)
                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                            	// NewSyncInstrument returns a newly constructed
                                                                                                                                                                                                                                                                                                            	// synchronous instrument implementation or an error, should
                                                                                                                                                                                                                                                                                                            	// one occur.
                                                                                                                                                                                                                                                                                                            	NewSyncInstrument(descriptor Descriptor) (SyncImpl, error)
                                                                                                                                                                                                                                                                                                            
                                                                                                                                                                                                                                                                                                            	// NewAsyncInstrument returns a newly constructed
                                                                                                                                                                                                                                                                                                            	// asynchronous instrument implementation or an error, should
                                                                                                                                                                                                                                                                                                            	// one occur.
                                                                                                                                                                                                                                                                                                            	NewAsyncInstrument(
                                                                                                                                                                                                                                                                                                            		descriptor Descriptor,
                                                                                                                                                                                                                                                                                                            		runner AsyncRunner,
                                                                                                                                                                                                                                                                                                            	) (AsyncImpl, error)
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                              MeterImpl is the interface an SDK must implement to supply a Meter implementation.

                                                                                                                                                                                                                                                                                                              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) NewFloat64SumObserver

                                                                                                                                                                                                                                                                                                                      func (mm MeterMust) NewFloat64SumObserver(name string, callback Float64ObserverFunc, oos ...InstrumentOption) Float64SumObserver

                                                                                                                                                                                                                                                                                                                        NewFloat64SumObserver calls `Meter.NewFloat64SumObserver` 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) NewFloat64UpDownSumObserver

                                                                                                                                                                                                                                                                                                                          func (mm MeterMust) NewFloat64UpDownSumObserver(name string, callback Float64ObserverFunc, oos ...InstrumentOption) Float64UpDownSumObserver

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

                                                                                                                                                                                                                                                                                                                            func (MeterMust) NewFloat64ValueObserver

                                                                                                                                                                                                                                                                                                                            func (mm MeterMust) NewFloat64ValueObserver(name string, callback Float64ObserverFunc, oos ...InstrumentOption) Float64ValueObserver

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

                                                                                                                                                                                                                                                                                                                              func (MeterMust) NewFloat64ValueRecorder

                                                                                                                                                                                                                                                                                                                              func (mm MeterMust) NewFloat64ValueRecorder(name string, mos ...InstrumentOption) Float64ValueRecorder

                                                                                                                                                                                                                                                                                                                                NewFloat64ValueRecorder calls `Meter.NewFloat64ValueRecorder` 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) NewInt64SumObserver

                                                                                                                                                                                                                                                                                                                                  func (mm MeterMust) NewInt64SumObserver(name string, callback Int64ObserverFunc, oos ...InstrumentOption) Int64SumObserver

                                                                                                                                                                                                                                                                                                                                    NewInt64SumObserver calls `Meter.NewInt64SumObserver` 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) NewInt64UpDownSumObserver

                                                                                                                                                                                                                                                                                                                                      func (mm MeterMust) NewInt64UpDownSumObserver(name string, callback Int64ObserverFunc, oos ...InstrumentOption) Int64UpDownSumObserver

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

                                                                                                                                                                                                                                                                                                                                        func (MeterMust) NewInt64ValueObserver

                                                                                                                                                                                                                                                                                                                                        func (mm MeterMust) NewInt64ValueObserver(name string, callback Int64ObserverFunc, oos ...InstrumentOption) Int64ValueObserver

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

                                                                                                                                                                                                                                                                                                                                          func (MeterMust) NewInt64ValueRecorder

                                                                                                                                                                                                                                                                                                                                          func (mm MeterMust) NewInt64ValueRecorder(name string, mos ...InstrumentOption) Int64ValueRecorder

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

                                                                                                                                                                                                                                                                                                                                            type MeterOption

                                                                                                                                                                                                                                                                                                                                            type MeterOption interface {
                                                                                                                                                                                                                                                                                                                                            	// ApplyMeter is used to set a MeterOption value of a MeterConfig.
                                                                                                                                                                                                                                                                                                                                            	ApplyMeter(*MeterConfig)
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                              MeterOption is an interface for applying Meter options.

                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                type NoopAsync

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

                                                                                                                                                                                                                                                                                                                                                func (NoopAsync) Descriptor

                                                                                                                                                                                                                                                                                                                                                func (NoopAsync) Descriptor() Descriptor

                                                                                                                                                                                                                                                                                                                                                func (NoopAsync) Implementation

                                                                                                                                                                                                                                                                                                                                                func (NoopAsync) Implementation() interface{}

                                                                                                                                                                                                                                                                                                                                                type NoopMeterProvider

                                                                                                                                                                                                                                                                                                                                                type NoopMeterProvider struct{}

                                                                                                                                                                                                                                                                                                                                                func (NoopMeterProvider) Meter

                                                                                                                                                                                                                                                                                                                                                func (NoopMeterProvider) Meter(_ string, _ ...MeterOption) Meter

                                                                                                                                                                                                                                                                                                                                                type NoopSync

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

                                                                                                                                                                                                                                                                                                                                                func (NoopSync) Bind

                                                                                                                                                                                                                                                                                                                                                func (NoopSync) Descriptor

                                                                                                                                                                                                                                                                                                                                                func (NoopSync) Descriptor() Descriptor

                                                                                                                                                                                                                                                                                                                                                func (NoopSync) Implementation

                                                                                                                                                                                                                                                                                                                                                func (NoopSync) Implementation() interface{}

                                                                                                                                                                                                                                                                                                                                                func (NoopSync) RecordOne

                                                                                                                                                                                                                                                                                                                                                type Observation

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

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

                                                                                                                                                                                                                                                                                                                                                  func (Observation) AsyncImpl

                                                                                                                                                                                                                                                                                                                                                  func (m Observation) AsyncImpl() AsyncImpl

                                                                                                                                                                                                                                                                                                                                                    AsyncImpl returns the instrument that created this observation. This returns an implementation-level object for use by the SDK, users should not refer to this.

                                                                                                                                                                                                                                                                                                                                                    func (Observation) Number

                                                                                                                                                                                                                                                                                                                                                    func (m Observation) Number() number.Number

                                                                                                                                                                                                                                                                                                                                                      Number returns a number recorded in this observation.

                                                                                                                                                                                                                                                                                                                                                      type SyncImpl

                                                                                                                                                                                                                                                                                                                                                      type SyncImpl interface {
                                                                                                                                                                                                                                                                                                                                                      	InstrumentImpl
                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                      	// Bind creates an implementation-level bound instrument,
                                                                                                                                                                                                                                                                                                                                                      	// binding a label set with this instrument implementation.
                                                                                                                                                                                                                                                                                                                                                      	Bind(labels []label.KeyValue) BoundSyncImpl
                                                                                                                                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                                                                                                                                      	// RecordOne captures a single synchronous metric event.
                                                                                                                                                                                                                                                                                                                                                      	RecordOne(ctx context.Context, number number.Number, labels []label.KeyValue)
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                        SyncImpl is the implementation-level interface to a generic synchronous instrument (e.g., ValueRecorder and Counter instruments).

                                                                                                                                                                                                                                                                                                                                                        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 registry provides a non-standalone implementation of MeterProvider that adds uniqueness checking for instrument descriptors on top of other MeterProvider it wraps.
                                                                                                                                                                                                                                                                                                                                                        Package registry provides a non-standalone implementation of MeterProvider that adds uniqueness checking for instrument descriptors on top of other MeterProvider it wraps.