Install an NPI-compatible plugin

The New Relic platform installer (NPI) is a command line utility that you can use to install, configure, and manage NPI-compatible plugins. After you install the NPI tool, you can use it to install any plugins that are compatible with it. Developers can also create NPI-compatible plugins.

Plugins is not supported with accounts that host data in the EU region data center.

Install the NPI tool

Plugins that are compatible with the New Relic platform installer include an NPI compatible label. If you have not already installed the NPI tool:

  1. Go to rpm.newrelic.com/plugins, then select any plugin listed as NPI compatible.
  2. From the selected plugin's Installation page in the UI, click the link that says * Requires New Relic Platform Installer (NPI) - Get it here.
  3. From the dropdown that opens, select your operating system.
  4. Copy the command that appears, then run it in your terminal to install the NPI tool.

Install the plugin

On Unix-based systems, you may need to set a default user. To set a default user, run ./npi set user <USER NAME> in your terminal.

Once you have installed the NPI tool, you can install any NPI compatible plugin.

  1. Go to rpm.newrelic.com/plugins, then select any plugin listed as NPI compatible.
  2. From the selected plugin's Installation page in the UI, follow the procedures to copy the specific plugin's installation command.
  3. In your terminal, change to the directory ~/newrelic-npi, then paste and run the install command.

Manage plugins with the NPI tool

To view information that helps you manage NPI-compatible plugins:

  • For usage and commands, help and version flags, and setup examples, run the command --help from the directory ~/newrelic-npi.
  • For a list of plugins that are NPI-compatible, run the command ./npi available.
screen npi command line example.png
New Relic platform installer (NPI): Run the command --help to get information to help you manage plugins.

Include proxy settings

If you need to include proxy settings in your configuration (for both the NPI tool and the plugin's newrelic.json file), use these commands:

./npi config set proxy_host <HOST>
./npi config set proxy_port <PORT>
./npi config set proxy_username <USER NAME>
./npi config set proxy_password <PASSWORD>

View log files

Run a where command to view the full path for a plugin so you can view log files or locate a plugin on your filesystem so you can manually configure it.

Troubleshoot NPI-compatible plugins

In addition to the troubleshooting procedures provided by the plugin publisher, follow these troubleshooting guidelines when installing NPI-compatible plugins.

Duplicate plugins

Problem: If you install a plugin and then install the same plugin again through the NPI tool, you will have two versions of the plugin installed.

SolutionDelete the older version of the plugin, and then install the NPI-compatible version using the NPI tool. Procedures to delete plugins typically appear in the README file or in other documentation that the plugin publisher provides.

Error message ./npi: line 1: bin/node: No such file or directory

Problem: The architecture script that you selected when you installed the NPI tool does not match your operating system (for example, x86 instead of x64).

Solution: Install the NPI tool using the correct script for your operating system.

Problem: You cannot run NPI commands.

Solution: Navigate to the directory ~/newrelic-npi and run the command again.

Cause: You can only access the NPI tool from the location where it was installed.

Insufficient privileges to run background processes

Problem: If you try to set a plugin to run as a background process, you might see a message that you have insufficient privileges.

Solution:

  • Linux: Run the command with sudo in front of it.
  • Windows: Run the command as an administrator.

Cause: The plugin creates an /etc/init.d script on Linux and a Windows service on Windows, both of which require escalated privileges to run.

For more help

Recommendations for learning more: