https://github.com/opsmatters/opsmatters-core
Java library for the opsmatters suite including a data cache for New Relic Monitoring and Alerting, models, and reporting utilities.
https://github.com/opsmatters/opsmatters-core
java java-library monitoring newrelic opsmatters
Last synced: 9 months ago
JSON representation
Java library for the opsmatters suite including a data cache for New Relic Monitoring and Alerting, models, and reporting utilities.
- Host: GitHub
- URL: https://github.com/opsmatters/opsmatters-core
- Owner: opsmatters
- License: apache-2.0
- Created: 2018-01-26T23:03:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-13T20:53:29.000Z (about 8 years ago)
- Last Synced: 2025-07-29T17:16:33.315Z (11 months ago)
- Topics: java, java-library, monitoring, newrelic, opsmatters
- Language: Java
- Homepage: http://opsmatters.github.io
- Size: 226 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpsMatters Core
[](https://travis-ci.org/opsmatters/opsmatters-core)
[](https://maven-badges.herokuapp.com/maven-central/com.opsmatters/opsmatters-core)
[](http://javadoc.io/doc/com.opsmatters/opsmatters-core)
Java library for the opsmatters suite including a data cache for New Relic Monitoring and Alerting, models, and reporting utilities.
## Examples
To obtain a New Relic cache instance containing all the static configuration:
```
NewRelicCache cache = NewRelicCache.builder()
.apiKey("")
.alerts(true)
.apm(true)
.mobile(true)
.browser(true)
.synthetics(true)
.insights(true)
.servers(true)
.plugins(true)
.infrastructure(true)
.build();
```
Next, create a manager to synchronise the cache with New Relic by importing all resources for the enabled products:
```
ProviderManager manager = ProviderFactory.getManager(Provider.NEW_RELIC);
boolean success = manager.sync(cache);
```
Once the cache has been populated, it can be queried for the resources and collections it contains. Here are some examples:
* To query the alert channels:
```
Collection channels = cache.alertChannels().list();
```
* To query the alert policies:
```
Collection policies = cache.alertPolicies().list();
```
* To query the APM alert conditions for a particular alert policy:
```
Collection conditions = cache.alertPolicies().alertConditions(policy.getId()).list()
```
* To query the Infrastructure alert conditions for a particular alert policy:
```
Collection infraConditions = cache.alertPolicies().infraAlertConditions(policy.getId()).list()
```
* To query the dashboards:
```
Collection dashboards = cache.dashboards().list();
```
## Prerequisites
A New Relic account with an Admin user.
The user needs to generate an [Admin API Key](https://docs.newrelic.com/docs/apis/rest-api-v2/getting-started/api-keys)
to provide read-write access via the [New Relic REST APIs](https://api.newrelic.com).
The Admin API Key is referenced in the documentation as the parameter "YOUR_API_KEY".
## Installing
First clone the repository using:
```
>$ git clone https://github.com/opsmatters/opsmatters-core.git
>$ cd opsmatters-core
```
To compile the source code, run all tests, and generate all artefacts (including sources, javadoc, etc):
```
mvn package
```
## Running the tests
To execute the unit tests:
```
mvn clean test
```
The following tests are included:
* ProviderTest: Creates a full NewRelicCache with all the available configuration items and then creates some test reports for the objects in a variety of formats.
## Deployment
The build artefacts are hosted in The Maven Central Repository.
Add the following dependency to include the artefact within your project:
```
com.opsmatters
opsmatters-core
1.0.2
```
## Built With
* [newrelic-api](https://github.com/opsmatters/newrelic-api) - Java client library for the New Relic Monitoring and Alerting REST APIs
* [docx4j](https://www.docx4java.org/trac/docx4j) - Java library for creating and manipulating Microsoft Open XML files
* [jxl](http://jexcelapi.sourceforge.net/) - Java API enabling developers to read, write, and modify Excel spreadsheets
* [opencsv](http://opencsv.sourceforge.net/) - CSV parser library for Java
* [Maven](https://maven.apache.org/) - Dependency Management
* [JUnit](http://junit.org/) - Unit testing framework
## Contributing
Please read [CONTRIBUTING.md](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
This project use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/opsmatters/opsmatters-core/tags).
## Authors
* **Gerald Curley** - *Initial work* - [opsmatters](https://github.com/opsmatters)
See also the list of [contributors](https://github.com/opsmatters/opsmatters-core/contributors) who participated in this project.
## License
This project is licensed under the terms of the [Apache license 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
Copyright (c) 2018 opsmatters