fiber/middleware/logger.md

Logger

HTTP request/response logger for Fiber

Example

The middleware packages comes with the official Fiber framework.

import (
  "github.com/gofiber/fiber"
  "github.com/gofiber/fiber/middleware"
)

func main() {
  // ...

  // Default Logger
  app.Use(middleware.Logger())

  // Pass a custom output
  app.Use(middleware.Logger(os.Stdout))

  // Pass a custom time zone
  app.Use(middleware.Logger("UTC"))

  // Pass a custom timeformat
  app.Use(middleware.Logger("15:04:05"))

  // Pass a custom format
  app.Use(middleware.Logger("${time} ${method} ${path}"))

  // Pass a custom  output + timeformat + format
  app.Use(middleware.Logger(os.Stdout, "15:04:05", "${time} ${method} ${path}"))

  // Order does not matter
  app.Use(middleware.Logger("${time} ${method} ${path}", os.Stdout, "15:04:05"))

  // Pass a custom config
  app.Use(middleware.Logger(middleware.LoggerConfig{
      Format:     "${time} ${method} ${path}",
      TimeFormat: "15:04:05",
      TimeZone:   "Asia/Chongqing",
      Output:     os.Stdout,
  }))

  // ...
}

Signature

func Logger(options ...interface{}) fiber.Handler {}

Config

type LoggerConfig struct {
  // Next defines a function to skip this middleware.
  Next func(ctx *fiber.Ctx) bool

  // Format defines the logging tags
  //
  // - time
  // - ip
  // - ips
  // - url
  // - host
  // - method
  // - methodColor
  // - path
  // - protocol
  // - route
  // - referer
  // - ua
  // - latency
  // - status
  // - statusColor
  // - body
  // - error
  // - bytesSent
  // - bytesReceived
  // - header:<key>
  // - query:<key>
  // - form:<key>
  // - cookie:<key>
  // - <color> - e.g. black, red, blue, yellow, cyan, magenta, white, resetColor
  //
  // Optional. Default: ${time} ${method} ${path} - ${ip} - ${status} - ${latency}\n
  Format string

  // TimeFormat https://programming.guide/go/format-parse-string-time-date-example.html
  //
  // Optional. Default: 15:04:05
  TimeFormat string

  // TimeZone can be specified, such as "UTC" and "America/New_York" and "Asia/Chongqing", etc
  //
  // Optional. Default: Local
  TimeZone string

  // Output is a writter where logs are written
  //
  // Default: os.Stderr
  Output io.Writer
}