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.
New Relic parameters and supported features in Nobl9
- General support:
- Release channel: Stable, Beta
- Connection method: Agent, Direct
- Event logs: Supported
- Query checker: Supported
- Query parameters:
- Query interval: 1 min
- Query delay: 1 min
- Jitter: 15 sec
- Timeout: 30 sec
- Agent details and minimum required versions for supported features:
- Environment variable:
NR_QUERY_DELAY
- Plugin name:
n9newrelic
- Replay and SLI Analyzer:
0.56.0
- Maximum historical data retrieval period:
30 days
- Query parameters retrieval:
0.73.2
- Timestamp cache persistence:
0.56.1
- Additional notes:
- Support for New Relic queries
- Learn more
Authenticationβ
Pass your New Relic Insights API Query Key, NEWRELIC_INSIGHTS_QUERY_KEY
,
as an environment variable during agent startup.
Query keys are not query-specificβany query key associated with your New Relic account will run any query.
The value of the New Relic account ID is returned by Intake API under the account_id
key.
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 New Relic, 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.
Direct connection methodβ
Direct configuration for NewRelic requires users to enter their credentials which Nobl9 stores safely.
Nobl9 Webβ
To set up this type of connection:
- Navigate to Integrations > Sources.
- Click .
- Click the required Source icon.
- Choose Direct.
-
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 can 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 when replaying your SLO based on this data source.
- The maximum period value depends on the data source.
Find the maximum value for your data source. - 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
sloctlβ
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
|