Last updated Sep 27, 2021

Rate this page:

Integrate Compass with New Relic

What is New Relic?

New Relic is an observability platform that enables engineering teams to monitor the performance of their deployed software.

Integrate Compass with New Relic

If your team uses New Relic for application performance monitoring (APM), you can import your monitored services directly into Compass. This is an easy way to begin building your component catalog in Compass.

To integrate Compass with New Relic, you must first install the New Relic app in Compass. Then you connect to your New Relic account to import the New Relic services into Compass.

Before you begin

Before setting up the integration with New Relic, make sure that you:

Set up the integration

To set up the integration:

  1. In Compass, select Apps from the top navigation bar.
  2. On the New Relic tile, select Install.
  3. On the New Relic tile, select Configure.
  4. If required, complete the requested steps to allow the app to access Compass.
  5. Select a New Relic Data Center from the list. Learn more about New Relic data centers
  6. Enter your New Relic API Key. This should be a user API key. Learn more New Relic API keys
  7. Select Connect account.

Now you can import your New Relic services into Compass.

Import services from New Relic

Once you have finished setting up the integration, you can import your services from New Relic into Compass.

To import services from New Relic:

  1. In Compass, select Apps from the top navigation bar.
  2. On the New Relic tile, select Configure.
  3. Select Select services to import.
  4. Deselect any services that you do not want to import into Compass.
  5. Select Import.
  6. If you are importing a large number of New Relic services, you may be prompted to Continue import. Follow the prompts to complete the import.

Compass will let you know when the import is complete. Each New Relic service is imported as a Service component. You can now select Components from the top navigation bar in Compass to view your newly imported services from New Relic.

Data imported from New Relic

The following data are imported from New Relic for each service:

  • Service name
  • Service tags
  • Link to the New Relic dashboard for the service

Sync services from New Relic after you import

After you initially import services from New Relic, you can perform a manual sync to import any new services that have appeared in New Relic and update any services that were previously imported.

To sync services from New Relic:

  1. In Compass, select Apps from the top navigation bar.
  2. On the New Relic tile, select Configure.
  3. Select Select services to import.
  4. Deselect any services that you do not want to import or sync into Compass.
  5. Select Import.
  6. If you are syncing a large number of New Relic services, you may be prompted to Continue import. Follow the prompts to complete the sync.

Compass will let you know when the sync is complete.

  • Any services that were previously imported will be re-synced with Compass, to import additional service tags as labels in Compass.
  • Any new services will be imported to Compass as new Service components

Update your New Relic API key

If you’ve cycled your New Relic API key, you can update it in the New Relic integration. Removing and/or updating your API key won’t impact any services you’ve already imported into Compass. The updated key should point to the same New Relic account as the existing key.

To update your New Relic API key:

  1. In Compass, select Apps from the top navigation bar.
  2. On the New Relic tile, select Configure.
  3. Select Disconnect account.
  4. Provide an updated API key.
  5. Select Connect New Relic account to continue using the integration.

Uninstall the New Relic integration

You can uninstall the New Relic integration if you don’t have any further need to import/sync services from New Relic into Compass. Uninstalling the integration won’t impact any services you’ve already imported into Compass.

To uninstall the New Relic integration:

  1. In Compass, select Apps from the top navigation bar.
  2. On the New Relic tile, select Configure.
  3. Select Uninstall app.

The integration is now uninstalled.

Rate this page: