reqlog

README

Request logging middleware for bunrouter

To install:

go get github.com/uptrace/bunrouter/extra/reqlog

To use:

import "github.com/uptrace/bunrouter/extra/reqlog"

router := bunrouter.New(
    bunrouter.WithMiddleware(reqlog.NewMiddleware()),
)

With options:

import "github.com/uptrace/bunrouter/extra/reqlog"

reqlogMiddleware := reqlog.NewMiddleware(reqlog.WithVerbose(false))

router := bunrouter.New(
    bunrouter.WithMiddleware(reqlogMiddleware),
)

Documentation

Index

• func NewMiddleware(opts ...Option) bunrouter.MiddlewareFunc
• type Option
  • func FromEnv(key string) Option
  • func WithEnabled(on bool) Option
  • func WithVerbose(on bool) Option

Functions

func NewMiddleware

func NewMiddleware(opts ...Option) bunrouter.MiddlewareFunc

Types

type Option

type Option func(m *middleware)

func FromEnv

func FromEnv(key string) Option

WithEnv configures the middleware using the environment variable value. For example, WithEnv("BUNDEBUG"):

• BUNDEBUG=0 - disables the middleware.
• BUNDEBUG=1 - enables the middleware.
• BUNDEBUG=2 - enables the middleware and verbose mode.

func WithEnabled

func WithEnabled(on bool) Option

WithEnabled enables/disables the middleware.

func WithVerbose

func WithVerbose(on bool) Option

WithVerbose configures the middleware to log all requests.