adonis-sentry
v2.1.4
Published
Sentry provider for adonis framework
Downloads
2,712
Maintainers
Readme
adonis-sentry
Sentry provider for AdonisJS
Install
adonis install adonis-sentry
You need to add the provider to AdonisJS at start/app.js
:
const providers = [
...
'adonis-sentry/providers/Sentry',
];
and in your .env
file
SENTRY_DSN=
SENTRY_ENVIRONMENT=
then you can use it as
const sentry = use('Sentry')
if you want to catch all the exceptions of your adonis project you must create an exception handler
adonis make:ehandler
and we need add sentry notify in app/Exceptions/Handler.js
'use strict'
const sentry = use('Sentry')
class ExceptionHandler extends BaseExceptionHandler {
...
async report (error, { request }) {
sentry.captureException(error)
}
}
module.exports = ExceptionHandler
Testing configuration
You can test your configuration using the command:
adonis sentry:test
Official documentation for Node.js apps
https://docs.sentry.io/clients/node/
Issues & PR
It is always helpful if we try to follow certain practices when creating issues or PR's, since it will save everyone's time.
- Always try creating regression tests when you find a bug (if possible).
- Share some context on what you are trying to do, with enough code to reproduce the issue.
- For general questions, please create a forum thread.
- When creating a PR for a feature, make sure to create a parallel PR for docs too.
License
Adonis Sentry is open-sourced software licensed under the MIT license.
Gratefulness
I want to thank Zura for have created the previous provider.