Check API
WARNING: Work in Progress
Checks
A Check is a runtime test to make sure something is working well. Checks can be used for a variety of purposes including:
- configuration checks
- security checks
- performance checks
- health checks
Moodle has had various types of checks for a long time but in 3.9 they were unified under a single Check API enabling plugins to cleanly define their own additional checks.
Status of a check
N/A
OK
Info
Unknown
Warning
Error
Critical?
Configuration checks
/admin/index.php?cache=1
/admin/environment.php
These are environmental checks to make sure a Moodle instance is fully setup.
Security checks
These are checks to make sure a Moodle instance is hardened correctly for you needs.
/report/security/index.php
Performance checks
/report/performance/index.php
Each check might exercise
Health checks
/report/status/index.php
A Health check covers operational tests such as 'can moodle connect to ldap'. The main core health check is to ensure that cron is running regularly and there has been no failed tasks.
