Publishing your plugin

Plugin Central is the repository of plugins available to New Relic Plugins users. Once you have created a plugin that you want to distribute through Plugin Central and have your documentation and support plans in place for it, follow these instructions to publish your plugin. After you publish your plugin, all of its dashboards and summary metrics you create (in addition to the default dashboard) will be available "out of the box" for your plugin users to use and enjoy.

Note: You can also publish a plugin without listing it in Plugin Central; for example, if you want to beta test it first, or if you only want specific users to be able to use it. If you decide to publish an "unlisted" plugin, you will need to communicate directly with your users when it is added, updated, or removed.

Requirements to publish plugins

Before you can make your plugin available, you must:

  • Make sure your plugin has at least three summary metrics and that you are satisfied with your dashboard's information and appearance.
  • Create documentation for your plugin.
  • Develop a support plan for your plugin.
  • Provide a URL to a branding image for your plugin.
  • Assign a publisher name to your plugin. (If left blank on the Publish page, this defaults to your account name.)
  • Link valid URLs for your About and Support pages. (Webpages with 400 or 500 level responses are not accepted.)
  • Accept the Developer Terms of Service. (A link to this document and checkbox will appear on the Publish page.)

If you want to list your plugin in Plugin Central you must also:

  • Write a description of your plugin (maximum 4096 characters), using Markdown text formatting.
  • Link a valid URL and type to your Setup page.

To publish your plugin: From the New Relic Plugins menu bar, select your plugin, then select Publish. The Publish page verifies all of these requirements before you can confirm publication.

Branding image

As part of the publishing process, you can identify a URL with a branding image for your plugin. Follow these formatting guidelines:

  • Set the image size to 64 x 64px.
  • Save as a .png or .gif file.
  • Use transparency for the background unless it is a square icon.
  • Design the image to display well on both white and black backgrounds.

Text formatting

To enhance the appearance of text in your plugin's Description, you can use most standard Markdown codes.

Exceptions: The plugin's Description field does not support:

  • Images
  • Links
  • Custom HTML

Standard Markdown text formatting codes include:

Element Markdown usage
Headings

At the beginning of the line, type one or more pound signs (#, ##, etc.) to correspond to each heading level. For example:

    #heading 1 title
    ##heading 2 title
Paragraphs To end a paragraph, press Return. Or, to insert a line break within a paragraph, type two or more spaces followed by Return.
Bulleted lists

Before you start a list, add a blank line or a heading to your document. Then start each unordered list item with an asterisk and a space. For example:

* list item

Numbered lists

Before you start a list, add a blank line or a heading to your document. Then start each step using any digit and a period. (Markdown automatically renumbers the list sequentially.) For example:

      1. Do this.
      2. Next do this.
Bold

Enclose one or more words with two asterisks. For example:

**sample text**

Italics

Enclose one or more words with one asterisk or an underscore. For example:

*sample text* or _sample text_

Code

Enclose one or more words with backticks. For example:

`sample code`

Horizontal rules

Type three or more asterisks or dashes separated with spaces. For example:

* * * or - - -

Note: Your plugin's horizontal rules will appear in the user interface for New Relic Plugins. However, they will not appear in New Relic's website.

Distribution method

The Distribution method identifies how users can obtain your plugin from Plugin Central.

  • File download: Most developers typically select this option for plugin setup and installation.
  • Webpage link: SaaS providers typically select this option for plugin configuration and identify their website's landing page URL. In addition, New Relic's Connect partners can use a referral URL.
  • Platform Installer (NPI): If you use the New Relic Platform Installer (NPI) command line utility from New Relic Plugins to package your plugin, you can select this this option. Your plugin will be listed in Plugin Central as NPI Compatible. NPI-compatible plugins provide a consistent experience for easy downloading, configuration, and management by installing plugins with a single command.

Initial release

To publish your plugin's user interface:

  1. From the New Relic Plugins menu bar, select the plugin you want to publish.
  2. From your plugin's summary page, select Publish.
  3. Complete the required fields.
  4. To make your plugin publicly available, select the checkbox option for List this plugin in Plugin Central, and complete the additional required fields.
  5. Optional: To identify a branding image URL for your plugin, select the icon image, or select Change.
  6. Review the Developer Terms of Service, and select Accept.
  7. Select Publish.

New Relic Plugins will automatically redirect you to your plugin listing.

Additional changes

You can update and re-publish your plugin as often as you want. For more information, including a table that lists where you can make changes to various plugin settings, see Changing plugin settings.

Every time you publish changes to your plugin and list them in Plugin Central, the changes are instantly visible in Plugin Central. In addition, your published plugin changes typically appear in New Relic's website within five minutes.

Recommendation: To avoid development and testing impacts on your users, maintain "development" and "production" versions. For more information, see Versioning your plugin.

Unlisted plugins

To prevent a plugin from being publicly listed in Plugin Central:

  1. From the New Relic Plugins menu bar, select the plugin.
  2. From your plugin's summary page, select Publish.
  3. Make sure the checkbox option for List this plugin in Plugin Central is not selected.
  4. Select Publish.

Even though a published plugin is unlisted, users can still use it. You will need to communicate directly with them when your unlisted plugin is added, updated, or removed.

For more help

Additional documentation resources include:

Recommendations for learning more: