JMX-Based Monitoring

Set server Java arguments appropriately to avoid regular full garbage collection (GC) events.

JMX is based on Java Remote Method Invocation (RMI), which uses references to objects. By default, the JMX client and server perform a full GC periodically to clean up stale references. As a result, the default settings cause JMX to cause a full GC every hour.

To prevent hourly full GCs when using JMX, add the -XX:+DisableExplicitGC option to the list of start-ds.java-args arguments. You can do this by editing the config/java.properties file and restarting the server.

Avoid using this argument when importing LDIF online using the import-ldif command. The import process uses GC to work around memory management issues.

Configure the server to activate JMX access.

The following example uses the reserved port number, 1689:

$ dsconfig \
 create-connection-handler \
 --hostname localhost \
 --port 4444 \
 --bindDN uid=admin \
 --bindPassword password \
 --handler-name JMX \
 --type jmx \
 --set enabled:true \
 --set listen-port:1689 \
 --usePkcs12TrustStore /path/to/opendj/config/keystore \
 --trustStorePasswordFile /path/to/opendj/config/keystore.pin \
 --no-prompt

The change takes effect immediately.

Add appropriate privileges to access JMX monitoring information.

By default, no users have privileges to access the JMX connection. The following commands add JMX privileges for the directory superuser:

$ ldapmodify \
 --hostname localhost \
 --port 1636 \
 --useSsl \
 --usePkcs12TrustStore /path/to/opendj/config/keystore \
 --trustStorePasswordFile /path/to/opendj/config/keystore.pin \
 --bindDN uid=admin \
 --bindPassword password << EOF
dn: uid=admin
changetype: modify
add: ds-privilege-name
ds-privilege-name: jmx-notify
ds-privilege-name: jmx-read
ds-privilege-name: jmx-write
EOF

The directory superuser already has the monitor-read privilege. When setting privileges for a regular user, add ds-privilege-name: monitor-read to the list.

• Configure security and connect remotely.

  See the section on Using SSL in Monitoring and Management Using JMX Technology for hints.

• Connect to a local server process using the process ID:

  $ jvisualvm --openpid $(</path/to/opendj/logs/server.pid)