New Relic Infrastructure Integration for Redis

In order to know how the Redis integration works and how to run it with the Infrastructure agent please check the documentation.

Integration Development usage

Assuming that you have the source code and Go tool installed (go version 1.9) then you can build and run the Redis Integration locally.

Go to the directory of the Redis integration and build it

$ make

The command above will execute the tests for the Redis integration and build an executable file called nri-redis under bin directory. Run nri-redis:

$ ./bin/nri-redis

If you want to know more about usage of ./bin/nri-redis check

$ ./bin/nri-redis -help

For managing external dependencies govendor tool is used. It is required to lock all external dependencies to specific version (if possible) into vendor directory.

Agent configuration

First of all it's required to install the agent. Please have a look at the agent installation documentation
You can also have a look at the configuration documentation
Before configuring the redis integration is also recommended to understand the integration configuration file

Redis Integration configuration

You can find a configuration sample file called redis-config.yml.sample in this project. Use this file as a guide and create your own config file redis-config.yml with your own configuration parameters:

hostname: Hostname or IP where Redis server is running.
port: Port on which Redis server is listening.
keys: List of the keys for retrieving their lengths.
remote_monitoring: It allows to monitor multiple instances. New users should have this value enabled. remote_monitoring: true

Installation

Download the Redis integration.
Copy the redis-definition.yml and /bin into /var/db/newrelic-infra/newrelic-integrations
Add execute permissions for the binary file nri-redis (if required)
Copy redis-config.yml into /etc/newrelic-infra/integrations.d

Contributing Code

We welcome code contributions (in the form of pull requests) from our user community. Before submitting a pull request please review these guidelines.

Following these helps us efficiently review and incorporate your contribution and avoid breaking your code with future changes to the agent.

Custom Integrations

To extend your monitoring solution with custom metrics, we offer the Integrations Golang SDK which can be found on github.

Refer to our docs site to get help on how to build your custom integrations.

Support

You can find more detailed documentation on our website, and specifically in the Infrastructure category.

If you can't find what you're looking for there, reach out to us on our support site or our community forum and we'll be happy to help you.

Find a bug? Contact us via support.newrelic.com, or email support@newrelic.com.

New Relic, Inc.

carlossscastro/nri-redis