access_log

README

Access Logging Middleware

The access logging middleware logs each request with the following information:

• correlationID
• client address
• HTTP method
• path

Example

The access logging will use the default logger slog.Default() and INFO log level.

finalHandler := midgard.StackMiddlewareHandler(
    []midgard.Middleware{
        access_log.New(),
    },
    http.HandlerFunc(HelloHandler),
)

It can also be configured with a custom logger and level.

finalHandler := midgard.StackMiddlewareHandler(
    []midgard.Middleware{
        access_log.New(
            access_log.WithLogger(someOtherLogger),
            access_log.WithLogLevel(slog.LevelDebug),
        ),
    },
    http.HandlerFunc(HelloHandler),
)

Documentation

Index

• func New(options ...func(*Handler) error) (defs.Middleware, error)
• func WithLogLevel(level slog.Level) func(h *Handler) error
• func WithLogger(log *slog.Logger) func(h *Handler) error
• type Handler
  • func (h *Handler) GetMWBase() *defs.MWBase
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Functions

func New

func New(options ...func(*Handler) error) (defs.Middleware, error)

New generates a new access logging middleware.

func WithLogLevel

func WithLogLevel(level slog.Level) func(h *Handler) error

WithLogLevel configures the log level to use with the logger.

func WithLogger

func WithLogger(log *slog.Logger) func(h *Handler) error

WithLogger configures the logger to use.

Types

type Handler

type Handler struct {
	defs.MWBase
}

Handler holds the information necessary for the log

func (*Handler) GetMWBase

func (h *Handler) GetMWBase() *defs.MWBase

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

accessLogging is the access logging middleware. It logs every request with its correlationID, the clients address, http method and accessed path.