README.md

id
fiberzap

Fiberzap

Zap logging support for Fiber.

Note: Requires Go 1.19 and above

Install

This middleware supports Fiber v2.

go get -u github.com/gofiber/fiber/v2
go get -u github.com/gofiber/contrib/fiberzap/v2
go get -u go.uber.org/zap

Signature

fiberzap.New(config ...fiberzap.Config) fiber.Handler

Config

Property	Type	Description	Default
Next	func(*Ctx) bool	Define a function to skip this middleware when returned true	nil
Logger	*zap.Logger	Add custom zap logger.	zap.NewDevelopment()
Fields	[]string	Add fields what you want see.	[]string{"latency", "status", "method", "url"}
FieldsFunc	[]zap.Field	Define a function to add custom fields.	nil
Messages	[]string	Custom response messages.	[]string{"Server error", "Client error", "Success"}
Levels	[]zapcore.Level	Custom response levels.	[]zapcore.Level{zapcore.ErrorLevel, zapcore.WarnLevel, zapcore.InfoLevel}
SkipURIs	[]string	Skip logging these URI.	[]string{}
GetResBody	func(c *fiber.Ctx) []byte	Define a function to get response body when return non-nil. eg: When use compress middleware, resBody is unreadable. you can set GetResBody func to get readable resBody.	nil

Example

package main

import (
    "log"

    "github.com/gofiber/fiber/v2"
    "github.com/gofiber/contrib/fiberzap/v2"
    "go.uber.org/zap"
)

func main() {
    app := fiber.New()
    logger, _ := zap.NewProduction()

    app.Use(fiberzap.New(fiberzap.Config{
        Logger: logger,
    }))

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

    log.Fatal(app.Listen(":3000"))
}

NewLogger

Signature

fiberzap.NewLogger(config ...fiberzap.LoggerConfig) *fiberzap.LoggerConfig

LoggerConfig

Property	Type	Description	Default
CoreConfigs	[]CoreConfig	Define Config for zapcore	fiberzap.LoggerConfigDefault
SetLogger	*zap.Logger	Add custom zap logger. if not nil, ZapOptions, CoreConfigs, SetLevel, SetOutput will be ignored.	nil
ExtraKeys	[]string	Allow users log extra values from context.	[]string{}
ZapOptions	[]zap.Option	Allow users to configure the zap.Option supplied by zap.	[]zap.Option{}

Example

package main

import (
	"context"
	"github.com/gofiber/contrib/fiberzap/v2"
	"github.com/gofiber/fiber/v2"
	"github.com/gofiber/fiber/v2/log"
)

func main() {
    app := fiber.New()
    log.SetLogger(fiberzap.NewLogger(fiberzap.LoggerConfig{
        ExtraKeys: []string{"request_id"},
    }))
    app.Use(func(c *fiber.Ctx) error {
        ctx := context.WithValue(c.UserContext(), "request_id", "123")
        c.SetUserContext(ctx)
        return c.Next()
    })
    app.Get("/", func(c *fiber.Ctx) error {
        log.WithContext(c.UserContext()).Info("Hello, World!")
        return c.SendString("Hello, World!")
    })
    log.Fatal(app.Listen(":3000"))
}