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/gtserror/new_caller.go | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) (limited to 'internal/gtserror/new_caller.go') diff --git a/internal/gtserror/new_caller.go b/internal/gtserror/new_caller.go index f7e0c84f6..7f4cd31cd 100644 --- a/internal/gtserror/new_caller.go +++ b/internal/gtserror/new_caller.go @@ -24,6 +24,8 @@ import ( "fmt" "runtime" "strings" + + "codeberg.org/gruf/go-caller" ) // Caller returns whether created errors will prepend calling function name. @@ -48,7 +50,7 @@ func (ce *cerror) Unwrap() error { // newAt is the same as New() but allows specifying calldepth. func newAt(calldepth int, msg string) error { return &cerror{ - c: caller(calldepth + 1), + c: getCaller(calldepth + 1), e: errors.New(msg), } } @@ -56,37 +58,25 @@ func newAt(calldepth int, msg string) error { // newfAt is the same as Newf() but allows specifying calldepth. func newfAt(calldepth int, msgf string, args ...any) error { return &cerror{ - c: caller(calldepth + 1), + c: getCaller(calldepth + 1), e: fmt.Errorf(msgf, args...), } } -// caller fetches the calling function name, skipping 'depth'. -func caller(depth int) string { - var pcs [1]uintptr - - // Fetch calling function using calldepth - _ = runtime.Callers(depth, pcs[:]) - fn := runtime.FuncForPC(pcs[0]) +// getCaller fetches the calling function name, skipping 'depth'. +func getCaller(depth int) string { + pcs := make([]uintptr, 1) - if fn == nil { - return "" - } + // Fetch calling function at depth. + _ = runtime.Callers(depth, pcs) - // Get func name. - name := fn.Name() + // Get cached calling func name. + name := caller.Get(pcs[0]) - // Drop everything but but function name itself + // Drop package / everything but function name itself. if idx := strings.LastIndexByte(name, '.'); idx >= 0 { name = name[idx+1:] } - const params = `[...]` - - // Drop any generic type parameter markers - if idx := strings.Index(name, params); idx >= 0 { - name = name[:idx] + name[idx+len(params):] - } - return name } -- cgit v1.2.3