logrus

Documentation

Index

• func DefaultJSONFormatter() logrus.Formatter
• func DefaultTextFormatter() logrus.Formatter
• func New(cfg Config) (iface.Logger, error)
• func Use(l *logrus.Logger, cfg Config) (iface.Logger, error)
• type ColorScheme
• type Config
  • func DefaultConfig() Config
• type TextFormatter
  • func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error)
  • func (f *TextFormatter) SetColorScheme(colorScheme *ColorScheme)

Functions

func DefaultJSONFormatter

func DefaultJSONFormatter() logrus.Formatter

func DefaultTextFormatter

func DefaultTextFormatter() logrus.Formatter

func New

func New(cfg Config) (iface.Logger, error)

New creates a new logger with the given configuration

func Use

func Use(l *logrus.Logger, cfg Config) (iface.Logger, error)

Use adapts the given logger based on the provided configuration

Types

type ColorScheme

type ColorScheme struct {
	InfoLevelStyle  string
	WarnLevelStyle  string
	ErrorLevelStyle string
	FatalLevelStyle string
	PanicLevelStyle string
	DebugLevelStyle string
	TraceLevelStyle string
	PrefixStyle     string
	TimestampStyle  string
}

type Config

type Config struct {
	EnableConsole     bool
	FileLocation      string
	Level             iface.Level
	Formatter         logrus.Formatter
	CaptureCallerInfo bool
	NoLock            bool
}

Config contains all configurable values for the Logrus entry

func DefaultConfig

func DefaultConfig() Config

type TextFormatter

type TextFormatter struct {
	// Set to true to bypass checking for a TTY before outputting colors.
	ForceColors bool

	// Force disabling colors. For a TTY colors are enabled by default.
	DisableColors bool

	// Force formatted layout, even for non-TTY output.
	ForceFormatting bool

	// Disable timestamp logging. useful when output is redirected to logging
	// system that already adds timestamps.
	DisableTimestamp bool

	// Disable the conversion of the log levels to uppercase
	DisableUppercase bool

	// Enable logging the full timestamp when a TTY is attached instead of just
	// the time passed since beginning of execution.
	FullTimestamp bool

	// Timestamp format to use for display when a full timestamp is printed.
	TimestampFormat string

	// The fields are sorted by default for a consistent output. For applications
	// that log extremely frequently and don't use the JSON formatter this may not
	// be desired.
	DisableSorting bool

	// Wrap empty fields in quotes if true.
	QuoteEmptyFields bool

	// Can be set to the override the default quoting character "
	// with something else. For example: ', or `.
	QuoteCharacter string

	// Pad msg field with spaces on the right for display.
	// The value for this parameter will be the size of padding.
	// Its default value is zero, which means no padding will be applied for msg.
	SpacePadding int

	sync.Once
	// contains filtered or unexported fields
}

func (*TextFormatter) Format

func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error)

func (*TextFormatter) SetColorScheme

func (f *TextFormatter) SetColorScheme(colorScheme *ColorScheme)