Note:

This site is no longer used and is in read-only mode. Instead please go to our new Moodle Developer Resource site.

Check API

From MoodleDocs
Revision as of 13:26, 26 January 2020 by Brendan Heywood (talk | contribs)

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 and allowed to extended cleanly by plugins in a variety of ways.

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

Health checks

cron is on admin


Performance checks

/report/performance/index.php