Issue¶

Drupal's 404 response is very resource intensive as it causes Drupal to fully bootstrap.

Resolution¶

Enabling Fast 404 in Drupal core¶

Drupal core has an option to serve a simple static HTML error response to a 404 status code. Enabling this setting can decrease wasted bandwidth and server load.

The instructions differ for Drupal 7 and Drupal 8. Follow the instructions that correspond to the Drupal version in use in your application.

Drupal 8¶

The Fast 404 contributed module does extend the current functionality of Drupal 8 core, however it's not necessary to create a static 404 HTML page. To implement a Drupal 8+ default core 404 static HTML response your team will need to edit the settings.php in Drupal and look for the following configuration.

/**
 * Fast 404 pages:
 *
 * Drupal can generate fully themed 404 pages. However, some of these responses
 * are for images or other resource files that are not displayed to the user.
 * This can waste bandwidth, and also generate server load.
 *
 * The options below return a simple, fast 404 page for URLs matching a
 * specific pattern:
 * - $config['system.performance']['fast_404']['exclude_paths']: A regular
 *   expression to match paths to exclude, such as images generated by image
 *   styles, or dynamically-resized images. The default pattern provided below
 *   also excludes the private file system. If you need to add more paths, you
 *   can add '|path' to the expression.
 * - $config['system.performance']['fast_404']['paths']: A regular expression to
 *   match paths that should return a simple 404 page, rather than the fully
 *   themed 404 page. If you don't have any aliases ending in htm or html you
 *   can add '|s?html?' to the expression.
 * - $config['system.performance']['fast_404']['html']: The html to return for
 *   simple 404 pages.
 *
 * Remove the leading hash signs if you would like to alter this functionality.
 */
# $config['system.performance']['fast_404']['exclude_paths'] = '/\/(?:styles)|(?:system\/files)\//';
# $config['system.performance']['fast_404']['paths'] = '/\.(?:txt|png|gif|jpe?g|css|js|ico|swf|flv|cgi|bat|pl|dll|exe|asp)$/i';
# $config['system.performance']['fast_404']['html'] = '
.....

Drupal 7¶

1. Edit your website's settings.php file
2. Find and uncomment (remove the #) on the following line:
   copy

   # drupal_fast_404();

3. Save the settings.php file
4. Commit the changed code to your repository

Using the Fast 404 module¶

Drupal core's fast 404 option avoids expensive page rendering without the need for an additional module. However, the Fast 404 module improves on this core functionality with more options to reduce load caused by bad requests.

The instructions differ for Drupal 7 and Drupal 8. Follow the instructions that correspond to the Drupal version in use in your application.

Drupal 7¶

1. Add the module to your standard modules location (usually sites/all/modules)
2. Place the code at the bottom of the README.TXT file into your settings.php file
3. If the module was not installed in sites/all/modules, modify the include_once path to match the install location
4. Commit the module and modified settings.php file to your repository
5. Enable the module on the modules page

To maximize the effectiveness of the Fast 404 module it may be necessary to familiarize yourself with each configuration setting found within the code block of the README.TXT file to determine whether it fits your needs.

Cause¶

By default, Drupal fully bootstraps for every 404 Not Found. This can be very expensive resource intensive; not just for missing pages, but any page with a bad link or a missing files can generate several 404s with one page request which can multiply the amount of resources needed to serve a single page.

Ideally, it would be best to eliminate all 404 requests; however, there are times when this is not a tenable option, such as developer resource constraints or a traffic spike. Thankfully, there are several methods to eliminate a fully bootstrapped response to a 404 Not Found request.