Scroll to navigation

PROMETHEUS-REDIS-EXPORTER(1) prometheus PROMETHEUS-REDIS-EXPORTER(1)

NAME

prometheus-redis-exporter - Prometheus exporter for ValKey/Redis metrics

SYNOPSIS

prometheus-redis-exporter [option...]

DESCRIPTION

This Prometheus exporter retrieves monitoring data from ValKey (or Redis) servers, and exposes them via an HTTP server to be collected by Prometheus.

OPTIONS

Comma separated list of lua regex for grouping keys
Comma separated list of key-patterns to export value and length/size, searched for with SCAN.
Approximate number of keys to process in each execution, larger value speeds up scanning. WARNING: ValKey and Redis are still single-threaded apps (unlike KeyDB), so a huge COUNT can affect production environment (default 1000).
Comma separated list of single keys to export value and length/size.
Comma separated list of single streams to export info about streams, groups and consumers.
Comma separated list of stream-patterns to export info about streams, groups and consumers, searched for with SCAN.
What to use for the CONFIG command (default "CONFIG").
Timeout for connection to ValKey/Redis instance (default "15s").
Comma separated list of patterns to count (eg: 'db0=production_*,db3=sessions:*'), searched for with SCAN.
Whether to disable values of keys stored in redis as labels or not when using. -check-keys or -check-single-key.
Do not try to collect latency histogram metrics.
Whether to scrape Client List specific metrics.
Whether to include the client's port when exporting the client list. Warning: including the port increases the number of metrics generated and will make your Prometheus server take up more memory.
Whether to include all config settings as metrics.
Whether to include system metrics like e.g. redis_total_system_memory_bytes.
Whether this is a ValKey/Redis cluster (enable this if you need to fetch key level data on a ValKey/Redis Cluster).
Whether to scrape Tile38 specific metrics.
Log format, valid options are txt and json (default "txt").
The maximum number of distinct key groups with the most memory utilization to present as distinct metrics per database, the leftover key groups will be aggregated in the 'overflow' bucket (default 100).
Namespace for metrics (default "redis").
Whether to ping the redis instance after connecting.
Whether to redact config settings that include potentially sensitive information like passwords (default true).
Whether to also export go runtime metrics.
Address of the ValKey/Redis instance to scrape (default "redis://localhost:6379").
Password of the ValKey/Redis instance to scrape.
-redis.password-file string
Password file of the ValKey/Redis instance to scrape.
User name to use for authentication (ValKey/Redis ACL for ValKey/Redis 6.0 and newer).
Path to Lua ValKey/Redis script for collecting extra metrics.
Whether to set client name to redis_exporter (default true).
Whether to to skip TLS verification.
Do not collect per consumer metrics for streams (decreases cardinality).
Name of the CA certificate file (including full path) if the server requires TLS client authentication.
Name of the client certificate file (including full path) if the server requires TLS client authentication.
Name of the client key file (including full path) if the server requires TLS client authentication.
Name of the CA certificate file (including full path) if the web interface and telemetry should require TLS client authentication.
Name of the server certificate file (including full path) if the web interface and telemetry should use TLS.
Name of the server key file (including full path) if the web interface and telemetry should use TLS.
Minimum TLS version that is acceptable by the web interface and telemetry when using TLS (default "TLS1.2").
Address to listen on for web interface and telemetry (default ":9121").
Path under which to expose metrics (default "/metrics").
Output verbose debug information.
Show version information and exit.

SEE ALSO

redis-server(8), prometheus(1).

2020-03-13 1.4.0