Function TestOTelSpanLoggerAwareCaller

spanlogger/otel_spanlogger_test.go:267–413

(t *testing.T)

}

func TestOTelSpanLoggerAwareCaller(t *testing.T) {
	testCases := map[string]func(w io.Writer) log.Logger{
		// This is based on Mimir's default logging configuration: https://github.com/grafana/mimir/blob/50d1c27b4ad82b265ff5a865345bec2d726f64ef/pkg/util/log/log.go#L45-L46
		"default logger": func(w io.Writer) log.Logger {
			logger := dskit_log.NewGoKitWithWriter("logfmt", w)
			logger = log.With(logger, "ts", log.DefaultTimestampUTC, "caller", Caller(5))
			logger = level.NewFilter(logger, level.AllowAll())
			return logger
		},

		//This is based on Mimir's logging configuration with rate-limiting enabled: https://github.com/grafana/mimir/blob/50d1c27b4ad82b265ff5a865345bec2d726f64ef/pkg/util/log/log.go#L42-L43
		"rate-limited logger": func(w io.Writer) log.Logger {
			logger := dskit_log.NewGoKitWithWriter("logfmt", w)
			logger = log.With(logger, "ts", log.DefaultTimestampUTC, "caller", Caller(6))
			logger = dskit_log.NewRateLimitedLogger(logger, 1000, 1000, nil)
			logger = level.NewFilter(logger, level.AllowAll())
			return logger
		},

		"default logger that has been wrapped with further information": func(w io.Writer) log.Logger {
			logger := dskit_log.NewGoKitWithWriter("logfmt", w)
			logger = log.With(logger, "ts", log.DefaultTimestampUTC, "caller", Caller(5))
			logger = level.NewFilter(logger, level.AllowAll())
			logger = log.With(logger, "user", "user-1")
			return logger
		},
	}

	resolver := tenant.NewMultiResolver()

	setupTest := func(t *testing.T, loggerFactory func(io.Writer) log.Logger) (*bytes.Buffer, *SpanLogger) {
		t.Cleanup(spanExporter.Reset)

		ctx, _ := tracer.Start(context.Background(), "test")

		buf := bytes.NewBuffer(nil)
		logger := loggerFactory(buf)
		spanLogger := FromContext(ctx, logger, resolver)
		require.NotNil(t, spanLogger.otelSpan)
		require.Nil(t, spanLogger.opentracingSpan)

		return buf, spanLogger
	}

	requireSpanHasTwoLogLinesWithoutCaller := func(t *testing.T, span tracetest.SpanStub, extraAttributes ...attribute.KeyValue) {
		evs := span.Events
		require.Len(t, evs, 2)

		require.Equal(t, "log", evs[0].Name)
		require.Equal(t, "log", evs[1].Name)
		require.Equal(t, append(slices.Clone(extraAttributes), attribute.String("msg", "this is a test")), evs[0].Attributes)
		require.Equal(t, append(slices.Clone(extraAttributes), attribute.String("msg", "this is another test")), evs[1].Attributes)
	}

	toCallerInfo := func(path string, lineNumber int) string {
		fileName := filepath.Base(path)
		return fmt.Sprintf("%s:%v", fileName, lineNumber)
	}