middleware

Documentation

Index

• func DefaultLogRowHandle(value *freedom.LogRow) bool
• func GenerateTraceID() (string, error)
• func NewBusFilter() func(freedom.Worker)
• func NewClientPrometheus(serviceName string, p prom) requests.Handler
• func NewRecover() context.Handler
• func NewRequestLogger(traceIDName string, loggerConf ...*RequestLoggerConfig) func(context.Context)
• func NewTrace(traceIDName string) func(context.Context)
• type Logger
  • func NewLogger(traceName, traceID string) *Logger
  • func (l *Logger) Debug(v ...interface{})
  • func (l *Logger) Debugf(format string, v ...interface{})
  • func (l *Logger) Error(v ...interface{})
  • func (l *Logger) Errorf(format string, v ...interface{})
  • func (l *Logger) Fatal(v ...interface{})
  • func (l *Logger) Fatalf(format string, v ...interface{})
  • func (l *Logger) Info(v ...interface{})
  • func (l *Logger) Infof(format string, v ...interface{})
  • func (l *Logger) Log(level golog.Level, v ...interface{})
  • func (l *Logger) Logf(level golog.Level, format string, args ...interface{})
  • func (l *Logger) Print(v ...interface{})
  • func (l *Logger) Printf(format string, args ...interface{})
  • func (l *Logger) Println(v ...interface{})
  • func (l *Logger) SetCallerLevel(level golog.Level)
  • func (l *Logger) Warn(v ...interface{})
  • func (l *Logger) Warnf(format string, v ...interface{})
• type RequestLoggerConfig
  • func DefaultLoggerConfig() *RequestLoggerConfig

Functions

func DefaultLogRowHandle

func DefaultLogRowHandle(value *freedom.LogRow) bool

DefaultLogRowHandle The middleware output of the log line .

func GenerateTraceID

func GenerateTraceID() (string, error)

GenerateTraceID Build a unique ID.

func NewBusFilter

func NewBusFilter() func(freedom.Worker)

NewBusFilter Worker's middleware, filtering HTTP Header.

func NewClientPrometheus

func NewClientPrometheus(serviceName string, p prom) requests.Handler

NewClientPrometheus HTTP Client middleware that monitors requests made.

func NewRecover

func NewRecover() context.Handler

NewRecover Request recover.

func NewRequestLogger

func NewRequestLogger(traceIDName string, loggerConf ...*RequestLoggerConfig) func(context.Context)

NewRequestLogger . Request the log. The name of the incoming trace, taken out of HTTP Header.

func NewTrace

func NewTrace(traceIDName string) func(context.Context)

NewTrace The default HTTP Trace.

Types

type Logger

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

Logger The implementation of Logger..

func NewLogger

func NewLogger(traceName, traceID string) *Logger

NewLogger Create a Loger. The name and value of the incoming Trace. Requests should have their own Loger.

func (*Logger) Debug

func (l *Logger) Debug(v ...interface{})

Debug will print when freedomLogger's Level is debug.

func (*Logger) Debugf

func (l *Logger) Debugf(format string, v ...interface{})

Debugf will print when freedomLogger's Level is debug.

func (*Logger) Error

func (l *Logger) Error(v ...interface{})

Error will print only when freedomLogger's Level is error, warn, info or debug.

func (*Logger) Errorf

func (l *Logger) Errorf(format string, v ...interface{})

Errorf will print only when freedomLogger's Level is error, warn, info or debug.

func (*Logger) Fatal

func (l *Logger) Fatal(v ...interface{})

Fatal `os.Exit(1)` exit no matter the level of the freedomLogger. If the freedomLogger's level is fatal, error, warn, info or debug then it will print the log message too.

func (*Logger) Fatalf

func (l *Logger) Fatalf(format string, v ...interface{})

Fatalf will `os.Exit(1)` no matter the level of the freedomLogger. If the freedomLogger's level is fatal, error, warn, info or debug then it will print the log message too.

func (*Logger) Info

func (l *Logger) Info(v ...interface{})

Info will print when freedomLogger's Level is info or debug.

func (*Logger) Infof

func (l *Logger) Infof(format string, v ...interface{})

Infof will print when freedomLogger's Level is info or debug.

func (*Logger) Log

func (l *Logger) Log(level golog.Level, v ...interface{})

Log prints a leveled log message to the output. This method can be used to use custom log levels if needed. It adds a new line in the end.

func (*Logger) Logf

func (l *Logger) Logf(level golog.Level, format string, args ...interface{})

Logf prints a leveled log message to the output. This method can be used to use custom log levels if needed. It adds a new line in the end.

func (*Logger) Print

func (l *Logger) Print(v ...interface{})

Print prints a log message without levels and colors.

func (*Logger) Printf

func (l *Logger) Printf(format string, args ...interface{})

Printf formats according to a format specifier and writes to `Printer#Output` without levels and colors.

func (*Logger) Println

func (l *Logger) Println(v ...interface{})

Println prints a log message without levels and colors. It adds a new line at the end, it overrides the `NewLine` option.

func (*Logger) SetCallerLevel

func (l *Logger) SetCallerLevel(level golog.Level)

SetCallerLevel .

func (*Logger) Warn

func (l *Logger) Warn(v ...interface{})

Warn will print when freedomLogger's Level is warn, info or debug.

func (*Logger) Warnf

func (l *Logger) Warnf(format string, v ...interface{})

Warnf will print when freedomLogger's Level is warn, info or debug.

type RequestLoggerConfig

type RequestLoggerConfig struct {
	Access               bool
	IP                   bool
	Query                bool
	MessageContextKeys   []string
	MessageHeaderKeys    []string
	RequestRawBody       bool
	RequestRawBodyMaxLen int
	Title                string
	CallerWithLevel      []golog.Level
	// contains filtered or unexported fields
}

RequestLoggerConfig Contains the options for the logger middleware can be optionally be passed to the `New`.

func DefaultLoggerConfig

func DefaultLoggerConfig() *RequestLoggerConfig

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