mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-12 10:04:29 +02:00
18f4cb85ec
* Empty All of the metrics dir * Add instrument api with documentation * Add a NoOp implementation. * Updated to the new config standard * Address PR comments * This change moves components to sdk/metrics The Moved components are: - metric/metrictest - metric/number - metric/internal/registry - metric/sdkapi * The SDK changes necessary to satasify the new api * This fixes the remaing tests. * Update changelog * refactor the Noop meter and instruments into one package. * Renamed pkg.Instruments to pkg.InstrumentProvider Co-authored-by: Aaron Clawson <MadVikingGod@users.noreply.github.com>
61 lines
2.5 KiB
Go
61 lines
2.5 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/metric"
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/metric/instrument"
|
|
"go.opentelemetry.io/otel/metric/instrument/asyncfloat64"
|
|
"go.opentelemetry.io/otel/metric/instrument/asyncint64"
|
|
"go.opentelemetry.io/otel/metric/instrument/syncfloat64"
|
|
"go.opentelemetry.io/otel/metric/instrument/syncint64"
|
|
)
|
|
|
|
// MeterProvider provides access to named Meter instances, for instrumenting
|
|
// an application or library.
|
|
type MeterProvider interface {
|
|
// Meter creates an instance of a `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
|
|
}
|
|
|
|
// Meter provides access to instrument instances for recording metrics.
|
|
type Meter interface {
|
|
// AsyncInt64 is the namespace for the Asynchronous Integer instruments.
|
|
//
|
|
// To Observe data with instruments it must be registered in a callback.
|
|
AsyncInt64() asyncint64.InstrumentProvider
|
|
|
|
// AsyncFloat64 is the namespace for the Asynchronous Float instruments
|
|
//
|
|
// To Observe data with instruments it must be registered in a callback.
|
|
AsyncFloat64() asyncfloat64.InstrumentProvider
|
|
|
|
// RegisterCallback captures the function that will be called during Collect.
|
|
//
|
|
// It is only valid to call Observe within the scope of the passed function,
|
|
// and only on the instruments that were registered with this call.
|
|
RegisterCallback(insts []instrument.Asynchronous, function func(context.Context)) error
|
|
|
|
// SyncInt64 is the namespace for the Synchronous Integer instruments
|
|
SyncInt64() syncint64.InstrumentProvider
|
|
// SyncFloat64 is the namespace for the Synchronous Float instruments
|
|
SyncFloat64() syncfloat64.InstrumentProvider
|
|
}
|