A single diagnostic Check performs one particular test on the application or environment.

It MUST return a Result which implements one of the following result interfaces:

  • Success - in case the check ran through without any issue.
  • Warning - in case there might be something wrong.
  • Failure - when the test failed and an intervention is required.

Each test Result can additionally return:

  • result message via getMessage(). It can be used to describe the context of the result.
  • result data via getData(). This can be used for providing detailed information on the cause of particular result, which might be useful for debugging problems.

One can define additional result interfaces, to denote additional severity levels (e.g. critical, alert, notice) or appropriate actions (i.e. missing, incomplete). However, it is recommended to extend the primary set of success, warning, and failure interfaces for compatibility with other applications and libraries.

Found a mistake or want to contribute to the documentation? Edit this page on GitHub!