Prometheus exporter for Redis metrics.
Supports Redis 2.x and 3.x
Locally build and run it:
$ go get
$ go build
$ ./redis_exporter <flags>
You can also run it via docker:
$ docker pull oliver006/redis_exporter
$ docker run -d --name redis_exporter -p 9121:9121 oliver006/redis_exporter
Add a block to the scrape_configs of your prometheus.yml config file:
scrape_configs:
...
- job_name: redis_exporter
static_configs:
- targets: ['localhost:9121']
...
and adjust the host name accordingly.
| Name | Description |
|---|---|
| debug | Verbose debug output |
| log-format | Log format, valid options are txt (default) and json. |
| check-keys | Comma separated list of keys to export value and length/size, eg: db3=user_count will export key user_count from db 3. db defaults to 0 if omitted. |
| redis.addr | Address of one or more redis nodes, comma separated, defaults to redis://localhost:6379. |
| redis.password | Password to use when authenticating to Redis |
| redis.alias | Alias for redis node addr, comma separated. |
| namespace | Namespace for the metrics, defaults to redis. |
| web.listen-address | Address to listen on for web interface and telemetry, defaults to 0.0.0.0:9121. |
| web.telemetry-path | Path under which to expose metrics, defaults to metrics. |
Redis node addresses can be tcp addresses like redis://localhost:6379, redis.example.com:6379 or unix socket addresses like unix:///tmp/redis.sock.
SSL is supported by using the rediss:// schema, for example: rediss://azure-ssl-enabled-host.redis.cache.windows.net:6380 (note that the port is required when connecting to a non-standard 6379 port, e.g. with Azure Redis instances).
These settings take precedence over any configurations provided by environment variables.
| Name | Description |
|---|---|
| REDIS_ADDR | Address of Redis node(s) |
| REDIS_PASSWORD | Password to use when authenticating to Redis |
| REDIS_ALIAS | Alias name of Redis node(s) |
Most items from the INFO command are exported,
see http://redis.io/commands/info for details.
In addition, for every database there are metrics for total keys, expiring keys and the average TTL for keys in the database.
You can also export values of keys if they're in numeric format by using the -check-keys flag. The exporter will also export the size (or, depending on the data type, the length) of the key. This can be used to export the number of elements in (sorted) sets, hashes, lists, etc.
Example Grafana screenshots:
Grafana dashboard is available on grafana.net and/or github.com.
Grafana dashboard with host & alias selector is available on github.com.
Open an issue or PR if you have more suggestions or ideas about what to add.