1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-01-12 02:28:07 +02:00
opentelemetry-go/api/metric/kind.go
Joshua MacDonald 0e2fdfc682
Support cumulative, delta, and pass-through exporters (#840)
* Update Process()

* Checkpoint

* Add subtractor; fix test

* Fix all simple integrator tests

* Build the rest (checkpoint)

* Pass all but Prometheus tests

* Precommit pass

* Add aggregation.Kind argument to ExportKindFor

* Remove Subtractor support

* Remove dead test code

* Restore the Subtractor code

* Fix the tests

* Comments

* Add tests for MetricKind

* Add ChangeSign test

* Test ExportKind

* New file

* Rename ChangeSign

* Remove a TODO, add a TODO

* Remove Stateful remnants

* Typo

* Typo

* Test an invalid export kind

* Comments

* Lint

* Apply suggestions from code review

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
2020-06-22 22:59:51 -07:00

80 lines
2.2 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=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()
}