Inheritance diagram for COREPOS\Fannie\API\monitor\Monitor:
Public Member Functions | |
| __construct ($config) | |
| check () | |
| escalate ($json) | |
| display ($json) | |
Protected Attributes | |
| $config | |
Detailed Description
API class for monitoring system status and building a dashboard.
Constructor & Destructor Documentation
| COREPOS\Fannie\API\monitor\Monitor::__construct | ( | $config | ) |
- Parameters
-
$config [FannieConfig] instance of configuration
Member Function Documentation
| COREPOS\Fannie\API\monitor\Monitor::check | ( | ) |
Assess current status of system(s) being monitored by this class.
- Returns
- [string] JSON-encoded string representing status
| COREPOS\Fannie\API\monitor\Monitor::display | ( | $json | ) |
Convert system status to HTML so it can be displayed to a user. These return values are used to build web-based dashboards.
- Parameters
-
$json [string] JSON-encoded string representing current system status. This is the value returned by the most recent call to check().
- Returns
- [string] HTML representation of status
| COREPOS\Fannie\API\monitor\Monitor::escalate | ( | $json | ) |
Determine whether system status is critical. Returning true tells the monitoring system to notify someone as soon as possible.
- Parameters
-
$json [string] JSON-encoded string representing current system status. This is the value returned by the most recent call to check().
- Returns
- [boolean] true => critical false => not critical
The documentation for this class was generated from the following file:
- fannie/classlib2.0/monitor/Monitor.php
