logger

Documentation

Overview

Package logger contains a service that provides methods to log HTTP requests for both server and client sides.

Index

• Variables
• func Log2Slog(ctx context.Context, parts *LogParts, logger *slog.Logger)
• func WithBody(maxBodySize int) func(l *Logger)
• type LogParts
• type Logger
  • func New(opts ...Option) *Logger
  • func (l *Logger) HTTPClientRoundTripper(next http.RoundTripper) http.RoundTripper
  • func (l *Logger) HTTPServerMiddleware(next http.Handler) http.Handler
• type Option
  • func WithLogFn(fn func(context.Context, *LogParts)) Option
  • func WithLogger(logger *slog.Logger) Option
  • func WithMaskIP(fn func(string) string) Option
  • func WithSanitizeHeaders(fn func(http.Header) map[string]string) Option
  • func WithSanitizeQuery(fn func(string) string) Option
  • func WithUser(fn func(*http.Request) (string, error)) Option
• type RequestInfo
• type ResponseInfo

Variables

var ErrNotHijacker = errors.New("ResponseWriter is not a Hijacker")

ErrNotHijacker is returned when the underlying ResponseWriter does not implement http.Hijacker interface.

Functions

func Log2Slog

func Log2Slog(ctx context.Context, parts *LogParts, logger *slog.Logger)

Log2Slog is the default log function that logs to slog.

func WithBody

func WithBody(maxBodySize int) func(l *Logger)

WithBody sets the maximum request & response body length to be logged. Zero and negative values mean to not log the body at all.

Types

type LogParts

type LogParts struct {
	// Client is true if the logger is used as round tripper.
	Client bool `json:"-"`

	Duration time.Duration `json:"duration"`
	StartAt  time.Time     `json:"start_at"`
	Request  *RequestInfo  `json:"request"`
	Response *ResponseInfo `json:"response"`
}

LogParts contains the information to be logged.

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger provides methods to log HTTP requests for both server and client sides.

func New

func New(opts ...Option) *Logger

New returns a new Logger.

func (*Logger) HTTPClientRoundTripper

func (l *Logger) HTTPClientRoundTripper(next http.RoundTripper) http.RoundTripper

HTTPClientRoundTripper returns a RoundTripper that logs HTTP requests.

func (*Logger) HTTPServerMiddleware

func (l *Logger) HTTPServerMiddleware(next http.Handler) http.Handler

HTTPServerMiddleware returns a middleware that logs HTTP requests.

type Option

type Option func(*Logger)

Option is a function that configures a Logger.

func WithLogFn

func WithLogFn(fn func(context.Context, *LogParts)) Option

WithLogFn sets a custom log function.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger is a shortcut that sets Log2Slog as the log function to log to slog.

func WithMaskIP

func WithMaskIP(fn func(string) string) Option

WithMaskIP sets a custom function to mask IP addresses.

func WithSanitizeHeaders

func WithSanitizeHeaders(fn func(http.Header) map[string]string) Option

WithSanitizeHeaders sets a custom function to sanitize headers.

func WithSanitizeQuery

func WithSanitizeQuery(fn func(string) string) Option

WithSanitizeQuery sets a custom function to sanitize query parameters.

func WithUser

func WithUser(fn func(*http.Request) (string, error)) Option

WithUser sets a custom user function.

type RequestInfo

type RequestInfo struct {
	Method   string `json:"method"`
	URL      string `json:"url"`
	RemoteIP string `json:"remote_ip"`
	Host     string `json:"host"`
	User     string `json:"user"`

	Headers map[string]string `json:"headers"`
	Body    string            `json:"body"`
}

RequestInfo contains the request information to be logged.

type ResponseInfo

type ResponseInfo struct {
	Status int   `json:"status"`
	Size   int64 `json:"size"`
	Error  error `json:"error"`

	Headers map[string]string `json:"headers"`
	Body    string            `json:"body"`
}

ResponseInfo contains the response information to be logged.