Redis Enterprise monitoring integration

This integration is for self-hosted Redis Enterprise clusters and not for Redis hosted cloud or various marketplace Redis Enterprise offerings.

Architecture

The Redis Enterprise integration can be run in two modes:

instances:
- name: redis-metrics
    command: metrics
    arguments:
    hostname: localhost
    port: 9443
    username: devops@example.com
    password: myPassword

instances:
- name: redis-metrics1
    command: metrics
    arguments:
    hostname: cluster1.fqdn
    port: 9443
    username: devops@example.com
    password: myPassword
- name: redis-metrics2
    command: metrics
    arguments:
    hostname: cluster.fqdn
    port: 9443
    username: devops@example.com
    password: myPassword

Prerequisites

Before moving to the installation, ensure you fulfill the following prerequisites.

Create a monitoring account in Redis Enterprise

1. Create a monitoring account on your Redis Enterprise account.
2. Log in to your Redis Entprise instance and click on Access Control.

   Tip

   We recommend using an internal account, but you can use LDAP if you have LDAP enabled.
3. Add a new user account with Cluster View Permissions.

Ensure you installed the New Relic infrastructre agent

To see whether you installed the New Relic infrastructure agent, run the following command:

$
sudo service newrelic-infra status -l

Depending on your Linux distro, you may need to run the following command:

$
sudo /bin/systemctl status  -l newrelic-infra.service

If you haven't installed it, see how to install the infrastructure agent.

Install and configure

1. Download the latest TAR file according to your OS from Github.

2. Unzip the TAR file by running:

   bash

   Copy

   $
   sudo su -
   $
   mkdir -p /tmp/nr_install
   $
   cd /tmp/nr_install
   $
   wget $RELEASE_DOWNLOAD
   $
   tar zxvf *.tar.gz

3. Create a folder and copy the files from the TAR file into this new folder by running:

   bash

   Copy

   $
   mkdir -p /var/db/newrelic-infra/custom-integrations/bin
   $
   cp newrelic-redis-enterprise /var/db/newrelic-infra/custom-integrations/bin
   $
   cp conf/redis-redisenterprise-definition.yml /var/db/newrelic-infra/custom-integrations/
   $
   cp conf/redis-redisenterprise-multi-config.yml.example conf/redis-redisenterprise-multi-config.yml

4. Configure the integration by running:

   bash

   Copy

   $
   vi conf/redis-redisenterprise-multi-config.yml
   $
   mv conf/redis-redisenterprise-multi-config.yml /etc/newrelic-infra/integrations.d/redis-redisenterprise-config.yaml

5. Test your username and password by running:

   bash

   Copy

   $
   curl -vk -u devops@example.com:password https://CLUSTER.FQDN:9443/v1/cluster

6. Restart New Relic by running:

   bash

   Copy

   $
   sudo service  newrelic-infra  restart

Configuration parameters

Install dashboards

1. Go to one.newrelic.com/marketplace.

2. Click the Dashboards tab, and in the search field, enter Redis Enterprise.

   Tip

   If you know the dashboard you want to add, click one of the following links:

   • Redis Enterprise Cluster metrics dashboard
   • Redis Enterprise Database CRDT dashboard
   • Redis Enterprise Databasem metrics dashboard

3. Click one of the dasboards, and select an account from the dropdown. Then, click View dashboard to add it to your account.