Purge Akamai Optimizer

INTRODUCTION

Provides various optimisations for akamai caching and purge processing.
As per https://learn.akamai.com/en-us/webhelp/fast-purge/fast-purge/GUID-588747... there are various limits which
akamai imposes for its edge cache tag header, This main Drupal Akamai module by
default do handle some of these restrictions, and this module provides solution
for the same.

REQUIREMENTS

Purge module. See: https://www.drupal.org/project/purge.
Akamai module. See: https://www.drupal.org/project/akamai
To work correctly, this patch (https://www.drupal.org/project/akamai/issues/3160999#comment-13762094) needs to be applied on Akamai module

INSTALLATION

Refer the Purge documentation to get more details on how to setup the various
purge modules and processors.
https://git.drupalcode.org/project/purge/-/blob/8.x-3.x/README.md

Also refer Akamai documentation for configuring Akamai setup.
https://git.drupalcode.org/project/akamai/-/blob/8.x-3.x/README.md

MODULE FEATURES

• Solves the problem of akamai edge cache tag header limit of 8192 characters
• This is achieved by created 5 character hashes of each tag.
• Includes the functionality of reducing more than 128 tags on a page.
• Provides a configuration to define prefixes for the tags which should be replaced with an identifier.
• In edge cache tag header for all the tags which are matching the prefix are replaced with an identifier.
• Sending replacement tags during purge for the tags which have been removed.
• Replacement identifiers are stored in a custom table. Also various cron jobs are added to analyse priority tags and automatically remove old records from this table.
• Adds a site identifier tag on all HTML pages which allows for purging the whole site.
• Also provides a hook to customise this identifier information.
• Adds support for sending a file identifier for purging. This identifier is not added on all the file pages.
• Adds a new AkamaiEverythingPurger to support purging whole Akamai cache using the site identifier and file identifier.
• Adds a feature to disable Akamai caching.

CONFIGURATION

• Refer documentation of Purge and Akamai module to configure your base setup.
• Refer Module's Readme file for more details

Other Recommended modules

• Purge Control: Provide a mechanism to disable and enable purging
• Purge Everything Queuer: Provides a purge queuer to queue everything invalidation, Also provides an implementation to restart the stopped purge process due to Queue getting full.
• Purge Ajax processor: Provides a Purge processor which Sends an Ajax request on every page load to process the purge queue.

Note

The complete end to end setup with additional modules was demonstrated in Drupal Con Europe 2021, Below are the session resources:

• Session
• PPT
• Demo repo