Redis

Plugin: go.d.plugin Module: redis

Overview

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.

Redis can be monitored further using the following other integrations:

Default Behavior

Auto-Detection

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

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the redis collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for redis, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit `go.d/redis.conf` and add a job.

:::important

UI configuration requires paid Netdata Cloud plan.

:::

Prerequisites

No action required.

Configuration

Options

The following options can be defined globally: update_every, autodetection_retry.

<details open><summary>Config options</summary>

Group	Option	Description	Default	Required
Collection	update_every	Data collection interval (seconds).	5	no
	autodetection_retry	Autodetection retry interval (seconds). Set 0 to disable.	0	no
Target	address	Redis server address (TCP or Unix socket).	redis://@localhost:6379	yes
	timeout	Dial, read, and write timeout (seconds).	1	no
Auth	username	Username for authentication.		no
	password	Password for authentication.		no
TLS	tls_skip_verify	Skip TLS certificate and hostname verification (insecure).	no	no
	tls_ca	Path to CA bundle used to validate the server certificate.		no
	tls_cert	Path to client TLS certificate (for mTLS).		no
	tls_key	Path to client TLS private key (for mTLS).		no
Functions	functions.top_queries.disabled	Disable the top-queries function.	no	no
	functions.top_queries.timeout	Query timeout (seconds). Uses collector timeout if not set.		no
	functions.top_queries.limit	Maximum number of queries to return.	500	no
Virtual Node	vnode	Associates this data collection job with a Virtual Node.		no

</details>

via UI

Configure the redis collector from the Netdata web interface:

Go to Nodes.
Select the node where you want the redis data-collection job to run and click the :gear: (Configure this node). That node will run the data collection.
The Collectors → Jobs view opens by default.
In the Search box, type redis (or scroll the list) to locate the redis collector.
Click the + next to the redis collector to add a new job.
Fill in the job fields, then click Test to verify the configuration and Submit to save.
- Test runs the job with the provided settings and shows whether data can be collected.
- If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/redis.conf.

The file format is YAML. Generally, the structure is:

yaml

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

You can edit the configuration file using the edit-config script from the Netdata config directory.

bash

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/redis.conf

Examples

TCP socket

An example configuration.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    address: 'redis://@127.0.0.1:6379'

</details>

Unix socket

An example configuration.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    address: 'unix://@/tmp/redis.sock'

</details>

TCP socket with password

An example configuration.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    address: 'redis://:[email protected]:6379'

</details>

Multi-instance

Note: When you define multiple jobs, their names must be unique.

Local and remote instances.

<details open><summary>Config</summary>

yaml

jobs:
  - name: local
    address: 'redis://:[email protected]:6379'

  - name: remote
    address: 'redis://user:[email protected]:6379'

</details>

Alerts

The following alerts are available:

Alert name	On metric	Description
redis_connections_rejected	redis.connections	connections rejected because of maxclients limit in the last minute
redis_bgsave_slow	redis.bgsave_now	duration of the on-going RDB save operation
redis_bgsave_broken	redis.bgsave_health	status of the last RDB save operation (0: ok, 1: error)
redis_master_link_down	redis.master_link_down_since_time	time elapsed since the link between master and slave is down

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per Redis instance

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, in_timeout_table	clients
redis.ping_latency	min, max, avg	seconds
redis.commands	processes	commands/s
redis.keyspace_lookup_hit_rate	lookup_hit_rate	percentage
redis.memory	max, used, rss, peak, dataset, lua, scripts	bytes
redis.mem_fragmentation_ratio	mem_fragmentation	ratio
redis.key_eviction_events	evicted	keys/s
redis.net	received, sent	kilobits/s
redis.rdb_changes	changes	operations
redis.bgsave_now	current_bgsave_time	seconds
redis.bgsave_health	last_bgsave	status
redis.bgsave_last_rdb_save_since_time	last_bgsave_time	seconds
redis.aof_file_size	current, base	bytes
redis.commands_calls	a dimension per command	calls
redis.commands_usec	a dimension per command	microseconds
redis.commands_usec_per_sec	a dimension per command	microseconds/s
redis.key_expiration_events	expired	keys/s
redis.database_keys	a dimension per database	keys
redis.database_expires_keys	a dimension per database	keys
redis.connected_replicas	connected	replicas
redis.master_link_status	up, down	status
redis.master_last_io_since_time	time	seconds
redis.master_link_down_since_time	time	seconds
redis.uptime	uptime	seconds

Live Data

This collector exposes real-time functions for interactive troubleshooting in the Live tab.

Top Queries

Retrieves slow command entries from Redis SLOWLOG.

This function executes the SLOWLOG GET command to retrieve entries of commands that exceeded the configured execution time threshold (slowlog-log-slower-than). It provides command details, execution duration, and client information for each slow command.

Use cases:

Identify slow commands that may need optimization
Analyze command patterns to detect performance hotspots
Investigate client sources of slow commands

Command text is truncated at 4096 characters for display purposes.

Aspect	Description
Name	`Redis:top-queries`
Require Cloud	yes
Performance	Executes `SLOWLOG GET` command to retrieve entries from Redis memory:
• Minimal overhead as SLOWLOG is stored in memory
• Default limit of 500 entries balances completeness with performance
• Large slowlogs with many entries may take slightly longer to transfer
Security	Command arguments may contain unmasked literal values including potentially sensitive data:
• Redis keys and values in command arguments
• Application-specific identifiers or session tokens
• Access should be restricted to authorized personnel only
Availability	Available when:
• The collector has successfully connected to Redis
• SLOWLOG is enabled (`slowlog-log-slower-than` > 0)
• Returns HTTP 503 if collector is still initializing
• Returns HTTP 500 if the command fails
• Returns HTTP 504 if the command times out

Prerequisites

No additional configuration is required.

Parameters

Parameter	Type	Description	Required	Default	Options
Filter By	select	Select the primary sort column. Options include duration, timestamp, ID, and command name. Defaults to duration to focus on slowest commands.	yes	duration

Returns

Slowlog entries with command timing and client metadata, providing insight into Redis performance patterns. Each row represents a single slow command execution that exceeded the configured threshold.

Column	Type	Unit	Visibility	Description
ID	integer		hidden	Unique identifier for the slowlog entry. Allows tracking individual command executions.
Timestamp	timestamp			Date and time when the slow command was executed. Useful for correlating slow commands with application events or system changes.
Command	string			Full command text including all arguments. May contain sensitive data (keys, values) depending on application implementation. Truncated to 4096 characters.
Command Name	string			The Redis command name (e.g., SET, GET, HGETALL, ZADD). Useful for grouping and analyzing slow commands by type.
Duration	duration	milliseconds		Execution time that exceeded the slowlog threshold. Higher values indicate slower commands that may need optimization or investigation.
Client Address	string		hidden	IP address of the client that executed the slow command. Useful for identifying problematic clients or network segments.
Client Name	string		hidden	Client identifier or name reported by Redis. Useful for identifying specific applications or services generating slow commands.

Troubleshooting

Debug Mode

Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

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
```
To debug a specific job:
bash
```
./go.d.plugin -d -m redis -j jobName
```

Getting Logs

If you're encountering problems with the redis collector, follow these steps to retrieve logs and identify potential issues:

Run the command specific to your system (systemd, non-systemd, or Docker container).
Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

System with systemd

Use the following command to view logs generated since the last Netdata service restart:

bash

journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep redis

System without systemd

Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:

bash

grep redis /var/log/netdata/collector.log

Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.

Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

bash

docker logs netdata 2>&1 | grep redis