• /
  • Log in
  • Free account

Checklist for developing plugins

Limited access


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.

Plan your plugin

When planning your plugin for Plugin Central:

  1. Sketch the types of metrics you want to collect and how you want to present them on dashboards. Include any necessary mathematical calculations.
  2. Sketch the types of summary metrics you want to collect and how you want to present them on the plugin's summary page. Include any necessary mathematical calculations.
  3. Optional: Define alert conditions for your metrics.
  4. Optional: If you want to receive alert notifications for your plugin, verify the email address to be used and confirm any other notification options as necessary.
  5. Decide whether to develop the plugin with one of the plugin SDKs or to use the Plugin API.

Create your plugin

When creating your plugin for Plugin Central:

  1. Select a unique, meaningful GUID name.
  2. Write the plugin agent.
  3. Test your plugin, including summary metrics, customized dashboards, alert conditions, and your process to disable or uninstall your plugin.
  4. Consider writing Chef and Puppet installation scripts to make plugin installation easier.

Publish your plugin

The following items are required for plugins published through New Relic's Plugin Central. If you do not plan to make your plugin publicly accessible to users, some of these items are not applicable.

Plugin support

Plugin publishers are responsible for providing first-line support if users have problems using their plugin. This includes verifying correct data acquisition and transmission.

If problems continue with getting the expected data into New Relic's user interface after you complete your troubleshooting procedures, then you (not your users) can escalate the problem to New Relic. We will work with you to resolve the problem, and then you can communicate the solution to your users.

For more help

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

Create issueEdit page
Copyright © 2021 New Relic Inc.