Note:

If you want to create a new page for developers, you should create it on the Moodle Developer Resource site.

Check API

From MoodleDocs
Revision as of 13:34, 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.

Check status

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.