Skip to main content

New Relic

CatalogDiscoveryScorecards

Summary

New Relic provides performance tracking. You can use New Relic to drive insights into values such as:

  • Error rates
  • Throughput
  • Apdex
  • Live entities in your environment
  • Embedded dashboards
  • Dependencies

Setup

In order to connect Cortex to your New Relic instance, you’ll need to create a New Relic User Token, and add it under Settings → New Relic.

Multi-account support

New Relic has multi account support. Each configuration requires an alias. We use the alias to correlate the instance you want to use with the registrations for various entities. There is also a default configuration used by registrations without an alias listed. You can edit aliases and the default configuration under Settings → New Relic.

caution

If you do not see the Settings page you're looking for in the sidebar, you likely don't have the proper permissions and need to contact your admin.

Registration

APM

New Relic application metrics can be fetched for each entity using application ID or tags.

Instructions to find your Application ID can be found in the New Relic docs. You can also find the Application ID in the URL in New Relic. Aliases tie the entity registration to a New Relic configuration listed under Settings → New Relic. The alias parameter is optional, but if not provided the entity will use the default configuration under Settings → New Relic.

x-cortex-apm:
newrelic:
applications:
- applicationId: 1234567
alias: Default-App # alias is optional and only relevant if you have opted into multi account support
- applicationId: 1234567
alias: Another-App # alias is optional and only relevant if you have opted into multi account support
tags:
- tag: tagKey
value: tagValue
alias: Default-App # alias is optional and only relevant if you have opted into multi account support

Embeds

Cortex can also embed dashboards from New Relic.

x-cortex-dashboards:
embeds:
- type: newrelic
url: https://chart-embed.service.newrelic.com/herald/6b334ae2-b1e0-412c-b714-826a5aed8358

Dependencies

Cortex automatically syncs dependencies from New Relic into Cortex. By default, we map entries found in New Relic's entity map using the entity identifier (x-cortex-tag).

For example, if you have two entities "entity-one" and "entity-two" that have a dependency edge in New Relic's entity map, we expect both entities to exist in Cortex with the same entity identifiers.