History

Uriel Fanelli a318691954 Initial commit		2023-02-14 11:33:38 +01:00
..
LICENSE	Initial commit	2023-02-14 11:33:38 +01:00
README.md	Initial commit	2023-02-14 11:33:38 +01:00
log.go	Initial commit	2023-02-14 11:33:38 +01:00

README.md

gologme/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:

Error
Warn
Info
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 Warn, 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.3.0

New to version 1.3.0

Made changes to bring it current as of Go 1.17.1 so it remains a drop in replacement
Made chagnes based on feedback
- Sorted log levels into natural order
- Enabled formatted prefixes that include the log level (e.g., [info] {rest of log line})

Installation

This package can be installed with the go get command:

go get github.com/gologme/log
go install github.com/gologme/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, warn, error, debug, or trace logging like:

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

Once these levels are enabled, calls to the info, warn, 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.Error()
log.Errorf()
log.Errorln()
log.Warn()
log.Warnf()
log.Warnln()
log.Info()
log.Infof()
log.Infoln()
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")

To enable the log level to be included in the prefix enable it.

log.EnableFormattedPrefix()

This will make the log lines look like, note the log level prefix: [debug] 2021/10/15 12:46:52 some logging message

To enable logging by the following numerical levels Level 10 = panic, fatal, error, warn, info, debug, & trace Level 5 = panic, fatal, error, warn, info, & debug Level 4 = panic, fatal, error, warn, & info Level 3 = panic, fatal, error, & warn Level 2 = panic, fatal & error Level 1 = panic, fatal

log.EnableLevelsByNumber(int)

To disable all logging levels

log.DisableAllLevels()

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(int)

License

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