Documentation ¶
Overview ¶
Package klog implements logging analogous to the Google-internal C++ INFO/ERROR/V setup. It provides functions Info, Warning, Error, Fatal, plus formatting variants such as Infof. It also provides V-style logging controlled by the -v and -vmodule=file=2 flags.
Basic examples:
glog.Info("Prepare to repel boarders") glog.Fatalf("Initialization failed: %s", err)
See the documentation for the V function for an explanation of these examples:
if glog.V(2) { glog.Info("Starting transaction...") } glog.V(2).Infoln("Processed", nItems, "elements")
Log output is buffered and written periodically using Flush. Programs should call Flush before exiting to guarantee all log output is written.
By default, all log statements write to standard error. This package provides several flags that modify this behavior. As a result, flag.Parse must be called before any logging is done.
-logtostderr=true Logs are written to standard error instead of to files. -alsologtostderr=false Logs are written to standard error as well as to files. -stderrthreshold=ERROR Log events at or above this severity are logged to standard error as well as to files. -log_dir="" Log files will be written to this directory instead of the default temporary directory. Other flags provide aids to debugging. -log_backtrace_at="" When set to a file and line number holding a logging statement, such as -log_backtrace_at=gopherflakes.go:234 a stack trace will be written to the Info log whenever execution hits that statement. (Unlike with -vmodule, the ".go" must be present.) -v=0 Enable V-leveled logging at the specified level. -vmodule="" The syntax of the argument is a comma-separated list of pattern=N, where pattern is a literal file name (minus the ".go" suffix) or "glob" pattern and N is a V level. For instance, -vmodule=gopher*=3 sets the V level to 3 in all Go files whose names begin "gopher".
Index ¶
- Variables
- func AppendColorCode(inColorCode byte, buf []byte) int
- func AppendDigits(inValue int, buf []byte) int
- func AppendNDigits(inNumDigits int, inValue int, buf []byte, inPad byte) int
- func AppendTimestamp(buf []byte) int
- func CalculateMaxSize() uint64
- func CopyStandardLogTo(name string)
- func Debug(args ...interface{})
- func DebugDepth(depth int, args ...interface{})
- func Debugf(format string, args ...interface{})
- func Debugln(args ...interface{})
- func Error(args ...interface{})
- func ErrorDepth(depth int, args ...interface{})
- func Errorf(format string, args ...interface{})
- func Errorln(args ...interface{})
- func Exit(args ...interface{})
- func ExitDepth(depth int, args ...interface{})
- func Exitf(format string, args ...interface{})
- func Exitln(args ...interface{})
- func Fatal(args ...interface{})
- func FatalDepth(depth int, args ...interface{})
- func Fatalf(format string, args ...interface{})
- func Fatalln(args ...interface{})
- func Flush()
- func Info(args ...interface{})
- func InfoDepth(depth int, args ...interface{})
- func Infof(format string, args ...interface{})
- func Infoln(args ...interface{})
- func InitFlags(flagset *flag.FlagSet)
- func SetFormatter(inFormatter Formatter)
- func SetOutput(w io.Writer)
- func SetOutputBySeverity(name string, w io.Writer)
- func Success(args ...interface{})
- func SuccessDepth(depth int, args ...interface{})
- func Successf(format string, args ...interface{})
- func Successln(args ...interface{})
- func Warning(args ...interface{})
- func WarningDepth(depth int, args ...interface{})
- func Warningf(format string, args ...interface{})
- func Warningln(args ...interface{})
- type FmtConstWidth
- type Formatter
- type Level
- type OutputStats
- type Verbose
Constants ¶
This section is empty.
Variables ¶
var MaxSize uint64 = 1024 * 1024 * 1800
MaxSize is the maximum size of a log file in bytes.
var Stats struct { Debug, Success, Info, Warning, Error OutputStats }
Stats tracks the number of lines of output and number of bytes per severity level. Values must be read with atomic.LoadInt64.
Functions ¶
func AppendColorCode ¶
AppendColorCode appends the console color code to the given slice, returning how many bytes were appended.
func AppendDigits ¶
AppendDigits appends the base 10 value to the given buffer, returning the number of bytes written.
Pre: inValue > 0
func AppendNDigits ¶
AppendNDigits formats an n-digit integer to the given buffer, padding as needed, returning the number of bytes written.
Pre: len(buf) >= inNumDigits
func AppendTimestamp ¶
AppendTimestamp appends a glog/klog-style timestamp to the given slice, returning how many bytes were written.
Pre: len(buf) >= 20
func CalculateMaxSize ¶
func CalculateMaxSize() uint64
CalculateMaxSize returns the real max size in bytes after considering the default max size and the flag options.
func CopyStandardLogTo ¶
func CopyStandardLogTo(name string)
CopyStandardLogTo arranges for messages written to the Go "log" package's default logs to also appear in the Google logs for the named and lower severities. Subsequent changes to the standard log's default output location or format may break this behavior.
Valid names are "INFO", "WARNING", "ERROR", and "FATAL". If the name is not recognized, CopyStandardLogTo panics.
func Debug ¶
func Debug(args ...interface{})
Debug logs to the DEBUG log. Arguments are handled in the manner of fmt.Print; a newline is appended if missing.
func DebugDepth ¶
func DebugDepth(depth int, args ...interface{})
DebugDepth acts as Debug but uses depth to determine which call frame to log. DebugDepth(0, "msg") is the same as Debug("msg").
func Debugf ¶
func Debugf(format string, args ...interface{})
Debugf logs to the DEBUG log. Arguments are handled in the manner of fmt.Printf; a newline is appended if missing.
func Debugln ¶
func Debugln(args ...interface{})
Debugln logs to the DEBUG log. Arguments are handled in the manner of fmt.Println; a newline is appended if missing.
func Error ¶
func Error(args ...interface{})
Error logs to the ERROR, WARNING, and INFO logs. Arguments are handled in the manner of fmt.Print; a newline is appended if missing.
func ErrorDepth ¶
func ErrorDepth(depth int, args ...interface{})
ErrorDepth acts as Error but uses depth to determine which call frame to log. ErrorDepth(0, "msg") is the same as Error("msg").
func Errorf ¶
func Errorf(format string, args ...interface{})
Errorf logs to the ERROR, WARNING, and INFO logs. Arguments are handled in the manner of fmt.Printf; a newline is appended if missing.
func Errorln ¶
func Errorln(args ...interface{})
Errorln logs to the ERROR, WARNING, and INFO logs. Arguments are handled in the manner of fmt.Println; a newline is appended if missing.
func Exit ¶
func Exit(args ...interface{})
Exit logs to the FATAL, ERROR, WARNING, and INFO logs, then calls os.Exit(1). Arguments are handled in the manner of fmt.Print; a newline is appended if missing.
func ExitDepth ¶
func ExitDepth(depth int, args ...interface{})
ExitDepth acts as Exit but uses depth to determine which call frame to log. ExitDepth(0, "msg") is the same as Exit("msg").
func Exitf ¶
func Exitf(format string, args ...interface{})
Exitf logs to the FATAL, ERROR, WARNING, and INFO logs, then calls os.Exit(1). Arguments are handled in the manner of fmt.Printf; a newline is appended if missing.
func Exitln ¶
func Exitln(args ...interface{})
Exitln logs to the FATAL, ERROR, WARNING, and INFO logs, then calls os.Exit(1).
func Fatal ¶
func Fatal(args ...interface{})
Fatal logs to the FATAL, ERROR, WARNING, and INFO logs, including a stack trace of all running goroutines, then calls os.Exit(255). Arguments are handled in the manner of fmt.Print; a newline is appended if missing.
func FatalDepth ¶
func FatalDepth(depth int, args ...interface{})
FatalDepth acts as Fatal but uses depth to determine which call frame to log. FatalDepth(0, "msg") is the same as Fatal("msg").
func Fatalf ¶
func Fatalf(format string, args ...interface{})
Fatalf logs to the FATAL, ERROR, WARNING, and INFO logs, including a stack trace of all running goroutines, then calls os.Exit(255). Arguments are handled in the manner of fmt.Printf; a newline is appended if missing.
func Fatalln ¶
func Fatalln(args ...interface{})
Fatalln logs to the FATAL, ERROR, WARNING, and INFO logs, including a stack trace of all running goroutines, then calls os.Exit(255). Arguments are handled in the manner of fmt.Println; a newline is appended if missing.
func Info ¶
func Info(args ...interface{})
Info logs to the INFO log. Arguments are handled in the manner of fmt.Print; a newline is appended if missing.
func InfoDepth ¶
func InfoDepth(depth int, args ...interface{})
InfoDepth acts as Info but uses depth to determine which call frame to log. InfoDepth(0, "msg") is the same as Info("msg").
func Infof ¶
func Infof(format string, args ...interface{})
Infof logs to the INFO log. Arguments are handled in the manner of fmt.Printf; a newline is appended if missing.
func Infoln ¶
func Infoln(args ...interface{})
Infoln logs to the INFO log. Arguments are handled in the manner of fmt.Println; a newline is appended if missing.
func SetFormatter ¶
func SetFormatter(inFormatter Formatter)
SetFormatter sets the global/default formatter.
By default, the formatter is set to nil, meaning the historcal glog/klog formatter is used.
func SetOutputBySeverity ¶
SetOutputBySeverity sets the output destination for specific severity
func Success ¶
func Success(args ...interface{})
Success logs to the SUCCESS log. Arguments are handled in the manner of fmt.Print; a newline is appended if missing.
func SuccessDepth ¶
func SuccessDepth(depth int, args ...interface{})
SuccessDepth acts as Success but uses depth to determine which call frame to log. SuccessDepth(0, "msg") is the same as Success("msg").
func Successf ¶
func Successf(format string, args ...interface{})
Successf logs to the SUCCESS log. Arguments are handled in the manner of fmt.Printf; a newline is appended if missing.
func Successln ¶
func Successln(args ...interface{})
Successln logs to the SUCCESS log. Arguments are handled in the manner of fmt.Println; a newline is appended if missing.
func Warning ¶
func Warning(args ...interface{})
Warning logs to the WARNING and INFO logs. Arguments are handled in the manner of fmt.Print; a newline is appended if missing.
func WarningDepth ¶
func WarningDepth(depth int, args ...interface{})
WarningDepth acts as Warning but uses depth to determine which call frame to log. WarningDepth(0, "msg") is the same as Warning("msg").
Types ¶
type FmtConstWidth ¶
type FmtConstWidth struct { // FileNameCharWidth is the number of chars to use from the given file name. // Filenames shorter than this are padded with spaces. // If 0, file names are not printed. FileNameCharWidth int // If set, color codes will be inserted UseColor bool }
FmtConstWidth is a basic formatter that makes reasonable attempts to make the header length a constant width, improving readability. It also can insert console color codes so each severity level is a different color.
func (*FmtConstWidth) FormatHeader ¶
func (f *FmtConstWidth) FormatHeader(inSeverity string, inFile string, inLine int, buf *bytes.Buffer)
FormatHeader -- see interface Formatter
type Formatter ¶
type Formatter interface { // FormatHeader writes a formatted header to ioBuf. // This function is presumed to be THREADSAFE. FormatHeader(inSeverity string, inFile string, inLine int, ioBuf *bytes.Buffer) }
Formatter is a pluggable formatter for klog, allowing external users to provider custom formatting.
type Level ¶
type Level int32
Level specifies a level of verbosity for V logs. *Level implements flag.Value; the -v flag is of type Level and should be modified only through the flag.Value interface.
type OutputStats ¶
type OutputStats struct {
// contains filtered or unexported fields
}
OutputStats tracks the number of output lines and bytes written.
func (*OutputStats) Bytes ¶
func (s *OutputStats) Bytes() int64
Bytes returns the number of bytes written.
func (*OutputStats) Lines ¶
func (s *OutputStats) Lines() int64
Lines returns the number of lines written.
type Verbose ¶
type Verbose bool
Verbose is a boolean type that implements Infof (like Printf) etc. See the documentation of V for more information.
func V ¶
V reports whether verbosity at the call site is at least the requested level. The returned value is a boolean of type Verbose, which implements Info, Infoln and Infof. These methods will write to the Info log if called. Thus, one may write either
if glog.V(2) { glog.Info("log this") }
or
glog.V(2).Info("log this")
The second form is shorter but the first is cheaper if logging is off because it does not evaluate its arguments.
Whether an individual call to V generates a log record depends on the setting of the -v and --vmodule flags; both are off by default. If the level in the call to V is at least the value of -v, or of -vmodule for the source file containing the call, the V call will log.
func (Verbose) Info ¶
func (v Verbose) Info(args ...interface{})
Info is equivalent to the global Info function, guarded by the value of v. See the documentation of V for usage.
Directories ¶
Path | Synopsis |
---|---|
examples
|
|
Package klogr implements github.com/go-logr/logr.Logger in terms of k8s.io/klog.
|
Package klogr implements github.com/go-logr/logr.Logger in terms of k8s.io/klog. |