1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
|
package logger
import (
"fmt"
"io"
"log"
"os"
"strings"
"sync"
"github.com/ghjm/cmdline"
"github.com/spf13/viper"
)
var (
logLevel int
showTrace bool
)
// Log level constants.
const (
ErrorLevel = iota + 1
WarningLevel
InfoLevel
DebugLevel
)
// QuietMode turns off all log output.
func SetGlobalQuietMode() {
logLevel = 0
}
// SetLogLevel is a helper function for setting logLevel int.
func SetGlobalLogLevel(level int) {
logLevel = level
}
// GetLogLevelByName is a helper function for returning level associated with log
// level string.
func GetLogLevelByName(logName string) (int, error) {
var err error
if val, hasKey := logLevelMap[strings.ToLower(logName)]; hasKey {
return val, nil
}
err = fmt.Errorf("%s is not a valid log level name", logName)
return 0, err
}
// This doesn't seem to be used anywhere.
// GetLogLevel returns current log level.
func GetLogLevel() int {
return logLevel
}
// LogLevelToName takes an int and returns the corresponding log level name.
func LogLevelToName(logLevel int) (string, error) {
var err error
for k, v := range logLevelMap {
if v == logLevel {
return k, nil
}
}
err = fmt.Errorf("%d is not a valid log level", logLevel)
return "", err
}
// logLevelMap maps strings to log level int
// allows for --LogLevel Debug at command line.
var logLevelMap = map[string]int{
"error": ErrorLevel,
"warning": WarningLevel,
"info": InfoLevel,
"debug": DebugLevel,
}
type MessageFunc func(level int, format string, v ...interface{})
var logger MessageFunc
// RegisterLogger registers a function for log delivery.
func RegisterLogger(msgFunc MessageFunc) {
logger = msgFunc
}
type ReceptorLogger struct {
log.Logger
Prefix string
m sync.Mutex
}
// NewReceptorLogger to instantiate a new logger object.
func NewReceptorLogger(prefix string) *ReceptorLogger {
return &ReceptorLogger{
Logger: *log.New(os.Stdout, prefix, log.LstdFlags),
Prefix: prefix,
}
}
// SetOutput sets the output destination for the logger.
func (rl *ReceptorLogger) SetOutput(w io.Writer) {
rl.Logger.SetOutput(w)
}
// SetShowTrace is a helper function for setting showTrace bool.
func (rl *ReceptorLogger) SetShowTrace(trace bool) {
showTrace = trace
}
// GetLogLevel returns the log level.
func (rl *ReceptorLogger) GetLogLevel() int {
return logLevel
}
// Error reports unexpected behavior, likely to result in termination.
func (rl *ReceptorLogger) Error(format string, v ...interface{}) {
rl.Log(ErrorLevel, format, v...)
}
// SanError reports unexpected behavior, likely to result in termination.
func (rl *ReceptorLogger) SanitizedError(format string, v ...interface{}) {
rl.SanitizedLog(ErrorLevel, format, v...)
}
// Warning reports unexpected behavior, not necessarily resulting in termination.
func (rl *ReceptorLogger) Warning(format string, v ...interface{}) {
rl.Log(WarningLevel, format, v...)
}
// SanitizedWarning reports unexpected behavior, not necessarily resulting in termination.
func (rl *ReceptorLogger) SanitizedWarning(format string, v ...interface{}) {
rl.SanitizedLog(WarningLevel, format, v...)
}
// Info provides general purpose statements useful to end user.
func (rl *ReceptorLogger) Info(format string, v ...interface{}) {
rl.Log(InfoLevel, format, v...)
}
// SanitizedInfo provides general purpose statements useful to end user.
func (rl *ReceptorLogger) SanitizedInfo(format string, v ...interface{}) {
rl.SanitizedLog(InfoLevel, format, v...)
}
// Debug contains extra information helpful to developers.
func (rl *ReceptorLogger) Debug(format string, v ...interface{}) {
rl.Log(DebugLevel, format, v...)
}
// Debug payload data.
func (rl *ReceptorLogger) DebugPayload(payloadDebug int, payload string, workUnitID string, connectionType string) {
var payloadMessage string
var workunitIDMessage string
var connectionTypeMessage string
switch payloadDebug {
case 3:
payloadMessage = fmt.Sprintf(" with a payload of: %s", payload)
fallthrough
case 2:
if workUnitID != "" {
workunitIDMessage = fmt.Sprintf(" with work unit %s", workUnitID)
} else {
workunitIDMessage = ", work unit not created yet"
}
fallthrough
case 1:
if connectionType != "" {
connectionTypeMessage = fmt.Sprintf("Reading from %s", connectionType)
}
default:
}
rl.Debug(fmt.Sprintf("PACKET TRACING ENABLED: %s%s%s", connectionTypeMessage, workunitIDMessage, payloadMessage)) //nolint:govet
}
// SanitizedDebug contains extra information helpful to developers.
func (rl *ReceptorLogger) SanitizedDebug(format string, v ...interface{}) {
rl.SanitizedLog(DebugLevel, format, v...)
}
// Trace outputs detailed packet traversal.
func (rl *ReceptorLogger) Trace(format string, v ...interface{}) {
if showTrace {
rl.SetPrefix("TRACE")
rl.Log(logLevel, format, v...)
}
}
// SanitizedTrace outputs detailed packet traversal.
func (rl *ReceptorLogger) SanitizedTrace(format string, v ...interface{}) {
if showTrace {
rl.SetPrefix("TRACE")
rl.SanitizedLog(logLevel, format, v...)
}
}
// Log adds a prefix and prints a given log message.
func (rl *ReceptorLogger) Log(level int, format string, v ...interface{}) {
if logger != nil {
logger(level, format, v...)
return
}
var prefix string
logLevelName, err := LogLevelToName(level)
if err != nil {
rl.Error("Log entry received with invalid level: %s\n", fmt.Sprintf(format, v...))
return
}
if rl.GetPrefix() != "" {
prefix = rl.GetPrefix() + " " + strings.ToUpper(logLevelName) + " "
} else {
prefix = strings.ToUpper(logLevelName) + " "
}
if logLevel >= level {
rl.Logger.SetPrefix(prefix)
rl.Logger.Printf(format, v...)
}
}
// SanitizedLog adds a prefix and prints a given log message.
func (rl *ReceptorLogger) SanitizedLog(level int, format string, v ...interface{}) {
if logger != nil {
logger(level, format, v...)
return
}
var prefix string
logLevelName, err := LogLevelToName(level)
if err != nil {
message := fmt.Sprintf(format, v...)
sanMessage := strings.ReplaceAll(message, "\n", "")
rl.Error("Log entry received with invalid level: %s\n", sanMessage)
return
}
if rl.GetPrefix() != "" {
prefix = rl.GetPrefix() + " " + strings.ToUpper(logLevelName) + " "
} else {
prefix = strings.ToUpper(logLevelName) + " "
}
if logLevel >= level {
message := fmt.Sprintf(format, v...)
sanMessage := strings.ReplaceAll(message, "\n", "")
rl.Logger.SetPrefix(prefix)
rl.Logger.Print(sanMessage)
}
}
func (rl *ReceptorLogger) SetPrefix(prefix string) {
rl.m.Lock()
defer rl.m.Unlock()
rl.Prefix = prefix
}
func (rl *ReceptorLogger) GetPrefix() string {
rl.m.Lock()
defer rl.m.Unlock()
return rl.Prefix
}
// GetLogLevelByName is a helper function for returning level associated with log
// level string.
func (rl *ReceptorLogger) GetLogLevelByName(logName string) (int, error) {
var err error
if val, hasKey := logLevelMap[strings.ToLower(logName)]; hasKey {
return val, nil
}
err = fmt.Errorf("%s is not a valid log level name", logName)
return 0, err
}
// LogLevelToName takes an int and returns the corresponding log level name.
func (rl *ReceptorLogger) LogLevelToName(logLevel int) (string, error) {
var err error
for k, v := range logLevelMap {
if v == logLevel {
return k, nil
}
}
err = fmt.Errorf("%d is not a valid log level", logLevel)
return "", err
}
type LoglevelCfg struct {
Level string `description:"Log level: Error, Warning, Info or Debug" barevalue:"yes" default:"error"`
}
func (cfg LoglevelCfg) Init() error {
var err error
val, err := GetLogLevelByName(cfg.Level)
if err != nil {
return err
}
SetGlobalLogLevel(val)
return nil
}
type TraceCfg struct{}
func (cfg TraceCfg) Prepare() error {
return nil
}
func init() {
version := viper.GetInt("version")
if version > 1 {
return
}
logLevel = InfoLevel
showTrace = false
log.SetOutput(os.Stdout)
log.SetFlags(log.Ldate | log.Ltime)
cmdline.RegisterConfigTypeForApp("receptor-logging",
"log-level", "Specifies the verbosity level for command output", LoglevelCfg{}, cmdline.Singleton)
cmdline.RegisterConfigTypeForApp("receptor-logging",
"trace", "Enables packet tracing output", TraceCfg{}, cmdline.Singleton)
}
|