property	type (default)	description
`dsn`	string (null)	Your Sentry data source name (see Sentry docs). Omitting it will disable the plugin.
`sendMetadata`	boolean (true)	Whether the plugin should attach additional information (like OS, browser, etc.) to the events sent to Sentry.

Example

./config/plugins.js

module.exports = ({ env }) => ({
  // ...
  sentry: {
    dsn: env('SENTRY_DSN'),
    sendMetadata: true,
  },
  // ...
});

Global Sentry service

You can access a Sentry service throughout your app.

const sentryService = strapi.plugins.sentry.services.sentry;

This service exposes the following methods:

`sendError(error, configureScope)`

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;
}

`getInstance()`

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();