logger

Documentation

Overview

Package logger provides request logging via middleware. See _examples/http_request/request-logger

Index

• func Columnize(nowFormatted string, latency time.Duration, status, ip, method, path string, ...) string
• func New(cfg ...Config) context.Handler
• type Config
  • func DefaultConfig() Config
  • func (c *Config) AddSkipper(sk SkipperFunc)
• type SkipperFunc

Functions

func Columnize

func Columnize(nowFormatted string, latency time.Duration, status, ip, method, path string, message interface{}) string

Columnize formats the given arguments as columns and returns the formatted output, note that it appends a new line to the end.

func New

func New(cfg ...Config) context.Handler

New creates and returns a new request logger middleware. Do not confuse it with the framework's Logger. This is for the http requests.

Receives an optional configuation.

Types

type Config

type Config struct {
	// Status displays status code (bool).
	//
	// Defaults to true.
	Status bool
	// IP displays request's remote address (bool).
	//
	// Defaults to true.
	IP bool
	// Method displays the http method (bool).
	//
	// Defaults to true.
	Method bool
	// Path displays the request path (bool).
	//
	// Defaults to true.
	Path bool

	// Columns will display the logs as a formatted columns-rows text (bool).
	// If custom `LogFunc` has been provided then this field is useless and users should
	// use the `Columinize` function of the logger to get the output result as columns.
	//
	// Defaults to false.
	Columns bool

	// MessageContextKey if not empty,
	// the middleware will try to fetch
	// the contents with `ctx.Values().Get(MessageContextKey)`
	// and if available then these contents will be
	// appended as part of the logs (with `%v`, in order to be able to set a struct too),
	// if Columns field was setted to true then
	// a new column will be added named 'Message'.
	//
	// Defaults to empty.
	MessageContextKey string

	// LogFunc is the writer which logs are written to,
	// if missing the logger middleware uses the app.Logger().Infof instead.
	// Note that message argument can be empty.
	LogFunc func(now time.Time, latency time.Duration, status, ip, method, path string, message interface{})
	// Skippers used to skip the logging i.e by `ctx.Path()` and serve
	// the next/main handler immediately.
	Skippers []SkipperFunc
	// contains filtered or unexported fields
}

Config contains the options for the logger middleware can be optionally be passed to the `New`.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns a default config that have all boolean fields to true except `Columns`, all strings are empty, LogFunc and Skippers to nil as well.

func (*Config) AddSkipper

func (c *Config) AddSkipper(sk SkipperFunc)

AddSkipper adds a skipper to the configuration.

type SkipperFunc

type SkipperFunc func(ctx context.Context) bool

The SkipperFunc signature, used to serve the main request without logs. See `Configuration` too.