sloggin

package module
v1.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 1, 2023 License: MIT Imports: 10 Imported by: 3

README

slog: Gin middleware

tag Go Version GoDoc Build Status Go report Coverage Contributors License

Gin middleware to log http requests using slog.

See also:

🚀 Install

go get github.com/samber/slog-gin

Compatibility: go >= 1.21

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

💡 Usage

Minimal
import (
	"github.com/gin-gonic/gin"
	sloggin "github.com/samber/slog-gin"
	"log/slog"
)

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

router := gin.New()

// Add the sloggin middleware to all routes.
// The middleware will log all requests attributes.
router.Use(sloggin.New(logger))
router.Use(gin.Recovery())

// Example pong request.
router.GET("/pong", func(c *gin.Context) {
    c.String(http.StatusOK, "pong")
})

router.Run(":1234")

// output:
// time=2023-04-10T14:00:0.000000Z level=INFO msg="Incoming request" status=200 method=GET path=/pong route=/pong ip=127.0.0.1 latency=25.5µs user-agent=curl/7.77.0 time=2023-04-10T14:00:00.000Z
OTEL
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))

config := sloggin.Config{
	WithSpanID:  true,
	WithTraceID: true,
}

router := chi.NewRouter()
router.Use(sloggin.NewWithConfig(logger, config))
Verbose
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))

config := sloggin.Config{
	WithRequestBody: true,
	WithResponseBody: true,
	WithRequestHeader: true,
	WithResponseHeader: true,
}

router := chi.NewRouter()
router.Use(sloggin.NewWithConfig(logger, config))
Filters
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))

router := gin.New()
router.Use(
	sloggin.NewWithFilters(
		logger,
		sloggin.Accept(func (c *gin.Context) bool {
			return xxx
		}),
		sloggin.IgnoreStatus(401, 404),
	),
)
router.Use(gin.Recovery())

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/gin-gonic/gin"
	sloggin "github.com/samber/slog-gin"
	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.DateTime, nil),
    )(
        slog.NewTextHandler(os.Stdout, nil),
    ),
)

router := gin.New()

// Add the sloggin middleware to all routes.
// The middleware will log all requests attributes.
router.Use(sloggin.New(logger))
router.Use(gin.Recovery())

// Example pong request.
router.GET("/pong", func(c *gin.Context) {
    c.String(http.StatusOK, "pong")
})

router.Run(":1234")

// output:
// time="2023-04-10 14:00:00" level=INFO msg="Incoming request" status=200 method=GET path=/pong route=/pong ip=127.0.0.1 latency=25.5µs user-agent=curl/7.77.0 time="2023-04-10 14:00:00"
Using custom logger sub-group
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))

router := gin.New()

// Add the sloggin middleware to all routes.
// The middleware will log all requests attributes under a "http" group.
router.Use(sloggin.New(logger.WithGroup("http")))
router.Use(gin.Recovery())

// Example pong request.
router.GET("/pong", func(c *gin.Context) {
    c.String(http.StatusOK, "pong")
})

router.Run(":1234")

// output:
// time=2023-04-10T14:00:0.000000+02:00 level=INFO msg="Incoming request" http.status=200 http.method=GET http.path=/pong http.route=/pong http.ip=127.0.0.1 http.latency=20.125µs http.user-agent=curl/7.77.0 time=2023-04-10T14:00:00.000+02:00
Add logger to a single route
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))

router := gin.New()
router.Use(gin.Recovery())

// Example pong request.
// Add the sloggin middleware to a single routes.
router.GET("/pong", sloggin.New(logger), func(c *gin.Context) {
    c.String(http.StatusOK, "pong")
})

router.Run(":1234")

// output:
// time="2023-04-10 14:00:00" level=INFO msg="Incoming request" status=200 method=GET path=/pong route=/pong ip=127.0.0.1 latency=25.5µs user-agent=curl/7.77.0 time="2023-04-10 14:00:00"
Adding custom attributes
logger := slog.New(slog.NewTextHandler(os.Stdout, nil)).
    With("environment", "production").
    With("server", "gin/1.9.0").
    With("server_start_time", time.Now()).
    With("gin_mode", gin.EnvGinMode)

router := gin.New()

// Add the sloggin middleware to all routes.
// The middleware will log all requests attributes.
router.Use(sloggin.New(logger))
router.Use(gin.Recovery())

// Example pong request.
router.GET("/pong", func(c *gin.Context) {
	// Add an attribute to a single log entry.
	sloggin.AddCustomAttributes(c, slog.String("foo", "bar"))
    c.String(http.StatusOK, "pong")
})

router.Run(":1234")

// output:
// time=2023-04-10T14:00:0.000000+02:00 level=INFO msg="Incoming request" environment=production server=gin/1.9.0 gin_mode=release server_start_time=2023-04-10T10:00:00.000+02:00 status=200 method=GET path=/pong route=/pong ip=127.0.0.1 latency=25.5µs user-agent=curl/7.77.0 time=2023-04-10T14:00:00.000+02:00 foo=bar
JSON output
logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))

router := gin.New()

// Add the sloggin middleware to all routes.
// The middleware will log all requests attributes.
router.Use(sloggin.New(logger))
router.Use(gin.Recovery())

// Example pong request.
router.GET("/pong", func(c *gin.Context) {
    c.String(http.StatusOK, "pong")
})

router.Run(":1234")

// output:
// {"time":"2023-04-10T14:00:0.000000+02:00","level":"INFO","msg":"Incoming request","gin_mode":"GIN_MODE","status":200,"method":"GET","path":"/pong","ip":"127.0.0.1","latency":15542,"user-agent":"curl/7.77.0","time":"2023-04-10T14:00:0.000000+02:00"}

🤝 Contributing

Don't hesitate ;)

# Install some dev dependencies
make tools

# Run tests
make test
# or
make watch-test

👤 Contributors

Contributors

💫 Show your support

Give a ⭐️ if this project helped you!

GitHub Sponsors

📝 License

Copyright © 2023 Samuel Berthe.

This project is MIT licensed.

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	RequestBodyMaxSize  = 64 * 1024 // 64KB
	ResponseBodyMaxSize = 64 * 1024 // 64KB

	HiddenRequestHeaders = map[string]struct{}{
		"authorization": {},
		"cookie":        {},
		"set-cookie":    {},
		"x-auth-token":  {},
		"x-csrf-token":  {},
		"x-xsrf-token":  {},
	}
	HiddenResponseHeaders = map[string]struct{}{
		"set-cookie": {},
	}
)

Functions

func AddCustomAttributes added in v1.3.0

func AddCustomAttributes(c *gin.Context, attr slog.Attr)

func GetRequestID added in v0.2.0

func GetRequestID(c *gin.Context) string

GetRequestID returns the request identifier

func New

func New(logger *slog.Logger) gin.HandlerFunc

New returns a gin.HandlerFunc (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) gin.HandlerFunc

NewWithConfig returns a gin.HandlerFunc (middleware) that logs requests using slog.

func NewWithFilters added in v1.1.0

func NewWithFilters(logger *slog.Logger, filters ...Filter) gin.HandlerFunc

NewWithFilters returns a gin.HandlerFunc (middleware) that logs requests using slog.

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

Types

type Config

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
}

type Filter added in v1.1.0

type Filter func(ctx *gin.Context) bool

func Accept added in v1.1.0

func Accept(filter Filter) Filter

Basic

func AcceptHost added in v1.1.0

func AcceptHost(hosts ...string) Filter

Host

func AcceptHostContains added in v1.1.0

func AcceptHostContains(parts ...string) Filter

func AcceptHostMatch added in v1.1.0

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

func AcceptHostPrefix added in v1.1.0

func AcceptHostPrefix(prefixs ...string) Filter

func AcceptHostSuffix added in v1.1.0

func AcceptHostSuffix(prefixs ...string) Filter

func AcceptMethod added in v1.1.0

func AcceptMethod(methods ...string) Filter

Method

func AcceptPath added in v1.1.0

func AcceptPath(urls ...string) Filter

Path

func AcceptPathContains added in v1.1.0

func AcceptPathContains(parts ...string) Filter

func AcceptPathMatch added in v1.1.0

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

func AcceptPathPrefix added in v1.1.0

func AcceptPathPrefix(prefixs ...string) Filter

func AcceptPathSuffix added in v1.1.0

func AcceptPathSuffix(prefixs ...string) Filter

func AcceptStatus added in v1.1.0

func AcceptStatus(statuses ...int) Filter

Status

func AcceptStatusGreaterThan added in v1.1.0

func AcceptStatusGreaterThan(status int) Filter

func AcceptStatusGreaterThanOrEqual added in v1.1.0

func AcceptStatusGreaterThanOrEqual(status int) Filter

func Ignore added in v1.1.0

func Ignore(filter Filter) Filter

func IgnoreHost added in v1.1.0

func IgnoreHost(hosts ...string) Filter

func IgnoreHostContains added in v1.1.0

func IgnoreHostContains(parts ...string) Filter

func IgnoreHostMatch added in v1.1.0

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

func IgnoreHostPrefix added in v1.1.0

func IgnoreHostPrefix(prefixs ...string) Filter

func IgnoreHostSuffix added in v1.1.0

func IgnoreHostSuffix(suffixs ...string) Filter

func IgnoreMethod added in v1.1.0

func IgnoreMethod(methods ...string) Filter

func IgnorePath added in v1.1.0

func IgnorePath(urls ...string) Filter

func IgnorePathContains added in v1.1.0

func IgnorePathContains(parts ...string) Filter

func IgnorePathMatch added in v1.1.0

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

func IgnorePathPrefix added in v1.1.0

func IgnorePathPrefix(prefixs ...string) Filter

func IgnorePathSuffix added in v1.1.0

func IgnorePathSuffix(suffixs ...string) Filter

func IgnoreStatus added in v1.1.0

func IgnoreStatus(statuses ...int) Filter

func IgnoreStatusLessThan added in v1.1.0

func IgnoreStatusLessThan(status int) Filter

func IgnoreStatusLessThanOrEqual added in v1.1.0

func IgnoreStatusLessThanOrEqual(status int) Filter

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL