You've already forked opentelemetry-go
mirror of
https://github.com/open-telemetry/opentelemetry-go.git
synced 2025-11-23 22:34:47 +02:00
80cb909774
Based on the Go version we currently use, the dependency already supports 1.24+, which allows using `t.Context()` and `b.Context()` in unit tests and benchmarks respectively. - Enable `context-background` and `context-todo` in [`usetesting`](https://golangci-lint.run/docs/linters/configuration/#usetesting) - Adjust the code to support linter detection --------- Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com> Co-authored-by: Tyler Yahn <codingalias@gmail.com> Co-authored-by: Damien Mathieu <42@dmathieu.com>
433 lines
11 KiB
Go
433 lines
11 KiB
Go
// Copyright The OpenTelemetry Authors
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package trace_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/go-logr/logr"
|
|
"github.com/go-logr/logr/funcr"
|
|
|
|
"go.opentelemetry.io/otel/attribute"
|
|
"go.opentelemetry.io/otel/internal/global"
|
|
sdktrace "go.opentelemetry.io/otel/sdk/trace"
|
|
"go.opentelemetry.io/otel/sdk/trace/tracetest"
|
|
"go.opentelemetry.io/otel/trace"
|
|
)
|
|
|
|
func benchmarkSpanLimits(b *testing.B, limits sdktrace.SpanLimits) {
|
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanLimits(limits))
|
|
tracer := tp.Tracer(b.Name())
|
|
ctx := b.Context()
|
|
|
|
const count = 8
|
|
|
|
attrs := []attribute.KeyValue{
|
|
attribute.Bool("bool", true),
|
|
attribute.BoolSlice("boolSlice", []bool{true, false}),
|
|
attribute.Int("int", 42),
|
|
attribute.IntSlice("intSlice", []int{42, -1}),
|
|
attribute.Int64("int64", 42),
|
|
attribute.Int64Slice("int64Slice", []int64{42, -1}),
|
|
attribute.Float64("float64", 42),
|
|
attribute.Float64Slice("float64Slice", []float64{42, -1}),
|
|
attribute.String("string", "value"),
|
|
attribute.StringSlice("stringSlice", []string{"value", "value-1"}),
|
|
}
|
|
|
|
links := make([]trace.Link, count)
|
|
for i := range links {
|
|
links[i] = trace.Link{
|
|
SpanContext: trace.NewSpanContext(trace.SpanContextConfig{
|
|
TraceID: [16]byte{0x01},
|
|
SpanID: [8]byte{0x01},
|
|
}),
|
|
Attributes: attrs,
|
|
}
|
|
}
|
|
|
|
events := make([]struct {
|
|
name string
|
|
attr []attribute.KeyValue
|
|
}, count)
|
|
for i := range events {
|
|
events[i] = struct {
|
|
name string
|
|
attr []attribute.KeyValue
|
|
}{
|
|
name: fmt.Sprintf("event-%d", i),
|
|
attr: attrs,
|
|
}
|
|
}
|
|
|
|
b.ReportAllocs()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := tracer.Start(ctx, "span-name", trace.WithLinks(links...))
|
|
span.SetAttributes(attrs...)
|
|
for _, e := range events {
|
|
span.AddEvent(e.name, trace.WithAttributes(e.attr...))
|
|
}
|
|
span.End()
|
|
}
|
|
}
|
|
|
|
func BenchmarkSpanLimits(b *testing.B) {
|
|
b.Run("AttributeValueLengthLimit", func(b *testing.B) {
|
|
limits := sdktrace.NewSpanLimits()
|
|
limits.AttributeValueLengthLimit = 2
|
|
benchmarkSpanLimits(b, limits)
|
|
})
|
|
|
|
b.Run("AttributeCountLimit", func(b *testing.B) {
|
|
limits := sdktrace.NewSpanLimits()
|
|
limits.AttributeCountLimit = 1
|
|
benchmarkSpanLimits(b, limits)
|
|
})
|
|
|
|
b.Run("EventCountLimit", func(b *testing.B) {
|
|
limits := sdktrace.NewSpanLimits()
|
|
limits.EventCountLimit = 1
|
|
benchmarkSpanLimits(b, limits)
|
|
})
|
|
|
|
b.Run("LinkCountLimit", func(b *testing.B) {
|
|
limits := sdktrace.NewSpanLimits()
|
|
limits.LinkCountLimit = 1
|
|
benchmarkSpanLimits(b, limits)
|
|
})
|
|
|
|
b.Run("AttributePerEventCountLimit", func(b *testing.B) {
|
|
limits := sdktrace.NewSpanLimits()
|
|
limits.AttributePerEventCountLimit = 1
|
|
benchmarkSpanLimits(b, limits)
|
|
})
|
|
|
|
b.Run("AttributePerLinkCountLimit", func(b *testing.B) {
|
|
limits := sdktrace.NewSpanLimits()
|
|
limits.AttributePerLinkCountLimit = 1
|
|
benchmarkSpanLimits(b, limits)
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanSetAttributesOverCapacity(b *testing.B) {
|
|
limits := sdktrace.NewSpanLimits()
|
|
limits.AttributeCountLimit = 1
|
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSpanLimits(limits))
|
|
tracer := tp.Tracer("BenchmarkSpanSetAttributesOverCapacity")
|
|
ctx := b.Context()
|
|
attrs := make([]attribute.KeyValue, 128)
|
|
for i := range attrs {
|
|
key := fmt.Sprintf("key-%d", i)
|
|
attrs[i] = attribute.Bool(key, true)
|
|
}
|
|
|
|
b.ReportAllocs()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := tracer.Start(ctx, "/foo")
|
|
span.SetAttributes(attrs...)
|
|
span.End()
|
|
}
|
|
}
|
|
|
|
func BenchmarkStartEndSpan(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark StartEndSpan", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithAttributes_4(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With 4 Attributes", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.SetAttributes(
|
|
attribute.Bool("key1", false),
|
|
attribute.String("key2", "hello"),
|
|
attribute.Int64("key3", 123),
|
|
attribute.Float64("key4", 123.456),
|
|
)
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithAttributes_8(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With 8 Attributes", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.SetAttributes(
|
|
attribute.Bool("key1", false),
|
|
attribute.String("key2", "hello"),
|
|
attribute.Int64("key3", 123),
|
|
attribute.Float64("key4", 123.456),
|
|
attribute.Bool("key21", false),
|
|
attribute.String("key22", "hello"),
|
|
attribute.Int64("key23", 123),
|
|
attribute.Float64("key24", 123.456),
|
|
)
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithAttributes_all(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With all Attribute types", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.SetAttributes(
|
|
attribute.Bool("key1", false),
|
|
attribute.String("key2", "hello"),
|
|
attribute.Int64("key3", 123),
|
|
attribute.Float64("key7", 123.456),
|
|
attribute.Int("key9", 123),
|
|
)
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithAttributes_all_2x(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With all Attributes types twice", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.SetAttributes(
|
|
attribute.Bool("key1", false),
|
|
attribute.String("key2", "hello"),
|
|
attribute.Int64("key3", 123),
|
|
attribute.Float64("key7", 123.456),
|
|
attribute.Int("key10", 123),
|
|
attribute.Bool("key21", false),
|
|
attribute.String("key22", "hello"),
|
|
attribute.Int64("key23", 123),
|
|
attribute.Float64("key27", 123.456),
|
|
attribute.Int("key210", 123),
|
|
)
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithEvents_4(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With 4 Events", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.AddEvent("event1")
|
|
span.AddEvent("event2")
|
|
span.AddEvent("event3")
|
|
span.AddEvent("event4")
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithEvents_8(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With 4 Events", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.AddEvent("event1")
|
|
span.AddEvent("event2")
|
|
span.AddEvent("event3")
|
|
span.AddEvent("event4")
|
|
span.AddEvent("event5")
|
|
span.AddEvent("event6")
|
|
span.AddEvent("event7")
|
|
span.AddEvent("event8")
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithEvents_WithStackTrace(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With 4 Attributes", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.AddEvent("event1", trace.WithStackTrace(true))
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkSpanWithEvents_WithTimestamp(b *testing.B) {
|
|
traceBenchmark(b, "Benchmark Start With 4 Attributes", func(b *testing.B, t trace.Tracer) {
|
|
ctx := b.Context()
|
|
b.ResetTimer()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
_, span := t.Start(ctx, "/foo")
|
|
span.AddEvent("event1", trace.WithTimestamp(time.Unix(0, 0)))
|
|
span.End()
|
|
}
|
|
})
|
|
}
|
|
|
|
func BenchmarkTraceIDFromHex(b *testing.B) {
|
|
want := trace.TraceID{
|
|
0xde,
|
|
0xad,
|
|
0xbe,
|
|
0xef,
|
|
0x01,
|
|
0x23,
|
|
0x45,
|
|
0x67,
|
|
0x89,
|
|
0xab,
|
|
0xcd,
|
|
0xef,
|
|
0x01,
|
|
0x23,
|
|
0x45,
|
|
0x67,
|
|
}
|
|
b.ReportAllocs()
|
|
for i := 0; i < b.N; i++ {
|
|
got, _ := trace.TraceIDFromHex("deadbeef0123456789abcdef01234567")
|
|
if got != want {
|
|
b.Fatalf("got = %q want = %q", got.String(), want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func BenchmarkSpanIDFromHex(b *testing.B) {
|
|
want := trace.SpanID{0xde, 0xad, 0xbe, 0xef, 0x01, 0x23, 0x45, 0x67}
|
|
b.ReportAllocs()
|
|
for i := 0; i < b.N; i++ {
|
|
got, _ := trace.SpanIDFromHex("deadbeef01234567")
|
|
if got != want {
|
|
b.Fatalf("got = %q want = %q", got.String(), want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func BenchmarkTraceID_DotString(b *testing.B) {
|
|
t, _ := trace.TraceIDFromHex("0000000000000001000000000000002a")
|
|
sc := trace.NewSpanContext(trace.SpanContextConfig{TraceID: t})
|
|
|
|
want := "0000000000000001000000000000002a"
|
|
for i := 0; i < b.N; i++ {
|
|
if got := sc.TraceID().String(); got != want {
|
|
b.Fatalf("got = %q want = %q", got, want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func BenchmarkSpanID_DotString(b *testing.B) {
|
|
sc := trace.NewSpanContext(trace.SpanContextConfig{SpanID: trace.SpanID{1}})
|
|
want := "0100000000000000"
|
|
for i := 0; i < b.N; i++ {
|
|
if got := sc.SpanID().String(); got != want {
|
|
b.Fatalf("got = %q want = %q", got, want)
|
|
}
|
|
}
|
|
}
|
|
|
|
func traceBenchmark(b *testing.B, name string, fn func(*testing.B, trace.Tracer)) {
|
|
b.Run("AlwaysSample", func(b *testing.B) {
|
|
b.ReportAllocs()
|
|
fn(b, tracer(b, name, sdktrace.AlwaysSample()))
|
|
})
|
|
b.Run("NeverSample", func(b *testing.B) {
|
|
b.ReportAllocs()
|
|
fn(b, tracer(b, name, sdktrace.NeverSample()))
|
|
})
|
|
}
|
|
|
|
func tracer(_ *testing.B, name string, sampler sdktrace.Sampler) trace.Tracer {
|
|
tp := sdktrace.NewTracerProvider(sdktrace.WithSampler(sampler))
|
|
return tp.Tracer(name)
|
|
}
|
|
|
|
func BenchmarkSpanProcessorOnEnd(b *testing.B) {
|
|
for _, bb := range []struct {
|
|
batchSize int
|
|
spansCount int
|
|
}{
|
|
{batchSize: 10, spansCount: 10},
|
|
{batchSize: 10, spansCount: 100},
|
|
{batchSize: 100, spansCount: 10},
|
|
{batchSize: 100, spansCount: 100},
|
|
} {
|
|
b.Run(fmt.Sprintf("batch: %d, spans: %d", bb.batchSize, bb.spansCount), func(b *testing.B) {
|
|
bsp := sdktrace.NewBatchSpanProcessor(
|
|
tracetest.NewNoopExporter(),
|
|
sdktrace.WithMaxExportBatchSize(bb.batchSize),
|
|
)
|
|
b.Cleanup(func() {
|
|
//nolint:usetesting // required to avoid getting a canceled context at cleanup.
|
|
_ = bsp.Shutdown(context.Background())
|
|
})
|
|
snap := tracetest.SpanStub{}.Snapshot()
|
|
|
|
b.ResetTimer()
|
|
b.ReportAllocs()
|
|
for i := 0; i < b.N; i++ {
|
|
// Ensure the export happens for every run
|
|
for j := 0; j < bb.spansCount; j++ {
|
|
bsp.OnEnd(snap)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func BenchmarkSpanProcessorVerboseLogging(b *testing.B) {
|
|
b.Cleanup(func(l logr.Logger) func() {
|
|
return func() { global.SetLogger(l) }
|
|
}(global.GetLogger()))
|
|
global.SetLogger(funcr.New(func(string, string) {}, funcr.Options{Verbosity: 5}))
|
|
tp := sdktrace.NewTracerProvider(
|
|
sdktrace.WithBatcher(
|
|
tracetest.NewNoopExporter(),
|
|
sdktrace.WithMaxExportBatchSize(10),
|
|
))
|
|
b.Cleanup(func() {
|
|
//nolint:usetesting // required to avoid getting a canceled context at cleanup.
|
|
_ = tp.Shutdown(context.Background())
|
|
})
|
|
tracer := tp.Tracer("bench")
|
|
ctx := b.Context()
|
|
|
|
b.ResetTimer()
|
|
b.ReportAllocs()
|
|
|
|
for i := 0; i < b.N; i++ {
|
|
for range 10 {
|
|
_, span := tracer.Start(ctx, "bench")
|
|
span.End()
|
|
}
|
|
}
|
|
}
|