mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-02-09 13:37:12 +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>
81 lines
2.6 KiB
Go
81 lines
2.6 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.
|
|
|
|
//go:generate stringer -type=InstrumentKind
|
|
|
|
package sdkapi // import "go.opentelemetry.io/otel/sdk/metric/sdkapi"
|
|
|
|
// InstrumentKind describes the kind of instrument.
|
|
type InstrumentKind int8
|
|
|
|
const (
|
|
// HistogramInstrumentKind indicates a Histogram instrument.
|
|
HistogramInstrumentKind InstrumentKind = iota
|
|
// GaugeObserverInstrumentKind indicates an GaugeObserver instrument.
|
|
GaugeObserverInstrumentKind
|
|
|
|
// CounterInstrumentKind indicates a Counter instrument.
|
|
CounterInstrumentKind
|
|
// UpDownCounterInstrumentKind indicates a UpDownCounter instrument.
|
|
UpDownCounterInstrumentKind
|
|
|
|
// CounterObserverInstrumentKind indicates a CounterObserver instrument.
|
|
CounterObserverInstrumentKind
|
|
// UpDownCounterObserverInstrumentKind indicates a UpDownCounterObserver
|
|
// instrument.
|
|
UpDownCounterObserverInstrumentKind
|
|
)
|
|
|
|
// Synchronous returns whether this is a synchronous kind of instrument.
|
|
func (k InstrumentKind) Synchronous() bool {
|
|
switch k {
|
|
case CounterInstrumentKind, UpDownCounterInstrumentKind, HistogramInstrumentKind:
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Asynchronous returns whether this is an asynchronous kind of instrument.
|
|
func (k InstrumentKind) Asynchronous() bool {
|
|
return !k.Synchronous()
|
|
}
|
|
|
|
// Adding returns whether this kind of instrument adds its inputs (as opposed to Grouping).
|
|
func (k InstrumentKind) Adding() bool {
|
|
switch k {
|
|
case CounterInstrumentKind, UpDownCounterInstrumentKind, CounterObserverInstrumentKind, UpDownCounterObserverInstrumentKind:
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
// Grouping returns whether this kind of instrument groups its inputs (as opposed to Adding).
|
|
func (k InstrumentKind) Grouping() bool {
|
|
return !k.Adding()
|
|
}
|
|
|
|
// Monotonic returns whether this kind of instrument exposes a non-decreasing sum.
|
|
func (k InstrumentKind) Monotonic() bool {
|
|
switch k {
|
|
case CounterInstrumentKind, CounterObserverInstrumentKind:
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
// PrecomputedSum returns whether this kind of instrument receives precomputed sums.
|
|
func (k InstrumentKind) PrecomputedSum() bool {
|
|
return k.Adding() && k.Asynchronous()
|
|
}
|