Install on-host integrations built by New Relic

This document explains how to install New Relic Infrastructure integrations. These procedures apply only to on-host integrations built by New Relic, and not to New Relic's cloud integrations.

On-host integrations are available only with Infrastructure Pro. For more subscription details, see the Infrastructure product page.

Verify compatibility and requirements

Before you install an integration, see the documentation for your integration and check the compatibility and requirements.

Install with apt (Debian or Ubuntu)

Infrastructure Pro subscriptions only: To install an Infrastructure on-host integration with apt:

  1. If you do not already have New Relic Infrastructure, install the Infrastructure agent for your operating system.
  2. From the command line, run:

    sudo apt-get update
  3. Run the following command, where INTEGRATION_FILE_NAME represents the integration's file name. For more information, see the specific integration's documentation.

    sudo apt-get install INTEGRATION_FILE_NAME
    
  4. Follow additional installation procedures for the specific on-host integration.

Install with yum (Amazon Linux, CentOS, or RHEL)

Infrastructure Pro subscriptions only: To install the Infrastructure integration package with yum:

  1. If you do not already have New Relic Infrastructure, install the Infrastructure agent for your operating system.
  2. From the command line, run:

    sudo yum -q makecache -y --disablerepo='*' --enablerepo='newrelic-infra'
  3. Run the following command, where INTEGRATION_FILE_NAME represents the integration's file name. For more information, see the specific integration's documentation.

    sudo yum install INTEGRATION_FILE_NAME
    
  4. Follow additional installation procedures for the specific on-host integration.

Install with Zypper (SLES)

Infrastructure Pro subscriptions only: To install an Infrastructure integration with Zypper:

  1. If you do not already have New Relic Infrastructure, install the Infrastructure agent for your operating system.
  2. From the command line, run:

    sudo zypper -n ref -r newrelic-infra
  3. Run the following command, where INTEGRATION_FILE_NAME represents the integration's file name. For more information, see the specific integration's documentation.

    sudo zypper -n install INTEGRATION_FILE_NAME
    
  4. Follow additional installation procedures for the specific on-host integration.

Install manually from a tarball archive

We recommend to use your distribution package manager to install the Infrastructure agent and the on-host integrations. If you choose to manually install the agent, you may also want to install the on-host integrations from the provided tarballs.

The manual install process is not automated. If you opt for manual install, you must place the different files in the correct folders, and ensure that the agent has all the permissions to execute the integrations.

To install an integration from a tarball:

  1. Download the packaged integration file from New Relic's tarballs repository.
  2. Unpack the tarball file according to our integration file structure and placement rules, so the agent is able to find the definitions, configurations, and executables of the integration.

  3. Place the binary that contains the definition file inside newrelic-integrations or custom-integrations in the agent directory.

  4. Place the integration's configuration file under the plugin directory.

nri-jmx, nri-cassandra, and nri-kafka integrations

Some integrations (such as nri-jmx, nri-cassandra, and nri-kafka) require the nrjmx tool. If you need the tool, download it from our repository and unpack it.

By default, the nrjmx location is /usr/bin/nrjmx/*. To install it in a different location, set the new path in the NR_JMX_TOOL environment variable.

nrjmx requires Java 8 or higher.

Update the agent

To keep your on-host integration up to date with New Relic Infrastructure, follow standard procedures to update the on-host integration package.

For more help

Recommendations for learning more: