JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Fusion Middleware Administration Guide for Oracle Unified Directory 11g Release 1 (11.1.1)
search filter icon
search icon

Document Information

Preface

1.  Starting and Stopping the Server

2.  Configuring the Server Instance

3.  Configuring the Proxy Components

4.  Configuring Security Between Clients and Servers

5.  Configuring Security Between the Proxy and the Data Source

6.  Managing Oracle Unified Directory With Oracle Directory Services Manager

7.  Managing Directory Data

8.  Replicating Directory Data

9.  Controlling Access To Data

10.  Managing Users and Groups With dsconfig

11.  Managing Password Policies

12.  Managing Directory Schema

13.  Monitoring Oracle Unified Directory

Monitoring Overview

Configuring Monitor Providers

To View Monitor Providers

To Disable a Monitor Provider

Configuring Logs With the Log Publisher

Log Configuration Overview

Configuring Log Publishers

To List Existing Log Publishers

Logging Internal Operations

Configuring Log Retention Policies

To View the Log Retention Policies

To Create a Log Retention Policy

To Modify a Log Retention Policy

Configuring Log Rotation Policies

To View the Log Rotation Policies

To Create a Log Rotation Policy

To Set Log Rotation or Retention for a Specific Log File

Differences Between Logging in Oracle Unified Directory and Oracle Directory Server Enterprise Edition

Configuring Alerts and Account Status Notification Handlers

Managing Alert Handlers

To View All Configured Alert Handlers

To Enable an Alert Handler

To Configure an Alert Handler

Supported Alert Types

To Delete an Alert Handler

To Disable an Alert Type

Managing Account Status Notification Handlers

To View the Configured Account Status Notification Handlers

To Enable Account Status Notification Handlers

To Create a New Account Status Notification Handler

To Delete an Account Status Notification Handler

Monitoring the Server With LDAP

Viewing Monitoring Information Using the cn=monitor Entry

Monitored Attributes in the Oracle Unified Directory proxy

To View the Available Monitoring Information

To Monitor General-Purpose Server Information

To Monitor System Information

To Monitor Version Information

To Monitor the User Root Back End

To Monitor the Backup Back End

To Monitor the Tasks Back End

To Monitor the monitor Back End

To Monitor the Schema Back End

To Monitor the adminRoot Back End

To Monitor the ads-truststore Back End

To Monitor Client Connections

To Monitor the LDAP Connection Handler

To Monitor LDAP Connection Handler Statistics

To Monitor Connections on the LDAP Connection Handler

To Monitor the Administration Connector

To Monitor Administration Connector Statistics

To Monitor Connections on the Administration Connector

To Monitor the LDIF Connection Handler

To Monitor the Work Queue

To Monitor JVM Stack Trace Information

To Monitor the JVM Memory Usage

To Monitor the userRoot Database Environment

To Monitor the Entry Cache

To Monitor Network Groups

To Monitor Distributions

To Monitor Load Balancing

To Monitor Remote LDAP Servers

To Monitor a Global Index

To Monitor a Global Index Catalog

Monitoring Using the manage-tasks Command

Monitoring the Server With JConsole

To Configure JMX on a Server Instance

Starting JConsole

Accessing a Server Instance From JConsole

Viewing Monitoring Information With JConsole

Accessing Logs

To View the Access Logs

To View the Audit Logs

To View the Debug Logs

To View the Error Logs

To View the Replication Repair Logs

To View the server.out Logs

To View the vdp-setup Logs

Monitoring the Server With SNMP

Configuring the SNMP Connection Handler and Its Dependencies

To Configure SNMP in the Server

To View the SNMP Connection Handler Properties

To Access SNMP on a Server Instance

SNMP Security Configuration

SNMP Security Configuration: V1 and V2c

SNMP Security Configuration: V3

SNMP USM Configuration: V3

Monitoring a Replicated Topology

Monitoring Replication Status With dsreplication

Advanced Replication Monitoring

To Monitor the Topology and Its Connections

To Monitor Replication Latency

To Monitor Data Consistency

To Monitor Replication Security

To Monitor Replicated Updates

To Monitor Replication Conflicts

General Purpose Enterprise Monitoring Solutions

General UNIX Monitoring Tools

Solaris Monitoring Tools

HP-UX Monitoring Tools

14.  Tuning Performance

15.  Advanced Administration

Monitoring the Server With LDAP

Oracle Unified Directory provides a variety of methods to monitor the current state of the server for debugging or troubleshooting purposes.

The topics in this section assume that you have configured monitoring providers on the server. For more information, see Configuring Monitor Providers.

You can monitor the server over LDAP in the following ways:

Viewing Monitoring Information Using the cn=monitor Entry

The directory server records system, performance, and version information as an entry with the base DN of cn=monitor. This entry provides useful performance metrics and server state information that you can use to monitor and debug a directory server instance.

You can access the cn=monitor suffix over the regular LDAP port but there are advantages to using the administration port to access monitoring information. The main advantage of the administration connector is the separation of user traffic and administration traffic.

For example, if you monitor the number of connections on the LDAP Connection Handler ("cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 port port-number,cn=monitor") over the regular LDAP port, your monitoring data are "polluted" by the monitoring request itself. All of the examples in this section use the administration port, over SSL. For more information, see Managing Administration Traffic to the Server.

Monitored Attributes in the Oracle Unified Directory proxy

Monitoring information related to Oracle Unified Directory proxy can be collected at the level under cn=Monitor for dozens of attributes, including those relating to the following:

Other attributes are monitored under each of the above in the dn tree. For example, client connections are monitored under both cn=Client Connections, 0.0.0.0 portport number ,cn=monitor and under cn=Client Connections,cn=Administration Connector 0.0.0.0 portport number ,cn=monitor

A workflow element is monitored under the part of the tree to which that workflow element relates. For example, a load balancing workflow element can be monitored as cn=load-bal-route1,cn=load balancing,cn=monitor

Hundreds of statistics are collected by the Oracle Unified Directory proxy for monitoring. For example, for the persistent search function, psearchCount lists the number of persistent search operations and psearchTotalCount lists the number of persistent search operations since the last restart of the Oracle Unified Directory proxy.

You can list all of these statistics by using the ldapsearch command on the cn=monitor entry, as described in To View the Available Monitoring Information.

The following procedures use the ldapsearch command at the command line interface.

To view status information on the replication of global indexes, you can use the gicadm status-replication command. For more information, see To View the Status of a Replicated Global Index Catalog Configuration.

To View the Available Monitoring Information

Use the ldapsearch command to inspect the attributes of cn=monitor. This example lists the base DNs of each monitor entry.

To Monitor General-Purpose Server Information

To Monitor System Information

To Monitor Version Information

To Monitor the User Root Back End

The userRoot back end is the back-end database (the JE environment) for your data. The monitor displays the back end's general properties, such as writability mode, base DN, back-end IDs, entry count, and other properties.

To Monitor the Backup Back End

To Monitor the Tasks Back End

Tasks are administrative functions (such as import-ldif, export-ldif, backup, and restore) that can be scheduled for processing at some future date or on a recurring basis. The monitor displays the tasks back end's general properties, such as writability mode, base DN, back-end IDs, entry count, and other properties.

To Monitor the monitor Back End

This monitor displays the back end's general properties, such as writability mode, base DN, back-end IDs, entry count, and other properties.

To Monitor the Schema Back End

This monitor displays the schema back end's general properties, such as writability mode, base DN, back-end IDs, entry count, and other properties.

To Monitor the adminRoot Back End

This monitor displays the adminRoot back end's general properties, such as writability mode, base DN, back-end IDs, entry count, and other properties.

To Monitor the ads-truststore Back End

The ads-truststore holds a mirror, or copy, of the remote Administrative Directory Service (ADS) host's ADS key entry, so that the new instance can establish trust with existing servers in the ADS domain. The monitor displays the back end's general properties, such as writability mode, base DN, back-end IDs, entry count, and other properties.

To Monitor Client Connections

This monitor represents all of the open client connections. Its contents are different to those of the DN "cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor", which describes the open client connections on the LDAP connection handler only.

To Monitor the LDAP Connection Handler

This connection handler is used to interact with clients over LDAP.

To Monitor LDAP Connection Handler Statistics

To Monitor Connections on the LDAP Connection Handler

This monitor represents the open client connections on the LDAP connection handler.

To Monitor the Administration Connector

This monitor provides basic information about the administration connector. For more information, see Managing Administration Traffic to the Server.

To Monitor Administration Connector Statistics

This monitor provides extensive statistical information about operations that are performed through the administration connector. For more information, see Managing Administration Traffic to the Server.

To Monitor Connections on the Administration Connector

This monitor represents the open client connections on the Administration Connector.

To Monitor the LDIF Connection Handler

The LDIF connection handler is used to process changes that are read from an LDIF file, using internal operations. Monitoring information for the LDIF connection handler is only available if the connection handler is enabled.

To Monitor the Work Queue

The work queue keeps track of outstanding client requests and ensures that they are processed.

To Monitor JVM Stack Trace Information

You can access JVM Stack Trace information for your directory server instance. This resource monitor is implemented in the org.opends.server.monitors.StackTraceMonitorProvider class and requires no custom configuration.

To Monitor the JVM Memory Usage

To Monitor the userRoot Database Environment

The userRoot database environment utilizes the Berkeley DB Java Edition back end. JE monitoring data (data under cn=*Database Environment,cn=monitor) is reliable only in the short term. During high server activity (for example, anywhere from an hour to several days depending on the counter), this data can overflow. In such cases, the JE monitoring data can reflect negative values or positive but incorrect values. This is a known issue and is expected to be fixed in the next major release of the Berkeley DB Java Edition. Oracle SR numbers 15979 and 15985 correspond to this issue.

To Monitor the Entry Cache

You can access the aggregated state of all active entry caches for your directory server instance by accessing the cn=Entry Caches,cn=Monitor entry. The server can also request the "per cache" monitor data for a given instance if the entry cache instances are enabled in the directory server configuration:

Additionally, any arbitrarily named active entry cache instance should provide a monitor, which can be accessed by that instance name, for example cn=Any Arbitrary Name Entry Cache,cn=Monitor.

To Monitor Network Groups

To Monitor Distributions

To Monitor Load Balancing

To Monitor Remote LDAP Servers

To Monitor a Global Index

To Monitor a Global Index Catalog

Monitoring Using the manage-tasks Command

Oracle Unified Directory provides a tasks back end that provides a mechanism for scheduling and processing certain tasks, such as import-ldif, export-ldif, backup, and restore. You can schedule a task to run at specific times and at recurring periods. To monitor scheduled tasks, use the manage-tasks command. For more information, see Configuring Commands As Tasks.

Monitoring the Server With JConsole

The JConsole (jconsole) Java utility is a JMX-compliant, graphical tool that connects to a running Java Virtual Machine that has been started with the management agent. This generic tool can be used to access server monitoring information.

To Configure JMX on a Server Instance

  1. Start the server.
  2. Enable the JMX Connection Handler and set the port number to be used with JMX.

    Choose a port that is not in use and to which the user that is running the server has access rights.

    $ dsconfig -h localhost -p 4444 -D "cn=directory manager" -w password -n \
      set-connection-handler-prop \
      --handler-name "JMX Connection Handler" --set enabled:true --set listen-port:1689
  3. Add the JMX read, write, and notify privileges to the root DN.
    $ dsconfig -h localhost -p 4444 -D "cn=directory manager" -w password -n \
      set-root-dn-prop \
      --add default-root-privilege-name:jmx-read \
      --add default-root-privilege-name:jmx-write \
      --add default-root-privilege-name:jmx-notify
  4. Restart the server.
Starting JConsole

Start the console by typing jconsole in a terminal window.

To run jconsole from the command line, you might have to add JAVA_HOME/bin to your path, where JAVA_HOME is the directory containing the JDK. Alternatively, you can enter the full path when you type the command.

For more information about using JConsole, see Using JConsole.

Accessing a Server Instance From JConsole

To connect JConsole to a server instance, use the Remote Process fields.

Figure 13-1 New Connection to a Server

Figure shows a new connection to a server, using Java 6

The following fields are required:

Viewing Monitoring Information With JConsole

When JConsole is connected to a server instance, it displays management objects (MBeans). The tree on the left pane shows all MBeans currently available. You can access server monitoring information in the right hand pane by selecting the associated MBean.

The following figure shows the attribute list for a server cn=LDAP Connection Handler 0.0.0.0 port 1389 Statistics,cn=monitor.

Figure 13-2 Java Monitoring and Management Console

Figure shows monitoring information using Java 6

Accessing Logs

The server provides logging mechanisms to record access, error, or debugging information for the server instance. Multiple loggers of a given type can be active at any time, which makes it possible to create logs for specific subtrees or different repositories. The server does not currently provide logging filters to restrict the type of information in the logs.

The following logs are provided:

To View the Access Logs

  1. Change to the logs directory of the server instance.
    $ cd install-dir/logs
  2. Open the access file by using a text editor or the UNIX cat command.
    $ cat access | more
    [24/Oct/2008:16:02:52 -0500] CONNECT conn=0 from=127.0.0.1 to=127.0.0.1 protocol=LDAP
    [24/Oct/2008:16:02:52 -0500] BIND conn=0 op=0 msgID=1 type=SIMPLE dn="cn=Directory 
      Manager"
    [24/Oct/2008:16:02:53 -0500] BIND conn=0 op=0 msgID=1 result="Success"
    authDN="cn=Directory Manager,cn=Root DNs,cn=config" etime=57
    ...(more output)...

To View the Audit Logs

  1. Change to the logs directory of the server instance.
    $ cd install-dir/logs
  2. Open the audit file by using a text editor or the UNIX cat command.
    $ cat audit | more
    # 05/Nov/2008:13:32:58 -0600; conn=21; op=51
    dn: cn=File-Based Audit Logger,cn=Loggers,cn=config
    changetype: modify
    replace: ds-cfg-enabled
    ds-cfg-enabled: true
    -
    replace: modifiersName
    modifiersName: cn=Directory Manager,cn=Root DNs,cn=config
    -
    replace: modifyTimestamp
    modifyTimestamp: 20081105193257Z
    # 05/Nov/2008:13:33:17 -0600; conn=21; op=57
    dn: cn=File-Based Debug Logger,cn=Loggers,cn=config
    changetype: modify
    replace: ds-cfg-enabled
    ds-cfg-enabled: true
    -
    replace: modifiersName
    modifiersName: cn=Directory Manager,cn=Root DNs,cn=config
    -
    replace: modifyTimestamp
    modifyTimestamp: 20081105193316Z
    ...(more output)...

To View the Debug Logs

  1. Change to the logs directory of the server instance.
    $ cd install-dir/logs
  2. Open the debug file by using a text editor or the UNIX cat command.
    $ cat debug | more
    [24/Oct/2008:16:02:52 -0500] CONNECT conn=0 from=127.0.0.1 to=127.0.0.1 protocol=LDAP
    [24/Oct/2008:16:02:52 -0500] BIND conn=0 op=0 msgID=1 type=SIMPLE dn="cn=Directory 
      Manager"
    [24/Oct/2008:16:02:53 -0500] BIND conn=0 op=0 msgID=1 result="Success"
    authDN="cn=Directory Manager,cn=Root DNs,cn=config" etime=57
    ...(more output)...

To View the Error Logs

  1. Change to the logs directory of the server instance.
    $ cd install-dir/logs
  2. Open the errors file by using a text editor or the UNIX cat command.
    $ cat errors | more
    [24/Oct/2007:16:02:10 -0500] category=CONFIG severity=NOTICE msgID=3605006
    msg=Access control has been enabled and will use the
    org.opends.server.authorization.dseecompat.AciHandler implementation
    [24/Oct/2007:16:02:17 -0500] category=JEB severity=NOTICE msgID=8847402
    msg=The database backend userRoot containing 160 entries has started
    [24/Oct/2007:16:02:21 -0500] category=CORE severity=NOTICE msgID=458887
    msg=The Directory Server has started successfully
    ...(more output)...

To View the Replication Repair Logs

  1. Change to the logs directory of the server instance.
    $ cd install-dir/logs
  2. Open the replication file by using a text editor or the UNIX cat command.
    $ cat replication | more
    [09/Oct/2007:11:02:22 -0500] category=SYNC severity=NOTICE msgID=15138878
    msg=Replication Server sr1-carb-08/129.123.131.98:8989 now used for Replication 
    Domain cn=admin data
    [09/Oct/2007:11:02:23 -0500] category=SYNC severity=NOTICE msgID=15138878
    msg=Replication Server sr1-carb-08/129.123.131.98:8989 now used for Replication 
    Domain cn=schema
    [09/Oct/2007:11:02:23 -0500] category=SYNC severity=NOTICE msgID=15138878
    msg=Replication Server sr1-carb-08/129.123.131.98:8989 now used for Replication 
    Domain dc=example,dc=com
    ...(more output)...

To View the server.out Logs

  1. Change to the logs directory of the server instance.
    $ cd install-dir/logs
  2. Open the server.out file by using a text editor or the UNIX cat command.
    $ cat server.out | more
    [19/Jan/2011:14:56:53 +0100] category=CORE severity=INFORMATION msgID=132 
      msg=The Directory Server is beginning the configuration bootstrapping process
    [19/Jan/2011:14:56:55 +0100] category=EXTENSIONS severity=INFORMATION msgID=1049147 
      msg=Loaded extension from file '/local/instances/OracleJavaDirectory.11.1.1.4.3/lib/
      extensions/distribution.jar' (build 1.0.0, revision unknown)
    [19/Jan/2011:14:56:55 +0100] category=EXTENSIONS severity=INFORMATION msgID=1049147 
      msg=Loaded extension from file '/local/instances/OracleJavaDirectory.11.1.1.4.3/lib/
      extensions/globalindex.jar' (build 1.0.0, revision unknown)
    [19/Jan/2011:14:56:55 +0100] category=EXTENSIONS severity=INFORMATION msgID=1049147 
      msg=Loaded extension from file '/local/instances/OracleJavaDirectory.11.1.1.4.3/lib/
      extensions/loadbalancing.jar' (build 1.0.0, revision unknown)
    [19/Jan/2011:14:56:56 +0100] category=EXTENSIONS severity=INFORMATION msgID=1049147 
      msg=Loaded extension from file '/local/instances/OracleJavaDirectory.11.1.1.4.3/lib/
      extensions/proxyldap.jar' (build 1.0.0, revision unknown)
    [19/Jan/2011:14:56:56 +0100] category=EXTENSIONS severity=INFORMATION msgID=1049147 
      msg=Loaded extension from file '/local/instances/OracleJavaDirectory.11.1.1.4.3/lib/
      extensions/replication-gateway.jar' (build 1.0.0, revision unknown)
    [19/Jan/2011:14:56:56 +0100] category=EXTENSIONS severity=INFORMATION msgID=1049147 
      msg=Loaded extension from file '/local/instances/OracleJavaDirectory.11.1.1.4.3/lib/
      extensions/snmp-mib2605.jar' (build 11.1.1.4.3, revision unknown)
    [19/Jan/2011:14:56:56 +0100] category=EXTENSIONS severity=INFORMATION msgID=1049147 
      msg=Loaded extension from file '/local/instances/OracleJavaDirectory.11.1.1.4.3/lib/
      extensions/virtualization.jar' (build 1.0.0, revision unknown>)
    [19/Jan/2011:14:56:58 +0100] category=CORE severity=NOTICE msgID=458886 msg=Oracle Unified 
      Directory 11.1 (Oracle Unified Directory version = 11.1.1.4.3) (build 20101216222159Z, R1012160831) 
      starting up
    [19/Jan/2011:14:57:09 +0100] category=RUNTIME_INFORMATION severity=NOTICE msgID=20381717 
      msg=Installation Directory:  /local/instances/OracleJavaDirectory.11.1.1.4.3
    [19/Jan/2011:14:57:09 +0100] category=RUNTIME_INFORMATION severity=NOTICE msgID=20381719 
      msg=Instance Directory:      /local/instances/OracleJavaDirectory.11.1.1.4.3
    ...
    more output
    ...

To View the vdp-setup Logs

  1. Change to the logs directory of the server instance.
    $ cd install-dir/logs
  2. Open the vdp-setup file by using a text editor or the UNIX cat command.
    $ cat vdp-setup | more
    Jun 24, 2009 6:22:12 PM com.sun.dps.ui.deploy.SetupLog initLogFileHandler
    INFO: vdp-setup application launched June 24, 2009 6:22:12 PM MEST
    Jun 24, 2009 6:32:08 PM com.sun.dps.ui.deploy.step.ProgressThread executeConfigPhase
    INFO: /installationdir/vdp-setup --cli 
    --ldapPort 5389 --adminConnectorPort 4454 --rootUserDN cn=Directory\ Manager 
    --rootUserPassword ****** --doNotStart
    Jun 24, 2009 6:33:00 PM com.sun.dps.ui.deploy.step.ProgressThread executeConfigPhase
    INFO: /installationdir/bin/start-ds --timeout 0 
    Jun 24, 2009 6:33:06 PM com.sun.dps.ui.deploy.step.ProgressThread executeConfigPhase
    INFO: /installationdir/bin/dsconfig 
    create-trust-manager-provider --provider-name Backend\ Servers
    --type file-based --set enabled:true --set trust-store-file:/installationdir/co
    nfig/backend-servers-truststore --set trust-store-type:JKS 
    --set trust-store-pin-file:/installationdir/config/backend-servers-truststore.pin
    --hostname midgard --port 4454 --bind
    DN cn=Directory\ Manager --bindPassword ****** --trustAll --no-prompt 
    ...(more output)...