opentelemetry-go/api/metric/kind.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=Kind

package metric

// Kind describes the kind of instrument.
type Kind int8

const (
	// ValueRecorderKind indicates a ValueRecorder instrument.
	ValueRecorderKind Kind = iota
	// ValueObserverKind indicates an ValueObserver instrument.
	ValueObserverKind

	// CounterKind indicates a Counter instrument.
	CounterKind
	// UpDownCounterKind indicates a UpDownCounter instrument.
	UpDownCounterKind

	// SumObserverKind indicates a SumObserver instrument.
	SumObserverKind
	// UpDownSumObserverKind indicates a UpDownSumObserver instrument.
	UpDownSumObserverKind
)

// Synchronous returns whether this is a synchronous kind of instrument.
func (k Kind) Synchronous() bool {
	switch k {
	case CounterKind, UpDownCounterKind, ValueRecorderKind:
		return true
	}
	return false
}

// Asynchronous returns whether this is an asynchronous kind of instrument.
func (k Kind) Asynchronous() bool {
	return !k.Synchronous()
}

// Adding returns whether this kind of instrument adds its inputs (as opposed to Grouping).
func (k Kind) Adding() bool {
	switch k {
	case CounterKind, UpDownCounterKind, SumObserverKind, UpDownSumObserverKind:
		return true
	}
	return false
}

// Adding returns whether this kind of instrument groups its inputs (as opposed to Adding).
func (k Kind) Grouping() bool {
	return !k.Adding()
}

// Monotonic returns whether this kind of instrument exposes a non-decreasing sum.
func (k Kind) Monotonic() bool {
	switch k {
	case CounterKind, SumObserverKind:
		return true
	}
	return false
}

// Cumulative returns whether this kind of instrument receives precomputed sums.
func (k Kind) PrecomputedSum() bool {
	return k.Adding() && k.Asynchronous()
}