newrelicapi
v0.0.3
Published
Simple NewRelic API Wrapper
Downloads
8
Readme
NewRelic API wrapper for nodejs
node-newrelicapi is a simple API wrapper for the NewRelic API written in nodejs.
Installation
npm install newrelicapi
Usage
var newrelic = require('newrelicapi');
newrelic.setAccountId(ACCOUNT_ID_HERE);
newrelic.setApiKey(APIKEY_HERE)
newrelic.getApplications(function(err, apps){
if (err) {
console.log(err);
}else{
console.log(apps);
}
});
Tests
Tests use the vows project. To run them:
npm install --dev
npm test
Todo
- Add inline documentation/comments for methods
- Add more tests
- Add better handling of failures returned from the API
- Currently I just ignore the status code returned and pass through the body. That kind of sucks and it'd be better to return a helpful error.
- Add remaining APIs
- Deployments
- Add re and limit to metric names request
- You can filter the list of metric names using a regular expression parameter (re).
- You can limit the list of metric names using limit.
Contributing
Fork the repo, create a branch, and submit a pull request.
License
Copyright [2012] [Phil Kates]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.