Install a New Relic plugin

Each plugin in New Relic's Plugin Central includes its own procedures for how to install, use, troubleshoot, and uninstall it. In order to use a plugin, first verify that your environment meets the plugin's documented requirements. Then follow the plugin's procedures to install the plugin agent on one or more hosts in your monitored environment, or to configure a SaaS plugin as directed by your SaaS provider.

As a standard security measure for data collection, New Relic requires that your application server supports SHA-2 (256-bit). SHA-1 is not supported.

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

Access rights

When using an agent from Plugin Central, New Relic recommends that you deploy the agent giving the fewest possible permissions in order for the plugin agent to function successfully. Unless the plugin publisher gives specific instructions, you should run the plugin agent as a non-privileged user; do not use "su" or "sudo" privileges. This applies to both installing and using the agent.

If the plugin agent needs credentials for the component (instance) that it is monitoring, New Relic recommends that you create a custom set of credentials just for the monitoring agent to use. These should be separate from any other production credentials. The custom credentials should grant the fewest possible permissions while still allowing the agent to gather the data it needs.

For example, for most plugin agents, you should only need to grant read-only access to your components or instances so the plugin agent cannot modify your system in any way. Also, with many agents, you should only need to grant access to read performance and administration data, not necessarily end customer or other sensitive data. For more information, see Plugin security.

License key

As part of any plugin installation process, you need your New Relic license key: From the New Relic menu bar, select (account) > Account settings. When you are logged into New Relic Plugins, the plugin's installation page on Plugin Central also shows your license key so you can easily copy it to your clipboard.

Note: If plugins have been published by SaaS providers, they must have access to the New Relic license key for each individual account. They can capture this information when provisioning new customers via the New Relic Partner API, or they can provide a mechanism for customers to share their existing New Relic license key.

screen license key.png
(account name) > Account settings: To install any plugin, you need your New Relic license key.

Typical plugin installation procedures

Installation requirements depend on the type of plugin. For example, a Java plugin agent has different requirements than a Ruby plugin agent. Before you use a plugin, review the documentation that the plugin's publisher provides about the agent's installation requirements.

To install any plugin from New Relic's Plugin Central directory:

  1. From the New Relic menu bar, select Plugins.
  2. From the Plugin Central directory, select the plugin's title or its Get started button.
  3. From the plugin's details page, select the Download or Continue button.
  4. Follow the plugin's specific instructions to get your plugin installed and running.

After you start running a plugin, it collects and sends data to New Relic (usually within five minutes). The plugin name will automatically appear on your New Relic Plugins menu bar, where you can select and view its summary metrics and dashboards.

screen plugin support.png
Plugins > Plugin Central > (selected plugin): Plugins include instructions for installing, using, troubleshooting, and uninstalling them, as well as a link for support.

Install with Chef or Puppet

In addition to standard installation procedures, you can install plugins with Chef and Puppet configuration management tools. These tools automate plugin installation, which make it easier to manage plugins with the rest of your server software.

Install an NPI-compatible plugin

The New Relic Platform Installer (NPI) is a command line utility that allows users to easily download, configure, and manage a plugin by installing it with a single command. If you select an NPI Compatible plugin from Plugin Central, follow the procedures to install an NPI-compatible plugin.

Videos

Here are videos with examples of how to install a Java plugin and a Ruby plugin. Specific installation procedures may vary depending on the plugin you select from Plugin Central.


[video link] This video shows how to install a Java plugin from Plugin Central (less than 2 minutes). View more videos and tutorials at learn.newrelic.com.


[video link] This video shows how to install a Ruby plugin from Plugin Central (approximately 90 seconds). View more videos and tutorials at learn.newrelic.com.

For more help

Recommendations for learning more: