Install Infrastructure on-host integrations

Our on-host integrations, which monitor core, non-cloud services, such as Apache or MySQL, can be installed directly on Linux and Windows, and in containerized Kubernetes and Amazon ECS environments.

Here we present general instructions for all install scenarios; refer to each integration's documentation for specific guidance and configuration instructions.

Install on-host integrations on Linux

Most on-host integrations can be installed using the official package manager of your Linux distribution.

Install with apt (Debian.pngDebian, ubuntu iconUbuntu)

To install an Infrastructure on-host integration with apt:

If you do not already have New Relic Infrastructure, install the Infrastructure agent for your operating system.

From the command line, run:

sudo apt-get update

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

Follow additional install procedures for the specific on-host integration.

Install with yum (amazon linux.pngAmazon Linux, centos iconCentOS, redhat iconRHEL)

To install the Infrastructure integration package with yum:

If you do not already have New Relic Infrastructure, install the Infrastructure agent for your operating system.

From the command line, run:

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

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

sudo yum install INTEGRATION_FILE_NAME

Follow additional install procedures for the specific on-host integration.

Install with Zypper (suse iconSLES)

To install an Infrastructure integration with Zypper:

If you do not already have New Relic Infrastructure, install the Infrastructure agent for your operating system.

From the command line, run:

sudo zypper -n ref -r newrelic-infra

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

Follow additional install procedures for the specific on-host integration.

Install from tarball ( Linux icon Other distros)

We recommend using 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 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.

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.

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.

Install on-host integrations on Windows

Integrations for services running on Windows Server can be installed using our .MSI installer or the official zip files. MSI install is recommended.

  1. Download the latest .MSI installer image from our repository.

  2. In an admin account, run the install script using an absolute path.

    msiexec.exe /qn /i PATH\TO\integration-name.msi
    
  3. Change C:\Program Files\New Relic\newrelic-infra\integrations.d\integration-name-config.yml.sample to integration-name-config.yml, and edit according to your needs.
  4. Restart the infrastructure agent.

Install on-host integrations on Kubernetes

To install an on-host integration on Kubernetes, see Monitor services running on Kubernetes. For example, see how you can monitor Redis running on Kubernetes.

Our on-host integrations and Kubernetes integration can run together; see Intro to Kubernetes integration to learn more.

Install on-host integrations on Amazon ECS

To install an on-host integration on Amazon ECS, see Monitor services running on ECS. We currently support the EC2 launch type.

Our on-host integrations and Kubernetes integration can run together; see Intro to ECS integration to learn more.

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: