opentelemetry-go/api/metric/measure.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.

package metric

import (
	"context"

	"go.opentelemetry.io/otel/api/core"
)

// Float64Measure is a metric that records float64 values.
type Float64Measure struct {
	syncInstrument
}

// Int64Measure is a metric that records int64 values.
type Int64Measure struct {
	syncInstrument
}

// BoundFloat64Measure is a bound instrument for Float64Measure.
//
// It inherits the Unbind function from syncBoundInstrument.
type BoundFloat64Measure struct {
	syncBoundInstrument
}

// BoundInt64Measure is a bound instrument for Int64Measure.
//
// It inherits the Unbind function from syncBoundInstrument.
type BoundInt64Measure struct {
	syncBoundInstrument
}

// Bind creates a bound instrument for this measure. The labels should
// contain the keys and values for each key specified in the measure
// with the WithKeys option.
//
// If the labels do not contain a value for the key specified in the
// measure with the WithKeys option, then the missing value will be
// treated as unspecified.
func (c Float64Measure) Bind(labels ...core.KeyValue) (h BoundFloat64Measure) {
	h.syncBoundInstrument = c.bind(labels)
	return
}

// Bind creates a bound instrument for this measure. The labels should
// contain the keys and values for each key specified in the measure
// with the WithKeys option.
//
// If the labels do not contain a value for the key specified in the
// measure with the WithKeys option, then the missing value will be
// treated as unspecified.
func (c Int64Measure) Bind(labels ...core.KeyValue) (h BoundInt64Measure) {
	h.syncBoundInstrument = c.bind(labels)
	return
}

// Measurement creates a Measurement object to use with batch
// recording.
func (c Float64Measure) Measurement(value float64) Measurement {
	return c.float64Measurement(value)
}

// Measurement creates a Measurement object to use with batch
// recording.
func (c Int64Measure) Measurement(value int64) Measurement {
	return c.int64Measurement(value)
}

// Record adds a new value to the list of measure's records. The
// labels should contain the keys and values for each key specified in
// the measure with the WithKeys option.
//
// If the labels do not contain a value for the key specified in the
// measure with the WithKeys option, then the missing value will be
// treated as unspecified.
func (c Float64Measure) Record(ctx context.Context, value float64, labels ...core.KeyValue) {
	c.directRecord(ctx, core.NewFloat64Number(value), labels)
}

// Record adds a new value to the list of measure's records. The
// labels should contain the keys and values for each key specified in
// the measure with the WithKeys option.
//
// If the labels do not contain a value for the key specified in the
// measure with the WithKeys option, then the missing value will be
// treated as unspecified.
func (c Int64Measure) Record(ctx context.Context, value int64, labels ...core.KeyValue) {
	c.directRecord(ctx, core.NewInt64Number(value), labels)
}

// Record adds a new value to the list of measure's records.
func (b BoundFloat64Measure) Record(ctx context.Context, value float64) {
	b.directRecord(ctx, core.NewFloat64Number(value))
}

// Record adds a new value to the list of measure's records.
func (b BoundInt64Measure) Record(ctx context.Context, value int64) {
	b.directRecord(ctx, core.NewInt64Number(value))
}