This plugin will take entries from the Moodle standard log store table and export them to AWS S3.
There is no internal cleanup process in Moodle to manage the size of the standard log store table. This table will get continuously larger over time. On busy Moodle sites this means that the table can easily be over 100GB on disk. As the standard log store table grows, both in number of records and size on disk Moodle performance can be affected.
This plugin will extract entries from the standard log store table that are older than a user configured date. These extracted entries are then uploaded to AWS S3 as a csv file, and finally the original records are deleted from the Moodle database. Doing this keeps the Moodle database size down while preserving data that can be leveraged for analytics and other functions.
The plugin functionality runs as a Moodle scheduled task.
This plugin currently supports Moodle:
| Moodle version | Branch |
|---|---|
| Moodle 4.5 - 5.3 | MOODLE_405_STABLE |
-
Get the code and copy/ install it to:
<moodledir>/admin/tool/s3logs -
Run the upgrade:
php admin/cli/upgrade.php
-
Configure the plugin in Site administration > Plugins > Admin Tools > S3 log archiver.
-
The schedule for the plugin task can be altered at Site administration > Server > Scheduled tasks
-
The scheduled task can also be run manually from your
<moodledir>:php admin/cli/scheduled_task.php --execute='\tool_s3logs\task\process_logs'
The plugin can be configured to restrict which logs are archived based on course ID. This is useful when you want to target a specific subset of logs rather than archiving everything older than the maximum age.
Two settings control this behaviour:
- Course ID filter: A comma-separated list of course IDs (e.g.
0,0,1,42,107). Leave blank to archive logs for all courses (default behaviour). - Course filter mode: Whether to Include or Exclude the listed course IDs from archiving.
Example: Archive only non-course logs
A common use case is to archive site-level logs (where courseid = 0 for logs outside any course, or courseid = 1 for the site home) while leaving course logs untouched in the database for faster querying.
- Go to Site administration > Plugins > Admin Tools > S3 log archiver
- Set Course ID filter to
0,1 - Set Course filter mode to
Include
The archiver will now only process log entries that do not belong to a real course, archiving them to S3 and removing them from the database.
This plugin was developed by Catalyst IT Australia:
Issues, and pull requests using github are welcome and encouraged!
https://github.com/catalyst/moodle-tool_s3logs/issues
If you would like commercial support or would like to sponsor additional improvements to this plugin please contact us:
https://www.catalyst-au.net/contact-us
Copyright 2017 Matt Porritt mattp@catalyst-au.net
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.