Documentation
¶
Overview ¶
Package stats contains support for OpenCensus stats recording.
OpenCensus allows users to create typed measures, record measurements, aggregate the collected data, and export the aggregated data.
Measures ¶
A measure represents a type of metric to be tracked and recorded. For example, latency, request Mb/s, and response Mb/s are measures to collect from a server.
Each measure needs to be registered before being used. Measure constructors such as Int64 and Float64 automatically register the measure by the given name. Each registered measure needs to be unique by name. Measures also have a description and a unit.
Libraries can define and export measures for their end users to create views and collect instrumentation data.
Recording measurements ¶
Measurement is a data point to be collected for a measure. For example, for a latency (ms) measure, 100 is a measurement that represents a 100ms latency event. Users collect data points on the existing measures with the current context. Tags from the current context are recorded with the measurements if they are any.
Recorded measurements are dropped immediately if user is not aggregating them via views. Users don't necessarily need to conditionally enable/disable recording to reduce cost. Recording of measurements is cheap.
Libraries can always record measurements, and end-users can later decide on which measurements they want to collect by registering views. This allows libraries to turn on the instrumentation by default.
Index ¶
Examples ¶
Constants ¶
const ( UnitNone = "1" UnitBytes = "By" UnitMilliseconds = "ms" )
Units are encoded according to the case-sensitive abbreviations from the Unified Code for Units of Measure: http://unitsofmeasure.org/ucum.html
Variables ¶
This section is empty.
Functions ¶
func Record ¶
func Record(ctx context.Context, ms ...Measurement)
Record records one or multiple measurements with the same tags at once. If there are any tags in the context, measurements will be tagged with them.
Example ¶
package main
import (
"context"
"log"
"go.opencensus.io/stats"
)
func main() {
ctx := context.Background()
openConns, err := stats.Int64("my.org/measure/openconns", "open connections", stats.UnitNone)
if err != nil {
log.Fatal(err)
}
stats.Record(ctx, openConns.M(124)) // Record 124 open connections.
}
Output:
Types ¶
type Float64Measure ¶ added in v0.3.0
type Float64Measure struct {
// contains filtered or unexported fields
}
Float64Measure is a measure of type float64.
func Float64 ¶ added in v0.3.0
func Float64(name, description, unit string) (*Float64Measure, error)
Float64 creates a new measure of type Float64Measure. It returns an error if a measure with the same name already exists.
func (*Float64Measure) Description ¶ added in v0.3.0
func (m *Float64Measure) Description() string
Description returns the description of the measure.
func (*Float64Measure) M ¶ added in v0.3.0
func (f *Float64Measure) M(v float64) Measurement
M creates a new float64 measurement. Use Record to record measurements.
type Int64Measure ¶ added in v0.3.0
type Int64Measure struct {
// contains filtered or unexported fields
}
Int64Measure is a measure of type int64.
func Int64 ¶ added in v0.3.0
func Int64(name, description, unit string) (*Int64Measure, error)
Int64 creates a new measure of type Int64Measure. It returns an error if a measure with the same name already exists.
func (*Int64Measure) Description ¶ added in v0.3.0
func (m *Int64Measure) Description() string
Description returns the description of the measure.
func (*Int64Measure) M ¶ added in v0.3.0
func (i *Int64Measure) M(v int64) Measurement
M creates a new int64 measurement. Use Record to record measurements.
type Measure ¶
type Measure interface {
Name() string
Description() string
Unit() string
// contains filtered or unexported methods
}
Measure represents a type of metric to be tracked and recorded. For example, latency, request Mb/s, and response Mb/s are measures to collect from a server.
Each measure needs to be registered before being used. Measure constructors such as Int64 and Float64 automatically registers the measure by the given name. Each registered measure needs to be unique by name. Measures also have a description and a unit.
func FindMeasure ¶
FindMeasure finds the Measure instance, if any, associated with the given name.
type Measurement ¶
type Measurement struct {
// contains filtered or unexported fields
}
Measurement is the numeric value measured when recording stats. Each measure provides methods to create measurements of their kind. For example, Int64Measure provides M to convert an int64 into a measurement.
func (Measurement) Measure ¶ added in v0.3.0
func (m Measurement) Measure() Measure
Measure returns the Measure from which this Measurement was created.
func (Measurement) Value ¶ added in v0.3.0
func (m Measurement) Value() float64
Value returns the value of the Measurement as a float64.
Source Files
Directories