2009-01-26 10:28:07 -07:00
|
|
|
// Copyright 2009 The Go Authors. All rights reserved.
|
|
|
|
// Use of this source code is governed by a BSD-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
2011-04-19 17:57:05 -06:00
|
|
|
// Package log implements a simple logging package. It defines a type, Logger,
|
|
|
|
// with methods for formatting output. It also has a predefined 'standard'
|
|
|
|
// Logger accessible through helper functions Print[f|ln], Fatal[f|ln], and
|
2010-10-13 12:05:45 -06:00
|
|
|
// Panic[f|ln], which are easier to use than creating a Logger manually.
|
|
|
|
// That logger writes to standard error and prints the date and time
|
|
|
|
// of each logged message.
|
2011-02-01 13:47:35 -07:00
|
|
|
// The Fatal functions call os.Exit(1) after writing the log message.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
// The Panic functions call panic after writing the log message.
|
2009-01-26 10:28:07 -07:00
|
|
|
package log
|
|
|
|
|
|
|
|
import (
|
2009-12-15 16:35:38 -07:00
|
|
|
"fmt"
|
|
|
|
"io"
|
|
|
|
"os"
|
2011-11-02 13:54:16 -06:00
|
|
|
"runtime"
|
2010-12-01 11:15:42 -07:00
|
|
|
"sync"
|
2011-11-02 13:54:16 -06:00
|
|
|
"time"
|
2009-01-26 10:28:07 -07:00
|
|
|
)
|
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// These flags define which text to prefix to each log entry generated by the Logger.
|
2009-01-26 10:28:07 -07:00
|
|
|
const (
|
2014-12-29 18:37:54 -07:00
|
|
|
// Bits 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,
|
2012-05-16 06:56:18 -06:00
|
|
|
// 2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
|
2015-04-10 14:33:03 -06:00
|
|
|
Ldate = 1 << iota // the date in the local time zone: 2009/01/23
|
|
|
|
Ltime // the time in the local time zone: 01:23:23
|
2011-04-06 12:48:03 -06:00
|
|
|
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
|
2015-04-10 14:33:03 -06:00
|
|
|
LUTC // if Ldate or Ltime is set, use UTC rather than the local time zone
|
2011-04-06 12:48:03 -06:00
|
|
|
LstdFlags = Ldate | Ltime // initial values for the standard logger
|
2009-01-26 10:28:07 -07:00
|
|
|
)
|
|
|
|
|
2010-12-01 11:15:42 -07:00
|
|
|
// 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. A Logger can be used simultaneously from
|
|
|
|
// multiple goroutines; it guarantees to serialize access to the Writer.
|
2009-01-26 10:28:07 -07:00
|
|
|
type Logger struct {
|
2012-03-06 21:27:11 -07:00
|
|
|
mu sync.Mutex // ensures atomic writes; protects the following fields
|
|
|
|
prefix string // prefix to write at beginning of each line
|
|
|
|
flag int // properties
|
|
|
|
out io.Writer // destination for output
|
|
|
|
buf []byte // for accumulating text to write
|
2009-01-26 10:28:07 -07:00
|
|
|
}
|
|
|
|
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
// New creates a new Logger. The out variable sets the
|
|
|
|
// destination to which log data will be written.
|
2009-03-04 23:46:44 -07:00
|
|
|
// The prefix appears at the beginning of each generated log line.
|
|
|
|
// The flag argument defines the logging properties.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
func New(out io.Writer, prefix string, flag int) *Logger {
|
2010-12-01 11:15:42 -07:00
|
|
|
return &Logger{out: out, prefix: prefix, flag: flag}
|
2009-01-26 10:28:07 -07:00
|
|
|
}
|
|
|
|
|
2015-01-18 20:54:53 -07:00
|
|
|
// SetOutput sets the output destination for the logger.
|
|
|
|
func (l *Logger) SetOutput(w io.Writer) {
|
|
|
|
l.mu.Lock()
|
|
|
|
defer l.mu.Unlock()
|
|
|
|
l.out = w
|
|
|
|
}
|
|
|
|
|
2011-04-06 12:48:03 -06:00
|
|
|
var std = New(os.Stderr, "", LstdFlags)
|
2009-01-26 10:28:07 -07:00
|
|
|
|
2010-10-12 18:27:14 -06:00
|
|
|
// Cheap integer to fixed-width decimal ASCII. Give a negative width to avoid zero-padding.
|
2012-03-06 21:27:11 -07:00
|
|
|
func itoa(buf *[]byte, i int, wid int) {
|
2009-01-26 16:34:16 -07:00
|
|
|
// Assemble decimal in reverse order.
|
2015-01-01 05:19:12 -07:00
|
|
|
var b [20]byte
|
|
|
|
bp := len(b) - 1
|
|
|
|
for i >= 10 || wid > 1 {
|
2009-12-15 16:35:38 -07:00
|
|
|
wid--
|
2015-01-01 05:19:12 -07:00
|
|
|
q := i / 10
|
|
|
|
b[bp] = byte('0' + i - q*10)
|
|
|
|
bp--
|
|
|
|
i = q
|
2009-01-26 16:34:16 -07:00
|
|
|
}
|
2015-01-01 05:19:12 -07:00
|
|
|
// i < 10
|
|
|
|
b[bp] = byte('0' + i)
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, b[bp:]...)
|
2009-01-26 10:28:07 -07:00
|
|
|
}
|
|
|
|
|
2012-03-06 21:27:11 -07:00
|
|
|
func (l *Logger) formatHeader(buf *[]byte, t time.Time, file string, line int) {
|
|
|
|
*buf = append(*buf, l.prefix...)
|
2015-04-10 14:33:03 -06:00
|
|
|
if l.flag&LUTC != 0 {
|
|
|
|
t = t.UTC()
|
|
|
|
}
|
2009-11-09 22:23:52 -07:00
|
|
|
if l.flag&(Ldate|Ltime|Lmicroseconds) != 0 {
|
2010-10-12 18:27:14 -06:00
|
|
|
if l.flag&Ldate != 0 {
|
2011-11-30 10:01:46 -07:00
|
|
|
year, month, day := t.Date()
|
|
|
|
itoa(buf, year, 4)
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, '/')
|
2011-11-30 10:01:46 -07:00
|
|
|
itoa(buf, int(month), 2)
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, '/')
|
2011-11-30 10:01:46 -07:00
|
|
|
itoa(buf, day, 2)
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, ' ')
|
2009-01-26 16:34:16 -07:00
|
|
|
}
|
2009-11-09 22:23:52 -07:00
|
|
|
if l.flag&(Ltime|Lmicroseconds) != 0 {
|
2011-11-30 10:01:46 -07:00
|
|
|
hour, min, sec := t.Clock()
|
|
|
|
itoa(buf, hour, 2)
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, ':')
|
2011-11-30 10:01:46 -07:00
|
|
|
itoa(buf, min, 2)
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, ':')
|
2011-11-30 10:01:46 -07:00
|
|
|
itoa(buf, sec, 2)
|
2009-11-09 22:23:52 -07:00
|
|
|
if l.flag&Lmicroseconds != 0 {
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, '.')
|
2011-11-30 10:01:46 -07:00
|
|
|
itoa(buf, t.Nanosecond()/1e3, 6)
|
2009-01-26 16:34:16 -07:00
|
|
|
}
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, ' ')
|
2009-01-26 16:34:16 -07:00
|
|
|
}
|
|
|
|
}
|
2009-11-09 22:23:52 -07:00
|
|
|
if l.flag&(Lshortfile|Llongfile) != 0 {
|
2011-04-06 12:48:03 -06:00
|
|
|
if l.flag&Lshortfile != 0 {
|
|
|
|
short := file
|
|
|
|
for i := len(file) - 1; i > 0; i-- {
|
|
|
|
if file[i] == '/' {
|
|
|
|
short = file[i+1:]
|
|
|
|
break
|
2009-01-26 16:34:16 -07:00
|
|
|
}
|
|
|
|
}
|
2011-04-06 12:48:03 -06:00
|
|
|
file = short
|
2009-01-26 16:34:16 -07:00
|
|
|
}
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, file...)
|
|
|
|
*buf = append(*buf, ':')
|
2010-10-12 18:27:14 -06:00
|
|
|
itoa(buf, line, -1)
|
2012-03-06 21:27:11 -07:00
|
|
|
*buf = append(*buf, ": "...)
|
2009-01-26 16:34:16 -07:00
|
|
|
}
|
|
|
|
}
|
2009-01-26 10:28:07 -07:00
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// 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 used to recover the PC and is
|
|
|
|
// provided for generality, although at the moment on all pre-defined
|
|
|
|
// paths it will be 2.
|
2011-11-01 20:04:37 -06:00
|
|
|
func (l *Logger) Output(calldepth int, s string) error {
|
2011-11-30 10:01:46 -07:00
|
|
|
now := time.Now() // get this early.
|
2011-04-06 12:48:03 -06:00
|
|
|
var file string
|
|
|
|
var line int
|
2011-07-17 16:46:00 -06:00
|
|
|
l.mu.Lock()
|
|
|
|
defer l.mu.Unlock()
|
2011-04-06 12:48:03 -06:00
|
|
|
if l.flag&(Lshortfile|Llongfile) != 0 {
|
2011-07-17 16:46:00 -06:00
|
|
|
// release lock while getting caller info - it's expensive.
|
|
|
|
l.mu.Unlock()
|
2011-04-06 12:48:03 -06:00
|
|
|
var ok bool
|
|
|
|
_, file, line, ok = runtime.Caller(calldepth)
|
|
|
|
if !ok {
|
|
|
|
file = "???"
|
|
|
|
line = 0
|
|
|
|
}
|
2011-07-17 16:46:00 -06:00
|
|
|
l.mu.Lock()
|
2009-01-26 10:28:07 -07:00
|
|
|
}
|
2012-03-06 21:27:11 -07:00
|
|
|
l.buf = l.buf[:0]
|
2011-04-06 12:48:03 -06:00
|
|
|
l.formatHeader(&l.buf, now, file, line)
|
2012-03-06 21:27:11 -07:00
|
|
|
l.buf = append(l.buf, s...)
|
2015-04-08 15:55:45 -06:00
|
|
|
if len(s) == 0 || s[len(s)-1] != '\n' {
|
2012-03-06 21:27:11 -07:00
|
|
|
l.buf = append(l.buf, '\n')
|
2011-04-06 12:48:03 -06:00
|
|
|
}
|
2012-03-06 21:27:11 -07:00
|
|
|
_, err := l.out.Write(l.buf)
|
2009-12-15 16:35:38 -07:00
|
|
|
return err
|
2009-01-26 10:28:07 -07:00
|
|
|
}
|
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// Printf calls l.Output to print to the logger.
|
|
|
|
// Arguments are handled in the manner of fmt.Printf.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
func (l *Logger) Printf(format string, v ...interface{}) {
|
|
|
|
l.Output(2, fmt.Sprintf(format, v...))
|
|
|
|
}
|
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// Print calls l.Output to print to the logger.
|
|
|
|
// Arguments are handled in the manner of fmt.Print.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
func (l *Logger) Print(v ...interface{}) { l.Output(2, fmt.Sprint(v...)) }
|
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// Println calls l.Output to print to the logger.
|
|
|
|
// Arguments are handled in the manner of fmt.Println.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
func (l *Logger) Println(v ...interface{}) { l.Output(2, fmt.Sprintln(v...)) }
|
|
|
|
|
2011-02-01 13:47:35 -07:00
|
|
|
// Fatal is equivalent to l.Print() followed by a call to os.Exit(1).
|
|
|
|
func (l *Logger) Fatal(v ...interface{}) {
|
2011-01-11 10:57:47 -07:00
|
|
|
l.Output(2, fmt.Sprint(v...))
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
2011-02-01 13:47:35 -07:00
|
|
|
// Fatalf is equivalent to l.Printf() followed by a call to os.Exit(1).
|
|
|
|
func (l *Logger) Fatalf(format string, v ...interface{}) {
|
2011-01-11 10:57:47 -07:00
|
|
|
l.Output(2, fmt.Sprintf(format, v...))
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
2011-02-01 13:47:35 -07:00
|
|
|
// Fatalln is equivalent to l.Println() followed by a call to os.Exit(1).
|
|
|
|
func (l *Logger) Fatalln(v ...interface{}) {
|
2011-01-11 10:57:47 -07:00
|
|
|
l.Output(2, fmt.Sprintln(v...))
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Panic is equivalent to l.Print() followed by a call to panic().
|
|
|
|
func (l *Logger) Panic(v ...interface{}) {
|
|
|
|
s := fmt.Sprint(v...)
|
|
|
|
l.Output(2, s)
|
|
|
|
panic(s)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Panicf is equivalent to l.Printf() followed by a call to panic().
|
|
|
|
func (l *Logger) Panicf(format string, v ...interface{}) {
|
|
|
|
s := fmt.Sprintf(format, v...)
|
|
|
|
l.Output(2, s)
|
|
|
|
panic(s)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Panicln is equivalent to l.Println() followed by a call to panic().
|
|
|
|
func (l *Logger) Panicln(v ...interface{}) {
|
|
|
|
s := fmt.Sprintln(v...)
|
|
|
|
l.Output(2, s)
|
|
|
|
panic(s)
|
|
|
|
}
|
|
|
|
|
2011-04-06 12:48:03 -06:00
|
|
|
// Flags returns the output flags for the logger.
|
|
|
|
func (l *Logger) Flags() int {
|
2011-07-17 16:46:00 -06:00
|
|
|
l.mu.Lock()
|
|
|
|
defer l.mu.Unlock()
|
2011-04-06 12:48:03 -06:00
|
|
|
return l.flag
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetFlags sets the output flags for the logger.
|
|
|
|
func (l *Logger) SetFlags(flag int) {
|
2011-07-17 16:46:00 -06:00
|
|
|
l.mu.Lock()
|
|
|
|
defer l.mu.Unlock()
|
2011-04-06 12:48:03 -06:00
|
|
|
l.flag = flag
|
|
|
|
}
|
|
|
|
|
|
|
|
// Prefix returns the output prefix for the logger.
|
|
|
|
func (l *Logger) Prefix() string {
|
2011-07-17 16:46:00 -06:00
|
|
|
l.mu.Lock()
|
|
|
|
defer l.mu.Unlock()
|
2011-04-06 12:48:03 -06:00
|
|
|
return l.prefix
|
|
|
|
}
|
|
|
|
|
|
|
|
// SetPrefix sets the output prefix for the logger.
|
|
|
|
func (l *Logger) SetPrefix(prefix string) {
|
2011-07-17 16:46:00 -06:00
|
|
|
l.mu.Lock()
|
|
|
|
defer l.mu.Unlock()
|
2011-04-06 12:48:03 -06:00
|
|
|
l.prefix = prefix
|
|
|
|
}
|
|
|
|
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
// SetOutput sets the output destination for the standard logger.
|
|
|
|
func SetOutput(w io.Writer) {
|
2011-07-17 16:46:00 -06:00
|
|
|
std.mu.Lock()
|
|
|
|
defer std.mu.Unlock()
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
std.out = w
|
|
|
|
}
|
|
|
|
|
2011-04-06 12:48:03 -06:00
|
|
|
// Flags returns the output flags for the standard logger.
|
|
|
|
func Flags() int {
|
|
|
|
return std.Flags()
|
|
|
|
}
|
|
|
|
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
// SetFlags sets the output flags for the standard logger.
|
|
|
|
func SetFlags(flag int) {
|
2011-04-06 12:48:03 -06:00
|
|
|
std.SetFlags(flag)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Prefix returns the output prefix for the standard logger.
|
|
|
|
func Prefix() string {
|
|
|
|
return std.Prefix()
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// SetPrefix sets the output prefix for the standard logger.
|
|
|
|
func SetPrefix(prefix string) {
|
2011-04-06 12:48:03 -06:00
|
|
|
std.SetPrefix(prefix)
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
// These functions write to the standard logger.
|
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// Print calls Output to print to the standard logger.
|
|
|
|
// Arguments are handled in the manner of fmt.Print.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
func Print(v ...interface{}) {
|
|
|
|
std.Output(2, fmt.Sprint(v...))
|
|
|
|
}
|
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// Printf calls Output to print to the standard logger.
|
|
|
|
// Arguments are handled in the manner of fmt.Printf.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
func Printf(format string, v ...interface{}) {
|
|
|
|
std.Output(2, fmt.Sprintf(format, v...))
|
|
|
|
}
|
|
|
|
|
2010-10-17 10:20:23 -06:00
|
|
|
// Println calls Output to print to the standard logger.
|
|
|
|
// Arguments are handled in the manner of fmt.Println.
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
func Println(v ...interface{}) {
|
|
|
|
std.Output(2, fmt.Sprintln(v...))
|
|
|
|
}
|
|
|
|
|
2011-02-01 13:47:35 -07:00
|
|
|
// Fatal is equivalent to Print() followed by a call to os.Exit(1).
|
|
|
|
func Fatal(v ...interface{}) {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
std.Output(2, fmt.Sprint(v...))
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
2011-02-01 13:47:35 -07:00
|
|
|
// Fatalf is equivalent to Printf() followed by a call to os.Exit(1).
|
|
|
|
func Fatalf(format string, v ...interface{}) {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
std.Output(2, fmt.Sprintf(format, v...))
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
2011-02-01 13:47:35 -07:00
|
|
|
// Fatalln is equivalent to Println() followed by a call to os.Exit(1).
|
|
|
|
func Fatalln(v ...interface{}) {
|
log: new interface
New logging interface simplifies and generalizes.
1) Loggers now have only one output.
2) log.Stdout, Stderr, Crash and friends are gone.
Logging is now always to standard error by default.
3) log.Panic* replaces log.Crash*.
4) Exiting and panicking are not part of the logger's state; instead
the functions Exit* and Panic* simply call Exit or panic after
printing.
5) There is now one 'standard logger'. Instead of calling Stderr,
use Print etc. There are now triples, by analogy with fmt:
Print, Println, Printf
What was log.Stderr is now best represented by log.Println,
since there are now separate Print and Println functions
(and methods).
6) New functions SetOutput, SetFlags, and SetPrefix allow global
editing of the standard logger's properties. This is new
functionality. For instance, one can call
log.SetFlags(log.Lshortfile|log.Ltime|log.Lmicroseconds)
to get all logging output to show file name, line number, and
time stamp.
In short, for most purposes
log.Stderr -> log.Println or log.Print
log.Stderrf -> log.Printf
log.Crash -> log.Panicln or log.Panic
log.Crashf -> log.Panicf
log.Exit -> log.Exitln or log.Exit
log.Exitf -> log.Exitf (no change)
This has a slight breakage: since loggers now write only to one
output, existing calls to log.New() need to delete the second argument.
Also, custom loggers with exit or panic properties will need to be
reworked.
All package code updated to new interface.
The test has been reworked somewhat.
The old interface will be removed after the new release.
For now, its elements are marked 'deprecated' in their comments.
Fixes #1184.
R=rsc
CC=golang-dev
https://golang.org/cl/2419042
2010-10-12 13:59:18 -06:00
|
|
|
std.Output(2, fmt.Sprintln(v...))
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Panic is equivalent to Print() followed by a call to panic().
|
|
|
|
func Panic(v ...interface{}) {
|
|
|
|
s := fmt.Sprint(v...)
|
|
|
|
std.Output(2, s)
|
|
|
|
panic(s)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Panicf is equivalent to Printf() followed by a call to panic().
|
|
|
|
func Panicf(format string, v ...interface{}) {
|
|
|
|
s := fmt.Sprintf(format, v...)
|
|
|
|
std.Output(2, s)
|
|
|
|
panic(s)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Panicln is equivalent to Println() followed by a call to panic().
|
|
|
|
func Panicln(v ...interface{}) {
|
|
|
|
s := fmt.Sprintln(v...)
|
|
|
|
std.Output(2, s)
|
|
|
|
panic(s)
|
|
|
|
}
|
2015-01-11 20:30:10 -07:00
|
|
|
|
|
|
|
// 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 Output(calldepth int, s string) error {
|
|
|
|
return std.Output(calldepth+1, s) // +1 for this frame.
|
|
|
|
}
|