jovo-community-plugin-sentry
v1.5.1
Published
A Jovo Framework plugin for Sentry
Downloads
67
Keywords
Readme
jovo-community-plugin-sentry
Overview
This plugin for the Jovo Framework allows you to easily add error monitoring with Sentry to your voice projects.
Platforms
The following platforms are supported:
- Amazon Alexa
- Google Assistant
- Samsung Bixby
- Twilio Autopilot
Install
Install the plugin into your Jovo project:
npm install jovo-community-plugin-sentry --save
Use the plugin in:
app.js:
const { SentryPlugin } = require('jovo-community-plugin-sentry');
app.use(
// ... base imports
new SentryPlugin()
);
app.ts:
import { SentryPlugin } from 'jovo-community-plugin-sentry';
app.use(
// ... base imports
new SentryPlugin()
);
Configuration
Refer to the Sentry documentation on Configuration.
Supported configuration values:
- dsn
- debug
- release
- environment
- maxBreadcrumbs
- sampleRate
- attachStacktrace
- serverName
config.js or config.ts:
plugin: {
SentryPlugin: {
dsn: 'https://[email protected]/0000000', // or set SENTRY_DSN
environment: process.env.JOVO_STAGE, //or set SENTRY_ENVIRONMENT
debug: false,
release: '[email protected]', //or set SENTRY_RELEASE
},
},
Here is a typical implementation:
- In
.env
file (forlocal
stage and Jovo Webhook) and in lambda environment variables (for all other stages includingprod
), set theSENTRY_DSN
variable:
SENTRY_DSN = "https://[email protected]/xxx"
- Set the
environment
value inconfig.js
orconfig.ts
:
plugin: {
SentryPlugin: {
environment: process.env.JOVO_STAGE,
}
},
Capture
The plugin will automatically capture exceptions in the code, but you can also access the capture methods from any handler:
this.$sentry.captureMessage('Hello, world!');
this.$sentry.captureException(new Error('Good bye'));
this.$sentry.captureEvent({
message: 'Manual',
stacktrace: [
// ...
],
});
License
MIT