slogfiber

README

slog: Fiber middleware

Fiber middleware to log http requests using slog.

See also:

• slog-multi: slog.Handler chaining, fanout, routing, failover, load balancing...
• slog-formatter: slog attribute formatting
• slog-sampling: slog sampling policy
• slog-gin: Gin middleware for slog logger
• slog-echo: Echo middleware for slog logger
• slog-fiber: Fiber middleware for slog logger
• slog-chi: Chi middleware for slog logger
• slog-datadog: A slog handler for Datadog
• slog-rollbar: A slog handler for Rollbar
• slog-sentry: A slog handler for Sentry
• slog-syslog: A slog handler for Syslog
• slog-logstash: A slog handler for Logstash
• slog-fluentd: A slog handler for Fluentd
• slog-graylog: A slog handler for Graylog
• slog-loki: A slog handler for Loki
• slog-slack: A slog handler for Slack
• slog-telegram: A slog handler for Telegram
• slog-mattermost: A slog handler for Mattermost
• slog-microsoft-teams: A slog handler for Microsoft Teams
• slog-webhook: A slog handler for Webhook
• slog-kafka: A slog handler for Kafka
• slog-parquet: A slog handler for Parquet + Object Storage
• slog-zap: A slog handler for Zap
• slog-zerolog: A slog handler for Zerolog
• slog-logrus: A slog handler for Logrus

🚀 Install

go get github.com/samber/slog-fiber

Compatibility: go >= 1.21

No breaking changes will be made to exported APIs before v2.0.0.

💡 Usage

Minimal

import (
	"github.com/gofiber/fiber/v2"
	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.Get("/", func(c *fiber.Ctx) error {
	return c.SendString("Hello, World 👋!")
})

app.Listen(":4242")

// output:
// time=2023-04-10T14:00:00.000+00:00 level=INFO msg="Incoming request" status=200 method=GET path=/ route=/ ip=::1 latency=25.958µs user-agent=curl/7.77.0 time=2023-04-10T14:00:00.000+00:00 request-id=229c7fc8-64f5-4467-bc4a-940700503b0d

Filters

import (
	"github.com/gofiber/fiber/v2"
	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.NewWithFilters(
		logger,
		slogfiber.Accept(func (c *fiber.Ctx) bool {
			return xxx
		}),
		slogfiber.IgnoreStatus(401, 404),
	),
)

Available filters:

• Accept / Ignore
• AcceptMethod / IgnoreMethod
• AcceptStatus / IgnoreStatus
• AcceptStatusGreaterThan / IgnoreStatusLessThan
• AcceptStatusGreaterThanOrEqual / IgnoreStatusLessThanOrEqual
• AcceptPath / IgnorePath
• AcceptPathContains / IgnorePathContains
• AcceptPathPrefix / IgnorePathPrefix
• AcceptPathSuffix / IgnorePathSuffix
• AcceptPathMatch / IgnorePathMatch
• AcceptHost / IgnoreHost
• AcceptHostContains / IgnoreHostContains
• AcceptHostPrefix / IgnoreHostPrefix
• AcceptHostSuffix / IgnoreHostSuffix
• AcceptHostMatch / IgnoreHostMatch

Using custom time formatters

import (
	"github.com/gofiber/fiber/v2"
	slogfiber "github.com/samber/slog-fiber"
	slogformatter "github.com/samber/slog-formatter"
	"log/slog"
)

// 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.Get("/", func(c *fiber.Ctx) error {
	return c.SendString("Hello, World 👋!")
})

app.Listen(":4242")

// output:
// time=2023-04-10T14:00:00.000+00:00 level=INFO msg="Incoming request" status=200 method=GET path=/ route=/ ip=::1 latency=25.958µs user-agent=curl/7.77.0 time=2023-04-10T14:00:00Z request-id=229c7fc8-64f5-4467-bc4a-940700503b0d

Using custom logger sub-group

import (
	"github.com/gofiber/fiber/v2"
	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.WithGroup("http")))

app.Get("/", func(c *fiber.Ctx) error {
	return c.SendString("Hello, World 👋!")
})

app.Listen(":4242")

// output:
// time=2023-04-10T14:00:00.000+00:00 level=INFO msg="Incoming request" http.status=200 http.method=GET http.path=/ http.route=/ http.ip=::1 http.latency=25.958µs http.user-agent=curl/7.77.0 http.time=2023-04-10T14:00:00Z http.request-id=229c7fc8-64f5-4467-bc4a-940700503b0d

Add logger to a single route

import (
	"github.com/gofiber/fiber/v2"
	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.Get("/", func(c *fiber.Ctx) error {
	return c.SendString("Hello, World 👋!")
})

app.Listen(":4242")

// output:
// time=2023-04-10T14:00:00.000+00:00 level=INFO msg="Incoming request" status=200 method=GET path=/ route=/ ip=::1 latency=25.958µs user-agent=curl/7.77.0 time=2023-04-10T14:00:00Z request-id=229c7fc8-64f5-4467-bc4a-940700503b0d

Adding custom attributes

import (
	"github.com/gofiber/fiber/v2"
	slogfiber "github.com/samber/slog-fiber"
	"log/slog"
)

// Create a slog logger, which:
//   - Logs to stdout.
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.WithGroup("http")))

app.Get("/", func(c *fiber.Ctx) error {
	return c.SendString("Hello, World 👋!")
})

app.Listen(":4242")

// output:
// time=2023-04-10T14:00:00.000+00:00 level=INFO msg="Incoming request" env=production status=200 method=GET path=/ route=/ ip=::1 latency=25.958µs user-agent=curl/7.77.0 time=2023-04-10T14:00:00Z request-id=229c7fc8-64f5-4467-bc4a-940700503b0d

JSON output

import (
	"github.com/gofiber/fiber/v2"
	slogfiber "github.com/samber/slog-fiber"
	"log/slog"
)

// Create a slog logger, which:
//   - Logs to stdout.
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil)),

app := fiber.New()

app.Use(slogfiber.New(logger))

app.Get("/", func(c *fiber.Ctx) error {
	return c.SendString("Hello, World 👋!")
})

app.Listen(":4242")

// output:
// {"time":"2023-04-10T14:00:00Z","level":"INFO","msg":"Incoming request","status":200,"method":"GET","path":"/","ip":"::1","latency":26750,"user-agent":"curl/7.77.0","time":"2023-04-10T14:00:00Z","request-id":"04201917-d7ba-4b20-a3bb-2fffba5f2bd9"}

🤝 Contributing

• 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-test

👤 Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.

Documentation

Index

• func GetRequestID(c *fiber.Ctx) string
• func New(logger *slog.Logger) fiber.Handler
• func NewWithConfig(logger *slog.Logger, config Config) fiber.Handler
• type Config
• type Filter
  • func Accept(filter Filter) Filter
  • func AcceptHost(hosts ...string) Filter
  • func AcceptHostContains(parts ...string) Filter
  • func AcceptHostMatch(regs ...regexp.Regexp) Filter
  • func AcceptHostPrefix(prefixs ...string) Filter
  • func AcceptHostSuffix(prefixs ...string) Filter
  • func AcceptMethod(methods ...string) Filter
  • func AcceptPath(urls ...string) Filter
  • func AcceptPathContains(parts ...string) Filter
  • func AcceptPathMatch(regs ...regexp.Regexp) Filter
  • func AcceptPathPrefix(prefixs ...string) Filter
  • func AcceptPathSuffix(prefixs ...string) Filter
  • func AcceptStatus(statuses ...int) Filter
  • func AcceptStatusGreaterThan(status int) Filter
  • func AcceptStatusGreaterThanOrEqual(status int) Filter
  • func Ignore(filter Filter) Filter
  • func IgnoreHost(hosts ...string) Filter
  • func IgnoreHostContains(parts ...string) Filter
  • func IgnoreHostMatch(regs ...regexp.Regexp) Filter
  • func IgnoreHostPrefix(prefixs ...string) Filter
  • func IgnoreHostSuffix(suffixs ...string) Filter
  • func IgnoreMethod(methods ...string) Filter
  • func IgnorePath(urls ...string) Filter
  • func IgnorePathContains(parts ...string) Filter
  • func IgnorePathMatch(regs ...regexp.Regexp) Filter
  • func IgnorePathPrefix(prefixs ...string) Filter
  • func IgnorePathSuffix(suffixs ...string) Filter
  • func IgnoreStatus(statuses ...int) Filter
  • func IgnoreStatusLessThan(status int) Filter
  • func IgnoreStatusLessThanOrEqual(status int) Filter

Functions

func GetRequestID

func GetRequestID(c *fiber.Ctx) string

GetRequestID returns the request identifier

func New

func New(logger *slog.Logger) fiber.Handler

New returns a fiber.Handler (middleware) that logs requests using slog.

Requests with errors are logged using slog.Error(). Requests without errors are logged using slog.Info().

func NewWithConfig

func NewWithConfig(logger *slog.Logger, config Config) fiber.Handler

NewWithConfig returns a fiber.Handler (middleware) that logs requests using slog.

Types

type Config

type Config struct {
	DefaultLevel     slog.Level
	ClientErrorLevel slog.Level
	ServerErrorLevel slog.Level

	WithRequestID bool

	Filters []Filter
}

type Filter

type Filter func(ctx *fiber.Ctx) bool

func Accept

func Accept(filter Filter) Filter

Basic

func AcceptHost

func AcceptHost(hosts ...string) Filter

Host

func AcceptHostContains

func AcceptHostContains(parts ...string) Filter

func AcceptHostMatch

func AcceptHostMatch(regs ...regexp.Regexp) Filter

func AcceptHostPrefix

func AcceptHostPrefix(prefixs ...string) Filter

func AcceptHostSuffix

func AcceptHostSuffix(prefixs ...string) Filter

func AcceptMethod

func AcceptMethod(methods ...string) Filter

Method

func AcceptPath

func AcceptPath(urls ...string) Filter

Path

func AcceptPathContains

func AcceptPathContains(parts ...string) Filter

func AcceptPathMatch

func AcceptPathMatch(regs ...regexp.Regexp) Filter

func AcceptPathPrefix

func AcceptPathPrefix(prefixs ...string) Filter

func AcceptPathSuffix

func AcceptPathSuffix(prefixs ...string) Filter

func AcceptStatus

func AcceptStatus(statuses ...int) Filter

Status

func AcceptStatusGreaterThan

func AcceptStatusGreaterThan(status int) Filter

func AcceptStatusGreaterThanOrEqual

func AcceptStatusGreaterThanOrEqual(status int) Filter

func Ignore

func Ignore(filter Filter) Filter

func IgnoreHost

func IgnoreHost(hosts ...string) Filter

func IgnoreHostContains

func IgnoreHostContains(parts ...string) Filter

func IgnoreHostMatch

func IgnoreHostMatch(regs ...regexp.Regexp) Filter

func IgnoreHostPrefix

func IgnoreHostPrefix(prefixs ...string) Filter

func IgnoreHostSuffix

func IgnoreHostSuffix(suffixs ...string) Filter

func IgnoreMethod

func IgnoreMethod(methods ...string) Filter

func IgnorePath

func IgnorePath(urls ...string) Filter

func IgnorePathContains

func IgnorePathContains(parts ...string) Filter

func IgnorePathMatch

func IgnorePathMatch(regs ...regexp.Regexp) Filter

func IgnorePathPrefix

func IgnorePathPrefix(prefixs ...string) Filter

func IgnorePathSuffix

func IgnorePathSuffix(suffixs ...string) Filter

func IgnoreStatus

func IgnoreStatus(statuses ...int) Filter

func IgnoreStatusLessThan

func IgnoreStatusLessThan(status int) Filter

func IgnoreStatusLessThanOrEqual

func IgnoreStatusLessThanOrEqual(status int) Filter