{"id":19701770,"url":"https://github.com/kuzzleio/kuzzle-plugin-sentry","last_synced_at":"2026-03-09T07:31:47.294Z","repository":{"id":71813467,"uuid":"241824790","full_name":"kuzzleio/kuzzle-plugin-sentry","owner":"kuzzleio","description":"A Kuzzle plugin to send errors to Sentry","archived":false,"fork":false,"pushed_at":"2025-05-07T12:01:37.000Z","size":2107,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-10-04T03:47:07.344Z","etag":null,"topics":["error-monitoring","kuzzle","kuzzle-plugin","monitoring","sentry"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kuzzleio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-02-20T07:53:21.000Z","updated_at":"2025-05-07T12:01:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"0f50e5a0-5c23-4861-aac7-7de3ded2b508","html_url":"https://github.com/kuzzleio/kuzzle-plugin-sentry","commit_stats":{"total_commits":9,"total_committers":4,"mean_commits":2.25,"dds":0.5555555555555556,"last_synced_commit":"3422fedb082a82e5800e03dddb2034735df8f07e"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/kuzzleio/kuzzle-plugin-sentry","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-sentry","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-sentry/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-sentry/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-sentry/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kuzzleio","download_url":"https://codeload.github.com/kuzzleio/kuzzle-plugin-sentry/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fkuzzle-plugin-sentry/sbom","scorecard":{"id":574413,"data":{"date":"2025-08-11","repo":{"name":"github.com/kuzzleio/kuzzle-plugin-sentry","commit":"2f527e9f4960611a51149714d0b1d130d6c4d00e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2,"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":"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":"Code-Review","score":3,"reason":"Found 3/8 approved changesets -- score normalized to 3","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":"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":"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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: npmCommand not pinned by hash: docker/install-plugins.sh:13","Info:   0 out of   1 npmCommand dependencies pinned"],"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE: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":"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 6 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"}},{"name":"Vulnerabilities","score":0,"reason":"16 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-593m-55hh-j8gv","Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-20T17:15:56.647Z","repository_id":71813467,"created_at":"2025-08-20T17:15:56.647Z","updated_at":"2025-08-20T17:15:56.647Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30287425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-09T02:57:19.223Z","status":"ssl_error","status_checked_at":"2026-03-09T02:56:26.373Z","response_time":61,"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":["error-monitoring","kuzzle","kuzzle-plugin","monitoring","sentry"],"created_at":"2024-11-11T21:10:18.078Z","updated_at":"2026-03-09T07:31:47.272Z","avatar_url":"https://github.com/kuzzleio.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kuzzle Plugin Sentry\n\nThis plugin allows to send the errors encountered by Kuzzle to Sentry for further detailed analysis.\n\n## Installation\n\nFirst, you have to get the Sentry DSN URL associated with the project you want to monitor.  \nPlease refer to Sentry [documentation](https://docs.sentry.io/) to create a new Node.js project and get your DSN.  \n\nOne you have it, you have to provide the DSN to the plugin using one of the following method.\n\n - `SENTRY_DSN` environment variable \n - `plugins.sentry.dsn` key in Kuzzle configuration file\n\n## Usage\n\nThis plugin adds a hook on the [request:onError](https://docs.kuzzle.io/core/2/plugins/guides/events/request-on-error/) event triggered by Kuzzle each time a request fail.  \n\nEach error will be enriched with the authenticated user to allow Sentry to compute the number of user affected by an issue. (See [Sentry documentation](https://docs.sentry.io/enriching-error-data/context/?platform=javascript#capturing-the-user))\n\nIt will send the error to Sentry alongside with other useful informations like:\n - input payload\n - request context\n\nFinally, is adds a [Sentry tag](https://docs.sentry.io/enriching-error-data/context/?platform=javascript#tagging-events) containing the controller and action name to quickly identify related events.\n\n## Configuration\n\nYou can configure the plugin by using [Kuzzle configuration file](https://docs.kuzzle.io/core/2/guides/essentials/configuration/).  \n\n### Sentry environment\n\nIt's possible to define the [Sentry environment](https://docs.sentry.io/enriching-error-data/environments/) to bring even more context to catched errors.\n\nYou can either provide the `KUZZLE_ENV` environment variable or add the following key to the configuration:\n\n```js\n\n{\n  // kuzzle configuration file\n  \"plugins\": {\n    \"sentry\": {\n      \"environment\": \"staging\"\n    }\n  }\n}\n```\n\n### Ignore errors\n\nYou can define errors that will be ignored and thus not send to Sentry.  \n\nBy default the plugin will only send the `PluginImplementationError`.  \n\nIf you add filters manually, then it will send every errors except those matching the filters.\n\nYou can filter errors either by [status](https://docs.kuzzle.io/core/2/api/essentials/errors/handling/) or by [id](https://docs.kuzzle.io/core/2/api/essentials/errors/codes/).  \n\nTheses filters can be defined in the configuration file:\n```js\n{\n  // kuzzle configuration file\n  \"plugins\": {\n    \"sentry\": {\n      \"ignore\": {\n        \"ids\": [\n          \"security.token.verification_error\",\n          \"security.token.expired\"\n        ],\n        \"statuses\": [ 401, 403 ]\n      } \n    }\n  }\n}\n```\n\n### Filter sensitive values\n\nAny sensitive information will be filtered in the Sentry report. This include password and authentication tokens.  \n\nBy default, those values are:\n - `context.token._id`: contain the authentication token\n - `context.token.jwt`: authentication token\n - `input.jwt`: authentication token\n - `input.body.password`: password of the `local` strategy\n\nYou can add other value to be filtered automatically in the `sensitiveValues` array:\n\n```js\n{\n  // kuzzle configuration file\n  \"plugins\": {\n    \"sentry\": {\n      \"sensitiveValues\": [\n        \"input.body.fbkeyid\"\n      ]\n    }\n  }\n}\n```\n\n### Exclude Sentry integrations\n\nYou can exclude default Sentry integration by providing their name in the configuration.  \n\n```js\n{\n  // kuzzle configuration file\n  \"plugins\": {\n    \"sentry\": {\n      \"excludeIntegrations\": [\n        \"Http\",\n        \"Console\"\n      ]\n    }\n  }\n}\n```\n\n### Configuration example\n\n```js\n{\n  // kuzzle configuration file\n  \"plugins\": {\n    \"sentry\": {\n      // DSN\n      \"dsn\": \"https://214284...@sentry.io/214284...\"\n\n      // Sentry environment\n      \"environment\": \"staging\",\n\n      // ignore specific errors\n      \"ignore\": {\n        \"ids\": [\n          \"security.token.verification_error\",\n          \"security.token.expired\"\n        ],\n        \"statuses\": [ 401, 403 ]\n      },\n\n      // Exclude Sentry default integrations\n      \"excludeIntegrations\": [\n        \"Http\",\n        \"Console\"\n      ],\n\n      // Additional sensitives values to filter before sending the error\n      \"sensitiveValues\": [\n        \"input.body.fbkeyid\"\n      ]\n    }    \n  }\n}\n```\n\n## Extended API\n\n#### admin:switch\n\nThis plugin also expose an API method in order to enable or disable sending events to Sentry.\n\nJSON payload:\n\n```json\n{\n  \"controller\": \"sentry/admin\",\n  \"action\": \"switch\",\n  \"state\": \"on\"\n}\n```\n\nHTTP route:\n\n```bash\n# enable plugin\ncurl localhost:7512/_plugin/sentry/switch/on\n\n# disable plugin\ncurl localhost:7512/_plugin/sentry/switch/off\n```\n\n#### send:generic\n\nSends an error to sentry.\n\n```js\n// Example usage in another plugin\n\nthis.context.accessors.sdk.query({\n  controller: 'sentry/send',\n  action: 'request',\n  body: {\n    error: new Error('failure'),\n    tags: {\n      tag1: 'gordon',\n      tag2: 'alyx'\n    },\n    extras: {\n      some: 'extra data',\n      whatever: 'you want'\n    },\n    request: // Optional errored request\n  }\n})\n```\n\n## Example of Sentry report\n\n![sentry kuzzle](sentry-kuzzle.gif)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuzzleio%2Fkuzzle-plugin-sentry","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkuzzleio%2Fkuzzle-plugin-sentry","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuzzleio%2Fkuzzle-plugin-sentry/lists"}