mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-11-03 22:42:25 -06:00
7af9117e0d
# 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 <grufwub@gmail.com> Co-committed-by: kim <grufwub@gmail.com>
58 lines
1.7 KiB
Go
58 lines
1.7 KiB
Go
// GoToSocial
|
|
// Copyright (C) GoToSocial Authors admin@gotosocial.org
|
|
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package bundb
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"code.superseriousbusiness.org/gotosocial/internal/log"
|
|
"codeberg.org/gruf/go-kv/v2"
|
|
"github.com/uptrace/bun"
|
|
)
|
|
|
|
// queryHook implements bun.QueryHook
|
|
type queryHook struct{}
|
|
|
|
func (queryHook) BeforeQuery(ctx context.Context, _ *bun.QueryEvent) context.Context {
|
|
return ctx // do nothing
|
|
}
|
|
|
|
// 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 database query duration.
|
|
dur := time.Since(event.StartTime)
|
|
|
|
switch {
|
|
// Warn on slow queries.
|
|
case dur > time.Second:
|
|
log.WithContext(ctx).
|
|
WithFields(kv.Fields{
|
|
{"duration", dur},
|
|
{"query", event.Query},
|
|
}...).
|
|
Warn("SLOW DATABASE QUERY")
|
|
|
|
// On trace log query info.
|
|
case log.Level() >= log.TRACE:
|
|
log.TraceKVs(ctx, kv.Fields{
|
|
{K: "duration", V: dur},
|
|
{K: "query", V: event.Query},
|
|
}...)
|
|
}
|
|
}
|