JDBCMonitor

The JDBCMonitor checks that it is able to connect to a database and checks if it is able to get the database catalog from that database management system (DBMS). It is based on the JDBC technology to connect and communicate with the database. This monitor implements placeholder substitution in parameter values.

Monitor Facts

Class Name

org.opennms.netmgt.poller.monitors.JDBCMonitor

Remote Enabled

true

Configuration and Use

Table 1. Monitor specific parameters for the JDBCMonitor
Parameter Description Required Default value Placeholder substitution

driver

JDBC driver class to use

required

org.postgresql.Driver

No

url

JDBC Url to connect to.

required

jdbc:postgresql://:OPENNMS_JDBC_HOSTNAME/opennms

Yes

user

Database user

required

postgres

Yes

password

Database password

required

empty string

Yes

retries

How many retries should be performed before failing the test

optional

0

No
The OPENNMS_JDBC_HOSTNAME is replaced in the url parameter with the IP or resolved hostname of the interface the monitored service is assigned to.

This monitor implements the Common Configuration Parameters.

Provide the Database Driver

The JDBCMonitor is based on JDBC and requires a JDBC driver to communicate with any database. Due to the fact that Horizon itself uses a PostgreSQL database, the PostgreSQL JDBC driver is available out of the box. For all other database systems a compatible JDBC driver has to be provided to Horizon as a jar-file. To provide a JDBC driver place the driver-jar in the opennms/lib folder of your Horizon.

Examples

The following example checks if the PostgreSQL database used by Horizon is available.

<service name="OpenNMS-DBMS" interval="30000" user-defined="true" status="on">
  <parameter key="driver" value="org.postgresql.Driver"/>
  <parameter key="url" value="jdbc:postgresql://OPENNMS_JDBC_HOSTNAME:5432/opennms"/>
  <parameter key="user" value="opennms"/>
  <parameter key="password" value="opennms"/>
</service>

<monitor service="OpenNMS-DBMS" class-name="org.opennms.netmgt.poller.monitors.JDBCMonitor" />