# README
glog
Leveled execution logs for Go.
This is an efficient pure Go implementation of leveled logs in the manner of the open source C++ package http://code.google.com/p/google-glog
By binding methods to booleans it is possible to use the log package without paying the expense of evaluating the arguments to the log. Through the -vmodule flag, the package also provides fine-grained control over logging at the file level.
The comment from glog.go introduces the ideas:
Package glog 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")
The repository contains an open source version of the log package used inside Google. The master copy of the source lives inside Google, not here. The code in this repo is for export only and is not itself under development. Feature requests will be ignored.
Send bug reports to [email protected].
# Functions
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.
No description provided by the author
Error logs to the ERROR, WARNING, and INFO logs.
ErrorDepth acts as Error but uses depth to determine which call frame to log.
Errorf logs to the ERROR, WARNING, and INFO logs.
Errorln logs to the ERROR, WARNING, and INFO logs.
Exit logs to the FATAL, ERROR, WARNING, and INFO logs, then calls os.Exit(1).
ExitDepth acts as Exit but uses depth to determine which call frame to log.
Exitf logs to the FATAL, ERROR, WARNING, and INFO logs, then calls os.Exit(1).
Exitln logs to the FATAL, ERROR, WARNING, and INFO logs, then calls os.Exit(1).
Fatal logs to the FATAL, ERROR, WARNING, and INFO logs, including a stack trace of all running goroutines, then calls os.Exit(255).
FatalDepth acts as Fatal but uses depth to determine which call frame to log.
Fatalf logs to the FATAL, ERROR, WARNING, and INFO logs, including a stack trace of all running goroutines, then calls os.Exit(255).
Fatalln logs to the FATAL, ERROR, WARNING, and INFO logs, including a stack trace of all running goroutines, then calls os.Exit(255).
Flush flushes all pending log I/O.
No description provided by the author
No description provided by the author
No description provided by the author
GetTraceLocation returns the global TraceLocation flag.
GetVerbosity returns the global verbosity level flag.
GetVModule returns the global verbosity pattern flag.
GetVTraceThreshold gets the current verbosity trace threshold for logging.
Info logs to the INFO log.
InfoDepth acts as Info but uses depth to determine which call frame to log.
Infof logs to the INFO log.
Infoln logs to the INFO log.
No description provided by the author
Separator creates a line, ie ---------------------------------.
SetAlsoToStderr sets global output option for logging to both FS and stderr.
No description provided by the author
No description provided by the author
SetToStderr sets the global output style.
SetV sets the global verbosity level.
SetVTraceThreshold sets the current verbosity trace threshold for logging.
V reports whether verbosity at the call site is at least the requested level.
Warning logs to the WARNING and INFO logs.
WarningDepth acts as Warning but uses depth to determine which call frame to log.
Warningf logs to the WARNING and INFO logs.
Warningln logs to the WARNING and INFO logs.
# Constants
These constants identify the interval for log rotation.
These constants identify the interval for log rotation.
These constants identify the interval for log rotation.
These constants identify the interval for log rotation.
These constants identify the interval for log rotation.
# Variables
Compress determines whether to compress rotated logs with GZIP or not.
DefaultAlsoToStdErr establishes the default bool toggling whether logging should be written to BOTH file and stderr.
DefaultDisplay establishes the default verbosity Level for display (stderr) logging.
DefaultLogDirName establishes the default directory name for debug (V) logs.
DefaultToStdErr establishes the default bool toggling whether logging should be directed ONLY to stderr.
DefaultVerbosity establishes the default verbosity Level for to-file (debug) logging.
MaxAge defines the maximum age of the oldest log file.
MaxSize is the maximum size of a log file in bytes.
MaxTotalSize is a maximum size of all log files.
MinSize is a minimum file size qualifying for rotation.
RotationInterval determines how often log rotation should take place.
Stats tracks the number of lines of output and number of bytes per severity level.
# Structs
OutputStats tracks the number of output lines and bytes written.
traceLocation represents the setting of the -log_backtrace_at flag.
# Type aliases
No description provided by the author
Interval is a type for rotation interval specification.
Level specifies a level of verbosity for V logs.
Verbose is a boolean type that implements Infof (like Printf) etc.