rollbar - npm Package Compare versions
Comparing version 0.2.4 to 0.2.5
@@ -13,3 +13,3 @@ { | ||
| ], | ||
| "version": "0.2.4", | ||
| "version": "0.2.5", | ||
| "repository": "git://github.com/rollbar/node_rollbar.git", | ||
@@ -16,0 +16,0 @@ "author": "Cory Virok <cory@rollbar.com>", |
@@ -1,9 +0,13 @@ | ||
| # rollbar [](https://travis-ci.org/rollbar/node_rollbar) | ||
| # Rollbar notifier for Node.js [](https://travis-ci.org/rollbar/node_rollbar) | ||
| Generic library for reporting exceptions and other messages to [Rollbar](https://rollbar.com). Requires a Rollbar account. | ||
| <!-- Sub:[TOC] --> | ||
| ##Quick start | ||
| ```js | ||
| // include and initialize the rollbar library with your access token | ||
| var rollbar = require("rollbar"); | ||
| rollbar.init("ACCESS_TOKEN"); | ||
| rollbar.init("POST_SERVER_ITEM_ACCESS_TOKEN"); | ||
@@ -37,3 +41,3 @@ // record a generic message and send to rollbar | ||
| // Use the rollbar error handler to send exceptions to your rollbar account | ||
| app.use(rollbar.errorHandler('ROLLBAR_ACCESS_TOKEN')); | ||
| app.use(rollbar.errorHandler('POST_SERVER_ITEM_ACCESS_TOKEN')); | ||
@@ -50,3 +54,3 @@ app.listen(6943); | ||
| var rollbar = require("rollbar"); | ||
| rollbar.init("ACCESS_TOKEN"); | ||
| rollbar.init("POST_SERVER_ITEM_ACCESS_TOKEN"); | ||
| ``` | ||
@@ -58,3 +62,3 @@ | ||
| // Queue up and report messages/exceptions to rollbar every 5 seconds | ||
| rollbar.init("ACCESS_TOKEN", {handler: "setInterval", handlerInterval: 5}); | ||
| rollbar.init("POST_SERVER_ITEM_ACCESS_TOKEN", {handler: "setInterval", handlerInterval: 5}); | ||
| ``` | ||
@@ -73,46 +77,63 @@ | ||
| - **host**: The hostname of the server the node.js process is running on | ||
| _default:_ `os.hostname()` | ||
| <dl> | ||
| <dt>host</dt> | ||
| <dd>The hostname of the server the node.js process is running on. | ||
| - **environment**: The environment the code is running in. | ||
| Default: `os.hostname()` | ||
| </dd> | ||
| <dt>environment</dt> | ||
| <dd>The environment the code is running in. | ||
| _default:_ `production` | ||
| Default: `'production'` | ||
| </dd> | ||
| <dt>handler</dt> | ||
| <dd>The method that the notifier will use to report exceptions. | ||
| Supported values: | ||
| - **handler**: The method that the notifier will use to report exceptions. | ||
| - setInterval -- all items that are queued up are sent to rollbar in batches in a setInterval callback | ||
| - NOTE: using this mode will mean that items are queued internally before being sent. For applications that send a very large amount of items, it is possible to use up too much memory and crash the node process. If this starts to happen, try lowering the handlerInterval setting or switch to a different handler, e.g. 'nextTick'. | ||
| - nextTick -- all items that are queued up are sent to rollbar in a process.nextTick callback | ||
| - inline -- items are sent to rollbar as they are queued up, one at-a-time | ||
| Supported values: | ||
| Default: `setInterval` | ||
| </dd> | ||
| <dt>handlerInterval</dt> | ||
| <dd>If the handler is `setInterval`, this is the number of seconds between batch posts of items to rollbar. | ||
| - setInterval -- all items that are queued up are sent to rollbar in batches in a setInterval callback | ||
| - NOTE: using this mode will mean that items are queued internally before being sent. For applications that send a very large amount of items, it is possible to use up too much memory and crash the node process. If this starts to happen, try lowering the handlerInterval setting or switch to a different handler, e.g. 'nextTick'. | ||
| - nextTick -- all items that are queued up are sent to rollbar in a process.nextTick callback | ||
| - inline -- items are sent to rollbar as they are queued up, one at-a-time | ||
| Default: `3` | ||
| </dd> | ||
| <dt>batchSize</dt> | ||
| <dd>The max number of items sent to rollbar at a time. | ||
| _default:_ `setInterval` | ||
| Default: `10` | ||
| </dd> | ||
| <dt>endpoint</dt> | ||
| <dd>The rollbar API base url. | ||
| - **handlerInterval**: If the handler is `setInterval`, this is the number of seconds between batch posts of items to rollbar. | ||
| Default: `'https://api.rollbar.com/api/1/'` | ||
| </dd> | ||
| <dt>root</dt> | ||
| <dd>The path to your code, (not including any trailing slash) which will be used to link source files on Rollbar. | ||
| _default:_ `3` | ||
| e.g. `'/Users/bob/Development'` | ||
| </dd> | ||
| <dt>branch</dt> | ||
| <dd>The branch in your version control system for this code. | ||
| - **batchSize**: The max number of items sent to rollbar at a time. | ||
| e.g. `'master'` | ||
| </dd> | ||
| <dt>scrubFields</dt> | ||
| <dd>List of field names to scrub out of POST. Values will be replaced with astrickses. If overriding, make sure to list all fields you want to scrub, not just fields you want to add to the default. Param names are converted to lowercase before comparing against the scrub list. | ||
| _default:_ `10` | ||
| Default: `['passwd', 'password', 'secret', 'confirm_password', 'password_confirmation']` | ||
| </dd> | ||
| - **endpoint**: The rollbar API base url. | ||
| _default:_ `https://api.rollbar.com/api/1/` | ||
| - **root**: The path to your code, (not including any trailing slash) which will be used to link source files on rollbar. | ||
| e.g. `/Users/bob/Development` | ||
| - **branch**: The branch in your version control system for this code | ||
| e.g. `master` | ||
| - **scrubFields**: List of field names to scrub out of POST. Values will be replaced with astrickses. If overriding, make sure to list all fields you want to scrub, not just fields you want to add to the default. Param names are converted to lowercase before comparing against the scrub list. | ||
| _default:_ `['passwd', 'password', 'secret', 'confirm_password', 'password_confirmation']` | ||
| ## Contributing | ||
@@ -119,0 +140,0 @@ |
@@ -128,3 +128,27 @@ var util = require('util'); | ||
| /* | ||
| * reportMessageWithPayloadData(message, payloadData, request, callback) | ||
| * | ||
| * The same as reportMessage() but allows you to specify extra data along with the message. | ||
| * | ||
| * Parameters: | ||
| * message - a string to send to rollbar | ||
| * payloadData - an object containing key/values to be sent along with the message. | ||
| * e.g. {level: "warning", fingerprint: "CustomerFingerPrint"} | ||
| * request - optional request object to send along with the message | ||
| * callback - optional callback that will be invoked depending on the handler method used. | ||
| * Should take a single parameter to denote if there was an error. | ||
| * | ||
| * Examples: | ||
| * | ||
| * rollbar.reportMessageWithPayloadData("Memcache miss", | ||
| * {level: "debug", fingerprint: "Memcache-miss"}, null, function(err) { | ||
| * // message was queued/sent to rollbar | ||
| * }); | ||
| * | ||
| */ | ||
| exports.reportMessageWithPayloadData = notifier.reportMessageWithPayloadData; | ||
| /* | ||
| * handleError(err, request, callback) | ||
@@ -131,0 +155,0 @@ * |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by3.15%
37372
- Lines of code
- increased by2.36%
954
- Number of lines in readme file
- increased by16.54%
148
No dependency changes