monitorThe monitor class. This is the entity which contains the details of what is to be monitored, how it is to be monitored and what to do if a given condition arises.
Located in /monitor-defs.php (line 805)
monitor
monitor
([string $name = ""], [string $emailto = ""], [string $emailfrom = ""], [string $emailpager = ""], [string $lockfilepath = ""])
mixed
$condition
= COND_OK (line 838)
Monitor highest priority condition
mixed
$emailfrom
= "" (line 812)
Address monitor messages come from
mixed
$emailpager
= "" (line 814)
Address to email SMS txt messages
mixed
$emailto
= "" (line 810)
Address to email monitor messages
mixed
$email_condition_threshold
= COND_WARNING (line 849)
Threshold condition for emailing
mixed
$emit_status
= false (line 819)
Whether to emit a status message to stdout. If true the monitor will emit the current status, plus the message associated with the highest priority (most severe) condition in the monitor. Format will be: 'CRITICAL: some message goes here'.
mixed
$hostname
= "" (line 826)
Local hostname we are running monitor on
mixed
$locked
= false (line 835)
True if we are locked via lockfile
mixed
$lockfile
(line 832)
Monitor lockfile object
mixed
$lockfilepath
= "" (line 821)
Monitor lockfile path
mixed
$message
= "" (line 840)
Monitor highest priority message
mixed
$monitors
= array() (line 865)
Array of monitors which do the work
mixed
$name
= "" (line 808)
The name of this monitor instance
mixed
$pager_condition_threshold
= COND_CRITICAL (line 852)
Threshold condition for paging
mixed
$reportmsg
= "" (line 843)
Report staging for email
mixed
$schedule
(line 862)
Schedule of named timeslots for this monitor
mixed
$smstxtmsg
= "" (line 846)
Report staging for SMS txt
mixed
$stop_on_condition
= COND_NONE (line 859)
Condition to stop on. If this condition is defined then we
mixed
$tinow
(line 855)
The current Unix timestamp
mixed
$use_lockfile
= true (line 829)
Whether to use a lockfile
Create a new monitor object. This is the container for all of the monitors which you can define and use to monitor a complete system.
Add a new monitor. Eg. file_monitor, postgres_monitor etc. This just stuffs the object in an array ready to be checked.
Add a time slot to the schedule. This requires two times as per 24hr clock which define a time interval during the day, and gives it a name. You can define any number of these. Timeslots have to be in HH:MM format, separated by a dash "-", eg: '07:30-11:45'.
Check all monitors. Just iterate through them and raise the conditions
contained in the reports each one returns. After collecting the details, we notify anyone which needs to know. If any condition returned from a check is CRITICAL, then the rule is we stop processing any further checks. Processing is done in order of definition of the monitors added, so put your critical ones first. NOTE: This method always performs a lock() before processing all the monitors, then performs an unlock() at the end.
Iterate through all our monitors, checking in each case. Each monitor will implement its own kind of checking and set its condition afterward.
We also check to see if we have to abort monitor checking on a given monitor condition.
Raise a condition. The single parameter to this method is a monitor object which will have had its check() method called. This contains the resulting condition and any messages to notify.
Sets the threshold at which we will send messages to email & pager.
Any conditions equal or worse than the threshold will be sent if the message is not nullstring.
Control the emission of status and status message associated with the most sever monitor error. The monitor defaults to not doing this so you should call this method without parameters to turn it on.
Set the condition to stop checking monitor on. If this is set to something other than COND_NONE, then the first time a monitor is raised to this condition the checking process is stopped.
Documentation generated by phpDocumentor 1.3.0RC3