Documentation
¶
Overview ¶
Package log implements a simple logging package. It defines a type, Builtin, with methods for formatting output. It also has a predefined 'standard' Builtin accessible through helper functions Print[f|ln], Fatal[f|ln], and Panic[f|ln], which are easier to use than creating a Builtin manually. That logger writes to standard error and prints the date and time of each logged message. The Fatal functions call os.Exit(1) after writing the log message. The Panic functions call panic after writing the log message.
Package builtin contains the Golang's built-in logger with only one change: Don't always add a newline. If someday they fix that, remove this internal package.
See this https://github.com/golang/go/issues/16564 for more info.
Index ¶
- Constants
- func Fatal(v ...interface{})
- func Fatalf(format string, v ...interface{})
- func Fatalln(v ...interface{})
- func Flags() int
- func OutputBuiltin(calldepth int, s string) error
- func Panic(v ...interface{})
- func Panicf(format string, v ...interface{})
- func Panicln(v ...interface{})
- func Prefix() string
- func Print(v ...interface{})
- func Printf(format string, v ...interface{})
- func Println(v ...interface{})
- func SetFlags(flag int)
- func SetOutput(w io.Writer)
- func SetPrefix(prefix string)
- func Writer() io.Writer
- type Builtin
- func (l *Builtin) Fatal(v ...interface{})
- func (l *Builtin) Fatalf(format string, v ...interface{})
- func (l *Builtin) Fatalln(v ...interface{})
- func (l *Builtin) Flags() int
- func (l *Builtin) OutputBuiltin(calldepth int, s string) error
- func (l *Builtin) Panic(v ...interface{})
- func (l *Builtin) Panicf(format string, v ...interface{})
- func (l *Builtin) Panicln(v ...interface{})
- func (l *Builtin) Prefix() string
- func (l *Builtin) Print(v ...interface{})
- func (l *Builtin) Printf(format string, v ...interface{})
- func (l *Builtin) Println(v ...interface{})
- func (l *Builtin) SetFlags(flag int)
- func (l *Builtin) SetOutput(w io.Writer)
- func (l *Builtin) SetPrefix(prefix string)
- func (l *Builtin) Writer() io.Writer
Constants ¶
const ( DefaultCallDepth = 2 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 Lmsgprefix // move the "prefix" from the beginning of the line to before the message LstdFlags = Ldate | Ltime // initial values for the standard logger )
These flags define which text to prefix to each log entry generated by the Builtin. Bits are or'ed together to control what's printed. With the exception of the Lmsgprefix flag, 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 Fatal ¶
func Fatal(v ...interface{})
Fatal is equivalent to Print() followed by a call to os.Exit(1).
func Fatalf ¶
func Fatalf(format string, v ...interface{})
Fatalf is equivalent to Printf() followed by a call to os.Exit(1).
func Fatalln ¶
func Fatalln(v ...interface{})
Fatalln is equivalent to Println() followed by a call to os.Exit(1).
func Flags ¶
func Flags() int
Flags returns the output flags for the standard logger. The flag bits are Ldate, Ltime, and so on.
func OutputBuiltin ¶
OutputBuiltin writes the output for a logging event. The string s contains the text to print after the prefix specified by the flags of the Builtin. 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 OutputBuiltin.
func Panic ¶
func Panic(v ...interface{})
Panic is equivalent to Print() followed by a call to panic().
func Panicf ¶
func Panicf(format string, v ...interface{})
Panicf is equivalent to Printf() followed by a call to panic().
func Panicln ¶
func Panicln(v ...interface{})
Panicln is equivalent to Println() followed by a call to panic().
func Print ¶
func Print(v ...interface{})
Print calls OutputBuiltin to print to the standard logger. Arguments are handled in the manner of fmt.Print.
func Printf ¶
func Printf(format string, v ...interface{})
Printf calls OutputBuiltin to print to the standard logger. Arguments are handled in the manner of fmt.Printf.
func Println ¶
func Println(v ...interface{})
Println calls OutputBuiltin to print to the standard logger. Arguments are handled in the manner of fmt.Println.
func SetFlags ¶
func SetFlags(flag int)
SetFlags sets the output flags for the standard logger. The flag bits are Ldate, Ltime, and so on.
Types ¶
type Builtin ¶
type Builtin struct {
// contains filtered or unexported fields
}
A Builtin 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. A Builtin can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer.
func Default ¶
func Default() *Builtin
Default returns the standard logger used by the package-level output functions.
func NewBuiltin ¶
NewBuiltin creates a new Builtin. The out variable sets the destination to which log data will be written. The prefix appears at the beginning of each generated log line, or after the log header if the Lmsgprefix flag is provided. The flag argument defines the logging properties.
func (*Builtin) Fatal ¶
func (l *Builtin) Fatal(v ...interface{})
Fatal is equivalent to l.Print() followed by a call to os.Exit(1).
func (*Builtin) Fatalln ¶
func (l *Builtin) Fatalln(v ...interface{})
Fatalln is equivalent to l.Println() followed by a call to os.Exit(1).
func (*Builtin) Flags ¶
Flags returns the output flags for the logger. The flag bits are Ldate, Ltime, and so on.
func (*Builtin) OutputBuiltin ¶
OutputBuiltin writes the output for a logging event. The string s contains the text to print after the prefix specified by the flags of the Builtin. 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 (*Builtin) Panic ¶
func (l *Builtin) Panic(v ...interface{})
Panic is equivalent to l.Print() followed by a call to panic().
func (*Builtin) Panicln ¶
func (l *Builtin) Panicln(v ...interface{})
Panicln is equivalent to l.Println() followed by a call to panic().
func (*Builtin) Print ¶
func (l *Builtin) Print(v ...interface{})
Print calls l.OutputBuiltin to print to the logger. Arguments are handled in the manner of fmt.Print.
func (*Builtin) Printf ¶
Printf calls l.OutputBuiltin to print to the logger. Arguments are handled in the manner of fmt.Printf.
func (*Builtin) Println ¶
func (l *Builtin) Println(v ...interface{})
Println calls l.OutputBuiltin to print to the logger. Arguments are handled in the manner of fmt.Println.
func (*Builtin) SetFlags ¶
SetFlags sets the output flags for the logger. The flag bits are Ldate, Ltime, and so on.
Source Files