Log adding/updating/deleting of elements

Installs: 36 090

Dependents: 0

Suggesters: 0

Security: 0

Stars: 19

Watchers: 2

Forks: 10

Open Issues: 32


3.0.2 2023-03-29 20:43 UTC

This package is auto-updated.

Last update: 2023-11-29 22:24:55 UTC


Audit log for Craft 4.

Plugin icon

Note: This plugin costs $99.00 through the Craft Plugin Store when used in production.


Screenshot of index view

Screenshot of details view


This plugin requires Craft CMS 4.0.0 or later.


To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project
  2. Then tell Composer to load the plugin:

     composer require superbig/craft-audit
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Audit.

Audit Overview

Audit automatically keeps an audit log for actions done by logged in users.

Configuring Audit

return [
    // How many days to keep log entries around
    'pruneDays'          => 30,

    // Enable logging
    'enabled'            => true,

    // Toggle specific event types
    'logElementEvents'            => true,
    'logChildElementEvents'       => false,
    'logDraftEvents'              => false,
    'logPluginEvents'             => true,
    'logUserEvents'               => true,
    'logRouteEvents'              => true,

    // Prune old records when a admin is logged in
    'pruneRecordsOnAdminRequests'          => false,

    // Enable geolocation status
    'enabledGeolocation' => true,
    'maxmindLicenseKey' => '',
    // Where to save Maxmind DB files
    'dbPath' => '',

Using Audit

As long as the plugin is installed, it will log the following events automatically:

  • Creating/saving/deleting elements (including users, Commerce product/variants etc.)
  • Saving global sets
  • Creating/saving/deleting routes
  • Installing/uninstalling and enabling/disabling plugins
  • Login/logout

More events like Commerce-specific event handling is planned.


To enable geolocation lookup with the help of the MaxMind GeoLite2 databases, you first have to generate a license key.

Add your License Key obtained from the account area.

Clearing old records

You can prune records older than n days (configured by the pruneDays setting) either by using the console command ./craft audit/default/prune-logs or by a button on the Audit index screen.


Brought to you by Superbig