Redis Monitoring

Redis is an open-source, networked software project that implements data structure servers. Identify and resolve issues with Redis-based apps before end users are affected with Site24x7 plugins.

This document details how to configure the Redis plugin and the monitoring metrics for providing in-depth visibility into the performance, availability, and usage stats of Redis servers.

Redis performance monitoring metrics:

The Various out-of-the-box metrics we support are:

Used Memory

"memory_used" gives the total amount of memory in bytes that is used by the Redis server. If it exceeds physical memory, system will start swapping causing severe performance degradation.

Peak used memory

"memory_used_peak" metric calculates and displays the highest amount of memory in bytes consumed by the Redis server.

Used CPU system

The metric "cpu_used_sys" gets the total amount of system CPU consumed by the Redis server. High CPU usage is not bad as long as it doesn't exceed CPU limit.

Used CPU user

The metric "cpu_used_user" records the total amount of user CPU consumed by the Redis server.

Used CPU user children

The metric "cpu_used_user_children" records the total amount of user CPU consumed by other background processes.

Used CPU system children

Get the total amount of system CPU consumed by background processes with the metric "cpu_used_sys_children".

Keyspace hits

Get the total number of failed key lookups in the main dictionary that have taken place in the system using the metric "keyspace_misses".

Keyspace misses

Use the metric "keyspace_hits" and get the total number of successful key lookups in the main dictionary that have taken place in the system.

Total connections recieved

Get the total number of connections rejected using the metric "rejected_conn". The connections are rejected whenever client limit is reached.

Rejected connections

Use the metric "total_conn_rec" and get the total number of connections accepted by the Redis server.

Connected clients

Get the total number of slave connections made to the Redis server with the metric "conn_slaves".

Connected slaves

The metric "conn_clients" records the total number of client connections made to the Redis server. This count will exclude connections from slaves.

Quick installation

If you're using Linux servers, use the Redis plugin installer that checks the prerequisites and installs the plugin with a bash script. You don't need to manually set up the plugin if you're using the installer.

Execute the command below in the terminal to run the installer and follow the instructions displayed on-screen:


                wget https://raw.githubusercontent.com/site24x7/plugins/master/redis/installer/Site24x7redisPluginInstaller.sh && sudo bash Site24x7redisPluginInstaller.sh

Bulk installation

The Redis plugin supports bulk installation across multiple servers through automation using Ansible. To install the plugin using Ansible, refer to the Redis Ansible playbook.

Standard installation

If you're not using Linux servers or want to install the plugin manually, follow the steps below.

Prerequisites:

Download and install the Site24x7 server monitoring agent (Linux | Windows) on the server where you plan to run the plugin.
Ensure you have Python 3 or a higher version installed on your server.
Site24x7 uses the redis module to get performance metrics from the Redis server. Execute the following command on your server to install the redis module: pip3 install redis

Installation

Create a folder named redis.
Download the redis.py" and redis.cfg files from our GitHub repository and place them in the redis folder.
wget https://raw.githubusercontent.com/site24x7/plugins/master/redis/redis.py && sed -i "1s|^.*|#! $(which python3)|" redis.py wget https://raw.githubusercontent.com/site24x7/plugins/master/redis/redis.cfg
To check if the plugin is working, execute the command below with appropriate arguments and check for a valid JSON output with applicable metrics and their corresponding values.
python redis.py --host "localhost" --port "6379" --password "redis_password"
Add the applicable configurations in the Redis.cfg file.
[redis] host = "localhost" port = "6379" password = "redis_password"
Follow the steps in this article to learn how to run the Python script on a Windows server. You don't need to do this for Linux.
Move the Redis folder to the Site24x7 server monitoring plugins directory.
For Linux: /opt/site24x7/monagent/plugins/
For Windows: C:\Program Files (x86)\Site24x7\WinAgent\monitoring\plugins\

The agent will automatically execute the plugin within five minutes and display the performance data in Site24x7.

To view the plugin monitor and the associated performance charts:

Log in to Site24x7.
Navigate to Plugins and click the relevant monitor.

Related plugins:

RabbitMQ plugin - Monitor performance metrics of your RabbitMQ databases
MongoDB plugin - Monitor performance metrics of your MongoDB databases
Mule plugin - Analyze performance of your Mule server
Nagios plugin - Execute thousands of Nagios plugins in Site24x7 without the need of running a Nagios server
Out-of-the-box plugins - Monitor your entire app stack with our extensive list of integrations
Create custom plugins - Create custom Linux and Windows plugins and monitor custom attributes