Project: Netdata (Observability and Analysis / Observability)
File: redis.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/redis/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/redis/metadata.yaml" sidebar_label: "Redis" learn_status: "Published" learnrelpath: "Collecting Metrics/Databases" most_popular: True message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/redis.svg" width="150"/> Plugin: go.d.plugin Module: redis <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> This collector monitors the health and performance of Redis servers and collects general statistics, CPU and memory consumption, replication information, command statistics, and more. It connects to the Redis instance via a TCP or UNIX socket and executes the following commands: This collector is supported on all platforms. This collector supports collecting metrics from multiple instances of this integration, including remote instances. By default, it detects instances running on localhost by attempting to connect using known Redis TCP and UNIX sockets: 127.0.0.1:6379 /tmp/redis.sock /var/run/redis/redis.sock /var/lib/redis/redis.sock The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. These metrics refer to the entire monitored application. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | redis.connections | accepted, rejected | connections/s | | redis.clients | connected, blocked, tracking, intimeouttable | clients | | redis.ping_latency | min, max, avg | seconds | | redis.commands | processes | commands/s | | redis.keyspacelookuphitrate | lookuphit_rate | percentage | | redis.memory | max, used, rss, peak, dataset, lua, scripts | bytes | | redis.memfragmentationratio | mem_fragmentation | ratio | | redis.keyevictionevents | evicted | keys/s | | redis.net | received, sent | kilobits/s | | redis.rdb_changes | changes | operations | | redis.bgsavenow | currentbgsave_time | seconds | | redis.bgsavehealth | lastbgsave | status | | redis.bgsavelastrdbsavesincetime | lastbgsave_time | seconds | | redis.aoffilesize | current, base | bytes | | redis.commands_calls | a dimension per command | calls | | redis.commands_usec | a dimension per command | microseconds | | redis.commandsusecper_sec | a dimension per command | microseconds/s | | redis.keyexpirationevents | expired | keys/s | | redis.database_keys | a dimension per database | keys | | redis.databaseexpireskeys | a dimension per database | keys | | redis.connected_replicas | connected | replicas | | redis.masterlinkstatus | up, down | status | | redis.masterlastiosincetime | time | seconds | | redis.masterlinkdownsincetime | time | seconds | |

| uptime | seconds | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | redis.connections | connections rejected because of maxclients limit in the last minute | | | redis.bgsave_now | duration of the on-going RDB save operation | | | redis.bgsave_health | status of the last RDB save operation (0: ok, 1: error) | | | redis.masterlinkdownsincetime | time elapsed since the link between master and slave is down | No action required. The configuration file name for this integration is `go.d/redis.conf`. You can edit the configuration file using the `edit-config` script from the Netdata . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/redis.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | update_every | Data collection frequency. | 5 | no | | autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no | | address | Redis server address. | redis://@localhost:6379 | yes | | timeout | Dial (establishing new connections), read (socket reads) and write (socket writes) timeout in seconds. | 1 | no | | username | Username used for authentication. | | no | | password | Password used for authentication. | | no | | tlsskipverify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no | | tls_ca | Certificate authority that client use when verifying server certificates. | | no | | tls_cert | Client tls certificate. | | no | | tls_key | Client tls key. | | no | </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local address: 'redis://@127.0.0.1:6379' ``` </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local address: 'unix://@/tmp/redis.sock' ``` </details> An example configuration. <details><summary>Config</summary> ```yaml jobs: name: local address: 'redis://:password@127.0.0.1:6379' ``` </details> Note: When you define multiple jobs, their names must be unique. Local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local address: 'redis://:password@127.0.0.1:6379' name: remote address: 'redis://user:password@203.0.113.0:6379' ``` </details> To troubleshoot issues with the `redis` collector, run the `go.d.plugin` with the debug option enabled. The output should give you clues as to why the collector isn't working. Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m redis ```