History

Dimitrij Denissenko 7fa451c740 chore: fewer test dependencies		2023-01-27 15:01:50 +00:00
..
README.md	feat(extra/redisprometheus): prometheus.Collector implementation for redis clients	2022-07-21 16:02:50 +02:00
collector.go	chore: update import path	2023-01-23 08:48:54 +02:00
go.mod	chore: release v9.0.0-rc.4 (release.sh)	2023-01-24 16:15:51 +02:00
go.sum	chore: fewer test dependencies	2023-01-27 15:01:50 +00:00

README.md

Prometheus Metric Collector

This package implements a prometheus.Collector for collecting metrics about the connection pool used by the various redis clients. Supported clients are redis.Client, redis.ClusterClient, redis.Ring and redis.UniversalClient.

Example

client := redis.NewClient(options)
collector := redisprometheus.NewCollector(namespace, subsystem, client)
prometheus.MustRegister(collector)

Metrics

Name	Type	Description
`pool_hit_total`	Counter metric	number of times a connection was found in the pool
`pool_miss_total`	Counter metric	number of times a connection was not found in the pool
`pool_timeout_total`	Counter metric	number of times a timeout occurred when getting a connection from the pool
`pool_conn_total_current`	Gauge metric	current number of connections in the pool
`pool_conn_idle_current`	Gauge metric	current number of idle connections in the pool
`pool_conn_stale_total`	Counter metric	number of times a connection was removed from the pool because it was stale