From 7af9117e0dc73f83995a32f11158cffdbaf5307c Mon Sep 17 00:00:00 2001 From: kim Date: Sat, 9 Aug 2025 16:23:00 +0200 Subject: [feature + performance] add JSON logging format (#4355) # Description Adds JSON logging as an optional alternative log output format. In the process this moves our log formatting itself into a separate subpkg to make it more easily modular, and improves caller name getting with some calling function name caching. ## Checklist - [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md). - [x] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat. - [x] I/we have not leveraged AI to create the proposed changes. - [x] I/we have performed a self-review of added code. - [x] I/we have written code that is legible and maintainable by others. - [x] I/we have commented the added code, particularly in hard-to-understand areas. - [x] I/we have made any necessary changes to documentation. - [ ] I/we have added tests that cover new code. - [x] I/we have run tests and they pass locally with the changes. - [x] I/we have run `go fmt ./...` and `golangci-lint run`. Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4355 Co-authored-by: kim Co-committed-by: kim --- internal/log/entry.go | 64 +++++++++++++-------------------------------------- 1 file changed, 16 insertions(+), 48 deletions(-) (limited to 'internal/log/entry.go') diff --git a/internal/log/entry.go b/internal/log/entry.go index 48059c3bf..5b18ddf0f 100644 --- a/internal/log/entry.go +++ b/internal/log/entry.go @@ -48,117 +48,85 @@ func (e Entry) WithFields(kvs ...kv.Field) Entry { } // Trace will log formatted args as 'msg' field to the log at TRACE level. -// -//go:noinline func (e Entry) Trace(a ...interface{}) { - logf(e.ctx, 3, TRACE, e.kvs, args(len(a)), a...) + logf(e.ctx, TRACE, e.kvs, "", a...) } // Tracef will log format string as 'msg' field to the log at TRACE level. -// -//go:noinline func (e Entry) Tracef(s string, a ...interface{}) { - logf(e.ctx, 3, TRACE, e.kvs, s, a...) + logf(e.ctx, TRACE, e.kvs, s, a...) } // Debug will log formatted args as 'msg' field to the log at DEBUG level. -// -//go:noinline func (e Entry) Debug(a ...interface{}) { - logf(e.ctx, 3, DEBUG, e.kvs, args(len(a)), a...) + logf(e.ctx, DEBUG, e.kvs, "", a...) } // Debugf will log format string as 'msg' field to the log at DEBUG level. -// -//go:noinline func (e Entry) Debugf(s string, a ...interface{}) { - logf(e.ctx, 3, DEBUG, e.kvs, s, a...) + logf(e.ctx, DEBUG, e.kvs, s, a...) } // Info will log formatted args as 'msg' field to the log at INFO level. -// -//go:noinline func (e Entry) Info(a ...interface{}) { - logf(e.ctx, 3, INFO, e.kvs, args(len(a)), a...) + logf(e.ctx, INFO, e.kvs, "", a...) } // Infof will log format string as 'msg' field to the log at INFO level. -// -//go:noinline func (e Entry) Infof(s string, a ...interface{}) { - logf(e.ctx, 3, INFO, e.kvs, s, a...) + logf(e.ctx, INFO, e.kvs, s, a...) } // Warn will log formatted args as 'msg' field to the log at WARN level. -// -//go:noinline func (e Entry) Warn(a ...interface{}) { - logf(e.ctx, 3, WARN, e.kvs, args(len(a)), a...) + logf(e.ctx, WARN, e.kvs, "", a...) } // Warnf will log format string as 'msg' field to the log at WARN level. -// -//go:noinline func (e Entry) Warnf(s string, a ...interface{}) { - logf(e.ctx, 3, WARN, e.kvs, s, a...) + logf(e.ctx, WARN, e.kvs, s, a...) } // Error will log formatted args as 'msg' field to the log at ERROR level. -// -//go:noinline func (e Entry) Error(a ...interface{}) { - logf(e.ctx, 3, ERROR, e.kvs, args(len(a)), a...) + logf(e.ctx, ERROR, e.kvs, "", a...) } // Errorf will log format string as 'msg' field to the log at ERROR level. -// -//go:noinline func (e Entry) Errorf(s string, a ...interface{}) { - logf(e.ctx, 3, ERROR, e.kvs, s, a...) + logf(e.ctx, ERROR, e.kvs, s, a...) } // 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 (e Entry) Panic(a ...interface{}) { defer panic(fmt.Sprint(a...)) - logf(e.ctx, 3, PANIC, e.kvs, args(len(a)), a...) + logf(e.ctx, PANIC, e.kvs, "", 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 (e Entry) Panicf(s string, a ...interface{}) { defer panic(fmt.Sprintf(s, a...)) - logf(e.ctx, 3, PANIC, e.kvs, s, a...) + logf(e.ctx, PANIC, e.kvs, s, a...) } // Log will log formatted args as 'msg' field to the log at given level. -// -//go:noinline func (e Entry) Log(lvl LEVEL, a ...interface{}) { - logf(e.ctx, 3, lvl, e.kvs, args(len(a)), a...) + logf(e.ctx, lvl, e.kvs, "", a...) } // Logf will log format string as 'msg' field to the log at given level. -// -//go:noinline func (e Entry) Logf(lvl LEVEL, s string, a ...interface{}) { - logf(e.ctx, 3, lvl, e.kvs, s, a...) + logf(e.ctx, lvl, e.kvs, s, a...) } // Print will log formatted args to the stdout log output. -// -//go:noinline func (e Entry) Print(a ...interface{}) { - printf(3, e.kvs, args(len(a)), a...) + logf(e.ctx, UNSET, e.kvs, "", a...) } // Printf will log format string to the stdout log output. -// -//go:noinline func (e Entry) Printf(s string, a ...interface{}) { - printf(3, e.kvs, s, a...) + logf(e.ctx, UNSET, e.kvs, s, a...) } -- cgit v1.2.3