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 NewRequest(cfg *RequestLoggerConfig) 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, args ...interface{})
  • func (l *Logger) Error(v ...interface{})
  • func (l *Logger) Errorf(format string, args ...interface{})
  • func (l *Logger) Fatal(v ...interface{})
  • func (l *Logger) Fatalf(format string, args ...interface{})
  • func (l *Logger) Info(v ...interface{})
  • func (l *Logger) Infof(format string, args ...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) Warn(v ...interface{})
  • func (l *Logger) Warnf(format string, args ...interface{})
• type RequestLoggerConfig
  • func DefaultLoggerConfig() *RequestLoggerConfig

Functions

func DefaultLogRowHandle

func DefaultLogRowHandle(value *freedom.LogRow) bool

DefaultLogRowHandle .

func GenerateTraceID

func GenerateTraceID() (string, error)

GenerateTraceID .

func NewBusFilter

func NewBusFilter() func(freedom.Worker)

NewBusFilter .

func NewClientPrometheus

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

NewClientPrometheus .

func NewRecover

func NewRecover() context.Handler

NewRecover .

func NewRequest

func NewRequest(cfg *RequestLoggerConfig) context.Handler

NewRequest .

func NewRequestLogger

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

NewRequestLogger .

func NewTrace

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

NewTrace .

Types

type Logger

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

Logger .

func NewLogger

func NewLogger(traceName, traceID string) *Logger

NewLogger .

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, args ...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, args ...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, args ...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, args ...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) 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, args ...interface{})

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

type RequestLoggerConfig

type RequestLoggerConfig struct {
	IP                   bool
	Query                bool
	MessageContextKeys   []string
	MessageHeaderKeys    []string
	RequestRawBody       bool
	RequestRawBodyMaxLen int64
	Title                string
	// 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.