Configuring New Relic Observer jobs

Use New Relic Observer when you have a New Relic account with a New Relic Infrastructure subscription. Using New Relic Observer, you can configure jobs that dynamically load New Relic Infrastructure resource data via New Relic for analysis by Netcool Agile Service Manager.

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.

The New Relic Observer is installed as part of the core installation procedure.
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"

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 to the Agile Service Manager core topology service:
  • 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. The observer loads and updates the resources and their relationships within the Agile Service Manager core topology service.

You configure the following job.
Load
By default, Load jobs are one-off, transient jobs that perform a full upload of all requested topology data as soon as they are triggered.
You can also run these jobs (again) manually from the Observer UI, or schedule them to run at set times when configuring them.
Table 1. New Relic job parameters
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. For more information, see account ID tip
New Relic Insights Query API key Specify the New Relic Insights Query API key. Required. Must be encrypted. For more information, see query API key tip
filterCriteria Extend the result set returned to Agile Service Manager.

Optional. The default value is 'SINCE 4 hours ago LIMIT 1000'.

For more information, see the documentation for New Relic Query Language.
Job schedule Specify when the job runs. Optional. Load jobs only.
Observer job description Enter additional information to describe the job. Optional
Tip (New Relic account ID): To obtain the account ID, first log into the New Relic login page:
https://login.newrelic.com/login and then obtain the account ID from this URL:
https://rpm.newrelic.com/accounts/<accountId>
Tip (New Relic Insights Query API key): A new Relic user with a new Relic Infrastructure subscription is required to generate a new Relic Insights query API Key as outlined here: https://docs.newrelic.com/docs/insights/insights-api/get-data/query-insights-event-data-api
Encryption requirement
The load job requires the insightsQueryAPIKey in encrypted form. To encrypt the insightsQueryAPIKey, run the encrypt_password.sh script in the ASM_HOME/bin directory: 
./bin/encrypt_password.sh
Enter and then confirm the password. The encryption utility will return an encrypted password.

Procedure

  1. From the Observer Configuration UI, click Configure under the New Relic icon, or select an existing New Relic job to be edited.
  2. Configure (at least) the following parameters:
    • Unique ID
    • New Relic account name or tenant name
    • New Relic account ID
    • New Relic Insights Query API Key (must be encrypted)
  3. Optional: Define a Job schedule (for Load jobs only) by setting the time when the job should run, and whether it should run at regular intervals. By default, the job runs immediately, and only once. Optionally, you can specify a future date and time for the job to run, and then set it to run at regular intervals after that, if required. The run intervals must be at least 90 seconds apart, and if you set them at less than 15 minutes, a warning is displayed, as the frequency can impact system performance.
  4. Optional: Enter an Observer job description to explain the purpose of the job in more detail.
  5. Click Run job to save your job and begin retrieving information.

Results

This job loads all requested topology data. Run this job whenever you need New Relic topology data refreshed.