On-host integrations: Installation and configuration
Some of our on-host integrations are built in a specific way and tightly bundled with the infrastructure agent, meaning they have similar install and configuration processes.
This documentation contains the basic installation procedures for these types of integrations. For technical details about how these integrations work, see On-host integration data reporting.
Installation methods
Your services may be running on a single physical host, on a VM, or in a container orchestrated by Kubernetes or Amazon ECS. Choose your desired installation method.
After you do the basic install of an integration, you must return to the documentation for a specific integration to read the configuration instructions.
Orchestrated environments
Our options for containerized, orchestrated environments:
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
Return to the docs for your integration and complete the configuration instructions.
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
Return to the docs for your integration and complete the configuration instructions.
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
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.
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.
Place the binary that contains the definition file inside newrelic-integrations or custom-integrations in the agent directory.
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.
Importante
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.
These integrations are built with the same file structure and configuration structure. For details about their structure and how they report data, see Data reporting.