log

Documentation

Overview

Package log implements API-related logging helpers.

Index

• func EnabledResponse(rw http.ResponseWriter, r *http.Request, v any)
• func Error(w http.ResponseWriter, r *http.Request, err error)
• func WithErrorLogger(ctx context.Context, fn ErrorLogger) context.Context
• type ErrorLogger
  • func ErrorLoggerFromContext(ctx context.Context) (fn ErrorLogger)
• type StackTracedError

Functions

func EnabledResponse

func EnabledResponse(rw http.ResponseWriter, r *http.Request, v any)

EnabledResponse log the response object if it implements the EnableLogger interface.

func Error

func Error(w http.ResponseWriter, r *http.Request, err error)

Error adds to the response writer the given error if it implements logging.ResponseLogger. If it does not implement it, then writes the error using the log package.

func WithErrorLogger

func WithErrorLogger(ctx context.Context, fn ErrorLogger) context.Context

WithErrorLogger returns a new context with the given error logger.

Types

type ErrorLogger

type ErrorLogger func(http.ResponseWriter, *http.Request, error)

ErrorLogger is the function type used to log errors.

func ErrorLoggerFromContext

func ErrorLoggerFromContext(ctx context.Context) (fn ErrorLogger)

ErrorLoggerFromContext returns an error logger from the context.

type StackTracedError

type StackTracedError interface {
	error

	StackTrace() errors.StackTrace
}

StackTracedError is the set of errors implementing the StackTrace function.

Errors implementing this interface have their stack traces logged when passed to the Error function of this package.