log

package module
v0.0.0-...-1611311 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 27, 2021 License: BSD-3-Clause Imports: 6 Imported by: 26

README

gologme/log

GoDoc

This is a fork of a fork to replace warnings with errors and say what level it is in the log.

This package is a drop in replacement for the built-in Go log package. All the functionality of the built-in package still exists and is unchanged. In addition, this package contains a series of small enhancements and additions. Namely, it adds four logging levels. These logging levels are:

  • Info
  • Error
  • Debug
  • Trace

In addition to these four defined logging levels, users can also define their own arbitrary logging levels.

Unlike other loggers, these logging levels are not enabled in a chain. Meaning, once a level is enabled, say Error, all levels above it are not also enabled. This package is implemented in such a way that users can individually turn on and turn off the various new logging levels. If existing code uses the build-in log package, no change is needed to use this package.

Another feature that was added, based on comments seen on the various golang boards, is the ability to set the calldepth.

Version

1.2.0

Installation

This package can be installed with the go get command:

go get github.com/gidoBOSSftw5731/log
go install github.com/gidoBOSSftw5731/log

Example

Just like the built-in package, code can still do simple logging just like:

log.Println("some interesting logging message")

In addition to this, users can enable info, error, debug, or trace logging like:

log.EnableLevel("info")
log.EnableLevel("error")
log.EnableLevel("debug")
log.EnableLevel("trace")

Once these levels are enabled, calls to the info, error, debug, or trace loggers will print out just like they do for the Print and Fatal built-in loggers. The functions / methods definitions that are defined for each level, match exactly the ones defined in the built-in package. The new functions/methods are called:

log.Info()
log.Infof()
log.Infoln()
log.Error()
log.Errorf()
log.Errorln()
log.Debug()
log.Debugf()
log.Debugln()
log.Trace()
log.Tracef()
log.Traceln()

In addition to the defined levels, arbitrary levels can be enabled. For example:

log.EnableLevel("tracedebug")

This level can then be used from an application as shown below. All three functions/methods are defined for this: log.Level(), log.Levelln(), log.Levelf(). For each of these, the first argument is the level name.

log.Levelln("tracedebug", "some other neat logging message for this level")

The last thing that was enabled was the ability to define the calldepth. The built-in package from the Go authors had this hard coded to a value of 2. A small change was made to enable this to be set by the application using the log package. From the Go authors source code it seems like the normal possible values would be 1, 2, or 3.

log.SetCallDepth()

License

This is free software, licensed under the same BSD license that the original Go log package was licensed.

Copyright 2017 Bret Jordan, All rights reserved.

Documentation

Overview

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

Constants

View Source
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.

Variables

This section is empty.

Functions

func Debug

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

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

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

func DisableLevel(level string)

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

func EnableLevel

func EnableLevel(level string)

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

func Error

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

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

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

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.

func GetLevel

func GetLevel(level string) bool

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

func Info

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

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

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

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

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

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

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

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 Prefix

func Prefix() string

Prefix returns the output prefix for the standard logger.

func Print

func Print(v ...interface{})

Print calls Output 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 Output to print to the standard logger. Arguments are handled in the manner of fmt.Printf.

func Println

func Println(v ...interface{})

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

func SetCallDepth

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

func SetFlags(flag int)

SetFlags sets the output flags for the standard logger.

func SetOutput

func SetOutput(w io.Writer)

SetOutput sets the output destination for the standard logger.

func SetPrefix

func SetPrefix(prefix string)

SetPrefix sets the output prefix for the standard logger.

func Trace

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

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

func Traceln(v ...interface{})

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

Types

type Logger

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

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

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

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

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

func (l *Logger) DisableLevel(level string)

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

func (*Logger) EnableLevel

func (l *Logger) EnableLevel(level string)

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

func (*Logger) Error

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

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

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

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

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

func (*Logger) Fatalf

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

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

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

func (*Logger) Flags

func (l *Logger) Flags() int

Flags returns the output flags for the logger.

func (*Logger) GetLevel

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

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

func (*Logger) Info

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

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

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

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

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

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

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

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

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

func (*Logger) Panicf

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

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

func (*Logger) Panicln

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

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

func (*Logger) Prefix

func (l *Logger) Prefix() string

Prefix returns the output prefix for the logger.

func (*Logger) Print

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

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

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

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

func (l *Logger) SetFlags(flag int)

SetFlags sets the output flags for the logger.

func (*Logger) SetOutput

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

SetOutput sets the output destination for the logger.

func (*Logger) SetPrefix

func (l *Logger) SetPrefix(prefix string)

SetPrefix sets the output prefix for the logger.

func (*Logger) Trace

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

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

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL