prometheus-redis-exporter(1)

💖 prometheus-redis-exporter 💖

okay bestie, sit down, hydrate, because today we're talking about prometheus-redis-exporter — a manual page from the prometheus corner of the docs, and honestly? she's a baddie.

✨ NAME ✨

prometheus-redis-exporter — a Prometheus exporter for Valkey/Redis metrics 🍓

---

🌈 SYNOPSIS 🌈

prometheus-redis-exporter [option...]

---

🦋 DESCRIPTION 🦋

so this exporter? she goes out, grabs all the monitoring data from your Valkey (or Redis) servers, and then serves it up over an HTTP server so Prometheus can come collect it. that's the whole vibe. it's giving matchmaker, but for metrics. 💅

---

🎀 OPTIONS 🎀

like, there's a LOT of them, and every single one is here, no skipping, periodt.

• -check-key-groups string — a comma separated list of lua regex for grouping keys
• -check-keys string — comma separated list of key-patterns to export value and length/size, searched for with SCAN
• -check-keys-batch-size int — approximate number of keys to process in each execution; bigger value = faster scanning. ⚠️ WARNING: Valkey and Redis are still single-threaded apps (unlike KeyDB), so a huge COUNT can affect your production environment (default 1000)
• -check-single-keys string — comma separated list of single keys to export value and length/size
• -check-single-streams string — comma separated list of single streams to export info about streams, groups and consumers
• -check-streams string — comma separated list of stream-patterns to export info about streams, groups and consumers, searched for with SCAN
• -config-command string — what to use for the CONFIG command (default "CONFIG")
• -connection-timeout string — timeout for connection to Valkey/Redis instance (default "15s")
• -count-keys string — comma separated list of patterns to count (eg: 'db0=production_*,db3=sessions:*'), searched for with SCAN
• -disable-exporting-key-values — whether to disable values of keys stored in redis as labels or not when using -check-keys or -check-single-key
• -exclude-latency-histogram-metrics — do not try to collect latency histogram metrics
• -export-client-list — whether to scrape Client List specific metrics
• -export-client-port — 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
• -include-config-metrics — whether to include all config settings as metrics
• -include-system-metrics — whether to include system metrics like e.g. redis_total_system_memory_bytes
• -is-cluster — whether this is a Valkey/Redis cluster (enable this if you need to fetch key level data on a Valkey/Redis Cluster)
• -is-tile38 — whether to scrape Tile38 specific metrics
• -log-format string — log format, valid options are txt and json (default "txt")
• -max-distinct-key-groups int — the maximum number of distinct key groups with the most memory utilization to present as distinct metrics per database; the leftover key groups get aggregated into the 'overflow' bucket (default 100)
• -namespace string — namespace for metrics (default "redis")
• -ping-on-connect — whether to ping the redis instance after connecting
• -redact-config-metrics — whether to redact config settings that include potentially sensitive information like passwords (default true)
• -redis-only-metrics — whether to also export go runtime metrics
• -redis.addr string — address of the Valkey/Redis instance to scrape (default "redis://localhost:6379")
• -redis.password string — password of the Valkey/Redis instance to scrape
• -redis.password-file string — password file of the Valkey/Redis instance to scrape
• -redis.user string — user name to use for authentication (Valkey/Redis ACL for Valkey/Redis 6.0 and newer)
• -script string — path to Lua Valkey/Redis script for collecting extra metrics
• -set-client-name — whether to set client name to redis_exporter (default true)
• -skip-tls-verification — whether to skip TLS verification
• -streams-exclude-consumer-metrics — do not collect per consumer metrics for streams (decreases cardinality)
• -tls-ca-cert-file string — name of the CA certificate file (including full path) if the server requires TLS client authentication
• -tls-client-cert-file string — name of the client certificate file (including full path) if the server requires TLS client authentication
• -tls-client-key-file string — name of the client key file (including full path) if the server requires TLS client authentication
• -tls-server-ca-cert-file string — name of the CA certificate file (including full path) if the web interface and telemetry should require TLS client authentication
• -tls-server-cert-file string — name of the server certificate file (including full path) if the web interface and telemetry should use TLS
• -tls-server-key-file string — name of the server key file (including full path) if the web interface and telemetry should use TLS
• -tls-server-min-version string — minimum TLS version that is acceptable by the web interface and telemetry when using TLS (default "TLS1.2")
• -web.listen-address string — address to listen on for web interface and telemetry (default ":9121")
• -web.telemetry-path string — path under which to expose metrics (default "/metrics")
• -debug — output verbose debug information
• -version — show version information and exit

---

👑 SEE ALSO 👑

go be nosy, bestie, these are all iconique:

• valkey-server(1)
• redis-server(8)
• prometheus(1)

---

that's the whole page, no notes, you ate it 💅✨

and for the little sign-off moment: this beauty is version 1.4.0, dated 2020-03-13, and she lives in the prometheus section of the manual. mwah. 🫶💖