Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bharat23/newrelic-api-parser
A python-based package to use New Relic APIs
https://github.com/bharat23/newrelic-api-parser
apm newrelic python3
Last synced: about 1 month ago
JSON representation
A python-based package to use New Relic APIs
- Host: GitHub
- URL: https://github.com/bharat23/newrelic-api-parser
- Owner: Bharat23
- License: mit
- Created: 2020-04-17T18:24:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T09:35:33.000Z (about 2 years ago)
- Last Synced: 2024-11-17T17:52:56.961Z (about 2 months ago)
- Topics: apm, newrelic, python3
- Language: Python
- Homepage: https://pypi.org/project/newrelic-api-parser/
- Size: 53.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# New Relic API Parser
- ## [Getting Started](#getting-started)
* [Prerequiste](#prerequiste)
* [Installation](#installation)
* [Examples](#example)
- ## [Available Methods](#available-methods)
- ## [Reference](#reference)
## Getting Started
- ### Prerequisites
- Python >= 3.6.x
- pip
- ### Installation
```
$ pip install newrelic-api-parser
```
- ### Examples
- Calling the insights API
```
# import the class
from NewRelicApiParser.Insights import Insights
query_key = 'NRIQ-xxxxxxxxxxxxxxxxxxxx'
# Call the api by passing the query key
# pass the account ID and the query you want to execute
Insights(query_key=query_key)
.query(, nrql='SELECT * from PageView')
```
### Available Methods
- For REST APIs
| Class | Method | Params | Description |
| --- | --- | --- | --- |
| AlertsConditions | get_list | policy_id | return the list of alert conditions for the provided policy id
| AlertsEvents | get_list | N.A. | return the list of alert events
| AlertsPolicies | get_list | N.A. | return the list of policies for the alerts
| AlertsViolation | get_list | N.A. | return the list of alert violations
| Applications | get_list | N.A. | return the list of apm applications
| Applications | show | app_id | returns the detail of an application based on the app id passed
| Applications | delete | app_id | delete an apm app on new relic based on the app id passed
| BrowserApplications | get_list | N.A. | return the list of browser applications
| BrowserApplications | create | browser_application_name | returns the detail of a browser application based on the application name passed
| Plugins | get_list | N.A. | return the list of plugins
| Plugins | show | app_id | returns the detail of a plugin based on the app id passed
- For Insights API
| Module | Method | Params | Description
| --- | --- | --- | --- |
| Insights | query | account_id, nrql | execute the passed new relic query and return the data
- For GraphQl API
| Module | Method | Params | Description
| --- | --- | --- | --- |
| GraphQlApi | query | request_body | execute the passed new relic graph ql query and return the data
## Reference
- Please refer the [official New Relic Documentation](https://docs.newrelic.com/docs/apis/rest-api-v2/getting-started/introduction-new-relic-rest-api-v2) for more details on the endpoints
### Note:
- The package is under development and will be prone to more frequent updates