README
¶
logged
A fast logger for Go.
Overview
Install with:
go get github.com/msales/logged
Examples
// Composable handlers
h := logged.LevelFilterHandler(
logged.Info,
logged.StreamHandler(os.Stdout, logged.LogfmtFormat()),
)
// The logger can have an initial context
l := logged.New(h, "env", "prod")
// All messages can have a context
l.Warn("connection error", "redis", conn.Name(), "timeout", conn.Timeout())
Will log the message
lvl=warn msg="connection error" redis=dsn_1 timeout=0.500
License
MIT-License. As is. No warranties whatsoever. Mileage may vary. Batteries not included.
Documentation
¶
Index ¶
- Constants
- type FilterFunc
- type Format
- type Formatter
- type FormatterFunc
- type Handler
- func BufferedStreamHandler(w io.Writer, flushBytes int, flushInterval time.Duration, fmtr Formatter) Handler
- func DiscardHandler() Handler
- func FilterHandler(fn FilterFunc, h Handler) Handler
- func LevelFilterHandler(maxLvl Level, h Handler) Handler
- func StreamHandler(w io.Writer, fmtr Formatter) Handler
- type HandlerFunc
- type Level
- type Logger
Constants ¶
const ( //LevelKey is the key used for message levels. LevelKey = "lvl" // MessageKey is the key used for message descriptions. MessageKey = "msg" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FilterFunc ¶
FilterFunc represents a function that can filter messages.
type Formatter ¶
type Formatter interface {
// Format formats a log message.
Format(msg string, lvl Level, ctx []interface{}) []byte
}
Formatter represents a log message formatter.
func FormatterFromString ¶ added in v0.3.0
FormatterFromString returns a formatter instance appropriate for the given format name.
type FormatterFunc ¶
FormatterFunc is a function formatter.
type Handler ¶
type Handler interface {
// Log write the log message.
Log(msg string, lvl Level, ctx []interface{})
}
Handler represents a log handler.
func BufferedStreamHandler ¶
func BufferedStreamHandler(w io.Writer, flushBytes int, flushInterval time.Duration, fmtr Formatter) Handler
BufferedStreamHandler writes buffered log messages to an io.Writer with the given format.
func DiscardHandler ¶
func DiscardHandler() Handler
DiscardHandler does nothing, discarding all log messages.
func FilterHandler ¶
func FilterHandler(fn FilterFunc, h Handler) Handler
FilterHandler returns a handler that only writes messages to the wrapped handler if the given function evaluates true.
func LevelFilterHandler ¶
LevelFilterHandler returns a handler that
type HandlerFunc ¶
HandlerFunc is a function handler.
func (HandlerFunc) Log ¶
func (h HandlerFunc) Log(msg string, lvl Level, ctx []interface{})
Log write the log message.
type Level ¶
type Level int
Level represents the predefined log level.
func LevelFromString ¶
LevelFromString converts a string to Level.
type Logger ¶
type Logger interface {
// Debug logs a debug message.
Debug(msg string, ctx ...interface{})
// Info logs an informational message.
Info(msg string, ctx ...interface{})
// Warn logs a warning message.
Warn(msg string, ctx ...interface{})
// Error logs an error message.
Error(msg string, ctx ...interface{})
// Crit logs a critical message.
Crit(msg string, ctx ...interface{})
// Close closes the logger.
Close() error
}
Logger represents a log writer.
Source Files