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 Sun OpenDS Standard Edition proxy

Monitoring information related to Sun OpenDS Standard Edition proxy can be collected at the level under cn=Monitor for dozens of attributes, including those relating to the following:

• Workflows: cn=workflow,cn=monitor

• Network Groups: cn=Network Groups,cn=monitor

• Load balancers: cn=load balancing,cn=monitor

• Distributions: cn=distribution,cn=monitor

• Global Index Catalogs: cn=Global Index Catalogs,cn=monitor

• Client Connections: cn=Client Connections,cn=monitor or under cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 portport number ,cn=monitor

• LDAP Connection Handler: cn=LDAP Connection Handler 0.0.0.0 portport number ,cn=monitor

• LDAP Connection Handler Statistics: cn=LDAP Connection Handler 0.0.0.0 portport number statistics,cn=monitor

• SNMP Connection Handler: cn=SNMP Connection Handler,cn=Monitor

• JMX Connection Handler: cn=JMX Connection Handler port number ,cn=monitor

• Administration Connector: cn=Administration Connector 0.0.0.0 portport number ,cn=monitor

• System Information: cn=System Information,cn=monitor

• Version: cn=Version,cn=monitor

• Back-end LDAP servers: cn=LDAP Servers,cn=monitor

• JVM stack traces: cn=JVM Stack Trace,cn=monitor

• JVM memory usage: cn=JVM Memory Usage,cn=Monitor

• SNMP: cn=SNMP,cn=Monitor

• Backend Backup: cn=backup Backend,cn=monitor

• Monitoring of back-end data: cn=monitor Backend,cn=monitor

• Tasks on the Backend Backup: cn=backup Backend,cn=monitor

• Entry caches: cn=Entry Caches,cn=monitor

• Work queues: cn=Work Queue,cn=monitor

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 Sun OpenDS Standard Edition 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 Sun OpenDS Standard Edition proxy.

All of these statistics are globally listed by executing the ldapsearch cn=monitor command as explained in To View the Available Monitoring Information.

The following procedures use the ldapsearch command at the command line interface. It is also possible to view monitoring information and statistics by using the Control Panel. For details, see Monitoring the Proxy Server With the Control Panel.

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.

• Run the ldapsearch command with a search scope of sub and the search attribute 1.1.

  This search attribute indicates that no attributes should be included in the matching entries.

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll  -s sub -b "cn=monitor" "(objectclass=*)" "1.1"
  dn: cn=monitor
  dn: cn=Client Connections,cn=monitor
  dn: cn=ads-truststore Backend,cn=monitor
  dn: cn=Network Groups,cn=monitor
  dn: cn=internal,cn=Network Groups,cn=monitor
  dn: cn=default,cn=Network Groups,cn=monitor
  dn: cn=LDAP Connection Handler 0.0.0.0 port 1389 Statistics,cn=monitor
  dn: cn=Administration Connector 0.0.0.0 port 4444,cn=monitor
  dn: cn=Client Connections,cn=Administration Connector 0.0.0.0 port 4444,cn=monitor
  dn: cn=backup Backend,cn=monitor
  dn: cn=Version,cn=monitor
  dn: cn=Work Queue,cn=monitor
  dn: cn=System Information,cn=monitor
  dn: cn=userRoot Database Environment,cn=monitor
  dn: cn=tasks Backend,cn=monitor
  dn: cn=adminRoot Backend,cn=monitor
  dn: cn=userRoot Backend,cn=monitor
  dn: cn=schema Backend,cn=monitor
  dn: cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor
  dn: cn=admin,cn=Network Groups,cn=monitor
  dn: cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor
  dn: cn=JVM Memory Usage,cn=monitor
  dn: cn=Administration Connector 0.0.0.0 port 4444 Statistics,cn=monitor
  dn: cn=JVM Stack Trace,cn=monitor
  dn: cn=Entry Caches,cn=monitor
  dn: cn=monitor Backend,cn=monitor

To Monitor General-Purpose Server Information

• Use the ldapsearch command with a base DN of "cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=monitor" "(objectclass=*)"

  Output will be similar to the following:

  dn: cn=monitor
  startTime: 20090702103150Z
  objectClass: extensibleObject
  objectClass: top
  objectClass: ds-monitor-entry
  cn: monitor
  vendorName: Sun Microsystems, Inc.
  currentTime: 20090702103850Z
  vendorVersion: Sun OpenDS Standard Edition 2.0.0
  maxConnections: 1
  productName: Sun OpenDS Standard Edition
  currentConnections: 1
  totalConnections: 3
  upTime: 0 days 0 hours 7 minutes 0 seconds 

To Monitor System Information

• Use the ldapsearch command with the base DN "cn=System Information,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=System Information,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=System Information,cn=monitor
  javaVersion: 1.6.0_10
  jvmArchitecture: 32-bit
  jvmArguments: "-Dorg.opends.server.scriptName=start-ds"
  jvmVersion: 11.0-b15
  classPath: /local/instances/SunOpenDS_SE2.0-standalone/classes:
  /local/instances/SunOpenDS_SE2.0-standalone/resources/resources.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/activation.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/aspectjrt.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/je.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/mail.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/OpenDS_de.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/OpenDS_es.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/OpenDS_fr.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/OpenDS_ja.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/OpenDS.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/OpenDS_zh_CN.jar:
  /local/instances/SunOpenDS_SE2.0-standalone/lib/quicksetup.jar
  usedMemory: 83361792
  freeUsedMemory: 21020432
  objectClass: extensibleObject
  objectClass: top
  objectClass: ds-monitor-entry
  javaVendor: Sun Microsystems Inc.
  operatingSystem: SunOS 5.11 x86
  cn: System Information
  systemName: llandudno
  workingDirectory: /local/instances/SunOpenDS_SE2.0-standalone/bin
  maxMemory: 518717440
  availableCPUs: 2
  javaHome: /usr/jdk/instances/jdk1.6.0/jre
  jvmVendor: Sun Microsystems Inc.

To Monitor Version Information

• Use the ldapsearch command with base DN "cn=Version,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -b "cn=Version,cn=Monitor" "(objectclass=*)"

  The beginning of the output will be similar to the following:

  dn: cn=Version,cn=monitor
  revisionNumber: 5492
  shortName: OpenDS
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  compactVersion: OpenDS-2.0.0
  pointVersion: 0
  cn: Version
  buildID: 20090630082738Z
  majorVersion: 2
  productName: Sun OpenDS Standard Edition
  minorVersion: 0
  fullVersion: Sun OpenDS Standard Edition 2.0.0

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.

• Use the ldapsearch command with base DN "cn=userRoot Backend,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=userRoot Backend,cn=monitor" "(objectclass=*)"
  dn: cn=userRoot Backend,cn=monitor

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-backend-monitor-entry
  ds-backend-is-private: FALSE
  cn: userRoot Backend
  ds-backend-writability-mode: enabled
  ds-backend-entry-count: 2002
  ds-backend-id: userRoot
  ds-base-dn-entry-count: 2002 dc=example,dc=com
  ds-backend-base-dn: dc=example,dc=com 

To Monitor the Backup Back End

• Use the ldapsearch command with base DN "cn=backup Backend,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=backup Backend,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=backup Backend,cn=monitor
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-backend-monitor-entry
  ds-backend-is-private: TRUE
  cn: backup Backend
  ds-backend-writability-mode: disabled
  ds-backend-entry-count: 1
  ds-backend-id: backup
  ds-base-dn-entry-count: 1 cn=backups
  ds-backend-base-dn: cn=backups 

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.

• Use the ldapsearch command with base DN "cn=Tasks Backend,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=Tasks Backend,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=tasks Backend,cn=monitor
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-backend-monitor-entry
  ds-backend-is-private: TRUE
  cn: tasks Backend
  ds-backend-writability-mode: enabled
  ds-backend-entry-count: 3
  ds-backend-id: tasks
  ds-base-dn-entry-count: 3 cn=tasks
  ds-backend-base-dn: cn=tasks

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.

• Use the ldapsearch command with base DN "cn=monitor Backend,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=monitor Backend,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=monitor Backend,cn=monitor
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-backend-monitor-entry
  ds-backend-is-private: TRUE
  cn: monitor Backend
  ds-backend-writability-mode: disabled
  ds-backend-entry-count: 25
  ds-backend-id: monitor
  ds-base-dn-entry-count: 25 cn=monitor
  ds-backend-base-dn: cn=monitor

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.

• Use the ldapsearch command with base DN "cn=schema Backend,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=schema Backend,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=schema Backend,cn=monitor
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-backend-monitor-entry
  ds-backend-is-private: TRUE
  cn: schema Backend
  ds-backend-writability-mode: enabled
  ds-backend-entry-count: 1
  ds-backend-id: schema
  ds-base-dn-entry-count: 1 cn=schema
  ds-backend-base-dn: cn=schema

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.

• Use the ldapsearch command with base DN "cn=adminRoot Backend,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=adminRoot Backend,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=adminRoot Backend,cn=monitor
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-backend-monitor-entry
  ds-backend-is-private: TRUE
  cn: adminRoot Backend
  ds-backend-writability-mode: enabled
  ds-backend-entry-count: 7
  ds-backend-id: adminRoot
  ds-base-dn-entry-count: 7 cn=admin data
  ds-backend-base-dn: cn=admin data

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.

• Use the ldapsearch command with base DN "cn=ads-truststore Backend,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=ads-truststore Backend,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=ads-truststore Backend,cn=monitor
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-backend-monitor-entry
  ds-backend-is-private: TRUE
  cn: ads-truststore Backend
  ds-backend-writability-mode: enabled
  ds-backend-entry-count: 3
  ds-backend-id: ads-truststore
  ds-base-dn-entry-count: 3 cn=ads-truststore
  ds-backend-base-dn: cn=ads-truststore

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.

• Use the ldapsearch command with base DN "cn=Client Connections,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=Client Connections,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=Client Connections,cn=monitor
  connection: connID="11" connectTime="20090702125632Z" source="127.0.0.1:54044" 
  destination="127.0.0.1:1389" ldapVersion="3" authDN="cn=Directory Manager,cn=Root DNs,
  cn=config" security="none" opsInProgress="1"
  cn: Client Connections
  objectClass: extensibleObject
  objectClass: top
  objectClass: ds-monitor-entry

To Monitor the LDAP Connection Handler

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

• Use the ldapsearch command with base DN "cn=LDAP Connection Handler 0.0.0.0 port port-number,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor" \
    "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor
  ds-connectionhandler-listener: 0.0.0.0:1389
  ds-connectionhandler-num-connections: 1
  ds-connectionhandler-protocol: LDAP
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-connectionhandler-monitor-entry
  ds-mon-config-dn: cn=ldap connection handler,cn=connection handlers,cn=config
  cn: LDAP Connection Handler 0.0.0.0 port 1389
  ds-connectionhandler-connection: connID="22" connectTime="20090702133936Z" 
  source="127.0.0.1:39574" destination="127.0.0.1:1389" ldapVersion="3" 
  authDN="cn=Directory Manager,cn=Root DNs,cn=config" security="none" opsInProgress="1"

To Monitor LDAP Connection Handler Statistics

• Use the ldapsearch command with base DN "cn=LDAP Connection Handler 0.0.0.0 port port-number Statistics,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=LDAP Connection Handler 0.0.0.0 port 1389 Statistics,cn=monitor" \
    "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=LDAP Connection Handler 0.0.0.0 port 1389 Statistics,cn=monitor
  objectClass: ds-monitor-entry
  objectClass: top
  objectClass: extensibleObject
  operationsCompleted: 37
  compareRequests: 0
  bytesWritten: 99488
  extendedRequests: 0
  addRequests: 0
  bindRequests: 19
  ...(more output)

To Monitor Connections on the LDAP Connection Handler

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

• Use the ldapsearch command with base DN "cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 port port-number,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll \
    -b "cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor" \
    "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=Client Connections,cn=LDAP Connection Handler 0.0.0.0 port 1389,cn=monitor
  connection: connID="0" connectTime="20090706084747Z" source="127.0.0.1:57523" de
  stination="127.0.0.1:1389" ldapVersion="3" authDN="" security="none" opsInProgr
  ess="0"
  connection: connID="1" connectTime="20090706084747Z" source="127.0.0.1:57524" de
  stination="127.0.0.1:1389" ldapVersion="3" authDN="" security="none" opsInProgr
  ess="0"
  connection: connID="2" connectTime="20090706084747Z" source="127.0.0.1:57525" de
  stination="127.0.0.1:1389" ldapVersion="3" authDN="" security="none" opsInProgr
  ess="0"
  connection: connID="3" connectTime="20090706084747Z" source="127.0.0.1:57526" de
  stination="127.0.0.1:1389" ldapVersion="3" authDN="" security="none" opsInProgr
  ess="0"
  connection: connID="4" connectTime="20090706084747Z" source="127.0.0.1:57527" de
  stination="127.0.0.1:1389" ldapVersion="3" authDN="" security="none" opsInProgr
  ess="0"

To Monitor the Administration Connector

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

• Use the ldapsearch command with base DN "cn=Administration Connector 0.0.0.0 port admin-port-number,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -b "cn=Administration Connector 0.0.0.0 port 4444,cn=monitor" \
    "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-connectionhandler-monitor-entry
  dn: cn=Administration Connector 0.0.0.0 port 4444,cn=monitor
  ds-connectionhandler-listener: 0.0.0.0:4444
  ds-connectionhandler-num-connections: 0
  ds-connectionhandler-protocol: LDAPS
  cn: Administration Connector 0.0.0.0 port 4444
  ds-mon-config-dn: cn=administration connector,cn=config

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.

• Use the ldapsearch command with base DN "cn=Administration Connector 0.0.0.0 port admin-port-number Statistics,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -b "cn=Administration Connector 0.0.0.0 port 4444 Statistics,cn=monitor" \
    "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=Administration Connector 0.0.0.0 port 4444 Statistics,cn=monitor
  compareResponses: 0
  connectionsClosed: 1
  searchResultsDone: 4
  ds-mon-resident-time-mod-operations-total-time: 92257568
  extendedResponses: 0
  bindRequests: 2
  operationsAbandoned: 0
  bytesWritten: 45056
  addResponses: 0
  addRequests: 0
  ds-mon-resident-time-moddn-operations-total-time: 0
  ds-mon-extended-operations-total-count: 0
  ds-mon-moddn-operations-total-count: 0
  modifyResponses: 1
  operationsCompleted: 7
  ...(more output)...

To Monitor Connections on the Administration Connector

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

• Use the ldapsearch command with base DN "cn=Client Connections,cn=Administration Connector 0.0.0.0 port port-number,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll \
    -b "cn=Client Connections,cn=Administration Connector 0.0.0.0 port 4444,cn=monitor" \
    "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  dn: cn=Client Connections,cn=Administration Connector 0.0.0.0 port 4444,cn=monitor
  connection: connID="339" connectTime="20090707075218Z" source="127.0.0.1:48213" 
  destination="127.0.0.1:4444" ldapVersion="3" authDN="" security="TLS"
   opsInProgress="1"
  cn: Client Connections

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.

• Use the ldapsearch command with base DN "cn=LDIF Connection Handler,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=LDIF Connection Handler,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-connectionhandler-monitor-entry
  dn: cn=LDIF Connection Handler,cn=monitor
  ds-connectionhandler-num-connections: 0
  ds-connectionhandler-protocol: LDIF
  ds-mon-config-dn: cn=ldif connection handler,cn=connection handlers,cn=config
  cn: LDIF Connection Handler

To Monitor the Work Queue

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

• Use the ldapsearch command with base DN "cn=Work Queue,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=Work Queue,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=Work Queue,cn=monitor
  currentRequestBacklog: 0
  objectClass: extensibleObject
  objectClass: top
  objectClass: ds-monitor-entry
  requestsSubmitted: 25
  cn: Work Queue
  maxRequestBacklog: 0
  averageRequestBacklog: 0
  requestsRejectedDueToQueueFull: 0

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.

• Use the ldapsearch command with the base DN "cn=JVM Stack Trace,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=JVM Stack Trace,cn=monitor" "(objectclass=*)"

  Depending on your configuration, the beginning of the output will be similar to the following:

  dn: cn=JVM Stack Trace,cn=monitor
  cn: JVM Stack Trace
  jvmThread: id=2 ---------- Reference Handler ----------
  jvmThread: id=2 frame[0]=java.lang.Object.wait(Object.java:native)
  jvmThread: id=2 frame[1]=java.lang.Object.wait(Object.java:485)
  jvmThread: id=2 frame[2]=java.lang.ref.Reference$ReferenceHandler.run(Reference.
  java:116)
  jvmThread: id=3 ---------- Finalizer ----------
  jvmThread: id=3 frame[0]=java.lang.Object.wait(Object.java:native)
  jvmThread: id=3 frame[1]=java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java
  :116)
  jvmThread: id=3 frame[2]=java.lang.ref.ReferenceQueue.remove(ReferenceQueue.java
  :132)
  jvmThread: id=3 frame[3]=java.lang.ref.Finalizer$FinalizerThread.run(Finalizer.j
  ava:159)
  jvmThread: id=4 ---------- Signal Dispatcher ----------
  jvmThread: id=10 ---------- Time Thread ----------
  jvmThread: id=10 frame[0]=sun.misc.Unsafe.park(Unsafe.java:native)
  jvmThread: id=10 frame[1]=java.util.concurrent.locks.LockSupport.parkNanos(LockS
  upport.java:198) 
  ...(more output)...

To Monitor the JVM Memory Usage

• Use the ldapsearch command with base DN "cn=JVM Memory Usage,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=JVM Memory Usage,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=JVM Memory Usage,cn=monitor
  ps-eden-space-bytes-used-after-last-collection: 0
  ps-mark-sweep-total-collection-count: 0
  code-cache-bytes-used-after-last-collection: 0
  ps-old-gen-current-bytes-used: 25260472
  ps-perm-gen-bytes-used-after-last-collection: 0
  ps-scavenge-recent-collection-duration: 3
  ps-scavenge-total-collection-count: 17
  ps-eden-space-current-bytes-used: 32001992
  ps-perm-gen-current-bytes-used: 21179960
  ps-old-gen-bytes-used-after-last-collection: 0
  ps-mark-sweep-total-collection-duration: 0
  ps-mark-sweep-average-collection-duration: 0
  ps-scavenge-average-collection-duration: 26
  ps-scavenge-total-collection-duration: 443
  objectClass: extensibleObject
  objectClass: top
  objectClass: ds-monitor-entry
  ps-mark-sweep-recent-collection-duration: 0
  ps-survivor-space-bytes-used-after-last-collection: 622592
  cn: JVM Memory Usage
  code-cache-current-bytes-used: 2143680
  ps-survivor-space-current-bytes-used: 622592 

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.

• Use the ldapsearch command with base DN "cn=userRoot Database Environment,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=userRoot Database Environment,cn=monitor" "(objectclass=*)"
  dn: cn=userRoot Database Environment,cn=monitor

  Depending on your configuration, output will be similar to the following:

  EnvironmentNTempBufferWrites: 0
  EnvironmentNNodesExplicitlyEvicted: 0
  EnvironmentCleanerBacklog: 0
  EnvironmentTotalLogSize: 5386067
  EnvironmentLockBytes: 2000
  EnvironmentNFullBINFlush: 2
  EnvironmentNBINsStripped: 0
  EnvironmentLastCheckpointEnd: 5385359
  TransactionNCommits: 24
  EnvironmentNCleanerEntriesRead: 0
  EnvironmentNRepeatFaultReads: 2
  TransactionNXACommits: 0
  EnvironmentNClusterLNsProcessed: 0
  TransactionNBegins: 24
  LockNOwners: 25
  ...(more output)...

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:

• cn=FIFO Entry Cache,cn=Monitor

• cn=Soft Reference Entry Cache,cn=Monitor

• cn=File System Entry Cache,cn=Monitor

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.

• Use the ldapsearch command with base DN "cn=Entry Caches,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password --useSSL \
    --trustAll -s base -b "cn=Entry Caches,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=Entry Caches,cn=monitor
  entryCacheHits: 0
  entryCacheTries: 0
  currentEntryCacheCount: 0
  objectClass: extensibleObject
  objectClass: top
  objectClass: ds-monitor-entry
  entryCacheHitRatio: 0
  cn: Entry Caches
  ...

To Monitor Network Groups

• Use the ldapsearch command with the base DN "cn=Network Groups,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password \
  --useSSL --trustAll -b "cn=Network Groups,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-mon-branch
  dn: cn=Network Groups,cn=monitor
  dn: cn=admin,cn=Network Groups,cn=monitor
  ds-mon-compare-operations-total-count: 0
  ds-mon-failed-referrals-total-count: 15
  ds-mon-unbind-operations-total-count: 13
  ds-mon-followed-referrals-total-count: 34
  ds-mon-violations-schema-total-count: Not implemented
  ds-mon-bind-operations-total-count: 98
  ds-mon-persistent-searchs-count: Not implemented
  ds-mon-add-operations-total-count: 37
  ds-mon-abandon-operations-total-count: 0
  ds-mon-moddn-operations-total-count: 0
  ds-mon-extended-operations-total-count: 0
  ds-mon-searchsubtree-operations-total-count: 310
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  ds-mon-discarded-referrals-total-count: Not implemented
  ds-mon-mod-operations-total-count: 1
  ds-mon-forwarded-referrals-total-count: Not implemented
  cn: admin
  ds-mon-searchonelevel-operations-total-count: 92966
  ds-mon-delete-operations-total-count: 0
  
  dn: cn=default,cn=Network Groups,cn=monitor
  ...

To Monitor Distributions

• Use the ldapsearch command with the base DN "cn=Distribution,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=directory manager" -w password \
    --useSSL --trustAll -b "cn=Distribution,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-mon-branch
  dn: cn=distribution,cn=monitor
  
  cn: distrib-we
  ds-mon-searchonelevel-operations-total-count: 0
  ds-mon-residenttime-bind-operations-max-time: 0
  ...
  
  ds-mon-delete-operations-total-count: 0
  
  dn: cn=algorithm,cn=distrib-we,cn=distribution,cn=monitor
  ds-mon-residenttime-total-time: 0
  ds-mon-residenttime-max-time: 0
  cn: algorithm
  ds-mon-runs-total-count: 0
  ds-mon-residenttime-min-time: 0
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  
  dn: cn=partitions,cn=algorithm,cn=distrib-we,cn=distribution,cn=monitor
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-mon-branch
  
  dn: cn=distrib-part1,cn=partitions,cn=algorithm,cn=distrib-we,cn=distribution,cn
   =monitor
  ...
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  ds-mon-modify-operations-total-count: 0
  cn: distrib-part1
  ds-mon-searchonelevel-operations-total-count: 0
  ds-mon-delete-operations-total-count: 0
  
  dn: cn=distrib-part2,cn=partitions,cn=algorithm,cn=distrib-we,cn=distribution,cn
   =monitor
  
  ...

To Monitor Load Balancing

• Use the ldapsearch command with the base DN "cn=load balancing,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=Directory Manager" -w password \
    --useSSL --trustAll -b "cn=load balancing,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-mon-branch
  dn: cn=load balancing,cn=monitor
  dn: cn=load-bal-we1,cn=load balancing,cn=monitor
  ds-mon-aborted-add-operations-total-count: 0
  ...
  dn: cn=algorithm,cn=load-bal-we1,cn=load balancing,cn=monitor
  
  dn: cn=routes,cn=algorithm,cn=load-bal-we1,cn=load balancing,cn=monitor
  ...
  dn: cn=load-bal-route1,cn=routes,cn=algorithm,cn=load-bal-we1,cn=load balancing,
   cn=monitor
  ...
  dn: cn=load-bal-we2,cn=load balancing,cn=monitor
  ...
  dn: cn=algorithm,cn=load-bal-we2,cn=load balancing,cn=monitor
  ...
  dn: cn=routes,cn=algorithm,cn=load-bal-we2,cn=load balancing,cn=monitor
  
  dn: cn=load-bal-route1,cn=routes,cn=algorithm,cn=load-bal-we2,cn=load balancing,
   cn=monitor
  ...
  cn: load-bal-route1
  
  dn: cn=load-bal-route2,cn=routes,cn=algorithm,cn=load-bal-we1,cn=load balancing,
   cn=monitor
  ...
  cn: load-bal-route2
  
  dn: cn=load-bal-route2,cn=routes,cn=algorithm,cn=load-bal-we2,cn=load balancing,
   cn=monitor
  
  cn: load-bal-route2
  ds-mon-searchonelevel-operations-total-count: 9
  ds-mon-delete-operations-total-count: 0

To Monitor Remote LDAP Servers

• Use the ldapsearch command with the base DN "cn=LDAP Servers,cn=monitor".

  $ ldapsearch -h localhost -p 4444 -D "cn=Directory Manager" -w password \
    --useSSL --trustAll -b "cn=LDAP Servers,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: ds-mon-branch
  dn: cn=LDAP Servers,cn=monitor
  
  dn: cn=proxy1,cn=LDAP Servers,cn=monitor
  ds-mon-aborted-add-operations-total-count: 0
  ...
  cn: proxy1
  ds-mon-searchonelevel-operations-total-count: 0
  ...
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  
  dn: cn=proxy2,cn=LDAP Servers,cn=monitor
  ds-mon-aborted-add-operations-total-count: 0
  ...
  cn: proxy2
  ds-mon-searchonelevel-operations-total-count: 0
  ...
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  ...
  dn: cn=proxy3,cn=LDAP Servers,cn=monitor
  ...
  cn: proxy3
  ds-mon-searchonelevel-operations-total-count: 0
  ...
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject
  ...
  dn: cn=proxy4,cn=LDAP Servers,cn=monitor
  ...
  cn: proxy4
  ...
  objectClass: top
  objectClass: ds-monitor-entry
  objectClass: extensibleObject

To Monitor a Global Index

• Use the ldapsearch command with the base DN "cn=givenname,cn=gi-catalog,cn=Global Index Catalogs,cn=monitor".

  Ensure that givenname corresponds to the name of the indexed attribute (for example cn, if you indexed cn), and that gi-catalog corresponds to the name of the global index catalog.

  $ ldapsearch -h localhost -p 4444 -D "cn=Directory Manager" -w password --useSSL \
    --trustAll -b "cn=givenname,cn=gi-catalog,cn=Global Index Catalogs,cn=monitor" 
    "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=givenname,cn=gi-catalog,cn=Global Index Catalogs,cn=monitor
  ds-mon-add-operations-min-time: 0
  ds-mon-add-operations-aborted-count: 0
  ds-mon-lookup-operations-min-time: 0
  ds-mon-getpartitions-operations-total-count: 0
  ds-mon-add-operations-max-time: 0
  ds-mon-lookup-operations-total-count: 0
  ds-mon-memorized-remove-operations-count: 0
  ds-mon-remove-operations-aborted-count: 0
  ds-mon-add-operations-total-time: 0
  ds-mon-getpartitions-operations-aborted-count: 0
  ds-mon-lookup-operations-total-time: 0
  ds-mon-index-entries: 0
  ds-mon-remove-operations-failed-count: 0
  ds-mon-getpartitions-operations-min-time: 0
  ds-mon-lookup-operations-max-time: 0
  ds-mon-getpartitions-operations-average-time: 0
  ds-mon-index-creation-date: 1252483187019
  ds-mon-getpartitions-operations-last-access-date: 0
  ds-mon-remove-operations-total-count: 0
  ds-mon-lookup-operations-failed-count: 0
  ds-mon-add-operations-failed-count: 0
  ds-mon-remove-operations-min-time: 0
  ds-mon-add-operations-average-time: 0
  ds-mon-lookup-operations-aborted-count: 0
  ds-mon-getpartitions-operations-total-time: 0
  ds-mon-remove-operations-max-time: 0
  ds-mon-getpartitions-operations-max-time: 0
  ds-mon-lookup-operations-last-access-date: 0
  ds-mon-add-operations-total-count: 0
  ds-mon-remove-operations-total-time: 0
  ds-mon-remove-operations-average-time: 0
  ds-mon-getpartitions-operations-failed-count: 0
  objectClass: ds-monitor-entry
  objectClass: top
  objectClass: extensibleObject
  ds-mon-lookup-operations-average-time: 0
  ds-mon-remove-operations-last-access-date: 0
  cn: givenname
  ds-mon-add-operations-last-access-date: 0

To Monitor a Global Index Catalog

• Use the ldapsearch command with the base DN "cn=gi-catalog,cn=Global Index Catalogs,cn=monitor".

  Ensure that givenname corresponds to the name of the indexed attribute (for example cn, if you indexed cn), and that gi-catalog corresponds to the name of the global index catalog.

  $ ldapsearch -h localhost -p 4444 -D "cn=Directory Manager" -w password --useSSL \
    --trustAll -b "cn=gi-catalog,cn=Global Index Catalogs,cn=monitor" "(objectclass=*)"

  Depending on your configuration, output will be similar to the following:

  dn: cn=gi-catalog,cn=Global Index Catalogs,cn=monitor
  ds-mon-replication-received-update-message-errors: 0
  ds-mon-configured-index-number: 1
  ds-mon-replication-full-update-pending-attribute:
  ds-mon-replication-full-update-status: NONE
  ds-mon-state: RUNNING_STANDALONE
  ds-mon-replication-published-update-message-number: 0
  ds-mon-replication-active: false
  ds-mon-replication-auto-sync-retries: 0
  ds-mon-replication-published-update-message-errors: 0
  ds-mon-replication-full-update-errors: 0
  ds-mon-replication-received-update-message-number: 0
  ds-mon-replication-auto-sync-is-running: false
  objectClass: ds-monitor-entry
  objectClass: top
  objectClass: extensibleObject
  ds-mon-replication-configured: false
  cn: gi-catalog