package telemetry_test import ( "context" "log" "strings" "testing" "golang.org/x/tools/internal/telemetry/event" "golang.org/x/tools/internal/telemetry/export" "golang.org/x/tools/internal/telemetry/stats" "golang.org/x/tools/internal/telemetry/unit" ) type Hooks struct { A func(ctx context.Context, a *int) (context.Context, func()) B func(ctx context.Context, b *string) (context.Context, func()) } var ( aValue = event.Key("a") bValue = event.Key("b") aCount = stats.Int64("aCount", "Count of time A is called.", unit.Dimensionless) aStat = stats.Int64("aValue", "A value.", unit.Dimensionless) bCount = stats.Int64("B", "Count of time B is called.", unit.Dimensionless) bLength = stats.Int64("BLen", "B length.", unit.Dimensionless) Baseline = Hooks{ A: func(ctx context.Context, a *int) (context.Context, func()) { return ctx, func() {} }, B: func(ctx context.Context, b *string) (context.Context, func()) { return ctx, func() {} }, } StdLog = Hooks{ A: func(ctx context.Context, a *int) (context.Context, func()) { log.Printf("start A where a=%d", *a) return ctx, func() { log.Printf("end A where a=%d", *a) } }, B: func(ctx context.Context, b *string) (context.Context, func()) { log.Printf("start B where b=%q", *b) return ctx, func() { log.Printf("end B where b=%q", *b) } }, } Log = Hooks{ A: func(ctx context.Context, a *int) (context.Context, func()) { event.Print(ctx, "start A", aValue.Of(*a)) return ctx, func() { event.Print(ctx, "end A", aValue.Of(*a)) } }, B: func(ctx context.Context, b *string) (context.Context, func()) { event.Print(ctx, "start B", bValue.Of(*b)) return ctx, func() { event.Print(ctx, "end B", bValue.Of(*b)) } }, } Trace = Hooks{ A: func(ctx context.Context, a *int) (context.Context, func()) { return event.StartSpan(ctx, "A") }, B: func(ctx context.Context, b *string) (context.Context, func()) { return event.StartSpan(ctx, "B") }, } Stats = Hooks{ A: func(ctx context.Context, a *int) (context.Context, func()) { aCount.Record(ctx, 1) return ctx, func() { aStat.Record(ctx, int64(*a)) } }, B: func(ctx context.Context, b *string) (context.Context, func()) { bCount.Record(ctx, 1) return ctx, func() { bLength.Record(ctx, int64(len(*b))) } }, } ) func Benchmark(b *testing.B) { b.Run("Baseline", Baseline.runBenchmark) b.Run("StdLog", StdLog.runBenchmark) event.SetExporter(nil) b.Run("LogNoExporter", Log.runBenchmark) b.Run("TraceNoExporter", Trace.runBenchmark) b.Run("StatsNoExporter", Stats.runBenchmark) event.SetExporter(newExporter()) b.Run("Log", Log.runBenchmark) b.Run("Trace", Trace.runBenchmark) b.Run("Stats", Stats.runBenchmark) } func A(ctx context.Context, hooks Hooks, a int) int { ctx, done := hooks.A(ctx, &a) defer done() if a > 0 { a = a * 10 } return B(ctx, hooks, a, "Called from A") } func B(ctx context.Context, hooks Hooks, a int, b string) int { _, done := hooks.B(ctx, &b) defer done() b = strings.ToUpper(b) if len(b) > 1024 { b = strings.ToLower(b) } return a + len(b) } func (hooks Hooks) runBenchmark(b *testing.B) { ctx := context.Background() b.ReportAllocs() b.ResetTimer() var acc int for i := 0; i < b.N; i++ { for _, value := range []int{0, 10, 20, 100, 1000} { acc += A(ctx, hooks, value) } } } func init() { log.SetOutput(new(noopWriter)) } type noopWriter int func (nw *noopWriter) Write(b []byte) (int, error) { return len(b), nil } type loggingExporter struct { logger event.Exporter } func newExporter() *loggingExporter { return &loggingExporter{ logger: export.LogWriter(new(noopWriter), false), } } func (e *loggingExporter) ProcessEvent(ctx context.Context, ev event.Event) context.Context { export.ContextSpan(ctx, ev) return e.logger.ProcessEvent(ctx, ev) } func (e *loggingExporter) Metric(ctx context.Context, data event.MetricData) { e.logger.Metric(ctx, data) }