{"id":13528014,"url":"https://github.com/airbrake/node-airbrake","last_synced_at":"2026-04-04T12:58:59.553Z","repository":{"id":57158004,"uuid":"2076636","full_name":"airbrake/node-airbrake","owner":"airbrake","description":"node-airbrake is no longer maintained. Please visit https://airbrake.io/docs/performance-monitoring/updating-from-deprecated-libraries-for-node/","archived":false,"fork":false,"pushed_at":"2020-04-23T15:02:30.000Z","size":494,"stargazers_count":176,"open_issues_count":0,"forks_count":70,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-04-04T12:58:48.251Z","etag":null,"topics":["airbrake-notifier","deprecated","node-airbrake","not-maintained"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/airbrake.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-07-20T07:10:10.000Z","updated_at":"2025-12-22T08:37:15.000Z","dependencies_parsed_at":"2022-08-28T21:00:21.819Z","dependency_job_id":null,"html_url":"https://github.com/airbrake/node-airbrake","commit_stats":null,"previous_names":["felixge/node-airbrake"],"tags_count":38,"template":false,"template_full_name":null,"purl":"pkg:github/airbrake/node-airbrake","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbrake%2Fnode-airbrake","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbrake%2Fnode-airbrake/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbrake%2Fnode-airbrake/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbrake%2Fnode-airbrake/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/airbrake","download_url":"https://codeload.github.com/airbrake/node-airbrake/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/airbrake%2Fnode-airbrake/sbom","scorecard":{"id":173444,"data":{"date":"2025-08-11","repo":{"name":"github.com/airbrake/node-airbrake","commit":"6da75faed6b8dc4ceab16ef33302fb38459d9afa"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 1/16 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 27 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-16T17:08:23.407Z","repository_id":57158004,"created_at":"2025-08-16T17:08:23.407Z","updated_at":"2025-08-16T17:08:23.407Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31400460,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["airbrake-notifier","deprecated","node-airbrake","not-maintained"],"created_at":"2024-08-01T06:02:10.110Z","updated_at":"2026-04-04T12:58:59.532Z","avatar_url":"https://github.com/airbrake.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"Node Airbrake\n=============\n\n[![Circle CI](https://circleci.com/gh/airbrake/node-airbrake.svg?style=shield)](https://circleci.com/gh/airbrake/node-airbrake)\n[![npm version](https://badge.fury.io/js/airbrake.svg)](https://badge.fury.io/js/airbrake)\n[![Documentation Status](http://inch-ci.org/github/airbrake/node-airbrake.svg?branch=master)](http://inch-ci.org/github/airbrake/node-airbrake)\n[![Downloads](https://img.shields.io/npm/dt/airbrake.svg)](https://www.npmjs.com/package/airbrake)\n\n**DEPRECATION WARNING: Node Airbrake is deprecated in favour of @airbrake/node\n(https://www.npmjs.com/package/@airbrake/node). Please migrate to it as soon as\npossible. See [migration guide](https://airbrake.io/docs/performance-monitoring/updating-from-deprecated-libraries-for-node/).**\n\n![Node Airbrake][arthur-node]\n\n* [Node Airbrake README][node-airbrake]\n\nIntroduction\n------------\n\n**DEPRECATION WARNING: Node Airbrake is deprecated in favour of @airbrake/node\n(https://www.npmjs.com/package/@airbrake/node). Please migrate to it as soon as\npossible.**\n\n_Node Airbrake_ is a Node.js notifier for [Airbrake][airbrake-io], the leading\nexception reporting service. The library provides minimalist API that enables\nthe ability to send _any_ Node exception to the Airbrake dashboard. Node\nAirbrake provides out-of-box integration with the Express web framework.\n\nKey features\n------------\n\n![The Airbrake Dashboard][dashboard]\n\n* Send chosen environment variables (whitelist or blacklist)\n* Detect and fix circular references in error context information\n* Support for all features of the [2.1 notification API][2.1api]\n* Support for [long-stack-traces][]\n* Optional auto-handler for `uncaughtException` events\n* Provides notification URL linking to Airbrake in `notify()` callback\n* Timeout Airbrake requests after 30 seconds, you never know\n* Express web application framework support\n* hapi web application framework support\n\nInstallation\n------------\n\n### NPM\n\nAdd the Node Airbrake package to your `package.json`:\n\n```js\n{\n  \"dependencies\": {\n    \"airbrake\": \"^2.1.3\"\n  }\n}\n```\n\n### Manual\n\nInvoke the following command from your terminal:\n\n```sh\nnpm install airbrake\n```\n\nExamples\n--------\n\n### Basic example\n\nThis is the minimal example that you can use to test Node Airbrake with your\nproject. The common use case for this module is to catch all `'uncaughtException'`\nevents on the `process` object and send them to Airbrake:\n\n```js\nvar airbrake = require('airbrake').createClient(\n  '105138', // Project ID\n  'fd04e13d806a90f96614ad8e529b2822' // Project key\n);\nairbrake.handleExceptions();\n\nthrow new Error('I am an uncaught exception');\n```\n\nNote: the above will re-throw the exception after it has been successfully\ndelivered to Airbrake, causing your process to exit with status 1.\n\nThis can optionally be disabled by passing false to `handleExceptions` (not\nrecommended):\n\n```js\nairbrake.handleExceptions(false);\n```\n\n### Filtering errors\n\nThere 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.\n\nThe 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`.\n\n`addFilter` accepts the entire [error notice](https://airbrake.io/docs/#create-notice-v3) to be sent to Airbrake, and provides access to the `context`, `environment`, `params`, and `session` values submitted with the notice, as well as the single-element `errors` array with its `backtrace` element and associated backtrace lines.\n\nThe return value of the filter function determines whether or not the error notice will be submitted.\n  * If null value is returned, the notice is ignored.\n  * Otherwise returned notice will be submitted.\n\nAn error notice must pass all provided filters to be submitted.\n\nIn the following example errors triggered with a message of 'this should not be posted to airbrake' will be ignored:\n\n```js\nairbrake.addFilter(function(notice) {\n  if (notice.errors[0].message === 'this should not be posted to airbrake') {\n    // Ignore errors with this messsage\n    return null;\n  }\n  return notice;\n});\n```\n\nFilters can be also used to modify notice payload, e.g. to set environment and application version:\n\n```js\nairbrake.addFilter(function(notice) {\n  notice.context.environment = 'production';\n  notice.context.version = '1.2.3';\n  return notice;\n});\n```\n\n### Manual error delivery\n\nIf you want more control over the delivery of your errors, you can also\nmanually submit errors to Airbrake:\n\n```js\nvar airbrake = require('airbrake').createClient(\"your project ID\", \"your api key\");\nvar err = new Error('Something went terribly wrong');\nairbrake.notify(err, function(err, url) {\n  if (err) throw err;\n\n  // Error has been delivered, url links to the error in airbrake\n});\n```\n\n### Severity\n\n[Severity](https://airbrake.io/docs/airbrake-faq/what-is-severity/) allows\ncategorizing how severe an error is. By default, it's set to `error`. To\nredefine severity, simply set an error's `severity` property. For example:\n\n```js\nvar err = new Error();\nerr.severity = 'critical';\n\nairbrake.notify(err);\n```\n\n### Express integration\n\nThe library provides out-of-box integration with the Express framework. It\nsupports even old Express versions (starting from `2.x`). Select your version\nbelow and configure accordingly.\n\n#### Express 4.x\n\n```js\nvar airbrake = require('airbrake').createClient(\"your project ID\", \"your api key\");\napp.use(airbrake.expressHandler());\n```\n\n#### Express 3.x\n\n```js\nvar airbrake = require('airbrake').createClient(\"your project ID\", \"your api key\");\napp.use(app.router);\napp.use(airbrake.expressHandler());\n```\n\n#### Express 2.x\n\n```js\nvar airbrake = require('airbrake').createClient(\"your project ID\", \"your api key\");\napp.error(airbrake.expressHandler());\n```\n\n### hapi integration\n\nThe library provides out-of-box integration with the hapi framework. To\nintegrate Airbrake with a hapi application simply install our handler:\n\n```js\nconst Hapi = require('hapi');\nconst server = new Hapi.Server();\nconst Airbrake = require('airbrake').createClient(\n  \"your project ID\",\n  \"your api key\"\n);\n\nAirbrake.env = 'production';\n\nserver.register(Airbrake.hapiHandler(), err =\u003e {\n  if (err) {\n    throw err;\n  }\n});\n```\n\nAPI\n---\n\n## Adding context to errors\n\nThe `notify()` method automatically adds the following context information to\neach delivered error:\n\n* **error.class:** (`err.type` string if set, or `'Error'`)\n* **error.message:** (`err.message` string)\n* **error.backtrace:** (`err.stack` as parsed by [stack-trace][])\n* **error.severity:** (`err.severity` defaults to `error`)\n* **request.url:** (`err.url`, see `airbrake.url`);\n* **request.component:** (`err.component` string if set);\n* **request.action:** (`err.action` string if set);\n* **request.cgi-data:** (`process.env`, merged all other properties of `err`)\n* **request.params:** (`err.params` object if set)\n* **request.session:** (`err.session` object if set)\n* **server-environment.project-root:** (`airbrake.projectRoot` string if set)\n* **server-environment.environment-name:** (`airbrake.env` string)\n* **server-environment.app-version:** (`airbrake.appVersion string if set)\n\nYou can add additional context information by modifying the error properties\nlisted above:\n\n``` javascript\nvar airbrake = require('airbrake').createClient(\"your project ID\", \"your api key\");\nvar http = require('http');\n\nhttp.createServer(function(req, res) {\n  if (req.headers['X-Secret'] !== 'my secret') {\n    var err = new Error('403 - Permission denied');\n    req.writeHead(403);\n    req.end(err.message);\n\n    err.url = req.url;\n    err.params = {ip: req.socket.remoteAddress};\n    airbrake.notify(err);\n  }\n});\n```\n\nUnfortunately `uncaughtException` events cannot be traced back to particular\nrequests, so you should still try to handle errors where they occur.\n\n[stack-trace]: https://github.com/felixge/node-stack-trace\n\n## Tracking deployments\n\nThis client supports Airbrake's [deployment tracking][]:\n\n``` javascript\nvar airbrake = require('airbrake').createClient(\"your project ID\", \"your api key\");\nvar deployment = {\n  rev: '98103a8fa850d5eaf3666e419d8a0a93e535b1b2',\n  repo: 'git@github.com:felixge/node-airbrake.git',\n};\n\nairbrake.trackDeployment(deployment, function(err, params) {\n  if (err) {\n    throw err;\n  }\n\n  console.log('Tracked deployment of %s to %s', params.rev, params.env);\n});\n```\n\nCheck out the `airbrake.trackDeployment()` API docs below for a list of all\noptions.\n\nConfiguration\n-------------\n\n### var airbrake = Airbrake.createClient(projectId, key, [env])\n\n`Airbrake.createClient()` returns a new Airbrake instance.\n\nOptions\n* `projectId` - Your application's Airbrake project ID.\n* `key` - Your application's Airbrake API key.\n* `env` - The name of the server environment this is running in.\n\n### airbrake.projectId = null\n\nYour application's Airbrake project ID.\n\n### airbrake.key = null\n\nYour application's Airbrake API key.\n\n### airbrake.env = process.env.NODE_ENV || 'development'\n\nThe name of the server environment this is running in.\n\n### airbrake.host = 'https://' + os.hostname()\n\nThe base url for errors. If `err.url` is not set, `airbrake.host` is used\ninstead. If `err.url` is a relative url starting with `'/'`, it is appended\nto `airbrake.host`. If `err.url` is an absolute url, `airbrake.host` is ignored.\n\n### airbrake.projectRoot = process.cwd()\n\nThe root directory of this project.\n\n### airbrake.appVersion = null\n\nThe version of this app. Set to a semantic version number, or leave unset.\n\n### airbrake.protocol = 'https'\n\nThe protocol to use.\n\n### airbrake.timeout = 30 * 1000\n\nThe timeout after which to give up trying to notify Airbrake in ms.\n\n### airbrake.proxy = null\n\nThe HTTP/HTTPS proxy to use when making requests.\n\n### airbrake.requestOptions = {}\n\nAdditional request options that are merged with the default set of options that are passed to `request` during `notify()` and `trackDeployment()`.\n\n### airbrake.whiteListKeys = []\n\nNames of environment variables to send.\n\n### airbrake.blackListKeys = []\n\nNames of environment variables to filter out.\n\n### airbrake.handleExceptions()\n\nRegisters a `process.on('uncaughtException')` listener. When an uncaught\nexception occurs, the error is sent to Airbrake, and then re-thrown to\nkill the process.\n\n### airbrake.handlePromiseRejections()\n\nRegisters a `process.on('unhandledRejection')` listener. When an uncaught\nexception occurs inside a promise, the error is sent to Airbrake, and then re-thrown to\nkill the process.\n\n### airbrake.expressHandler(disableUncaughtException)\n\nA custom error handler that is used with Express. Integrate with Express\nmiddleware using `app.use()`.\n\nOptions:\n* `disableUncaughtException`: Disables re-throwing and killing process on uncaught exception.\n\n### airbrake.notify(err, [cb])\n\nSends the given `err` to airbrake.\n\nThe callback parameter receives two arguments, `err, url`. `err` is set if\nthe delivery to Airbrake failed.\n\nIf no `cb` is given, and the delivery fails, an `error` event is emitted. If\nthere is no listener for this event, node will kill the process as well. This\nis done to avoid silent error delivery failure.\n\n### airbrake.trackDeployment([params, [cb]])\n\nNotifies Airbrake about a deployment. `params` is an object with the following\noptions:\n\n* `env:` The environment being deployed, defaults to `airbrake.env`.\n* `user:` The user doing the deployment, defaults to `process.env.USER`.\n* `repo:` The github url of this repository. Defaults to `git config --get remote.origin.url`.\n* `rev:` The revision of this deployment. Defaults to `git rev-parse HEAD`.\n\nAdditional notes\n----------------\n\n### Exception limit\n\nThe maximum size of an exception is 64KB. Exceptions that exceed this limit will\nbe truncated to fit the size.\n\nLicense\n-------\n\nThe library was originally created by [Felix Geisendörfer](https://github.com/felixge).\nThe project uses the MIT License. See LICENSE.md for details.\n\n[arthur-node]: http://s3.amazonaws.com/airbrake-github-assets/node-airbrake/arthur-node.jpeg\n[node-airbrake]: https://github.com/airbrake/node-airbrake\n[airbrake-io]: https://airbrake.io\n[long-stack-traces]: https://github.com/tlrobinson/long-stack-traces\n[2.1api]: http://help.airbrake.io/kb/api-2/notifier-api-version-21\n[screenshot]: https://github.com/airbrake/node-airbrake/raw/master/screenshot.png\n[deployment tracking]: https://airbrake.io/docs/airbrake-faq/deploy-tracking/\n[dashboard]: http://s3.amazonaws.com/airbrake-github-assets/node-airbrake/airbrake-dashboard.png\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairbrake%2Fnode-airbrake","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fairbrake%2Fnode-airbrake","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fairbrake%2Fnode-airbrake/lists"}