New Relic developers

New Relic One: Guide to publishing

See your application in New Relic One

There are two options for placing your application in New Relic One:

For details on permissions and access to data, see Permissions.

Serve locally

While working on your application, before it’s ready for final publishing, you can locally serve your Nerdpack to display it in New Relic One. If you are doing this for the first time, go through the get-start process from the Build a New Relic One application launcher in one.newrelic.com.

To serve a Nerdpack locally: 

  1. Serve the Nerdpack by running the following in the parent root folder of your Nerdpack: nr1 nerdpack:serve.

  2. Go to one.newrelic.com/?nerdpack=local. The ?nerdpack=local URL suffix will load any locally served Nerdpacks available.

When you make a change to a locally served Nerdpack, New Relic One will automatically reload it.

For more on this, see Local development.

Publish

One of the CLI commands is nerdpack:publish. This places your Nerdpack in New Relic One. To publish and deploy, you must be a Nerdpack manager (a type of New Relic add-on role). Your New Relic account administrator can grant this role. 

Note: New Relic One requires that only one version (following Semantic versioning) of a Nerdpack can be published. Thus, the success of a nr1 nerdpack:publish command expects both the correct permissions (the aforementioned Nerdpack Manager role as well as a unique version (as specified in the package.json's version attribute.

To publish, run: nr1 nerdpack:publish

To get more familiar with the command: Type the following and review the capabilities of the command.

nr1 nerdpack:publish --help

Deploy

One of the CLI commands is nerdpack:deploy. Deploying a Nerdpack is how you choose which New Relic accounts have access to your application, and how you control which version of the application they’ll see.

When you deploy a Nerdpack, you choose its "channel." A channel represents the development status of an application. There are three-channel choices: DEV, BETA, and STABLE. When you deploy your application (or a new version of your application) you assign it to one of these channels. Channels are meant to be an easier way to control application version access than having to be concerned with many specific version numbers. 

 

Subscribe

One deployed, users in those accounts can use the nr1 nerdpack:subscribe command to subscribe to your Nerdpack. 

For more on publishing and deploying, see the workshop.