Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 2.81 KB

README.markdown

File metadata and controls

67 lines (48 loc) · 2.81 KB
Raw

yeller_node

Yeller notifier for node.js

Get started: report errors to yeller in 30 seconds

var yeller = require('./yeller_node')
var yellerClient = yeller.client({token: 'YOUR_API_TOKEN_HERE'})
yellerClient.report(new Error('an message'));

Including additional information

Often you'll want to include more information about what was going on when the error happened

yellerClient.report(new Error('an message'),
 {location: 'myhandler', url: 'http://example.com'
  customData: {userID: 1}});

Here are the available options that you can pass to report to give additional information:

  • location: the name of what kind of program was running when this error happened. For http requests, this might be the name of the handler, for background jobs, the name of the job, etc
  • url (http only): the url of the http request that caused this error
  • customData: this is an arbitrary JSON hash of any information you want to send along with the error. Typical suspects: http params, http session, current job params, data about the currently logged in user, etc

Alongside options to report, you can pass some other options to client:

  • applicationEnvironment: a string that denotes what kind of environment the application is running in. This defaults to production, but you might want to change it to staging, development, or test etc
  • developmentEnvironments: an array of environments in which yeller should ignore errors. This lets you use yeller in your production code without it reporting errors when your tests fail etc.
  • host: a string that denotes which server the error happened on. By default yeller_node reads this from os.hostname.

Error Handling

yeller_node (like all other supported yeller clients) does smart retrying when nodes fail- so if one of yeller's backend servers is down, you won't lose errors.

For detecting when an error happens whilst yeller is reporting an error, you can pass errorHandler to client like so:

var errorHandler = {
    ioError: function (err) {
                console.log(err);
            },
    authError: function (err) {
                console.log(err);
            },
};
var yellerClient = client({
  token: 'YOUR_API_TOKEN_HERE',
  errorHandler: errorHandler
});

This will log yeller errors to stdout. ioError happens when there's a failure talking to yeller's backend, authError happens when your yeller API token is invalid.

Questions

If you have any questions, feel free to shoot me an email, [email protected].

Bug Reports And Contributions

Think you've found a bug? Sorry about that. Please open an issue on Github, or email me at [email protected] and I'll check it out as soon as possible.