Discover the top benefits of observability
See the research


In scouring through the feedback we receive through forums, reviews, and social media, the New Relic Platform team has learned that many people have questions about the installation of New Relic plugins: How do I get it on my machine? How do I configure it? How do I keep it running?

The New Relic Platform Installer (NPI)--a simple, light-weight command-line tool that will help you easily download, configure, and manage New Relic Platform Plugins-- is designed to address exactly these questions.

Bear in mind, this is an early release, so the tool now supports only a small subset of the plugins we intend to support down the road. Look for the following list to expand rapidly:

  • New Relic MySQL Plugin - Java
  • New Relic Memcached Plugin - Java
  • New Relic Wikipedia (Example) Plugin - Java
  • 3Legs Varnish Plugin - Java
  • 3Legs Cassandra Plugin - Java
  • 3Legs JMX Remote Plugin - Java
  • New Relic WIkipedia (Example) Plugin - .NET
  • New Relic MS SQL Plugin - .NET

Simply follow the instructions below to get a plugin up and running on your machine with the NPI tool.

Step 1: Downloading the NPI Tool

Simply copy and paste one of the following commands into your terminal (replacing 'YOUR_LICENSE_KEY' with your New Relic License Key) to download the NPI tool to the directory “$HOME/newrelic-npi”. This will NOT affect your path, or download any global external dependencies:

Note: You can optionally prepend 'PREFIX=[directory]' or 'DEFAULTUSER=[username]' to configure the locations the NPI tool will be installed to and the default user plugins will be run as, respectively.

Linux – Debian/Ubuntu

  • x86:

LICENSE_KEY=YOUR_KEY_HERE bash -c "$(curl -sSL"

  • x64

LICENSE_KEY=YOUR_KEY_HERE bash -c "$(curl -sSL"

Linux – Red Hat/CentOS

  • x86:

LICENSE_KEY=YOUR_KEY_HERE bash -c "$(curl -sSL"

  • x64

LICENSE_KEY=YOUR_KEY_HERE bash -c "$(curl -sSL"

Linux – Generic

  • x86:

LICENSE_KEY=YOUR_KEY_HERE bash -c "$(curl -sSL"

  • x64

LICENSE_KEY=YOUR_KEY_HERE bash -c "$(curl -sSL"

Windows and Mac OSX require a slightly more manual setup process:

  1. Navigate to: download the latest archive for your system.
  2. Extract the archive to a location of your choosing.
  3. Run the following commands to configure the New Relic Platform installer to use your license key:

npi config set license_key <YOUR_LICENSE_KEY>

Step 2: Downloading Plugins

We currently support only a subset of our plugins, all of which require Java to be installed on the box they are running on (the NPI tool does not install any runtime dependencies).

The NPI tool has two different workflows: The first is a simple interactive flow that will walk you through the installation. The second is a series of individual commands that give you granular control over each step of the installation and can be easily integrated into other scripts or workflows:

Installing with the interactive walkthrough:

The 'install' command will guide you through the installation process:

// Gets a list of available plugins to install with this tool ./npi available


// Walks you through the installation of a plugin  

./npi install <plugin_id>

Installing with individual commands:

You can always run './npi --help' from the directory where the tool was installed ("$HOME/newrelic-npi") to see a full list of commands currently supported. The following is an example session:

// Display a list of commands and flags that can be used to tailor your workflow ./npi --help  

// Show plugins currently on your machine ./npi list  

// Set your license key if you did not already in the installation process ./npi config set license_key <LICENSE_KEY>  

// Gets a list of available plugins to install with this tool ./npi available  

// Download a plugin to your machine ./npi fetch <plugin_id>  

// Copy license key and open the plugin configuration file in a text editor ./npi prepare <plugin_id>  

// Start a plugin in the foreground to ensure everything is working ./npi start <plugin_id> --foreground  

// * ADMIN REQUIRED * Set the plugin to run as a background process and start it ./npi add-service <plugin_id> --start

Step 3: Provide feedback

We are using the New Relic Community Forum to gather feedback on the NPI tool. In fact, this blog post was adapted from a Forum post called Getting Started with the Platform Installer. All you'll need to do is create a post with your feedback under the Platform Installer category. Anything you'd like us to know, we'd like to hear (e.g. the tool is easy or hard to use, the experience is confusing, the command names do not make sense to you). It will all help us plan the next steps for this project! We look forward to hearing your feedback and thank you as always for helping us improve the New Relic Platform!