SURVIVOR: database Check Module
About database
basics
Module Type Scheduler Remote
check Yes Yes
syntax
     module database {
       type (postgres | oracle | oracleic | ingres | db2 | sybase | mysql | msql)
       name <string>
       [username <string>]
       [password <password>]
       [environment <string>]
       [environment ...]
     }
 

Dependencies

Arguments

Name Type Value
type string Database type. Currently supported types are postgres, oracle, oracleic, ingres, db2, sybase, mysql, and msql.
name string Database name or identifier.
username optional string Username to use if authentication is required.
password optional password Password to use if authentication is required.
environment optional string list Environment variables to set.

Description

The database module verifies that a database is functioning correctly by actually interacting with the database. The module connects to the database, and upon connection, "pings" the database to ensure a medium level of functionality. The process module can also be used to ensure that the database processes are running.

A problem is generated if the connection to the database fails or if the database ping fails.

Some databases require environment variables to be set in order for the connection to succeed. Oracle (but not Oracle Instant Client) requires ORACLE_HOME to be set; Ingres requires II_SYSTEM to be set; DB2 requires DB2INSTANCE to be set.

Examples

  1. To monitor an Oracle database:
        module database {
          type oracle
          name mydb1
          username /
          environment ORACLE_HOME=/opt/local
        }
        
  2. To monitor an Oracle database using an Instant Client installation:
        module database {
          type oracleic
          name mydb1
          username /
        }
        
  3. To monitor an Ingres database:
        module database {
          type ingres
          name testdb
          environment II_SYSTEM=/usr/ingres2
        }
        
  4. To monitor a Postgres database:
        module database {
          type postgres
          name horde
          username imp
          password notMyPassword
        }
        
  5. To monitor a DB2 database:
        module database {
          type db2
          name survivor
          username db2survivor
          password pword
          environment DB2INSTANCE=db2user
        }
        

$Date: 2006/12/10 01:42:48 $
$Revision: 0.11 $
keywords
environment
name
password
type
username