Class postgres_monitor

Description

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.

NOTE: The 'monitor' class which uses this class implements a rule which says that when a monitor (such as this one) returns a FATAL condition, then the checking process will die, having sent notifications out. If you don't want this to return the COND_FATAL condition on failure use the 'set_fail_condition()' method to set it to COND_ERROR.

Located in /monitor-defs.php (line 417)

generic_monitor
   |
   --postgres_monitor
Variable Summary
 mixed $dbid
 mixed $dbname
 mixed $host
 mixed $password
 mixed $port
 mixed $user
Method Summary
 postgres_monitor postgres_monitor (string $dbname, string $user, [string $password = ""], [string $host = ""], [string $port = ""])
 boolean check ()
Variables
mixed $dbid = false (line 422)

Database connection resource ID

mixed $dbname = "" (line 425)

Name of the database to connect to

mixed $host = "" (line 434)

For TCP connections: hostname to connect to

mixed $password = "" (line 431)

Password of username to connect as

mixed $port = "" (line 437)

For TCP connections: port to connect to

mixed $user = "" (line 428)

Username to connect as

Methods
Constructor postgres_monitor (line 447)

Define a new Postgres monitor object.

postgres_monitor postgres_monitor (string $dbname, string $user, [string $password = ""], [string $host = ""], [string $port = ""])
  • string $dbname: Name of the Postgres database
  • string $user: Username to connect as
  • string $password: User password, if required
  • string $host: Hostname for TCP connections
  • string $port: Port number for TCP connections
check (line 464)

Make the check, as to whether we can connect to the Postgres DB.

If not then return false, else return true.

  • return: True if Postgres could be connected to.
boolean check ()

Documentation generated by phpDocumentor 1.3.0RC3