logger

Documentation

Overview

package logger is a minimal logger weapper

Index

• Constants
• Variables
• func Debugf(format string, v ...interface{})
• func Errorf(format string, v ...interface{})
• func Fatalf(format string, v ...interface{})
• func Infof(format string, v ...interface{})
• func Log(format string, v ...interface{})
• func Panicf(format string, v ...interface{})
• func Printf(format string, v ...interface{})
• func SetLevel(lvl Level)
• func Tracef(format string, v ...interface{})
• func Warnf(format string, v ...interface{})
• type Level
  • func GetLevel() (lvl Level)
  • func ParseLevel(lvl string) (Level, error)
  • func (level Level) MarshalText() ([]byte, error)
  • func (level Level) String() string
  • func (level *Level) UnmarshalText(text []byte) error
• type Logger
  • func SetLogger(l Logger) (old Logger)

Constants

const LogValid bool = false //nolint:gochecknoglobals //i know that

Variables

var AllLevels = []Level{
	PanicLevel,
	FatalLevel,
	ErrorLevel,
	WarnLevel,
	InfoLevel,
	DebugLevel,
	TraceLevel,
	OffLevel,
}

AllLevels is a constant exposing all logging levels

Functions

func Debugf

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

func Errorf

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

func Fatalf

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

func Infof

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

func Log

func Log(format string, v ...interface{})

func Panicf

func Panicf(format string, v ...interface{})

func Printf

func Printf(format string, v ...interface{})

func SetLevel

func SetLevel(lvl Level)

func Tracef

func Tracef(format string, v ...interface{})

func Warnf

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

Types

type Level

type Level uint32

Level type

const (
	// PanicLevel level, highest level of severity. Logs and then calls panic with the
	// message passed to Debug, Info, ...
	PanicLevel Level = iota
	// FatalLevel level. Logs and then calls `logger.Exit(1)`. It will exit even if the
	// logging level is set to Panic.
	FatalLevel
	// ErrorLevel level. Logs. Used for errors that should definitely be noted.
	// Commonly used for hooks to send errors to an error tracking service.
	ErrorLevel
	// WarnLevel level. Non-critical entries that deserve eyes.
	WarnLevel
	// InfoLevel level. General operational entries about what's going on inside the
	// application.
	InfoLevel
	// DebugLevel level. Usually only enabled when debugging. Very verbose logging.
	DebugLevel
	// TraceLevel level. Designates finer-grained informational events than the Debug.
	TraceLevel
	// OffLevel level. The logger will be shutdown.
	OffLevel
)

These are the different logging levels. You can set the logging level to log on your instance of logger, obtained with `logrus.New()`.

func GetLevel

func GetLevel() (lvl Level)

func ParseLevel

func ParseLevel(lvl string) (Level, error)

ParseLevel takes a string level and returns the Logrus log level constant.

func (Level) MarshalText

func (level Level) MarshalText() ([]byte, error)

MarshalText convert Level to string and []byte

func (Level) String

func (level Level) String() string

Convert the Level to a string. E.g. PanicLevel becomes "panic".

func (*Level) UnmarshalText

func (level *Level) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Logger

type Logger interface {
	Printf(format string, v ...interface{})
	Infof(format string, v ...interface{})
	Warnf(format string, v ...interface{})
	Debugf(format string, v ...interface{})
	Tracef(format string, v ...interface{})

	Errorf(format string, v ...interface{})
	Fatalf(format string, v ...interface{})
	Panicf(format string, v ...interface{})

	SetLevel(lvl Level)
	GetLevel() Level
}

func SetLogger

func SetLogger(l Logger) (old Logger)