mirror of
https://github.com/go-gitea/gitea.git
synced 2025-07-13 13:34:44 +02:00
60 lines
2.1 KiB
Go
60 lines
2.1 KiB
Go
// Copyright 2024 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package db
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"code.gitea.io/gitea/modules/gtprof"
|
|
"code.gitea.io/gitea/modules/log"
|
|
"code.gitea.io/gitea/modules/setting"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/promauto"
|
|
"xorm.io/xorm/contexts"
|
|
)
|
|
|
|
type EngineHook struct {
|
|
Threshold time.Duration
|
|
Logger log.Logger
|
|
}
|
|
|
|
var _ contexts.Hook = (*EngineHook)(nil)
|
|
|
|
// follows: https://opentelemetry.io/docs/specs/semconv/database/database-metrics/#metric-dbclientoperationduration
|
|
var durationHistogram = promauto.NewHistogram(prometheus.HistogramOpts{
|
|
Namespace: "db",
|
|
Subsystem: "client",
|
|
Name: "operation_duration_seconds",
|
|
Help: "Duration of database client operations.",
|
|
// ConstLabels: prometheus.Labels{"db.system.name": BuilderDialect()}, //TODO: add type of database per spec.
|
|
})
|
|
|
|
func (*EngineHook) BeforeProcess(c *contexts.ContextHook) (context.Context, error) {
|
|
ctx, _ := gtprof.GetTracer().Start(c.Ctx, gtprof.TraceSpanDatabase)
|
|
return ctx, nil
|
|
}
|
|
|
|
func (h *EngineHook) AfterProcess(c *contexts.ContextHook) error {
|
|
durationHistogram.Observe(c.ExecuteTime.Seconds())
|
|
span := gtprof.GetContextSpan(c.Ctx)
|
|
if span != nil {
|
|
// Do not record SQL parameters here:
|
|
// * It shouldn't expose the parameters because they contain sensitive information, end users need to report the trace details safely.
|
|
// * Some parameters contain quite long texts, waste memory and are difficult to display.
|
|
span.SetAttributeString(gtprof.TraceAttrDbSQL, c.SQL)
|
|
span.End()
|
|
} else {
|
|
setting.PanicInDevOrTesting("span in database engine hook is nil")
|
|
}
|
|
if c.ExecuteTime >= h.Threshold {
|
|
// 8 is the amount of skips passed to runtime.Caller, so that in the log the correct function
|
|
// is being displayed (the function that ultimately wants to execute the query in the code)
|
|
// instead of the function of the slow query hook being called.
|
|
h.Logger.Log(8, &log.Event{Level: log.WARN}, "[Slow SQL Query] %s %v - %v", c.SQL, c.Args, c.ExecuteTime)
|
|
}
|
|
return nil
|
|
}
|