go_goutils/logging/funcs_std.go

186 lines
3.0 KiB
Go
Raw Normal View History

2021-02-26 15:52:29 -05:00
package logging
2021-02-26 20:27:35 -05:00
import (
2021-02-27 00:51:58 -05:00
"fmt"
"log"
2021-02-26 20:27:35 -05:00
)
2022-01-05 05:15:38 -05:00
// Setup sets up/configures a StdLogger and prepares it for use.
2021-02-26 20:27:35 -05:00
func (l *StdLogger) Setup() {
l.Logger = log.Default()
l.Logger.SetPrefix(l.Prefix)
}
2022-01-05 05:15:38 -05:00
// Shutdown cleanly shuts down a StdLogger.
2021-02-26 20:27:35 -05:00
func (l *StdLogger) Shutdown() {
// NOOP
_ = ""
}
2022-01-05 05:15:38 -05:00
// GetPrefix returns the prefix used by this StdLogger.
func (l *StdLogger) GetPrefix() (prefix string) {
prefix = l.Prefix
return
}
/*
DoDebug sets the debug state of this StdLogger.
Note that this merely acts as a *safety filter* for debug messages to avoid sensitive information being written to the log.
*/
func (l *StdLogger) DoDebug(d bool) {
2021-02-26 15:52:29 -05:00
l.EnableDebug = d
}
2022-01-05 05:15:38 -05:00
// SetPrefix sets the prefix for this StdLogger.
func (l *StdLogger) SetPrefix(prefix string) {
2021-02-26 15:52:29 -05:00
l.Prefix = prefix
2021-02-26 20:27:35 -05:00
l.Logger.SetPrefix(prefix)
2021-02-26 15:52:29 -05:00
}
2022-01-05 05:15:38 -05:00
// Alert writes an ALERT-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Alert(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "ALERT")
2021-02-26 15:52:29 -05:00
return
}
2022-01-05 05:15:38 -05:00
// Crit writes an CRITICAL-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Crit(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "CRITICAL")
2021-02-26 15:52:29 -05:00
return
}
2022-01-05 05:15:38 -05:00
// Debug writes a DEBUG-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Debug(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
if !l.EnableDebug {
return
}
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "DEBUG")
2021-02-26 15:52:29 -05:00
return
}
2022-01-05 05:15:38 -05:00
// Emerg writes an EMERGENCY-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Emerg(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "EMERGENCY")
2021-02-26 15:52:29 -05:00
return
}
2022-01-05 05:15:38 -05:00
// Err writes an ERROR-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Err(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "ERROR")
2021-02-26 15:52:29 -05:00
return
}
2022-01-05 05:15:38 -05:00
// Info writes an INFO-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Info(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "INFO")
2021-02-26 15:52:29 -05:00
return
}
2022-01-05 05:15:38 -05:00
// Notice writes a NOTICE-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Notice(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "NOTICE")
2021-02-26 15:52:29 -05:00
return
}
2022-01-05 05:15:38 -05:00
// Warning writes a WARNING/WARN-level message to this StdLogger.
2021-02-26 15:52:29 -05:00
func (l *StdLogger) Warning(s string, v ...interface{}) (err error) {
2021-02-26 20:27:35 -05:00
var msg string
if v != nil {
msg = fmt.Sprintf(s, v...)
} else {
msg = s
}
l.renderWrite(msg, "WARNING")
return
}
2022-01-05 05:15:38 -05:00
// renderWrite prepares/formats a log message to be written to this StdLogger.
2021-02-26 20:27:35 -05:00
func (l *StdLogger) renderWrite(msg, prio string) {
s := fmt.Sprintf("[%v] %v", prio, msg)
l.Logger.Println(s)
2021-02-26 15:52:29 -05:00
return
}