Ratchetio NPM | npm.io

ratchetio

Generic library for reporting exceptions and other messages to Ratchet.io. Requires a Ratchet.io account.

// include and initialize the ratchet library with your access token
var ratchet = require("ratchetio");
ratchet.init("ACCESS_TOKEN");

// record a generic message and send to ratchet.io
ratchet.reportMessage("Hello world!");

Installation

Install using the node package manager, npm:

$ npm install --save ratchetio

Configuration

Using Express

var express = require('express');
var ratchet = require('ratchetio');

var app = express();

app.get('/', function(req, res) {
  // ...
});

// Use the ratchet error handler to send exceptions to your ratchet.io account
app.use(ratchet.errorHandler('RATCHET_ACCESS_TOKEN'));

app.listen(6943);

Standalone

In your main application, require and initialize using your access_token::

var ratchet = require("ratchetio");
ratchet.init("ACCESS_TOKEN");

Other options can be passed into the init() function using a second parameter. E.g.:

// Queue up and report messages/exceptions to ratchet every 5 seconds
ratchet.init("ACCESS_TOKEN", {handler: "setInterval", handlerInterval: 5});

When you are finished using ratchet, clean up any remaining items in the queue using the shutdown function:

ratchet.shutdown();

Configuration reference

ratchet.init() takes the following configuration options (pass in the second parameter):

host: The hostname of the server the node.js process is running on
default: os.hostname()
environment: The environment the code is running in.
default: production
handler: The method that the notifier will use to report exceptions.
Supported values:
- setInterval -- all items that are queued up are sent to ratchet.io in batches in a setInterval callback
- nextTick -- all items that are queued up are sent to ratchet.io in a process.nextTick callback
- inline -- items are sent to ratchet.io as they are queued up, one at-a-time
  default: setInterval
handlerInterval: If the handler is setInterval, this is the number of seconds between batch posts of items to ratchet.io.
default: 3
batchSize: The max number of items sent to ratchet.io at a time.
default: 10
endpoint: The Ratchet.io API base url.
default: https://submit.ratchet.io/api/1/
root: The path to your code, (not including any trailing slash) which will be used to link source files on ratchet.io.
e.g. /Users/bob/Development
branch: The branch in your version control system for this code
e.g. master