log

Documentation

Index

• func LevelNames() string
• func SetupGlobalLogger(level string) error
• func ToFile(fileName string) error
• type FileNameHook
  • func NewFilenameHook() *FileNameHook
  • func (f *FileNameHook) Fire(entry *logrus.Entry) error
  • func (f *FileNameHook) Levels() []logrus.Level
• type StepLogger
  • func NewStepLogger(steps uint) *StepLogger
  • func (l *StepLogger) WithStep() *logrus.Entry

Functions

func LevelNames

func LevelNames() string

LevelNames returns a comma separated list of available levels.

func SetupGlobalLogger

func SetupGlobalLogger(level string) error

SetupGlobalLogger uses to provided log level string and applies it globally.

func ToFile

func ToFile(fileName string) error

ToFile adds a file destination to the global logger.

Types

type FileNameHook

type FileNameHook struct {
	Formatter func(file, function string, line int) string
	// contains filtered or unexported fields
}

func NewFilenameHook

func NewFilenameHook() *FileNameHook

NewFilenameHook creates a new default FileNameHook.

func (*FileNameHook) Fire

func (f *FileNameHook) Fire(entry *logrus.Entry) error

Fire executes the hook for every logrus entry.

func (*FileNameHook) Levels

func (f *FileNameHook) Levels() []logrus.Level

Levels returns the levels for which the hook is activated. This contains currently only the DebugLevel.

type StepLogger

type StepLogger struct {
	*logrus.Logger
	// contains filtered or unexported fields
}

StepLogger is a step counting logger implementation.

func NewStepLogger

func NewStepLogger(steps uint) *StepLogger

NewStepLogger creates a new logger.

func (*StepLogger) WithStep

func (l *StepLogger) WithStep() *logrus.Entry

WithStep increments the internal step counter and adds the output to the field.