The highest tagged major version is
README
¶
log
It is a simple structured logging package for Go.
Features
- easy and configurable
- built-in some handlers
- allow to use different level for each handler
- goroutine safety
- allow to add default fields to every log. ( ex. You maybe want to add
app_idper each app orenvper each environment) - colored text for console handler (
linux,mac, andwindowsare supported) - trace time
- work with error interface
- Go standard context is supported
Handlers
- console
- gelf (graylog)
- memory (unit test)
- discard (benchmark)
Installation
Use go get
go get -u gitlab.silkrode.com.tw/golang/log
Example
package main
import (
"errors"
"gitlab.silkrode.com.tw/golang/log"
"gitlab.silkrode.com.tw/golang/log/handlers/console"
)
func main() {
// use console handler to log all level logs
clog := console.New()
log.RegisterHandler(clog, log.AllLevels...)
// optional: allow handlers to clear all buffer
defer log.Flush()
// use withDefaultFields to add fields to every logs
log.WithDefaultFields(
log.Fields{
"app_id": "santa",
"env": "dev",
},
)
// use trace to get how long it takes
defer log.Trace("time to run").Stop()
// print message use DEBUG level
log.Debug("hello world")
// log information with custom fileds
fields := log.Fields{
"city": "keelung",
}
log.WithFields(fields).Infof("more info")
// log error struct and print error message
err := errors.New("something bad happened")
log.WithError(err).Error("oops...")
}
Output
Benchmarks
Run on MacBook Pro 15-inch 2018 using go version go1.13.5 windows 10 OS
go test -bench=. -benchmem -run=^bb -v
goos: windows
goarch: amd64
pkg: github.com/jasonsoft/log
BenchmarkSmall-12 13483690 82.6 ns/op 0 B/op 0 allocs/op
BenchmarkMedium-12 2489635 605 ns/op 336 B/op 2 allocs/op
BenchmarkLarge-12 479955 2802 ns/op 2183 B/op 9 allocs/op
PASS
ok github.com/jasonsoft/log 4.604s
Documentation
¶
Index ¶
- Variables
- func Debug(msg string)
- func Debugf(msg string, v ...interface{})
- func Error(msg string)
- func Errorf(msg string, v ...interface{})
- func Fatal(msg string)
- func Fatalf(msg string, v ...interface{})
- func Flush()
- func Info(msg string)
- func Infof(msg string, v ...interface{})
- func NewContext(ctx context.Context, e Entry) context.Context
- func Panic(msg string)
- func Panicf(msg string, v ...interface{})
- func RegisterHandler(handler Handler, levels ...Level)
- func Warn(msg string)
- func Warnf(msg string, v ...interface{})
- func WithDefaultFields(fields Fields)
- type Entry
- func (e Entry) Debug(msg string)
- func (e Entry) Debugf(msg string, v ...interface{})
- func (e Entry) Error(msg string)
- func (e Entry) Errorf(msg string, v ...interface{})
- func (e Entry) Fatal(msg string)
- func (e Entry) Fatalf(msg string, v ...interface{})
- func (e Entry) Info(msg string)
- func (e Entry) Infof(msg string, v ...interface{})
- func (e Entry) Panic(msg string)
- func (e Entry) Panicf(msg string, v ...interface{})
- func (e Entry) Stop()
- func (e Entry) Trace(msg string) Entry
- func (e Entry) Warn(msg string)
- func (e Entry) Warnf(msg string, v ...interface{})
- func (e Entry) WithError(err error) Entry
- func (e Entry) WithField(key string, value interface{}) Entry
- func (e Entry) WithFields(fields Fields) Entry
- type Fields
- type Flusher
- type Handler
- type Level
Constants ¶
This section is empty.
Variables ¶
var AllLevels = []Level{ DebugLevel, InfoLevel, WarnLevel, ErrorLevel, PanicLevel, FatalLevel, }
AllLevels is an array of all log levels, for easier registering of all levels to a handler
Functions ¶
func Fatalf ¶
func Fatalf(msg string, v ...interface{})
Fatalf level formatted message, followed by an exit.
func NewContext ¶
NewContext return a new context with a logger value
func RegisterHandler ¶
RegisterHandler adds a new Log Handler and specifies what log levels the handler will be passed log entries for
func WithDefaultFields ¶
func WithDefaultFields(fields Fields)
WithDefaultFields adds fields to every entry instance
Types ¶
type Entry ¶
type Entry struct {
Level Level `json:"level"`
Message string `json:"message"`
Timestamp time.Time `json:"timestamp"`
Fields Fields `json:"fields"` // single map; easy to use for handlers
// contains filtered or unexported fields
}
Entry defines a single log entry
func FromContext ¶
FromContext return a logger from the context
func Trace ¶
Trace returns a new entry with a Stop method to fire off a corresponding completion log, useful with defer.
func WithFields ¶
WithFields returns a log Entry with fields set
func (Entry) Stop ¶
func (e Entry) Stop()
Stop should be used with Trace, to fire off the completion message. When an `err` is passed the "error" field is set, and the log level is error.
func (Entry) Trace ¶
Trace returns a new entry with a Stop method to fire off a corresponding completion log, useful with defer.
func (Entry) WithFields ¶
WithFields adds the provided fields to the current entry
type Fields ¶
type Fields map[string]interface{}
Fields represents a map of entry level data used for structured logging.
type Flusher ¶
type Flusher interface {
Flush() error
}
Flusher is an interface that allow handles have the ability to clear buffer and close connection
type Level ¶
type Level uint8
Level of the log
func GetLevelsFromMinLevel ¶
GetLevelsFromMinLevel returns Levels array which above minLevel
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
handlers
|
|
|
discard
Package discard implements a no-op handler useful for benchmarks and tests.
|
Package discard implements a no-op handler useful for benchmarks and tests. |
|
memory
Package memory implements an in-memory handler useful for testing, as the entries can be accessed after writes.
|
Package memory implements an in-memory handler useful for testing, as the entries can be accessed after writes. |