The official plugin to track Strapi errors with Sentry.
- Initialize a Sentry instance when your Strapi app starts
- Send errors encountered in your application's end API to Sentry
- Attach useful metadata to Sentry events, to help you with debugging
- Expose a global Sentry service
To install this plugin, you need to add an NPM dependency to your Strapi application.
# Using Yarn
yarn add strapi-plugin-sentry
# Or using NPM
npm install strapi-plugin-sentry
property | type (default) | description |
---|---|---|
dsn |
string (null ) |
Your Sentry data source name (see Sentry docs). |
sendMetadata |
boolean (true ) |
Whether the plugin should attach additional information (like OS, browser, etc.) to the events sent to Sentry. |
init |
object ({} ) |
A config object that is passed directly to Sentry during the Sentry.init() . See all available options on Sentry's docs
|
Example
./config/plugins.js
module.exports = ({ env }) => ({
// ...
sentry: {
dsn: env('SENTRY_DSN'),
sendMetadata: true,
},
// ...
});
You can access a Sentry service throughout your app.
const sentryService = strapi.plugins.sentry.services.sentry;
This service exposes the following methods:
Use it to manually send errors to Sentry. The configureScope
is optional, it allows you to customize the error event. Read more about Sentry's scope system on their docs.
Example
try {
// Your code here
} catch (error) {
// Either send a simple error
strapi.plugins.sentry.services.sentry.sendError(error);
// Or send an error with a customized Sentry scope
strapi.plugins.sentry.services.sentry.sendError(error, (scope, sentryInstance) => {
// Customize the scope here
scope.setTag('my_custom_tag', 'Tag value');
});
throw error;
}
Use it if you need direct access to the Sentry instance, which should already already be initialized. It's useful if sendError
doesn't suit your needs.
Example
const sentryInstance = strapi.plugins.sentry.services.sentry.getInstance();
By default, this plugin uses a middleware that logs all your unhandled API errors to Sentry. You can disable this feature by turning off the sentry
middleware in your app's config.
Example
./config/middleware.js
module.exports = {
//...
settings: {
sentry: {
enabled: false,
},
},
};
Only the middleware will be disabled. You will still have access to the Sentry service.
You can also completely disable this plugin (both the middleware and the service). If you omit the dsn
property of your plugin's settings, or if you give it a null value, the Sentry plugin will be ignored. You can use the env
utility to disable it depending on the environment.
Example
./config/plugins.js
module.exports = ({ env }) => ({
// ...
sentry: {
dsn: env('NODE_ENV') === 'development' ? null : env('SENTRY_DSN'),
},
// ...
});