refactor(logging): prefer get-style logger accessors
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
parent
a5be0146d3
commit
c2e60c6ece
3 changed files with 26 additions and 26 deletions
|
|
@ -10,18 +10,18 @@ func (l *Logger) WithComponent(component string) *Logger {
|
|||
return l.ComponentLogger(component)
|
||||
}
|
||||
|
||||
// GetLevel returns the current log level.
|
||||
// Preferred over Level for AX naming consistency.
|
||||
// Level returns the current log level.
|
||||
// Deprecated: Use GetLevel instead.
|
||||
//
|
||||
// level := logger.GetLevel()
|
||||
func (l *Logger) GetLevel() Level {
|
||||
return l.Level()
|
||||
// level := logger.Level()
|
||||
func (l *Logger) Level() Level {
|
||||
return l.GetLevel()
|
||||
}
|
||||
|
||||
// GetGlobal returns the global logger instance.
|
||||
// Deprecated: Use Global instead.
|
||||
// Global returns the global logger instance.
|
||||
// Deprecated: Use GetGlobal instead.
|
||||
//
|
||||
// logger := GetGlobal()
|
||||
func GetGlobal() *Logger {
|
||||
return Global()
|
||||
// logger := Global()
|
||||
func Global() *Logger {
|
||||
return GetGlobal()
|
||||
}
|
||||
|
|
|
|||
|
|
@ -107,10 +107,10 @@ func (l *Logger) SetLevel(level Level) {
|
|||
l.level = level
|
||||
}
|
||||
|
||||
// Level returns the current log level.
|
||||
// GetLevel returns the current log level.
|
||||
//
|
||||
// level := logger.Level()
|
||||
func (l *Logger) Level() Level {
|
||||
// level := logger.GetLevel()
|
||||
func (l *Logger) GetLevel() Level {
|
||||
l.mu.RLock()
|
||||
defer l.mu.RUnlock()
|
||||
return l.level
|
||||
|
|
@ -242,10 +242,10 @@ func SetGlobal(l *Logger) {
|
|||
globalLogger = l
|
||||
}
|
||||
|
||||
// Global returns the global logger instance.
|
||||
// GetGlobal returns the global logger instance.
|
||||
//
|
||||
// logger := Global()
|
||||
func Global() *Logger {
|
||||
// logger := GetGlobal()
|
||||
func GetGlobal() *Logger {
|
||||
globalMu.RLock()
|
||||
defer globalMu.RUnlock()
|
||||
return globalLogger
|
||||
|
|
@ -266,56 +266,56 @@ func SetGlobalLevel(level Level) {
|
|||
//
|
||||
// Debug("connected", Fields{"peer_id": "node-1"})
|
||||
func Debug(message string, fields ...Fields) {
|
||||
Global().Debug(message, fields...)
|
||||
GetGlobal().Debug(message, fields...)
|
||||
}
|
||||
|
||||
// Info logs an informational message using the global logger.
|
||||
//
|
||||
// Info("worker started", Fields{"component": "transport"})
|
||||
func Info(message string, fields ...Fields) {
|
||||
Global().Info(message, fields...)
|
||||
GetGlobal().Info(message, fields...)
|
||||
}
|
||||
|
||||
// Warn logs a warning message using the global logger.
|
||||
//
|
||||
// Warn("peer rate limited", Fields{"peer_id": "node-1"})
|
||||
func Warn(message string, fields ...Fields) {
|
||||
Global().Warn(message, fields...)
|
||||
GetGlobal().Warn(message, fields...)
|
||||
}
|
||||
|
||||
// Error logs an error message using the global logger.
|
||||
//
|
||||
// Error("send failed", Fields{"peer_id": "node-1"})
|
||||
func Error(message string, fields ...Fields) {
|
||||
Global().Error(message, fields...)
|
||||
GetGlobal().Error(message, fields...)
|
||||
}
|
||||
|
||||
// Debugf logs a formatted debug message using the global logger.
|
||||
//
|
||||
// Debugf("connected peer %s", "node-1")
|
||||
func Debugf(format string, args ...any) {
|
||||
Global().Debugf(format, args...)
|
||||
GetGlobal().Debugf(format, args...)
|
||||
}
|
||||
|
||||
// Infof logs a formatted informational message using the global logger.
|
||||
//
|
||||
// Infof("worker %s ready", "node-1")
|
||||
func Infof(format string, args ...any) {
|
||||
Global().Infof(format, args...)
|
||||
GetGlobal().Infof(format, args...)
|
||||
}
|
||||
|
||||
// Warnf logs a formatted warning message using the global logger.
|
||||
//
|
||||
// Warnf("peer %s is slow", "node-1")
|
||||
func Warnf(format string, args ...any) {
|
||||
Global().Warnf(format, args...)
|
||||
GetGlobal().Warnf(format, args...)
|
||||
}
|
||||
|
||||
// Errorf logs a formatted error message using the global logger.
|
||||
//
|
||||
// Errorf("peer %s failed", "node-1")
|
||||
func Errorf(format string, args ...any) {
|
||||
Global().Errorf(format, args...)
|
||||
GetGlobal().Errorf(format, args...)
|
||||
}
|
||||
|
||||
// ParseLevel parses a string into a log level.
|
||||
|
|
|
|||
|
|
@ -149,8 +149,8 @@ func TestLogger_SetLevel_Good(t *testing.T) {
|
|||
}
|
||||
|
||||
// Verify Level
|
||||
if logger.Level() != LevelInfo {
|
||||
t.Error("Level should return LevelInfo")
|
||||
if logger.GetLevel() != LevelInfo {
|
||||
t.Error("GetLevel should return LevelInfo")
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue