Usage of /usr/bin/valkey_exporter:
-append-instance-role-label
Whether to append 'instance_role' label to redis metrics
-basic-auth-hash-password string
Hashed password for basic authentication, bcrypt format, conflicts with --basic-auth-password
-basic-auth-password string
Password for basic authentication, conflicts with --basic-auth-hash-password
-basic-auth-username string
Username for basic authentication
-check-key-groups string
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, larger value speeds up scanning.
WARNING: Still Redis is a single-threaded app, huge COUNT can affect production environment. (default 1000)
-check-search-indexes string
Regex pattern for Redis Search indexes to export metrics from FT.INFO command (default ".*")
-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
-cluster-discover-hostnames /discover-cluster-nodes
Whether to use hostname for cluster node discovery if available via /discover-cluster-nodes endpoint.
-config-command string
What to use for the CONFIG command, set to "-" to skip config metrics extraction (default "CONFIG")
-connection-timeout string
Timeout for connection to Redis instance (default "15s")
-count-keys string
Comma separated list of patterns to count (eg: 'db0=production_*,db3=sessions:*'), searched for with SCAN
-debug
Output verbose debug information (sets log level to DEBUG, takes precedence over "--log-level")
-disable-exporting-key-values
Whether to disable values of keys stored in redis as labels or not when using check-keys/check-single-key
-disable-scrape-endpoint
Whether to disable the /scrape endpoint
-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-go-runtime-metrics
Whether to include Go runtime metrics
-include-metrics-for-empty-databases
Whether to emit db metrics (like db_keys) for empty databases (default true)
-include-modules-metrics
Whether to collect Redis Modules metrics
-include-rdb-file-size-metric
Whether to include RDB file size metric. Note: Requires the exporter to run on the same host as Redis with read access to the RDB directory. Will not work in remote or containerized deployments where the RDB file is not accessible.
-include-search-indexes-metrics
Whether to collect Redis Search indexes metrics
-include-sentinel-peer-info
Whether to export sentinel_peer_info metrics (high cardinality)
-include-system-metrics
Whether to include system metrics like e.g. redis_total_system_memory_bytes
-is-cluster
Whether this is a redis cluster (Enable this if you need to fetch key level data on a Redis Cluster).
-is-tile38
Whether to scrape Tile38 specific metrics
-log-format string
Log format, valid options are txt and json (default "txt")
-log-level string
Set log level (default "INFO")
-lua-script-read-only
Use EVAL_RO command for gathering extra metrics with Lua script
-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 will be aggregated in 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 export only Redis metrics (omit Go process+runtime metrics)
-redis.addr string
Address of the Redis instance to scrape (default "redis://localhost:6379")
-redis.password string
Password of the Redis instance to scrape
-redis.password-file string
Password file of the Redis instance to scrape
-redis.user string
User name to use for authentication (Redis ACL for Redis 6.0 and newer)
-script string
Comma separated list of path(s) to Redis Lua script(s) for gathering extra metrics
-set-client-name
Whether to set client name to redis_exporter (default true)
-skip-checkkeys-for-role-master
Whether to skip gathering the check-keys metrics (size, val) when the instance is of type master (reduce load on master nodes)
-skip-tls-verification
Whether to to skip TLS verification
-streams-exclude-consumer-metrics
Don't 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")
-tls-server-name string
Server name used to verify the Redis server certificate when connecting over TLS
-version
Show version information and exit
-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")
Options (59)
| Option | Description | Source |
|---|---|---|
-append-instance-role-label | Whether to append 'instance_role' label to redis metrics | help |
-basic-auth-hash-password string | Hashed password for basic authentication, bcrypt format, conflicts with --basic-auth-password | help |
-basic-auth-password string | Password for basic authentication, conflicts with --basic-auth-hash-password | help |
-basic-auth-username string | Username for basic authentication | help |
-check-key-groups string | Comma separated list of lua regex for grouping keys | help |
-check-keys string | Comma separated list of key-patterns to export value and length/size, searched for with SCAN | help |
-check-keys-batch-size int | Approximate number of keys to process in each execution, larger value speeds up scanning. | help |
-check-search-indexes string | Regex pattern for Redis Search indexes to export metrics from FT.INFO command (default ".*") | help |
-check-single-keys string | Comma separated list of single keys to export value and length/size | help |
-check-single-streams string | Comma separated list of single streams to export info about streams, groups and consumers | help |
-check-streams string | Comma separated list of stream-patterns to export info about streams, groups and consumers, searched for with SCAN | help |
-cluster-discover-hostnames /discover-cluster-nodes | Whether to use hostname for cluster node discovery if available via /discover-cluster-nodes endpoint. | help |
-config-command string | What to use for the CONFIG command, set to "-" to skip config metrics extraction (default "CONFIG") | help |
-connection-timeout string | Timeout for connection to Redis instance (default "15s") | help |
-count-keys string | Comma separated list of patterns to count (eg: 'db0=production_*,db3=sessions:*'), searched for with SCAN | help |
-debug | Output verbose debug information (sets log level to DEBUG, takes precedence over "--log-level") | help |
-disable-exporting-key-values | Whether to disable values of keys stored in redis as labels or not when using check-keys/check-single-key | help |
-disable-scrape-endpoint | Whether to disable the /scrape endpoint | help |
-exclude-latency-histogram-metrics | Do not try to collect latency histogram metrics | help |
-export-client-list | Whether to scrape Client List specific metrics | help |
-export-client-port | Whether to include the client's port when exporting the client list. | help |
-include-config-metrics | Whether to include all config settings as metrics | help |
-include-go-runtime-metrics | Whether to include Go runtime metrics | help |
-include-metrics-for-empty-databases | Whether to emit db metrics (like db_keys) for empty databases (default true) | help |
-include-modules-metrics | Whether to collect Redis Modules metrics | help |
-include-rdb-file-size-metric | Whether to include RDB file size metric. | help |
-include-search-indexes-metrics | Whether to collect Redis Search indexes metrics | help |
-include-sentinel-peer-info | Whether to export sentinel_peer_info metrics (high cardinality) | help |
-include-system-metrics | Whether to include system metrics like e.g. redis_total_system_memory_bytes | help |
-is-cluster | Whether this is a redis cluster (Enable this if you need to fetch key level data on a Redis Cluster). | help |
-is-tile38 | Whether to scrape Tile38 specific metrics | help |
-log-format string | Log format, valid options are txt and json (default "txt") | help |
-log-level string | Set log level (default "INFO") | help |
-lua-script-read-only | Use EVAL_RO command for gathering extra metrics with Lua script | help |
-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 will be aggregated in the 'overflow' bucket (default… | help |
-namespace string | Namespace for metrics (default "redis") | help |
-ping-on-connect | Whether to ping the redis instance after connecting | help |
-redact-config-metrics | Whether to redact config settings that include potentially sensitive information like passwords (default true) | help |
-redis-only-metrics | Whether to export only Redis metrics (omit Go process+runtime metrics) | help |
-redis.addr string | Address of the Redis instance to scrape (default "redis://localhost:6379") | help |
-redis.password string | Password of the Redis instance to scrape | help |
-redis.password-file string | Password file of the Redis instance to scrape | help |
-redis.user string | User name to use for authentication (Redis ACL for Redis 6.0 and newer) | help |
-script string | Comma separated list of path(s) to Redis Lua script(s) for gathering extra metrics | help |
-set-client-name | Whether to set client name to redis_exporter (default true) | help |
-skip-checkkeys-for-role-master | Whether to skip gathering the check-keys metrics (size, val) when the instance is of type master (reduce load on master nodes) | help |
-skip-tls-verification | Whether to to skip TLS verification | help |
-streams-exclude-consumer-metrics | Don't collect per consumer metrics for streams (decreases cardinality) | help |
-tls-ca-cert-file string | Name of the CA certificate file (including full path) if the server requires TLS client authentication | help |
-tls-client-cert-file string | Name of the client certificate file (including full path) if the server requires TLS client authentication | help |
-tls-client-key-file string | Name of the client key file (including full path) if the server requires TLS client authentication | help |
-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 | help |
-tls-server-cert-file string | Name of the server certificate file (including full path) if the web interface and telemetry should use TLS | help |
-tls-server-key-file string | Name of the server key file (including full path) if the web interface and telemetry should use TLS | help |
-tls-server-min-version string | Minimum TLS version that is acceptable by the web interface and telemetry when using TLS (default "TLS1.2") | help |
-tls-server-name string | Server name used to verify the Redis server certificate when connecting over TLS | help |
-version | Show version information and exit | help |
-web.listen-address string | Address to listen on for web interface and telemetry. | help |
-web.telemetry-path string | Path under which to expose metrics. | help |