This plugin integrates the Sentry error tracking & performance monitoring service with your Vendure server. In addition to capturing errors, it also provides built-in support for tracing as well as enriching your Sentry events with additional context about the request.
This plugin depends on access to Sentry, which can be self-hosted or used as a cloud service.
If using the hosted SaaS option, you must have a Sentry account and a project set up (sign up here). When setting up your project, select the "Node.js" platform and no framework.
The following environment variables are used to control how the Sentry integration behaves:
SENTRY_DSN: (required) Sentry Data Source NameSENTRY_TRACES_SAMPLE_RATE: Number between 0 and 1SENTRY_PROFILES_SAMPLE_RATE: Number between 0 and 1SENTRY_ENABLE_LOGS: Boolean. Captures calls to the console API as logs in Sentry. Default falseSENTRY_CAPTURE_LOG_LEVELS: 'debug' | 'info' | 'warn' | 'error' | 'log' | 'assert' | 'trace'Setting up the Sentry plugin requires two steps:
Make sure the SENTRY_DSN environment variable is defined.
The Sentry SDK must be initialized before your application starts. This is done by preloading the instrument file when starting your Vendure server:
Or if using TypeScript directly with tsx:
This plugin includes built-in support for tracing, which allows you to see the performance of your application. To enable tracing, preload the instrument file as described in Step 1. This ensures that the Sentry SDK is initialized before any other code is executed.
You can also set the tracesSampleRate and profilesSampleRate options to control the sample rate for
tracing and profiling, with the following environment variables:
SENTRY_TRACES_SAMPLE_RATESENTRY_PROFILES_SAMPLE_RATEThe sample rate for tracing should be between 0 and 1. The sample rate for profiling should be between 0 and 1.
By default, both are set to undefined, which means that tracing and profiling are disabled.
You may want to add your own custom spans to your code. To do so, you can use the Sentry object
from the @sentry/node package. For example:
To test whether your Sentry configuration is working correctly, you can set the includeErrorTestMutation option to true. This will add a mutation to the Admin API
which will throw an error of the type specified in the errorType argument. For example:
You should then be able to see the error in your Sentry dashboard (it may take a couple of minutes to appear).
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.
Talk to the teamOnce set up, you will be given a Data Source Name (DSN) which you will need to provide to the plugin.