r00t2/go_goutils
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

Add docs for NullLogger.

Browse Source
This commit is contained in:
brent s. 2022-09-06 01:01:39 -04:00
parent 94145fb4c7
commit a2a849600b
Signed by: bts
GPG Key ID: 8C004C2F93481F6B
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
logging/doc.go
View File

@ -3,18 +3,19 @@ Package logging implements and presents various loggers under a unified interfac


These particular loggers (logging.Logger) available are: These particular loggers (logging.Logger) available are:


NullLogger
StdLogger StdLogger
FileLogger FileLogger
SystemDLogger (Linux only) SystemDLogger (Linux only)
SyslogLogger (Linux only) SyslogLogger (Linux only)
WinLogger (Windows only) WinLogger (Windows only)


There is a sixth type of logging.Logger, MultiLogger, that allows for multiple loggers to be written to with a single call. There is a seventh type of logging.Logger, MultiLogger, that allows for multiple loggers to be written to with a single call.
As you may have guessed, NullLogger doesn't actually log anything but is fully "functional" as a logging.Logger.


Note that for some Loggers, the prefix may be modified - "literal" loggers (StdLogger and FileLogger) will append a space to the end of the prefix. Note that for some Loggers, the prefix may be modified - "literal" loggers (StdLogger and FileLogger) will append a space to the end of the prefix.
If this is undesired (unlikely), you will need to modify (Logger).Prefix and run (Logger).Logger.SetPrefix(yourPrefixHere) for the respective logger. If this is undesired (unlikely), you will need to modify (Logger).Prefix and run (Logger).Logger.SetPrefix(yourPrefixHere) for the respective logger.



Every logging.Logger type has the following methods that correspond to certain "levels". Every logging.Logger type has the following methods that correspond to certain "levels".


Alert(s string, v ...interface{}) (err error) Alert(s string, v ...interface{}) (err error)