import "github.com/netbookai/log"
Package log provides a minimal interface for structured logging in services. ColdBrew uses this log package for all logs.
The simplest way to use this package is by calling static log functions to report particular level (error/warning/info/debug)
log.Error(...)
log.Warn(...)
log.Info(...)
log.Debug(...)
You can also initialize a new logger by calling 'log.NewLogger' and passing a loggers.BaseLogger implementation (loggers package provides a number of pre built implementations)
logger := log.NewLogger(gokit.NewLogger())
logger.Info(ctx, "key", "value")
Note: Preferred logging output is in either logfmt or json format, so to facilitate these log function arguments should be in pairs of key-value
log package uses context.Context to pass additional information to logs, you can use 'loggers.AddToLogContext' function to add additional information to logs. For example in access log from service
{"@timestamp":"2018-07-30T09:58:18.262948679Z","caller":"http/http.go:66","error":null,"grpcMethod":"/AuthSvc.AuthService/Authenticate","level":"info","method":"POST","path":"/2.0/authenticate/","took":"1.356812ms","trace":"15592e1b-93df-11e8-bdfd-0242ac110002","transport":"http"}
we pass 'grpcMethod' from context, this information gets automatically added to all log calls called inside the service and makes debugging services much easier. ColdBrew also generates a 'trace' ID per request, this can be used to trace an entire request path in logs.
this package is based on https://github.com/carousell/Orion/tree/master/utils/log
- func Debug(ctx context.Context, args ...interface{})
- func Error(ctx context.Context, args ...interface{})
- func GetLevel() loggers.Level
- func Info(ctx context.Context, args ...interface{})
- func SetLevel(level loggers.Level)
- func SetLogger(l Logger)
- func Warn(ctx context.Context, args ...interface{})
- type Logger
func Debug(ctx context.Context, args ...interface{})
Debug writes out a debug log to global logger
func Error(ctx context.Context, args ...interface{})
Error writes out an error log to global logger
func GetLevel() loggers.Level
GetLevel returns the current log level
func Info(ctx context.Context, args ...interface{})
Info writes out an info log to global logger
func SetLevel(level loggers.Level)
SetLevel sets the log level to filter logs
func SetLogger(l Logger)
SetLogger sets the global logger
func Warn(ctx context.Context, args ...interface{})
Warn writes out a warning log to global logger
Logger interface is implemnted by the log implementation
type Logger interface {
loggers.BaseLogger
Debug(ctx context.Context, args ...interface{})
Info(ctx context.Context, args ...interface{})
Warn(ctx context.Context, args ...interface{})
Error(ctx context.Context, args ...interface{})
}
func GetLogger() Logger
GetLogger returns the global logger
func NewLogger(log loggers.BaseLogger) Logger
NewLogger creates a new logger with a provided BaseLogger
Generated by gomarkdoc