README
¶
boldlygo/log - a simple leveled, structured log
boldlygo/log provides a simple leveled, structured log.
Example
package main
import (
"context"
"net"
"net/http"
"os"
"gitlab.com/boldlygo/log"
)
type Handler struct {
log.Logger
}
func (h Handler) handle(w http.ResponseWriter, r *http.Request) {
// Log with the fields in r.Context() and level debug.
h.Log(r.Context(), log.LevelDebug)
}
func (h Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
// Include the request URI in any log entries.
ctx := log.Context(r.Context(), log.NewField("uri", r.RequestURI))
r = r.WithContext(ctx)
h.handle(w, r)
}
func main() {
logger := log.New(os.Stderr)
svr := &http.Server{
Addr: ":http",
Handler: Handler{
Logger: logger,
},
ErrorLog: logger.Logger,
BaseContext: func(net.Listener) context.Context {
return log.Context(context.Background(), log.NewField("name", "value"))
},
}
svr.ListenAndServe()
}
Documentation
¶
Overview ¶
Package log defines the Logger interface and a basic implementation.
Index ¶
Constants ¶
const ( FieldKeyError = "error" FieldKeyLevel = "level" FieldKeyMessage = "msg" FieldKeyTime = "time" )
Common field keys.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Field ¶
type Field interface {
Key() string
Get() interface{}
}
Field is the interface implemented by types that store structured data for logging.
func FromContext ¶
FromContext returns the fields stored in ctx.
type Formatter ¶ added in v0.2.0
Formatter is the interface implemented by types that can format a Log entry.
type JSONFormat ¶ added in v0.2.0
type JSONFormat struct{}
JSONFormat formats log entries as JSON.
func (JSONFormat) Format ¶ added in v0.2.0
func (JSONFormat) Format(e entry) ([]byte, error)
Format implements the Formatter interface.
type Level ¶
type Level int8
Level is the log severity level.
const ( LevelTrace Level = iota - 2 LevelDebug LevelInfo LevelWarning LevelError LevelFatal // Logger implementations may call os.Exit(1). LevelPanic // Logger implementations may panic. )
Common log severity levels.
func ParseLevel ¶ added in v0.1.3
ParseLevel parses s into a Level.
func (Level) Get ¶ added in v0.1.3
func (l Level) Get() interface{}
Get implements the Field and flag.Getter interfaces.
func (Level) MarshalText ¶
MarshalText implements the encoding.TextMarshaler interface.
func (*Level) UnmarshalText ¶ added in v0.1.3
UnmarshalText implements encoding.TextUnmarshaler.
type Log ¶
type Log struct {
// contains filtered or unexported fields
}
Log is a basic leveled, structured log.
type Msg ¶
type Msg string
Msg is a log message.
type TextFormat ¶ added in v0.2.0
type TextFormat struct{}
TextFormat formats log entries as plain text.
func (TextFormat) Format ¶ added in v0.2.0
func (TextFormat) Format(e entry) ([]byte, error)
Format implements the Formatter interface.
Source Files