Skip to content

feat: make HTTP header to log attribute mapping configurable #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
stuartwdouglas wants to merge 1 commit into from
Closed

feat: make HTTP header to log attribute mapping configurable #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cmd/cachewd/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ func main() {

logger.InfoContext(ctx, "Starting cachewd", "bind", globalConfig.Bind)

server, err := newServer(ctx, mux, globalConfig.Bind, globalConfig.MetricsConfig, globalConfig.OPAConfig)
server, err := newServer(ctx, mux, globalConfig.Bind, globalConfig.MetricsConfig, globalConfig.OPAConfig, globalConfig.LoggingConfig)
fatalIfError(ctx, logger, err, "Failed to create server")

err = server.ListenAndServe()
Expand Down Expand Up @@ -220,7 +220,7 @@ func extractPathPrefix(path string) string {
return prefix
}

func newServer(ctx context.Context, muxHandler http.Handler, bind string, metricsConfig metrics.Config, opaConfig opa.Config) (*http.Server, error) {
func newServer(ctx context.Context, muxHandler http.Handler, bind string, metricsConfig metrics.Config, opaConfig opa.Config, loggingConfig logging.Config) (*http.Server, error) {
var handler http.Handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
labeler, _ := otelhttp.LabelerFromContext(r.Context())
labeler.Add(attribute.String("cachew.http.path.prefix", extractPathPrefix(r.URL.Path)))
Expand All @@ -238,7 +238,7 @@ func newServer(ctx context.Context, muxHandler http.Handler, bind string, metric
otelhttp.WithTracerProvider(otel.GetTracerProvider()),
)(handler)

handler = httputil.LoggingMiddleware(handler)
handler = httputil.LoggingMiddleware(loggingConfig.HeaderAttrs, handler)

logger := logging.FromContext(ctx)
return &http.Server{
Expand Down
11 changes: 8 additions & 3 deletions internal/httputil/logging.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,17 @@ import (
"github.com/block/cachew/internal/logging"
)

func LoggingMiddleware(next http.Handler) http.Handler {
// LoggingMiddleware adds method/URI to the logger and optionally extracts
// request headers into log attributes based on the provided headerAttrs map.
func LoggingMiddleware(headerAttrs map[string]string, next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
// Propagate attributes tot the handlers.
logger := logging.FromContext(r.Context()).With("method", r.Method, "uri", r.RequestURI)
for header, attr := range headerAttrs {
if v := r.Header.Get(header); v != "" {
logger = logger.With(attr, v)
}
}
r = r.WithContext(logging.ContextWithLogger(r.Context(), logger))
logger.Debug("Request received")
next.ServeHTTP(w, r)
})
}
7 changes: 4 additions & 3 deletions internal/logging/logging.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ import (
)

type Config struct {
JSON bool `hcl:"json,optional" help:"Enable JSON logging."`
Level slog.Level `hcl:"level" help:"Set the logging level." default:"info"`
Remap map[string]string `hcl:"remap,optional" help:"Remap field names from old to new (e.g., msg=message, time=timestamp)."`
JSON bool `hcl:"json,optional" help:"Enable JSON logging."`
Level slog.Level `hcl:"level" help:"Set the logging level." default:"info"`
Remap map[string]string `hcl:"remap,optional" help:"Remap field names from old to new (e.g., msg=message, time=timestamp)."`
HeaderAttrs map[string]string `hcl:"header-attrs,optional" help:"Map HTTP header names to log attribute names (e.g., X-Request-Id=request_id)."`
}

var levelVar = &slog.LevelVar{} //nolint:gochecknoglobals
Expand Down