New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@airbrake/node
Advanced tools
@airbrake/node - npm Package Compare versions
Comparing version 1.1.0-beta.2 to 1.1.0
| export declare const NOTIFIER_NAME = "airbrake-js/node"; | ||
| export declare const NOTIFIER_VERSION = "1.1.0-beta.2"; | ||
| export declare const NOTIFIER_VERSION = "1.1.0"; | ||
| export declare const NOTIFIER_URL = "https://github.com/airbrake/airbrake-js/tree/master/packages/node"; |
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| exports.NOTIFIER_NAME = 'airbrake-js/node'; | ||
| exports.NOTIFIER_VERSION = '1.1.0-beta.2'; | ||
| exports.NOTIFIER_VERSION = '1.1.0'; | ||
| exports.NOTIFIER_URL = 'https://github.com/airbrake/airbrake-js/tree/master/packages/node'; | ||
| //# sourceMappingURL=version.js.map |
| export declare const NOTIFIER_NAME = "airbrake-js/node"; | ||
| export declare const NOTIFIER_VERSION = "1.1.0-beta.2"; | ||
| export declare const NOTIFIER_VERSION = "1.1.0"; | ||
| export declare const NOTIFIER_URL = "https://github.com/airbrake/airbrake-js/tree/master/packages/node"; |
| export var NOTIFIER_NAME = 'airbrake-js/node'; | ||
| export var NOTIFIER_VERSION = '1.1.0-beta.2'; | ||
| export var NOTIFIER_VERSION = '1.1.0'; | ||
| export var NOTIFIER_URL = 'https://github.com/airbrake/airbrake-js/tree/master/packages/node'; | ||
| //# sourceMappingURL=version.js.map |
| { | ||
| "name": "@airbrake/node", | ||
| "version": "1.1.0-beta.2", | ||
| "version": "1.1.0", | ||
| "description": "Official Airbrake notifier for Node.js", | ||
@@ -20,3 +20,3 @@ "author": "Airbrake", | ||
| "dependencies": { | ||
| "@airbrake/browser": "^1.1.0-beta.2", | ||
| "@airbrake/browser": "^1.1.0", | ||
| "cross-fetch": "^3.0.4", | ||
@@ -23,0 +23,0 @@ "error-stack-parser": "^2.0.4", |
176
README.md
@@ -1,14 +0,17 @@ | ||
| # Airbrake for Node.js | ||
| # Official Airbrake Notifier for Node.js | ||
| [](https://github.com/airbrake/airbrake-js/actions?query=branch%3Amaster) | ||
| [](https://www.npmjs.com/package/@airbrake/node) | ||
| This is the JavaScript notifier for capturing errors in Node.js and reporting them to [Airbrake](http://airbrake.io). For web browsers there is a [separate package](https://github.com/airbrake/airbrake-js/tree/master/packages/browser). | ||
| The official Airbrake notifier for capturing JavaScript errors in Node.js and | ||
| reporting them to [Airbrake](http://airbrake.io). If you're looking for | ||
| Node.js support there is a | ||
| [separate package](https://github.com/airbrake/airbrake-js/tree/master/packages/browser). | ||
| <img src="http://f.cl.ly/items/443E2J1D2W3x1E1u3j1u/JS-airbrakeman.jpg" width=800px> | ||
|  | ||
| ## Installation | ||
| airbrake can be installed using yarn: | ||
| Using yarn: | ||
| ```sh | ||
@@ -18,3 +21,3 @@ yarn add @airbrake/node | ||
| or using npm: | ||
| Using npm: | ||
@@ -25,13 +28,9 @@ ```sh | ||
| Example configurations can be found in [examples](examples), including: | ||
| * [Express](examples/express) | ||
| * [Node.js](examples/nodejs) | ||
| ## Basic Usage | ||
| First you need to initialize the notifier with the project id and API key taken from [Airbrake.io](https://airbrake.io): | ||
| First, initialize the notifier with the project ID and API key taken from | ||
| [Airbrake](https://airbrake.io): | ||
| ```js | ||
| import { Notifier } from '@airbrake/browser'; | ||
| const { Notifier } = require('@airbrake/node'); | ||
@@ -45,7 +44,7 @@ const airbrake = new Notifier({ | ||
| Then you can send a textual message to Airbrake: | ||
| Then, you can send a textual message to Airbrake: | ||
| ```js | ||
| let promise = airbrake.notify(`user id=${user_id} not found`); | ||
| promise.then(function(notice) { | ||
| promise.then((notice) => { | ||
| if (notice.id) { | ||
@@ -59,8 +58,7 @@ console.log('notice id', notice.id); | ||
| Or report catched errors directly: | ||
| or report errors directly: | ||
| ```js | ||
| try { | ||
| // This will throw if the document has no head tag | ||
| document.head.insertBefore(document.createElement('style')); | ||
| new Error('Hello from Airbrake!'); | ||
| } catch(err) { | ||
@@ -72,9 +70,9 @@ airbrake.notify(err); | ||
| Alternatively, you can wrap any code which may throw errors using the client's `wrap` method: | ||
| Alternatively, you can wrap any code which may throw errors using the `wrap` | ||
| method: | ||
| ```js | ||
| let startApp = function() { | ||
| // This will throw if the document has no head tag. | ||
| document.head.insertBefore(document.createElement('style')); | ||
| } | ||
| let startApp = () => { | ||
| new Error('Hello from Airbrake!'); | ||
| }; | ||
| startApp = airbrake.wrap(startApp); | ||
@@ -86,9 +84,8 @@ | ||
| or use `call` shortcut: | ||
| or use the `call` shortcut: | ||
| ```js | ||
| let startApp = function() { | ||
| // This will throw if the document has no head tag. | ||
| document.head.insertBefore(document.createElement('style')); | ||
| } | ||
| let startApp = () => { | ||
| new Error('Hello from Airbrake!'); | ||
| }; | ||
@@ -98,43 +95,124 @@ airbrake.call(startApp); | ||
| ### Node.js request and proxy | ||
| ## Example configurations | ||
| In order to use [request](https://github.com/request/request) HTTP client you can pass `request` option which accepts request wrapper: | ||
| * [Express](examples/express) | ||
| * [Node.js](examples/nodejs) | ||
| ## Advanced Usage | ||
| ### Notice Annotations | ||
| It's possible to annotate error notices with all sorts of useful information at | ||
| the time they're captured by supplying it in the object being reported. | ||
| ```js | ||
| const airbrake = new Notifier({ | ||
| ... | ||
| request: request.defaults({'proxy':'http://localproxy.com'}) | ||
| try { | ||
| startApp(); | ||
| } catch(err) { | ||
| airbrake.notify({ | ||
| error: err, | ||
| context: { component: 'bootstrap' }, | ||
| environment: { env1: 'value' }, | ||
| params: { param1: 'value' }, | ||
| session: { session1: 'value' }, | ||
| }); | ||
| throw err; | ||
| } | ||
| ``` | ||
| ### Severity | ||
| [Severity](https://airbrake.io/docs/airbrake-faq/what-is-severity/) allows | ||
| categorizing how severe an error is. By default, it's set to `error`. To | ||
| redefine severity, simply overwrite `context/severity` of a notice object: | ||
| ```js | ||
| airbrake.notify({ | ||
| error: err, | ||
| context: { severity: 'warning' } | ||
| }); | ||
| ``` | ||
| ## Contributing | ||
| ### Filtering errors | ||
| Install dependencies: | ||
| There may be some errors thrown in your application that you're not interested | ||
| in sending to Airbrake, such as errors thrown by 3rd-party libraries. | ||
| ```bash | ||
| yarn install | ||
| The Airbrake notifier makes it simple to ignore this chaff while still | ||
| processing legitimate errors. Add filters to the notifier by providing filter | ||
| functions to `addFilter`. | ||
| `addFilter` accepts the entire | ||
| [error notice](https://airbrake.io/docs/api/#create-notice-v3) to be sent to | ||
| Airbrake and provides access to the `context`, `environment`, `params`, | ||
| and `session` properties. It also includes the single-element `errors` array | ||
| with its `backtrace` property and associated backtrace lines. | ||
| The return value of the filter function determines whether or not the error | ||
| notice will be submitted. | ||
| * If `null` is returned, the notice is ignored. | ||
| * Otherwise, the returned notice will be submitted. | ||
| An error notice must pass all provided filters to be submitted. | ||
| In the following example all errors triggered by admins will be ignored: | ||
| ```js | ||
| airbrake.addFilter((notice) => { | ||
| if (notice.params.admin) { | ||
| // Ignore errors from admin sessions. | ||
| return null; | ||
| } | ||
| return notice; | ||
| }); | ||
| ``` | ||
| Run unit tests: | ||
| Filters can be also used to modify notice payload, e.g. to set the environment | ||
| and application version: | ||
| ```bash | ||
| yarn test | ||
| ```js | ||
| airbrake.addFilter((notice) => { | ||
| notice.context.environment = 'production'; | ||
| notice.context.version = '1.2.3'; | ||
| return notice; | ||
| }); | ||
| ``` | ||
| Build project: | ||
| ### Filtering keys | ||
| ```bash | ||
| yarn build | ||
| With the `keysBlacklist` option, you can specify a list of keys containing | ||
| sensitive information that must be filtered out: | ||
| ```js | ||
| const airbrake = new Notifier({ | ||
| // ... | ||
| keysBlacklist: [ | ||
| 'password', // exact match | ||
| /secret/, // regexp match | ||
| ], | ||
| }); | ||
| ``` | ||
| ## Credits | ||
| ### Node.js request and proxy | ||
| Airbrake is maintained and funded by [airbrake.io](http://airbrake.io) | ||
| To use the [request](https://github.com/request/request) HTTP client, pass | ||
| the `request` option which accepts a request wrapper: | ||
| Thank you to all [the contributors](https://github.com/airbrake/airbrake-js/contributors). | ||
| ```js | ||
| const airbrake = new Notifier({ | ||
| // ... | ||
| request: request.defaults({'proxy':'http://localproxy.com'}) | ||
| }); | ||
| ``` | ||
| The names and logos for Airbrake are trademarks of Airbrake Technologies Inc. | ||
| ### Instrumentation | ||
| # License | ||
| `@airbrake/node` attempts to automatically instrument various performance | ||
| metrics. You can disable that behavior using the `performanceStats` option: | ||
| Airbrake is Copyright © 2008-2017 Airbrake Technologies Inc. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file. | ||
| ```js | ||
| const airbrake = new Notifier({ | ||
| // ... | ||
| performanceStats: false | ||
| }); | ||
| ``` |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Fixed alerts
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by2.28%
94340
- Number of low quality alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by58.21%
212
Dependency changes
Updated@airbrake/browser@^1.1.0