Fortinet black logo

User Guide

Redis

24.1.0
Copy Link
Copy Doc ID af1daa65-c273-11ec-9fd1-fa163e15d75b:553597
Download PDF

Redis

The Redis plugin allows you to monitor a number of metrics on your key-value data store. If used effectively, this plugin can help you prevent outages before they happen. For example, you can use this plugin to alert your IT team when Redis’ memory usage becomes dangerously high.

If you cannot find this plugin in the /usr/lib/fm-agent/plugins folder, then your version of the agent is out of date and you should update it to gain access to this feature.

If you haven't yet read the article Add FortiMonitor Agent checks, you should start there.

Agent Configuration

If your Redis instance is secured with password protection, you will need to add the password to the agent config file:

  • /etc/fm-agent/fm_agent.cfg

If your Redis instance does not require a password, this section in the config file is not required.

[redis]
password = xxxxx

Control Panel Configuration

To use the Redis plugin, first select Redis from the monitoring catalog.

There are a number of metrics to monitor available.

  • Clients: blocked clients

  • Clients: connected clients

  • Data: length of list

  • Memory: used memory

  • Memory: used memory peak

  • Memory: used memory rss

  • Persistence: background save in progress

  • Persistence: changes since last save

  • Replication: connected slaves

  • Replication: role (master=1, slave=0)

  • Server: uptime in seconds

  • Stats: evicted keys

  • Stats: expired keys

  • Stats: keyspace hits

  • Stats: keyspace misses

  • Stats: pub/sub channels

  • Stats: pub/sub patterns

  • Stats: total commands processed

If you would like to inspect the Redis plugin in more detail, you can find the python script for it in the /usr/lib/fm-agent/pluginsfolder.

Redis

The Redis plugin allows you to monitor a number of metrics on your key-value data store. If used effectively, this plugin can help you prevent outages before they happen. For example, you can use this plugin to alert your IT team when Redis’ memory usage becomes dangerously high.

If you cannot find this plugin in the /usr/lib/fm-agent/plugins folder, then your version of the agent is out of date and you should update it to gain access to this feature.

If you haven't yet read the article Add FortiMonitor Agent checks, you should start there.

Agent Configuration

If your Redis instance is secured with password protection, you will need to add the password to the agent config file:

  • /etc/fm-agent/fm_agent.cfg

If your Redis instance does not require a password, this section in the config file is not required.

[redis]
password = xxxxx

Control Panel Configuration

To use the Redis plugin, first select Redis from the monitoring catalog.

There are a number of metrics to monitor available.

  • Clients: blocked clients

  • Clients: connected clients

  • Data: length of list

  • Memory: used memory

  • Memory: used memory peak

  • Memory: used memory rss

  • Persistence: background save in progress

  • Persistence: changes since last save

  • Replication: connected slaves

  • Replication: role (master=1, slave=0)

  • Server: uptime in seconds

  • Stats: evicted keys

  • Stats: expired keys

  • Stats: keyspace hits

  • Stats: keyspace misses

  • Stats: pub/sub channels

  • Stats: pub/sub patterns

  • Stats: total commands processed

If you would like to inspect the Redis plugin in more detail, you can find the python script for it in the /usr/lib/fm-agent/pluginsfolder.