diff --git a/api/global/internal/benchmark_test.go b/api/global/internal/benchmark_test.go index 66a3728d1..017afbd95 100644 --- a/api/global/internal/benchmark_test.go +++ b/api/global/internal/benchmark_test.go @@ -59,7 +59,7 @@ func (*benchFixture) AggregatorFor(descriptor *metric.Descriptor) export.Aggrega switch descriptor.MetricKind() { case metric.CounterKind: return sum.New() - case metric.MeasureKind: + case metric.ValueRecorderKind: if strings.HasSuffix(descriptor.Name(), "minmaxsumcount") { return minmaxsumcount.New(descriptor) } else if strings.HasSuffix(descriptor.Name(), "ddsketch") { diff --git a/api/global/internal/meter_test.go b/api/global/internal/meter_test.go index 070e65221..17485b745 100644 --- a/api/global/internal/meter_test.go +++ b/api/global/internal/meter_test.go @@ -82,9 +82,9 @@ func TestDirect(t *testing.T) { counter.Add(ctx, 1, labels1...) counter.Add(ctx, 1, labels1...) - measure := Must(meter1).NewFloat64Measure("test.measure") - measure.Record(ctx, 1, labels1...) - measure.Record(ctx, 2, labels1...) + valuerecorder := Must(meter1).NewFloat64ValueRecorder("test.valuerecorder") + valuerecorder.Record(ctx, 1, labels1...) + valuerecorder.Record(ctx, 2, labels1...) _ = Must(meter1).RegisterFloat64Observer("test.observer.float", func(result metric.Float64ObserverResult) { result.Observe(1., labels1...) @@ -96,7 +96,7 @@ func TestDirect(t *testing.T) { result.Observe(2, labels2...) }) - second := Must(meter2).NewFloat64Measure("test.second") + second := Must(meter2).NewFloat64ValueRecorder("test.second") second.Record(ctx, 1, labels3...) second.Record(ctx, 2, labels3...) @@ -104,7 +104,7 @@ func TestDirect(t *testing.T) { global.SetMeterProvider(provider) counter.Add(ctx, 1, labels1...) - measure.Record(ctx, 3, labels1...) + valuerecorder.Record(ctx, 3, labels1...) second.Record(ctx, 3, labels3...) mock.RunAsyncInstruments() @@ -120,7 +120,7 @@ func TestDirect(t *testing.T) { Number: asInt(1), }, { - Name: "test.measure", + Name: "test.valuerecorder", LibraryName: "test1", Labels: asMap(labels1...), Number: asFloat(3), @@ -174,8 +174,8 @@ func TestBound(t *testing.T) { boundC.Add(ctx, 1) boundC.Add(ctx, 1) - measure := Must(glob).NewInt64Measure("test.measure") - boundM := measure.Bind(labels1...) + valuerecorder := Must(glob).NewInt64ValueRecorder("test.valuerecorder") + boundM := valuerecorder.Bind(labels1...) boundM.Record(ctx, 1) boundM.Record(ctx, 2) @@ -194,7 +194,7 @@ func TestBound(t *testing.T) { Number: asFloat(1), }, { - Name: "test.measure", + Name: "test.valuerecorder", LibraryName: "test", Labels: asMap(labels1...), Number: asInt(3), @@ -216,8 +216,8 @@ func TestUnbind(t *testing.T) { counter := Must(glob).NewFloat64Counter("test.counter") boundC := counter.Bind(labels1...) - measure := Must(glob).NewInt64Measure("test.measure") - boundM := measure.Bind(labels1...) + valuerecorder := Must(glob).NewInt64ValueRecorder("test.valuerecorder") + boundM := valuerecorder.Bind(labels1...) boundC.Unbind() boundM.Unbind() diff --git a/api/global/internal/registry_test.go b/api/global/internal/registry_test.go index 6e6af1407..14ae04dfd 100644 --- a/api/global/internal/registry_test.go +++ b/api/global/internal/registry_test.go @@ -36,11 +36,11 @@ var ( "counter.float64": func(name, libraryName string) (metric.InstrumentImpl, error) { return unwrap(MeterProvider().Meter(libraryName).NewFloat64Counter(name)) }, - "measure.int64": func(name, libraryName string) (metric.InstrumentImpl, error) { - return unwrap(MeterProvider().Meter(libraryName).NewInt64Measure(name)) + "valuerecorder.int64": func(name, libraryName string) (metric.InstrumentImpl, error) { + return unwrap(MeterProvider().Meter(libraryName).NewInt64ValueRecorder(name)) }, - "measure.float64": func(name, libraryName string) (metric.InstrumentImpl, error) { - return unwrap(MeterProvider().Meter(libraryName).NewFloat64Measure(name)) + "valuerecorder.float64": func(name, libraryName string) (metric.InstrumentImpl, error) { + return unwrap(MeterProvider().Meter(libraryName).NewFloat64ValueRecorder(name)) }, "observer.int64": func(name, libraryName string) (metric.InstrumentImpl, error) { return unwrap(MeterProvider().Meter(libraryName).RegisterInt64Observer(name, func(metric.Int64ObserverResult) {})) diff --git a/api/metric/api_test.go b/api/metric/api_test.go index 1395b8687..9a370a8d4 100644 --- a/api/metric/api_test.go +++ b/api/metric/api_test.go @@ -119,29 +119,29 @@ func TestCounter(t *testing.T) { } } -func TestMeasure(t *testing.T) { +func TestValueRecorder(t *testing.T) { { mockSDK, meter := mockTest.NewMeter() - m := Must(meter).NewFloat64Measure("test.measure.float") + m := Must(meter).NewFloat64ValueRecorder("test.valuerecorder.float") ctx := context.Background() labels := []kv.KeyValue{} m.Record(ctx, 42, labels...) boundInstrument := m.Bind(labels...) boundInstrument.Record(ctx, 42) meter.RecordBatch(ctx, labels, m.Measurement(42)) - t.Log("Testing float measure") + t.Log("Testing float valuerecorder") checkBatches(t, ctx, labels, mockSDK, metric.Float64NumberKind, m.SyncImpl()) } { mockSDK, meter := mockTest.NewMeter() - m := Must(meter).NewInt64Measure("test.measure.int") + m := Must(meter).NewInt64ValueRecorder("test.valuerecorder.int") ctx := context.Background() labels := []kv.KeyValue{kv.Int("I", 1)} m.Record(ctx, 42, labels...) boundInstrument := m.Bind(labels...) boundInstrument.Record(ctx, 42) meter.RecordBatch(ctx, labels, m.Measurement(42)) - t.Log("Testing int measure") + t.Log("Testing int valuerecorder") checkBatches(t, ctx, labels, mockSDK, metric.Int64NumberKind, m.SyncImpl()) } } @@ -309,10 +309,10 @@ func TestWrappedInstrumentError(t *testing.T) { impl := &testWrappedMeter{} meter := metric.WrapMeterImpl(impl, "test") - measure, err := meter.NewInt64Measure("test.measure") + valuerecorder, err := meter.NewInt64ValueRecorder("test.valuerecorder") require.Equal(t, err, metric.ErrSDKReturnedNilImpl) - require.NotNil(t, measure.SyncImpl()) + require.NotNil(t, valuerecorder.SyncImpl()) observer, err := meter.RegisterInt64Observer("test.observer", func(result metric.Int64ObserverResult) {}) diff --git a/api/metric/doc.go b/api/metric/doc.go index 127b33bd4..8249b6f6d 100644 --- a/api/metric/doc.go +++ b/api/metric/doc.go @@ -13,57 +13,37 @@ // limitations under the License. // metric package provides an API for reporting diagnostic -// measurements using four basic kinds of instruments. +// measurements using instruments categorized as follows: // -// The three basic kinds are: +// Synchronous instruments are called by the user with a Context. +// Asynchronous instruments are called by the SDK during collection. // -// - counters -// - measures -// - observers +// Additive instruments are semantically intended for capturing a sum. +// Non-additive instruments are intended for capturing a distribution. // -// All instruments report either float64 or int64 values. +// Additive instruments may be monotonic, in which case they are +// non-descreasing and naturally define a rate. // -// The primary object that handles metrics is Meter. Meter can be -// obtained from Provider. The implementations of the Meter and -// Provider are provided by SDK. Normally, the Meter is used directly -// only for the instrument creation and batch recording. +// The synchronous instrument names are: // -// Counters are instruments that are reporting a quantity or a sum. An -// example could be bank account balance or bytes downloaded. Counters -// can be created with either NewFloat64Counter or -// NewInt64Counter. Counters expect non-negative values by default to -// be reported. This can be changed with the WithMonotonic option -// (passing false as a parameter) passed to the Meter.New*Counter -// function - this allows reporting negative values. To report the new -// value, use an Add function. +// Counter: additive, monotonic +// UpDownCounter: additive +// ValueRecorder: non-additive // -// Measures are instruments that are reporting values that are -// recorded separately to figure out some statistical properties from -// those values (like average). An example could be temperature over -// time or lines of code in the project over time. Measures can be -// created with either NewFloat64Measure or NewInt64Measure. Measures -// by default take only non-negative values. This can be changed with -// the WithAbsolute option (passing false as a parameter) passed to -// the New*Measure function - this allows reporting negative values -// too. To report a new value, use the Record function. +// and the asynchronous instruments are: // -// Observers are instruments that are reporting a current state of a -// set of values. An example could be voltage or -// temperature. Observers can be created with either -// RegisterFloat64Observer or RegisterInt64Observer. Observers by -// default have no limitations about reported values - they can be -// less or greater than the last reported value. This can be changed -// with the WithMonotonic option passed to the Register*Observer -// function - this permits the reported values only to go -// up. Reporting of the new values happens asynchronously, with the -// use of a callback passed to the Register*Observer function. The -// callback can report multiple values. There is no unregister function. +// SumObserver: additive, monotonic +// UpDownSumOnserver: additive +// ValueObserver: non-additive // -// Counters and measures support creating bound instruments for a -// potentially more efficient reporting. The bound instruments have -// the same function names as the instruments (so a Counter bound -// instrument has Add, and a Measure bound instrument has Record). -// Bound Instruments can be created with the Bind function of the -// respective instrument. When done with the bound instrument, call -// Unbind on it. +// All instruments are provided with support for either float64 or +// int64 input values. +// +// The Meter interface supports allocating new instruments as well as +// interfaces for recording batches of synchronous measurements or +// asynchronous observations. To obtain a Meter, use a Provider. +// +// The Provider interface supports obtaining a named Meter interface. +// To obtain a Provider implementation, initialize and configure any +// compatible SDK. package metric // import "go.opentelemetry.io/otel/api/metric" diff --git a/api/metric/kind.go b/api/metric/kind.go index 63799ca96..38001e918 100644 --- a/api/metric/kind.go +++ b/api/metric/kind.go @@ -20,8 +20,8 @@ package metric type Kind int8 const ( - // MeasureKind indicates a Measure instrument. - MeasureKind Kind = iota + // ValueRecorderKind indicates a ValueRecorder instrument. + ValueRecorderKind Kind = iota // ObserverKind indicates an Observer instrument. ObserverKind // CounterKind indicates a Counter instrument. diff --git a/api/metric/kind_string.go b/api/metric/kind_string.go index f46c1463f..67113b120 100644 --- a/api/metric/kind_string.go +++ b/api/metric/kind_string.go @@ -8,14 +8,14 @@ func _() { // An "invalid array index" compiler error signifies that the constant values have changed. // Re-run the stringer command to generate them again. var x [1]struct{} - _ = x[MeasureKind-0] + _ = x[ValueRecorderKind-0] _ = x[ObserverKind-1] _ = x[CounterKind-2] } -const _Kind_name = "MeasureKindObserverKindCounterKind" +const _Kind_name = "ValueRecorderKindObserverKindCounterKind" -var _Kind_index = [...]uint8{0, 11, 23, 34} +var _Kind_index = [...]uint8{0, 17, 29, 40} func (i Kind) String() string { if i < 0 || i >= Kind(len(_Kind_index)-1) { diff --git a/api/metric/meter.go b/api/metric/meter.go index e20b02b1e..5e95e2812 100644 --- a/api/metric/meter.go +++ b/api/metric/meter.go @@ -82,22 +82,22 @@ func (m Meter) NewFloat64Counter(name string, options ...Option) (Float64Counter m.newSync(name, CounterKind, Float64NumberKind, options)) } -// NewInt64Measure creates a new integer Measure instrument with the +// NewInt64ValueRecorder creates a new integer ValueRecorder instrument with the // given name, customized with options. May return an error if the // name is invalid (e.g., empty) or improperly registered (e.g., // duplicate registration). -func (m Meter) NewInt64Measure(name string, opts ...Option) (Int64Measure, error) { - return wrapInt64MeasureInstrument( - m.newSync(name, MeasureKind, Int64NumberKind, opts)) +func (m Meter) NewInt64ValueRecorder(name string, opts ...Option) (Int64ValueRecorder, error) { + return wrapInt64ValueRecorderInstrument( + m.newSync(name, ValueRecorderKind, Int64NumberKind, opts)) } -// NewFloat64Measure creates a new floating point Measure with the +// NewFloat64ValueRecorder creates a new floating point ValueRecorder with the // given name, customized with options. May return an error if the // name is invalid (e.g., empty) or improperly registered (e.g., // duplicate registration). -func (m Meter) NewFloat64Measure(name string, opts ...Option) (Float64Measure, error) { - return wrapFloat64MeasureInstrument( - m.newSync(name, MeasureKind, Float64NumberKind, opts)) +func (m Meter) NewFloat64ValueRecorder(name string, opts ...Option) (Float64ValueRecorder, error) { + return wrapFloat64ValueRecorderInstrument( + m.newSync(name, ValueRecorderKind, Float64NumberKind, opts)) } // RegisterInt64Observer creates a new integer Observer instrument diff --git a/api/metric/must.go b/api/metric/must.go index ecd47b0e0..b747932f3 100644 --- a/api/metric/must.go +++ b/api/metric/must.go @@ -53,20 +53,20 @@ func (mm MeterMust) NewFloat64Counter(name string, cos ...Option) Float64Counter } } -// NewInt64Measure calls `Meter.NewInt64Measure` and returns the +// NewInt64ValueRecorder calls `Meter.NewInt64ValueRecorder` and returns the // instrument, panicking if it encounters an error. -func (mm MeterMust) NewInt64Measure(name string, mos ...Option) Int64Measure { - if inst, err := mm.meter.NewInt64Measure(name, mos...); err != nil { +func (mm MeterMust) NewInt64ValueRecorder(name string, mos ...Option) Int64ValueRecorder { + if inst, err := mm.meter.NewInt64ValueRecorder(name, mos...); err != nil { panic(err) } else { return inst } } -// NewFloat64Measure calls `Meter.NewFloat64Measure` and returns the +// NewFloat64ValueRecorder calls `Meter.NewFloat64ValueRecorder` and returns the // instrument, panicking if it encounters an error. -func (mm MeterMust) NewFloat64Measure(name string, mos ...Option) Float64Measure { - if inst, err := mm.meter.NewFloat64Measure(name, mos...); err != nil { +func (mm MeterMust) NewFloat64ValueRecorder(name string, mos ...Option) Float64ValueRecorder { + if inst, err := mm.meter.NewFloat64ValueRecorder(name, mos...); err != nil { panic(err) } else { return inst diff --git a/api/metric/registry/registry_test.go b/api/metric/registry/registry_test.go index 55eea312f..51f8392a1 100644 --- a/api/metric/registry/registry_test.go +++ b/api/metric/registry/registry_test.go @@ -37,11 +37,11 @@ var ( "counter.float64": func(m metric.Meter, name string) (metric.InstrumentImpl, error) { return unwrap(m.NewFloat64Counter(name)) }, - "measure.int64": func(m metric.Meter, name string) (metric.InstrumentImpl, error) { - return unwrap(m.NewInt64Measure(name)) + "valuerecorder.int64": func(m metric.Meter, name string) (metric.InstrumentImpl, error) { + return unwrap(m.NewInt64ValueRecorder(name)) }, - "measure.float64": func(m metric.Meter, name string) (metric.InstrumentImpl, error) { - return unwrap(m.NewFloat64Measure(name)) + "valuerecorder.float64": func(m metric.Meter, name string) (metric.InstrumentImpl, error) { + return unwrap(m.NewFloat64ValueRecorder(name)) }, "observer.int64": func(m metric.Meter, name string) (metric.InstrumentImpl, error) { return unwrap(m.RegisterInt64Observer(name, func(metric.Int64ObserverResult) {})) diff --git a/api/metric/sdkapi.go b/api/metric/sdkapi.go index c9b902dc8..c7a6fe4c5 100644 --- a/api/metric/sdkapi.go +++ b/api/metric/sdkapi.go @@ -53,7 +53,7 @@ type InstrumentImpl interface { } // SyncImpl is the implementation-level interface to a generic -// synchronous instrument (e.g., Measure and Counter instruments). +// synchronous instrument (e.g., ValueRecorder and Counter instruments). type SyncImpl interface { InstrumentImpl diff --git a/api/metric/sync.go b/api/metric/sync.go index 6b8d3a2a3..66e99c285 100644 --- a/api/metric/sync.go +++ b/api/metric/sync.go @@ -174,22 +174,22 @@ func wrapFloat64CounterInstrument(syncInst SyncImpl, err error) (Float64Counter, return Float64Counter{syncInstrument: common}, err } -// wrapInt64MeasureInstrument returns an `Int64Measure` from a +// wrapInt64ValueRecorderInstrument returns an `Int64ValueRecorder` from a // `SyncImpl`. An error will be generated if the // `SyncImpl` is nil (in which case a No-op is substituted), // otherwise the error passes through. -func wrapInt64MeasureInstrument(syncInst SyncImpl, err error) (Int64Measure, error) { +func wrapInt64ValueRecorderInstrument(syncInst SyncImpl, err error) (Int64ValueRecorder, error) { common, err := checkNewSync(syncInst, err) - return Int64Measure{syncInstrument: common}, err + return Int64ValueRecorder{syncInstrument: common}, err } -// wrapFloat64MeasureInstrument returns an `Float64Measure` from a +// wrapFloat64ValueRecorderInstrument returns an `Float64ValueRecorder` from a // `SyncImpl`. An error will be generated if the // `SyncImpl` is nil (in which case a No-op is substituted), // otherwise the error passes through. -func wrapFloat64MeasureInstrument(syncInst SyncImpl, err error) (Float64Measure, error) { +func wrapFloat64ValueRecorderInstrument(syncInst SyncImpl, err error) (Float64ValueRecorder, error) { common, err := checkNewSync(syncInst, err) - return Float64Measure{syncInstrument: common}, err + return Float64ValueRecorder{syncInstrument: common}, err } // wrapInt64ObserverInstrument returns an `Int64Observer` from a diff --git a/api/metric/measure.go b/api/metric/valuerecorder.go similarity index 51% rename from api/metric/measure.go rename to api/metric/valuerecorder.go index 11dd215ee..f4723fb98 100644 --- a/api/metric/measure.go +++ b/api/metric/valuerecorder.go @@ -20,78 +20,78 @@ import ( "go.opentelemetry.io/otel/api/kv" ) -// Float64Measure is a metric that records float64 values. -type Float64Measure struct { +// Float64ValueRecorder is a metric that records float64 values. +type Float64ValueRecorder struct { syncInstrument } -// Int64Measure is a metric that records int64 values. -type Int64Measure struct { +// Int64ValueRecorder is a metric that records int64 values. +type Int64ValueRecorder struct { syncInstrument } -// BoundFloat64Measure is a bound instrument for Float64Measure. +// BoundFloat64ValueRecorder is a bound instrument for Float64ValueRecorder. // // It inherits the Unbind function from syncBoundInstrument. -type BoundFloat64Measure struct { +type BoundFloat64ValueRecorder struct { syncBoundInstrument } -// BoundInt64Measure is a bound instrument for Int64Measure. +// BoundInt64ValueRecorder is a bound instrument for Int64ValueRecorder. // // It inherits the Unbind function from syncBoundInstrument. -type BoundInt64Measure struct { +type BoundInt64ValueRecorder struct { syncBoundInstrument } -// Bind creates a bound instrument for this measure. The labels are +// Bind creates a bound instrument for this ValueRecorder. The labels are // associated with values recorded via subsequent calls to Record. -func (c Float64Measure) Bind(labels ...kv.KeyValue) (h BoundFloat64Measure) { +func (c Float64ValueRecorder) Bind(labels ...kv.KeyValue) (h BoundFloat64ValueRecorder) { h.syncBoundInstrument = c.bind(labels) return } -// Bind creates a bound instrument for this measure. The labels are +// Bind creates a bound instrument for this ValueRecorder. The labels are // associated with values recorded via subsequent calls to Record. -func (c Int64Measure) Bind(labels ...kv.KeyValue) (h BoundInt64Measure) { +func (c Int64ValueRecorder) Bind(labels ...kv.KeyValue) (h BoundInt64ValueRecorder) { h.syncBoundInstrument = c.bind(labels) return } // Measurement creates a Measurement object to use with batch // recording. -func (c Float64Measure) Measurement(value float64) Measurement { +func (c Float64ValueRecorder) 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 { +func (c Int64ValueRecorder) Measurement(value int64) Measurement { return c.int64Measurement(value) } -// Record adds a new value to the list of measure's records. The +// Record adds a new value to the list of ValueRecorder's records. The // labels should contain the keys and values to be associated with // this value. -func (c Float64Measure) Record(ctx context.Context, value float64, labels ...kv.KeyValue) { +func (c Float64ValueRecorder) Record(ctx context.Context, value float64, labels ...kv.KeyValue) { c.directRecord(ctx, NewFloat64Number(value), labels) } -// Record adds a new value to the list of measure's records. The +// Record adds a new value to the ValueRecorder's distribution. The // labels should contain the keys and values to be associated with // this value. -func (c Int64Measure) Record(ctx context.Context, value int64, labels ...kv.KeyValue) { +func (c Int64ValueRecorder) Record(ctx context.Context, value int64, labels ...kv.KeyValue) { c.directRecord(ctx, NewInt64Number(value), labels) } -// Record adds a new value to the list of measure's records using the labels -// previously bound to the measure via Bind() -func (b BoundFloat64Measure) Record(ctx context.Context, value float64) { +// Record adds a new value to the ValueRecorder's distribution using the labels +// previously bound to the ValueRecorder via Bind(). +func (b BoundFloat64ValueRecorder) Record(ctx context.Context, value float64) { b.directRecord(ctx, NewFloat64Number(value)) } -// Record adds a new value to the list of measure's records using the labels -// previously bound to the measure via Bind() -func (b BoundInt64Measure) Record(ctx context.Context, value int64) { +// Record adds a new value to the ValueRecorder's distribution using the labels +// previously bound to the ValueRecorder via Bind(). +func (b BoundInt64ValueRecorder) Record(ctx context.Context, value int64) { b.directRecord(ctx, NewInt64Number(value)) } diff --git a/example/basic/main.go b/example/basic/main.go index 9a5b05983..84470d10b 100644 --- a/example/basic/main.go +++ b/example/basic/main.go @@ -80,7 +80,7 @@ func main() { metric.WithDescription("An observer set to 1.0"), ) - measureTwo := metric.Must(meter).NewFloat64Measure("ex.com.two") + valuerecorderTwo := metric.Must(meter).NewFloat64ValueRecorder("ex.com.two") ctx := context.Background() @@ -89,8 +89,8 @@ func main() { barKey.String("bar1"), ) - measure := measureTwo.Bind(commonLabels...) - defer measure.Unbind() + valuerecorder := valuerecorderTwo.Bind(commonLabels...) + defer valuerecorder.Unbind() err := tracer.WithSpan(ctx, "operation", func(ctx context.Context) error { @@ -103,7 +103,7 @@ func main() { correlation.NewContext(ctx, anotherKey.String("xyz")), commonLabels, - measureTwo.Measurement(2.0), + valuerecorderTwo.Measurement(2.0), ) return tracer.WithSpan( @@ -114,7 +114,7 @@ func main() { trace.SpanFromContext(ctx).AddEvent(ctx, "Sub span event") - measure.Record(ctx, 1.3) + valuerecorder.Record(ctx, 1.3) return nil }, diff --git a/example/prometheus/main.go b/example/prometheus/main.go index 6c0282801..f9a5cf702 100644 --- a/example/prometheus/main.go +++ b/example/prometheus/main.go @@ -60,11 +60,11 @@ func main() { result.Observe(value, labels...) } _ = metric.Must(meter).RegisterFloat64Observer("ex.com.one", cb, - metric.WithDescription("A measure set to 1.0"), + metric.WithDescription("An observer set to 1.0"), ) - measureTwo := metric.Must(meter).NewFloat64Measure("ex.com.two") - measureThree := metric.Must(meter).NewFloat64Counter("ex.com.three") + valuerecorder := metric.Must(meter).NewFloat64ValueRecorder("ex.com.two") + counter := metric.Must(meter).NewFloat64Counter("ex.com.three") commonLabels := []kv.KeyValue{lemonsKey.Int(10), kv.String("A", "1"), kv.String("B", "2"), kv.String("C", "3")} notSoCommonLabels := []kv.KeyValue{lemonsKey.Int(13)} @@ -78,8 +78,8 @@ func main() { meter.RecordBatch( ctx, commonLabels, - measureTwo.Measurement(2.0), - measureThree.Measurement(12.0), + valuerecorder.Measurement(2.0), + counter.Measurement(12.0), ) time.Sleep(5 * time.Second) @@ -91,8 +91,8 @@ func main() { meter.RecordBatch( ctx, notSoCommonLabels, - measureTwo.Measurement(2.0), - measureThree.Measurement(22.0), + valuerecorder.Measurement(2.0), + counter.Measurement(22.0), ) time.Sleep(5 * time.Second) @@ -104,8 +104,8 @@ func main() { meter.RecordBatch( ctx, commonLabels, - measureTwo.Measurement(12.0), - measureThree.Measurement(13.0), + valuerecorder.Measurement(12.0), + counter.Measurement(13.0), ) time.Sleep(100 * time.Second) diff --git a/exporters/metric/prometheus/prometheus.go b/exporters/metric/prometheus/prometheus.go index 2d8ec76de..5af88a6b7 100644 --- a/exporters/metric/prometheus/prometheus.go +++ b/exporters/metric/prometheus/prometheus.go @@ -147,7 +147,7 @@ func InstallNewPipeline(config Config) (*push.Controller, http.HandlerFunc, erro // NewExportPipeline sets up a complete export pipeline with the recommended setup, // chaining a NewRawExporter into the recommended selectors and integrators. func NewExportPipeline(config Config, period time.Duration) (*push.Controller, http.HandlerFunc, error) { - selector := simple.NewWithHistogramMeasure(config.DefaultHistogramBoundaries) + selector := simple.NewWithHistogramDistribution(config.DefaultHistogramBoundaries) exporter, err := NewRawExporter(config) if err != nil { return nil, nil, err @@ -220,7 +220,7 @@ func (c *collector) Collect(ch chan<- prometheus.Metric) { } } else if dist, ok := agg.(aggregator.Distribution); ok { // TODO: summaries values are never being resetted. - // As measures are recorded, new records starts to have less impact on these summaries. + // As measurements are recorded, new records starts to have less impact on these summaries. // We should implement an solution that is similar to the Prometheus Clients // using a rolling window for summaries could be a solution. // diff --git a/exporters/metric/prometheus/prometheus_test.go b/exporters/metric/prometheus/prometheus_test.go index 362df65a6..0505281a4 100644 --- a/exporters/metric/prometheus/prometheus_test.go +++ b/exporters/metric/prometheus/prometheus_test.go @@ -45,10 +45,10 @@ func TestPrometheusExporter(t *testing.T) { "counter", metric.CounterKind, metric.Float64NumberKind) lastValue := metric.NewDescriptor( "lastvalue", metric.ObserverKind, metric.Float64NumberKind) - measure := metric.NewDescriptor( - "measure", metric.MeasureKind, metric.Float64NumberKind) - histogramMeasure := metric.NewDescriptor( - "histogram_measure", metric.MeasureKind, metric.Float64NumberKind) + valuerecorder := metric.NewDescriptor( + "valuerecorder", metric.ValueRecorderKind, metric.Float64NumberKind) + histogramValueRecorder := metric.NewDescriptor( + "histogram_valuerecorder", metric.ValueRecorderKind, metric.Float64NumberKind) labels := []kv.KeyValue{ kv.Key("A").String("B"), @@ -61,26 +61,26 @@ func TestPrometheusExporter(t *testing.T) { checkpointSet.AddLastValue(&lastValue, 13.2, labels...) expected = append(expected, `lastvalue{A="B",C="D"} 13.2`) - checkpointSet.AddMeasure(&measure, 13, labels...) - checkpointSet.AddMeasure(&measure, 15, labels...) - checkpointSet.AddMeasure(&measure, 17, labels...) - expected = append(expected, `measure{A="B",C="D",quantile="0.5"} 15`) - expected = append(expected, `measure{A="B",C="D",quantile="0.9"} 17`) - expected = append(expected, `measure{A="B",C="D",quantile="0.99"} 17`) - expected = append(expected, `measure_sum{A="B",C="D"} 45`) - expected = append(expected, `measure_count{A="B",C="D"} 3`) + checkpointSet.AddValueRecorder(&valuerecorder, 13, labels...) + checkpointSet.AddValueRecorder(&valuerecorder, 15, labels...) + checkpointSet.AddValueRecorder(&valuerecorder, 17, labels...) + expected = append(expected, `valuerecorder{A="B",C="D",quantile="0.5"} 15`) + expected = append(expected, `valuerecorder{A="B",C="D",quantile="0.9"} 17`) + expected = append(expected, `valuerecorder{A="B",C="D",quantile="0.99"} 17`) + expected = append(expected, `valuerecorder_sum{A="B",C="D"} 45`) + expected = append(expected, `valuerecorder_count{A="B",C="D"} 3`) boundaries := []metric.Number{metric.NewFloat64Number(-0.5), metric.NewFloat64Number(1)} - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, -0.6, labels...) - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, -0.4, labels...) - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, 0.6, labels...) - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, 20, labels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, -0.6, labels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, -0.4, labels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, 0.6, labels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, 20, labels...) - expected = append(expected, `histogram_measure_bucket{A="B",C="D",le="+Inf"} 4`) - expected = append(expected, `histogram_measure_bucket{A="B",C="D",le="-0.5"} 1`) - expected = append(expected, `histogram_measure_bucket{A="B",C="D",le="1"} 3`) - expected = append(expected, `histogram_measure_count{A="B",C="D"} 4`) - expected = append(expected, `histogram_measure_sum{A="B",C="D"} 19.6`) + expected = append(expected, `histogram_valuerecorder_bucket{A="B",C="D",le="+Inf"} 4`) + expected = append(expected, `histogram_valuerecorder_bucket{A="B",C="D",le="-0.5"} 1`) + expected = append(expected, `histogram_valuerecorder_bucket{A="B",C="D",le="1"} 3`) + expected = append(expected, `histogram_valuerecorder_count{A="B",C="D"} 4`) + expected = append(expected, `histogram_valuerecorder_sum{A="B",C="D"} 19.6`) missingLabels := []kv.KeyValue{ kv.Key("A").String("E"), @@ -93,25 +93,25 @@ func TestPrometheusExporter(t *testing.T) { checkpointSet.AddLastValue(&lastValue, 32, missingLabels...) expected = append(expected, `lastvalue{A="E",C=""} 32`) - checkpointSet.AddMeasure(&measure, 19, missingLabels...) - expected = append(expected, `measure{A="E",C="",quantile="0.5"} 19`) - expected = append(expected, `measure{A="E",C="",quantile="0.9"} 19`) - expected = append(expected, `measure{A="E",C="",quantile="0.99"} 19`) - expected = append(expected, `measure_count{A="E",C=""} 1`) - expected = append(expected, `measure_sum{A="E",C=""} 19`) + checkpointSet.AddValueRecorder(&valuerecorder, 19, missingLabels...) + expected = append(expected, `valuerecorder{A="E",C="",quantile="0.5"} 19`) + expected = append(expected, `valuerecorder{A="E",C="",quantile="0.9"} 19`) + expected = append(expected, `valuerecorder{A="E",C="",quantile="0.99"} 19`) + expected = append(expected, `valuerecorder_count{A="E",C=""} 1`) + expected = append(expected, `valuerecorder_sum{A="E",C=""} 19`) boundaries = []metric.Number{metric.NewFloat64Number(0), metric.NewFloat64Number(1)} - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, -0.6, missingLabels...) - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, -0.4, missingLabels...) - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, -0.1, missingLabels...) - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, 15, missingLabels...) - checkpointSet.AddHistogramMeasure(&histogramMeasure, boundaries, 15, missingLabels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, -0.6, missingLabels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, -0.4, missingLabels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, -0.1, missingLabels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, 15, missingLabels...) + checkpointSet.AddHistogramValueRecorder(&histogramValueRecorder, boundaries, 15, missingLabels...) - expected = append(expected, `histogram_measure_bucket{A="E",C="",le="+Inf"} 5`) - expected = append(expected, `histogram_measure_bucket{A="E",C="",le="0"} 3`) - expected = append(expected, `histogram_measure_bucket{A="E",C="",le="1"} 3`) - expected = append(expected, `histogram_measure_count{A="E",C=""} 5`) - expected = append(expected, `histogram_measure_sum{A="E",C=""} 28.9`) + expected = append(expected, `histogram_valuerecorder_bucket{A="E",C="",le="+Inf"} 5`) + expected = append(expected, `histogram_valuerecorder_bucket{A="E",C="",le="0"} 3`) + expected = append(expected, `histogram_valuerecorder_bucket{A="E",C="",le="1"} 3`) + expected = append(expected, `histogram_valuerecorder_count{A="E",C=""} 5`) + expected = append(expected, `histogram_valuerecorder_sum{A="E",C=""} 28.9`) compareExport(t, exporter, checkpointSet, expected) } diff --git a/exporters/metric/stdout/stdout.go b/exporters/metric/stdout/stdout.go index 04e39e6b1..d22b5f070 100644 --- a/exporters/metric/stdout/stdout.go +++ b/exporters/metric/stdout/stdout.go @@ -53,8 +53,8 @@ type Config struct { // useful to create deterministic test conditions. DoNotPrintTime bool - // Quantiles are the desired aggregation quantiles for measure - // metric data, used when the configured aggregator supports + // Quantiles are the desired aggregation quantiles for distribution + // summaries, used when the configured aggregator supports // quantiles. // // Note: this exporter is meant as a demonstration; a real @@ -133,7 +133,7 @@ func InstallNewPipeline(config Config, opts ...push.Option) (*push.Controller, e // NewExportPipeline sets up a complete export pipeline with the recommended setup, // chaining a NewRawExporter into the recommended selectors and integrators. func NewExportPipeline(config Config, period time.Duration, opts ...push.Option) (*push.Controller, error) { - selector := simple.NewWithExactMeasure() + selector := simple.NewWithExactDistribution() exporter, err := NewRawExporter(config) if err != nil { return nil, err diff --git a/exporters/metric/stdout/stdout_test.go b/exporters/metric/stdout/stdout_test.go index a5f94df6c..918c47b8b 100644 --- a/exporters/metric/stdout/stdout_test.go +++ b/exporters/metric/stdout/stdout_test.go @@ -177,7 +177,7 @@ func TestStdoutMinMaxSumCount(t *testing.T) { checkpointSet := test.NewCheckpointSet() - desc := metric.NewDescriptor("test.name", metric.MeasureKind, metric.Float64NumberKind) + desc := metric.NewDescriptor("test.name", metric.ValueRecorderKind, metric.Float64NumberKind) magg := minmaxsumcount.New(&desc) aggtest.CheckedUpdate(fix.t, magg, metric.NewFloat64Number(123.456), &desc) aggtest.CheckedUpdate(fix.t, magg, metric.NewFloat64Number(876.543), &desc) @@ -190,14 +190,14 @@ func TestStdoutMinMaxSumCount(t *testing.T) { require.Equal(t, `{"updates":[{"name":"test.name{A=B,C=D}","min":123.456,"max":876.543,"sum":999.999,"count":2}]}`, fix.Output()) } -func TestStdoutMeasureFormat(t *testing.T) { +func TestStdoutValueRecorderFormat(t *testing.T) { fix := newFixture(t, nil, stdout.Config{ PrettyPrint: true, }) checkpointSet := test.NewCheckpointSet() - desc := metric.NewDescriptor("test.name", metric.MeasureKind, metric.Float64NumberKind) + desc := metric.NewDescriptor("test.name", metric.ValueRecorderKind, metric.Float64NumberKind) magg := array.New() for i := 0; i < 1000; i++ { @@ -238,7 +238,7 @@ func TestStdoutMeasureFormat(t *testing.T) { } func TestStdoutNoData(t *testing.T) { - desc := metric.NewDescriptor("test.name", metric.MeasureKind, metric.Float64NumberKind) + desc := metric.NewDescriptor("test.name", metric.ValueRecorderKind, metric.Float64NumberKind) for name, tc := range map[string]export.Aggregator{ "ddsketch": ddsketch.New(ddsketch.NewDefaultConfig(), &desc), "minmaxsumcount": minmaxsumcount.New(&desc), diff --git a/exporters/metric/test/test.go b/exporters/metric/test/test.go index a7dca90d1..bc49cd9c9 100644 --- a/exporters/metric/test/test.go +++ b/exporters/metric/test/test.go @@ -88,11 +88,11 @@ func (p *CheckpointSet) AddCounter(desc *metric.Descriptor, v float64, labels .. p.updateAggregator(desc, sum.New(), v, labels...) } -func (p *CheckpointSet) AddMeasure(desc *metric.Descriptor, v float64, labels ...kv.KeyValue) { +func (p *CheckpointSet) AddValueRecorder(desc *metric.Descriptor, v float64, labels ...kv.KeyValue) { p.updateAggregator(desc, array.New(), v, labels...) } -func (p *CheckpointSet) AddHistogramMeasure(desc *metric.Descriptor, boundaries []metric.Number, v float64, labels ...kv.KeyValue) { +func (p *CheckpointSet) AddHistogramValueRecorder(desc *metric.Descriptor, boundaries []metric.Number, v float64, labels ...kv.KeyValue) { p.updateAggregator(desc, histogram.New(desc, boundaries), v, labels...) } diff --git a/exporters/otlp/internal/transform/metric_test.go b/exporters/otlp/internal/transform/metric_test.go index 57e0388a9..79f71e187 100644 --- a/exporters/otlp/internal/transform/metric_test.go +++ b/exporters/otlp/internal/transform/metric_test.go @@ -111,7 +111,7 @@ func TestMinMaxSumCountMetricDescriptor(t *testing.T) { }{ { "mmsc-test-a", - metric.MeasureKind, + metric.ValueRecorderKind, "test-a-description", unit.Dimensionless, metric.Int64NumberKind, @@ -160,7 +160,7 @@ func TestMinMaxSumCountMetricDescriptor(t *testing.T) { } func TestMinMaxSumCountDatapoints(t *testing.T) { - desc := metric.NewDescriptor("", metric.MeasureKind, metric.Int64NumberKind) + desc := metric.NewDescriptor("", metric.ValueRecorderKind, metric.Int64NumberKind) labels := label.NewSet() mmsc := minmaxsumcount.New(&desc) assert.NoError(t, mmsc.Update(context.Background(), 1, &desc)) @@ -228,7 +228,7 @@ func TestSumMetricDescriptor(t *testing.T) { }, { "sum-test-b", - metric.MeasureKind, // This shouldn't change anything. + metric.ValueRecorderKind, // This shouldn't change anything. "test-b-description", unit.Milliseconds, metric.Float64NumberKind, @@ -257,7 +257,7 @@ func TestSumMetricDescriptor(t *testing.T) { } func TestSumInt64DataPoints(t *testing.T) { - desc := metric.NewDescriptor("", metric.MeasureKind, metric.Int64NumberKind) + desc := metric.NewDescriptor("", metric.ValueRecorderKind, metric.Int64NumberKind) labels := label.NewSet() s := sumAgg.New() assert.NoError(t, s.Update(context.Background(), metric.Number(1), &desc)) @@ -271,7 +271,7 @@ func TestSumInt64DataPoints(t *testing.T) { } func TestSumFloat64DataPoints(t *testing.T) { - desc := metric.NewDescriptor("", metric.MeasureKind, metric.Float64NumberKind) + desc := metric.NewDescriptor("", metric.ValueRecorderKind, metric.Float64NumberKind) labels := label.NewSet() s := sumAgg.New() assert.NoError(t, s.Update(context.Background(), metric.NewFloat64Number(1), &desc)) @@ -285,7 +285,7 @@ func TestSumFloat64DataPoints(t *testing.T) { } func TestSumErrUnknownValueType(t *testing.T) { - desc := metric.NewDescriptor("", metric.MeasureKind, metric.NumberKind(-1)) + desc := metric.NewDescriptor("", metric.ValueRecorderKind, metric.NumberKind(-1)) labels := label.NewSet() s := sumAgg.New() _, err := sum(&desc, &labels, s) diff --git a/exporters/otlp/otlp_integration_test.go b/exporters/otlp/otlp_integration_test.go index 79121a292..624bd4a07 100644 --- a/exporters/otlp/otlp_integration_test.go +++ b/exporters/otlp/otlp_integration_test.go @@ -109,7 +109,7 @@ func newExporterEndToEndTest(t *testing.T, additionalOpts []otlp.ExporterOption) span.End() } - selector := simple.NewWithExactMeasure() + selector := simple.NewWithExactDistribution() integrator := integrator.New(selector, true) pusher := push.New(integrator, exp, 60*time.Second) pusher.Start() @@ -124,12 +124,12 @@ func newExporterEndToEndTest(t *testing.T, additionalOpts []otlp.ExporterOption) val int64 } instruments := map[string]data{ - "test-int64-counter": {metric.CounterKind, metricapi.Int64NumberKind, 1}, - "test-float64-counter": {metric.CounterKind, metricapi.Float64NumberKind, 1}, - "test-int64-measure": {metric.MeasureKind, metricapi.Int64NumberKind, 2}, - "test-float64-measure": {metric.MeasureKind, metricapi.Float64NumberKind, 2}, - "test-int64-observer": {metric.ObserverKind, metricapi.Int64NumberKind, 3}, - "test-float64-observer": {metric.ObserverKind, metricapi.Float64NumberKind, 3}, + "test-int64-counter": {metric.CounterKind, metricapi.Int64NumberKind, 1}, + "test-float64-counter": {metric.CounterKind, metricapi.Float64NumberKind, 1}, + "test-int64-valuerecorder": {metric.ValueRecorderKind, metricapi.Int64NumberKind, 2}, + "test-float64-valuerecorder": {metric.ValueRecorderKind, metricapi.Float64NumberKind, 2}, + "test-int64-observer": {metric.ObserverKind, metricapi.Int64NumberKind, 3}, + "test-float64-observer": {metric.ObserverKind, metricapi.Float64NumberKind, 3}, } for name, data := range instruments { switch data.iKind { @@ -142,12 +142,12 @@ func newExporterEndToEndTest(t *testing.T, additionalOpts []otlp.ExporterOption) default: assert.Failf(t, "unsupported number testing kind", data.nKind.String()) } - case metric.MeasureKind: + case metric.ValueRecorderKind: switch data.nKind { case metricapi.Int64NumberKind: - metricapi.Must(meter).NewInt64Measure(name).Record(ctx, data.val, labels...) + metricapi.Must(meter).NewInt64ValueRecorder(name).Record(ctx, data.val, labels...) case metricapi.Float64NumberKind: - metricapi.Must(meter).NewFloat64Measure(name).Record(ctx, float64(data.val), labels...) + metricapi.Must(meter).NewFloat64ValueRecorder(name).Record(ctx, float64(data.val), labels...) default: assert.Failf(t, "unsupported number testing kind", data.nKind.String()) } @@ -246,7 +246,7 @@ func newExporterEndToEndTest(t *testing.T, additionalOpts []otlp.ExporterOption) default: assert.Failf(t, "invalid number kind", data.nKind.String()) } - case metric.MeasureKind, metric.ObserverKind: + case metric.ValueRecorderKind, metric.ObserverKind: assert.Equal(t, metricpb.MetricDescriptor_SUMMARY.String(), desc.GetType().String()) m.GetSummaryDataPoints() if dp := m.GetSummaryDataPoints(); assert.Len(t, dp, 1) { diff --git a/exporters/otlp/otlp_metric_test.go b/exporters/otlp/otlp_metric_test.go index 0471d0add..4d72d541a 100644 --- a/exporters/otlp/otlp_metric_test.go +++ b/exporters/otlp/otlp_metric_test.go @@ -188,10 +188,10 @@ func TestNoGroupingExport(t *testing.T) { ) } -func TestMeasureMetricGroupingExport(t *testing.T) { +func TestValuerecorderMetricGroupingExport(t *testing.T) { r := record{ - "measure", - metric.MeasureKind, + "valuerecorder", + metric.ValueRecorderKind, metric.Int64NumberKind, nil, nil, @@ -205,7 +205,7 @@ func TestMeasureMetricGroupingExport(t *testing.T) { Metrics: []*metricpb.Metric{ { MetricDescriptor: &metricpb.MetricDescriptor{ - Name: "measure", + Name: "valuerecorder", Type: metricpb.MetricDescriptor_SUMMARY, Labels: []*commonpb.StringKeyValue{ { diff --git a/sdk/export/metric/aggregator/aggregator.go b/sdk/export/metric/aggregator/aggregator.go index df1285108..660e83ef3 100644 --- a/sdk/export/metric/aggregator/aggregator.go +++ b/sdk/export/metric/aggregator/aggregator.go @@ -116,7 +116,7 @@ func NewInconsistentMergeError(a1, a2 export.Aggregator) error { // RangeTest is a commmon routine for testing for valid input values. // This rejects NaN values. This rejects negative values when the // metric instrument does not support negative values, including -// monotonic counter metrics and absolute measure metrics. +// monotonic counter metrics and absolute ValueRecorder metrics. func RangeTest(number metric.Number, descriptor *metric.Descriptor) error { numberKind := descriptor.NumberKind() diff --git a/sdk/export/metric/aggregator/aggregator_test.go b/sdk/export/metric/aggregator/aggregator_test.go index 1907b92b7..0083a71a2 100644 --- a/sdk/export/metric/aggregator/aggregator_test.go +++ b/sdk/export/metric/aggregator/aggregator_test.go @@ -86,7 +86,7 @@ func TestNaNTest(t *testing.T) { t.Run(nkind.String(), func(t *testing.T) { for _, mkind := range []metric.Kind{ metric.CounterKind, - metric.MeasureKind, + metric.ValueRecorderKind, metric.ObserverKind, } { desc := metric.NewDescriptor( diff --git a/sdk/export/metric/metric.go b/sdk/export/metric/metric.go index 5b3a19a8f..c2d583173 100644 --- a/sdk/export/metric/metric.go +++ b/sdk/export/metric/metric.go @@ -100,22 +100,16 @@ type AggregationSelector interface { } // Aggregator implements a specific aggregation behavior, e.g., a -// behavior to track a sequence of updates to a counter, a measure, or -// an observer instrument. For the most part, counter semantics are -// fixed and the provided implementation should be used. Measure and -// observer metrics offer a wide range of potential tradeoffs and -// several implementations are provided. -// -// Aggregators are meant to compute the change (i.e., delta) in state -// from one checkpoint to the next, with the exception of LastValue -// aggregators. LastValue aggregators are required to maintain the last -// value across checkpoints. +// behavior to track a sequence of updates to an instrument. Sum-only +// instruments commonly use a simple Sum aggregator, but for the +// distribution instruments (ValueRecorder, ValueObserver) there are a +// number of possible aggregators with different cost and accuracy +// tradeoffs. // // Note that any Aggregator may be attached to any instrument--this is // the result of the OpenTelemetry API/SDK separation. It is possible -// to attach a counter aggregator to a Measure instrument (to compute -// a simple sum) or a LastValue aggregator to a measure instrument (to -// compute the last value). +// to attach a Sum aggregator to a ValueRecorder instrument or a +// MinMaxSumCount aggregator to a Counter instrument. type Aggregator interface { // Update receives a new measured value and incorporates it // into the aggregation. Update() calls may arrive diff --git a/sdk/metric/aggregator/array/array.go b/sdk/metric/aggregator/array/array.go index 38168bcc2..2d92a54fe 100644 --- a/sdk/metric/aggregator/array/array.go +++ b/sdk/metric/aggregator/array/array.go @@ -27,6 +27,8 @@ import ( ) type ( + // Aggregator aggregates events that form a distribution, keeping + // an array with the exact set of values. Aggregator struct { // ckptSum needs to be aligned for 64-bit atomic operations. ckptSum metric.Number diff --git a/sdk/metric/aggregator/array/array_test.go b/sdk/metric/aggregator/array/array_test.go index 87ea6d98f..2c3efb706 100644 --- a/sdk/metric/aggregator/array/array_test.go +++ b/sdk/metric/aggregator/array/array_test.go @@ -50,7 +50,7 @@ type updateTest struct { } func (ut *updateTest) run(t *testing.T, profile test.Profile) { - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg := New() @@ -118,7 +118,7 @@ type mergeTest struct { func (mt *mergeTest) run(t *testing.T, profile test.Profile) { ctx := context.Background() - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg1 := New() agg2 := New() @@ -215,7 +215,7 @@ func TestArrayErrors(t *testing.T) { ctx := context.Background() - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) test.CheckedUpdate(t, agg, metric.Number(0), descriptor) @@ -243,7 +243,7 @@ func TestArrayErrors(t *testing.T) { } func TestArrayFloat64(t *testing.T) { - descriptor := test.NewAggregatorTest(metric.MeasureKind, metric.Float64NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, metric.Float64NumberKind) fpsf := func(sign int) []float64 { // Check behavior of a bunch of odd floating diff --git a/sdk/metric/aggregator/ddsketch/ddsketch.go b/sdk/metric/aggregator/ddsketch/ddsketch.go index a6b95da15..197d95e4d 100644 --- a/sdk/metric/aggregator/ddsketch/ddsketch.go +++ b/sdk/metric/aggregator/ddsketch/ddsketch.go @@ -29,7 +29,7 @@ import ( // Config is an alias for the underlying DDSketch config object. type Config = sdk.Config -// Aggregator aggregates measure events. +// Aggregator aggregates events into a distribution. type Aggregator struct { lock sync.Mutex cfg *Config diff --git a/sdk/metric/aggregator/ddsketch/ddsketch_test.go b/sdk/metric/aggregator/ddsketch/ddsketch_test.go index 22a39b568..cc68359de 100644 --- a/sdk/metric/aggregator/ddsketch/ddsketch_test.go +++ b/sdk/metric/aggregator/ddsketch/ddsketch_test.go @@ -33,7 +33,7 @@ type updateTest struct { func (ut *updateTest) run(t *testing.T, profile test.Profile) { ctx := context.Background() - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg := New(NewDefaultConfig(), descriptor) all := test.NewNumbers(profile.NumberKind) @@ -92,7 +92,7 @@ type mergeTest struct { func (mt *mergeTest) run(t *testing.T, profile test.Profile) { ctx := context.Background() - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg1 := New(NewDefaultConfig(), descriptor) agg2 := New(NewDefaultConfig(), descriptor) diff --git a/sdk/metric/aggregator/histogram/histogram.go b/sdk/metric/aggregator/histogram/histogram.go index f861d9651..6566dab91 100644 --- a/sdk/metric/aggregator/histogram/histogram.go +++ b/sdk/metric/aggregator/histogram/histogram.go @@ -51,7 +51,7 @@ var _ aggregator.Sum = &Aggregator{} var _ aggregator.Count = &Aggregator{} var _ aggregator.Histogram = &Aggregator{} -// New returns a new measure aggregator for computing Histograms. +// New returns a new aggregator for computing Histograms. // // A Histogram observe events and counts them in pre-defined buckets. // And also provides the total sum and count of all observations. diff --git a/sdk/metric/aggregator/histogram/histogram_test.go b/sdk/metric/aggregator/histogram/histogram_test.go index 53aa1250b..6a559cec3 100644 --- a/sdk/metric/aggregator/histogram/histogram_test.go +++ b/sdk/metric/aggregator/histogram/histogram_test.go @@ -84,7 +84,7 @@ func TestHistogramPositiveAndNegative(t *testing.T) { // Validates count, sum and buckets for a given profile and policy func histogram(t *testing.T, profile test.Profile, policy policy) { ctx := context.Background() - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg := New(descriptor, boundaries[profile.NumberKind]) @@ -126,7 +126,7 @@ func TestHistogramMerge(t *testing.T) { ctx := context.Background() test.RunProfiles(t, func(t *testing.T, profile test.Profile) { - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg1 := New(descriptor, boundaries[profile.NumberKind]) agg2 := New(descriptor, boundaries[profile.NumberKind]) @@ -178,7 +178,7 @@ func TestHistogramNotSet(t *testing.T) { ctx := context.Background() test.RunProfiles(t, func(t *testing.T, profile test.Profile) { - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg := New(descriptor, boundaries[profile.NumberKind]) agg.Checkpoint(ctx, descriptor) diff --git a/sdk/metric/aggregator/minmaxsumcount/mmsc.go b/sdk/metric/aggregator/minmaxsumcount/mmsc.go index 1c840a158..a66bec496 100644 --- a/sdk/metric/aggregator/minmaxsumcount/mmsc.go +++ b/sdk/metric/aggregator/minmaxsumcount/mmsc.go @@ -24,8 +24,8 @@ import ( ) type ( - // Aggregator aggregates measure events, keeping only the min, max, - // sum, and count. + // Aggregator aggregates events that form a distribution, + // keeping only the min, max, sum, and count. Aggregator struct { lock sync.Mutex current state @@ -44,8 +44,9 @@ type ( var _ export.Aggregator = &Aggregator{} var _ aggregator.MinMaxSumCount = &Aggregator{} -// New returns a new measure aggregator for computing min, max, sum, and -// count. It does not compute quantile information other than Min and Max. +// New returns a new aggregator for computing the min, max, sum, and +// count. It does not compute quantile information other than Min and +// Max. // // This type uses a mutex for Update() and Checkpoint() concurrency. func New(desc *metric.Descriptor) *Aggregator { diff --git a/sdk/metric/aggregator/minmaxsumcount/mmsc_test.go b/sdk/metric/aggregator/minmaxsumcount/mmsc_test.go index 50c2fa5fc..d01916b8e 100644 --- a/sdk/metric/aggregator/minmaxsumcount/mmsc_test.go +++ b/sdk/metric/aggregator/minmaxsumcount/mmsc_test.go @@ -79,7 +79,7 @@ func TestMinMaxSumCountPositiveAndNegative(t *testing.T) { // Validates min, max, sum and count for a given profile and policy func minMaxSumCount(t *testing.T, profile test.Profile, policy policy) { ctx := context.Background() - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg := New(descriptor) @@ -127,7 +127,7 @@ func TestMinMaxSumCountMerge(t *testing.T) { ctx := context.Background() test.RunProfiles(t, func(t *testing.T, profile test.Profile) { - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg1 := New(descriptor) agg2 := New(descriptor) @@ -185,7 +185,7 @@ func TestMaxSumCountNotSet(t *testing.T) { ctx := context.Background() test.RunProfiles(t, func(t *testing.T, profile test.Profile) { - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) agg := New(descriptor) agg.Checkpoint(ctx, descriptor) diff --git a/sdk/metric/aggregator/sum/sum_test.go b/sdk/metric/aggregator/sum/sum_test.go index acd37e9ab..617254d2c 100644 --- a/sdk/metric/aggregator/sum/sum_test.go +++ b/sdk/metric/aggregator/sum/sum_test.go @@ -71,13 +71,13 @@ func TestCounterSum(t *testing.T) { }) } -func TestMeasureSum(t *testing.T) { +func TestValueRecorderSum(t *testing.T) { ctx := context.Background() test.RunProfiles(t, func(t *testing.T, profile test.Profile) { agg := New() - descriptor := test.NewAggregatorTest(metric.MeasureKind, profile.NumberKind) + descriptor := test.NewAggregatorTest(metric.ValueRecorderKind, profile.NumberKind) sum := metric.Number(0) diff --git a/sdk/metric/benchmark_test.go b/sdk/metric/benchmark_test.go index 9cbc1a578..06c8a980b 100644 --- a/sdk/metric/benchmark_test.go +++ b/sdk/metric/benchmark_test.go @@ -311,7 +311,7 @@ func BenchmarkInt64LastValueAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewInt64Measure("int64.lastvalue") + mea := fix.meter.NewInt64ValueRecorder("int64.lastvalue") b.ResetTimer() @@ -324,7 +324,7 @@ func BenchmarkInt64LastValueHandleAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewInt64Measure("int64.lastvalue") + mea := fix.meter.NewInt64ValueRecorder("int64.lastvalue") handle := mea.Bind(labs...) b.ResetTimer() @@ -338,7 +338,7 @@ func BenchmarkFloat64LastValueAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewFloat64Measure("float64.lastvalue") + mea := fix.meter.NewFloat64ValueRecorder("float64.lastvalue") b.ResetTimer() @@ -351,7 +351,7 @@ func BenchmarkFloat64LastValueHandleAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewFloat64Measure("float64.lastvalue") + mea := fix.meter.NewFloat64ValueRecorder("float64.lastvalue") handle := mea.Bind(labs...) b.ResetTimer() @@ -361,13 +361,13 @@ func BenchmarkFloat64LastValueHandleAdd(b *testing.B) { } } -// Measures +// ValueRecorders -func benchmarkInt64MeasureAdd(b *testing.B, name string) { +func benchmarkInt64ValueRecorderAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewInt64Measure(name) + mea := fix.meter.NewInt64ValueRecorder(name) b.ResetTimer() @@ -376,11 +376,11 @@ func benchmarkInt64MeasureAdd(b *testing.B, name string) { } } -func benchmarkInt64MeasureHandleAdd(b *testing.B, name string) { +func benchmarkInt64ValueRecorderHandleAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewInt64Measure(name) + mea := fix.meter.NewInt64ValueRecorder(name) handle := mea.Bind(labs...) b.ResetTimer() @@ -390,11 +390,11 @@ func benchmarkInt64MeasureHandleAdd(b *testing.B, name string) { } } -func benchmarkFloat64MeasureAdd(b *testing.B, name string) { +func benchmarkFloat64ValueRecorderAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewFloat64Measure(name) + mea := fix.meter.NewFloat64ValueRecorder(name) b.ResetTimer() @@ -403,11 +403,11 @@ func benchmarkFloat64MeasureAdd(b *testing.B, name string) { } } -func benchmarkFloat64MeasureHandleAdd(b *testing.B, name string) { +func benchmarkFloat64ValueRecorderHandleAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) - mea := fix.meter.NewFloat64Measure(name) + mea := fix.meter.NewFloat64ValueRecorder(name) handle := mea.Bind(labs...) b.ResetTimer() @@ -467,55 +467,55 @@ func BenchmarkObserverObservationFloat64(b *testing.B) { // MaxSumCount func BenchmarkInt64MaxSumCountAdd(b *testing.B) { - benchmarkInt64MeasureAdd(b, "int64.minmaxsumcount") + benchmarkInt64ValueRecorderAdd(b, "int64.minmaxsumcount") } func BenchmarkInt64MaxSumCountHandleAdd(b *testing.B) { - benchmarkInt64MeasureHandleAdd(b, "int64.minmaxsumcount") + benchmarkInt64ValueRecorderHandleAdd(b, "int64.minmaxsumcount") } func BenchmarkFloat64MaxSumCountAdd(b *testing.B) { - benchmarkFloat64MeasureAdd(b, "float64.minmaxsumcount") + benchmarkFloat64ValueRecorderAdd(b, "float64.minmaxsumcount") } func BenchmarkFloat64MaxSumCountHandleAdd(b *testing.B) { - benchmarkFloat64MeasureHandleAdd(b, "float64.minmaxsumcount") + benchmarkFloat64ValueRecorderHandleAdd(b, "float64.minmaxsumcount") } // DDSketch func BenchmarkInt64DDSketchAdd(b *testing.B) { - benchmarkInt64MeasureAdd(b, "int64.ddsketch") + benchmarkInt64ValueRecorderAdd(b, "int64.ddsketch") } func BenchmarkInt64DDSketchHandleAdd(b *testing.B) { - benchmarkInt64MeasureHandleAdd(b, "int64.ddsketch") + benchmarkInt64ValueRecorderHandleAdd(b, "int64.ddsketch") } func BenchmarkFloat64DDSketchAdd(b *testing.B) { - benchmarkFloat64MeasureAdd(b, "float64.ddsketch") + benchmarkFloat64ValueRecorderAdd(b, "float64.ddsketch") } func BenchmarkFloat64DDSketchHandleAdd(b *testing.B) { - benchmarkFloat64MeasureHandleAdd(b, "float64.ddsketch") + benchmarkFloat64ValueRecorderHandleAdd(b, "float64.ddsketch") } // Array func BenchmarkInt64ArrayAdd(b *testing.B) { - benchmarkInt64MeasureAdd(b, "int64.array") + benchmarkInt64ValueRecorderAdd(b, "int64.array") } func BenchmarkInt64ArrayHandleAdd(b *testing.B) { - benchmarkInt64MeasureHandleAdd(b, "int64.array") + benchmarkInt64ValueRecorderHandleAdd(b, "int64.array") } func BenchmarkFloat64ArrayAdd(b *testing.B) { - benchmarkFloat64MeasureAdd(b, "float64.array") + benchmarkFloat64ValueRecorderAdd(b, "float64.array") } func BenchmarkFloat64ArrayHandleAdd(b *testing.B) { - benchmarkFloat64MeasureHandleAdd(b, "float64.array") + benchmarkFloat64ValueRecorderHandleAdd(b, "float64.array") } // BatchRecord diff --git a/sdk/metric/correct_test.go b/sdk/metric/correct_test.go index 02174b877..e26aa630a 100644 --- a/sdk/metric/correct_test.go +++ b/sdk/metric/correct_test.go @@ -107,7 +107,7 @@ func TestInputRangeTestCounter(t *testing.T) { require.Nil(t, sdkErr) } -func TestInputRangeTestMeasure(t *testing.T) { +func TestInputRangeTestValueRecorder(t *testing.T) { ctx := context.Background() integrator := &correctnessIntegrator{ t: t, @@ -120,17 +120,17 @@ func TestInputRangeTestMeasure(t *testing.T) { sdkErr = handleErr }) - measure := Must(meter).NewFloat64Measure("name.measure") + valuerecorder := Must(meter).NewFloat64ValueRecorder("name.valuerecorder") - measure.Record(ctx, math.NaN()) + valuerecorder.Record(ctx, math.NaN()) require.Equal(t, aggregator.ErrNaNInput, sdkErr) sdkErr = nil checkpointed := sdk.Collect(ctx) require.Equal(t, 0, checkpointed) - measure.Record(ctx, 1) - measure.Record(ctx, 2) + valuerecorder.Record(ctx, 1) + valuerecorder.Record(ctx, 2) integrator.records = nil checkpointed = sdk.Collect(ctx) @@ -150,9 +150,9 @@ func TestDisabledInstrument(t *testing.T) { sdk := metricsdk.NewAccumulator(integrator) meter := metric.WrapMeterImpl(sdk, "test") - measure := Must(meter).NewFloat64Measure("name.disabled") + valuerecorder := Must(meter).NewFloat64ValueRecorder("name.disabled") - measure.Record(ctx, -1) + valuerecorder.Record(ctx, -1) checkpointed := sdk.Collect(ctx) require.Equal(t, 0, checkpointed) @@ -389,8 +389,8 @@ func TestRecordBatch(t *testing.T) { counter1 := Must(meter).NewInt64Counter("int64.counter") counter2 := Must(meter).NewFloat64Counter("float64.counter") - measure1 := Must(meter).NewInt64Measure("int64.measure") - measure2 := Must(meter).NewFloat64Measure("float64.measure") + valuerecorder1 := Must(meter).NewInt64ValueRecorder("int64.valuerecorder") + valuerecorder2 := Must(meter).NewFloat64ValueRecorder("float64.valuerecorder") sdk.RecordBatch( ctx, @@ -400,8 +400,8 @@ func TestRecordBatch(t *testing.T) { }, counter1.Measurement(1), counter2.Measurement(2), - measure1.Measurement(3), - measure2.Measurement(4), + valuerecorder1.Measurement(3), + valuerecorder2.Measurement(4), ) sdk.Collect(ctx) @@ -411,10 +411,10 @@ func TestRecordBatch(t *testing.T) { _ = out.AddTo(rec) } require.EqualValues(t, map[string]float64{ - "int64.counter/A=B,C=D": 1, - "float64.counter/A=B,C=D": 2, - "int64.measure/A=B,C=D": 3, - "float64.measure/A=B,C=D": 4, + "int64.counter/A=B,C=D": 1, + "float64.counter/A=B,C=D": 2, + "int64.valuerecorder/A=B,C=D": 3, + "float64.valuerecorder/A=B,C=D": 4, }, out.Map) } diff --git a/sdk/metric/doc.go b/sdk/metric/doc.go index cee67d00b..1ad5edc7d 100644 --- a/sdk/metric/doc.go +++ b/sdk/metric/doc.go @@ -13,57 +13,34 @@ // limitations under the License. /* -Package metric implements the OpenTelemetry metric.Meter API. The SDK -supports configurable metrics export behavior through a collection of -export interfaces that support various export strategies, described below. +Package metric implements the OpenTelemetry metric.MeterImpl +interface. The Accumulator type supports configurable metrics export +behavior through a collection of export interfaces that support +various export strategies, described below. -The metric.Meter API consists of methods for constructing each of the basic -kinds of metric instrument. There are six types of instrument available to -the end user, comprised of three basic kinds of metric instrument (Counter, -Measure, Observer) crossed with two kinds of number (int64, float64). +The metric.MeterImpl API consists of methods for constructing +synchronous and asynchronous instruments. There are two constructors +per instrument for the two kinds of number (int64, float64). -The API assists the SDK by consolidating the variety of metric instruments -into a narrower interface, allowing the SDK to avoid repetition of -boilerplate. The API and SDK are separated such that an event reaching -the SDK has a uniform structure: an instrument, a label set, and a -numerical value. +Synchronous instruments are managed by a sync.Map containing a *record +with the current state for each synchronous instrument. A bound +instrument encapsulates a direct pointer to the record, allowing +bound metric events to bypass a sync.Map lookup. A lock-free +algorithm is used to protect against races when adding and removing +items from the sync.Map. -To this end, the API uses a kv.Number type to represent either an int64 -or a float64, depending on the instrument's definition. A single -implementation interface is used for counter and measure instruments, -metric.InstrumentImpl, and a single implementation interface is used for -their handles, metric.HandleImpl. For observers, the API defines -interfaces, for which the SDK provides an implementation. - -There are four entry points for events in the Metrics API - three for -synchronous instruments (counters and measures) and one for asynchronous -instruments (observers). The entry points for synchronous instruments are: -via instrument handles, via direct instrument calls, and via BatchRecord. -The SDK is designed with handles as the primary entry point, the other two -entry points are implemented in terms of short-lived handles. For example, -the implementation of a direct call allocates a handle, operates on the -handle, and releases the handle. Similarly, the implementation of -RecordBatch uses a short-lived handle for each measurement in the batch. -The entry point for asynchronous instruments is via observer callbacks. -Observer callbacks behave like a set of instrument handles - one for each -observation for a distinct label set. The observer handles are alive as -long as they are used. If the callback stops reporting values for a -certain label set, the associated handle is dropped. +Asynchronous instruments are managed by an internal +AsyncInstrumentState, which coordinates calling batch and single +instrument callbacks. Internal Structure -The SDK is designed with minimal use of locking, to avoid adding -contention for user-level code. For each handle, whether it is held by -user-level code or a short-lived device, there exists an internal record -managed by the SDK. Each internal record corresponds to a specific -instrument and label set combination. - Each observer also has its own kind of record stored in the SDK. This record contains a set of recorders for every specific label set used in the callback. A sync.Map maintains the mapping of current instruments and label sets to -internal records. To create a new handle, the SDK consults the Map to +internal records. To create a new bound instrument, the SDK consults the Map to locate an existing record, otherwise it constructs a new record. The SDK maintains a count of the number of references to each record, ensuring that records are not reclaimed from the Map while they are still active @@ -74,12 +51,7 @@ sweeps through all records in the SDK, checkpointing their state. When a record is discovered that has no references and has not been updated since the prior collection pass, it is removed from the Map. -The SDK maintains a current epoch number, corresponding to the number of -completed collections. Each recorder of an observer record contains the -last epoch during which it was updated. This variable allows the collection -code path to detect stale recorders and remove them. - -Each record of a handle and recorder of an observer has an associated +Both synchronous and asynchronous instruments have an associated aggregator, which maintains the current state resulting from all metric events since its last checkpoint. Aggregators may be lock-free or they may use locking, but they should expect to be called concurrently. Aggregators @@ -97,21 +69,18 @@ enters the SDK resulting in a new record, and collection context, where a system-level thread performs a collection pass through the SDK. -Descriptor is a struct that describes the metric instrument to the export -pipeline, containing the name, recommended aggregation keys, units, -description, metric kind (counter or measure), number kind (int64 or -float64), and whether the instrument has alternate semantics or not (i.e., -monotonic=false counter, absolute=false measure). A Descriptor accompanies -metric data as it passes through the export pipeline. +Descriptor is a struct that describes the metric instrument to the +export pipeline, containing the name, units, description, metric kind, +number kind (int64 or float64). A Descriptor accompanies metric data +as it passes through the export pipeline. The AggregationSelector interface supports choosing the method of aggregation to apply to a particular instrument. Given the Descriptor, this AggregatorFor method returns an implementation of Aggregator. If this interface returns nil, the metric will be disabled. The aggregator should be matched to the capabilities of the exporter. Selecting the aggregator -for counter instruments is relatively straightforward, but for measure and -observer instruments there are numerous choices with different cost and -quality tradeoffs. +for sum-only instruments is relatively straightforward, but many options +are available for aggregating distributions from ValueRecorder instruments. Aggregator is an interface which implements a concrete strategy for aggregating metric updates. Several Aggregator implementations are diff --git a/sdk/metric/histogram_stress_test.go b/sdk/metric/histogram_stress_test.go index 4a40823ef..d05536622 100644 --- a/sdk/metric/histogram_stress_test.go +++ b/sdk/metric/histogram_stress_test.go @@ -25,7 +25,7 @@ import ( ) func TestStressInt64Histogram(t *testing.T) { - desc := metric.NewDescriptor("some_metric", metric.MeasureKind, metric.Int64NumberKind) + desc := metric.NewDescriptor("some_metric", metric.ValueRecorderKind, metric.Int64NumberKind) h := histogram.New(&desc, []metric.Number{metric.NewInt64Number(25), metric.NewInt64Number(50), metric.NewInt64Number(75)}) ctx, cancelFunc := context.WithCancel(context.Background()) diff --git a/sdk/metric/minmaxsumcount_stress_test.go b/sdk/metric/minmaxsumcount_stress_test.go index ecec40564..0b51f66a6 100644 --- a/sdk/metric/minmaxsumcount_stress_test.go +++ b/sdk/metric/minmaxsumcount_stress_test.go @@ -25,7 +25,7 @@ import ( ) func TestStressInt64MinMaxSumCount(t *testing.T) { - desc := metric.NewDescriptor("some_metric", metric.MeasureKind, metric.Int64NumberKind) + desc := metric.NewDescriptor("some_metric", metric.ValueRecorderKind, metric.Int64NumberKind) mmsc := minmaxsumcount.New(&desc) ctx, cancel := context.WithCancel(context.Background()) diff --git a/sdk/metric/selector/simple/simple.go b/sdk/metric/selector/simple/simple.go index e8929f093..3f7517585 100644 --- a/sdk/metric/selector/simple/simple.go +++ b/sdk/metric/selector/simple/simple.go @@ -42,40 +42,40 @@ var ( _ export.AggregationSelector = selectorHistogram{} ) -// NewWithInexpensiveMeasure returns a simple aggregation selector +// NewWithInexpensiveDistribution returns a simple aggregation selector // that uses counter, minmaxsumcount and minmaxsumcount aggregators // for the three kinds of metric. This selector is faster and uses // less memory than the others because minmaxsumcount does not // aggregate quantile information. -func NewWithInexpensiveMeasure() export.AggregationSelector { +func NewWithInexpensiveDistribution() export.AggregationSelector { return selectorInexpensive{} } -// NewWithSketchMeasure returns a simple aggregation selector that +// NewWithSketchDistribution returns a simple aggregation selector that // uses counter, ddsketch, and ddsketch aggregators for the three // kinds of metric. This selector uses more cpu and memory than the -// NewWithInexpensiveMeasure because it uses one DDSketch per distinct -// measure/observer and labelset. -func NewWithSketchMeasure(config *ddsketch.Config) export.AggregationSelector { +// NewWithInexpensiveDistribution because it uses one DDSketch per distinct +// instrument and label set. +func NewWithSketchDistribution(config *ddsketch.Config) export.AggregationSelector { return selectorSketch{ config: config, } } -// NewWithExactMeasure returns a simple aggregation selector that uses +// NewWithExactDistribution returns a simple aggregation selector that uses // counter, array, and array aggregators for the three kinds of metric. -// This selector uses more memory than the NewWithSketchMeasure +// This selector uses more memory than the NewWithSketchDistribution // because it aggregates an array of all values, therefore is able to // compute exact quantiles. -func NewWithExactMeasure() export.AggregationSelector { +func NewWithExactDistribution() export.AggregationSelector { return selectorExact{} } -// NewWithHistogramMeasure returns a simple aggregation selector that uses counter, +// NewWithHistogramDistribution returns a simple aggregation selector that uses counter, // histogram, and histogram aggregators for the three kinds of metric. This -// selector uses more memory than the NewWithInexpensiveMeasure because it +// selector uses more memory than the NewWithInexpensiveDistribution because it // uses a counter per bucket. -func NewWithHistogramMeasure(boundaries []metric.Number) export.AggregationSelector { +func NewWithHistogramDistribution(boundaries []metric.Number) export.AggregationSelector { return selectorHistogram{boundaries: boundaries} } @@ -83,7 +83,7 @@ func (selectorInexpensive) AggregatorFor(descriptor *metric.Descriptor) export.A switch descriptor.MetricKind() { case metric.ObserverKind: fallthrough - case metric.MeasureKind: + case metric.ValueRecorderKind: return minmaxsumcount.New(descriptor) default: return sum.New() @@ -94,7 +94,7 @@ func (s selectorSketch) AggregatorFor(descriptor *metric.Descriptor) export.Aggr switch descriptor.MetricKind() { case metric.ObserverKind: fallthrough - case metric.MeasureKind: + case metric.ValueRecorderKind: return ddsketch.New(s.config, descriptor) default: return sum.New() @@ -105,7 +105,7 @@ func (selectorExact) AggregatorFor(descriptor *metric.Descriptor) export.Aggrega switch descriptor.MetricKind() { case metric.ObserverKind: fallthrough - case metric.MeasureKind: + case metric.ValueRecorderKind: return array.New() default: return sum.New() @@ -116,7 +116,7 @@ func (s selectorHistogram) AggregatorFor(descriptor *metric.Descriptor) export.A switch descriptor.MetricKind() { case metric.ObserverKind: fallthrough - case metric.MeasureKind: + case metric.ValueRecorderKind: return histogram.New(descriptor, s.boundaries) default: return sum.New() diff --git a/sdk/metric/selector/simple/simple_test.go b/sdk/metric/selector/simple/simple_test.go index 0f79df535..a80c62ac2 100644 --- a/sdk/metric/selector/simple/simple_test.go +++ b/sdk/metric/selector/simple/simple_test.go @@ -29,35 +29,35 @@ import ( ) var ( - testCounterDesc = metric.NewDescriptor("counter", metric.CounterKind, metric.Int64NumberKind) - testMeasureDesc = metric.NewDescriptor("measure", metric.MeasureKind, metric.Int64NumberKind) - testObserverDesc = metric.NewDescriptor("observer", metric.ObserverKind, metric.Int64NumberKind) + testCounterDesc = metric.NewDescriptor("counter", metric.CounterKind, metric.Int64NumberKind) + testValueRecorderDesc = metric.NewDescriptor("valuerecorder", metric.ValueRecorderKind, metric.Int64NumberKind) + testObserverDesc = metric.NewDescriptor("observer", metric.ObserverKind, metric.Int64NumberKind) ) -func TestInexpensiveMeasure(t *testing.T) { - inex := simple.NewWithInexpensiveMeasure() +func TestInexpensiveDistribution(t *testing.T) { + inex := simple.NewWithInexpensiveDistribution() require.NotPanics(t, func() { _ = inex.AggregatorFor(&testCounterDesc).(*sum.Aggregator) }) - require.NotPanics(t, func() { _ = inex.AggregatorFor(&testMeasureDesc).(*minmaxsumcount.Aggregator) }) + require.NotPanics(t, func() { _ = inex.AggregatorFor(&testValueRecorderDesc).(*minmaxsumcount.Aggregator) }) require.NotPanics(t, func() { _ = inex.AggregatorFor(&testObserverDesc).(*minmaxsumcount.Aggregator) }) } -func TestSketchMeasure(t *testing.T) { - sk := simple.NewWithSketchMeasure(ddsketch.NewDefaultConfig()) +func TestSketchDistribution(t *testing.T) { + sk := simple.NewWithSketchDistribution(ddsketch.NewDefaultConfig()) require.NotPanics(t, func() { _ = sk.AggregatorFor(&testCounterDesc).(*sum.Aggregator) }) - require.NotPanics(t, func() { _ = sk.AggregatorFor(&testMeasureDesc).(*ddsketch.Aggregator) }) + require.NotPanics(t, func() { _ = sk.AggregatorFor(&testValueRecorderDesc).(*ddsketch.Aggregator) }) require.NotPanics(t, func() { _ = sk.AggregatorFor(&testObserverDesc).(*ddsketch.Aggregator) }) } -func TestExactMeasure(t *testing.T) { - ex := simple.NewWithExactMeasure() +func TestExactDistribution(t *testing.T) { + ex := simple.NewWithExactDistribution() require.NotPanics(t, func() { _ = ex.AggregatorFor(&testCounterDesc).(*sum.Aggregator) }) - require.NotPanics(t, func() { _ = ex.AggregatorFor(&testMeasureDesc).(*array.Aggregator) }) + require.NotPanics(t, func() { _ = ex.AggregatorFor(&testValueRecorderDesc).(*array.Aggregator) }) require.NotPanics(t, func() { _ = ex.AggregatorFor(&testObserverDesc).(*array.Aggregator) }) } -func TestHistogramMeasure(t *testing.T) { - ex := simple.NewWithHistogramMeasure([]metric.Number{}) +func TestHistogramDistribution(t *testing.T) { + ex := simple.NewWithHistogramDistribution([]metric.Number{}) require.NotPanics(t, func() { _ = ex.AggregatorFor(&testCounterDesc).(*sum.Aggregator) }) - require.NotPanics(t, func() { _ = ex.AggregatorFor(&testMeasureDesc).(*histogram.Aggregator) }) + require.NotPanics(t, func() { _ = ex.AggregatorFor(&testValueRecorderDesc).(*histogram.Aggregator) }) require.NotPanics(t, func() { _ = ex.AggregatorFor(&testObserverDesc).(*histogram.Aggregator) }) } diff --git a/sdk/metric/stress_test.go b/sdk/metric/stress_test.go index 7e15e1594..7bdd72432 100644 --- a/sdk/metric/stress_test.go +++ b/sdk/metric/stress_test.go @@ -285,7 +285,7 @@ func (f *testFixture) Process(_ context.Context, record export.Record) error { f.T.Fatal("Sum error: ", err) } f.impl.storeCollect(actual, sum, time.Time{}) - case metric.MeasureKind: + case metric.ValueRecorderKind: lv, ts, err := agg.(aggregator.LastValue).LastValue() if err != nil && err != aggregator.ErrNoData { f.T.Fatal("Last value error: ", err) @@ -431,15 +431,15 @@ func TestStressFloat64Counter(t *testing.T) { func intLastValueTestImpl() testImpl { return testImpl{ newInstrument: func(meter api.Meter, name string) SyncImpler { - return Must(meter).NewInt64Measure(name + ".lastvalue") + return Must(meter).NewInt64ValueRecorder(name + ".lastvalue") }, getUpdateValue: func() api.Number { r1 := rand.Int63() return api.NewInt64Number(rand.Int63() - r1) }, operate: func(inst interface{}, ctx context.Context, value api.Number, labels []kv.KeyValue) { - measure := inst.(api.Int64Measure) - measure.Record(ctx, value.AsInt64(), labels...) + valuerecorder := inst.(api.Int64ValueRecorder) + valuerecorder.Record(ctx, value.AsInt64(), labels...) }, newStore: func() interface{} { return &lastValueState{ @@ -473,14 +473,14 @@ func TestStressInt64LastValue(t *testing.T) { func floatLastValueTestImpl() testImpl { return testImpl{ newInstrument: func(meter api.Meter, name string) SyncImpler { - return Must(meter).NewFloat64Measure(name + ".lastvalue") + return Must(meter).NewFloat64ValueRecorder(name + ".lastvalue") }, getUpdateValue: func() api.Number { return api.NewFloat64Number((-0.5 + rand.Float64()) * 100000) }, operate: func(inst interface{}, ctx context.Context, value api.Number, labels []kv.KeyValue) { - measure := inst.(api.Float64Measure) - measure.Record(ctx, value.AsFloat64(), labels...) + valuerecorder := inst.(api.Float64ValueRecorder) + valuerecorder.Record(ctx, value.AsFloat64(), labels...) }, newStore: func() interface{} { return &lastValueState{