mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-04 09:43:23 +02:00
d1aca7b167
* Split WithView from WithReader
* Accept readers and views params in newPipelines
* Update MeterProvider pipes init
* Fix WithView comment
* Fix view example MeterProvider option
* Fix With{View,Reader} option in prom exporter test
* Test Reader not required to be comparable
* Add changes to changelog
* Fix changelog option name
116 lines
4.0 KiB
Go
116 lines
4.0 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 metric // import "go.opentelemetry.io/otel/sdk/metric"
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/metric"
|
|
"go.opentelemetry.io/otel/sdk/instrumentation"
|
|
)
|
|
|
|
// MeterProvider handles the creation and coordination of Meters. All Meters
|
|
// created by a MeterProvider will be associated with the same Resource, have
|
|
// the same Views applied to them, and have their produced metric telemetry
|
|
// passed to the configured Readers.
|
|
type MeterProvider struct {
|
|
pipes pipelines
|
|
meters cache[instrumentation.Scope, *meter]
|
|
|
|
forceFlush, shutdown func(context.Context) error
|
|
}
|
|
|
|
// Compile-time check MeterProvider implements metric.MeterProvider.
|
|
var _ metric.MeterProvider = (*MeterProvider)(nil)
|
|
|
|
// NewMeterProvider returns a new and configured MeterProvider.
|
|
//
|
|
// By default, the returned MeterProvider is configured with the default
|
|
// Resource and no Readers. Readers cannot be added after a MeterProvider is
|
|
// created. This means the returned MeterProvider, one created with no
|
|
// Readers, will perform no operations.
|
|
func NewMeterProvider(options ...Option) *MeterProvider {
|
|
conf := newConfig(options)
|
|
flush, sdown := conf.readerSignals()
|
|
return &MeterProvider{
|
|
pipes: newPipelines(conf.res, conf.readers, conf.views),
|
|
forceFlush: flush,
|
|
shutdown: sdown,
|
|
}
|
|
}
|
|
|
|
// Meter returns a Meter with the given name and configured with options.
|
|
//
|
|
// The name should be the name of the instrumentation scope creating
|
|
// telemetry. This name may be the same as the instrumented code only if that
|
|
// code provides built-in instrumentation.
|
|
//
|
|
// If name is empty, the default (go.opentelemetry.io/otel/sdk/meter) will be
|
|
// used.
|
|
//
|
|
// Calls to the Meter method after Shutdown has been called will return Meters
|
|
// that perform no operations.
|
|
//
|
|
// This method is safe to call concurrently.
|
|
func (mp *MeterProvider) Meter(name string, options ...metric.MeterOption) metric.Meter {
|
|
c := metric.NewMeterConfig(options...)
|
|
s := instrumentation.Scope{
|
|
Name: name,
|
|
Version: c.InstrumentationVersion(),
|
|
SchemaURL: c.SchemaURL(),
|
|
}
|
|
return mp.meters.Lookup(s, func() *meter {
|
|
return newMeter(s, mp.pipes)
|
|
})
|
|
}
|
|
|
|
// ForceFlush flushes all pending telemetry.
|
|
//
|
|
// This method honors the deadline or cancellation of ctx. An appropriate
|
|
// error will be returned in these situations. There is no guaranteed that all
|
|
// telemetry be flushed or all resources have been released in these
|
|
// situations.
|
|
//
|
|
// This method is safe to call concurrently.
|
|
func (mp *MeterProvider) ForceFlush(ctx context.Context) error {
|
|
if mp.forceFlush != nil {
|
|
return mp.forceFlush(ctx)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// Shutdown shuts down the MeterProvider flushing all pending telemetry and
|
|
// releasing any held computational resources.
|
|
//
|
|
// This call is idempotent. The first call will perform all flush and
|
|
// releasing operations. Subsequent calls will perform no action and will
|
|
// return an error stating this.
|
|
//
|
|
// Measurements made by instruments from meters this MeterProvider created
|
|
// will not be exported after Shutdown is called.
|
|
//
|
|
// This method honors the deadline or cancellation of ctx. An appropriate
|
|
// error will be returned in these situations. There is no guaranteed that all
|
|
// telemetry be flushed or all resources have been released in these
|
|
// situations.
|
|
//
|
|
// This method is safe to call concurrently.
|
|
func (mp *MeterProvider) Shutdown(ctx context.Context) error {
|
|
if mp.shutdown != nil {
|
|
return mp.shutdown(ctx)
|
|
}
|
|
return nil
|
|
}
|