Skip to content

feat: allow to customize log message #74

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

Open
sad-fat-cat wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: allow to customize log message #74

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
2 changes: 1 addition & 1 deletion _example/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ require (
github.com/go-chi/chi/v5 v5.1.0
github.com/go-chi/httplog/v3 v3.0.0-00010101000000-000000000000
github.com/go-chi/traceid v0.3.0
github.com/golang-cz/devslog v0.0.14
github.com/golang-cz/devslog v0.0.15
)

require github.com/google/uuid v1.6.0 // indirect
6 changes: 2 additions & 4 deletions _example/go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@ github.com/go-chi/chi/v5 v5.1.0 h1:acVI1TYaD+hhedDJ3r54HyA6sExp3HfXq7QWEEY/xMw=
github.com/go-chi/chi/v5 v5.1.0/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
github.com/go-chi/traceid v0.3.0 h1:BYITxMnIeQasU7/U7+InZWANWxVZeCUBGTAqWleQOeg=
github.com/go-chi/traceid v0.3.0/go.mod h1:XFfEEYZjqgML4ySh+wYBU29eqJkc2um7oEzgIc63e74=
github.com/golang-cz/devslog v0.0.9 h1:GU59V626sUccMjytKhewgN3teduXtx/itoQs78NaPdE=
github.com/golang-cz/devslog v0.0.9/go.mod h1:bSe5bm0A7Nyfqtijf1OMNgVJHlWEuVSXnkuASiE1vV8=
github.com/golang-cz/devslog v0.0.14 h1:hZY6VuZ/+MmG4djP9X1YDSmX/z5zPDDVgFlO0fyb+CY=
github.com/golang-cz/devslog v0.0.14/go.mod h1:bSe5bm0A7Nyfqtijf1OMNgVJHlWEuVSXnkuASiE1vV8=
github.com/golang-cz/devslog v0.0.15 h1:ejoBLTCwJHWGbAmDf2fyTJJQO3AkzcPjw8SC9LaOQMI=
github.com/golang-cz/devslog v0.0.15/go.mod h1:bSe5bm0A7Nyfqtijf1OMNgVJHlWEuVSXnkuASiE1vV8=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
4 changes: 4 additions & 0 deletions _example/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ func main() {
}
return nil
},

LogFormat: func(r *http.Request, statusCode int, d time.Duration) string {
return fmt.Sprintf("%s %s => HTTP %v", r.Method, r.URL, statusCode)
Copy link
Contributor

@VojtechVitek VojtechVitek Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of curiosity, what's the format you're thinking of for yourself?

Copy link
Author

@sad-fat-cat sad-fat-cat Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just constant string, like "request processed".

Because all info about request already stored in slog attrs, and variance part in message field sort of difficult to work with aggregations (for example, % of uniq clients were affected by a particular error in this operation).

I thought about just putting the template string in the params, but the function seems more flexible, in general.

},
}))

// Set request log attribute from within middleware.
Expand Down
7 changes: 6 additions & 1 deletion middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ func RequestLogger(logger *slog.Logger, o *Options) func(http.Handler) http.Hand
s = SchemaECS
}

logFormat := o.LogFormat
if logFormat == nil {
logFormat = defaultLogFormat
}

return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := context.WithValue(r.Context(), ctxKeyLogAttrs{}, &[]slog.Attr{})
Expand Down Expand Up @@ -166,7 +171,7 @@ func RequestLogger(logger *slog.Logger, o *Options) func(http.Handler) http.Hand
logAttrs = groupAttrs(logAttrs, s.GroupDelimiter)
}

msg := fmt.Sprintf("%s %s => HTTP %v (%v)", r.Method, r.URL, statusCode, duration)
msg := logFormat(r, statusCode, duration)
logger.LogAttrs(ctx, lvl, msg, logAttrs...)
}()

Expand Down
12 changes: 12 additions & 0 deletions options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package httplog

import (
"fmt"
"time"

"log/slog"
"net/http"
)
Expand Down Expand Up @@ -95,6 +98,10 @@ type Options struct {
//
// WARNING: Be careful not to leak any sensitive information in the logs.
LogExtraAttrs func(req *http.Request, reqBody string, respStatus int) []slog.Attr

// LogFormat is a optional function that lets you control the format of the log message
// If not provided, default format will be used
LogFormat func(*http.Request, int, time.Duration) string
}

var defaultOptions = Options{
Expand All @@ -105,4 +112,9 @@ var defaultOptions = Options{
LogResponseHeaders: []string{"Content-Type"},
LogBodyContentTypes: []string{"application/json", "application/xml", "text/plain", "text/csv", "application/x-www-form-urlencoded", ""},
LogBodyMaxLen: 1024,
LogFormat: defaultLogFormat,
}

func defaultLogFormat(r *http.Request, statusCode int, duration time.Duration) string {
return fmt.Sprintf("%s %s => HTTP %v (%v)", r.Method, r.URL, statusCode, duration)
}