Fiber middleware to log http requests using slog.
Sponsored by:
100% OpenTelemetry-native observability platform
Simple to use, built on open standards, and designed for full cost control
Simple to use, built on open standards, and designed for full cost control
See also:
- slog-multi:
slog.Handlerchaining, fanout, routing, failover, load balancing... - slog-formatter:
slogattribute formatting - slog-sampling:
slogsampling policy - slog-mock:
slog.Handlerfor test purposes
HTTP middlewares:
- slog-gin: Gin middleware for
sloglogger - slog-echo: Echo middleware for
sloglogger - slog-fiber: Fiber middleware for
sloglogger - slog-chi: Chi middleware for
sloglogger - slog-http:
net/httpmiddleware forsloglogger
Loggers:
- slog-zap: A
sloghandler forZap - slog-zerolog: A
sloghandler forZerolog - slog-logrus: A
sloghandler forLogrus
Log sinks:
- slog-datadog: A
sloghandler forDatadog - slog-betterstack: A
sloghandler forBetterstack - slog-rollbar: A
sloghandler forRollbar - slog-loki: A
sloghandler forLoki - slog-sentry: A
sloghandler forSentry - slog-syslog: A
sloghandler forSyslog - slog-logstash: A
sloghandler forLogstash - slog-fluentd: A
sloghandler forFluentd - slog-graylog: A
sloghandler forGraylog - slog-quickwit: A
sloghandler forQuickwit - slog-slack: A
sloghandler forSlack - slog-telegram: A
sloghandler forTelegram - slog-mattermost: A
sloghandler forMattermost - slog-microsoft-teams: A
sloghandler forMicrosoft Teams - slog-webhook: A
sloghandler forWebhook - slog-kafka: A
sloghandler forKafka - slog-nats: A
sloghandler forNATS - slog-parquet: A
sloghandler forParquet+Object Storage - slog-channel: A
sloghandler for Go channels
# Fiber v2 (current)
go get github.com/samber/slog-fiber
# Fiber v3 (beta)
go get github.com/samber/slog-fiber@fiber-v3Compatibility: go >= 1.21
No breaking changes will be made to exported APIs before v2.0.0.
type Config struct {
DefaultLevel slog.Level
ClientErrorLevel slog.Level
ServerErrorLevel slog.Level
WithUserAgent bool
WithRequestID bool
WithRequestBody bool
WithRequestHeader bool
WithResponseBody bool
WithResponseHeader bool
WithSpanID bool
WithTraceID bool
Filters []Filter
}Attributes will be injected in log payload.
Other global parameters:
slogfiber.TraceIDKey = "trace_id"
slogfiber.SpanIDKey = "span_id"
slogfiber.RequestBodyMaxSize = 64 * 1024 // 64KB
slogfiber.ResponseBodyMaxSize = 64 * 1024 // 64KB
slogfiber.HiddenRequestHeaders = map[string]struct{}{ ... }
slogfiber.HiddenResponseHeaders = map[string]struct{}{ ... }
slogfiber.RequestIDHeaderKey = "X-Request-Id"import (
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/recover"
slogfiber "github.com/samber/slog-fiber"
"log/slog"
)
// Create a slog logger, which:
// - Logs to stdout.
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
app := fiber.New()
app.Use(slogfiber.New(logger))
app.Use(recover.New())
app.Get("/", func(c *fiber.Ctx) error {
return c.SendString("Hello, World 👋!")
})
app.Listen(":4242")
// output:
// time=2023-10-15T20:32:58.926+02:00 level=INFO msg="Incoming request" env=production request.time=2023-10-15T20:32:58.626+02:00 request.method=GET request.path=/ request.route="" request.ip=127.0.0.1:63932 request.length=0 response.time=2023-10-15T20:32:58.926+02:00 response.latency=100ms response.status=200 response.length=7 id=229c7fc8-64f5-4467-bc4a-940700503b0dlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))
config := slogfiber.Config{
WithSpanID: true,
WithTraceID: true,
}
app := fiber.New()
app.Use(slogfiber.NewWithConfig(logger, config))logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
config := slogfiber.Config{
DefaultLevel: slog.LevelInfo,
ClientErrorLevel: slog.LevelWarn,
ServerErrorLevel: slog.LevelError,
}
app := fiber.New()
app.Use(slogfiber.NewWithConfig(logger, config))logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
config := slogfiber.Config{
WithRequestBody: true,
WithResponseBody: true,
WithRequestHeader: true,
WithResponseHeader: true,
}
app := fiber.New()
app.Use(slogfiber.NewWithConfig(logger, config))logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
app := fiber.New()
app.Use(
slogfiber.NewWithFilters(
logger,
slogfiber.Accept(func (c *fiber.Ctx) bool {
return xxx
}),
slogfiber.IgnoreStatus(401, 404),
),
)
app.Use(recover.New())Available filters:
- Accept / Ignore
- AcceptMethod / IgnoreMethod
- AcceptStatus / IgnoreStatus
- AcceptStatusGreaterThan / IgnoreStatusGreaterThan
- AcceptStatusLessThan / IgnoreStatusLessThan
- AcceptStatusGreaterThanOrEqual / IgnoreStatusGreaterThanOrEqual
- AcceptStatusLessThanOrEqual / IgnoreStatusLessThanOrEqual
- AcceptPath / IgnorePath
- AcceptPathContains / IgnorePathContains
- AcceptPathPrefix / IgnorePathPrefix
- AcceptPathSuffix / IgnorePathSuffix
- AcceptPathMatch / IgnorePathMatch
- AcceptHost / IgnoreHost
- AcceptHostContains / IgnoreHostContains
- AcceptHostPrefix / IgnoreHostPrefix
- AcceptHostSuffix / IgnoreHostSuffix
- AcceptHostMatch / IgnoreHostMatch
// Create a slog logger, which:
// - Logs to stdout.
// - RFC3339 with UTC time format.
logger := slog.New(
slogformatter.NewFormatterHandler(
slogformatter.TimezoneConverter(time.UTC),
slogformatter.TimeFormatter(time.RFC3339, nil),
)(
slog.NewTextHandler(os.Stdout, nil),
),
)
app := fiber.New()
app.Use(slogfiber.New(logger))
app.Use(recover.New())
app.Get("/", func(c *fiber.Ctx) error {
return c.SendString("Hello, World 👋!")
})
app.Listen(":4242")
// output:
// time=2023-10-15T20:32:58.926+02:00 level=INFO msg="Incoming request" env=production request.time=2023-10-15T20:32:58Z request.method=GET request.path=/ request.route="" request.ip=127.0.0.1:63932 request.length=0 response.time=2023-10-15T20:32:58Z response.latency=100ms response.status=200 response.length=7 id=229c7fc8-64f5-4467-bc4a-940700503b0dlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))
app := fiber.New()
app.Use(slogfiber.New(logger.WithGroup("http")))
app.Use(recover.New())
app.Get("/", func(c *fiber.Ctx) error {
return c.SendString("Hello, World 👋!")
})
app.Listen(":4242")
// output:
// time=2023-10-15T20:32:58.926+02:00 level=INFO msg="Incoming request" env=production http.request.time=2023-10-15T20:32:58.626+02:00 http.request.method=GET http.request.path=/ http.request.route="" http.request.ip=127.0.0.1:63932 http.request.length=0 http.response.time=2023-10-15T20:32:58.926+02:00 http.response.latency=100ms http.response.status=200 http.response.length=7 http.id=229c7fc8-64f5-4467-bc4a-940700503b0dlogger := slog.New(slog.NewTextHandler(os.Stdout, nil))
app := fiber.New()
app.Use(recover.New())
app.Get("/", slogfiber.New(logger), func(c *fiber.Ctx) error {
return c.SendString("Hello, World 👋!")
})
app.Listen(":4242")logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
// Add an attribute to all log entries made through this logger.
logger = logger.With("env", "production")
app := fiber.New()
app.Use(slogfiber.New(logger))
app.Use(recover.New())
app.Get("/", func(c *fiber.Ctx) error {
// Add an attribute to a single log entry.
slogfiber.AddCustomAttributes(c, slog.String("foo", "bar"))
return c.SendString("Hello, World 👋!")
})
app.Listen(":4242")
// output:
// time=2023-10-15T20:32:58.926+02:00 level=INFO msg="Incoming request" env=production request.time=2023-10-15T20:32:58.626+02:00 request.method=GET request.path=/ request.route="" request.ip=127.0.0.1:63932 request.length=0 response.time=2023-10-15T20:32:58.926+02:00 response.latency=100ms response.status=200 response.length=7 id=229c7fc8-64f5-4467-bc4a-940700503b0d foo=barlogger := slog.New(slog.NewJSONHandler(os.Stdout, nil)),
app := fiber.New()
app.Use(slogfiber.New(logger))
app.Use(recover.New())
app.Get("/", func(c *fiber.Ctx) error {
return c.SendString("Hello, World 👋!")
})
app.Listen(":4242")
// output:
// {"time":"2023-10-15T20:32:58.926+02:00","level":"INFO","msg":"Incoming request","env":"production","http":{"request":{"time":"2023-10-15T20:32:58.626+02:00","method":"GET","path":"/","route":"","ip":"127.0.0.1:55296","length":0},"response":{"time":"2023-10-15T20:32:58.926+02:00","latency":100000,"status":200,"length":7},"id":"04201917-d7ba-4b20-a3bb-2fffba5f2bd9"}}- Ping me on twitter @samuelberthe (DMs, mentions, whatever :))
- Fork the project
- Fix open issues or request new features
Don't hesitate ;)
# Install some dev dependencies
make tools
# Run tests
make test
# or
make watch-testGive a ⭐️ if this project helped you!
Copyright © 2023 Samuel Berthe.
This project is MIT licensed.