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:
-
Using the New Relic ONE interface, select Manage your plan in User preferences:
-
Copy Account ID from the Plan management page:
For more information on account ID, refer to the Account ID | New Relic documentation.
To retrieve your INSIGHTS_QUERY_KEY
:
- On your New Relic Account, go to API Keys :
- In the Looking for other keys? section, click the Insights Query Keys link:
Nobl9 requires an Insights Query Key that begins with the NRIQ-
prefix.
You can only obtain this key from the New Relic Insights API (see step 3 below).
- Once the New Relic Insights API tab has loaded, click the blue plus button next to the Query Keys section on the right-hand side of the page to create a new
INSIGHTS_QUERY_KEY
:
Adding New Relic as a data sourceβ
To ensure data transmission between Nobl9 and your data source, it may be necessary to list Nobl9 IP addresses as trusted.
- 18.159.114.21
- 18.158.132.186
- 3.64.154.26
You can add the New Relic data source using the direct or agent connection methods. For both methods, start with these steps:
- Navigate to Integrations > Sources.
- Click .
- Click the relevant Source icon.
- Choose a relevant connection method (Agent or Direct), 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:
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel may be subject to change.
- The
-
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. -
Enter the Insights Query Key.
Refer to the Authentication section above for more details.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in New Relic integration for Query delay is
1 minute
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in New Relic integration for Query delay is
- Enter a Maximum Period for Historical Data Retrieval.
- This value defines how far back in the past your data will be retrieved.
- The value for the maximum period of data retrieval depends on the data source. Check the Replay documentation for details.
- A greater period can extend the loading time when creating an SLO.
- The value must be a positive integer.
- Enter a Default Period for Historical Data Retrieval.
- It is used by SLOs connected to this data source.
- The value must be a positive integer or
0
. - By default, this value is set to 0. When you set it to
>0
, you will create SLOs with Replay.
- Click Add Data Source
Direct using CLI - YAMLβ
The YAML for setting up a direct connection to New Relic looks like this:
apiVersion: n9/v1alpha
kind: Direct
metadata:
name: newrelic-direct
displayName: Newrelic direct
project: newrelic-direct
spec:
description: direct integration with Newrelic
sourceOf:
- Metrics
- Services
queryDelay:
unit: Minute
value: 720
logCollectionEnabled: false
newRelic:
accountId: 12345678
insightsQueryKey: ""
historicalDataRetrieval:
maxDuration:
value: 30
unit: Day
defaultDuration:
value: 0
unit: Day
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
logCollectionEnabled optional | boolean | Optional. Defaults to false . Set to true if you'd like your direct to collect event logs. Beta functionality available only through direct release channel. Reach out to support@nobl9.com to activate it. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
newRelic.accountID mandatory | string, secret | ID number assigned to the New Relic user account. See authentication for more details. |
newRelic.insightsQueryKey mandatory | string, secret | New Relic's API Query Key. See authentication for more details. |
Replay-related fields | ||
historicalDataRetrieval optional | n/a | Optional structure related to configuration related to Replay. β Use only with supported sources. β’ If omitted, Nobl9 uses the default values of value: 0 and unit: Day for maxDuration and defaultDuration . |
maxDuration.value optional | numeric | Specifies the maximum duration for historical data retrieval. Must be integer β₯ 0 . See Replay documentation for values of max duration per data source. |
maxDuration.unit optional | enum | Specifies the unit for the maximum duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
defaultDuration.value optional | numeric | Specifies the default duration for historical data retrieval. Must be integer β₯ 0 and β€ maxDuration . |
defaultDuration.unit optional | enum | Specifies the unit for the default duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
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.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel may be subject to change.
- The
-
Enter the New Relic Account ID to connect to your data source.
- Enter a Project.
- Enter a Name.
- Create a Description.
- In the Advanced Settings you can:
- Enter a Maximum Period for Historical Data Retrieval.
- Enter a Default Period for Historical Data Retrieval.
- Click Add Data Source
Agent using CLI - YAMLβ
The YAML for setting up an agent connection to New Relic looks like this:
apiVersion: n9/v1alpha
kind: Agent
metadata:
name: newrelic
displayName: New Relic Agent
project: newrelic
spec:
description: Agent settings for new relic datasource
sourceOf:
- Metrics
- Services
releaseChannel: beta
queryDelay:
unit: Minute
value: 720
newrelic:
accountId: 12345678
historicalDataRetrieval:
maxDuration:
value: 30
unit: Day
defaultDuration:
value: 0
unit: Day
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . β’ Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. β’ Must be a number less than 1440 minutes (24 hours). β’ Check query delay documentation for default unit of query delay for each source. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
newRelic.accountID mandatory | string, secret | ID number assigned to the New Relic user account. See authentication section above for more details. |
Replay-related fields | ||
historicalDataRetrieval optional | n/a | Optional structure related to configuration related to Replay. β Use only with supported sources. β’ If omitted, Nobl9 uses the default values of value: 0 and unit: Day for maxDuration and defaultDuration . |
maxDuration.value optional | numeric | Specifies the maximum duration for historical data retrieval. Must be integer β₯ 0 . See Replay documentation for values of max duration per data source. |
maxDuration.unit optional | enum | Specifies the unit for the maximum duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
defaultDuration.value optional | numeric | Specifies the default duration for historical data retrieval. Must be integer β₯ 0 and β€ maxDuration . |
defaultDuration.unit optional | enum | Specifies the unit for the default duration of historical data retrieval. Accepted values: Minute | Hour | Day . |
It is possible that a user is assigned to multiple accounts. In any case, the account ID can be obtained in the same way.
You can deploy only one agent in one YAML file by using the sloctl apply
command.
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).
- Kubernetes
- Docker
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:0.73.2
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
# The N9_METRICS_PORT is a variable specifying the port to which the /metrics and /health endpoints are exposed.
# The 9090 is the default value and can be changed.
# If you donβt want the metrics to be exposed, comment out or delete the N9_METRICS_PORT variable.
- name: N9_METRICS_PORT
value: "9090"
If you use Docker, you can run the Docker command to deploy the agent. It will look something like this:
# DISCLAIMER: This Docker command contains only the fields necessary for the purpose of this demo.
# It is not a ready-to-apply command, and you will need to replace the placeholder values with your own values.
docker run -d --restart on-failure \
--name nobl9-agent-nobl9-dev-newrelic-week-newrelicagent \
-e N9_CLIENT_ID="<CLIENT_ID>" \
-e N9_CLIENT_SECRET="<CLIENT_SECRET>" \
# The N9_METRICS_PORT is a variable specifying the port to which the /metrics and /health endpoints are exposed.
# The 9090 is the default value and can be changed.
# If you donβt want the metrics to be exposed, comment out or delete the N9_METRICS_PORT variable.
-e N9_METRICS_PORT=9090 \
-e NEWRELIC_INSIGHTS_QUERY_KEY="<NEWRELIC_INSIGHTS_QUERY_KEY>" \
nobl9/agent:0.73.2
Creating SLOs with New Relicβ
Creating SLOs in the UIβ
Follow the instructions below to create your SLOs with New Relic in the UI:
-
Navigate to Service Level Objectives.
-
Click .
-
Select a data source for your SLO.
-
In step 1 of the SLO wizard, select the service the SLO will be associated with.
-
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).
- Choose the Data Count Method for your ratio metric:
- Non-incremental: counts incoming metric values one-by-one. So the resulting SLO graph is pike-shaped.
- Incremental: counts the incoming metric values incrementally, adding every next value to previous values.
It results in a constantly increasing SLO graph.
-
Use the New Relic's query language (NRQL) to enter a Query or a Good query and Total Query for the metric you selected. For more details on NRQL and query samples, refer to the New Relic query examples section.
- Nobl9 queries for time series data using the
TIMESERIES
clause.- You can add an empty
TIMESERIES
clause in your NRQL query or skip it altogether as Nobl9 adds missingTIMESERIES
clause or overwrites the existing one. - As
TIMESERIES
clause is overwritten, do not append it with custom parameters.
- You can add an empty
warningDo not append the time range by using the
SINCE
andUNTIL
clauses in your queries as Nobl9 must have control over queried time range.For details on the position of the
TIMESERIES
clause, go to New Relic query examples below. - Nobl9 queries for time series data using the
-
In step 3, define a Time Window for the SLO.
-
In step 4, specify the Error Budget Calculation Method and your Objective(s).
-
In step 5, add a Name, Description, and other details about your SLO. You can also select Alert policies and Labels on this screen.
-
When youβre done, click Create SLO.
countMetrics
), keep in mind that the values ββresulting from that query for both good and total:- Must be positive.
- While we recommend using integers, fractions are also acceptable.
- If using fractions, we recommend them to be larger than
1e-4
=0.0001
. - Shouldn't be larger than
1e+20
.