Documentation
¶
Overview ¶
Package logger implements a logging package for use in the Zettelstore.
Index ¶
- type Level
- type LogWriter
- type Logger
- func (l *Logger) Clone() *Message
- func (l *Logger) Debug() *Message
- func (l *Logger) Error() *Message
- func (l *Logger) Info() *Message
- func (l *Logger) Level() Level
- func (l *Logger) Mandatory() *Message
- func (l *Logger) SetLevel(newLevel Level) *Logger
- func (l *Logger) Trace() *Message
- func (l *Logger) WithUser(up UserProvider) *Logger
- type Message
- func (m *Message) Bool(text string, val bool) *Message
- func (m *Message) Bytes(text string, val []byte) *Message
- func (m *Message) Child() *Logger
- func (m *Message) Enabled() bool
- func (m *Message) Err(err error) *Message
- func (m *Message) HTTPIP(r *http.Request) *Message
- func (m *Message) Int(text string, i int64) *Message
- func (m *Message) Msg(text string)
- func (m *Message) Str(text, val string) *Message
- func (m *Message) Uint(text string, u uint64) *Message
- func (m *Message) User(ctx context.Context) *Message
- func (m *Message) Zid(zid id.Zid) *Message
- type UserProvider
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Level ¶
type Level uint8
Level defines the possible log levels
const ( NoLevel Level = iota // the absent log level TraceLevel // Log most internal activities DebugLevel // Log most data updates InfoLevel // Log normal activities ErrorLevel // Log (persistent) errors MandatoryLevel // Log only mandatory events NeverLevel // Logging is disabled )
Constants for Level
type LogWriter ¶
type LogWriter interface {
WriteMessage(level Level, ts time.Time, prefix, msg string, details []byte) error
}
LogWriter writes log messages to their specified destinations.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger represents an objects that emits logging messages.
func New ¶
New creates a new logger for the given service.
This function must only be called from a kernel implementation, not from code that tries to log something.
func (*Logger) Mandatory ¶
Mandatory creates a message that will always logged, except when logging is disabled.
func (*Logger) WithUser ¶
func (l *Logger) WithUser(up UserProvider) *Logger
WithUser creates a derivied logger that allows to retrieve and log user identifer.
type Message ¶
type Message struct {
// contains filtered or unexported fields
}
Message presents a message to log.
func (*Message) HTTPIP ¶ added in v0.5.1
HTTPIP adds the IP address of a HTTP request to the message.
Source Files
Click to show internal directories.
Click to hide internal directories.