New Relic API Client (Java)

Java library for interfacing with New Relic APIs

Setting up your credentials

There is a template config file in the config directory, it is in HOCON format. You can make a copy of this file for your own configuration. The config uses different identifiers, this section of the documentation covers API Keys and how they are used.

Name	Description
accountName	Just a label to help know the name of the account, used in logging.
adminName	A label to know who is the owner of the Admin API Key.
accountId	The Account ID is required to query data from your account.
licenseKey	The License Key is used for Agents or Plugins to send data to your account.
restKey	The Rest API Key can be used to query certain kinds of data, it's recommended to use an Admin Key which provides more flexibility.
adminKey	The Admin API Key is like the Rest API Key but tied to a single admin user, there are also a few API calls that require this key.
insightsQueryKey	The Insights Query API Key is used to run NRQL queries and process the results.
insightsInsertKey	The Insights Insert API Key is used to publish custom events into Insights.

Using your custom config

Once you make a copy of config/template.conf to your own file, then you reference it with -Dconfig.file at runtime.

Building and running the tests

This project relies on gradle, so you can test that everything is working properly (including your config file) like this:

$ ./gradlew -Dconfig.file=config/myconfig.conf test
:compileJava
:processResources UP-TO-DATE
:classes
:compileTestJava
:processTestResources UP-TO-DATE
:testClasses
:test
Hibernate: drop table account if exists
Hibernate: drop table application if exists

BUILD SUCCESSFUL

Total time: 6.39 secs

Tasks

In addition to including Java libraries for working with the API, this project also can run as a Spring Boot application. Developers can create tasks such as an ETL-style program for working with the API on a regular schedule. There are currently a couple of tasks available.

Metrics Copier Task

This task will copy metrics from a source account (through the Applications API) and publish to a destination account (through the Insights Insert API). You configure the task with a config section like this:

	tasks {
		metricsCopier {
			enabled = true
			
			dest = {
				account = "ABC"
				eventType = "MetricTest1"
			}
			
			source = {
				account = "DEF"
				
				applicationList = [
					"Storefront"
					"Order Service"
					"User Service"
					"Inventory Service"
				]
				
				applications = {
					"Storefront".appId = 123
					"Order Service".appId = 456
					"User Service".appId = 789
					"Inventory Service".appId = 101112
				}

				metricList = [
					"MetricsReported"
					"Errors"
					"HttpDispatcher"
				]

				metrics = {
					"MetricsReported" = {
						mName = "Agent/MetricsReported/count"
					}
					"Errors" = {
						mName = "Errors/all"
					}
					"HttpDispatcher" = {
						mName = "HttpDispatcher"
					}
				}
			}
		}
  }

Here are all the sections underneath tasks.metricsCopier:

enabled (default: false) - set to true so you can use this task
dest.account - where you want to publish the results (needs to match the name of an account from the accounts section)
dest.eventType - name of the eventType in Insights for the created events
source.account - where you will query for data (needs to match the name of an account from the accounts section)
source.applicationList - array of applications you will use (names must match below)
source.applications - object with the application names and appIds, note the syntax required
source.metricList - array of metrics you will use (names must match below)
source.metrics - object with the metric short names and long names, note the syntax required

Synthetics Copier Task

TBD

API Details

There are multiple API systems involved, these tables have additional details.

APIs Supported

Type	Status	Description
Rest v2 API (not Alerts)	Partial	Query apps, metric names and data and POST to Plugins
Rest v2 API (Alerts)	Not supported yet	Broke out Alerts separately, it's a large set of APIs
Insights API	Partial	The query and insert calls are supported
Synthetics API	Not supported yet	CRUD functionality for Synthetic Monitors

APIs To Do

Type	Description
Rest v2 API (not Alerts)	Need to add support for other endpoints (Mobile, Browser, Alerts, etc.)
Rest v2 API (Alerts)	Need all capabilities
Insights API	Needs an ability to potentially return results as DAO
Synthetics API	Need all capabilities

Deprecated / Will Not Support

Servers
Legacy Alert Policies
Legacy Notification Channels

rjusselrelic / newrelic-api-client-java