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.
npm install opbeat-http-client
var opbeatHttpClient =appId: '...'organizationId: '...'secretToken: '...'userAgent: '...'opbeatHttpClient
The module exposes an initialize function which takes a single options hash as the 1st argument. All properties are required:
appId- The Opbeat app id
organizationId- The Opbeat organization id
secretToken- The Opbeat secret token
userAgent- 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)
The Opbeat intake API v1 currently support the following two endpoints:
The full URL's for those are:
When specifying the
endpoint argument in the
method, you just have to specify that last part of the URL, e.g.
An optional object that you can use to supply custom headers that should be sent to the Opbeat intake API.
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)