Retrieving Monitored Data About Data Sources

For a description of how Directory Proxy Server monitors the health of data sources, see Monitoring Data Sources in Oracle Directory Server Enterprise Edition Reference. This section describes how to configure the monitoring of data sources.

To Monitor a Data Source by Listening for Errors

In this type of monitoring, Directory Proxy Server listens for errors on the traffic between Directory Proxy Server and the data sources. This type of monitoring is called reactive monitoring because Directory Proxy Server reacts if an error is detected, but does not actively test data sources.

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

1. Set the monitoring mode for the data source to reactive.

   $ dpconf set-ldap-data-source-prop -h host -p port datasource monitoring-mode:reactive

2. Configure an alert to be sent when an error is detected or when a data source goes offline or online, as described in Configuring Administrative Alerts for Directory Proxy Server.

To Monitor a Data Source by Periodically Establishing Dedicated Connections

Directory Proxy Server creates a dedicated connection to a data source if there have been no requests to or responses from the data source for a specified interval.

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

1. Set the monitoring mode for the data source to proactive.

   $ dpconf set-ldap-data-source-prop -h host -p port datasource monitoring-mode:proactive

2. Configure the monitoring search request that is performed by Directory Proxy Server.

   $ dpconf set-ldap-data-source-prop -h host -p port datasource \
     monitoring-bind-timeout:timeout monitoring-entry-dn:dn \
     monitoring-search-filter:filter monitoring-entry-timeout:timeout

   The following properties are used in the search request:

   monitoring-bind-timeout

   The length of time that Directory Proxy Server waits to establish a connection to the data source. By default, the value of this property is 5 seconds.

   monitoring-entry-dn

   The DN of the target entry in the search request. By default, this property is the root DSE entry ("").

   monitoring-search-filter

   The search filter.

   monitoring-entry-timeout

   The length of time that Directory Proxy Server waits for the search response. By default, the value of this property is 5 seconds.

3. (Optional) Configure the proactive monitoring to bind as a specific user.

   $ dpconf set-ldap-data-source-prop ldap-data-source \
   monitoring-bind-dn:uid=user-id monitoring-bind-pwd-file:password-file

   Replace the user-id with a valid dn such as uid=bjensen,dc=example,dc=com and password-file with a path to the file containing password.

   By default, the bind is performed as anonymous, that is, both the monitoring-bind-dn and monitoring-bind-pwd attributes are set to none.

4. Set the polling interval.

   $ dpconf set-ldap-data-source-prop -h host -p port datasource \
   down-monitoring-interval:interval

   If a connection is down, Directory Proxy Server polls the connection at this interval to detect its recovery. If the interval is not specified, the value of monitoring-interval is used.

5. (Optional) Configure the availability monitor to specify the number of times it will poll the connection when it is first detected as down.

   $ dpconf set-ldap-data-source-prop -h host -p port datasource monitoring-retry-count:count

6. Configure an alert to be sent when a data source is detected as offline or online, as described in Configuring Administrative Alerts for Directory Proxy Server.

To Monitor a Data Source by Testing Established Connections

In this type of monitoring, Directory Proxy Server performs a search on each connection to each data source at a regular interval. In this way, Directory Proxy Server detects closed connections and prevents connections from being dropped because of inactivity.

You can use DSCC to perform this task. For information, see Directory Service Control Center Interface and the DSCC online help.

1. Set the monitoring mode for the data source to proactive.

   $ dpconf set-ldap-data-source-prop -h host -p port datasource monitoring-mode:proactive

2. Set the time interval after which Directory Proxy Server sends a request to a data source to prevent connections from being dropped.

   $ dpconf set-ldap-data-source-prop -h host -p port datasource \
    monitoring-inactivity-timeout:time

   By default, the inactivity timeout is 120 seconds.

3. (Optional) Configure the proactive monitoring to bind as a specific user.

   $ dpconf set-ldap-data-source-prop ldap-data-source
   monitoring-bind-dn:uid=user-id monitoring-bind-pwd-file:password-file

   Replace the user-id with a valid dn such as uid=bjensen,dc=example,dc=com and password-file with a path to the file containing password.

   By default, the bind is performed as anonymous, that is, both the monitoring-bind-dn and monitoring-bind-pwd attributes are set to none.

4. Configure an alert to be sent when a data source is detected as offline or online, as described in Configuring Administrative Alerts for Directory Proxy Server.