Standardize OTEL error logging format to match application logs (#4292)

This commit is contained in:
Milos Gajdos 2024-03-05 17:22:26 +00:00 committed by GitHub
commit 5c662eb1c2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 22 additions and 13 deletions

21
tracing/loggerwriter.go Normal file
View file

@ -0,0 +1,21 @@
package tracing
import "github.com/distribution/distribution/v3/internal/dcontext"
// loggerWriter is a custom writer that implements the io.Writer interface.
// It is designed to redirect log messages to the Logger interface, specifically
// for use with OpenTelemetry's stdouttrace exporter.
type loggerWriter struct {
logger dcontext.Logger // Use the Logger interface
}
// Write logs the data using the Debug level of the provided logger.
func (lw *loggerWriter) Write(p []byte) (n int, err error) {
lw.logger.Debug(string(p))
return len(p), nil
}
// Handle logs the error using the Error level of the provided logger.
func (lw *loggerWriter) Handle(err error) {
lw.logger.Error(err)
}

View file

@ -26,19 +26,6 @@ const (
AttributePrefix = "io.cncf.distribution." AttributePrefix = "io.cncf.distribution."
) )
// loggerWriter is a custom writer that implements the io.Writer interface.
// It is designed to redirect log messages to the Logger interface, specifically
// for use with OpenTelemetry's stdouttrace exporter.
type loggerWriter struct {
logger dcontext.Logger // Use the Logger interface
}
// Write logs the data using the Debug level of the provided logger.
func (lw *loggerWriter) Write(p []byte) (n int, err error) {
lw.logger.Debug(string(p))
return len(p), nil
}
// InitOpenTelemetry initializes OpenTelemetry for the application. This function sets up the // InitOpenTelemetry initializes OpenTelemetry for the application. This function sets up the
// necessary components for collecting telemetry data, such as traces. // necessary components for collecting telemetry data, such as traces.
func InitOpenTelemetry(ctx context.Context) error { func InitOpenTelemetry(ctx context.Context) error {
@ -71,6 +58,7 @@ func InitOpenTelemetry(ctx context.Context) error {
sdktrace.WithSpanProcessor(sp), sdktrace.WithSpanProcessor(sp),
) )
otel.SetTracerProvider(provider) otel.SetTracerProvider(provider)
otel.SetErrorHandler(lw)
pr := propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{}) pr := propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})
otel.SetTextMapPropagator(pr) otel.SetTextMapPropagator(pr)