mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-02-09 13:37:12 +02:00
1f9cc3036b
* Split metric inst config Instead of having the same configuration for both the Synchronous and Asynchronous instruments, use specific options for both. * Use Async/Sync opt for appropriate inst * Update noop inst providers * Update internal global impl * Update sdk * Remove unused method for callbackOption * Test instrument configuration * Lint imports * Add changes to changelog * Refactor callbacks and further split opts Define callbacks to return the value observed. Because of the different types returned for different observables, the callbacks and options are move to the sync/async packages. * Update noop impl * Fix example_test.go * Fix internal impl * Update Callbacks Return observations for distinct attr sets. * Refactor common code in sdk/metric inst provider * Update examples and prom exporter * Generalize callback * Update changelog * Add unit tests for callback * Add meter tests for cbacks on creation * Rename Observations to Measurements * Update Callback to accept an Observer * Update SDK impl * Move conf to instrument pkg * Apply suggestions from code review
103 lines
3.3 KiB
Go
103 lines
3.3 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package instrument // import "go.opentelemetry.io/otel/metric/instrument"
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/metric/unit"
|
|
)
|
|
|
|
// Int64Observer is a recorder of int64 measurement values.
|
|
//
|
|
// Warning: methods may be added to this interface in minor releases.
|
|
type Int64Observer interface {
|
|
Asynchronous
|
|
|
|
// Observe records the measurement value for a set of attributes.
|
|
//
|
|
// It is only valid to call this within a callback. If called outside of
|
|
// the registered callback it should have no effect on the instrument, and
|
|
// an error will be reported via the error handler.
|
|
Observe(ctx context.Context, value int64, attributes ...attribute.KeyValue)
|
|
}
|
|
|
|
// Int64Callback is a function registered with a Meter that makes
|
|
// observations for an Int64Observer it is registered with.
|
|
//
|
|
// 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
|
|
// Int64Callback. 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 Int64Callback func(context.Context, Int64Observer) error
|
|
|
|
// Int64ObserverConfig contains options for Asynchronous instruments that
|
|
// observe int64 values.
|
|
type Int64ObserverConfig struct {
|
|
description string
|
|
unit unit.Unit
|
|
callbacks []Int64Callback
|
|
}
|
|
|
|
// NewInt64ObserverConfig returns a new Int64ObserverConfig with all opts
|
|
// applied.
|
|
func NewInt64ObserverConfig(opts ...Int64ObserverOption) Int64ObserverConfig {
|
|
var config Int64ObserverConfig
|
|
for _, o := range opts {
|
|
config = o.applyInt64Observer(config)
|
|
}
|
|
return config
|
|
}
|
|
|
|
// Description returns the Config description.
|
|
func (c Int64ObserverConfig) Description() string {
|
|
return c.description
|
|
}
|
|
|
|
// Unit returns the Config unit.
|
|
func (c Int64ObserverConfig) Unit() unit.Unit {
|
|
return c.unit
|
|
}
|
|
|
|
// Callbacks returns the Config callbacks.
|
|
func (c Int64ObserverConfig) Callbacks() []Int64Callback {
|
|
return c.callbacks
|
|
}
|
|
|
|
// Int64ObserverOption applies options to int64 Observer instruments.
|
|
type Int64ObserverOption interface {
|
|
applyInt64Observer(Int64ObserverConfig) Int64ObserverConfig
|
|
}
|
|
|
|
type int64ObserverOptionFunc func(Int64ObserverConfig) Int64ObserverConfig
|
|
|
|
func (fn int64ObserverOptionFunc) applyInt64Observer(cfg Int64ObserverConfig) Int64ObserverConfig {
|
|
return fn(cfg)
|
|
}
|
|
|
|
// WithInt64Callback adds callback to be called for an instrument.
|
|
func WithInt64Callback(callback Int64Callback) Int64ObserverOption {
|
|
return int64ObserverOptionFunc(func(cfg Int64ObserverConfig) Int64ObserverConfig {
|
|
cfg.callbacks = append(cfg.callbacks, callback)
|
|
return cfg
|
|
})
|
|
}
|