New Relic integration

This integration ingests events from New Relic and maps them to APEX AIOps Incident Management events automatically.

This integration was validated with New Relic on November 25, 2024 and updated to use New Relic workflows instead of deprecated alerts.

When to use the New Relic integration

Incident Management offers two convenient mechanisms for integration with New Relic.

Use the Incident Management New Relic integration :
- To ingest events from New Relic and send them to Incident Management with automatic mapping.
- When you can configure your New Relic instance to authenticate against an Incident Management endpoint to send data to Incident Management. This integration does not require an Incident Management Collector and you can use authentication.
Use the New Relic plugin with the Incident Management Collector, when you:
- Don’t want to make direct outbound calls from your environment.
- Can install an Incident Management Collector on a host in your environment and it will act as a proxy.

Create a new integration in Incident Management

Log in to your Incident Management instance.
Choose Integrations > Ingestion Services . Click on the entry for the New Relic push integration.
Click Add New Integration.
Define the Incident Management Endpoint and API Description. Then click Save.
The UI displays the integration in a new page with a Provisioned status. Click Save at the bottom of the page. The integration status will change to Active when it starts receiving data.

The new integration includes a custom endpoint, a set of default mappings to convert New Relic data to Incident Management events, and a deduplication key to group similar events into alerts. You can now set up New Relic to send data to this endpoint, as described in the following section.

(Optional) Once your endpoint starts receiving data from New Relic, you can customize how the integration maps and deduplicates this data. To learn more about mapping and deduplication, read Use mapping types in custom integrations and Deduplicate events to reduce noise.

Set up a workflow in New Relic

To set up New Relic, do the following:

Create a new destination in New Relic:
1. In New Relic, navigate to Alerts > Destinations.
2. Click Webhook.
3. Set the webhook name as: AIOps
4. Under Endpoint URL, enter the APEX AIOps Incident Management endpoint URL for your New Relic integration.
  Your endpoint URL is located under the "Configuration Information" section of your New Relic integration in Incident Management.
5. Click Save destination.

Create a new workflow in New Relic:

In New Relic, navigate to Alerts > Workflows.
Click Add a workflow.
Provide a name for the workflow.
Under Filter data, specify the kinds of issues you want to send. For more information on building filter queries in New Relic, see the New Relic documentation.
Under Notify, select "Webhook."
For Destination, select the "AIOps" webhook you created.
Add the following custom headers:
- Key: Content-Type
  Value: application/json
- Key: apiKey
  Value: Paste your Incident Management API key in this field.
  To create a new API key to use with your integration, follow the instructions in Manage API keys.

Replace the default payload template with the following:

{ 
  "account_id": {{nrAccountId}},
  "account_name": {{json accumulations.tag.account.[0]}},
  "closed_violations_count": {"critical": {{closedIncidentsCount}}, "warning": 0},
  "closed_violations_count_warning": 0,
  "closed_violations_count_critical": {{closedIncidentsCount}},
  "open_violations_count_warning": 0,
  "open_violations_count_critical": {{openIncidentsCount}},
  "condition_family_id": {{accumulations.conditionFamilyId.[0]}},
  "condition_id": {{accumulations.conditionFamilyId.[0]}},
  "condition_name": "{{escape accumulations.conditionName.[0]}}",
  "condition_description": "{{escape accumulations.conditionDescription.[0]}}",
  "current_state": "{{#if issueClosedAtUtc}}closed{{else if issueAcknowledgedAt}}acknowledged{{else}}open{{/if}}",
  "details": {{json issueTitle}},
  "duration": {{#if issueDurationMs}}{{issueDurationMs}}{{else}}0{{/if}},
  "event_type": "INCIDENT",
  "incident_acknowledge_url": {{json issueAckUrl}},
  "incident_id": {{#if labels.nrIncidentId}}{{labels.nrIncidentId.[0]}}{{else}}-1{{/if}},
  "incident_url": {{json issuePageUrl}},
  "issue_id": {{json issueId}},
  "metadata": {
    {{#if locationStatusesObject}}"location_statuses": {{json locationStatusesObject}},{{/if}}
    {{#if accumulations.metadata_entity_type}}"entity.type": {{json accumulations.metadata_entity_type.[0]}},{{/if}}
    {{#if accumulations.metadata_entity_name}}"entity.name": {{json accumulations.metadata_entity_name.[0]}},{{/if}}
    "section": "metadata"
  },
  "open_violations_count": {
    "critical": {{openIncidentsCount}},
    "warning": 0
  },
  "owner": {{json owner}},
  "policy_name": {{json accumulations.policyName.[0]}},
  "policy_url": {{json policyUrl}},
  "runbook_url": {{json accumulations.runbookUrl.[0]}},
  "severity": "{{#eq HIGH priority}}WARNING{{else}}{{priority}}{{/eq}}",
  "targets": [
    {
      "id": "{{labels.targetId.[0]}}",
      "name": "{{#if accumulations.targetName}}{{escape accumulations.targetName.[0]}}{{else if entitiesData.entities}}{{escape entitiesData.entities.[0].name}}{{else}}N/A{{/if}}",
      "link": "{{issuePageUrl}}",
      "product": "{{accumulations.conditionProduct.[0]}}",
      "type": "{{#if entitiesData.types.[0]}}{{entitiesData.types.[0]}}{{else}}N/A{{/if}}",
      "labels": {
        {{#each accumulations.rawTag}}"{{escape @key}}": {{#if this.[0]}}{{json this.[0]}}{{else}}"empty"{{/if}}{{#unless @last}},{{/unless}}{{/each}}
      }
    }
  ],
  "timestamp": {{updatedAt}},
  "timestamp_utc_string": {{json issueUpdatedAt}},
  "version": 1.0,
  "violation_callback_url": {{json issuePageUrl}},
  "violation_chart_url": {{json violationChartUrl}}
}

Click Save message.
Click Test workflow to send a test notification to your Incident Management instance.
In Incident Management, go to the page for your New Relic integration and check the Map Your Data section to verify that the test notification was sent.
Navigate back to New Relic and click Activate workflow.

For more information about notification channels and alert policies in New Relic, see docs.newrelic.com.

Finish configuring integration in Incident Management

To finish configuring your New Relic integration, do the following:

Within the page for your New Relic integration in Incident Management, navigate to the Map Your Data section. Customize the default mappings from New Relic fields to Incident Management fields (optional).
Set a deduplication key (optional).
Save the integration.

In this section:

New Relic integration

When to use the New Relic integration

Create a new integration in Incident Management

Set up a workflow in New Relic

Finish configuring integration in Incident Management

Search results