Checklist for developing plugins

Here is a checklist with cross references to detailed information for plugin authors to follow when planning and creating plugins.

If you do not plan to make your plugin publicly accessible to users, some of the Publishing your plugin checklist items are not applicable. For more information about public and unlisted plugins, see Publishing your plugin.

Checklist for developing plugins

Plugin checklist item Done?

Planning your plugin

square-o

Sketch the types of metrics you want to collect and how you want to present them on dashboards. Include any necessary mathematical calculations. For more information, see:

square-o

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. For more information, see:

square-o
Optional: Define alert thresholds for your metrics. square-o
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. square-o
Decide whether to develop the plugin with one of the New Relic Plugins agent's plugin SDKs or to use the API for New Relic Plugins. square-o

Creating your plugin

square-o
Select a unique, meaningful GUID name. square-o

Write the plugin agent. In addition to the developer documentation for New Relic Plugins, see:

square-o
Test your plugin, including:
  • Summary metrics show the metrics you intended to collect.
  • Customized dashboards show data the way you want.
  • If used, your alert thresholds are appropriate.
  • Your process to disable or uninstall your plugin works correctly.
square-o

Consider writing Chef and Puppet installation scripts to make plugin installation easier.

square-o

Publishing your plugin

square-o

Note: These steps are required for plugins published through Plugin Central.

square-o
Write documentation for installing, using, troubleshooting, and uninstalling your plugin. square-o
Make a plan for supporting your plugin and identifying a support URL for users. square-o
Identify the About Us URL for your plugin. square-o
Identify a URL to a branding image for when you publish your plugin. square-o
Review the Developer Terms of Service for New Relic Plugins. (A link to this document appears on your plugin's Publish page.) square-o
Follow standard procedures to publish your plugin. (To complete this process: From the New Relic Plugins menu bar, select your plugin, and then select Publish.) square-o
Recommendation: Maintain "dev" and "production" versions when updating your plugin. square-o

For more help

Recommendations for learning more: