ignition

This integrates the spatie/ignition package error handler for Drupal 10.x.

It is meant for development purposes - after enabling, you can get the new error/exception page UI and add solutions to your custom exceptions as shown in the screenshot. Do not enable this module on a production website, as the exception/error output may show sensitive information.

After enabling the module, all errors will display through Ignition. See the docs about how to add user friendly Solutions to custom thrown exceptions. Solutions allow you to add descriptive text and links to potential solutions, documentation, guides, runbooks or other useful resources (see screenshot) when that particular error is encountered.

See this blog post for some more information on why you may want to use this module.

Ignition only works if the Drupal log level is set to All messages, with backtrace information. As a general rule, you should always set the Drupal log level to None on live/production environments.

You can add a snippet like this to you settings.php file to achieve this:

if (SITE_IS_PROD) {
  $config['system.logging']['error_level'] = 'hide';
}

For Acquia environments, you can use following snippet for example:

if (isset($_ENV['AH_SITE_ENVIRONMENT']) && $_ENV['AH_SITE_ENVIRONMENT'] == 'prod') {
  $config['system.logging']['error_level'] = 'hide';
}

You can also enable AI integration to get potential explanations for the error right in the output:

The color theme and the editor used for the code preview can be configured by clicking the cog icon in the top right corner of the error page. The settings are stored in the user or session storage, so they will be remembered across multiple requests.

The Store settings in ~/.ignition.json option in the settings form at /admin/config/development/ignition can be used to store the Ignition settings in a file in the user's home directory. This is useful if you want to share the same settings across multiple projects. This is only recommended for local, non-shared development environments.

Installing

1. Run composer require drupal/ignition:^1.0
2. Enable the module.
3. Clear the cache.
4. Exceptions should now render through Ignition instead of Drupal.