README
¶
cog
Package provides to structured log both for displaying it sanely in the stderr logs as well as sending key-valued logs into any log storage such as ElasticSearch.
To setup basic stderr logging, use following snippet in your main.go:
import "github.com/reconquest/cog"
// ...
stderr := lorg.NewLog()
stderr.SetIndentLines(true)
stderr.SetFormat(
lorg.NewFormat("${time} ${level:[%s]:right:short} ${prefix}%s"),
)
if args["--debug"].(bool) {
stderr.SetLevel(lorg.LevelDebug)
}
log = cog.NewLogger(stderr)
// use like that
log.Infof(nil, "message to log: %d", 1)
log.Infof(karma.Describe("key", "value"), "message to log: %d", 1)
err := errors.New("some error")
log.Fatalf(
karma.Describe("context", "testing error").Reason(err),
"message to log: %d",
1,
)
To see more examples of how to use karma for structured logging and error
reporting, consider looking at tests and examples.
Motivation
Following package offers significant improvements above logrus and similar
structured loggers:
- Readable tree-like log entries in stderr, which makes easy to debug program, because log is more readable.
- Allows to use context errors, that used to describe errors on all call-stack levels to ease finding problems and fixing them.
- Sends logs to ES in key-value format like other structured loggers.
- Does not change ordering of key-values in the context.
License
This project is licensed under the terms of the MIT license.
Documentation
¶
Index ¶
- func Display(logger *Logger, level lorg.Level, hierarchy karma.Hierarchical)
- type Displayer
- type Exiter
- type Logger
- func (logger *Logger) Debug(args ...interface{})
- func (logger *Logger) Debugf(context *karma.Context, message string, args ...interface{})
- func (logger *Logger) Display(level lorg.Level, hierarchy karma.Hierarchical)
- func (logger *Logger) Error(args ...interface{})
- func (logger *Logger) Errorf(err error, message string, args ...interface{})
- func (logger *Logger) Fatal(args ...interface{})
- func (logger *Logger) Fatalf(err error, message string, args ...interface{})
- func (logger *Logger) Info(args ...interface{})
- func (logger *Logger) Infof(context *karma.Context, message string, args ...interface{})
- func (logger *Logger) NewChild() *Logger
- func (logger *Logger) NewChildWithPrefix(prefix string) *Logger
- func (logger *Logger) Send(level lorg.Level, hierarchy karma.Hierarchical) error
- func (logger *Logger) SetDisplayer(display Displayer)
- func (logger *Logger) SetExiter(exiter func(int))
- func (logger *Logger) SetSender(sender Sender)
- func (logger *Logger) Trace(args ...interface{})
- func (logger *Logger) TraceJSON(obj interface{}) (encoded string)
- func (logger *Logger) Tracef(context *karma.Context, message string, args ...interface{})
- func (logger *Logger) Warning(args ...interface{})
- func (logger *Logger) Warningf(err error, message string, args ...interface{})
- func (logger *Logger) Write(level lorg.Level, reason interface{}, message string, args ...interface{})
- type Sender
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Logger ¶
Logger provides structured logging methods, based on karma package.
func (*Logger) Display ¶
func (logger *Logger) Display(level lorg.Level, hierarchy karma.Hierarchical)
func (*Logger) NewChildWithPrefix ¶
func (*Logger) SetDisplayer ¶
SetDisplayer sets given function as callack when displays log line
Source Files
Click to show internal directories.
Click to hide internal directories.