redis/go-redis
1
0
Fork 0
mirror of https://github.com/redis/go-redis.git synced 2025-07-31 05:04:23 +03:00
Code Activity

feat(extra/redisprometheus): prometheus.Collector implementation for redis clients

Browse Source 
Signed-off-by: Knut Zuidema <me@knutzuidema.de>
This commit is contained in:
Knut Zuidema
2022-07-21 16:02:50 +02:00
parent e061db8c13
commit 43d0cbb9b8
4 changed files with 677 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
extra/redisprometheus/README.md Normal file
View File

@ -0,0 +1,26 @@
# Prometheus Metric Collector
This package implements a [`prometheus.Collector`](https://pkg.go.dev/github.com/prometheus/client_golang@v1.12.2/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
```go
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 |