• /
  • Log in
  • Free account

Use the New Relic Platform Installer (NPI) utility

Limited access

Important

For an even better experience than plugins, go to:

  • newrelic.com/integrations: Integrate the on-host and cloud systems you already use with New Relic, so you can filter and analyze data, create dashboards, and set alerts within a single platform.
  • developer.newrelic.com: Use developer tools to collect data from any source, automate workflows, build apps, and use our APIs.

Limited access to legacy plugins

As of December 2, 2020, plugin access has been limited to accounts that have accessed a legacy plugin in the past 30 days. The legacy plugin experience will reach end of life (EoL) as of June 16, 2021. For more information, see our Explorers Hub post.

NPI compatibility requirements

The New Relic Platform Installer (NPI) is a command line utility for plugins in Plugin Central. It allows users to easily download, configure, and manage a plugin by installing it with a single command.

The NPI is available for plugins written with Java or .NET plugin SDKs. If you are a plugin developer, follow these steps to meet the NPI requirements for a consistent installation experience, and publish your plugin in Plugin Central as NPI Compatible.

In order to make your plugin NPI-compatible, make sure it meets each of these requirements:

NPI compatibility

Requirements

Writing your plugin

Packaging

Use the tar.gz or zip compression protocol to package your plugin.

Executable

Name the executable file plugin.jar (for Java) or plugin.exe (for .NET), and store it in the root of your plugin folder.

Code

Do not use any relative references in your code.

Configuration files

Create a ./config directory containing a plugin.template.json file and a newrelic.template.json file. Make sure that plugin configuration is read from the plugin.json file in the ./config directory. For more information, refer to the README in GitHub.

Distribution

Once your plugin is NPI-compatible from a code perspective, place it somewhere that is accessible for consumers to download. For example, add the compressed distributable to a dist folder in your GitHub repository.

When your plugin is ready for distribution, follow standard procedures to publish it in Plugin Central. Be sure to select the Platform Installer (NPI) distribution option.

NPI command line utility

When users select an NPI Compatible plugin from Plugin Central, they also have the option to download the NPI tool. The tool allows users to easily download, configure, and manage a plugin. They can also use a series of commands to manage their plugins or pass the --help flag for more information about available options.

Updates

After you create and publish an NPI-compatible plugin, follow standard procedures to update it as needed. Then, when you publish the updated plugin, the NPI tool automatically will pick up your most current version for users who have installed your NPI-compatible plugin.

Privately-published plugins

In general, the NPI tool will try to pull download (manifest) information from New Relic's Plugins service. You can also provide a file named manifest.json in the config directory of your NPI installation to provide this information. Use this file format:

[
{
"guid": "arbitrary_identifier",
"download_url": "https://plugin.download.url.com",
"publisher": "New Relic Inc.",
"version": "1.0.1",
"installer_compatible": true,
"implementation": "Java"
},
{
"guid": "arbitrary_identifier2",
"download_url": "https://plugin2.download.url.com",
"publisher": "New Relic Inc.",
"version": "2.0.0",
"installer_compatible": true,
"implementation": ".NET"
}
]

After you set this up, you can run all the same commands with your private plugin's GUID.

To install or fetch a plugin, you must pass the --untrusted flag to allow downloading plugins from a local file.

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.