Adding Zebrium Root Cause Reports to your New Relic Dashboards

Follow the steps below to setup the Zebrium integration for New Relic. This will allow you to visualize Zebrium auto-detected root cause reports on any New Relic dashboard.

Integration Overview

1. Create an API Key in New Relic.
2. Create a New Relic Integration in Zebrium using the information from step 1.
3. Add Zebrium Root Cause Report events and Log metrics to your New Relic Dashboard using the Zebrium quickstart.

Integration Details

STEP 1: Create an API Key in New Relic

1. From the Settings pull-down, select API keys.
2. Click on Create a key.
3. Choose the appropriate Account and note the Account Id for use in STEP 2.
4. Select Ingest - License as the Key type.
5. Enter a Name for the API key and click Create a key.
6. Copy and save the Key for use in STEP 2.

STEP 2: Create a New Relic Outbound Integration in Zebrium

1. From the User menu area, click on the Settings (hamburger) Menu.
2. Select Integrations.
3. Scroll to the Observability Dashboards section and click on New Relic.
4. Click on the Create a New Integration button.
5. Click on the General tab.
6. Enter an Integration Name for this integration.
7. Select the Deployment for the integration.
8. Select the Service Group(s) for the integration.
9. Click on the Send Detections tab.
10. Click on the Enabled button.
11. Enter the Account Id from STEP 1 above.
12. Enter the API Key from STEP 1 above.
13. Click the Save button.

STEP 3: Visualize Zebrium auto-detected root cause reports with the Zebrium quickstart

The quickest way to start seeing Zebrium root cause reports on any New Relic dashboards is to install the New Relic I/O (Instant Observability) Zebrium quickstart.

1. Go to the Zebrium quickstart New Relic I/O, and click the green “Install now” button.
2. If you don’t have a New Relic account, follow the sign up instructions to get started for free.
3. Select an account and select Begin installation.
4. Follow the instructions in the installation docs or, if you have already completed Steps 1 and 2 above, just click “Done”.
5. Click the “See your data” button.

The above steps will install some sample Zebrium dashboard panels. We recommend copying the “Zebrium Root Cause Finder” and “Zebrium Root Cause Reports” panels to your other dashboards so you can see Zebrium detections alongside other dashboard charts.

More details on the panels and queries behind them appears below:

The screen shot below shows a New Relic dashboard with the following Zebrium charts:

• A count of Zebrium Root Cause Report Detections
• A Zebrium Root Cause Finder chart with a green vertical bar wherever a detection occurs. This is useful when used on other dashboards as you can visually correlate what you are seeing in other data with what Zebrium has automatically detected.
• A chart showing log anomaly counts
• A chart containing a list of root cause report summaries

Sample New Relic Zebrium dashboard:

The following screen shots show the definitions for each of the charts above:

Count of Zebrium Root Cause Report Detections:

Root cause finder showing where detections occur:

Chart of log anomaly counts:

List of root cause report summaries:

Table of Important Metrics

Zebrium Detections Event Payload

Zebrium Detections are sent to New Relic as Custom Events with eventType of NrAiIncidentExternal

Here is a sample NrAiIncidentExternal payload for a Zebrium detection with descriptions of each field:

    {
      "aggregationTag.ze_deployment": "this is the deployment name",
      "aggregationTag.ze_first_occurrence": "set to true if this is the first occurrence of this type of incident",
      "aggregationTag.ze_inci_id": "00062722-5f20-0000-0000-5190000353ee",
      "aggregationTag.ze_service_group": "this is the zebrium service group name",
      "aggregationTag.ze_significance": "significance of the detection: low, medium or high",
      "deepLinkUrl": "this is the URL in the Zebrium UI for this root cause report",
      "description": "this is usually the NLP summary for the root cause report",
      "entityName": "zebrium_detections",
      "source": "zebrium_detections",
      "state": "trigger",
      "timestamp": 1651647986000,
      "title": "Zebrium Detected Root Cause Report",
      "version": 1
    }

Support

If you need help with this integration, please contact Zebrium by emailing support@zebrium.com.