New Relic API

A Java client library for the New Relic Monitoring and Alerting REST APIs built using Jersey and Gson. The library implements over 110 operations across all of the available 35 New Relic services. It is primarily used by applications to automate the configuration of New Relic Monitoring, Alerting and Dashboards, but can also be used for extracting incident and metric data, executing Insights queries, and uploading plugin metrics.

The following New Relic APIs are currently supported:

REST v2 API

• Alerts Channels (List, Create, Delete)
• Alerts Policies (List, Create, Update, Delete)
• Alerts Policy Channels (Update, Delete)
• Alerts Conditions (List, Create, Update, Delete)
• Alerts Entity Conditions (List, Add, Remove)
• Alerts NRQL Conditions (List, Create, Update, Delete)
• Alerts External Service Conditions (List, Create, Update, Delete)
• Alerts Plugins Conditions (List, Create, Update, Delete)
• Alerts Synthetics Conditions (List, Create, Update, Delete)
• Alerts Infrastructure Conditions (List, Create, Update, Delete)
• Alerts Events (List)
• Alerts Violations (List)
• Alerts Incidents (List)
• Applications (List, Show, Update, Delete, Metric Names, Metric Data)
• Application Hosts (List, Show, Metric Names, Metric Data)
• Application Instances (List, Show, Metric Names, Metric Data)
• Browser Applications (List, Create)
• Mobile Applications (List, Show, Metric Names, Metric Data)
• Key Transactions (List, Show)
• Plugins (List, Show)
• Plugin Components (List, Show, Metric Names, Metric Data)
• Servers (List, Show, Update, Delete, Metric Names, Metric Data)
• Deployments (List, Create, Delete)
• Labels (List, Create, Delete)
• Users (List, Show, Reset Password)
• Usages (List)
• Dashboards (List, Show, Create, Update, Delete)

Synthetics v1/v3 API

• Monitors (List, Show, Show Script, Create, Update, Update Script, Patch, Delete)
• Labels (List, Create, Delete)
• Locations (List)

Plugins v1 API

• Plugin Metrics (Metric Data)

Insights v1 API

• Query (List)

Partner v2 API

• Accounts (List, Show, Create, Update, Delete)
• Users (List, Create, Update, Delete)
• Subscriptions (List, Show, Create)

Examples

A detailed set of examples of the usage of each of the APIs can be found on the API site.

Prerequisites

A New Relic account with an Admin user. The user needs to generate an Admin API Key to provide read-write access via the New Relic REST APIs. The Admin API Key is referenced in the documentation as the parameter "YOUR_API_KEY".

Other keys:

• For executing Insights queries, the Account ID is required and a Query key will need to be generated.
  • The Account ID is referenced in the documentation as the parameter "YOUR_ACCOUNT_ID".
  • The Query Key is referenced in the documentation as the parameter "YOUR_QUERY_KEY".
• For sending Plugins metrics, the main license key for the account is required.
  • The License Key is referenced in the documentation as the parameter "YOUR_LICENSE_KEY".
• For executing Partner API operations, the Partner ID is required and a Partner API key will need to be generated.
  • The Partner ID is referenced in the documentation as the parameter "YOUR_PARTNER_ID".
  • The Partner API Key is referenced in the documentation as the parameter "YOUR_PARTNER_ACCOUNT_KEY".

Installing

First clone the repository using:

>$ git clone https://github.com/opsmatters/newrelic-api.git
>$ cd newrelic-api

To compile the source code, run all tests, and generate all artefacts (including sources, javadoc, etc):

mvn package -Dnewrelic.api_key="<YOUR_API_KEY>" -Dnewrelic.query_key="<YOUR_QUERY_KEY>" -Dnewrelic.license_key="<YOUR_LICENSE_KEY>" -Dnewrelic.account_id="<YOUR_ACCOUNT_ID>"

Running the tests

To execute the unit tests:

mvn clean test -Dnewrelic.api_key="<YOUR_API_KEY>" -Dnewrelic.query_key="<YOUR_QUERY_KEY>" -Dnewrelic.license_key="<YOUR_LICENSE_KEY>" -Dnewrelic.account_id="<YOUR_ACCOUNT_ID>"

The following tests are included:

• AlertServicesTest: Creates several alert channels, an alert policy with several conditions and then deletes them.
• ApplicationServicesTest: Creates or gets several types of applications, and then carries out various operations on them.
• UserServicesTest: Gets the users for an account.
• UsageServicesTest: Gets the usages for a product.
• SyntheticsServicesTest: Creates several types of monitors, adds labels to them, and then deletes them. Also gets the list of locations.
• InsightsServicesTest: Executes an NRQL query and then parses the result.
• PluginsServicesTest: Sends a set of plugin metric timeslices to New Relic.
• DashboardsServicesTest: Creates several dashboards, updates them, lists them, and then deletes them.

Deployment

The build artefacts are hosted in The Maven Central Repository.

Add the following dependency to include the artefact within your project:

<dependency>
  <groupId>com.opsmatters</groupId>
  <artifactId>newrelic-api</artifactId>
  <version>1.0.11</version>
</dependency>

Built With

• Jersey - RESTful Web Services in Java
• Gson - Java serialization/deserialization library
• Guava - An open-source set of common libraries for Java
• Maven - Dependency Management
• JUnit - Unit testing framework

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

This project use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Gerald Curley - Initial work - opsmatters

See also the list of contributors who participated in this project.

License

This project is licensed under the terms of the Apache license 2.0.

_{Copyright (c) 2018 opsmatters}