Description of Each Entry Under the cn=monitor Entry (Sun Java System Directory Server Enterprise Edition 6.0 Reference)

Sun Java System Directory Server Enterprise Edition 6.0 Reference

Description of Each Entry Under the `cn=monitor` Entry

For information about each entry in the cn=monitor subtree, see the following sections:

`cn=Product`

The cn=Product entry identifies the set of files being installed. An installed product is identified by the entry cn=ProductName.

cn=Product contains the following groups of attributes:

Settings

version identifies the full release number containing major release, minor release and optionally micro release (for example, 6.0).
buildNumber identifies the syntax of the build number.
patchId identifies the patch of the product. This attribute can be empty.
installDate identifies the date of last installation of the product or patch.
installLocation identifies the full installation path.

State

Provides operational status and availability status.

Statistics

Provides a set of statistics metrics such as performance and usage.

`cn=Operating System`

The cn=Operating System entry identifies which operating system the product package is installed under. This entry has the following monitoring DN:

cn=Operating System, cn=ProductName, cn=Product, cn=monitor

cn=Operating System contains the following groups of attributes:

Settings

OperatingSystemName identifies the name of the operating system (for example, SunOS).
operatingSystemVersion identifies the release of the operating system (for example, 6.1).

State

Provides operational status and availability status.

Statistics

The following list contains some of the statistics that can be collected:

totalVisibleMemory
totalVirtualMemory
freePhysicalMemory
usedPhysicalMemory

`cn=Instance`

The cn=Instance entry identifies an instance of the installed product. More than one instance of a product can exist on a single data source. Each instance is identified by an instance ID, where instanceId=host:instance-path.

The cn=Instance entry has the following monitoring DN:

cn=InstanceId, cn=Instance, cn=Operating System, cn=ProductName,
  cn=Product, cn=monitor

cn=Operating System contains the following groups of attributes:

Settings: Provides configuration attribute values.
State: operationalStatus identifies the status of the element, with the following values: 0, 2, 8, 9, and 10. For information about the values, see Table 18–2.
Statistics: Provides a set of statistics metrics such as performance and usage.

`cn=Service`

The cn=Service entry identifies information about LDAP operations, or services, for an instance of Directory Proxy Server.

LDAP operations are add, delete, modify, modifyDN, search, compare, and bind. Each LDAP operation has a specific monitoring entry below cn=Service. For example, the add operation has the following DN:

cn=add, cn=Service, cn=InstanceId, cn=Instance, cn=Operating System, 
  cn=ProductName, cn=Product, cn=monitor

Entries below cn=Service can contain the following groups of attributes:

Settings

Provides configuration attribute values.

State

Provides operational status and availability status.

Statistics

total identifies the number of operations received by this instance of Directory Proxy Server.
succeeded identifies the number of successful operations in this instance of Directory Proxy Server.
failed identifies the number of failed operations in this instance of Directory Proxy Server.
abandonned identifies the number of operations abandoned by this instance of Directory Proxy Server.

`cn=SAP`

A Service Access Point (SAP) provides information on how to access a service. The cn=SAP entry has the following monitoring DN:

cn=listenerName, cn=SAP, cn=instanceId, cn=Instance, 
  cn=OperatingSystem, cn=Product, cn=monitor

Entries below cn=SAP can contain the following groups of attributes:

Settings

name identifies the SAP name, either LDAP or LDAPS.
isSecure identifies whether LDAPS is used. If the value is TRUE, LDAPS is used.
host identifies the hostname of the current data source.
port identifies the port number to access this instance of Directory Proxy Server.

State

operationalStatus identifies the status of the SAP. If the value is 2 or OK, the SAP is fully operational.
startTime identifies the date and time at which the SAP was started.
stopTime identifies the date and time at which the SAP was stopped.
stopException provides a description of the error if a stop operation fails. If this attribute is empty, no error has occurred.

Statistics

acceptedConnections identifies the number of accepted TCP connections. One counter exists for all LDAP operations. The counter is service agnostic.

`cn=RSAP`

The cn=RSAP entry identifies the type of remote service. The remote SAP can be one of the following types:

LDAP(S) to access directory servers such as Sun Directory Server or Microsoft ADAM.
ODBC to access RDBM systems such as the Oracle Database.

LDAP Remote SAP

The cn=RSAP entry for an LDAP remote SAP can have one of the following monitoring DNs:

cn=LDAP  servername, cn=RSAP, cn=instanceId, cn=Instance, 
  cn=OperatingSystem, cn=Product, cn=monitor

cn=LDAPS  servername, cn=RSAP, cn=instanceId, cn=Instance, 
  cn=OperatingSystem, cn=Product, cn=monitor

Entries below cn=RSAP can contain the following groups of attributes:

Settings

name identifies the SAP name, either LDAP or LDAPS.
isSecure identifies whether LDAPS is used. If the value is TRUE, LDAPS is used.
host identifies the hostname of the host server.
port identifies the port number to access this instance of Directory Proxy Server.
totalConnections identifies the total number of connections for bind, read and write operations.
connectionsForBind identifies the number of connection for bind operations.
connectionsForRead identifies the number of connection for read operations (search and compare).
connectionsForWrite identifies the number of connection for write operations (add, delete, modify, and modifyDN).

State

operationalStatus identifies the status of the element, with the following values: 2, 4, 12, and 13. For information about these values, see Table 18–2.

Statistics

totalAvailableConnections identifies the total number of available connections for bind, read and write operations. The value 0 means that access to that data source is congested.
The following attributes are given for bind operations but also exist for read operations and write operations:
- totalBindConnections identifies the number of established connections for bind operations. All of the connections are kept in a pool of bind connections.
- availableBindConnections identifies the number of free bind connections in the pool.
- requestedBindConnections identifies the number of requests to get a free bind connection from the pool.
- providedBindConnections identifies the number of bind connections provided upon request.
- refusedBindConnections identifies the number of requests being refused because the pool is empty (even after a wait) or because the remote data source is down.
- waitRequiredBindConnections identifies the number of requests being blocked in a wait state, waiting for a bind connection to be freed.
- returnedValidBindConnections identifies the number of connections being released.
- returnedInvalidBindConnections identifies the number of connections being released as invalid. A connection is said to be invalid when errors have occurred.

ODBC Remote SAP

The cn=RSAP entry for an ODBC remote SAP has the following monitoring DN:

cn=ODBC servername, cn=RSAP, cn=instanceId, cn=Instance, 
  cn=OperatingSystem, cn=Product, cn=monitor

Entries below cn=RSAP can contain the following groups of attributes:

Settings

name identifies the SAP name, ODBC.
isSecure identifies whether LDAPS is used. If the value is TRUE, LDAPS is used.
host identifies the hostname of the host server.
port identifies the port number to access this instance of Directory Proxy Server.

State

operationalStatus identifies the status of the element, with the following values: 2, 4, 12, and 13. For information about these values, see Table 18–2.

Statistics

Provides a set of statistics metrics such as performance and usage.

`cn=Component`

The cn=Component entry identifies the part of the software being accessed through a service. The following parts of the software are identified by the cn=Component entry:

Load balancing algorithm
Connection class
Data view

Proportional Load Balancing Algorithm For All Data Sources

The cn=Component entry for the proportional load balancing algorithm for all data sources has the following monitoring DN:

cn=ProportionalLB, cn=DataSourcePool poolname, cn=Component, 
  cn=instanceId, cn=Instance, cn=OperatingSystem, cn=Product, cn=monitor

Entries below the cn=Component entry for the proportional load balancing algorithm contain the following groups of attributes for all data sources:

Settings

Provides configuration attribute values.

State

enabled identifies the status of the remote SAP. If the value is TRUE, the load balancing algorithm is active.

Statistics

totalProvidedBindConnections identifies the total number of connections provided for bind operations.
totalRefusedBindConnections identifies the number of refused connections for bind operations.

Connections can be refused for one of the following reasons:
- The pool of data sources is empty.
- All the data sources in the pool are down.
- The data source selected by the load balancing algorithm has no free connection to reach the remote service.
totalProvidedAddConnections see totalProvidedBindConnections
totalRefusedAddConnections see totalRefusedBindConnections
totalProvidedCompareConnections see totalProvidedBindConnections
totalRefusedCompareConnections see totalRefusedBindConnections
totalProvidedDeleteConnections see totalProvidedBindConnections
totalRefusedDeleteConnections see totalRefusedBindConnections
totalProvidedModifyConnections see totalProvidedBindConnections
totalRefusedModifyConnections see totalRefusedBindConnections
totalProvidedModifyDNConnections see totalProvidedBindConnections
totalRefusedModifyDNConnections see totalRefusedBindConnections
totalProvidedCompareConnections see totalProvidedBindConnections
totalRefusedCompareConnections see totalRefusedBindConnections

Proportional Load Balancing Algorithm For Individual Data Sources

The cn=Component entry for the proportional load balancing algorithm for individual data sources has the following monitoring DN:

cn=Add, cn=servername, cn=Proportional LB, cn=DataSource Pool poolname,
  cn=Component, cn=instanceId, cn=Instance, cn=OperatingSystem, 
  cn=Product, cn=monitor

Similar monitoring DNs exist for the delete, modify, modifyDN, search, compare, and bind operations.

Entries below the cn=Component entry for the proportional load balancing algorithm contain the following groups of attributes for individual data sources:

Settings

expectedWeight identifies the expected weight for the operation on the data source.

State

operationalStatus identifies the status of the element, with the following values: 2, and 5. For information about these values, see Table 18–2.

Statistics

provided the number of connections provided to reach the data source for the operation.
failed the number of failed requests to get a connection to that data source.
realWeight the real usage of the data source for the operation, to be compared with the expectedWeight.

`cn=JVM`

The cn=JVM entry identifies the JVM that is being used to run the instance of Directory Proxy Server. The cn=JVM entry has the following monitoring DN:

cn=JVM, cn=instanceId, cn=Instance, cn=DPS60, cn=Product, cn=monitor

Entries below cn=JVM can contain the following groups of attributes:

Settings

version identifies the version of the JVM used to run the instance of Directory Proxy Server.
installLocation identifies the location of the JVM installation.

State

operationalStatus identifies the status of the element, with the following values: 2, and 5. For information about these values, see Table 18–2.

Statistics

totalJVMMemory identifies the total amount of memory allocated for the JVM to run.
usedJVMMemory identifies the amount of memory currently in use.
freeJVMMemory identifies the amount of free memory.

`cn=Resource`

The cn=Resource entry identifies the set of resources being used by the software. Resources include buffers, file descriptors, and hard disks.

The following elements are identified by the cn=Resource entry:

Connection Handler Thread

The connection handler thread decodes incoming requests. The connection handler is oriented to the LDAP or LDAPS protocol. When a request has been fully decoded, the request is put in the work queue.

The cn=Resource entry for the connection handler thread has the following monitoring DN:

cn=connection_handler_thread_name, cn=Connection Handler Thread,
  cn=Resource, cn=instanceId, cn=Instance, cn=DPS60, cn=Product, 
  cn=monitor

Entries below the cn=Resource entry for the connection handler thread contain the following groups of attributes:

Settings

Provides configuration attribute values.

State

operationalStatus identifies the status of the element. The value 2 indicates that the element is fully operational.
startTime identifies the date and time at which the thread was started.
stopTime identifies the date and time at which the thread was stopped.

Statistics

The following statistics can be gathered:

Byte buffer pool statistics under cn=ByteBufferPool:
- numTries
- numHits
- numMissesEmpty
- numMissesSize
- numReleases
- availableStandardBuffers
- availableOversizedBuffers
String buffer pool statistics under cn=StringBufferPool:
- numTries
- numHits
- numMisses
- numReleases
- availableBuffers
Vector pool statistics under cn=VectorPool:
- numTries
- numHits
- numMisses
- numReleases
- availableBuffers

Work Queue

Incoming requests from clients are stored by connection handler threads in the work queue. The requests are then processed by the worker thread. The cn=Resource entry for the work queue has the following monitoring DN:

cn=Work Queue, cn=Resource, cn=instanceId, cn=Instance, cn=DPS60, 
  cn=Product, cn=monitor

Entries below the cn=Resource entry for the work queue contain the following groups of attributes:

Settings

normalPriorityBacklogHighWaterMark identifies the maximum number of requests of normal priority that can be put in the queue. When this threshold is reached, the connection handler is suspended.
normalPriorityBacklogLowWaterMark. When the number of operations of normal priority drops lower than the normalPriorityBacklogLowWaterMark, the connection handler is woken up.

State

operationalStatus identifies the status of the element, with the following values: 2, and 4. For information about these values, see Table 18–2.

Statistics

numNormalPriorityPuts identifies the number of requests of normal priority that are put in the queue by the connection handler threads.
numNormalPriorityGets identifies the number of request of normal priority retrieved from the queue by worker threads.
normalPriorityBacklog identifies the number of remaining requests of normal priority in the queue.
maxNormalPriorityBacklog identifies the peak of remaining requests of normal priority in the queue.
numHighPriorityPuts identifies the number of requests of high priority that are put in the queue by the connection handler threads.
numHighPriorityGets identifies the number of request of high priority retrieved from the queue by worker threads.
highPriorityBacklog identifies the number of remaining requests of high priority in the queue.
maxHighPriorityBacklog identifies the peak of remaining requests of high priority in the queue.
numAbandonRequests identifies the number of requests that are abandoned.
numSuccessfulAbandons identifies the number of requests that are abandoned while in the queue.

Worker Thread

The worker thread processes requests from the work queue.

The cn=Resource entry for the worker thread has the following monitoring DN:

cn=worker_thread_name, cn=Worker Thread, cn=Resource,
  cn=instanceId, cn=Instance, cn=DPS60, cn=Product, cn=monitor

Entries below the cn=Resource entry for the search thread contain the same groups of attributes as described in Connection Handler Thread, and the following attributes:

Statistics

processedOperations identifies the number of operations processed by the worker thread.
raisedExceptions identifies the number of exceptions raised during the processing of operations.

Search Thread

When a search is performed on several data views, parallel search threads can be used. The cn=Resource entry for the search thread has the following monitoring DN:

cn=search_thread_name, cn=Search Thread, cn=Resource, cn=instanceId,
  cn=Instance, cn=DPS60, cn=Product, cn=monitor

Entries below the cn=Resource entry for the search thread contain the same groups of attributes as described in Connection Handler Thread.

Monitor Thread

The monitor thread checks the availability of remote data sources. A remote data source is considered to be available when the monitor thread can create one connection to the remote data source. The cn=Resource entry for the monitor thread has the following monitoring DN:

cn=monitor_thread_name, cn=Monitor Thread, cn=Resource, cn=instanceId,
  cn=Instance, cn=DPS60, cn=Product, cn=monitor

Entries below the cn=Resource entry for the search thread contain the same groups of attributes as described in Connection Handler Thread, and the following groups of attributes:

Settings

backendServerName identifies the name of the monitored remote data source.
checkInterval identifies the interval of time (in seconds) between two checks.
additionalCheckType identifies additional checking. The following values can be used:
- 1 (no additional checks)
- 2 (create a bind connection to the data source)
- 3 (create a read connection to the data source)

State

serverIsAvailable identifies the status of the remote data source. The value is true if the remote data source is up and running.

Statistics

totalChecks identifies the total number of checks.
failedAvailabilityChecks identifies the number of failed availability checks. An availability check is successful when a remote data source is up and running.
failedAdditionalChecks identifies the number of failed additional checks.