measure_float64.go

// Copyright 2017, OpenCensus 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 stats

// Float64Measure is a measure of type float64.
type Float64Measure struct {
	name        string
	unit        string
	description string
}

// Name returns the name of the measure.
func (m *Float64Measure) Name() string {
	return m.name
}

// Description returns the description of the measure.
func (m *Float64Measure) Description() string {
	return m.description
}

// Unit returns the unit of the measure.
func (m *Float64Measure) Unit() string {
	return m.unit
}

// M creates a new float64 measurement.
// Use Record to record measurements.
func (m *Float64Measure) M(v float64) Measurement {
	return Measurement{Measure: m, Value: v}
}

// Float64 creates a new measure of type Float64Measure. It returns
// an error if a measure with the same name already exists.
func Float64(name, description, unit string) (*Float64Measure, error) {
	if err := checkName(name); err != nil {
		return nil, err
	}
	m := &Float64Measure{
		name:        name,
		description: description,
		unit:        unit,
	}
	_, err := register(m)
	if err != nil {
		return nil, err
	} else {
		return m, err
	}
}