- Basic Overview
- Requirements
- Download FilterLog for Moodle
- Installation
- Usage
- Updating
- Uninstallation
- Limitations
- Language Support
- Troubleshooting
- Frequently Asked Questions (FAQ)
- Contributing
- Motivation for this plugin
- Further information
- License
FilterLog Admin Tool for Moodle LMS enables administrators to regularly shrink or eliminate logs for a specific user id. This can be very useful if your logs are being filled by Web Services.
WARNING: This ALPHA release has NOT been tested on many Moodle sites yet and should not be used on production Moodle sites at this time. Although we expect everything to work, if you find a problem, please help by reporting it in the Bug Tracker.
This plugin requires Moodle 3.0.1+ from https://moodle.org/ .
The most recent DEVELOPMENT release of FilterLog for Moodle LMS can be found at: https://github.com/michael-milette/moodle-tool_filterlog
Install the plugin, like any other plugin, to the following folder:
/admin/tool/filterlog
See https://docs.moodle.org/en/Installing_plugins for details on installing Moodle plugins.
WARNING: This ALPHA release has NOT been tested on many Moodle sites yet and should not be used on production Moodle sites at this time. Although we expect everything to work, if you find a problem, please help by reporting it in the Bug Tracker.
You can customize the text appearing in the plugin using Moodle's language editor. Here is how to do it:
- Navigate to Site Administration > Language > Language Customization.
- Select the language you want to customize.
- Click the Open Language Pack for Editing button.
- Wait until the Continue button apppears. This may take a little time. Please be patient.
- In the Show Strings of These Components field, scroll down and select tool_filterlog.php.
- Click the Show Strings button.
- Edit the language strings as needed.
- Scroll to the bottom of the page and click the Save changes to the language pack button.
For more information on editing language strings in Moodle, visit: https://docs.moodle.org/en/Language_customisation.
There are no special considerations required for updating the plugin.
The first public ALPHA version was released on 2021-09-29.
For more information on releases since then, see CHANGELOG.md.
Uninstalling the plugin by going into the following:
Site Administration > Plugins > Manage plugins > FilterLog
...and click Uninstall. You may also need to manually delete the following folder:
/admin/tool/filterlog
- You can only choose to remove log entries from a single user id from the standard log store.
- This does not work with the legacy log store.
This plugin includes support for the English language.
If you need a different language that is not yet supported, please contribute a translation using the Moodle AMOS Translation Toolkit for Moodle at https://lang.moodle.org/
If it is not working for you, check the following:
- The most recent version of the plugin is installed.
- You have check the plugin settings by going to Site Administration > Plugins > Admin Tools > FilterLog to ensure that you specified an ID (you cannot specify the admin ID = 0), and have set a rentention period.
- You have ensured that the task is enabled and the time is set by going to Administration > Server > Scheduled Tasks > Log Table User Cleanup and clicked on the gear icon.
- You have verified that cron is running the Moodle Task Scheduler each minute of the day.
IMPORANT: Although we expect everything to work, this ALPHA release has not been fully tested in every situation. If you find a problem, please help by reporting it in the Bug Tracker.
There are no known security considerations at this time.
Got a burning question that is not covered here? If you can't find your answer, submit your question in the Moodle forums or open a new issue on Github at:
https://github.com/michael-milette/moodle-tool_filterlog/issues
If you are interested in helping, please take a look at our contributing guidelines for details on our code of conduct and the process for submitting pull requests to us.
Michael Milette - Author and Lead Developer
The development of this plugin was motivated through our own experience in Moodle development, features requested by out clients and topics discussed in the Moodle forums and Moodle Tracker. The project development was sponsored by CSA Group and is supported by TNG Consulting Inc.
For further information regarding the tool_filterlog plugin, support or to report a bug, please visit the project page at:
https://github.com/michael-milette/moodle-tool_filterlog
Copyright © 2021 TNG Consulting Inc. - link:www.tngconsulting.ca
This file is part of FilterLog for Moodle - https://moodle.org/
FilterLog 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.
FilterLog 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 FilterLog. If not, see https://www.gnu.org/licenses/.