Skip to main content

New Relic

New Relic is a software solution that monitors performance and availability. It sets and rates application performance across the environment using a standardized Apdex (application performance index) score. You can use any New Relic query to gather SLIs and apply them in Nobl9 to define your new SLOs.

Scope of support

With the New Relic integration, you can use any New Relic Query | New Relic Documentation to gather SLIs and apply them in Nobl9 to define your new SLOs.

Authentication

NewRelic Insights API Query Key, that is NEWRELIC_INSIGHTS_QUERY_KEY, must be passed as an environment variable during agent startup. Query keys are not query-specific - any query key in your New Relic account will run any query. The value of the New Relic account ID is returned by Intake API. The Key is account_id. There is no possibility to overwrite the value of account_id with the environmental variables.

Your account_id shows on your New Relic account once you list out your accounts:

  1. Using the New Relic ONE interface, select Manage your plan in User preferences:

    New Relic Preferences

  2. Copy Account ID from the Plan management page:

    New Relic Plan

To retrieve your INSIGHTS_QUERY_KEY:

  1. Go to Manage Insights Data on your New Relic Account:

    New Relic Menu

  2. Choose API Keys. The key that you need is an API Query Key:

    New Relic API Keys

For more information on account ID, refer to the Account ID | New Relic Documentation.

Adding New Relic as a Data Source in the UI

To add New Relic as a data source in Nobl9 using the Agent or Direct connection method, follow these steps:

  1. Navigate to Integrations > Sources.

  2. Click the plus button button.

  3. Click the NewRelic icon.

  4. Choose Direct or Agent, then configure the source as described below.

New Relic Direct

Direct Configuration in the UI

Direct configuration for NewRelic requires users to enter their credentials which Nobl9 stores safely. To set up this type of connection:

  1. Enter the New Relic Account ID to connect to your data source.
    Your Account ID shows on your New Relic account once you list out your accounts.

  2. Enter the Insights Query Key.
    Refer to the Authentication section above for more details.

  3. Select a Project (mandatory).
    Specifying a Project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, a default value appears.

  4. Enter a Display name (optional).
    You can enter a friendly name with spaces in this field.

  5. Enter a Name (mandatory).
    The name is mandatory and can only contain lowercase, alphanumeric characters and dashes (for example, my-project-name). This field is populated automatically when you enter a display name, but you can edit the result.

  6. Enter a Description (optional).
    Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.

  7. Click the Add Data Source button.

New Relic Agent

Agent Configuration in the UI

Follow the instructions below to configure your New Relic Agent. Refer to the section above for the description of the fields.

  1. You can edit the New Relic Account ID to connect to your data source.

  2. Select a Project.

  3. Enter a Display Name.

  4. Enter a Name.

  5. Create a Description.

  6. Click the Add Data Source button.

Deploying New Relic Agent

When you add the data source, Nobl9 automatically generates a Kubernetes configuration and a Docker command line for you to use to deploy the Agent. Both of these are available in the web UI, under the Agent Configuration section. Be sure to swap in your credentials (e.g., replace <NEWRELIC_INSIGHTS_QUERY_KEY> with your organization key).

If you use Kubernetes, you can apply the supplied YAML config file to a Kubernetes cluster to deploy the Agent. It will look something like this:

# DISCLAIMER: This deployment description contains only the fields necessary for the purpose of this demo.
# It is not a ready-to-apply k8s deployment description, and the client_id and client_secret are only exemplary values.

apiVersion: v1
kind: Secret
metadata:
name: nobl9-agent-nobl9-dev-newrelic-week-ble
namespace: default
type: Opaque
stringData:
newrelic_insights_query_key: "<NEWRELIC_INSIGHTS_QUERY_KEY>"
client_id: "<CLIENT_ID>"
client_secret: "<CLIENT_SECRET>"
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: nobl9-agent-nobl9-dev-newrelic-week-ble
namespace: default
spec:
replicas: 1
selector:
matchLabels:
nobl9-agent-name: "newrelicagent"
nobl9-agent-project: "newrelic-week"
nobl9-agent-organization: "nobl9-dev"
template:
metadata:
labels:
nobl9-agent-name: "newrelicagent"
nobl9-agent-project: "newrelic-week"
nobl9-agent-organization: "nobl9-dev"
spec:
containers:
- name: agent-container
image: nobl9/agent:latest
resources:
requests:
memory: "350Mi"
cpu: "0.1"
env:
- name: N9_CLIENT_ID
valueFrom:
secretKeyRef:
key: client_id
name: nobl9-agent-nobl9-dev-newrelic-week-ble
- name: N9_CLIENT_SECRET
valueFrom:
secretKeyRef:
key: client_secret
name: nobl9-agent-nobl9-dev-newrelic-week-ble
- name: NEWRELIC_INSIGHTS_QUERY_KEY
valueFrom:
secretKeyRef:
key: newrelic_insights_query_key
name: nobl9-agent-nobl9-dev-newrelic-week-ble

Creating SLOs with New Relic

Creating SLOs in the UI

Follow the instructions below to create your SLOs with New Relic in the UI:

  1. Navigate to Service Level Objectives.

  2. Click the plus button button.

  3. Select a data source for your SLO.

  4. In step 1 of the SLO wizard, select the Service the SLO will be associated with.

  5. In step 2, select New Relic as the Data Source for your SLO, then specify the Metric. You can choose either a Threshold Metric, where a single time series is evaluated against a threshold, or a Ratio Metric, which allows you to enter two time series to compare (for example, a count of good requests and total requests).

    • Threshold metric for New Relic: Query: SELECT average(duration) FROM Transaction TIMESERIES

    • Ratio metric for New Relic: Good Query: SELECT count() FROM Transaction WHERE httpResponseCode IN ('200','301','302') TIMESERIES Total Query: SELECT count() FROM Transaction TIMESERIES

  6. In step 3, define a Time Window for the SLO.

  7. In step 4, specify the Error Budget Calculation Method and your Objective(s).

  8. In step 5, add a Name, Description, and other details about your SLO. You can also select Alert Policies and Labels on this screen.

  9. When you’re done, click Create SLO.

SLOs using New Relic - YAML samples

Here’s an example of New Relic using a rawMetric (Threshold metric)

apiVersion: n9/v1alpha
kind: SLO
metadata:
displayName: My SLO
name: my-slo
project: my-project
spec:
budgetingMethod: Timeslices
description: ""
indicator:
metricSource:
name: newrelic
service: newrelic-polakpotrafipl
objectives:
- target: 0.6
op: lte
rawMetric:
query:
newRelic:
nrql: SELECT average(duration) FROM Transaction TIMESERIES
displayName: rather-bad
timeSliceTarget: 0.6
value: 0.6
- target: 0.99
op: lte
rawMetric:
query:
newRelic:
nrql: SELECT average(duration) FROM Transaction TIMESERIES
displayName: stretched
timeSliceTarget: 0.99
value: 1.2
timeWindows:
- count: 1
isRolling: true
unit: Hour

Specification for metric from New Relic always has one mandatory field:

  • nrql – It can be used to retrieve detailed New Relic data and get insight into your applications, hosts, and business-important activity.

New Relic Query Examples

Details about a New Relic Query Language can be found in the Introduction to NRQL | New Relic Documentation.

TIMESERIES clause

Nobl9 always queries for time series data and TIMESERIES clause is enforced. Nobl9 adds missing TIMESERIES clause or overwrites the existing one.

You can add an empty TIMESERIES clause in your NRQL queries or skip it altogether.

note

Because TIMESERIES clause is overwritten, user should not use their own parameters in it.

  • SELECT count(*) FROM Transaction TIMESERIES 1 hour

1 hour will be overwritten by the agent and set to a different value.

SINCE, UNTIL clauses

  • SINCE clause

  • UNTIL clause

note

The Nobl9 agent needs control over a time range queried, so the user must not use SINCE and UNTIL clauses explicitly. There is no mechanism that would overwrite these clauses if used, so using them will cause incorrect results.

One point in results

Queries must be written in such a way that they return only one time series. In other words, the user always has to query for a single attribute or use a single function (or expression).

Examples:

❌ Incorrect queries:

  • SELECT * FROM Transaction - selects ALL attributes

  • SELECT average(duration), min(duration) FROM Transaction - selects 2 functions

✔ Correct queries:

  • SELECT count(*) FROM Transaction TIMESERIES - selects a single function.

  • SELECT duration FROM Transaction TIMESERIES - selects a single attribute.

Other clauses mutually exclusive with TIMESERIES

❌ Other clauses that are mutually exclusive with TIMESERIES clause must not be used. Example:

  • SELECT count(*) FROM PageView FACET city

Querying the New Relic Server

The Nobl9 Agent leverages NewRelic Insights API parameters. It pulls data at a two-minute interval from the New Relic server.

New Relic API Rate limits

For the information on New Relic rate limits, refer to the following documentation:

Introduction to NRQL | New Relic Documentation

Query Insights Event Data via API | New Relic Documentation

Rate Limits for NRQL Queries | New Relic Documentation