Garnet

Plugin: go.d.plugin Module: redis

Overview

Monitor Garnet server health and performance, including memory, connections, keyspace, replication, and persistence status.

Netdata monitors Garnet through the Redis protocol and reports the Garnet INFO fields that match Redis semantics. Workload, connection, traffic, and lookup metrics require periodic sampling on the Garnet server. Per-command call counts require --commandstats-monitor.

It connects to the Garnet instance via a TCP or UNIX socket and executes the following commands:

• INFO ALL
• PING
• INFO KEYSPACE — requested at most every 30 seconds; Garnet answers it with a full store scan
• INFO COMMANDSTATS — requested every cycle; populated only when the server runs with --commandstats-monitor

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Garnet can be monitored further using the following other integrations:

• Applications
• Containers

Default Behavior

Auto-Detection

By default, it detects instances running on localhost by attempting to connect using known Redis-compatible TCP and UNIX sockets:

• 127.0.0.1:6379
• /tmp/redis.sock
• /var/run/redis/redis.sock
• /var/lib/redis/redis.sock

The Netdata Agent service discovery can also create jobs automatically:

• The net_listeners discoverer matches processes listening on TCP port 6379, or whose command name is redis-server, and creates a job with the discovered address. The rule lives in go.d/sd/net_listeners.conf.
• The docker discoverer matches containers exposing port 6379 or using a redis image and creates a job with the discovered address. The rule lives in go.d/sd/docker.conf.

Limits

The Garnet server does not expose some data the Redis protocol surfaces, so the following charts have no data for Garnet:

• Process CPU usage and per-command CPU time
• Allocator memory: used, peak, max memory, dataset, Lua, scripts, and the memory fragmentation ratio
• Key evictions and key expirations
• The RDB save duration, the time since the last save, and the changes since the last save
• Blocked and tracking clients
• The duration of a down replica link; link status remains available

When Garnet reports monitor_task:disabled, workload, connection, traffic, and lookup charts stay empty because its counters are not sampled. Per-command call counts remain available with --commandstats-monitor; Garnet does not measure per-command CPU time.

The keyspace section requires a full store scan on the Garnet server, so the collector requests it at most every 30 seconds; key counts can be up to 30 seconds old.

Performance Impact

Collection is lightweight for the Netdata Agent. The periodic INFO KEYSPACE request runs a full store scan on the Garnet server; on very large stores it may exceed the job timeout, in which case the keys and expires-keys charts stay empty until the timeout option is raised.

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

Enable periodic metrics sampling

Start Garnet with --metrics-sampling-freq 1 to sample workload, connections, network traffic, and key lookups every second. Sampling is disabled by default.

Verify that redis-cli INFO SERVER reports monitor_task:enabled. Enabling only --commandstats-monitor does not enable these general metrics.

Enable per-command statistics

The calls-per-command chart is populated only when the Garnet server tracks per-command usage. CPU timing charts remain empty.

Start the Garnet server with the --commandstats-monitor flag, then verify with redis-cli:

redis-cli INFO COMMANDSTATS

The reply contains cmdstat_ entries when tracking is enabled.

Configuration

Options

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

Config options

Group	Option	Description	Default	Required
Target	address	Redis server address as a URL: redis:// or rediss:// (TLS) for TCP, unix:// for a Unix socket.	redis://@localhost:6379	yes
	timeout	Connection and read/write timeout, in seconds.	1	no
Auth	username	Username for authentication. A username in the address takes precedence.		no
	password	Password for authentication. A password in the address takes precedence.		no
TLS	tls_skip_verify	Skip TLS certificate and hostname verification. Insecure.	no	no
	tls_ca	Path to a CA bundle used to verify the server certificate. Leave empty to use the system trust store.		no
	tls_cert	Path to a client certificate file for mutual TLS. Requires a client key.		no
	tls_key	Path to the client key file for mutual TLS. Requires a client certificate.		no
Collection	update_every	Data collection interval, in seconds.	1	no
	autodetection_retry	How often to retry the initial connection when the job fails to start, in seconds. Zero disables retries.	0	no
	ping_samples	Number of PING commands sent each data collection interval to measure latency.	5	no
Functions	functions.top_queries.disabled	Disable the Top Queries function.	no	no
	functions.top_queries.timeout	Query timeout, in seconds. Zero uses the collector timeout.		no
	functions.top_queries.limit	Maximum number of slow log entries to return. Zero uses the default (500).	500	no
Virtual Node	vnode	Associates this job with a Virtual Node.		no

address

There are two connection types: TCP socket and Unix socket.

• TCP: redis://<user>:<password>@<host>:<port>/<db_number> (rediss:// for TLS)
• Unix: unix://<user>:<password>@</path/to/redis.sock>?db=<db_number>

Setting any TLS option also enables TLS for a redis:// address.

via UI

Configure the redis collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the redis data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type redis (or scroll the list) to locate the redis collector.
5. Click the + next to the redis collector to add a new job.
6. 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:

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.

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

Examples

TCP socket

An example configuration.

Config

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

Unix socket

An example configuration.

Config

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

TCP socket with password

An example configuration.

Config

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

Multi-instance

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

Local and remote instances.

Config

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

  - name: remote
    address: 'redis://user:password@203.0.113.0:6379'

Alerts

The following alerts are available:

Alert name	On metric	Description
Alert name redis_connections_rejected	On metricredis.connections	Descriptionconnections rejected because of maxclients limit in the last minute
Alert name redis_bgsave_broken	On metricredis.bgsave_health	Descriptionstatus of the last RDB save operation (0: ok, 1: error)

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 Garnet instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric	Description	Dimensions	Unit
redis.connections	Accepted and rejected (maxclients limit) connections	accepted, rejected	connections/s
redis.clients	Clients	connected, blocked, tracking, in_timeout_table	clients
redis.ping_latency	Ping latency	min, max, avg	seconds
redis.commands	Processed commands	processes	commands/s
redis.keyspace_lookup_hit_rate	Keys lookup hit rate	lookup_hit_rate	percentage
redis.memory	Memory usage	max, used, rss, peak, dataset, lua, scripts	bytes
redis.mem_fragmentation_ratio	Ratio between used_memory_rss and used_memory	mem_fragmentation	ratio
redis.key_eviction_events	Evicted keys due to maxmemory limit	evicted	keys/s
redis.net	Bandwidth	received, sent	kilobits/s
redis.rdb_changes	Operations that produced changes since the last SAVE or BGSAVE	changes	operations
redis.bgsave_now	Duration of the on-going RDB save operation if any	current_bgsave_time	seconds
redis.bgsave_health	Status of the last RDB save operation (0: ok, 1: err)	last_bgsave	status
redis.bgsave_last_rdb_save_since_time	Time elapsed since the last successful RDB save	last_bgsave_time	seconds
redis.aof_file_size	AOF file size	current, base	bytes
redis.commands_calls	Calls per command	a dimension per command	calls
redis.commands_usec	Total CPU time consumed by the commands	a dimension per command	microseconds
redis.commands_usec_per_sec	Average CPU consumed per command execution	a dimension per command	microseconds/s
redis.key_expiration_events	Expired keys	expired	keys/s
redis.database_keys	Keys per database	a dimension per database	keys
redis.database_expires_keys	Keys with an expiration per database	a dimension per database	keys
redis.connected_replicas	Connected replicas	connected	replicas
redis.master_link_status	Master link status	up, down	status
redis.master_last_io_since_time	Time elapsed since the last interaction with master	time	seconds
redis.master_link_down_since_time	Time elapsed since the link between master and slave is down	time	seconds
redis.uptime	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

Diagnostics

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].

  cd /usr/libexec/netdata/plugins.d/

• Switch to the netdata user.

  sudo -u netdata -s

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m redis

  To debug a specific job:

  ./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:

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:

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:

docker logs netdata 2>&1 | grep redis