https://github.com/redis-field-engineering/new-relic-redis-enterprise

Redis Enterprise Software Plugin for NewRelic
https://github.com/redis-field-engineering/new-relic-redis-enterprise

Last synced: 2 months ago
JSON representation

Redis Enterprise Software Plugin for NewRelic

• Host: GitHub
• URL: https://github.com/redis-field-engineering/new-relic-redis-enterprise
• Owner: redis-field-engineering
• Created: 2021-10-25T13:22:09.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-19T17:41:23.000Z (about 3 years ago)
• Last Synced: 2025-01-25T12:09:04.526Z (4 months ago)
• Language: Go
• Homepage:
• Size: 877 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# New Relic Redis Enterprise Plugin 

![img](https://raw.githubusercontent.com/DataDog/integrations-extras/master/redisenterprise/images/redis-enterprise.jpg)

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

## Plugin Architecture

Redis Enterprise plugin can be run in two modes

#### Localhost Mode

This is the preferred method of installation as it will also provide host level OS statistics for better correlation.

![img](docs/NewRelicLocalhostMode.png)

Sample config

```

instances:

  - name: redis-metrics

    command: metrics

    arguments:

      hostname: localhost

      port: 9443

      username: [email protected]

      password: myPass

```

#### Cluster Mode

The New Relic agent on a node outside of the Redis Enterprise cluster can scrape multiple clusters for metrics

![img](docs/NewRelicClusterMode.png)

Sample config

```

instances:

  - name: redis-metrics1

    command: metrics

    arguments:

      hostname: cluster1.fqdn

      port: 9443

      username: [email protected]

      password: myPass

  - name: redis-metrics2

    command: metrics

    arguments:

      hostname: cluster.fqdn

      port: 9443

      username: [email protected]

      password: myPass

```

## Installing the plugin

#### Create a monitoring account on your Redis Enterprise

Login to your Redis Entprise Instance and click on Access Control

If you have LDAP enabled you can use LDAP, but an internal account is highly recommended.

![create account](docs/account_1.png)

#### Add a new user account with Cluster View Permissions

![create account](docs/account_2.png)

#### Ensure New Relic agent is installed and running

[Agent installation instructions](https://docs.newrelic.com/docs/infrastructure/install-infrastructure-agent/get-started/install-infrastructure-agent/)

Check the service status

```

sudo service newrelic-infra status -l

# OR depending on your Linux distro

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

```

#### Pull the rlease from Github Releases

https://github.com/redis-field-engineering/newrelic-redis-enterprise/releases

#### Unarchive

```

sudo su -

mkdir -p /tmp/nr_install

cd /tmp/nr_install

wget $RELEASE_DOWNLOAD

tar zxvf *.tar.gz 

```

#### Copy files into place

```

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

```

#### Configure the integration

```

vi conf/redis-redisenterprise-multi-config.yml

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

```

Configuration parameters

| Parameter | Usage | Notes |

|--|--|--|

|hostname| FQDN of the Redis Cluster | If running in localhost mode use ```localhost``` |

|port| Port of the Redis Enterprise API | default port is ```9443``` |

|username| User created above | is an email address like ```[email protected]``` |

|password| Password created above |  |

You can test your username/password combination with curl

```

curl -vk -u [email protected]:password  https://CLUSTER.FQDN:9443/v1/cluster

```

#### Restart New relic

```

sudo service  newrelic-infra  restart

```

#### Install Dashboards

Go to the [dashboards section](https://one.newrelic.com/dashboards) of your New Relic installation

Locate your Account ID which you may be found in the URL:

![account id](docs/account_id.png)

Click on Import Dashboards and import the following dashboards

For each dashboard you will need to add your account ID  

```

cat cluster.json |sed -e s/REPLACE_ME_WITH_YOUR_ACCOUNT_ID//g

```

- [Redis Enterprise Cluster Metrics](dashboards/cluster.json)

- [Redis Enterprise Database Metrics](dashboards/db.json)

- [Redis Enterprise Active/Active Metrics](dashboards/active_active.json)

### Dashboards

#### Cluster Metrics

![cluster metrics](docs/newrelic_cluster_dashboard.png)

#### Database Metrics

![database metrics](docs/newrelic_database_dashboard.png)

#### Active/Active Metrics

![crdt metrics](docs/newrelic_crdt_dashboard.png)

### Monitoring Guide

See our [Monitoring Guide ](docs/RedisEnterpriseMonitoringGuide.md) for suggestions on KPIs to monitor.

### Support

Contact the [Redis Field Engineering Team][1].

[1]: mailto:[email protected]?subject=NewRelic%20Integration%20Support