// 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_test import ( "context" "fmt" "math/rand" "testing" "go.opentelemetry.io/otel/api/global" "go.opentelemetry.io/otel/api/kv" "go.opentelemetry.io/otel/api/label" "go.opentelemetry.io/otel/api/metric" export "go.opentelemetry.io/otel/sdk/export/metric" sdk "go.opentelemetry.io/otel/sdk/metric" "go.opentelemetry.io/otel/sdk/metric/processor/test" ) type benchFixture struct { meter metric.Meter accumulator *sdk.Accumulator B *testing.B export.AggregatorSelector } func newFixture(b *testing.B) *benchFixture { b.ReportAllocs() bf := &benchFixture{ B: b, AggregatorSelector: test.AggregatorSelector(), } bf.accumulator = sdk.NewAccumulator(bf) bf.meter = metric.WrapMeterImpl(bf.accumulator, "benchmarks") return bf } func (f *benchFixture) Process(export.Accumulation) error { return nil } func (f *benchFixture) Meter(_ string, _ ...metric.MeterOption) metric.Meter { return f.meter } func (f *benchFixture) meterMust() metric.MeterMust { return metric.Must(f.meter) } func makeManyLabels(n int) [][]kv.KeyValue { r := make([][]kv.KeyValue, n) for i := 0; i < n; i++ { r[i] = makeLabels(1) } return r } func makeLabels(n int) []kv.KeyValue { used := map[string]bool{} l := make([]kv.KeyValue, n) for i := 0; i < n; i++ { var k string for { k = fmt.Sprint("k", rand.Intn(1000000000)) if !used[k] { used[k] = true break } } l[i] = kv.Key(k).String(fmt.Sprint("v", rand.Intn(1000000000))) } return l } func benchmarkLabels(b *testing.B, n int) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(n) cnt := fix.meterMust().NewInt64Counter("int64.counter") b.ResetTimer() for i := 0; i < b.N; i++ { cnt.Add(ctx, 1, labs...) } } func BenchmarkInt64CounterAddWithLabels_1(b *testing.B) { benchmarkLabels(b, 1) } func BenchmarkInt64CounterAddWithLabels_2(b *testing.B) { benchmarkLabels(b, 2) } func BenchmarkInt64CounterAddWithLabels_4(b *testing.B) { benchmarkLabels(b, 4) } func BenchmarkInt64CounterAddWithLabels_8(b *testing.B) { benchmarkLabels(b, 8) } func BenchmarkInt64CounterAddWithLabels_16(b *testing.B) { benchmarkLabels(b, 16) } // Note: performance does not depend on label set size for the // benchmarks below--all are benchmarked for a single label. func BenchmarkAcquireNewHandle(b *testing.B) { fix := newFixture(b) labelSets := makeManyLabels(b.N) cnt := fix.meterMust().NewInt64Counter("int64.counter") b.ResetTimer() for i := 0; i < b.N; i++ { cnt.Bind(labelSets[i]...) } } func BenchmarkAcquireExistingHandle(b *testing.B) { fix := newFixture(b) labelSets := makeManyLabels(b.N) cnt := fix.meterMust().NewInt64Counter("int64.counter") for i := 0; i < b.N; i++ { cnt.Bind(labelSets[i]...).Unbind() } b.ResetTimer() for i := 0; i < b.N; i++ { cnt.Bind(labelSets[i]...) } } func BenchmarkAcquireReleaseExistingHandle(b *testing.B) { fix := newFixture(b) labelSets := makeManyLabels(b.N) cnt := fix.meterMust().NewInt64Counter("int64.counter") for i := 0; i < b.N; i++ { cnt.Bind(labelSets[i]...).Unbind() } b.ResetTimer() for i := 0; i < b.N; i++ { cnt.Bind(labelSets[i]...).Unbind() } } // Iterators var benchmarkIteratorVar kv.KeyValue func benchmarkIterator(b *testing.B, n int) { labels := label.NewSet(makeLabels(n)...) b.ResetTimer() for i := 0; i < b.N; i++ { iter := labels.Iter() for iter.Next() { benchmarkIteratorVar = iter.Label() } } } func BenchmarkIterator_0(b *testing.B) { benchmarkIterator(b, 0) } func BenchmarkIterator_1(b *testing.B) { benchmarkIterator(b, 1) } func BenchmarkIterator_2(b *testing.B) { benchmarkIterator(b, 2) } func BenchmarkIterator_4(b *testing.B) { benchmarkIterator(b, 4) } func BenchmarkIterator_8(b *testing.B) { benchmarkIterator(b, 8) } func BenchmarkIterator_16(b *testing.B) { benchmarkIterator(b, 16) } // Counters func BenchmarkGlobalInt64CounterAddWithSDK(b *testing.B) { // Compare with BenchmarkInt64CounterAdd() to see overhead of global // package. This is in the SDK to avoid the API from depending on the // SDK. ctx := context.Background() fix := newFixture(b) sdk := global.Meter("test") global.SetMeterProvider(fix) labs := []kv.KeyValue{kv.String("A", "B")} cnt := Must(sdk).NewInt64Counter("int64.counter") b.ResetTimer() for i := 0; i < b.N; i++ { cnt.Add(ctx, 1, labs...) } } func BenchmarkInt64CounterAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) cnt := fix.meterMust().NewInt64Counter("int64.counter") b.ResetTimer() for i := 0; i < b.N; i++ { cnt.Add(ctx, 1, labs...) } } func BenchmarkInt64CounterHandleAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) cnt := fix.meterMust().NewInt64Counter("int64.counter") handle := cnt.Bind(labs...) b.ResetTimer() for i := 0; i < b.N; i++ { handle.Add(ctx, 1) } } func BenchmarkFloat64CounterAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) cnt := fix.meterMust().NewFloat64Counter("float64.counter") b.ResetTimer() for i := 0; i < b.N; i++ { cnt.Add(ctx, 1.1, labs...) } } func BenchmarkFloat64CounterHandleAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) cnt := fix.meterMust().NewFloat64Counter("float64.counter") handle := cnt.Bind(labs...) b.ResetTimer() for i := 0; i < b.N; i++ { handle.Add(ctx, 1.1) } } // LastValue func BenchmarkInt64LastValueAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewInt64ValueRecorder("int64.lastvalue") b.ResetTimer() for i := 0; i < b.N; i++ { mea.Record(ctx, int64(i), labs...) } } func BenchmarkInt64LastValueHandleAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewInt64ValueRecorder("int64.lastvalue") handle := mea.Bind(labs...) b.ResetTimer() for i := 0; i < b.N; i++ { handle.Record(ctx, int64(i)) } } func BenchmarkFloat64LastValueAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewFloat64ValueRecorder("float64.lastvalue") b.ResetTimer() for i := 0; i < b.N; i++ { mea.Record(ctx, float64(i), labs...) } } func BenchmarkFloat64LastValueHandleAdd(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewFloat64ValueRecorder("float64.lastvalue") handle := mea.Bind(labs...) b.ResetTimer() for i := 0; i < b.N; i++ { handle.Record(ctx, float64(i)) } } // ValueRecorders func benchmarkInt64ValueRecorderAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewInt64ValueRecorder(name) b.ResetTimer() for i := 0; i < b.N; i++ { mea.Record(ctx, int64(i), labs...) } } func benchmarkInt64ValueRecorderHandleAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewInt64ValueRecorder(name) handle := mea.Bind(labs...) b.ResetTimer() for i := 0; i < b.N; i++ { handle.Record(ctx, int64(i)) } } func benchmarkFloat64ValueRecorderAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewFloat64ValueRecorder(name) b.ResetTimer() for i := 0; i < b.N; i++ { mea.Record(ctx, float64(i), labs...) } } func benchmarkFloat64ValueRecorderHandleAdd(b *testing.B, name string) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) mea := fix.meterMust().NewFloat64ValueRecorder(name) handle := mea.Bind(labs...) b.ResetTimer() for i := 0; i < b.N; i++ { handle.Record(ctx, float64(i)) } } // Observers func BenchmarkObserverRegistration(b *testing.B) { fix := newFixture(b) names := make([]string, 0, b.N) for i := 0; i < b.N; i++ { names = append(names, fmt.Sprintf("test.valueobserver.%d", i)) } cb := func(_ context.Context, result metric.Int64ObserverResult) {} b.ResetTimer() for i := 0; i < b.N; i++ { fix.meterMust().NewInt64ValueObserver(names[i], cb) } } func BenchmarkValueObserverObservationInt64(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) _ = fix.meterMust().NewInt64ValueObserver("test.valueobserver", func(_ context.Context, result metric.Int64ObserverResult) { for i := 0; i < b.N; i++ { result.Observe((int64)(i), labs...) } }) b.ResetTimer() fix.accumulator.Collect(ctx) } func BenchmarkValueObserverObservationFloat64(b *testing.B) { ctx := context.Background() fix := newFixture(b) labs := makeLabels(1) _ = fix.meterMust().NewFloat64ValueObserver("test.valueobserver", func(_ context.Context, result metric.Float64ObserverResult) { for i := 0; i < b.N; i++ { result.Observe((float64)(i), labs...) } }) b.ResetTimer() fix.accumulator.Collect(ctx) } // MaxSumCount func BenchmarkInt64MaxSumCountAdd(b *testing.B) { benchmarkInt64ValueRecorderAdd(b, "int64.minmaxsumcount") } func BenchmarkInt64MaxSumCountHandleAdd(b *testing.B) { benchmarkInt64ValueRecorderHandleAdd(b, "int64.minmaxsumcount") } func BenchmarkFloat64MaxSumCountAdd(b *testing.B) { benchmarkFloat64ValueRecorderAdd(b, "float64.minmaxsumcount") } func BenchmarkFloat64MaxSumCountHandleAdd(b *testing.B) { benchmarkFloat64ValueRecorderHandleAdd(b, "float64.minmaxsumcount") } // DDSketch func BenchmarkInt64DDSketchAdd(b *testing.B) { benchmarkInt64ValueRecorderAdd(b, "int64.ddsketch") } func BenchmarkInt64DDSketchHandleAdd(b *testing.B) { benchmarkInt64ValueRecorderHandleAdd(b, "int64.ddsketch") } func BenchmarkFloat64DDSketchAdd(b *testing.B) { benchmarkFloat64ValueRecorderAdd(b, "float64.ddsketch") } func BenchmarkFloat64DDSketchHandleAdd(b *testing.B) { benchmarkFloat64ValueRecorderHandleAdd(b, "float64.ddsketch") } // Array func BenchmarkInt64ArrayAdd(b *testing.B) { benchmarkInt64ValueRecorderAdd(b, "int64.array") } func BenchmarkInt64ArrayHandleAdd(b *testing.B) { benchmarkInt64ValueRecorderHandleAdd(b, "int64.array") } func BenchmarkFloat64ArrayAdd(b *testing.B) { benchmarkFloat64ValueRecorderAdd(b, "float64.array") } func BenchmarkFloat64ArrayHandleAdd(b *testing.B) { benchmarkFloat64ValueRecorderHandleAdd(b, "float64.array") } // BatchRecord func benchmarkBatchRecord8Labels(b *testing.B, numInst int) { const numLabels = 8 ctx := context.Background() fix := newFixture(b) labs := makeLabels(numLabels) var meas []metric.Measurement for i := 0; i < numInst; i++ { inst := fix.meterMust().NewInt64Counter(fmt.Sprint("int64.counter.", i)) meas = append(meas, inst.Measurement(1)) } b.ResetTimer() for i := 0; i < b.N; i++ { fix.accumulator.RecordBatch(ctx, labs, meas...) } } func BenchmarkBatchRecord8Labels_1Instrument(b *testing.B) { benchmarkBatchRecord8Labels(b, 1) } func BenchmarkBatchRecord_8Labels_2Instruments(b *testing.B) { benchmarkBatchRecord8Labels(b, 2) } func BenchmarkBatchRecord_8Labels_4Instruments(b *testing.B) { benchmarkBatchRecord8Labels(b, 4) } func BenchmarkBatchRecord_8Labels_8Instruments(b *testing.B) { benchmarkBatchRecord8Labels(b, 8) } // Record creation func BenchmarkRepeatedDirectCalls(b *testing.B) { ctx := context.Background() fix := newFixture(b) c := fix.meterMust().NewInt64Counter("int64.counter") k := kv.String("bench", "true") b.ResetTimer() for i := 0; i < b.N; i++ { c.Add(ctx, 1, k) fix.accumulator.Collect(ctx) } }