Tutorial

Monitoring Redis Droplets Using Redis Exporter Service

Monitoring Redis Droplets Using Redis Exporter Service

Introduction

Effective monitoring of Redis databases is essential for maintaining optimal performance, identifying potential bottlenecks, and ensuring overall system reliability. Redis Exporter Service is a robust utility designed to monitor Redis databases using Prometheus.

This tutorial will guide you through the complete setup and configuration of Redis Exporter Service, ensuring you establish a monitoring solution seamlessly. By following this tutorial, you’ll achieve a fully operational monitoring setup to effectively monitor the performance metrics of your Redis database.

Note: The approximate setup time for this tutorial is around 25 minutes

Prerequisites

Before you begin, make sure you have the following prerequisites in place:

  • You’ll need to have Redis database servers set up and running on a Ubuntu Droplet. You can refer to our tutorials on How to Install and Secure Redis on Ubuntu. The servers you want to monitor should be accessible from the machine where you plan to install Redis Exporter Service.
  • You’ll need SSH access to Redis servers to install and configure Redis Exporter Service.
  • Prometheus MySQL Exporter integrates with Prometheus for metrics scraping and Grafana for visualization. Here we are using Prometheus and Grafana images from DigitalOcean Marketplace to monitor the database Droplets.

Note: In this tutorial, we will walk through two different methods to set up Redis Exporter Service for monitoring Redis databases. You can choose between manual configuration and script-based automation, each tailored to different preferences and operational requirements. Follow the instructions for each method to deploy Redis Exporter Service on your infrastructure effectively. This flexibility allows you to select the best deployment strategy and operational workflow approach.

Method 1: Manual Configuration

Let’s proceed with the manual configuration method in this section.

Create Prometheus System User and Group

Create a system user and group named “prometheus” to manage the exporter service.

sudo groupadd --system prometheus
sudo useradd -s /sbin/nologin --system -g prometheus prometheus

Download and Install Redis Exporter

Download the latest release of Redis Exporter from GitHub, extract the downloaded files, and move the binary to the /usr/local/bin/ directory.

curl -s https://api.github.com/repos/oliver006/redis_exporter/releases/latest | grep browser_download_url | grep linux-amd64 | cut -d '"' -f 4 | wget -qi -
tar xvf redis_exporter-*.linux-amd64.tar.gz
sudo mv redis_exporter-*.linux-amd64/redis_exporter /usr/local/bin/

Verify Redis Exporter Installation

redis_exporter --version

Here is the sample Output:

Redis_3

Configure systemd Service for Redis Exporter

Create a systemd service unit file to manage the Redis Exporter service.

sudo vim /etc/systemd/system/redis_exporter.service

Add the following content to the file:

redis_exporter.service
[Unit]
Description=Prometheus Redis Exporter
Documentation=https://github.com/oliver006/redis_exporter
Wants=network-online.target
After=network-online.target

[Service]
Type=simple
User=prometheus
Group=prometheus
ExecReload=/bin/kill -HUP $MAINPID
ExecStart=/usr/local/bin/redis_exporter \
  --log-format=txt \
  --namespace=redis \
  --web.listen-address=:9121 \
  --web.telemetry-path=/metrics

SyslogIdentifier=redis_exporter
Restart=always

[Install]
WantedBy=multi-user.target

Reload systemd and Start Redis Exporter Service

sudo systemctl daemon-reload
sudo systemctl enable redis_exporter
sudo systemctl start redis_exporter

Configuring the Prometheus Droplet (Manual Method)

Let’s configure the Prometheous droplet for the manual configuration.

Take a backup of the prometheus.yml file

cp /etc/prometheus/prometheus.yml /etc/prometheus/prometheus.yml-$(date +'%d%b%Y-%H:%M')

Add the Redis Exporter endpoints to be scraped

Log in to your Prometheus server and add the Redis Exporter endpoints to be scraped.

Replace the IP addresses and ports with your Redis Exporter endpoints (9121 is the default port for Redis Exporter Service).

vi /etc/prometheus/prometheus.yml
prometheus.yml
scrape_configs:
  - job_name: server1_db
    static_configs:
      - targets: ['10.10.1.10:9121']
        labels:
          alias: db1

  - job_name: server2_db
    static_configs:
      - targets: ['10.10.1.11:9121']
        labels:

This is the end of the manual configuration. Now, let’s proceed with the script-based configuration.

Method 2: Configuring Using Scripts

You can also achieve this by running two scripts - one for the target droplets and the other for the Prometheus droplet.

Let’s start by configuring the Target Droplets.

SSH into the Target Droplet.

Download the Target Configuration script by using the following command:

wget https://solutions-files.ams3.digitaloceanspaces.com/Redis-Monitoring/DO_Redis_Target_Config.sh

Once the script is downloaded, ensure it has executable permissions by running:

chmod +x DO_Redis_Target_Config.sh

Execute the script by running:

./DO_Redis_Target_Config.sh

The configuration is complete.

Redis_4

Note: If the redis_exporter.service file already exists, the script will not run.

Redis_1

Configuring the Prometheus Droplet (Script Method)

SSH into the Prometheus Droplet and download the script by using the following command:

wget https://solutions-files.ams3.digitaloceanspaces.com/Redis-Monitoring/DO_Redis_Prometheus_Config.sh

Once the script is downloaded, ensure it has executable permissions by running:

chmod +x DO_Redis_Prometheus_Config.sh

Execute the script by running:

./DO_Redis_Prometheus_Config.sh

Enter the number of Droplets to add to monitoring.

Enter the hostnames and IP addresses.

Redis_2

The configuration is complete.

Once added, check whether the targets are updated by accessing the URL prometheushostname:9090/targets.

Note: If you enter an IP address already added to the monitoring, you will be asked to enter the details again. Also, if you do not have any more servers to add, you can enter 0 to exit the script

Redis_5

Configuring Grafana

Log into the Grafana dashboard by visiting Grafana-IP:3000 on a browser.

Go to Configuration > Data Sources.

grafana1

Click on Add data source.

grafana2

Search and Select Prometheus.

grafana3

Enter Name as Prometheus, and URL (Prometheushostname:9090) and click “Save & Test”. If you see “Data source is working”, you have successfully added the data source. Once done, go to Create > Import.

grafana4

You can manually configure the dashboard or import the dashboard by uploading the JSON file. A JSON template for Redis monitoring can be found in the below link:

https://solutions-files.ams3.digitaloceanspaces.com/Redis-Monitoring/DO_Grafana-Redis_Monitoring.json

Fill in the fields and Import.

grafana5

The Grafana dashboard is ready. Select the host and check if the metrics are visible. Please feel free to modify and edit the dashboard as needed.

grafana7

Conclusion

In this tutorial, you learned to automate the deployment of the Redis Exporter on your servers. The script begins by checking if the redis_exporter.service unit file already exists and exits if it does, avoiding redundant setups. It then creates a Prometheus system user and group for secure service isolation. The script downloads and installs the Redis Exporter binaries, placing them in /usr/local/bin/ for standardization.

Next, it generates and configures a system unit file (redis_exporter.service), specifying essential settings and restarting policies. The script reloads systemd to apply the new configuration, enables the service to start at boot, and starts it immediately.

By automating these steps, the script simplifies the deployment process, minimizes human error, and ensures a consistent setup across servers, providing an efficient solution for integrating Redis metrics into your Prometheus monitoring infrastructure.

As a next step, you can also refer to our tutorial on Monitoring MySQL and MariaDB Droplets Using Prometheus MySQL Exporter.

Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.

Learn more about our products

About the authors
Default avatar

Senior Solutions Architect


Default avatar

Sr Technical Writer

Sr. Technical Writer@ DigitalOcean | Medium Top Writers(AI & ChatGPT) | 2M+ monthly views & 34K Subscribers | Ex Cloud Consultant @ AMEX | Ex SRE(DevOps) @ NUTANIX


Still looking for an answer?

Ask a questionSearch for more help

Was this helpful?
 
Leave a comment


This textbox defaults to using Markdown to format your answer.

You can type !ref in this text area to quickly search our full set of tutorials, documentation & marketplace offerings and insert the link!

Try DigitalOcean for free

Click below to sign up and get $200 of credit to try our products over 60 days!

Sign up

Join the Tech Talk
Success! Thank you! Please check your email for further details.

Please complete your information!

Become a contributor for community

Get paid to write technical tutorials and select a tech-focused charity to receive a matching donation.

DigitalOcean Documentation

Full documentation for every DigitalOcean product.

Resources for startups and SMBs

The Wave has everything you need to know about building a business, from raising funding to marketing your product.

Get our newsletter

Stay up to date by signing up for DigitalOcean’s Infrastructure as a Newsletter.

New accounts only. By submitting your email you agree to our Privacy Policy

The developer cloud

Scale up as you grow — whether you're running one virtual machine or ten thousand.

Get started for free

Sign up and get $200 in credit for your first 60 days with DigitalOcean.*

*This promotional offer applies to new accounts only.