mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2024-12-16 10:19:23 +02:00
493e13f834
The methods on the `Float64Gauge`, `Int64Gauge`, `Float64Counter`, `Int64Counter`, `Float64Measure`, and `Int64Measure` `struct`s do not need to mutate the internal state of the `struct` and can therefore be defined with value receivers instead. This aligns closer to the function signatures of each instruments constructor function. Additionally, this change means calls to these methods do not need an allocation to the heap. Resolves #440 Co-authored-by: Rahul Patel <rghetia@yahoo.com>
114 lines
3.7 KiB
Go
114 lines
3.7 KiB
Go
// Copyright 2019, 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 (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/api/core"
|
|
)
|
|
|
|
// Float64Counter is a metric that accumulates float64 values.
|
|
type Float64Counter struct {
|
|
commonMetric
|
|
}
|
|
|
|
// Int64Counter is a metric that accumulates int64 values.
|
|
type Int64Counter struct {
|
|
commonMetric
|
|
}
|
|
|
|
// BoundFloat64Counter is a bound instrument for Float64Counter.
|
|
//
|
|
// It inherits the Unbind function from commonBoundInstrument.
|
|
type BoundFloat64Counter struct {
|
|
commonBoundInstrument
|
|
}
|
|
|
|
// BoundInt64Counter is a boundInstrument for Int64Counter.
|
|
//
|
|
// It inherits the Unbind function from commonBoundInstrument.
|
|
type BoundInt64Counter struct {
|
|
commonBoundInstrument
|
|
}
|
|
|
|
// Bind creates a bound instrument for this counter. The labels should
|
|
// contain the keys and values for each key specified in the counter
|
|
// with the WithKeys option.
|
|
//
|
|
// If the labels do not contain a value for the key specified in the
|
|
// counter with the WithKeys option, then the missing value will be
|
|
// treated as unspecified.
|
|
func (c Float64Counter) Bind(labels LabelSet) (h BoundFloat64Counter) {
|
|
h.commonBoundInstrument = c.bind(labels)
|
|
return
|
|
}
|
|
|
|
// Bind creates a bound instrument for this counter. The labels should
|
|
// contain the keys and values for each key specified in the counter
|
|
// with the WithKeys option.
|
|
//
|
|
// If the labels do not contain a value for the key specified in the
|
|
// counter with the WithKeys option, then the missing value will be
|
|
// treated as unspecified.
|
|
func (c Int64Counter) Bind(labels LabelSet) (h BoundInt64Counter) {
|
|
h.commonBoundInstrument = c.bind(labels)
|
|
return
|
|
}
|
|
|
|
// Measurement creates a Measurement object to use with batch
|
|
// recording.
|
|
func (c Float64Counter) Measurement(value float64) Measurement {
|
|
return c.float64Measurement(value)
|
|
}
|
|
|
|
// Measurement creates a Measurement object to use with batch
|
|
// recording.
|
|
func (c Int64Counter) Measurement(value int64) Measurement {
|
|
return c.int64Measurement(value)
|
|
}
|
|
|
|
// Add adds the value to the counter's sum. The labels should contain
|
|
// the keys and values for each key specified in the counter with the
|
|
// WithKeys option.
|
|
//
|
|
// If the labels do not contain a value for the key specified in the
|
|
// counter with the WithKeys option, then the missing value will be
|
|
// treated as unspecified.
|
|
func (c Float64Counter) Add(ctx context.Context, value float64, labels LabelSet) {
|
|
c.directRecord(ctx, core.NewFloat64Number(value), labels)
|
|
}
|
|
|
|
// Add adds the value to the counter's sum. The labels should contain
|
|
// the keys and values for each key specified in the counter with the
|
|
// WithKeys option.
|
|
//
|
|
// If the labels do not contain a value for the key specified in the
|
|
// counter with the WithKeys option, then the missing value will be
|
|
// treated as unspecified.
|
|
func (c Int64Counter) Add(ctx context.Context, value int64, labels LabelSet) {
|
|
c.directRecord(ctx, core.NewInt64Number(value), labels)
|
|
}
|
|
|
|
// Add adds the value to the counter's sum.
|
|
func (b BoundFloat64Counter) Add(ctx context.Context, value float64) {
|
|
b.directRecord(ctx, core.NewFloat64Number(value))
|
|
}
|
|
|
|
// Add adds the value to the counter's sum.
|
|
func (b BoundInt64Counter) Add(ctx context.Context, value int64) {
|
|
b.directRecord(ctx, core.NewInt64Number(value))
|
|
}
|