History

Vladyslav Vildanov ad131f49b0 Updated package version (#3134 ) * Updated package version * Changed version format according to specification * Updated submodule versions		2024-09-26 13:14:30 +03:00
..
README.md	feat(extra/redisprometheus): prometheus.Collector implementation for redis clients	2022-07-21 16:02:50 +02:00
collector.go	Format code and fix go vet (#2696 )	2023-09-20 14:03:44 +03:00
go.mod	Updated package version (#3134 )	2024-09-26 13:14:30 +03:00
go.sum	add server address and port attributes to redis otel trace instrumentation (#2826 )	2024-03-27 08:56:11 +02: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