log

Documentation

Index

• Constants
• Variables
• func Debug(v ...interface{})
• func Debugf(format string, args ...interface{})
• func Error(v ...interface{})
• func Errorf(format string, args ...interface{})
• func Fatal(v ...interface{})
• func Fatalf(format string, args ...interface{})
• func GetDefaultLevel() string
• func GetLevel() string
• func IncreaseLevel(levels int)
• func Info(v ...interface{})
• func Infof(format string, args ...interface{})
• func Log(level Level, v ...interface{})
• func LogAndExit(level Level, v ...interface{})
• func Logf(level Level, format string, args ...interface{})
• func LogfAndExit(level Level, format string, args ...interface{})
• func Print(v ...interface{})
• func Println(v ...interface{})
• func SetLevel(levelName string)
• func SetLevelFromEnv()
• func Spam(v ...interface{})
• func Spamf(format string, args ...interface{})
• func Verbose(v ...interface{})
• func Verbosef(format string, args ...interface{})
• func Warn(v ...interface{})
• func Warnf(format string, args ...interface{})
• type Level
• type LevelConfig
• type Logger
  • func NewLogger(output io.Writer) *Logger
  • func (l *Logger) Print(message *Message)
  • func (l *Logger) Println(message *Message)
• type Message
• type Mode
• type Processor
  • func NewLogProcessor() *Processor
  • func (lp *Processor) Process()

Constants

const (
	// DisableLevel disables all leveled logs (some output, such as usage, will be
	// still printed).
	DisableLevel = iota
	// FatalLevel logs indicates serious errors, which make program unable to
	// running.
	FatalLevel
	// ErrorLevel logs indicates errors which prevent program to perform some
	// function.
	ErrorLevel
	// WarnLevel logs indicates some less serious errors, which doesn't affect
	// program execution.
	WarnLevel
	// InfoLevel logs confirmates that things are working as expected.
	InfoLevel
	// VerboseLevel logs contain detailed information that should be
	// understandable to experienced users to provide insight in the software’s
	// behavior.
	VerboseLevel
	// DebugLevel logs contain detailed information, typically of interest only
	// when diagnosing problems.
	DebugLevel
	// SpamLevel logs are too verbose for regular debbuging.
	SpamLevel
)

const (
	EscapeMarkerMode     = "klio_mode"
	EscapeMarkerLogLevel = "klio_log_level"
	EscapeMarkerTags     = "klio_tags"
	EscapeMarkerReset    = "klio_reset"
)

const DefaultErrorLevel = ErrorLevel

DefaultErrorLevel represents default level for error logs.

const DefaultLevel = InfoLevel

DefaultLevel represents default level for non-error logs.

const MaxLevel = SpamLevel

MaxLevel represents maximum level for logs.

Variables

var (
	DefaultLogger = NewLogger(os.Stdout)
	ErrorLogger   = NewLogger(os.Stderr)
)

var LevelNames = []string{"disable", "fatal", "error", "warn", "info", "verbose", "debug", "spam"}

LevelNames contains all supported names of logging levels.

var LevelsByName = map[string]Level{
	"disable": DisableLevel,
	"fatal":   FatalLevel,
	"error":   ErrorLevel,
	"warn":    WarnLevel,
	"info":    InfoLevel,
	"verbose": VerboseLevel,
	"debug":   DebugLevel,
	"spam":    SpamLevel,
}

LevelsByName maps level names to golog.Level type.

Functions

func Debug

func Debug(v ...interface{})

Debug will print only when logger's Level is debug or spam.

func Debugf

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

Debugf will print only when logger's Level is debug or spam.

func Error

func Error(v ...interface{})

Error will print only when logger's Level is error, warn, info, verbose, debug or spam.

func Errorf

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

Errorf will print only when logger's Level is error, warn, info, verbose, debug or spam.

func Fatal

func Fatal(v ...interface{})

Fatal `os.Exit(1)` exit no matter the level of the logger. If the logger's level is fatal, error, warn, info, verbose debug or spam then it will print the log message too.

func Fatalf

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

Fatalf will `os.Exit(1)` no matter the level of the logger. If the logger's level is fatal, error, warn, info, verbose debug or spam then it will print the log message too.

func GetDefaultLevel

func GetDefaultLevel() string

GetDefaultLevel returns default logging level name.

func GetLevel

func GetLevel() string

GetLevel returns current logging level name.

func IncreaseLevel

func IncreaseLevel(levels int)

IncreaseLevel changes current level by specified number.

func Info

func Info(v ...interface{})

Info will print only when logger's Level is info, verbose, debug or spam.

func Infof

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

Infof will print only when logger's Level is info, verbose, debug or spam.

func Log

func Log(level Level, v ...interface{})

Log prints message with specified level.

func LogAndExit

func LogAndExit(level Level, v ...interface{})

LogAndExit prints message with specified level and calls os.Exit(1).

func Logf

func Logf(level Level, format string, args ...interface{})

Logf prints message with specified level.

func LogfAndExit

func LogfAndExit(level Level, format string, args ...interface{})

LogfAndExit prints message with specified level and calls os.Exit(1).

func Print

func Print(v ...interface{})

Print prints a log message without levels and colors.

func Println

func Println(v ...interface{})

Println prints a log message without levels and colors. It adds a new line at the end.

func SetLevel

func SetLevel(levelName string)

SetLevel sets minimum level for logs, logs with level above specified value will not be printed.

func SetLevelFromEnv

func SetLevelFromEnv()

SetLevelFromEnv sets minimum level for logs based on environment variables.

func Spam

func Spam(v ...interface{})

Spam will print when logger's Level is spam.

func Spamf

func Spamf(format string, args ...interface{})

Spamf will print when logger's Level is spam.

func Verbose

func Verbose(v ...interface{})

Verbose will print only when logger's Level is verbose, debug or spam.

func Verbosef

func Verbosef(format string, args ...interface{})

Verbosef will print only when logger's Level is verbose, debug or spam.

func Warn

func Warn(v ...interface{})

Warn will print only when logger's Level is warn, info, verbose, debug or spam.

func Warnf

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

Warnf will print only when logger's Level is warn, info, verbose, debug or spam.

Types

type Level

type Level uint32

Level is a number which defines the log level.

type LevelConfig

type LevelConfig struct {
	Name        string
	DisplayText string
	Color       int
}

type Logger

type Logger struct {
	Level   Level
	Printer *pio.Printer
	Output  io.Writer
}

func NewLogger

func NewLogger(output io.Writer) *Logger

func (*Logger) Print

func (l *Logger) Print(message *Message)

func (*Logger) Println

func (l *Logger) Println(message *Message)

type Message

type Message struct {
	Level Level
	Tags  []string
	Text  string
}

type Mode

type Mode string

type Processor

type Processor struct {
	DefaultLevel Level
	DefaultMode  Mode
	Input        io.Reader
	Logger       *Logger
}

func NewLogProcessor

func NewLogProcessor() *Processor

func (*Processor) Process

func (lp *Processor) Process()