mirror of
https://git.zx2c4.com/wireguard-go
synced 2024-11-15 01:05:15 +01:00
7139279cd0
This commit overhauls wireguard-go's logging. The primary, motivating change is to use a function instead of a *log.Logger as the basic unit of logging. Using functions provides a lot more flexibility for people to bring their own logging system. It also introduces logging helper methods on Device. These reduce line noise at the call site. They also allow for log functions to be nil; when nil, instead of generating a log line and throwing it away, we don't bother generating it at all. This spares allocation and pointless work. This is a breaking change, although the fix required of clients is fairly straightforward. Signed-off-by: Josh Bleecher Snyder <josh@tailscale.com>
69 lines
1.6 KiB
Go
69 lines
1.6 KiB
Go
/* SPDX-License-Identifier: MIT
|
|
*
|
|
* Copyright (C) 2017-2020 WireGuard LLC. All Rights Reserved.
|
|
*/
|
|
|
|
package device
|
|
|
|
import (
|
|
"log"
|
|
"os"
|
|
)
|
|
|
|
// A Logger provides logging for a Device.
|
|
// The functions are Printf-style functions.
|
|
// They must be safe for concurrent use.
|
|
// They do not require a trailing newline in the format.
|
|
// If nil, that level of logging will be silent.
|
|
type Logger struct {
|
|
Debugf func(format string, args ...interface{})
|
|
Infof func(format string, args ...interface{})
|
|
Errorf func(format string, args ...interface{})
|
|
}
|
|
|
|
// Log levels for use with NewLogger.
|
|
const (
|
|
LogLevelSilent = iota
|
|
LogLevelError
|
|
LogLevelInfo
|
|
LogLevelDebug
|
|
)
|
|
|
|
// NewLogger constructs a Logger that writes to stdout.
|
|
// It logs at the specified log level and above.
|
|
// It decorates log lines with the log level, date, time, and prepend.
|
|
func NewLogger(level int, prepend string) *Logger {
|
|
logger := new(Logger)
|
|
logf := func(prefix string) func(string, ...interface{}) {
|
|
return log.New(os.Stdout, prefix+": "+prepend, log.Ldate|log.Ltime).Printf
|
|
}
|
|
if level >= LogLevelDebug {
|
|
logger.Debugf = logf("DEBUG")
|
|
}
|
|
if level >= LogLevelInfo {
|
|
logger.Infof = logf("INFO")
|
|
}
|
|
if level >= LogLevelError {
|
|
logger.Errorf = logf("ERROR")
|
|
}
|
|
return logger
|
|
}
|
|
|
|
func (device *Device) debugf(format string, args ...interface{}) {
|
|
if device.log.Debugf != nil {
|
|
device.log.Debugf(format, args...)
|
|
}
|
|
}
|
|
|
|
func (device *Device) infof(format string, args ...interface{}) {
|
|
if device.log.Infof != nil {
|
|
device.log.Infof(format, args...)
|
|
}
|
|
}
|
|
|
|
func (device *Device) errorf(format string, args ...interface{}) {
|
|
if device.log.Errorf != nil {
|
|
device.log.Errorf(format, args...)
|
|
}
|
|
}
|