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.
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.
To get started with writing a plugin agent that generates example metric data, refer to the README files in GitHub for the Plugin agent SDK, including:
After developing a plugin with a plugin SDK, you can use Chef and Puppet installation scripts. This makes plugin installation easier from Plugin Central in New Relic, especially when your plugin has required runtime dependencies, such as Java or Ruby. Managing plugins with user permissions and startup scripts also is easier.
Several Chef and Puppet installation scripts have been written for supported plugins. You can use these Chef recipes and Puppet manifests as templates for other plugins. For more information about installation scripts for plugins in Plugin Central, see:
This is an example of how to configure your plugin to create multiple agents with different configurations. In this example:
- The plugin is called Wikipedia.
- Wikipedia has 3 hosts: English, Spanish, and German.
- Each host uses a different port in New Relic Plugins.
The Plugin API is useful when you need to:
- Use a programming language not supported by the plugin SDKs.
- Write plugins to in-house standards or as part of a larger running application.
- Report metrics for a large number of individual accounts.
The Plugin API can be used by plugin developers to POST metrics for multiple components (instances) directly to the New Relic collectors using JSON. Each POST typically is consumed by the collector in under 3ms, so this is a very fast way to send large amounts of metric data.
After you publish your plugin, New Relic will update usage data about accounts and components or instances every 24 hours, including:
- Number of accounts using your plugin
- Components or instances that are reporting data
- Review comments
Plugins that are publicly published in Plugin Central will have more details in the Usage dashboard than unlisted (privately published) ones. In addition to providing a central location to examine review comments and ratings, the Usage dashboard is useful for verifying public information about the plugin, including the download link and a shortcut link to Plugin Central.
Anyone on the authoring account can view the published plugin's Usage dashboard.
- Go to one.newrelic.com > More > Plugins, and select the plugin's name or icon.
- From the plugin's Summary page, select Usage.
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's data security and licenses documentation.