Discover and manage applications with New Relic One Catalog

Developers are creating new and innovative apps that can extend and enhance your data views. The New Relic One Catalog makes it easy and fast to browse through publicly available apps and subscribe to the ones you want, all from the New Relic One GUI. The Catalog also lets you subscribe to apps that you build, publish, and deploy. These are displayed in the Your company applications area.

NR1_catalog.png

one.newrelic.com > New Relic One Catalog Subscribe to applications

Why it matters

Applications in the New Relic One Catalog have a couple of sources. Some are developed by New Relic engineers to address common needs and are available to all customers. Others are created by and for developers and other stakeholders within a company. All are intended to help you visualize the data you need, the way you want it.

If you’ve started to develop applications on the New Relic One platform, you probably want to share them with your broader organization. That’s where the Catalog comes in. When you publish and deploy your app, it’s available to you in the Catalog. You can manage the information that you want to share about your application, as well as how it appears on the New Relic One home page. You can also subscribe accounts to it.

Permission for managing applications

Certain permissions are required for subscribing to applications using the Catalog:

Subscribe to publicly available applications

To subscribe to publicly available applications—applications that are listed above Your company applications in the Catalog—you must have the Nerdpack manager role. Nerdpack manager permissions are automatically assigned to New Relic account owners and admins and can be assigned to individual users. If you aren’t an owner or admin, you can request Nerdpack manager permission, or ask your New Relic admin or owner to subscribe the apps to your account for you.

You can add any of the publicly available applications to master accounts or separate sub-accounts on which you have the Nerdpack manager role, or to separate sub-accounts under a master account you own or administer. If you add the application to a master account, the access flows to all of its sub-accounts as well.

Subscribe to applications that you create

You also must have the Nerdpack manager role to subscribe the applications you create to accounts. Currently, applications that you publish and deploy, listed under Your company applications, can only be subscribed to the master account that was used to publish them, or to its sub-accounts. This means you might want a New Relic admin to deploy your applications for you, if they need to be available across the company.

Add images and metadata to your apps

The Catalog can provide helpful information about each application, including a description of what it does and how it’s best used. Applications can also include screenshots, icons, and metadata that help to make it stand out among all the other applications on your New Relic One home page.

screenshot of app description in catalog

one.newrelic.com > New Relic One Catalog > Browser analyzer (or any app) to view application information

The New Relic One CLI enables you to provide the information and images you want to include with your application. Then it's a matter of kicking off a Catalog command that validates the information and saves it to the Catalog.

When you create an application by running nr1 create, a generic icon.png file is added to your project. Replace this with an icon of your choice, but keep the file name icon.png to update your application's icon in the Catalog.

1. Update the New Relic One CLI

Make sure you have the latest version of the New Relic One CLI by running nr1 update.

2. Add catalog metadata and screenshots

Run nr1 create and then select catalog to add a catalog folder to your New Relic One project. The folder contains the following empty files and folder. Add the information as described in the following table for the process to succeed.

File Requirements
screenshots folder A directory that must contain no more than 6 images and meet these criteria:
  • 3:2 aspect ratio
  • PNG format
  • landscape orientation
  • 1600 to 2400 pixels wide
documentation.md A markdown file that presents usage information pulled into the Documentation tab for the application in the Catalog.
additionalInfo.md An optional markdown file for any additional information about using your application.
config.json A JSON file that contains the following fields:
  • tagline: A brief headline for the application. Must not exceed 30 characters.
  • repository: The URL to the GitHub repo for the application. Must not exceed 1000 characters.
  • details: Describes the purpose of the application and how to use it. Information must not exceed 1000. Use carriage returns for formatting. Do not include any markdown or HTML.
  • support: An object that contains:
    • issues: A valid URL to the GitHub repository's issues list, generally the GitHub Issues tab for the repo.
    • email: A valid email address for the team supporting the application.
    • community: URL to a support thread, forum, or website for troubleshooting and usage support.
  • whatsNew: A bulleted list of changes in this version. Must not exceed 500 characters. Use carriage returns for formatting. Do not include markdown or HTML.
Example:
{
  "tagline": "Map your workloads & entities",
  "repository": "https://github.com/newrelic/nr1-workload-geoops.git",
  "details": "Describe, consume, and manage Workloads and Entities in a geographic model that supports location-specific KPI's, custom metadata, drill-down navigation into Entities and Workloads, real-time configuration, and configuration via automation using the newrelic-cli.",
  "support": {
    "issues": {
      "url": "https://github.com/newrelic/nr1-workload-geoops/issues"
    },
    "email": {
      "address": "opensource+nr1-workload-geoops@newrelic.com"
    },
    "community": {
      "url": "https://discuss.newrelic.com/t/workload-geoops-nerdpack/99478"
    }
  },
  "whatsNew": "\n-Feat: Geographic mapping of Workloads and Entities\n-Feat: Programmatic alerting rollup of underlying Entities\n-Feat: Custom KPI measurement per location\n-Feat: Empty-state edit workflow\n-Feat: JSON file upload format\n-Feat: Published (in open source docs) guide to automating configuration using the newrelic-cli"
}
3. Save the metadata and screenshots to the catalog

Run nr1 catalog:submit. This validates the information you added to the catalog directory against the criteria described in the previous step, and saves it to the Catalog.

Subscribe accounts to an application

  1. From the New Relic One home page, click the New Relic One Catalog launcher.
  2. In the New Relic One Catalog, select the application you want to add to your New Relic account.
  3. Click Add this app. Note that this button says Manage access if the app has already been subscribed to an account you manage.
  4. On the access page listing the accounts you can subscribe to an application, select the accounts you want to subscribe, then click Update access. Now you and the accounts you subscribed to the app can launch it from New Relic One.

Unsubscribe to an application

  1. On New Relic One, select New Relic One Catalog.
  2. Click the application you want to unsubscribe accounts from.
  3. Click Manage access.
  4. On the access page, clear the check box for any accounts you want to unsubscribe, and then click Update access. The application is no longer listed on New Relic One.

Handle duplicate applications

You might end up with duplicate applications on your New Relic One landing page. This can happen when you subscribe to the same app using both the CLI and the Catalog. Or if you clone an app, modify and deploy it, but keep the original name. You can manage duplicates with the Catalog.

Good to know before you start:

  • You need Nerdpack manager permission on accounts that you want to unsubscribe and undeploy from applications.
  • You can't remove the public apps.
  • When a duplicate application has no accounts subscribed to it, you undeploy it. For applications that have accounts subscribed to them, you unscubscribe and undeploy.
  • The unsubscribe and undeploy process happens in a batch. To remove an account from an application, but ensure that other accounts continue to be subscribed, select the checkbox, Resubscribe these accounts to the new application.

Remove duplicates

  1. In the New Relic One Catalog, click a public application that has one or more duplicates. (You can only manage duplicates from the public version of the application.)
  2. On the application information page, select Clean up applications.
  3. Review the information about the application that's open, as well as any duplicates. Click Manage app for duplicates you want to remove.
  4. If needed, select Resubscribe these accounts to the new application.
  5. Click Unsubscribe and undeploy, and agree to the terms and conditions.

For more help

Additional documentation resources include:

Recommendations for learning more: