README
¶
go-log Travix logging library
A package with logger implementation for Go. Contains Travix-specific fields
Implementation is influenced by zerolog
Usage
Import the package
go get "github.com/Travix-International/go-log"
A way to create logger with default settings
import "github.com/Travix-International/go-log"
...
cfg := log.NewLoggerConfig()
logger := log.NewLogger(cfg)
Log a message with particular level, type and text
logger.Info("MessageTypeInfo").Log("MessageText")
Log an error
logger.Error("ErrorType").LogErr(err)
Create a new copy of logger with additional field
logger = logger.Str("key", "value")
Benchmarks
Benchmark_Logger/DebugLog-12 181819 5804 ns/op 3504 B/op 31 allocs/op
Benchmark_Logger/DebugStrLog-12 219472 5743 ns/op 3449 B/op 33 allocs/op
Documentation
¶
Index ¶
- type Level
- type Logger
- func (l Logger) Bool(key string, b bool) Logger
- func (l Logger) Bytes(key string, val []byte) Logger
- func (l Logger) Debug(msgType string) Message
- func (l Logger) Error(errorcode string) Message
- func (l Logger) Float64(key string, f float64) Logger
- func (l Logger) GetLogLevel() string
- func (l Logger) Info(msgType string) Message
- func (l Logger) Int(key string, i int) Logger
- func (l Logger) IsDebugLevel() bool
- func (l Logger) JSON(key string, val interface{}) Logger
- func (l Logger) Str(key, val string) Logger
- func (l Logger) Warn(msgType string) Message
- func (l Logger) With() Logger
- func (l Logger) WithLevel(logLevel Level) Logger
- type LoggerConfig
- type Message
- func (m Message) Bool(key string, b bool) Message
- func (m Message) Bytes(key string, val []byte) Message
- func (m Message) Float64(key string, f float64) Message
- func (m Message) Int(key string, i int) Message
- func (m Message) JSON(key string, val interface{}) Message
- func (m Message) Log(msg string)
- func (m Message) LogErr(err error)
- func (m Message) LogJSON(msg string, obj interface{})
- func (m Message) LogMsg(shortMsg, msg string)
- func (m Message) Logf(format string, v ...interface{})
- func (m Message) Str(key, val string) Message
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Level ¶
type Level uint8
Level defines log levels.
const ( // DebugLevel defines debug log level. DebugLevel Level = iota // InfoLevel defines info log level. InfoLevel // WarnLevel defines warn log level. WarnLevel // ErrorLevel defines error log level. ErrorLevel // FatalLevel defines fatal log level. FatalLevel // PanicLevel defines panic log level. PanicLevel // NoLevel defines an absent log level. NoLevel // Disabled disables the logger. Disabled )
func ParseLogLevel ¶
ParseLogLevel parses string representation of log level to an object
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger is a base container for log level and Message template messageTemplate is a pre-filled message which is cloned when a new message is created
func NewLogger ¶
func NewLogger(cfg LoggerConfig) Logger
NewLogger create a new instance of Logger cfg - initial configration
func (Logger) Bytes ¶
Bytes adds the field key with val as a string to the Logger. Runes outside of normal ASCII ranges will be hex-encoded in the resulting JSON.
func (Logger) GetLogLevel ¶
GetLogLevel returns the log level of the Logger.
func (Logger) IsDebugLevel ¶
IsDebugLevel returns true if the current logger has debug level.
type LoggerConfig ¶
type LoggerConfig struct {
AppGroup string
AppName string
AppVersion string
HostName string
LogLevel Level
// contains filtered or unexported fields
}
LoggerConfig set of arguments to create an instance of Logger AppGroup - group name of application. Example: flights AppName - application name. Example: searchApi AppVersion - current version of application Hostname - current hostname Loglevel - initial log level of the Logger out - an output for log messages. Default: os.Stderr uuidGen - a function to generate UUID. Default: uuid.New().String timestampFunc - a function to generate current time.Time. Default: time.Now
func NewLoggerConfig ¶
func NewLoggerConfig() LoggerConfig
NewLoggerConfig returns default configuration for the logger
type Message ¶
type Message struct {
// contains filtered or unexported fields
}
Message represents a log message before marshaling into text representation err - holds error object canLog - flag to write messages with acceptable log level enc - encoder to json format timestampFunc - a function to generate current time.Time. v3template - pre-filled message in v3 log format
func (Message) Bytes ¶
Bytes adds the field key with val as a string to the Message. Runes outside of normal ASCII ranges will be hex-encoded in the resulting JSON.
func (Message) LogJSON ¶
LogJSON sends the Message with the obj added as JSON-encoded in the message field.
func (Message) LogMsg ¶
LogMsg sends the Message with shortmsg added as the message field and msg in the payload
Source Files