---
title: Redis Enterprise monitoring integration
source: https://docs.newrelic.com/docs/infrastructure/host-integrations/host-integrations-list/redis/redis-enterprise-integration
---

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

## Architecture [#architecture]

The Redis Enterprise integration can be run in two modes:

**Localhost mode**

We recommend you to use this mode as it also provides host-level OS statistics for better correlation. Here's an example configuration file:

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

````

**Cluster mode**

The New Relic agent on a node outside of the Redis Enterprise cluster can scrape multiple clusters for metrics. Here's an example configuration file:

````yaml
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 [#prereqs]

Before moving to the [installation](#install), ensure you fulfill the following prerequisites.

### Create a monitoring account in Redis Enterprise [#monitoring-account]

1.  Create a monitoring account on your Redis Enterprise account.
2.  Log in to your Redis Entprise instance and click on **Access Control**.
    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 [#NR-agent]

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

```shell
sudo service newrelic-infra status -l
```

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

```shell
sudo /bin/systemctl status  -l newrelic-infra.service
```

If you haven't installed it, see [how to install the infrastructure agent](https://docs.newrelic.com/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent/).

## Install and configure [#install]

1.  Download the latest TAR file according to your OS from [Github](https://github.com/redis-field-engineering/newrelic-redis-enterprise/releases).

2.  Unzip the TAR file by running:
    ```shell
    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:
    ```shell
    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:
    ```shell
    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:
    ```shell
    curl -vk -u devops@example.com:password https://CLUSTER.FQDN:9443/v1/cluster
    ```

6.  Restart New Relic by running:
    ```shell
    sudo service  newrelic-infra  restart
    ```

### Configuration parameters [#config-parameters]

| Parameter  | Definition                       | Value                                        |
| ---------- | -------------------------------- | -------------------------------------------- |
| `hostname` | Domain of the Redis cluster      | If running on localhost mode use `localhost` |
| `port`     | Port of the Redis Enterprise API | The default port is `9443`                   |
| `username` | The Redis user you created       | Email address such as `devops@example.com`   |
| `password` | Your password                    |                                              |

## Install dashboards [#install-dashboards]

1.  Go to **[one.newrelic.com/marketplace](https://one.newrelic.com/marketplace)**.
2.  Click the **Dashboards** tab, and in the search field, enter **Redis Enterprise**.
    ![A screenshot of the Redis Enterprise dashboards.](https://docs.newrelic.com/images/infrastructure_screenshot-crop_redis-enterprise-dashboard.webp "Redis Enterprise dashboards")

    > #### 💡 TIP
    >
    > If you know the dashboard you want to add, click one of the following links:
    >
    > -   [Redis Enterprise Cluster metrics dashboard](https://one.newrelic.com/marketplace?state=51bb87db-0e38-0700-be7a-8fb16d608735)
    > -   [Redis Enterprise Database CRDT dashboard](https://one.newrelic.com/marketplace?state=3dd588b8-ef40-85b6-17f5-49ca63ad25e3)
    > -   [Redis Enterprise Databasem metrics dashboard](https://one.newrelic.com/marketplace?state=8d596a92-8338-1657-4b08-3c520845fec6)
3.  Click one of the dasboards, and select an account from the dropdown. Then, click **View dashboard** to add it to your account.