opbeat-http-client
A low-level HTTP client for communicating with the Opbeat intake API.
This module is meant for building other modules that needs to
communicate with Opbeat.
If you are looking to use Opbeat in your app or website, you'd most
likely want to check out the official Opbeat module for
Node.js instead.
Installation
npm install opbeat-http-client
Example Usage
var opbeatHttpClient = require('opbeat-http-client')({
appId: '...',
organizationId: '...',
secretToken: '...',
userAgent: '...'
})
opbeatHttpClient.request('errors', body, function (err, res, body) {
if (err) throw err
console.log(body)
})
API
The module exposes an initialize function which takes a single options
hash as the 1st argument. All properties are required:
appId
- The Opbeat app idorganizationId
- The Opbeat organization idsecretToken
- The Opbeat secret tokenuserAgent
- The HTTP user agent that your module should identify it
self with
The init function will return a low level HTTP client primed for
communicating with the Opbeat intake API.
client.request(endpoint, [headers], body, callback)
endpoint
The Opbeat intake API v1 currently support the following two endpoints:
The full URL's for those are:
https://intake.opbeat.com/api/v1/organizations/<organization-id>/apps/<app-id>/<endpoint>/
When specifying the endpoint
argument in the client.request()
method, you just have to specify that last part of the URL, e.g.
"releases".
An optional object that you can use to supply custom headers that should
be sent to the Opbeat intake API.
body
The body should be in the form of a JavaScript object literal. The
opbeat-http-client will take care of encoding it correctly.
callback
The callback function is called with 3 arguments:
- An error when applicable (usually from the http.ClientRequest object)
- An http.IncomingMessage object
- The response body (as a String)
License
MIT