logger

Documentation

Overview

Package logger implements logging middleware

Index

• func AnonymizeIP(ip string) string
• func ApacheCombined(l *Middleware)
• func Logger(next http.Handler) http.Handler
• func WithBody(l *Middleware)
• type Backend
• type Middleware
  • func New(options ...Option) *Middleware
  • func (l *Middleware) Handler(next http.Handler) http.Handler
• type Option
  • func IPfn(ipFn func(ip string) string) Option
  • func Log(log Backend) Option
  • func MaxBodySize(max int) Option
  • func Prefix(prefix string) Option
  • func SubjFn(subjFn func(r *http.Request) (string, error)) Option
  • func UserFn(userFn func(r *http.Request) (string, error)) Option

Functions

func AnonymizeIP

func AnonymizeIP(ip string) string

AnonymizeIP is a function to reset the last part of IPv4 to 0. from 123.212.12.78 it will make 123.212.12.0

func ApacheCombined

func ApacheCombined(l *Middleware)

ApacheCombined sets format to Apache Combined Log. See http://httpd.apache.org/docs/2.2/logs.html#combined

func Logger

func Logger(next http.Handler) http.Handler

Logger is a default logger middleware with "REST" prefix

func WithBody

func WithBody(l *Middleware)

WithBody triggers request body logging. Body size is limited (default 1k)

Types

type Backend

type Backend interface {
	Logf(format string, args ...interface{})
}

Backend is logging backend

type Middleware

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

Middleware is a logger for rest requests.

func New

func New(options ...Option) *Middleware

New makes rest logger with given options

func (*Middleware) Handler

func (l *Middleware) Handler(next http.Handler) http.Handler

Handler middleware prints http log

type Option

type Option func(l *Middleware)

Option func type

func IPfn

func IPfn(ipFn func(ip string) string) Option

IPfn sets IP masking function. If ipFn is nil then IP address will be logged as is.

func Log

func Log(log Backend) Option

Log sets logging backend.

func MaxBodySize

func MaxBodySize(max int) Option

MaxBodySize sets size of the logged part of the request body.

func Prefix

func Prefix(prefix string) Option

Prefix sets log line prefix.

func SubjFn

func SubjFn(subjFn func(r *http.Request) (string, error)) Option

SubjFn triggers subject logging if subjFn is not nil.

func UserFn

func UserFn(userFn func(r *http.Request) (string, error)) Option

UserFn triggers user name logging if userFn is not nil.