ykyuen / pyrelic

New Relic Python API

About this forked repository

Thanks andrewgross for writing the pyrelic package for New Relic API v1. I was working on the monitoring project and the metrics i need is only available on New Relic API v2. So I have added few functions in this forked repository.

Please refer to the following functions in client.py. It could give u some hints on how to make the query.

• get_metric_data_v2
• get_instance_ids_v2
• get_applications_summary_v2
• get_servers_summary_v2
• get_server_metric_data_v2
• get_instances_summary_v2
• get_instance_metric_data_v2

The above functions are constructed base on the available endpoints in the New Relic API Explorer. It's good to make your data query in the explorer first before coding.

Since the code i have added is not generic enough, i may try to reconstruct the code pattern later if i have time. Please feel free to comment or work together until the code is good enough for sending a pull request.

---

Pyrelic

A New Relic client library written in Python.

While New Relic's documentation for their API is very solid, the usage details are pretty sparse and biased toward the Rails Active Resource helper library.

The documentation in this library's docstrings was derived from the New Relic Ruby API.

Installation

$ pip install https://github.com/ykyuen/pyrelic/archive/master.zip

Examples

Setup

from pyrelic import Client
from time import sleep
c = Client(account_id='XXX', api_key='XXXXXX')

Get some metric data

metrics = c.get_metric_data(['My Application'], ['Database/my_table/select', 'Database/my_table/update'], ['average_value'], '2012-03-28T15:48:00Z', '2012-03-29T15:48:00Z')

for metric in metrics:
    if "select" in metric.name:
        print "Average Select Time: {}".format(metric.average_value)
    if  "update" in metric.name:
        print "Average Update Time: {}".format(metric.average_value)

Handle API rate limiting

try:
    metrics = c.get_metric_data(['My Application'], ['Database/my_table/select', 'Database/my_table/update'], ['average_value'], '2012-03-28T15:48:00Z', '2012-03-29T15:48:00Z')
except NewRelicApiRateLimitException as e:
    sleep(e.timeout)

List some metrics

metrics = c.get_metric_list('123456', re='Database')
for k,v in metrics.iteritems():
    print "Metric Name: {}".format(k)
    print "Available Fields: {}".format(v)

Figure out what applications you have

applications = c.view_applications()
for application in applications:
    print "Name: {}".format(application.name)
    print "ID: {}".format(application.app_id)
    print "URL: {}".format(application.url)

Delete applications (careful!)

failed_deletions = c.delete_applications( {'app_id': 1234, 'app': 'My Application'})
if len(failed_deletions) is 0:
    print "All applications deleted succesfully!"

View servers

servers = c.view_servers()
for server in servers:
    print "Hostname: {}".format(server.hostname)
    print "Server ID: {}".format(server.server_id)
    print "Overview URL: {}".format(server.overview_url)

Delete Servers

failed_deletion = c.delete_servers("server_id")
if len(failed_deletions) is 0:
    print "Server deleted succesfully!"

Notify Deployments by ID

response = c.notify_deployment(application_id=123, description='description',
                                 revision='1.2.3', user='stevemac',
                                 changelog='orange')
print response['timestamp']

Notify Deployments by ID

response = c.notify_deployment(application_name="iMyFace.ly", description='description',
                                 revision='1.2.3', user='stevemac',
                                 changelog='orange')
print response['timestamp']