yeller_node
- Don't use this, it's now depreciated*
- Use the official yellerapp package - https://www.npmjs.com/package/yeller_node / https://www.npmjs.com/package/yeller_node *
Yeller notifier for node.js
Get started: report errors to yeller in 30 seconds
var yeller = var yellerClient = yelleryellerClient;
Including additional information
Often you'll want to include more information about what was going on when the error happened
yellerClient;
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, etcurl
(http only): the url of the http request that caused this errorcustomData
: 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 toproduction
, but you might want to change it tostaging
,development
, ortest
etchost
: a string that denotes which server the error happened on. By defaultyeller_node
reads this fromos.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 = { console; } { console; };var yellerClient = ;
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, tcrayford@yellerapp.com.
Bug Reports And Contributions
Think you've found a bug? Sorry about that. Please open an issue on Github, or email me at tcrayford@yellerapp.com and I'll check it out as soon as possible.