Sentry plugin

Page summary:

The Sentry plugin connects Strapi to Sentry to report errors and attach debugging metadata. This documentation details installation, environment-based configuration, and ways to disable or skip sending events outside production.

This plugin enables you to track errors in your Strapi application using Sentry.

IDENTITY CARD

Location

Only usable and configurable via server code

Package name

@strapi/plugin-sentry

Additional resources

Strapi Marketplace pageSentry page

By using the Sentry plugin you can:

• Initialize a Sentry instance upon startup of a Strapi application
• Send Strapi application errors as events to Sentry
• Include additional metadata in Sentry events to assist in debugging
• Expose a global Sentry service usable by the Strapi server

Installation

Install the Sentry plugin by adding the dependency to your Strapi application as follows:

yarn

yarn add @strapi/plugin-sentry

npm

npm install @strapi/plugin-sentry

Configuration

Create or edit your /config/plugins file to configure the Sentry plugin. The following properties are available:

Property	Type	Default Value	Description
dsn	string	null	Your Sentry data source name.
sendMetadata	boolean	true	Whether the plugin should attach additional information (e.g., OS, browser, etc.) to the events sent to Sentry.
init	object	{}	A config object that is passed directly to Sentry during initialization (see official Sentry documentation for available options).

The following is an example basic configuration:

JavaScript

/config/plugins.js

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

TypeScript

/config/plugins.ts

export default ({ env }) => ({
  // ...
  sentry: {
    enabled: true,
    config: {
      dsn: env('SENTRY_DSN'),
      sendMetadata: true,
    },
  },
  // ...
});

Disabling for non-production environments

If the dsn property is set to a nil value (null or undefined) while sentry.enabled is true, the Sentry plugin will be available to use in the running Strapi instance, but the service will not actually send errors to Sentry. That allows you to write code that runs on every environment without additional checks, but only send errors to Sentry in production.

When you start Strapi with a nil dsn config property, the plugin will print the following warning:
info: @strapi/plugin-sentry is disabled because no Sentry DSN was provided

You can make use of that by using the env utility to set the dsn configuration property depending on the environment.

JavaScript

/config/plugins.js

module.exports = ({ env }) => ({
  // …
  sentry: {
    enabled: true,
    config: {
      // Only set `dsn` property in production
      dsn: env('NODE_ENV') === 'production' ? env('SENTRY_DSN') : null,
    },
  },
  // …
});

TypeScript

/config/plugins.ts

export default ({ env }) => ({
  // …
  sentry: {
    enabled: true,
    config: {
      // Only set `dsn` property in production
      dsn: env('NODE_ENV') === 'production' ? env('SENTRY_DSN') : null,
    },
  },
  // …
});

Disabling the plugin completely

Like every other Strapi plugin, you can also disable this plugin in the plugins configuration file. This will cause strapi.plugins('sentry') to return undefined:

JavaScript

/config/plugins.js

module.exports = ({ env }) => ({
  // …
  sentry: {
    enabled: false,
  },
  // …
});

TypeScript

/config/plugins.ts

export default ({ env }) => ({
  // …
  sentry: {
    enabled: false,
  },
  // …
});

Usage

After installing and configuring the plugin, you can access a Sentry service in your Strapi application as follows:

const sentryService = strapi.plugin('sentry').service('sentry');

This service exposes the following methods:

Method	Description	Parameters
sendError()	Manually send errors to Sentry.	error: The error to be sent. configureScope: Optional. Enables you to customize the error event. See the official Sentry documentation for more details.
getInstance()	Used for direct access to the Sentry instance.	-

The sendError() method can be used as follows:

try {
  // Your code here
} catch (error) {
  // Either send a simple error
  strapi
    .plugin('sentry')
    .service('sentry')
    .sendError(error);

  // Or send an error with a customized Sentry scope
  strapi
    .plugin('sentry')
    .service('sentry')
    .sendError(error, (scope, sentryInstance) => {
      // Customize the scope here
      scope.setTag('my_custom_tag', 'Tag value');
    });
  throw error;
}

The getInstance() method is accessible as follows:

const sentryInstance = strapi
  .plugin('sentry')
  .service('sentry')
  .getInstance();