new_relic_rest_client
This is a ruby client to access the new relic API.
Installation
Add this line to your application's Gemfile:
gem 'new_relic_rest_client'
And then execute:
$ bundle
Or install it yourself as:
$ gem install new_relic_rest_client
Usage
First set your api key like so:
NRRC.api_key = "23423423948239040jf0asdfjsdjifnasdkhlbashbfasfb"
Then make a request for data.
puts NRRC::Routes::Applications.list
puts NRRC::Routes::Applications.show "23423423"
you can also pass in params
puts NRRC::Routes::Applications.list({"filter[ids]" => ["23423423"]})
It does support updating,creating and deleting in the same way
##Function listing
Here's the list of functions and there arguments, grouped by route.
Applications
NRRC::Routes::Applications
list params={}
show app_id
update app_id, data={}
delete app_id
metric_names app_id, params={}
metric_data app_id, params={}
event_list app_id, params={}
event_show app_id,event_id
event_close app_id, event_id
create_event app_id, data={}
downtime_list app_id, params={}
downtime_show app_id,event_id
Application Hosts
NRRC::Routes::Application_Hosts
list app_id, params={}
show app_id, host_id
metric_names app_id, host_id, params={}
metric_data app_id, host_id, params={}
Application Instances
NRRC::Routes::Application_Instances
list app_id, params={}
show app_id, instance_id
metric_names app_id, instance_id, params={}
metric_data app_id, instance_id, params={}
Mobile Applications
NRRC::Routes::Mobile_applications
list params={}
show app_id
metric_names app_id, params={}
metric_data app_id, params={}
Browser Applications
NRRC::Routes::Browser_Applications
list params={}
create data={}
Key Transactions
NRRC::Routes::Key_Transactions
list app_id, params={}
show app_id
Servers
NRRC::Routes::Servers
list params={}
show app_id
update app_id, data={}
delete app_id
metric_names app_id, params={}
metric_data app_id, params={}
Notification Channels
NRRC::Routes::Notification_Channels
list params={}
show app_id
Users
NRRC::Routes::Servers
list params={}
show app_id
reset_password user_id
Plugins
NRRC::Routes::Plugins
list params={}
show plugin_id
Components
NRRC::Routes::Components
list params={}
show component_id
Labels
NRRC::Routes::Labels
list params={}
create data
delete label_id
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
- Fork it ( https://github.com/[my-github-username]/new_relic_rest_client/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request