Configuring a New Relic Observer job
Use the New Relic Observer when you have a New Relic account with a New Relic Infrastructure subscription. Using this observer you can configure jobs that dynamically load New Relic Infrastructure resource data through New Relic for analysis.
Before you begin
Important: The New Relic Observer supports the cloud/SaaS New Relic version.
Ensure you have the New Relic account and New Relic Infrastructure subscription details to hand, such as the account name, account ID, and New Relic Insights API query key.
Restriction: New Relic applies a 1000 results limit on all New Relic Query Language (NRQL) queries. To accommodate this limit when retrieving data from the SystemSample, StorageSample, ProcessSample and NetworkSample event tables, the New Relic Observer uses the following NRQL query time clause:
"SINCE 4 hours ago LIMIT 1000"
Enabling access to the URL routes
To access the URL routes for the topology Swagger documentation, see the Enabling access to URL routes topic.
About this task
The Observer uses the New Relic Infrastructure subscription and makes active New Relic Query Language (NRQL) calls over REST to New Relic Insights to download New Relic Infrastructure resource data.
The New Relic Observer loads the following New Relic Infrastructure resources and their relationships:
- Host
- Storage
- OS
- Network Interfaces
- Processes
The New Relic Observer job extracts New Relic Infrastructure resources from New Relic using New Relic Query Language (NRQL) over REST, and the observer loads and updates the resources and their relationships.
You configure the following job.
Load: By default, Load jobs are one-off, transient jobs that do a full upload of all requested topology data as soon as they are triggered.
You can also run these jobs (again) from the Observer UI, or schedule them to run at set times when configuring them.
Procedure
Define or edit the following parameters, then click Run job to save and run the job.
Encryption requirement: For more information, see Configuring observer job security
| Parameter | Action | Details |
|---|---|---|
| Unique ID | Enter a unique name for the job | Required |
| New Relic Name | Specify the New Relic account name or tenant name | Required |
| New Relic account ID | Specify the New Relic account ID | Required. |
| New Relic Insights Query API key | Specify the New Relic Insights Query API key | Required. |
| filterCriteria | Extend the result set returned to IBM Cloud Pak® for Watson AIOps | Optional. The default value is SINCE 4 hours ago LIMIT 1000. For more information, see the documentation for New Relic Query Language. |
| Generate debug support file | Set this parameter to True in order to capture the output of the next scheduled job run as a file. This file will be stored with an observer's log files and can be used to debug observer issues, for example at the request
of your designated Support team, or while using a test environment. For one-off jobs (that is, Load jobs), this parameter reverts to False after the next completed run. To examine the output produced, you can load the generated
debug file using the File Observer. |
Optional |
| Job schedule | Specify when the job runs | Optional. Load jobs only. |
| Observer job description | Enter additional information to describe the job | Optional |
Tips:
-
New Relic account ID: To obtain the account ID log in to New Relic and then go to the URL https://rpm.newrelic.com/accounts/%3CaccountId%3E
-
New Relic Insights Query API Key: A New Relic user with a New Relic Infrastructure subscription is required to generate a New Relic Insights Qeury API Key. For more information, see https://docs.newrelic.com/docs/insights/insights-api/get-data/query-insights-event-data-api.