metric – go.opentelemetry.io/otel/metric Index | Examples | Files | Directories

package metric

import "go.opentelemetry.io/otel/metric"

Package metric provides the OpenTelemetry API used to measure metrics about source code operation.

This API is separate from its implementation so the instrumentation built from it is reusable. See go.opentelemetry.io/otel/sdk/metric for the official OpenTelemetry implementation of this API.

All measurements made with this package are made via instruments. These instruments are created by a Meter which itself is created by a MeterProvider. Applications need to accept a MeterProvider implementation as a starting point when instrumenting. This can be done directly, or by using the OpenTelemetry global MeterProvider via GetMeterProvider. Using an appropriately named Meter from the accepted MeterProvider, instrumentation can then be built from the Meter's instruments.

Instruments

Each instrument is designed to make measurements of a particular type. Broadly, all instruments fall into two overlapping logical categories: asynchronous or synchronous, and int64 or float64.

All synchronous instruments (Int64Counter, Int64UpDownCounter, Int64Histogram, Float64Counter, Float64UpDownCounter, Float64Histogram) are used to measure the operation and performance of source code during the source code execution. These instruments only make measurements when the source code they instrument is run.

All asynchronous instruments (Int64ObservableCounter, Int64ObservableUpDownCounter, Int64ObservableGauge, Float64ObservableCounter, Float64ObservableUpDownCounter, Float64ObservableGauge) are used to measure metrics outside of the execution of source code. They are said to make "observations" via a callback function called once every measurement collection cycle.

Each instrument is also grouped by the value type it measures. Either int64 or float64. The value being measured will dictate which instrument in these categories to use.

Outside of these two broad categories, instruments are described by the function they are designed to serve. All Counters (Int64Counter, Float64Counter, Int64ObservableCounter, Float64ObservableCounter) are designed to measure values that never decrease in value, but instead only incrementally increase in value. UpDownCounters (Int64UpDownCounter, Float64UpDownCounter, Int64ObservableUpDownCounter, Float64ObservableUpDownCounter) on the other hand, are designed to measure values that can increase and decrease. When more information needs to be conveyed about all the synchronous measurements made during a collection cycle, a Histogram (Int64Histogram, Float64Histogram) should be used. Finally, when just the most recent measurement needs to be conveyed about an asynchronous measurement, a Gauge (Int64ObservableGauge, Float64ObservableGauge) should be used.

See the OpenTelemetry documentation for more information about instruments and their intended use.

API Implementations

This package does not conform to the standard Go versioning policy, all of its interfaces may have methods added to them without a package major version bump. This non-standard API evolution could surprise an uninformed implementation author. They could unknowingly build their implementation in a way that would result in a runtime panic for their users that update to the new API.

The API is designed to help inform an instrumentation author about this non-standard API evolution. It requires them to choose a default behavior for unimplemented interface methods. There are three behavior choices they can make:

All interfaces in this API embed a corresponding interface from go.opentelemetry.io/otel/metric/embedded. If an author wants the default behavior of their implementations to be a compilation failure, signaling to their users they need to update to the latest version of that implementation, they need to embed the corresponding interface from go.opentelemetry.io/otel/metric/embedded in their implementation. For example, 

import "go.opentelemetry.io/otel/metric/embedded"

type MeterProvider struct {
	embedded.MeterProvider
	// ...
}

If an author wants the default behavior of their implementations to a panic, they need to embed the API interface directly. 

import "go.opentelemetry.io/otel/metric"

type MeterProvider struct {
	metric.MeterProvider
	// ...
}

This is not a recommended behavior as it could lead to publishing packages that contain runtime panics when users update other package that use newer versions of go.opentelemetry.io/otel/metric.

Finally, an author can embed another implementation in theirs. The embedded implementation will be used for methods not defined by the author. For example, an author who want to default to silently dropping the call can use go.opentelemetry.io/otel/metric/noop: 

import "go.opentelemetry.io/otel/metric/noop"

type MeterProvider struct {
	noop.MeterProvider
	// ...
}

It is strongly recommended that authors only embed go.opentelemetry.io/otel/metric/noop if they choose this default behavior. That implementation is the only one OpenTelemetry authors can guarantee will fully implement all the API interfaces when a user updates their API.

Index

Examples

Types

type AddConfig 

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

AddConfig contains options for an addition measurement.

func NewAddConfig 

func NewAddConfig(opts []AddOption) AddConfig

NewAddConfig returns a new AddConfig with all opts applied.

func (AddConfig) Attributes 

func (c AddConfig) Attributes() attribute.Set

Attributes returns the configured attribute set.

type AddOption 

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

AddOption applies options to an addition measurement. See MeasurementOption for other options that can be used as a AddOption.

type Callback 

type Callback func(context.Context, Observer) error

Callback is a function registered with a Meter that makes observations for the set of instruments it is registered with. The Observer parameter is used to record measurement observations for these instruments.

The function needs to complete in a finite amount of time and the deadline of the passed context is expected to be honored.

The function needs to make unique observations across all registered Callbacks. Meaning, it should not report measurements for an instrument with the same attributes as another Callback will report.

The function needs to be concurrent safe.

type Float64Callback 

type Float64Callback func(context.Context, Float64Observer) error

Float64Callback is a function registered with a Meter that makes observations for a Float64Observerable instrument it is registered with. Calls to the Float64Observer record measurement values for the Float64Observable.

The function needs to complete in a finite amount of time and the deadline of the passed context is expected to be honored.

The function needs to make unique observations across all registered Float64Callbacks. Meaning, it should not report measurements with the same attributes as another Float64Callbacks also registered for the same instrument.

The function needs to be concurrent safe.

type Float64Counter 

type Float64Counter interface {
	embedded.Float64Counter

	// Add records a change to the counter.
	Add(ctx context.Context, incr float64, opts ...AddOption)
}

Float64Counter is an instrument that records increasing float64 values.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Float64CounterConfig 

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

Float64CounterConfig contains options for synchronous counter instruments that record int64 values.

func NewFloat64CounterConfig 

func NewFloat64CounterConfig(opts ...Float64CounterOption) Float64CounterConfig

NewFloat64CounterConfig returns a new Float64CounterConfig with all opts applied.

func (Float64CounterConfig) Description 

func (c Float64CounterConfig) Description() string

Description returns the configured description.

func (Float64CounterConfig) Unit 

func (c Float64CounterConfig) Unit() string

Unit returns the configured unit.

type Float64CounterOption 

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

Float64CounterOption applies options to a Float64CounterConfig. See [Option] for other options that can be used as a Float64CounterOption.

type Float64Histogram 

type Float64Histogram interface {
	embedded.Float64Histogram

	// Record adds an additional value to the distribution.
	Record(ctx context.Context, incr float64, opts ...RecordOption)
}

Float64Histogram is an instrument that records a distribution of float64 values.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Float64HistogramConfig 

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

Float64HistogramConfig contains options for synchronous counter instruments that record int64 values.

func NewFloat64HistogramConfig 

func NewFloat64HistogramConfig(opts ...Float64HistogramOption) Float64HistogramConfig

NewFloat64HistogramConfig returns a new Float64HistogramConfig with all opts applied.

func (Float64HistogramConfig) Description 

func (c Float64HistogramConfig) Description() string

Description returns the configured description.

func (Float64HistogramConfig) Unit 

func (c Float64HistogramConfig) Unit() string

Unit returns the configured unit.

type Float64HistogramOption 

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

Float64HistogramOption applies options to a Float64HistogramConfig. See [Option] for other options that can be used as a Float64HistogramOption.

type Float64Observable 

type Float64Observable interface {
	Observable
	// contains filtered or unexported methods
}

Float64Observable describes a set of instruments used asynchronously to record float64 measurements once per collection cycle. Observations of these instruments are only made within a callback.

Warning: Methods may be added to this interface in minor releases.

type Float64ObservableCounter 

type Float64ObservableCounter interface {
	embedded.Float64ObservableCounter

	Float64Observable
}

Float64ObservableCounter is an instrument used to asynchronously record increasing float64 measurements once per collection cycle. Observations are only made within a callback for this instrument. The value observed is assumed the to be the cumulative sum of the count.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Float64ObservableCounterConfig 

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

Float64ObservableCounterConfig contains options for asynchronous counter instruments that record int64 values.

func NewFloat64ObservableCounterConfig 

func NewFloat64ObservableCounterConfig(opts ...Float64ObservableCounterOption) Float64ObservableCounterConfig

NewFloat64ObservableCounterConfig returns a new Float64ObservableCounterConfig with all opts applied.

func (Float64ObservableCounterConfig) Callbacks 

func (c Float64ObservableCounterConfig) Callbacks() []Float64Callback

Callbacks returns the configured callbacks.

func (Float64ObservableCounterConfig) Description 

func (c Float64ObservableCounterConfig) Description() string

Description returns the configured description.

func (Float64ObservableCounterConfig) Unit 

func (c Float64ObservableCounterConfig) Unit() string

Unit returns the configured unit.

type Float64ObservableCounterOption 

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

Float64ObservableCounterOption applies options to a Float64ObservableCounterConfig. See Float64ObservableOption and [Option] for other options that can be used as a Float64ObservableCounterOption.

type Float64ObservableGauge 

type Float64ObservableGauge interface {
	embedded.Float64ObservableGauge

	Float64Observable
}

Float64ObservableGauge is an instrument used to asynchronously record instantaneous float64 measurements once per collection cycle. Observations are only made within a callback for this instrument.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Float64ObservableGaugeConfig 

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

Float64ObservableGaugeConfig contains options for asynchronous counter instruments that record int64 values.

func NewFloat64ObservableGaugeConfig 

func NewFloat64ObservableGaugeConfig(opts ...Float64ObservableGaugeOption) Float64ObservableGaugeConfig

NewFloat64ObservableGaugeConfig returns a new Float64ObservableGaugeConfig with all opts applied.

func (Float64ObservableGaugeConfig) Callbacks 

func (c Float64ObservableGaugeConfig) Callbacks() []Float64Callback

Callbacks returns the configured callbacks.

func (Float64ObservableGaugeConfig) Description 

func (c Float64ObservableGaugeConfig) Description() string

Description returns the configured description.

func (Float64ObservableGaugeConfig) Unit 

func (c Float64ObservableGaugeConfig) Unit() string

Unit returns the configured unit.

type Float64ObservableGaugeOption 

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

Float64ObservableGaugeOption applies options to a Float64ObservableGaugeConfig. See Float64ObservableOption and [Option] for other options that can be used as a Float64ObservableGaugeOption.

type Float64ObservableOption 

type Float64ObservableOption interface {
	Float64ObservableCounterOption
	Float64ObservableUpDownCounterOption
	Float64ObservableGaugeOption
}

Float64ObservableOption applies options to float64 Observer instruments.

func WithFloat64Callback 

func WithFloat64Callback(callback Float64Callback) Float64ObservableOption

WithFloat64Callback adds callback to be called for an instrument.

type Float64ObservableUpDownCounter 

type Float64ObservableUpDownCounter interface {
	embedded.Float64ObservableUpDownCounter

	Float64Observable
}

Float64ObservableUpDownCounter is an instrument used to asynchronously record float64 measurements once per collection cycle. Observations are only made within a callback for this instrument. The value observed is assumed the to be the cumulative sum of the count.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Float64ObservableUpDownCounterConfig 

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

Float64ObservableUpDownCounterConfig contains options for asynchronous counter instruments that record int64 values.

func NewFloat64ObservableUpDownCounterConfig 

func NewFloat64ObservableUpDownCounterConfig(opts ...Float64ObservableUpDownCounterOption) Float64ObservableUpDownCounterConfig

NewFloat64ObservableUpDownCounterConfig returns a new Float64ObservableUpDownCounterConfig with all opts applied.

func (Float64ObservableUpDownCounterConfig) Callbacks 

func (c Float64ObservableUpDownCounterConfig) Callbacks() []Float64Callback

Callbacks returns the configured callbacks.

func (Float64ObservableUpDownCounterConfig) Description 

func (c Float64ObservableUpDownCounterConfig) Description() string

Description returns the configured description.

func (Float64ObservableUpDownCounterConfig) Unit 

func (c Float64ObservableUpDownCounterConfig) Unit() string

Unit returns the configured unit.

type Float64ObservableUpDownCounterOption 

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

Float64ObservableUpDownCounterOption applies options to a Float64ObservableUpDownCounterConfig. See Float64ObservableOption and [Option] for other options that can be used as a Float64ObservableUpDownCounterOption.

type Float64Observer 

type Float64Observer interface {
	embedded.Float64Observer

	// Observe records the float64 value.
	Observe(value float64, opts ...ObserveOption)
}

Float64Observer is a recorder of float64 measurements.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Float64UpDownCounter 

type Float64UpDownCounter interface {
	embedded.Float64UpDownCounter

	// Add records a change to the counter.
	Add(ctx context.Context, incr float64, opts ...AddOption)
}

Float64UpDownCounter is an instrument that records increasing or decreasing float64 values.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Float64UpDownCounterConfig 

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

Float64UpDownCounterConfig contains options for synchronous counter instruments that record int64 values.

func NewFloat64UpDownCounterConfig 

func NewFloat64UpDownCounterConfig(opts ...Float64UpDownCounterOption) Float64UpDownCounterConfig

NewFloat64UpDownCounterConfig returns a new Float64UpDownCounterConfig with all opts applied.

func (Float64UpDownCounterConfig) Description 

func (c Float64UpDownCounterConfig) Description() string

Description returns the configured description.

func (Float64UpDownCounterConfig) Unit 

func (c Float64UpDownCounterConfig) Unit() string

Unit returns the configured unit.

type Float64UpDownCounterOption 

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

Float64UpDownCounterOption applies options to a Float64UpDownCounterConfig. See [Option] for other options that can be used as a Float64UpDownCounterOption.

type InstrumentOption 

type InstrumentOption interface {
	Int64CounterOption
	Int64UpDownCounterOption
	Int64HistogramOption
	Int64ObservableCounterOption
	Int64ObservableUpDownCounterOption
	Int64ObservableGaugeOption

	Float64CounterOption
	Float64UpDownCounterOption
	Float64HistogramOption
	Float64ObservableCounterOption
	Float64ObservableUpDownCounterOption
	Float64ObservableGaugeOption
}

InstrumentOption applies options to all instruments.

func WithDescription 

func WithDescription(desc string) InstrumentOption

WithDescription sets the instrument description.

func WithUnit 

func WithUnit(u string) InstrumentOption

WithUnit sets the instrument unit.

type Int64Callback 

type Int64Callback func(context.Context, Int64Observer) error

Int64Callback is a function registered with a Meter that makes observations for an Int64Observerable instrument it is registered with. Calls to the Int64Observer record measurement values for the Int64Observable.

The function needs to complete in a finite amount of time and the deadline of the passed context is expected to be honored.

The function needs to make unique observations across all registered Int64Callbacks. Meaning, it should not report measurements with the same attributes as another Int64Callbacks also registered for the same instrument.

The function needs to be concurrent safe.

type Int64Counter 

type Int64Counter interface {
	embedded.Int64Counter

	// Add records a change to the counter.
	Add(ctx context.Context, incr int64, opts ...AddOption)
}

Int64Counter is an instrument that records increasing int64 values.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Int64CounterConfig 

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

Int64CounterConfig contains options for synchronous counter instruments that record int64 values.

func NewInt64CounterConfig 

func NewInt64CounterConfig(opts ...Int64CounterOption) Int64CounterConfig

NewInt64CounterConfig returns a new Int64CounterConfig with all opts applied.

func (Int64CounterConfig) Description 

func (c Int64CounterConfig) Description() string

Description returns the configured description.

func (Int64CounterConfig) Unit 

func (c Int64CounterConfig) Unit() string

Unit returns the configured unit.

type Int64CounterOption 

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

Int64CounterOption applies options to a Int64CounterConfig. See [Option] for other options that can be used as an Int64CounterOption.

type Int64Histogram 

type Int64Histogram interface {
	embedded.Int64Histogram

	// Record adds an additional value to the distribution.
	Record(ctx context.Context, incr int64, opts ...RecordOption)
}

Int64Histogram is an instrument that records a distribution of int64 values.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Int64HistogramConfig 

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

Int64HistogramConfig contains options for synchronous counter instruments that record int64 values.

func NewInt64HistogramConfig 

func NewInt64HistogramConfig(opts ...Int64HistogramOption) Int64HistogramConfig

NewInt64HistogramConfig returns a new Int64HistogramConfig with all opts applied.

func (Int64HistogramConfig) Description 

func (c Int64HistogramConfig) Description() string

Description returns the configured description.

func (Int64HistogramConfig) Unit 

func (c Int64HistogramConfig) Unit() string

Unit returns the configured unit.

type Int64HistogramOption 

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

Int64HistogramOption applies options to a Int64HistogramConfig. See [Option] for other options that can be used as an Int64HistogramOption.

type Int64Observable 

type Int64Observable interface {
	Observable
	// contains filtered or unexported methods
}

Int64Observable describes a set of instruments used asynchronously to record int64 measurements once per collection cycle. Observations of these instruments are only made within a callback.

Warning: Methods may be added to this interface in minor releases.

type Int64ObservableCounter 

type Int64ObservableCounter interface {
	embedded.Int64ObservableCounter

	Int64Observable
}

Int64ObservableCounter is an instrument used to asynchronously record increasing int64 measurements once per collection cycle. Observations are only made within a callback for this instrument. The value observed is assumed the to be the cumulative sum of the count.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Int64ObservableCounterConfig 

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

Int64ObservableCounterConfig contains options for asynchronous counter instruments that record int64 values.

func NewInt64ObservableCounterConfig 

func NewInt64ObservableCounterConfig(opts ...Int64ObservableCounterOption) Int64ObservableCounterConfig

NewInt64ObservableCounterConfig returns a new Int64ObservableCounterConfig with all opts applied.

func (Int64ObservableCounterConfig) Callbacks 

func (c Int64ObservableCounterConfig) Callbacks() []Int64Callback

Callbacks returns the configured callbacks.

func (Int64ObservableCounterConfig) Description 

func (c Int64ObservableCounterConfig) Description() string

Description returns the configured description.

func (Int64ObservableCounterConfig) Unit 

func (c Int64ObservableCounterConfig) Unit() string

Unit returns the configured unit.

type Int64ObservableCounterOption 

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

Int64ObservableCounterOption applies options to a Int64ObservableCounterConfig. See Int64ObservableOption and [Option] for other options that can be used as an Int64ObservableCounterOption.

type Int64ObservableGauge 

type Int64ObservableGauge interface {
	embedded.Int64ObservableGauge

	Int64Observable
}

Int64ObservableGauge is an instrument used to asynchronously record instantaneous int64 measurements once per collection cycle. Observations are only made within a callback for this instrument.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Int64ObservableGaugeConfig 

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

Int64ObservableGaugeConfig contains options for asynchronous counter instruments that record int64 values.

func NewInt64ObservableGaugeConfig 

func NewInt64ObservableGaugeConfig(opts ...Int64ObservableGaugeOption) Int64ObservableGaugeConfig

NewInt64ObservableGaugeConfig returns a new Int64ObservableGaugeConfig with all opts applied.

func (Int64ObservableGaugeConfig) Callbacks 

func (c Int64ObservableGaugeConfig) Callbacks() []Int64Callback

Callbacks returns the configured callbacks.

func (Int64ObservableGaugeConfig) Description 

func (c Int64ObservableGaugeConfig) Description() string

Description returns the configured description.

func (Int64ObservableGaugeConfig) Unit 

func (c Int64ObservableGaugeConfig) Unit() string

Unit returns the configured unit.

type Int64ObservableGaugeOption 

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

Int64ObservableGaugeOption applies options to a Int64ObservableGaugeConfig. See Int64ObservableOption and [Option] for other options that can be used as an Int64ObservableGaugeOption.

type Int64ObservableOption 

type Int64ObservableOption interface {
	Int64ObservableCounterOption
	Int64ObservableUpDownCounterOption
	Int64ObservableGaugeOption
}

Int64ObservableOption applies options to int64 Observer instruments.

func WithInt64Callback 

func WithInt64Callback(callback Int64Callback) Int64ObservableOption

WithInt64Callback adds callback to be called for an instrument.

type Int64ObservableUpDownCounter 

type Int64ObservableUpDownCounter interface {
	embedded.Int64ObservableUpDownCounter

	Int64Observable
}

Int64ObservableUpDownCounter is an instrument used to asynchronously record int64 measurements once per collection cycle. Observations are only made within a callback for this instrument. The value observed is assumed the to be the cumulative sum of the count.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Int64ObservableUpDownCounterConfig 

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

Int64ObservableUpDownCounterConfig contains options for asynchronous counter instruments that record int64 values.

func NewInt64ObservableUpDownCounterConfig 

func NewInt64ObservableUpDownCounterConfig(opts ...Int64ObservableUpDownCounterOption) Int64ObservableUpDownCounterConfig

NewInt64ObservableUpDownCounterConfig returns a new Int64ObservableUpDownCounterConfig with all opts applied.

func (Int64ObservableUpDownCounterConfig) Callbacks 

func (c Int64ObservableUpDownCounterConfig) Callbacks() []Int64Callback

Callbacks returns the configured callbacks.

func (Int64ObservableUpDownCounterConfig) Description 

func (c Int64ObservableUpDownCounterConfig) Description() string

Description returns the configured description.

func (Int64ObservableUpDownCounterConfig) Unit 

func (c Int64ObservableUpDownCounterConfig) Unit() string

Unit returns the configured unit.

type Int64ObservableUpDownCounterOption 

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

Int64ObservableUpDownCounterOption applies options to a Int64ObservableUpDownCounterConfig. See Int64ObservableOption and [Option] for other options that can be used as an Int64ObservableUpDownCounterOption.

type Int64Observer 

type Int64Observer interface {
	embedded.Int64Observer

	// Observe records the int64 value.
	Observe(value int64, opts ...ObserveOption)
}

Int64Observer is a recorder of int64 measurements.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Int64UpDownCounter 

type Int64UpDownCounter interface {
	embedded.Int64UpDownCounter

	// Add records a change to the counter.
	Add(ctx context.Context, incr int64, opts ...AddOption)
}

Int64UpDownCounter is an instrument that records increasing or decreasing int64 values.

Warning: Methods may be added to this interface in minor releases. See go.opentelemetry.io/otel/metric package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Int64UpDownCounterConfig 

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

Int64UpDownCounterConfig contains options for synchronous counter instruments that record int64 values.

func NewInt64UpDownCounterConfig 

func NewInt64UpDownCounterConfig(opts ...Int64UpDownCounterOption) Int64UpDownCounterConfig

NewInt64UpDownCounterConfig returns a new Int64UpDownCounterConfig with all opts applied.

func (Int64UpDownCounterConfig) Description 

func (c Int64UpDownCounterConfig) Description() string

Description returns the configured description.

func (Int64UpDownCounterConfig) Unit 

func (c Int64UpDownCounterConfig) Unit() string

Unit returns the configured unit.

type Int64UpDownCounterOption 

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

Int64UpDownCounterOption applies options to a Int64UpDownCounterConfig. See [Option] for other options that can be used as an Int64UpDownCounterOption.

type MeasurementOption 

type MeasurementOption interface {
	AddOption
	RecordOption
	ObserveOption
}

MeasurementOption applies options to all instrument measurement.

func WithAttributeSet 

func WithAttributeSet(attributes attribute.Set) MeasurementOption

WithAttributeSet sets the attribute Set associated with a measurement is made with.

If multiple WithAttributeSet or WithAttributes options are passed the attributes will be merged together in the order they are passed. Attributes with duplicate keys will use the last value passed.

func WithAttributes 

func WithAttributes(attributes ...attribute.KeyValue) MeasurementOption

WithAttributes converts attributes into an attribute Set and sets the Set to be associated with a measurement. This is shorthand for: 

cp := make([]attribute.KeyValue, len(attributes))
copy(cp, attributes)
WithAttributes(attribute.NewSet(cp...))

attribute.NewSet may modify the passed attributes so this will make a copy of attributes before creating a set in order to ensure this function is concurrent safe. This makes this option function less optimized in comparison to WithAttributeSet. Therefore, WithAttributeSet should be preferred for performance sensitive code.

See WithAttributeSet for information about how multiple WithAttributes are merged.

type Meter 

type Meter interface {
	embedded.Meter

	// Int64Counter returns a new instrument identified by name and configured
	// with options. The instrument is used to synchronously record increasing
	// int64 measurements during a computational operation.
	Int64Counter(name string, options ...Int64CounterOption) (Int64Counter, error)
	// Int64UpDownCounter returns a new instrument identified by name and
	// configured with options. The instrument is used to synchronously record
	// int64 measurements during a computational operation.
	Int64UpDownCounter(name string, options ...Int64UpDownCounterOption) (Int64UpDownCounter, error)
	// Int64Histogram returns a new instrument identified by name and
	// configured with options. The instrument is used to synchronously record
	// the distribution of int64 measurements during a computational operation.
	Int64Histogram(name string, options ...Int64HistogramOption) (Int64Histogram, error)
	// Int64ObservableCounter returns a new instrument identified by name and
	// configured with options. The instrument is used to asynchronously record
	// increasing int64 measurements once per a measurement collection cycle.
	Int64ObservableCounter(name string, options ...Int64ObservableCounterOption) (Int64ObservableCounter, error)
	// Int64ObservableUpDownCounter returns a new instrument identified by name
	// and configured with options. The instrument is used to asynchronously
	// record int64 measurements once per a measurement collection cycle.
	Int64ObservableUpDownCounter(name string, options ...Int64ObservableUpDownCounterOption) (Int64ObservableUpDownCounter, error)
	// Int64ObservableGauge returns a new instrument identified by name and
	// configured with options. The instrument is used to asynchronously record
	// instantaneous int64 measurements once per a measurement collection
	// cycle.
	Int64ObservableGauge(name string, options ...Int64ObservableGaugeOption) (Int64ObservableGauge, error)

	// Float64Counter returns a new instrument identified by name and
	// configured with options. The instrument is used to synchronously record
	// increasing float64 measurements during a computational operation.
	Float64Counter(name string, options ...Float64CounterOption) (Float64Counter, error)
	// Float64UpDownCounter returns a new instrument identified by name and
	// configured with options. The instrument is used to synchronously record
	// float64 measurements during a computational operation.
	Float64UpDownCounter(name string, options ...Float64UpDownCounterOption) (Float64UpDownCounter, error)
	// Float64Histogram returns a new instrument identified by name and
	// configured with options. The instrument is used to synchronously record
	// the distribution of float64 measurements during a computational
	// operation.
	Float64Histogram(name string, options ...Float64HistogramOption) (Float64Histogram, error)
	// Float64ObservableCounter returns a new instrument identified by name and
	// configured with options. The instrument is used to asynchronously record
	// increasing float64 measurements once per a measurement collection cycle.
	Float64ObservableCounter(name string, options ...Float64ObservableCounterOption) (Float64ObservableCounter, error)
	// Float64ObservableUpDownCounter returns a new instrument identified by
	// name and configured with options. The instrument is used to
	// asynchronously record float64 measurements once per a measurement
	// collection cycle.
	Float64ObservableUpDownCounter(name string, options ...Float64ObservableUpDownCounterOption) (Float64ObservableUpDownCounter, error)
	// Float64ObservableGauge returns a new instrument identified by name and
	// configured with options. The instrument is used to asynchronously record
	// instantaneous float64 measurements once per a measurement collection
	// cycle.
	Float64ObservableGauge(name string, options ...Float64ObservableGaugeOption) (Float64ObservableGauge, error)

	// RegisterCallback registers f to be called during the collection of a
	// measurement cycle.
	//
	// If Unregister of the returned Registration is called, f needs to be
	// unregistered and not called during collection.
	//
	// The instruments f is registered with are the only instruments that f may
	// observe values for.
	//
	// If no instruments are passed, f should not be registered nor called
	// during collection.
	RegisterCallback(f Callback, instruments ...Observable) (Registration, error)
}

Meter provides access to instrument instances for recording metrics.

Warning: Methods may be added to this interface in minor releases. See package documentation on API implementation for information on how to set default behavior for unimplemented methods.

Example (Asynchronous_multiple)

Code:play  

package main

import (
	"context"
	"fmt"
	"runtime"

	"go.opentelemetry.io/otel/metric"
	"go.opentelemetry.io/otel/metric/global"
)

func main() {
	meter := global.Meter("go.opentelemetry.io/otel/metric#MultiAsyncExample")

	// This is just a sample of memory stats to record from the Memstats
	heapAlloc, _ := meter.Int64ObservableUpDownCounter("heapAllocs")
	gcCount, _ := meter.Int64ObservableCounter("gcCount")

	_, err := meter.RegisterCallback(
		func(_ context.Context, o metric.Observer) error {
			memStats := &runtime.MemStats{}
			// This call does work
			runtime.ReadMemStats(memStats)

			o.ObserveInt64(heapAlloc, int64(memStats.HeapAlloc))
			o.ObserveInt64(gcCount, int64(memStats.NumGC))

			return nil
		},
		heapAlloc,
		gcCount,
	)
	if err != nil {
		fmt.Println("Failed to register callback")
		panic(err)
	}
}
Example (Asynchronous_single)

Code:play  

package main

import (
	"context"
	"fmt"

	"go.opentelemetry.io/otel/attribute"
	"go.opentelemetry.io/otel/metric"
	"go.opentelemetry.io/otel/metric/global"
)

func main() {
	meter := global.Meter("go.opentelemetry.io/otel/metric#AsyncExample")

	_, err := meter.Int64ObservableGauge(
		"DiskUsage",
		metric.WithUnit("By"),
		metric.WithInt64Callback(func(_ context.Context, obsrv metric.Int64Observer) error {
			// Do the real work here to get the real disk usage. For example,
			//
			//   usage, err := GetDiskUsage(diskID)
			//   if err != nil {
			//   	if retryable(err) {
			//   		// Retry the usage measurement.
			//   	} else {
			//   		return err
			//   	}
			//   }
			//
			// For demonstration purpose, a static value is used here.
			usage := 75000
			obsrv.Observe(int64(usage), metric.WithAttributes(attribute.Int("disk.id", 3)))
			return nil
		}),
	)
	if err != nil {
		fmt.Println("failed to register instrument")
		panic(err)
	}
}
Example (Synchronous)

Code:play  

package main

import (
	"context"
	"fmt"
	"time"

	"go.opentelemetry.io/otel/metric"
	"go.opentelemetry.io/otel/metric/global"
)

func main() {
	// Create a histogram using the global MeterProvider.
	workDuration, err := global.Meter("go.opentelemetry.io/otel/metric#SyncExample").Int64Histogram(
		"workDuration",
		metric.WithUnit("ms"))
	if err != nil {
		fmt.Println("Failed to register instrument")
		panic(err)
	}

	startTime := time.Now()
	ctx := context.Background()
	// Do work
	// ...
	workDuration.Record(ctx, time.Since(startTime).Milliseconds())
}

type MeterConfig 

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

MeterConfig contains options for Meters.

func NewMeterConfig 

func NewMeterConfig(opts ...MeterOption) MeterConfig

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

func (MeterConfig) InstrumentationAttributes 

func (cfg MeterConfig) InstrumentationAttributes() attribute.Set

InstrumentationAttributes returns the attributes associated with the library providing instrumentation.

func (MeterConfig) InstrumentationVersion 

func (cfg MeterConfig) InstrumentationVersion() string

InstrumentationVersion returns the version of the library providing instrumentation.

func (MeterConfig) SchemaURL 

func (cfg MeterConfig) SchemaURL() string

SchemaURL is the schema_url of the library providing instrumentation.

type MeterOption 

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

MeterOption is an interface for applying Meter options.

func WithInstrumentationAttributes 

func WithInstrumentationAttributes(attr ...attribute.KeyValue) MeterOption

WithInstrumentationAttributes sets the instrumentation attributes.

The passed attributes will be de-duplicated.

func WithInstrumentationVersion 

func WithInstrumentationVersion(version string) MeterOption

WithInstrumentationVersion sets the instrumentation version.

func WithSchemaURL 

func WithSchemaURL(schemaURL string) MeterOption

WithSchemaURL sets the schema URL.

type MeterProvider 

type MeterProvider interface {
	embedded.MeterProvider

	// Meter returns a new Meter with the provided name and configuration.
	//
	// A Meter should be scoped at most to a single package. The name needs to
	// be unique so it does not collide with other names used by
	// an application, nor other applications. To achieve this, the import path
	// of the instrumentation package is recommended to be used as name.
	//
	// If the name is empty, then an implementation defined default name will
	// be used instead.
	Meter(name string, opts ...MeterOption) Meter
}

MeterProvider provides access to named Meter instances, for instrumenting an application or package.

Warning: Methods may be added to this interface in minor releases. See package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type Observable 

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

Observable is used as a grouping mechanism for all instruments that are updated within a Callback.

type ObserveConfig 

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

ObserveConfig contains options for an observed measurement.

func NewObserveConfig 

func NewObserveConfig(opts []ObserveOption) ObserveConfig

NewObserveConfig returns a new ObserveConfig with all opts applied.

func (ObserveConfig) Attributes 

func (c ObserveConfig) Attributes() attribute.Set

Attributes returns the configured attribute set.

type ObserveOption 

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

ObserveOption applies options to an addition measurement. See MeasurementOption for other options that can be used as a ObserveOption.

type Observer 

type Observer interface {
	embedded.Observer

	// ObserveFloat64 records the float64 value for obsrv.
	ObserveFloat64(obsrv Float64Observable, value float64, opts ...ObserveOption)
	// ObserveInt64 records the int64 value for obsrv.
	ObserveInt64(obsrv Int64Observable, value int64, opts ...ObserveOption)
}

Observer records measurements for multiple instruments in a Callback.

Warning: Methods may be added to this interface in minor releases. See package documentation on API implementation for information on how to set default behavior for unimplemented methods.

type RecordConfig 

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

RecordConfig contains options for a recorded measurement.

func NewRecordConfig 

func NewRecordConfig(opts []RecordOption) RecordConfig

NewRecordConfig returns a new RecordConfig with all opts applied.

func (RecordConfig) Attributes 

func (c RecordConfig) Attributes() attribute.Set

Attributes returns the configured attribute set.

type RecordOption 

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

RecordOption applies options to an addition measurement. See MeasurementOption for other options that can be used as a RecordOption.

type Registration 

type Registration interface {
	embedded.Registration

	// Unregister removes the callback registration from a Meter.
	//
	// This method needs to be idempotent and concurrent safe.
	Unregister() error
}

Registration is an token representing the unique registration of a callback for a set of instruments with a Meter.

Warning: Methods may be added to this interface in minor releases. See package documentation on API implementation for information on how to set default behavior for unimplemented methods.

Source Files

asyncfloat64.go asyncint64.go config.go doc.go instrument.go meter.go syncfloat64.go syncint64.go

Directories

PathSynopsis
embeddedPackage embedded provides interfaces embedded within the [OpenTelemetry metric API].
global
instrumentPackage instrument provides the OpenTelemetry API instruments used to make measurements.
internal
noopPackage noop provides an implementation of the OpenTelemetry metric API that produces no telemetry and minimizes used computation resources.
Version
v0.38.0
Published
Apr 28, 2023
Platform
windows/amd64
Imports
3 packages
Last checked
now –

Tools for package owners.