mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-11-14 00:57:29 -06:00
[chore] ensure consistent caller name fetching regardless of compiler inlining (#3323)
* move logging levels into log package itself * ensure inconsistent inlining doesn't mess with log calling function name * remove unused global variable * fix log level
This commit is contained in:
kim
GitHub
parent
747c251df6
commit
77b095a8c3
17 changed files with 292 additions and 204 deletions
|
|
@ -24,19 +24,26 @@ import (
|
|||
"os"
|
||||
"slices"
|
||||
"strings"
|
||||
"syscall"
|
||||
"time"
|
||||
|
||||
"codeberg.org/gruf/go-kv"
|
||||
"codeberg.org/gruf/go-logger/v2/level"
|
||||
)
|
||||
|
||||
var (
|
||||
// loglvl is the currently set logging level.
|
||||
loglvl level.LEVEL
|
||||
// loglvl is the currently
|
||||
// set logging output
|
||||
loglvl LEVEL
|
||||
|
||||
// lvlstrs is the lookup table of log levels to strings.
|
||||
lvlstrs = level.Default()
|
||||
// lvlstrs is the lookup table
|
||||
// of all log levels to strings.
|
||||
lvlstrs = [int(ALL) + 1]string{
|
||||
TRACE: "TRACE",
|
||||
DEBUG: "DEBUG",
|
||||
INFO: "INFO",
|
||||
WARN: "WARN",
|
||||
ERROR: "ERROR",
|
||||
PANIC: "PANIC",
|
||||
}
|
||||
|
||||
// syslog output, only set if enabled.
|
||||
sysout *syslog.Writer
|
||||
|
|
@ -54,13 +61,13 @@ func Hook(hook func(ctx context.Context, kvs []kv.Field) []kv.Field) {
|
|||
ctxhooks = append(ctxhooks, hook)
|
||||
}
|
||||
|
||||
// Level returns the currently set log level.
|
||||
func Level() level.LEVEL {
|
||||
// Level returns the currently set log
|
||||
func Level() LEVEL {
|
||||
return loglvl
|
||||
}
|
||||
|
||||
// SetLevel sets the max logging level.
|
||||
func SetLevel(lvl level.LEVEL) {
|
||||
// SetLevel sets the max logging
|
||||
func SetLevel(lvl LEVEL) {
|
||||
loglvl = lvl
|
||||
}
|
||||
|
||||
|
|
@ -83,174 +90,259 @@ func New() Entry {
|
|||
return Entry{}
|
||||
}
|
||||
|
||||
// WithContext returns a new prepared Entry{} with context.
|
||||
func WithContext(ctx context.Context) Entry {
|
||||
return Entry{ctx: ctx}
|
||||
}
|
||||
|
||||
// WithField returns a new prepared Entry{} with key-value field.
|
||||
func WithField(key string, value interface{}) Entry {
|
||||
return New().WithField(key, value)
|
||||
return Entry{kvs: []kv.Field{{K: key, V: value}}}
|
||||
}
|
||||
|
||||
// WithFields returns a new prepared Entry{} with key-value fields.
|
||||
func WithFields(fields ...kv.Field) Entry {
|
||||
return New().WithFields(fields...)
|
||||
return Entry{kvs: fields}
|
||||
}
|
||||
|
||||
// Note that most of the below logging
|
||||
// functions we specifically do NOT allow
|
||||
// the Go buildchain to inline, to ensure
|
||||
// expected behaviour in caller fetching.
|
||||
|
||||
// Trace will log formatted args as 'msg' field to the log at TRACE level.
|
||||
//
|
||||
//go:noinline
|
||||
func Trace(ctx context.Context, a ...interface{}) {
|
||||
logf(ctx, 3, level.TRACE, nil, args(len(a)), a...)
|
||||
logf(ctx, 3, TRACE, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Tracef will log format string as 'msg' field to the log at TRACE level.
|
||||
//
|
||||
//go:noinline
|
||||
func Tracef(ctx context.Context, s string, a ...interface{}) {
|
||||
logf(ctx, 3, level.TRACE, nil, s, a...)
|
||||
logf(ctx, 3, TRACE, nil, s, a...)
|
||||
}
|
||||
|
||||
// TraceKV will log the one key-value field to the log at TRACE level.
|
||||
//
|
||||
//go:noinline
|
||||
func TraceKV(ctx context.Context, key string, value interface{}) {
|
||||
logf(ctx, 3, level.TRACE, []kv.Field{{K: key, V: value}}, "")
|
||||
logf(ctx, 3, TRACE, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// TraceKVs will log key-value fields to the log at TRACE level.
|
||||
//
|
||||
//go:noinline
|
||||
func TraceKVs(ctx context.Context, kvs ...kv.Field) {
|
||||
logf(ctx, 3, level.TRACE, kvs, "")
|
||||
logf(ctx, 3, TRACE, kvs, "")
|
||||
}
|
||||
|
||||
// Debug will log formatted args as 'msg' field to the log at DEBUG level.
|
||||
//
|
||||
//go:noinline
|
||||
func Debug(ctx context.Context, a ...interface{}) {
|
||||
logf(ctx, 3, level.DEBUG, nil, args(len(a)), a...)
|
||||
logf(ctx, 3, DEBUG, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Debugf will log format string as 'msg' field to the log at DEBUG level.
|
||||
//
|
||||
//go:noinline
|
||||
func Debugf(ctx context.Context, s string, a ...interface{}) {
|
||||
logf(ctx, 3, level.DEBUG, nil, s, a...)
|
||||
logf(ctx, 3, DEBUG, nil, s, a...)
|
||||
}
|
||||
|
||||
// DebugKV will log the one key-value field to the log at DEBUG level.
|
||||
//
|
||||
//go:noinline
|
||||
func DebugKV(ctx context.Context, key string, value interface{}) {
|
||||
logf(ctx, 3, level.DEBUG, []kv.Field{{K: key, V: value}}, "")
|
||||
logf(ctx, 3, DEBUG, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// DebugKVs will log key-value fields to the log at DEBUG level.
|
||||
//
|
||||
//go:noinline
|
||||
func DebugKVs(ctx context.Context, kvs ...kv.Field) {
|
||||
logf(ctx, 3, level.DEBUG, kvs, "")
|
||||
logf(ctx, 3, DEBUG, kvs, "")
|
||||
}
|
||||
|
||||
// Info will log formatted args as 'msg' field to the log at INFO level.
|
||||
//
|
||||
//go:noinline
|
||||
func Info(ctx context.Context, a ...interface{}) {
|
||||
logf(ctx, 3, level.INFO, nil, args(len(a)), a...)
|
||||
logf(ctx, 3, INFO, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Infof will log format string as 'msg' field to the log at INFO level.
|
||||
//
|
||||
//go:noinline
|
||||
func Infof(ctx context.Context, s string, a ...interface{}) {
|
||||
logf(ctx, 3, level.INFO, nil, s, a...)
|
||||
logf(ctx, 3, INFO, nil, s, a...)
|
||||
}
|
||||
|
||||
// InfoKV will log the one key-value field to the log at INFO level.
|
||||
//
|
||||
//go:noinline
|
||||
func InfoKV(ctx context.Context, key string, value interface{}) {
|
||||
logf(ctx, 3, level.INFO, []kv.Field{{K: key, V: value}}, "")
|
||||
logf(ctx, 3, INFO, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// InfoKVs will log key-value fields to the log at INFO level.
|
||||
//
|
||||
//go:noinline
|
||||
func InfoKVs(ctx context.Context, kvs ...kv.Field) {
|
||||
logf(ctx, 3, level.INFO, kvs, "")
|
||||
logf(ctx, 3, INFO, kvs, "")
|
||||
}
|
||||
|
||||
// Warn will log formatted args as 'msg' field to the log at WARN level.
|
||||
//
|
||||
//go:noinline
|
||||
func Warn(ctx context.Context, a ...interface{}) {
|
||||
logf(ctx, 3, level.WARN, nil, args(len(a)), a...)
|
||||
logf(ctx, 3, WARN, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Warnf will log format string as 'msg' field to the log at WARN level.
|
||||
//
|
||||
//go:noinline
|
||||
func Warnf(ctx context.Context, s string, a ...interface{}) {
|
||||
logf(ctx, 3, level.WARN, nil, s, a...)
|
||||
logf(ctx, 3, WARN, nil, s, a...)
|
||||
}
|
||||
|
||||
// WarnKV will log the one key-value field to the log at WARN level.
|
||||
//
|
||||
//go:noinline
|
||||
func WarnKV(ctx context.Context, key string, value interface{}) {
|
||||
logf(ctx, 3, level.WARN, []kv.Field{{K: key, V: value}}, "")
|
||||
logf(ctx, 3, WARN, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// WarnKVs will log key-value fields to the log at WARN level.
|
||||
//
|
||||
//go:noinline
|
||||
func WarnKVs(ctx context.Context, kvs ...kv.Field) {
|
||||
logf(ctx, 3, level.WARN, kvs, "")
|
||||
logf(ctx, 3, WARN, kvs, "")
|
||||
}
|
||||
|
||||
// Error will log formatted args as 'msg' field to the log at ERROR level.
|
||||
//
|
||||
//go:noinline
|
||||
func Error(ctx context.Context, a ...interface{}) {
|
||||
logf(ctx, 3, level.ERROR, nil, args(len(a)), a...)
|
||||
logf(ctx, 3, ERROR, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Errorf will log format string as 'msg' field to the log at ERROR level.
|
||||
//
|
||||
//go:noinline
|
||||
func Errorf(ctx context.Context, s string, a ...interface{}) {
|
||||
logf(ctx, 3, level.ERROR, nil, s, a...)
|
||||
logf(ctx, 3, ERROR, nil, s, a...)
|
||||
}
|
||||
|
||||
// ErrorKV will log the one key-value field to the log at ERROR level.
|
||||
//
|
||||
//go:noinline
|
||||
func ErrorKV(ctx context.Context, key string, value interface{}) {
|
||||
logf(ctx, 3, level.ERROR, []kv.Field{{K: key, V: value}}, "")
|
||||
logf(ctx, 3, ERROR, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// ErrorKVs will log key-value fields to the log at ERROR level.
|
||||
//
|
||||
//go:noinline
|
||||
func ErrorKVs(ctx context.Context, kvs ...kv.Field) {
|
||||
logf(ctx, 3, level.WARN, kvs, "")
|
||||
}
|
||||
|
||||
func Fatal(ctx context.Context, a ...interface{}) {
|
||||
defer syscall.Exit(1)
|
||||
logf(ctx, 3, level.FATAL, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
func Fatalf(ctx context.Context, s string, a ...interface{}) {
|
||||
defer syscall.Exit(1)
|
||||
logf(ctx, 3, level.FATAL, nil, s, a...)
|
||||
}
|
||||
|
||||
func FatalKV(ctx context.Context, key string, value interface{}) {
|
||||
logf(ctx, 3, level.FATAL, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
func FatalKVs(ctx context.Context, kvs ...kv.Field) {
|
||||
logf(ctx, 3, level.FATAL, kvs, "")
|
||||
logf(ctx, 3, ERROR, kvs, "")
|
||||
}
|
||||
|
||||
// Panic will log formatted args as 'msg' field to the log at PANIC level.
|
||||
// This will then call panic causing the application to crash.
|
||||
//
|
||||
//go:noinline
|
||||
func Panic(ctx context.Context, a ...interface{}) {
|
||||
defer panic(fmt.Sprint(a...))
|
||||
logf(ctx, 3, level.PANIC, nil, args(len(a)), a...)
|
||||
logf(ctx, 3, PANIC, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Panicf will log format string as 'msg' field to the log at PANIC level.
|
||||
// This will then call panic causing the application to crash.
|
||||
//
|
||||
//go:noinline
|
||||
func Panicf(ctx context.Context, s string, a ...interface{}) {
|
||||
defer panic(fmt.Sprintf(s, a...))
|
||||
logf(ctx, 3, level.PANIC, nil, s, a...)
|
||||
logf(ctx, 3, PANIC, nil, s, a...)
|
||||
}
|
||||
|
||||
// PanicKV will log the one key-value field to the log at PANIC level.
|
||||
// This will then call panic causing the application to crash.
|
||||
//
|
||||
//go:noinline
|
||||
func PanicKV(ctx context.Context, key string, value interface{}) {
|
||||
logf(ctx, 3, level.PANIC, []kv.Field{{K: key, V: value}}, "")
|
||||
defer panic(kv.Field{K: key, V: value}.String())
|
||||
logf(ctx, 3, PANIC, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// PanicKVs will log key-value fields to the log at PANIC level.
|
||||
// This will then call panic causing the application to crash.
|
||||
//
|
||||
//go:noinline
|
||||
func PanicKVs(ctx context.Context, kvs ...kv.Field) {
|
||||
logf(ctx, 3, level.PANIC, kvs, "")
|
||||
defer panic(kv.Fields(kvs).String())
|
||||
logf(ctx, 3, PANIC, kvs, "")
|
||||
}
|
||||
|
||||
// Log will log formatted args as 'msg' field to the log at given level.
|
||||
func Log(ctx context.Context, lvl level.LEVEL, a ...interface{}) {
|
||||
//
|
||||
//go:noinline
|
||||
func Log(ctx context.Context, lvl LEVEL, a ...interface{}) {
|
||||
logf(ctx, 3, lvl, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Logf will log format string as 'msg' field to the log at given level.
|
||||
func Logf(ctx context.Context, lvl level.LEVEL, s string, a ...interface{}) {
|
||||
//
|
||||
//go:noinline
|
||||
func Logf(ctx context.Context, lvl LEVEL, s string, a ...interface{}) {
|
||||
logf(ctx, 3, lvl, nil, s, a...)
|
||||
}
|
||||
|
||||
// LogKV will log the one key-value field to the log at given level.
|
||||
func LogKV(ctx context.Context, lvl level.LEVEL, key string, value interface{}) { //nolint:revive
|
||||
logf(ctx, 3, level.DEBUG, []kv.Field{{K: key, V: value}}, "")
|
||||
//
|
||||
//go:noinline
|
||||
func LogKV(ctx context.Context, lvl LEVEL, key string, value interface{}) { //nolint:revive
|
||||
logf(ctx, 3, lvl, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// LogKVs will log key-value fields to the log at given level.
|
||||
func LogKVs(ctx context.Context, lvl level.LEVEL, kvs ...kv.Field) { //nolint:revive
|
||||
//
|
||||
//go:noinline
|
||||
func LogKVs(ctx context.Context, lvl LEVEL, kvs ...kv.Field) { //nolint:revive
|
||||
logf(ctx, 3, lvl, kvs, "")
|
||||
}
|
||||
|
||||
// Print will log formatted args to the stdout log output.
|
||||
//
|
||||
//go:noinline
|
||||
func Print(a ...interface{}) {
|
||||
printf(3, nil, args(len(a)), a...)
|
||||
}
|
||||
|
||||
// Printf will log format string to the stdout log output.
|
||||
//
|
||||
//go:noinline
|
||||
func Printf(s string, a ...interface{}) {
|
||||
printf(3, nil, s, a...)
|
||||
}
|
||||
|
||||
// PrintKVs will log the one key-value field to the stdout log output.
|
||||
//
|
||||
//go:noinline
|
||||
func PrintKV(key string, value interface{}) {
|
||||
printf(3, []kv.Field{{K: key, V: value}}, "")
|
||||
}
|
||||
|
||||
// PrintKVs will log key-value fields to the stdout log output.
|
||||
//
|
||||
//go:noinline
|
||||
func PrintKVs(kvs ...kv.Field) {
|
||||
printf(3, kvs, "")
|
||||
}
|
||||
|
||||
//go:noinline
|
||||
func printf(depth int, fields []kv.Field, s string, a ...interface{}) {
|
||||
// Acquire buffer
|
||||
buf := getBuf()
|
||||
|
|
@ -279,7 +371,7 @@ func printf(depth int, fields []kv.Field, s string, a ...interface{}) {
|
|||
|
||||
if sysout != nil {
|
||||
// Write log entry to syslog
|
||||
logsys(level.INFO, buf.String())
|
||||
logsys(INFO, buf.String())
|
||||
}
|
||||
|
||||
// Write to log and release
|
||||
|
|
@ -287,17 +379,18 @@ func printf(depth int, fields []kv.Field, s string, a ...interface{}) {
|
|||
putBuf(buf)
|
||||
}
|
||||
|
||||
func logf(ctx context.Context, depth int, lvl level.LEVEL, fields []kv.Field, s string, a ...interface{}) {
|
||||
//go:noinline
|
||||
func logf(ctx context.Context, depth int, lvl LEVEL, fields []kv.Field, s string, a ...interface{}) {
|
||||
var out *os.File
|
||||
|
||||
// Check if enabled.
|
||||
if lvl > Level() {
|
||||
if lvl > loglvl {
|
||||
return
|
||||
}
|
||||
|
||||
// Split errors to stderr,
|
||||
// all else goes to stdout.
|
||||
if lvl <= level.ERROR {
|
||||
if lvl <= ERROR {
|
||||
out = os.Stderr
|
||||
} else {
|
||||
out = os.Stdout
|
||||
|
|
@ -354,21 +447,21 @@ func logf(ctx context.Context, depth int, lvl level.LEVEL, fields []kv.Field, s
|
|||
|
||||
// logsys will log given msg at given severity to the syslog.
|
||||
// Max length: https://www.rfc-editor.org/rfc/rfc5424.html#section-6.1
|
||||
func logsys(lvl level.LEVEL, msg string) {
|
||||
func logsys(lvl LEVEL, msg string) {
|
||||
if max := 2048; len(msg) > max {
|
||||
// Truncate up to max
|
||||
msg = msg[:max]
|
||||
}
|
||||
switch lvl {
|
||||
case level.TRACE, level.DEBUG:
|
||||
case TRACE, DEBUG:
|
||||
_ = sysout.Debug(msg)
|
||||
case level.INFO:
|
||||
case INFO:
|
||||
_ = sysout.Info(msg)
|
||||
case level.WARN:
|
||||
case WARN:
|
||||
_ = sysout.Warning(msg)
|
||||
case level.ERROR:
|
||||
case ERROR:
|
||||
_ = sysout.Err(msg)
|
||||
case level.FATAL, level.PANIC:
|
||||
case PANIC:
|
||||
_ = sysout.Crit(msg)
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue