Docs For Class monitor

Description

The 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 704)

Variable Summary

mixed $condition

mixed $emailfrom

mixed $emailpager

mixed $emailto

mixed $email_condition_threshold

mixed $hostname

mixed $locked

mixed $lockfile

mixed $lockfilepath

mixed $monitors

mixed $name

mixed $pager_condition_threshold

mixed $reportmsg

mixed $schedule

mixed $smstxtmsg

mixed $tinow

mixed $use_lockfile

Method Summary

monitor monitor ([string $name = ""], [string $emailto = ""], [string $emailfrom = ""], [string $emailpager = ""], [string $lockfilepath = ""])

void add_monitor (object $monitor)

void add_timeslot (mixed $start, mixed $end, string $name)

void check ()

void check_all_monitors ()

void clear ()

void notify ()

void raise_condition (object $monitor)

void set_condition_thresholds (integer $email_cond, integer $pager_cond)

Variables

mixed $condition = COND_OK (line 732)

Monitor worst case condition

mixed $emailfrom = "" (line 711)

Address monitor messages come from

mixed $emailpager = "" (line 713)

Address to email SMS txt messages

mixed $emailto = "" (line 709)

Address to email monitor messages

mixed $email_condition_threshold = COND_WARNING (line 741)

Threshold condition for emailing

mixed $hostname = "" (line 720)

Local hostname we are running monitor on

mixed $locked = false (line 729)

True if we are locked via lockfile

mixed $lockfile (line 726)

Monitor lockfile object

mixed $lockfilepath = "" (line 715)

Monitor lockfile path

mixed $monitors = array() (line 753)

Array of monitors which do the work

mixed $name = "" (line 707)

The name of this monitor instance

mixed $pager_condition_threshold = COND_ERROR (line 744)

Threshold condition for paging

mixed $reportmsg = "" (line 735)

Report staging for email

mixed $schedule (line 750)

Schedule of named timeslots for this monitor

mixed $smstxtmsg = "" (line 738)

Report staging for SMS txt

mixed $tinow (line 747)

The current Unix timestamp

mixed $use_lockfile = true (line 723)

Whether to use a lockfile

Methods

Constructor monitor (line 763)

Create a new monitor object.

monitor monitor ([string $name = ""], [string $emailto = ""], [string $emailfrom = ""], [string $emailpager = ""], [string $lockfilepath = ""])

string $name: Name of this monitor instance (message prefix)
string $emailto: Email address to send monitor messages to
string $emailfrom: Email from-address for monitor messages
string $emailpager: Email address for pager TXT messages
string $lockfilepath: Path to lockfile (optional)

add_monitor (line 1053)

Add a new monitor. Eg. file_monitor, postgres_monitor etc. This just stuffs the object in an array ready to be checked.

void add_monitor (object $monitor)

object $monitor: New monitor object to add to our list

add_timeslot (line 1044)

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'.

void add_timeslot (mixed $start, mixed $end, string $name)

mixed $start: Start time for timeslot, string datetime or Unix timestamp
mixed $end: End time for timeslot, string datetime or Unix timestamp
string $name: The name or ID associated with this timeslot.

check (line 985)

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 FATAL, 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.

void check ()

check_all_monitors (line 960)

Iterate through all our monitors, checking in each case. Each monitor will implement its own kind of checking and set its condition afterward.

void check_all_monitors ()

clear (line 820)

Clear all the monitors.

void clear ()

notify (line 928)

Method to send notification(s)..

void notify ()

raise_condition (line 905)

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.

void raise_condition (object $monitor)

object $monitor: Monitor object which has had its check() method run

set_condition_thresholds (line 894)

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.

void set_condition_thresholds (integer $email_cond, integer $pager_cond)

integer $email_cond: Conditions >= this will be reported via email
integer $pager_cond: Conditions >= this will be reported via pager