opentelemetry-go/api/metric/counter.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"
)

// Float64Counter is a metric that accumulates float64 values.
type Float64Counter struct {
	commonMetric
}

// Int64Counter is a metric that accumulates int64 values.
type Int64Counter struct {
	commonMetric
}

// Float64CounterHandle is a handle for Float64Counter.
type Float64CounterHandle struct {
	Handle
}

// Int64CounterHandle is a handle for Int64Counter.
type Int64CounterHandle struct {
	Handle
}

// CounterOptionApplier is an interface for applying metric options
// that are valid only for counter metrics.
type CounterOptionApplier interface {
	// ApplyCounterOption is used to make some counter-specific
	// changes in the Descriptor.
	ApplyCounterOption(*Descriptor)
}

type counterOptionWrapper struct {
	F Option
}

var (
	_ CounterOptionApplier    = counterOptionWrapper{}
	_ ExplicitReportingMetric = Float64Counter{}
	_ ExplicitReportingMetric = Int64Counter{}
)

func (o counterOptionWrapper) ApplyCounterOption(d *Descriptor) {
	o.F(d)
}

func newCounter(name string, valueKind ValueKind, mos ...CounterOptionApplier) commonMetric {
	m := registerCommonMetric(name, CounterKind, valueKind)
	for _, opt := range mos {
		opt.ApplyCounterOption(m.Descriptor())
	}
	return m
}

// NewFloat64Counter creates a new counter for float64.
func NewFloat64Counter(name string, mos ...CounterOptionApplier) (c Float64Counter) {
	c.commonMetric = newCounter(name, Float64ValueKind, mos...)
	return
}

// NewInt64Counter creates a new counter for int64.
func NewInt64Counter(name string, mos ...CounterOptionApplier) (c Int64Counter) {
	c.commonMetric = newCounter(name, Int64ValueKind, mos...)
	return
}

// GetHandle creates a handle 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) GetHandle(labels LabelSet) (h Float64CounterHandle) {
	h.Handle = c.getHandle(labels)
	return
}

// GetHandle creates a handle 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) GetHandle(labels LabelSet) (h Int64CounterHandle) {
	h.Handle = c.getHandle(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.recordOne(ctx, NewFloat64MeasurementValue(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.recordOne(ctx, NewInt64MeasurementValue(value), labels)
}

// Add adds the value to the counter's sum.
func (h *Float64CounterHandle) Add(ctx context.Context, value float64) {
	h.RecordOne(ctx, NewFloat64MeasurementValue(value))
}

// Add adds the value to the counter's sum.
func (h *Int64CounterHandle) Add(ctx context.Context, value int64) {
	h.RecordOne(ctx, NewInt64MeasurementValue(value))
}