From OpenNMS

Contents 1 Overview 2 Configuration 3 Example 3.1 Capsd Configuration 3.2 Poller Configuration 4 See Also 5 External Links 6 Version History/Availability

Overview

The JDBC monitor checks that it is able to connect to a given JDBC URL and that it is able to get the database catalog from that URL.

You need to place the DB .jar file driver for your DataBase version under the $OPENNMS_HOME/lib folder, so it's added to the CLASSPATH.

Configuration

The JDBC monitor takes the following parameters:

driver 

The JDBC driver to use. Defaults to "com.sybase.jdbc2.jdbc.SybDriver".

url 

The JDBC url to connect to. Defaults to "jdbc:sybase:Tds:host/tempdb".

user 

The username to connect as. Defaults to "sa".

password 

The password to connect with. Defaults to "".

timeout 

How long to wait for a connection in milliseconds. Defaults to "3000".

retries 

how many times to retry upon failure or timeout. Defaults to "0".

Example

Capsd Configuration

First, to be able to detect the database properly, you need to configure capsd-configuration.xml to find it, like so:

Sybase

 <protocol-plugin protocol="Sybase-JDBC" class-name="org.opennms.netmgt.capsd.plugins.JDBCPlugin" scan="on">
   <property key="user" value="sa"/>
   <property key="password" value="XXXX"/>
   <property key="retry" value="3"/>
   <property key="timeout" value="5000"/>
   <property key="driver" value="com.sybase.jdbc2.jdbc.SybDriver"/>
   <property key="url" value="jdbc:sybase:Tds:OPENNMS_JDBC_HOSTNAME:4100/tempdb"/>
 </protocol-plugin>

Oracle

 <protocol-plugin protocol="OracleDB" class-name="org.opennms.netmgt.capsd.plugins.JDBCPlugin" scan="on">
  <property key="user" value="username"/>
  <property key="password" value="password"/>
  <property key="timeout" value="3000"/>
  <property key="retry" value="3"/>
  <property key="driver" value="oracle.jdbc.driver.OracleDriver"/>
  <property key="url" value="jdbc:oracle:thin:@OPENNMS_JDBC_HOSTNAME:1521/DB_SERVICE_NAME"/>
</protocol-plugin>

(note, if you're on OpenNMS 1.2 or earlier, the JDBCPlugin is at "org.opennms.netmgt.capsd.JDBCPlugin" instead of "org.opennms.netmgt.capsd.plugins.JDBCPlugin".)

Poller Configuration

Then, to monitor it, you configure poller-configuration.xml like so:

Sybase

 <service name=”Sybase-JDBC” user-defined=”false” interval=”6000″ status=”on”>
   <parameter key=”user” value=”sa”/>
   <parameter key=”password” value=”XXXX”/>
   <parameter key=”timeout” value=”3000″/>
   <parameter key=”driver” value=”com.sybase.jdbc2.jdbc.SybDriver”/>
   <!– jdbc:sybase:Tds::/ –>
   <parameter key=”url” value=”jdbc:sybase:Tds:OPENNMS_JDBC_HOSTNAME:4100/tempdb”/>
 </service>
 <monitor service=”Sybase-JDBC” class-name=”org.opennms.netmgt.poller.monitors.JDBCMonitor”/>

Oracle

<service name="OracleDB" user-defined="false" interval="30000" status="on">
  <parameter key="user" value="username"/>
  <parameter key="password" value="password"/>
  <parameter key="timeout" value="3000"/>
  <parameter key="driver" value="oracle.jdbc.driver.OracleDriver"/>
  <parameter key="url" value="jdbc:oracle:thin:@OPENNMS_JDBC_HOSTNAME:1521/DB_SERVICE_NAME"/>
</service>
<monitor service="OracleDB" class-name="org.opennms.netmgt.poller.monitors.JDBCMonitor"/>

(and again, if you're on OpenNMS 1.2 or earlier, the JDBCMonitor is at "org.opennms.netmgt.poller.JDBCMonitor" instead of "org.opennms.netmgt.poller.monitors.JDBCMonitor".)

See Also

• JDBC stored procedure monitor - run a stored procedure and pass-fail based on the response.
• JDBC For MSSQL 200x - How to monitor and run stored procedures against a Microsoft SQL Server.

External Links

• Tarus's blog post about the monitor

Version History/Availability

• This feature was added in version 1.1.3