Log adding/updating/deleting of elements
Audit log for Craft 3.
Note: This plugin costs $99.00 through the Craft Plugin Store when used in production.
This plugin requires Craft CMS 3.0.0-beta.23 or later.
To install the plugin, follow these instructions.
Open your terminal and go to your Craft project:
Then tell Composer to load the plugin:
composer require superbig/craft-audit
In the Control Panel, go to Settings → Plugins and click the “Install” button for Audit.
Audit automatically keeps an audit log for actions done by logged in users.
<?php 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' => '', ];
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
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.
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