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/db/bundb/hook.go | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) (limited to 'internal/db') diff --git a/internal/db/bundb/hook.go b/internal/db/bundb/hook.go index f02a1353d..cc71f655b 100644 --- a/internal/db/bundb/hook.go +++ b/internal/db/bundb/hook.go @@ -35,21 +35,24 @@ func (queryHook) BeforeQuery(ctx context.Context, _ *bun.QueryEvent) context.Con // AfterQuery logs the time taken to query, the operation (select, update, etc), and the query itself as translated by bun. func (queryHook) AfterQuery(ctx context.Context, event *bun.QueryEvent) { - // Get the DB query duration + // Get the database query duration. dur := time.Since(event.StartTime) switch { - // Warn on slow database queries + // Warn on slow queries. case dur > time.Second: log.WithContext(ctx). WithFields(kv.Fields{ {"duration", dur}, {"query", event.Query}, - }...).Warn("SLOW DATABASE QUERY") + }...). + Warn("SLOW DATABASE QUERY") - // On trace, we log query information, - // manually crafting so DB query not escaped. + // On trace log query info. case log.Level() >= log.TRACE: - log.Printf("level=TRACE duration=%s query=%s", dur, event.Query) + log.TraceKVs(ctx, kv.Fields{ + {K: "duration", V: dur}, + {K: "query", V: event.Query}, + }...) } } -- cgit v1.2.3