mirror of
https://github.com/redis/go-redis.git
synced 2025-04-19 07:22:17 +03:00
e8ad794e96
* run go fix ./... Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> * run make fmt Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> * fix go vet ./... issues * Update README.md Reorder imports with the rules defined in the Makefile as if we run `make fmt` * run gofumpt -w . * update Makefile to use gofumpt instead gofmt * increment makefile * format test * format tests Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> --------- Signed-off-by: Tiago Peczenyj <tpeczenyj@weborama.com> Co-authored-by: ofekshenawa <104765379+ofekshenawa@users.noreply.github.com>
118 lines
3.3 KiB
Go
118 lines
3.3 KiB
Go
package redisprometheus
|
|
|
|
import (
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
|
|
"github.com/redis/go-redis/v9"
|
|
)
|
|
|
|
// StatGetter provides a method to get pool statistics.
|
|
type StatGetter interface {
|
|
PoolStats() *redis.PoolStats
|
|
}
|
|
|
|
// Collector collects statistics from a redis client.
|
|
// It implements the prometheus.Collector interface.
|
|
type Collector struct {
|
|
getter StatGetter
|
|
hitDesc *prometheus.Desc
|
|
missDesc *prometheus.Desc
|
|
timeoutDesc *prometheus.Desc
|
|
totalDesc *prometheus.Desc
|
|
idleDesc *prometheus.Desc
|
|
staleDesc *prometheus.Desc
|
|
}
|
|
|
|
var _ prometheus.Collector = (*Collector)(nil)
|
|
|
|
// NewCollector returns a new Collector based on the provided StatGetter.
|
|
// The given namespace and subsystem are used to build the fully qualified metric name,
|
|
// i.e. "{namespace}_{subsystem}_{metric}".
|
|
// The provided metrics are:
|
|
// - pool_hit_total
|
|
// - pool_miss_total
|
|
// - pool_timeout_total
|
|
// - pool_conn_total_current
|
|
// - pool_conn_idle_current
|
|
// - pool_conn_stale_total
|
|
func NewCollector(namespace, subsystem string, getter StatGetter) *Collector {
|
|
return &Collector{
|
|
getter: getter,
|
|
hitDesc: prometheus.NewDesc(
|
|
prometheus.BuildFQName(namespace, subsystem, "pool_hit_total"),
|
|
"Number of times a connection was found in the pool",
|
|
nil, nil,
|
|
),
|
|
missDesc: prometheus.NewDesc(
|
|
prometheus.BuildFQName(namespace, subsystem, "pool_miss_total"),
|
|
"Number of times a connection was not found in the pool",
|
|
nil, nil,
|
|
),
|
|
timeoutDesc: prometheus.NewDesc(
|
|
prometheus.BuildFQName(namespace, subsystem, "pool_timeout_total"),
|
|
"Number of times a timeout occurred when looking for a connection in the pool",
|
|
nil, nil,
|
|
),
|
|
totalDesc: prometheus.NewDesc(
|
|
prometheus.BuildFQName(namespace, subsystem, "pool_conn_total_current"),
|
|
"Current number of connections in the pool",
|
|
nil, nil,
|
|
),
|
|
idleDesc: prometheus.NewDesc(
|
|
prometheus.BuildFQName(namespace, subsystem, "pool_conn_idle_current"),
|
|
"Current number of idle connections in the pool",
|
|
nil, nil,
|
|
),
|
|
staleDesc: prometheus.NewDesc(
|
|
prometheus.BuildFQName(namespace, subsystem, "pool_conn_stale_total"),
|
|
"Number of times a connection was removed from the pool because it was stale",
|
|
nil, nil,
|
|
),
|
|
}
|
|
}
|
|
|
|
// Describe implements the prometheus.Collector interface.
|
|
func (s *Collector) Describe(descs chan<- *prometheus.Desc) {
|
|
descs <- s.hitDesc
|
|
descs <- s.missDesc
|
|
descs <- s.timeoutDesc
|
|
descs <- s.totalDesc
|
|
descs <- s.idleDesc
|
|
descs <- s.staleDesc
|
|
}
|
|
|
|
// Collect implements the prometheus.Collector interface.
|
|
func (s *Collector) Collect(metrics chan<- prometheus.Metric) {
|
|
stats := s.getter.PoolStats()
|
|
metrics <- prometheus.MustNewConstMetric(
|
|
s.hitDesc,
|
|
prometheus.CounterValue,
|
|
float64(stats.Hits),
|
|
)
|
|
metrics <- prometheus.MustNewConstMetric(
|
|
s.missDesc,
|
|
prometheus.CounterValue,
|
|
float64(stats.Misses),
|
|
)
|
|
metrics <- prometheus.MustNewConstMetric(
|
|
s.timeoutDesc,
|
|
prometheus.CounterValue,
|
|
float64(stats.Timeouts),
|
|
)
|
|
metrics <- prometheus.MustNewConstMetric(
|
|
s.totalDesc,
|
|
prometheus.GaugeValue,
|
|
float64(stats.TotalConns),
|
|
)
|
|
metrics <- prometheus.MustNewConstMetric(
|
|
s.idleDesc,
|
|
prometheus.GaugeValue,
|
|
float64(stats.IdleConns),
|
|
)
|
|
metrics <- prometheus.MustNewConstMetric(
|
|
s.staleDesc,
|
|
prometheus.CounterValue,
|
|
float64(stats.StaleConns),
|
|
)
|
|
}
|