loggerext

README

Go ApiServer Middleware Logger Ext

Provide an extension of github.com/xgfone/go-apiserver/http/middleware/logger to support to log the request and response header and body, requiring Go1.21+ and github.com/xgfone/go-apiserver@v0.42.0+.

Usage

import _ "github.com/xgfone/go-apiserver-middleware-logger-ext"

Documentation

Overview

Package loggerext provides an extension of "github.com/xgfone/go-apiserver/http/middleware/logger" to support to log the request and response header and body.

Usage

import (
	loggerext "github.com/xgfone/go-apiserver-middleware-logger-ext"
	"github.com/xgfone/go-apiserver/http/router"
)

router.DefaultRouter.Middlewares.InsertFunc(loggerext.WrapHandler)

Index

• func AppendIgnorePath(path string)
• func Collect(w http.ResponseWriter, r *http.Request, appendAttr func(...slog.Attr))
• func DisableLogRespBody(ctx context.Context) context.Context
• func Enabled(req *http.Request) bool
• func Release(w http.ResponseWriter, r *http.Request)
• func WrapHandler(next http.Handler) http.Handler
• func WrapReqRespBody(w http.ResponseWriter, r *http.Request) (http.ResponseWriter, *http.Request)

Functions

func AppendIgnorePath

func AppendIgnorePath(path string)

AppendIgnorePath appends the ignored path, which is not logged.

"" and "/" are ignored. If path ends with "/", it is a prefix matching; Or, an equal matching.

func Collect

func Collect(w http.ResponseWriter, r *http.Request, appendAttr func(...slog.Attr))

Collect collects the key-value log information and appends them by appendAttr.

func DisableLogRespBody

func DisableLogRespBody(ctx context.Context) context.Context

DisableLogRespBody returns a new context to set a flag to indicate not to log the response body.

If not set, use the default policy.

func Enabled

func Enabled(req *http.Request) bool

Enabled reports whether to log the request.

func Release

func Release(w http.ResponseWriter, r *http.Request)

Release tries to release the buffer into the pool.

func WrapHandler

func WrapHandler(next http.Handler) http.Handler

WrapHandler wraps a http handler and returns a new, which will replace the request and response writer, so must be used before the logger middleware.

func WrapReqRespBody

func WrapReqRespBody(w http.ResponseWriter, r *http.Request) (http.ResponseWriter, *http.Request)

WrapReqRespBody wraps the http request and response writer, and returns the new, which is used by the http middleware, such as WrapHandler.

NOTICE: Release should be called after handling the request.