Display Performance Monitoring Data for Oracle Unified Directory 12c

Before You Begin

This 15-minute tutorial shows you how you can access information about Oracle Unified Directory 12c (OUD) servers that is useful for monitoring and troubleshooting purposes. The cn=monitor entry contains information that is published by the monitor providers about OUD.

Background

Monitoring information and performance data can be found in various formats, such as cn=monitor, alerts, DIRECTORY_SERVER_MIB, and logs. In order to access performance monitoring information in the above forms, OUD must be configured to support the LDAP protocol for cn=monitor, Simple Mail Transfer Protocol for alerts, Simple Network Management Protocol for DIRECTORY_SERVER_MIB, and a file system for logs. This tutorial will look at LDAP searches on the cn=monitor entry which display similar performance monitoring information as provided by the Oracle Virtual Directory 11g Performance Monitor plugin.

What Do You Need?

An environment with:

At least 16 GB of physical memory
Oracle Enterprise Linux 6.6 or later

A basic understanding of Linux

This tutorial assumes that you have:

Installed Oracle Unified Directory 12c (12.2.1.3.0 or above)
You have configured an OUD LDAP server instance. The assumption for this OBE is that the OUD server is running on hostname oud.example.com, LDAP port 1389, and LDAP administration port 4444.
The perfmon.ldif sample data should be loaded to this OUD instance.
Defined the following environment variables:
- OUD_ORACLE_HOME=/u01/app/oracle/product/oud/oud
- OUD_INSTANCES=/u01/app/oracle/config/oud_instances

Configure a Directory Server Instance

Run the oud-setup utility from the command line to setup an OUD server instance.

# export INSTANCE_NAME=../../config/oud_instances/oud_monitor
# $OUD_ORACLE_HOME/oud-setup -i -n \
-p 1389 \
-D "cn=Directory Manager" \ 
-j ~/pwd.txt \
-b dc=example,dc=com \
--adminConnectorPort 4444 \
-l ~/perfmon.ldif

The output should look similar to this:

Oracle Unified Directory 12.2.1.4.0
Please wait while the setup program initializes...
Creating instance directory /u01/app/oracle/config/oud_instances/oud_monitor/OUD/.....Done.
See /u01/app/oracle/config/oud_instances/oud_monitor/OUD/logs/oud-setup for a detailed log of this operation.
Configuring Directory Server ..... Done.
Importing LDIF file /home/oracle/perfmon.ldif ........ Processed 15 entries, imported 15, skipped 0, rejected 0 and migrated 0 in 0 seconds (average rate 15.8/sec)
Starting Directory Server ........ Done.
To see basic server configuration status and configuration you can launch /u01/app/oracle/config/oud_instances/oud_monitor/OUD/bin/status

Note: The /home/oracle/pwd.txt should contain the password that you want to assign to your OUD Administrator.

List the Available Oracle Unified Directory Monitors

Run the following ldapsearch command to inspect the attributes of cn=monitor to view the available monitoring information in Oracle Unified Directory 12 c

Note: The LDAP Searches for cn=monitor are performed on OUD Admin Port 4444. The purpose and the usage of a few essential OUD performance monitors are shown in the following topics.
```
# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=monitor" "(objectclass=*)" "1.1"
```
The output should look similar to this:
```
dn: cn=monitor
dn: cn=ads-truststore Backend,cn=monitor
dn: cn=LDAP Administration Connector 0.0.0.0 port 4444,cn=monitor
dn: cn=userRoot Backend,cn=monitor
.	.	.
Click here to view all the Monitors
```

View the Details of System and Version OUD Monitors

Run the following ldapsearch command with base DN cn=System Information,cn=monitor to monitor the System information such as jvmArchitecture, java, jvm Versions and Vendor details etc.,

# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \ 
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=System Information,cn=monitor" "(objectclass=*)"

The output should look similar to this:

dn: cn=System Information,cn=monitor
availableCPUs: 4
jvmArguments: "-Dorg.opends.server.scriptName=start-ds"
.	.	.
Click here to view complete System information

Run the following ldapsearch command with base DN cn=Version,cn=monitor to monitor the productName, major, minor and product Version details etc,.

# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=Version,cn=monitor" "(objectclass=*)"

The output should look similar to this:

dn: cn=Version,cn=monitor
componentVersion: 3
fullVersion: Oracle Unified Directory 12.2.1.3.0
buildID: 20170727163142Z
.	.	.
Click here to view complete Version information

View the Details of LDAP Connection Handler OUD Monitor

Run the following ldapsearch command with base DN

cn=Client Connections,cn=LDAP Connection Handler
                    0.0.0.0 port 1389,cn=monitor

to represent all the open connections on the LDAP connection handler, if any.

# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=Client Connections, cn=LDAP connection Handler 0.0.0.0 port 1389, cn=monitor" \
"(objectclass=*)"

The output should look similar to this:

dn: cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor
objectClass: top
objectClass: ds-monitor-entry
objectClass: extensibleObject
cn: Client Connections

Run the following ldapsearch command with base DN

cn=LDAP Connection Handler 0.0.0.0 port 1389
                    Statistics,cn=monitor

to represent statistics such as all CRUD operations, number of compare, and bind requests etc., on the LDAP connection handler.

# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=LDAP Connection Handler 0.0.0.0 port 1389 Statistics, \
cn=monitor" "(objectclass=*)"

The output should look similar to this:

dn: cn=LDAP Connection Handler 0.0.0.0 port 1389 Statistics,cn=monitor
bindResponses: 12
ds-mon-failed-entry-exists-add-operations-total-count: 0
ds-mon-mod-operations-total-count: 0
.	.	.
Click here to view complete LDAP Connection handler statistics

View the Details of Administrator Connector OUD Monitor

Run the following ldapsearch command with base DN

cn=LDAP Administrator Connector 0.0.0.0 port
                    4444,cn=monitor

to provide basic information about the administration connector.

# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=LDAP Administrator Connector 0.0.0.0 port 4444, cn=monitor" \
"(objectclass=*)"

The output should look similar to this:

dn: cn=LDAP Administration Connector 0.0.0.0 port 4444,cn=monitor
ds-mon-config-dn: cn=ldap,cn=administration connectors,cn=config
ds-connectionhandler-protocol: LDAPS
ds-connectionhandler-num-connections: 1
.	.	.
Click here to view complete LDAP Administration details

Run the following ldapsearch command with base DN

cn=LDAP Administrator Connector 0.0.0.0 4444
                    Statistics,cn=monitor

to represent extensive statistical information about operations that are performed through the administration connector.

# cd $OUD_INSTANCES/oud_monitor//OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=LDAP Administrator Connector 0.0.0.0 port 4444 Statistics, \
cn=monitor" "(objectclass=*)"

The output should look similar to this:

dn: cn=LDAP Administration Connector 0.0.0.0 port 4444 Statistics,cn=monitor
bindResponses: 148
ds-mon-failed-entry-exists-add-operations-total-count: 0
ds-mon-mod-operations-total-count: 22
bindRequests: 148
.	.	.
Click here to view complete LDAP Administrator Connector statistics

View the Details of JVM Memory And Cache Monitors

Run the following ldapsearch command with base DN cn=JVM Memory Usage,cn=monitor to provide the snapshot of JVM memory.

# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=JVM Memory Usage, cn=monitor" \
"(objectclass=*)"

The output should look similar to this:

dn: cn=JVM Memory Usage,cn=monitor
code-cache-bytes-used-after-last-collection: 0
compressed-class-space-bytes-used-after-last-collection: 0
metaspace-current-bytes-used: 38293312
.	.	.
Click here to view complete JVM Memory details

Run the following ldapsearch command with base DN cn=Entry Caches,cn=monitor to access the aggregated state of all active entry caches for your directory server instance.

# cd $OUD_INSTANCES/oud_monitor/OUD/bin 
# ./ldapsearch -h localhost \
-p 4444 \
-D "cn=Directory Manager" \
-j ~/pwd.txt \
--useSSL \
--trustALL \
-s sub \
-b "cn=Entry Caches,cn=monitor" "(objectclass=*)"

The output should look similar to this:

dn: cn=Entry Caches,cn=monitor
entryCacheHits: 8
entryCacheHitRatio: 0
entryCacheTries: 3007
currentEntryCacheCount: 2
.	.	.
Click here to view complete Cache details