On-host integrations: Installation and configuration

To install:

1. If you don't already have it, install the infrastructure agent.
2. Download the latest .MSI installer image for the desired integration from our repository.
3. In an admin account, run the install script using an absolute path.

   msiexec.exe /qn /i PATH\TO\integration-name.msi

   Copy
4. Return to the docs for your integration and complete the configuration instructions.

To install an integration with apt:

1. If you don't already have it, install the infrastructure agent for your operating system.

2. From the command line, run:

   sudo apt-get update

   Copy

3. Run the following command, where INTEGRATION_FILE_NAME represents the integration's file name. For more information, see the integration's documentation.

   sudo apt-get install INTEGRATION_FILE_NAME

   Copy

4. Return to the docs for your integration and complete the configuration instructions.

To install an integration package with yum:

1. If you don't already have it, install the infrastructure agent for your operating system.

2. From the command line, run:

   sudo yum -q makecache -y --disablerepo='*' --enablerepo='newrelic-infra'

   Copy

3. Run the following command, where INTEGRATION_FILE_NAME represents the integration's file name. For more information, see the specific on-host integration.

   sudo yum install INTEGRATION_FILE_NAME

   Copy

4. Return to the docs for your integration and complete the configuration instructions.

To install an on-host integration with zypper:

1. If you don't already have it, install the infrastructure agent for your operating system.

2. From the command line, run:

   sudo zypper -n ref -r newrelic-infra

   Copy

3. Run the following command, where INTEGRATION_FILE_NAME represents the integration's file name. For more information, see the integration's documentation.

   sudo zypper -n install INTEGRATION_FILE_NAME

   Copy

4. Return to the docs for your integration and complete the configuration instructions.

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 the tarball 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 config file under the plugin directory.

5. Return to the docs for your integration and complete the configuration instructions. If your integration requires use of the JMX tool, details about that are below.

   For integrations that require our nrjmx tool, follow these additional instructions:

   Use of the New Relic JMX tool

   Some integrations (such as JMX, Cassandra, and Kafka) require the nrjmx tool. If your integration needs this, download it from our repository and unpack it.

   Important

   nrjmx requires Java 8 or higher.

   For JMX integration version 2.3.3 or higher and Cassandra integration version 2.3.0 or higher, the nrjmx tool is included as a dependency. For this reason, when using a package manager, the nrjmx tool doesn't have to be installed manually.

   If you have nrjmx already installed and install nri-jmx, our JMX tool keeps the already-installed version. If you don't have nrjmx already installed, it gets the latest nrjmx release.

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