log: github.com/gologme/log Index | Files

package log

import "github.com/gologme/log"

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 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. 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. The Fatal functions call os.Exit(1) after writing the log message. The Panic functions call panic after writing the log message.

Index

Package Files

log.go

Constants

const (
    // 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,
    //	2009/01/23 01:23:23.123123 /a/b/c/d.go:23: message
    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
    LstdFlags     = Ldate | Ltime // initial values for the standard logger
)

These flags define which text to prefix to each log entry generated by the Logger.

func Debug Uses

func Debug(v ...interface{})

Debug - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func Debugf Uses

func Debugf(format string, v ...interface{})

Debugf - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Debugln Uses

func Debugln(v ...interface{})

Debugln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func DisableLevel Uses

func DisableLevel(level string)

DisableLevel - This function will disable the output from the supplied logging level

func EnableLevel Uses

func EnableLevel(level string)

EnableLevel - This function will enable the output from the supplied logging level

func Error Uses

func Error(v ...interface{})

Error - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func Errorf Uses

func Errorf(format string, v ...interface{})

Errorf - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Errorln Uses

func Errorln(v ...interface{})

Errorln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func Fatal Uses

func Fatal(v ...interface{})

Fatal is equivalent to Print() followed by a call to os.Exit(1).

func Fatalf Uses

func Fatalf(format string, v ...interface{})

Fatalf is equivalent to Printf() followed by a call to os.Exit(1).

func Fatalln Uses

func Fatalln(v ...interface{})

Fatalln is equivalent to Println() followed by a call to os.Exit(1).

func Flags Uses

func Flags() int

Flags returns the output flags for the standard logger.

func GetLevel Uses

func GetLevel(level string) bool

GetLevel - This function will return the state of a given level

func Info Uses

func Info(v ...interface{})

Info - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func Infof Uses

func Infof(format string, v ...interface{})

Infof - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Infoln Uses

func Infoln(v ...interface{})

Infoln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func Level Uses

func Level(level string, v ...interface{})

Level - This function calls Output to print to the standard logger. The first parameter is a logging level, this allows the printing of arbitrary logging levels. Arguments are handled in the manner of fmt.Print.

func Levelf Uses

func Levelf(level, format string, v ...interface{})

Levelf - This function calls Output to print to the standard logger. The first parameter is a logging level, this allows the printing of arbitrary logging levels. Arguments are handled in the manner of fmt.Printf.

func Levelln Uses

func Levelln(level string, v ...interface{})

Levelln - This function calls Output to print to the standard logger. The first parameter is a logging level, this allows the printing of arbitrary logging levels. Arguments are handled in the manner of fmt.Println.

func Output Uses

func Output(calldepth int, s string) error

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 Panic Uses

func Panic(v ...interface{})

Panic is equivalent to Print() followed by a call to panic().

func Panicf Uses

func Panicf(format string, v ...interface{})

Panicf is equivalent to Printf() followed by a call to panic().

func Panicln Uses

func Panicln(v ...interface{})

Panicln is equivalent to Println() followed by a call to panic().

func Prefix Uses

func Prefix() string

Prefix returns the output prefix for the standard logger.

func Print Uses

func Print(v ...interface{})

Print calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func Printf Uses

func Printf(format string, v ...interface{})

Printf calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Println Uses

func Println(v ...interface{})

Println calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func SetCallDepth Uses

func SetCallDepth(d int)

SetCallDepth - This function will set the call depth. By default the call depth is set at 2. A depth of 2 represents the behavior of the standard library.

func SetFlags Uses

func SetFlags(flag int)

SetFlags sets the output flags for the standard logger.

func SetOutput Uses

func SetOutput(w io.Writer)

SetOutput sets the output destination for the standard logger.

func SetPrefix Uses

func SetPrefix(prefix string)

SetPrefix sets the output prefix for the standard logger.

func Trace Uses

func Trace(v ...interface{})

Trace - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func Tracef Uses

func Tracef(format string, v ...interface{})

Tracef - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Traceln Uses

func Traceln(v ...interface{})

Traceln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func Warn Uses

func Warn(v ...interface{})

Warn - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func Warnf Uses

func Warnf(format string, v ...interface{})

Warnf - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Warnln Uses

func Warnln(v ...interface{})

Warnln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

type Logger Uses

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. A Logger can be used simultaneously from multiple goroutines; it guarantees to serialize access to the Writer.

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 New Uses

func New(out io.Writer, prefix string, flag int) *Logger

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 Uses

func (l *Logger) Debug(v ...interface{})

Debug - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func (*Logger) Debugf Uses

func (l *Logger) Debugf(format string, v ...interface{})

Debugf - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Debugln Uses

func (l *Logger) Debugln(v ...interface{})

Debugln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func (*Logger) DisableLevel Uses

func (l *Logger) DisableLevel(level string)

DisableLevel - This function will disable the output from the supplied logging level

func (*Logger) EnableLevel Uses

func (l *Logger) EnableLevel(level string)

EnableLevel - This function will enable the output from the supplied logging level

func (*Logger) Error Uses

func (l *Logger) Error(v ...interface{})

Error - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func (*Logger) Errorf Uses

func (l *Logger) Errorf(format string, v ...interface{})

Errorf - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Errorln Uses

func (l *Logger) Errorln(v ...interface{})

Errorln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func (*Logger) Fatal Uses

func (l *Logger) Fatal(v ...interface{})

Fatal is equivalent to l.Print() followed by a call to os.Exit(1).

func (*Logger) Fatalf Uses

func (l *Logger) Fatalf(format string, v ...interface{})

Fatalf is equivalent to l.Printf() followed by a call to os.Exit(1).

func (*Logger) Fatalln Uses

func (l *Logger) Fatalln(v ...interface{})

Fatalln is equivalent to l.Println() followed by a call to os.Exit(1).

func (*Logger) Flags Uses

func (l *Logger) Flags() int

Flags returns the output flags for the logger.

func (*Logger) GetLevel Uses

func (l *Logger) GetLevel(level string) bool

GetLevel - This function will return the state of a given level

func (*Logger) Info Uses

func (l *Logger) Info(v ...interface{})

Info - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func (*Logger) Infof Uses

func (l *Logger) Infof(format string, v ...interface{})

Infof - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Infoln Uses

func (l *Logger) Infoln(v ...interface{})

Infoln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func (*Logger) Level Uses

func (l *Logger) Level(level string, v ...interface{})

Level - This function calls Output to print to the standard logger. The first parameter is a logging level, this allows the printing of arbitrary logging levels. Arguments are handled in the manner of fmt.Print.

func (*Logger) Levelf Uses

func (l *Logger) Levelf(level, format string, v ...interface{})

Levelf - This function calls Output to print to the standard logger. The first parameter is a logging level, this allows the printing of arbitrary logging levels. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Levelln Uses

func (l *Logger) Levelln(level string, v ...interface{})

Levelln - This function calls Output to print to the standard logger. The first parameter is a logging level, this allows the printing of arbitrary logging levels. Arguments are handled in the manner of fmt.Println.

func (*Logger) Output Uses

func (l *Logger) Output(level string, s string) error

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.

func (*Logger) Panic Uses

func (l *Logger) Panic(v ...interface{})

Panic is equivalent to l.Print() followed by a call to panic().

func (*Logger) Panicf Uses

func (l *Logger) Panicf(format string, v ...interface{})

Panicf is equivalent to l.Printf() followed by a call to panic().

func (*Logger) Panicln Uses

func (l *Logger) Panicln(v ...interface{})

Panicln is equivalent to l.Println() followed by a call to panic().

func (*Logger) Prefix Uses

func (l *Logger) Prefix() string

Prefix returns the output prefix for the logger.

func (*Logger) Print Uses

func (l *Logger) Print(v ...interface{})

Print calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Print.

func (*Logger) Printf Uses

func (l *Logger) Printf(format string, v ...interface{})

Printf calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Println Uses

func (l *Logger) Println(v ...interface{})

Println calls l.Output to print to the logger. Arguments are handled in the manner of fmt.Println.

func (*Logger) SetCallDepth Uses

func (l *Logger) SetCallDepth(d int)

SetCallDepth - This function will set the call depth. By default the call depth is set at 2. A depth of 2 represents the behavior of the standard library.

func (*Logger) SetFlags Uses

func (l *Logger) SetFlags(flag int)

SetFlags sets the output flags for the logger.

func (*Logger) SetOutput Uses

func (l *Logger) SetOutput(w io.Writer)

SetOutput sets the output destination for the logger.

func (*Logger) SetPrefix Uses

func (l *Logger) SetPrefix(prefix string)

SetPrefix sets the output prefix for the logger.

func (*Logger) Trace Uses

func (l *Logger) Trace(v ...interface{})

Trace - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func (*Logger) Tracef Uses

func (l *Logger) Tracef(format string, v ...interface{})

Tracef - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Traceln Uses

func (l *Logger) Traceln(v ...interface{})

Traceln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

func (*Logger) Warn Uses

func (l *Logger) Warn(v ...interface{})

Warn - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Print.

func (*Logger) Warnf Uses

func (l *Logger) Warnf(format string, v ...interface{})

Warnf - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func (*Logger) Warnln Uses

func (l *Logger) Warnln(v ...interface{})

Warnln - This function calls Output to print to the standard logger. Arguments are handled in the manner of fmt.Println.

Package log imports 6 packages (graph) and is imported by 8 packages. Updated 2020-10-20. Refresh now. Tools for package owners.