logging

Documentation

Index

• Constants
• func ConfigureLogger(config schema.Log, log bool) (err error)
• func FormatFilePath(in string, now time.Time) (out string)
• func InitializeLogger(config schema.Log, log bool) (err error)
• func Logger() *logrus.Logger
• type CtxPrintfLogger
  • func LoggerCtxPrintf(level logrus.Level) (logger *CtxPrintfLogger)
  • func (l *CtxPrintfLogger) Printf(_ context.Context, format string, args ...any)
• type LogLevel
  • func (l LogLevel) Level() logrus.Level
• type PrintfLogger
  • func LoggerPrintf(level logrus.Level) (logger *PrintfLogger)
  • func (l *PrintfLogger) Printf(format string, args ...any)

Constants

const (
	FormatText = "text"
	FormatJSON = "json"
)

Log Format values.

const (
	LevelTrace = "trace"
	LevelDebug = "debug"
	LevelInfo  = "info"
	LevelWarn  = "warn"
	LevelError = "error"
)

Log Level values.

const (
	FieldRemoteIP   = "remote_ip"
	FieldMethod     = "method"
	FieldPath       = "path"
	FieldPathRaw    = "path_raw"
	FieldStatusCode = "status_code"
)

Field names.

Functions

func ConfigureLogger

func ConfigureLogger(config schema.Log, log bool) (err error)

ConfigureLogger configures the default loggers level, formatting, and the output destinations.

func FormatFilePath

func FormatFilePath(in string, now time.Time) (out string)

FormatFilePath formats a file path with the given time.

func InitializeLogger

func InitializeLogger(config schema.Log, log bool) (err error)

InitializeLogger configures the default logger similar to ConfigureLogger but also configures the stack levels hook.

func Logger

func Logger() *logrus.Logger

Logger returns the standard logrus logger.

Types

type CtxPrintfLogger

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

CtxPrintfLogger is a logger that implements a common Printf logger with a ctx.

func LoggerCtxPrintf

func LoggerCtxPrintf(level logrus.Level) (logger *CtxPrintfLogger)

LoggerCtxPrintf returns a new CtxPrintfLogger given a level.

func (*CtxPrintfLogger) Printf

func (l *CtxPrintfLogger) Printf(_ context.Context, format string, args ...any)

Printf is the implementation of the interface.

type LogLevel

type LogLevel string

func (LogLevel) Level

func (l LogLevel) Level() logrus.Level

type PrintfLogger

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

PrintfLogger is a logger that implements a common Printf logger.

func LoggerPrintf

func LoggerPrintf(level logrus.Level) (logger *PrintfLogger)

LoggerPrintf returns a new PrintfLogger given a level.

func (*PrintfLogger) Printf

func (l *PrintfLogger) Printf(format string, args ...any)

Printf is the implementation of the interface.