Documentation ¶
Overview ¶
Package log is a modification of the log package included in the Go standard library, adding support for leveled logging, colorized output and JSON formatting. A predefined 'standard' logger which is accessible through helper functions Error[f|ln], Info[f|ln], Debug[f|ln], and Trace[f|ln]. The standard logger writes to standard error and prints the filename and linenumber of the call site of each logged message. Every log message is output on a separate line: if the message being printed does not end in a newline, the logger will add one.
Index ¶
- Constants
- func ClearFlag(flag int)
- func Debug(v ...interface{})
- func Debugf(format string, v ...interface{})
- func Error(v ...interface{})
- func Errorf(format string, v ...interface{})
- func Fatal(v ...interface{})
- func Fatalf(format string, v ...interface{})
- func HasFlag(flag int) bool
- func Info(v ...interface{})
- func Infof(format string, v ...interface{})
- func Loggable(level Level) bool
- func Output(calldepth int, level, s string) error
- func SetColorize(v bool)
- func SetFlags(flag int)
- func SetLevel(v Level)
- func SetOutput(w io.Writer)
- func SetPrefix(pre string)
- func ToggleFlag(flag int)
- func Trace(v ...interface{})
- func Tracef(format string, v ...interface{})
- func Warning(v ...interface{})
- func Warningf(format string, v ...interface{})
- type Level
- type Logger
- func (l *Logger) ClearFlag(flag int)
- func (l *Logger) Debug(v ...interface{})
- func (l *Logger) Debugf(format string, v ...interface{})
- func (l *Logger) Error(v ...interface{})
- func (l *Logger) Errorf(format string, v ...interface{})
- func (l *Logger) Fatal(v ...interface{})
- func (l *Logger) Fatalf(format string, v ...interface{})
- func (l *Logger) Flags() int
- func (l *Logger) HasFlag(flag int) bool
- func (l *Logger) Info(v ...interface{})
- func (l *Logger) Infof(format string, v ...interface{})
- func (l *Logger) Level() Level
- func (l *Logger) Loggable(level Level) bool
- func (l *Logger) Output(calldepth int, level, s string) error
- func (l *Logger) Prefix() string
- func (l *Logger) SetColorize(enabled bool)
- func (l *Logger) SetFlags(flag int)
- func (l *Logger) SetLevel(v Level)
- func (l *Logger) SetOutput(w io.Writer)
- func (l *Logger) SetPrefix(prefix string)
- func (l *Logger) ToggleFlag(flag int)
- func (l *Logger) Trace(v ...interface{})
- func (l *Logger) Tracef(format string, v ...interface{})
- func (l *Logger) Warning(v ...interface{})
- func (l *Logger) Warningf(format string, v ...interface{})
- func (l *Logger) Writer() io.Writer
Constants ¶
const ( Ldate = 1 << iota // the date in the local time zone: 2009/01/23 Ltime // the time in the local time zone: 01:23:23 Lmicroseconds // microsecond resolution: 01:23:23.123123. assumes Ltime. Llongfile // full file name and line number: /a/b/c/d.go:23 Lshortfile // final file name element and line number: d.go:23. overrides Llongfile LUTC // if Ldate or Ltime is set, use UTC rather than the local time zone LJSON // JSON encode log records LstdFlags = Ldate | Ltime | LJSON // initial values for the standard logger )
These flags define which text to prefix to each log entry generated by the Logger. Bits are or'ed together to control what's printed. There is no control over the order they appear (the order listed here) or the format they present (as described in the comments). The prefix is followed by a colon only when Llongfile or Lshortfile is specified. For example, flags Ldate | Ltime (or LstdFlags) produce,
2009/01/23 01:23:23 message
while flags Ldate | Ltime | Lmicroseconds | Llongfile produce,
2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
Variables ¶
This section is empty.
Functions ¶
func Debugf ¶
func Debugf(format string, v ...interface{})
Debugf calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.
func Errorf ¶
func Errorf(format string, v ...interface{})
Errorf calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.
func Fatalf ¶
func Fatalf(format string, v ...interface{})
Fatalf calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.
func Infof ¶
func Infof(format string, v ...interface{})
Infof calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.
func Output ¶
Output writes the output for a logging event. The string s contains the text to print after the prefix specified by the flags of the Logger. A newline is appended if the last character of s is not already a newline. Calldepth is the count of the number of frames to skip when computing the file name and line number if Llongfile or Lshortfile is set; a value of 1 will print the details for the caller of Output.
func SetColorize ¶
func SetColorize(v bool)
SetColorize enables/disables colorized log output by level
func ToggleFlag ¶
func ToggleFlag(flag int)
ToggleFlag toggles the current value of flag on the standard logger
Types ¶
type Level ¶
type Level int
Level is the type for log levels
the available log levels in increasing level of verbosity
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
A Logger represents an active logging object that generates lines of output to an io.Writer. Each logging operation makes a single call to the Writer's Write method. Calldepth is the count of the number of frames to skip when computing the file name and line number if Llongfile or Lshortfile is set. A Logger can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer. This logger adds support for leveled logging with optional JSON formatting and colorized output if the writer is a terminal
func New ¶
New creates a new Logger. The out variable sets the destination to which log data will be written. The prefix appears at the beginning of each generated log line. The flag argument defines the logging properties.
func (*Logger) Debug ¶
func (l *Logger) Debug(v ...interface{})
Debug calls l.Output to conditionally print message string to the logger
func (*Logger) Debugf ¶
Debugf calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Printf.
func (*Logger) Error ¶
func (l *Logger) Error(v ...interface{})
Error calls l.Output to conditionally print message string to the logger
func (*Logger) Errorf ¶
Errorf calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Printf.
func (*Logger) Fatal ¶
func (l *Logger) Fatal(v ...interface{})
Fatal calls l.Output to unconditionally print to the logger, then calls os.Exit(1)
func (*Logger) Fatalf ¶
Fatalf calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Printf.
func (*Logger) Info ¶
func (l *Logger) Info(v ...interface{})
Info calls l.Output to conditionally print message string to the logger
func (*Logger) Infof ¶
Infof calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Printf.
func (*Logger) Loggable ¶
Loggable return true if the given level should be logged at the current log level of the logger; for example, if current log level is Info then calls to Loggable(log.InfoLevel) and Loggable(log.ErrorLevel) would return true while Loggable(log.DebugLevel) would return false
func (*Logger) Output ¶
Output writes the output for a logging event. The string level is the log level of the caller. The string s contains the text to print after the prefix set by the flags of the Logger. A newline is appended if the last character of s is not already a newline. Calldepth is used to recover the PC and is provided for generality, although at the moment on all pre-defined paths it will be 2.
func (*Logger) SetColorize ¶
SetColorize enables/disables colorized output to a terminal writer
func (*Logger) ToggleFlag ¶
ToggleFlag toggles the current setting of flag
func (*Logger) Trace ¶
func (l *Logger) Trace(v ...interface{})
Trace calls l.Output to conditionally print message string to the logger
func (*Logger) Tracef ¶
Tracef calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Printf.
func (*Logger) Warning ¶
func (l *Logger) Warning(v ...interface{})
Warning calls l.Output to conditionally print message string to the logger