Files
022bc2a714 Add sql connection pool metrics (#8071)
## What changed?

Adding sql connection pool metrics from stdlib `Stats`

## Why?

Expose more metrics for config fine tuning

## How did you test it?
- [x] built
- [x] run locally and tested manually
- [x] covered by existing tests
- [ ] added new unit test(s)
- [ ] added new functional test(s)

---------

Co-authored-by: Roey Berman <[email protected]>
Co-authored-by: Roey Berman <[email protected]>
2025-09-08 17:09:57 -07:00

88 lines
1.9 KiB
Go

package sqlplugin
import (
"sync"
"sync/atomic"
"time"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/metrics"
)
type DBMetricsReporter struct {
interval time.Duration
handle *DatabaseHandle
metrics metrics.Handler
quit chan struct{}
wg sync.WaitGroup
started atomic.Bool
stopped atomic.Bool
logger log.Logger
}
func newDBMetricReporter(dbKind DbKind, handle *DatabaseHandle) *DBMetricsReporter {
reporter := &DBMetricsReporter{
interval: time.Minute,
handle: handle,
metrics: handle.metrics.WithTags(metrics.PersistenceDBKindTag(dbKind.String())),
quit: make(chan struct{}),
logger: handle.logger,
}
reporter.started.Store(false)
reporter.stopped.Store(false)
return reporter
}
// Start run metrics report in background
// yield control immediately without blocking
// safe to called multiple time
func (r *DBMetricsReporter) Start() {
if !r.started.CompareAndSwap(false, true) {
return
}
r.wg.Add(1)
go r.run()
}
func (r *DBMetricsReporter) run() {
defer r.wg.Done()
ticker := time.NewTicker(r.interval)
defer ticker.Stop()
for {
select {
case <-r.quit:
return
case <-ticker.C:
if r.stopped.Load() {
return
}
r.report()
}
}
}
func (r *DBMetricsReporter) report() {
db := r.handle.db.Load()
if db == nil {
return
}
s := db.Stats()
metrics.PersistenceSQLMaxOpenConn.With(r.metrics).Record(float64(s.MaxOpenConnections))
metrics.PersistenceSQLOpenConn.With(r.metrics).Record(float64(s.OpenConnections))
metrics.PersistenceSQLIdleConn.With(r.metrics).Record(float64(s.Idle))
metrics.PersistenceSQLInUse.With(r.metrics).Record(float64(s.InUse))
}
// Stop signal background reporter to stop
// and wait for reporter to completely stopped
// safe to call multiple time
func (r *DBMetricsReporter) Stop() {
if r.stopped.CompareAndSwap(false, true) {
close(r.quit)
}
r.wg.Wait()
}