gotosocial/internal/db/bundb/hook.go

/*
   GoToSocial
   Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org

   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"

	"github.com/sirupsen/logrus"
	"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(_ context.Context, event *bun.QueryEvent) {
	// Get the DB query duration
	dur := time.Since(event.StartTime)

	log := func(lvl logrus.Level, msg string) {
		logrus.WithFields(logrus.Fields{
			"duration":  dur,
			"operation": event.Operation(),
			"query":     event.Query,
		}).Log(lvl, msg)
	}

	switch {
	// Warn on slow database queries
	case dur > time.Second:
		log(logrus.WarnLevel, "SLOW DATABASE QUERY")

	// On trace, we log query information
	case logrus.GetLevel() == logrus.TraceLevel:
		log(logrus.TraceLevel, "database query")
	}
}