Raven: Sentry Integration

Raven module provides integration with Sentry, an application monitoring and error tracking platform, allowing your Drupal site to send log events and performance traces to Sentry.

Sentry can capture all (or a user-defined subset of) Drupal log messages as well as errors that typically are not logged by Drupal: fatal PHP errors such as memory limit exceeded, fatal JavaScript errors, and exceptions thrown by Drush commands, and provides a full stacktrace and customizable metadata for each event.

You can use the Sentry hosted service or install Sentry (and/or Sentry Relay) on your own infrastructure (e.g. using Docker). Alternative lighter-weight backends such as Bugsink and GlitchTip are also available.

This module can send the following types of events to Sentry:

• PHP fatal errors;
• Drupal log (watchdog) messages;
• Drush command exceptions;
• JavaScript exceptions, via @sentry/browser;
• Content Security Policy (CSP) reports, if CSP or Security Kit modules are installed; and
• Monitoring sensor status changes, if Monitoring module is installed.

You can choose which errors you want to catch by enabling desired error handlers and selecting error levels. A Sentry breadcrumb is recorded for each Drupal log message. If you use Monolog module, the README explains how to setup the drupal.raven Monolog handler to send log events to Sentry.

Sentry structured logs are also supported; these lightweight logs lack stacktraces and are only sent once at the end of the request (or on demand).

Raven module also integrates with Sentry performance tracing, both server-side and in the browser. If enabled on the module settings page, a transaction will be created for each request/response handled by Drupal, each page load in the browser, and each Drush command. Spans (timed operations) can be captured for:

• Requests made by Drupal's HTTP client;
• Database queries;
• Rendered Twig templates;
• Log messages sent to Sentry;
• Client-side spans captured by the Sentry browser SDK, including Interaction to Next Paint (INP) spans, if enabled; and
• Any spans created by custom code.

If you install the optional Excimer PHP extension and configure the profiling sample rate, Sentry can render highly detailed, interactive flame graphs.

You also have the option to enable Sentry release health monitoring, which sends a session event to Sentry for each page load, allowing you to track adoption and crash rate of new releases. If you enable the user feedback dialog option, users will be prompted to submit a crash report when JavaScript exceptions are thrown.

If you configure cron monitoring, Sentry will alert you when cron runs are missed and graph the average duration of cron runs over time.

Raven release branch Sentry PHP dependency Sentry JavaScript 7.x 4.x 10.x (ES2020) 6.x 4.x 8.x (ES2018) 5.x 4.x 7.x (ES6) 4.x 3.x 7.x (ES6) 3.x 3.x 6.x 8.x-2.x 1.x 6.x 7.x-4.x 3.x 6.x 7.x-3.x 1.x 6.x 7.x-2.x 1.x 3.x

Credits:

Raven module is not affiliated with Sentry; it is developed and maintained by mfb. You can support development by contributing or sponsoring.

Raven graphic by Hugh D’Andrade (Creative Commons Attribution License).