README
¶
go-logging
Advanced logger for Golang that supports multiple output formats and simple logging functions.
Simple Example
log.Info("Starting")
defer log.Info("Exiting")
a := 2
b := 3
sum := 5
log.Notice("sum of a and b", "a", a, "b", b, "sum", sum)
if err := doSomethingWithError(); err != nil {
log.Error("could not do something with error", "error", err)
} else {
log.Notice("successfully done something without error")
}
2020-04-17T08:59:51Z [INF] Starting
2020-04-17T08:59:51Z [NOT] sum of a and b A: 2 B: 3 SUM: 5
2020-04-17T08:59:51Z [ERR] could not do something with error ERROR: no such file or directory
2020-04-17T08:59:51Z [INF] Exiting
Advanced Example
opts := []log.Option{
log.OptionEnableDebug(true),
log.OptionWithTimeFormat(time.ANSIC),
log.OptionEnableLocalTime(true),
log.OptionWithLevelKey("_LVL"),
log.OptionWithTimeKey("_TIME"),
log.OptionWithMessageKey("message"),
log.OptionWithStaticKV("_HOSTNAME", "my-hostname"),
log.OptionWithStaticKV("_IP", "123.123.123.123"),
log.OptionWithWriter(os.Stdout),
}
logger := log.New(log.FormatterJSON, opts...)
log.SetLogger(logger)
log.Info("Starting")
defer log.Info("Exiting")
a := 2
b := 3
log.Debug("calculating sum of a and b", "a", a, "b", b)
sum := a + b
log.Notice("sum of a and b", "a", a, "b", b, "sum", sum)
if err := doSomethingWithError(); err != nil {
log.Error("could not do something with error", "error", err)
} else {
log.Notice("successfully done something without error")
}
{"_HOSTNAME":"my-hostname","_IP":"123.123.123.123","_LVL":"Info","_TIME":"Fri Apr 17 11:40:52 2020","_message":"Starting"}
{"_HOSTNAME":"my-hostname","_IP":"123.123.123.123","_LVL":"Debug","_TIME":"Fri Apr 17 11:40:52 2020","_message":"calculating sum of a and b","a":2,"b":3}
{"_HOSTNAME":"my-hostname","_IP":"123.123.123.123","_LVL":"Notice","_TIME":"Fri Apr 17 11:40:52 2020","_message":"sum of a and b","a":2,"b":3,"sum":5}
{"_HOSTNAME":"my-hostname","_IP":"123.123.123.123","_LVL":"Error","_TIME":"Fri Apr 17 11:40:52 2020","_message":"could not do something with error","error":"no such file or directory"}
{"_HOSTNAME":"my-hostname","_IP":"123.123.123.123","_LVL":"Info","_TIME":"Fri Apr 17 11:40:52 2020","_message":"Exiting"}
Documentation
¶
Index ¶
- func Debug(message string, kv ...interface{}) (int, error)
- func Error(message string, kv ...interface{}) (int, error)
- func Fatal(message string, kv ...interface{}) (int, error)
- func FormatterJSON(l *Logger, level string, message string, kv ...interface{}) string
- func FormatterKV(l *Logger, level string, message string, kv ...interface{}) string
- func FormatterSimple(l *Logger, level string, message string, kv ...interface{}) string
- func Info(message string, kv ...interface{}) (int, error)
- func Notice(message string, kv ...interface{}) (int, error)
- func OptionDisableLevel(levelOff bool) func(l *Logger)
- func OptionDisableMutex(mutexOff bool) func(*Logger)
- func OptionDisableTime(timeOff bool) func(l *Logger)
- func OptionEnableDebug(debugOn bool) func(*Logger)
- func OptionEnableLocalTime(localTimeOn bool) func(*Logger)
- func OptionEnableTrace(traceOn bool) func(*Logger)
- func OptionWithLevelKey(key string) func(l *Logger)
- func OptionWithMessageKey(key string) func(l *Logger)
- func OptionWithStaticKV(key string, value interface{}) func(*Logger)
- func OptionWithTimeFormat(format string) func(*Logger)
- func OptionWithTimeKey(key string) func(l *Logger)
- func OptionWithWriter(w io.Writer) func(l *Logger)
- func SetLogger(l *Logger)
- func Trace(message string, kv ...interface{}) (int, error)
- func Warning(message string, kv ...interface{}) (int, error)
- type Formatter
- type Logger
- func (l *Logger) Debug(message string, kv ...interface{}) (int, error)
- func (l *Logger) Error(message string, kv ...interface{}) (int, error)
- func (l *Logger) Fatal(message string, kv ...interface{}) (int, error)
- func (l *Logger) Info(message string, kv ...interface{}) (int, error)
- func (l *Logger) Notice(message string, kv ...interface{}) (int, error)
- func (l *Logger) Print(message string, kv ...interface{}) (int, error)
- func (l *Logger) Trace(message string, kv ...interface{}) (int, error)
- func (l *Logger) Warning(message string, kv ...interface{}) (int, error)
- type Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FormatterJSON ¶
FormatterJSON formats every log line as JSON format
func FormatterKV ¶
FormatterKV formats every log line with key: "value" format using strconv.Quote(...)
func FormatterSimple ¶
FormatterSimple formats every log line in a simple format %timestamp% [%level%] %message% %key-values%
func OptionDisableLevel ¶
OptionDisableLevel removes level from log lines
func OptionDisableMutex ¶
OptionDisableMutex disables mutex protection of writer
func OptionDisableTime ¶
OptionDisableTime removes time from log lines
func OptionEnableDebug ¶
OptionEnableDebug enables/disables debug mode
func OptionEnableLocalTime ¶
OptionEnableLocalTime enables/disables local time instead of utc time
func OptionEnableTrace ¶
OptionEnableTrace enables/disables trace mode
func OptionWithLevelKey ¶
OptionWithLevelKey overwrites the key that is used for level
func OptionWithMessageKey ¶
OptionWithMessageKey overwrites the key that is used for message
func OptionWithStaticKV ¶
OptionWithStaticKV adds a key value pair to each upcoming log line .. This option can be passed multiple times.
func OptionWithTimeFormat ¶
OptionWithTimeFormat changes the time format
func OptionWithTimeKey ¶
OptionWithTimeKey overwrites the key that is used for time
func OptionWithWriter ¶
OptionWithWriter overwrites the writer of the logger
Types ¶
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger holds all logger configurations
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.