[monitor] element index

Package indexes

All elements
a c d e f h l m n p r s t u w
a
top
Method add_monitor
monitor::add_monitor() in monitor-defs.php
Add a new monitor. Eg. file_monitor, postgres_monitor etc. This just stuffs the object in an array ready to be checked.
Method add_timeslot
monitor::add_timeslot() in monitor-defs.php
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'.
c
top
Variable $condition
monitor::$condition in monitor-defs.php
Monitor highest priority condition
Variable $critsecs
file_monitor::$critsecs in monitor-defs.php
Seconds before error condition
Method check
lucene_monitor::check() in monitor-defs.php
Make the check on Lucene by firing the query off and checking for the expected number of hits coming back.
Method check
monitor::check() in monitor-defs.php
Check all monitors. Just iterate through them and raise the conditions
Method check
postgres_monitor::check() in monitor-defs.php
Make the check, as to whether we can connect to the Postgres DB.
Method check
process_monitor::check() in monitor-defs.php
Make the check on the time the file was last modified and if this is longer than this->warnsecs ago but less than this->errsecs then issue a warning. Otherwise if it is longer than this->errsecs ago then we issue an error message.
Method check
exec_monitor::check() in monitor-defs.php
Make the check by executing the script/program which has been
Method check
file_monitor::check() in monitor-defs.php
Make the check on the time the file was last modified and if this is longer than this->warnsecs ago but less than this->errsecs then issue a warning. Otherwise if it is longer than this->errsecs ago then we issue an error message.
Method check
diskspace_monitor::check() in monitor-defs.php
Check the space on the filesystem of the directory specified.
Method check_all_monitors
monitor::check_all_monitors() in monitor-defs.php
Iterate through all our monitors, checking in each case. Each monitor will implement its own kind of checking and set its condition afterward.
Method clear
monitor::clear() in monitor-defs.php
Clear all the monitors.
Constant COND_ALL
COND_ALL in monitor-defs.php
Aggregate: all conditions
Constant COND_CRITICAL
COND_CRITICAL in monitor-defs.php
Critical error condition
Constant COND_NONE
COND_NONE in monitor-defs.php
Aggregate: no conditions
Constant COND_OK
COND_OK in monitor-defs.php
Condition for a passed test
Constant COND_UNKNOWN
COND_UNKNOWN in monitor-defs.php
Condition is undefined
Constant COND_WARNING
COND_WARNING in monitor-defs.php
Warning condition
d
top
Variable $dbid
postgres_monitor::$dbid in monitor-defs.php
Database connection resource ID
Variable $dbname
postgres_monitor::$dbname in monitor-defs.php
Name of the database to connect to
Method diskspace_monitor
Class diskspace_monitor
diskspace_monitor in monitor-defs.php
Class which checks for a disk free space condition.
e
top
Variable $emailfrom
monitor::$emailfrom in monitor-defs.php
Address monitor messages come from
Variable $emailpager
monitor::$emailpager in monitor-defs.php
Address to email SMS txt messages
Variable $emailto
monitor::$emailto in monitor-defs.php
Address to email monitor messages
Variable $email_condition_threshold
Threshold condition for emailing
Variable $emit_status
monitor::$emit_status in monitor-defs.php
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'.
Variable $execparms
exec_monitor::$execparms in monitor-defs.php
Variable $execpath
exec_monitor::$execpath in monitor-defs.php
Class exec_monitor
exec_monitor in monitor-defs.php
A monitor class to exec a script/program on the OS. This allows you
Method exec_monitor
exec_monitor::exec_monitor() in monitor-defs.php
Define a new exec check object.
f
top
Variable $filepath
file_monitor::$filepath in monitor-defs.php
Path to the file to monitor
Variable $fsdir
diskspace_monitor::$fsdir in monitor-defs.php
Directory to check
Method file_monitor
file_monitor::file_monitor() in monitor-defs.php
Define a new file check object.
Class file_monitor
file_monitor in monitor-defs.php
A monitor class to check when files/directories were last modified.
h
top
Variable $host
postgres_monitor::$host in monitor-defs.php
For TCP connections: hostname to connect to
Variable $hostname
monitor::$hostname in monitor-defs.php
Local hostname we are running monitor on
l
top
Variable $locked
monitor::$locked in monitor-defs.php
True if we are locked via lockfile
Variable $lockfile
monitor::$lockfile in monitor-defs.php
Monitor lockfile object
Variable $lockfilepath
monitor::$lockfilepath in monitor-defs.php
Monitor lockfile path
Variable $luhits
lucene_monitor::$luhits in monitor-defs.php
Expected no. of hits
Variable $luhost
lucene_monitor::$luhost in monitor-defs.php
Lucene host
Variable $luhost_abbrev
lucene_monitor::$luhost_abbrev in monitor-defs.php
Lucene host abbreviation
Variable $luport
lucene_monitor::$luport in monitor-defs.php
Lucene port
Variable $lusearch
lucene_monitor::$lusearch in monitor-defs.php
The lucene search object
Class lucene_monitor
lucene_monitor in monitor-defs.php
A monitor class to check if Lucene is up and about
Method lucene_monitor
Define a new Lucene monitor object. We register the Lucene query to use and the number of hits we expect. You can also specify the hostname and port of the Lucene server here, although Axyl users can leave these out (blank) if they have configured them with setup-system.php.
m
top
Variable $message
monitor::$message in monitor-defs.php
Monitor highest priority message
Variable $minspace
diskspace_monitor::$minspace in monitor-defs.php
Threshold (bytes) before error condition
Variable $monitors
monitor::$monitors in monitor-defs.php
Array of monitors which do the work
Method monitor
monitor::monitor() in monitor-defs.php
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.
Class monitor
monitor in monitor-defs.php
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.
Page monitor-defs.php
monitor-defs.php in monitor-defs.php
n
top
Variable $name
monitor::$name in monitor-defs.php
The name of this monitor instance
Method notify
monitor::notify() in monitor-defs.php
Method to send notification(s)..
p
top
Variable $pager_condition_threshold
Threshold condition for paging
Variable $password
postgres_monitor::$password in monitor-defs.php
Password of username to connect as
Variable $pidfile
process_monitor::$pidfile in monitor-defs.php
Path to the PID file containing a process ID for the running process. Leave
Variable $port
postgres_monitor::$port in monitor-defs.php
For TCP connections: port to connect to
Variable $procname
process_monitor::$procname in monitor-defs.php
Name of the process being monitored.
Variable $ps_all_cmd
process_monitor::$ps_all_cmd in monitor-defs.php
The 'ps' command to use for an 'all processes list. This allows override
Variable $ps_pid_cmd
process_monitor::$ps_pid_cmd in monitor-defs.php
The 'ps' command to use for a specific process ID#. This allows override
Variable $publish_output
exec_monitor::$publish_output in monitor-defs.php
Method postgres_monitor
Define a new Postgres monitor object.
Class postgres_monitor
postgres_monitor in monitor-defs.php
A monitor class to check if Postgres is up and about. You need to specify a database and a user (and if required, a password) which can be use to test-connect to Postgres. Optionally you can specify the host and port number if connection is over TCP.
Method process_monitor
Defines a new process monitoring object and provides matching info.
Class process_monitor
process_monitor in monitor-defs.php
A monitor class to check if a given process is running. This can be achieved by consulting a pidfile, or by checking the process status listing for the given process name (the default behaviour).
r
top
Variable $reportmsg
monitor::$reportmsg in monitor-defs.php
Report staging for email
Method raise_condition
monitor::raise_condition() in monitor-defs.php
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.
s
top
Variable $schedule
monitor::$schedule in monitor-defs.php
Schedule of named timeslots for this monitor
Variable $smstxtmsg
monitor::$smstxtmsg in monitor-defs.php
Report staging for SMS txt
Variable $stop_on_condition
monitor::$stop_on_condition in monitor-defs.php
Condition to stop on. If this condition is defined then we
Variable $success_regex
exec_monitor::$success_regex in monitor-defs.php
Variable $success_value
exec_monitor::$success_value in monitor-defs.php
Method set_condition_thresholds
Sets the threshold at which we will send messages to email & pager.
Method set_emit_status
monitor::set_emit_status() in monitor-defs.php
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.
Method set_stop_on_condition
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.
Method set_success_regex
Allows you to specify a regular expression which will be applied to the output of the executed script/program and if matched will be taken to mean the check was successful. If specified, this takes the place of the default behaviour of checking the return code.
Method set_success_value
Allows you to specify a string value which, if returned as output by the called script/program, will indicate success.
t
top
Variable $tinow
monitor::$tinow in monitor-defs.php
The current Unix timestamp
u
top
Variable $user
postgres_monitor::$user in monitor-defs.php
Username to connect as
Variable $use_lockfile
monitor::$use_lockfile in monitor-defs.php
Whether to use a lockfile
w
top
Variable $warnsecs
file_monitor::$warnsecs in monitor-defs.php
Seconds before warning message
Variable $warnspace
diskspace_monitor::$warnspace in monitor-defs.php
Threshold (bytes) before warning condition
a c d e f h l m n p r s t u w