Profiling OpenKM

From OpenKM Documentation
Jump to: navigation, search

You can profiling local and remote Java applications using Java VisualVM. For local application is easy because it detect automatically them and show in the listing. For remote application you need to do a little work.

First of all add this line to $TOMCAT_HOME/bin/ file (or setenv.bat if using Windows):

CATALINA_OPTS="$CATALINA_OPTS -Djava.rmi.server.hostname="

Nota clasica.png The java.rmi.server.hostname should match the internal IP of the remote server, so replace by the right IP.

In order to connect to this remote Tomcat instance, go to File > Add JMX Connection... and fill the hostname and port. In this case the port is 9090 but you can set another one using the property.


To enhance security, enable authentication:


Edit the access allow file $CATALINA_HOME/conf/jmxremote.access:

 monitorRole readonly
 controlRole readwrite

Nota clasica.png To show remote threads you need the readwrite permission.

Edit the password file $CATALINA_BASE/conf/jmxremote.password :

 monitorRole tomcat
 controlRole tomcat

And finally, restrict access to these files:

 $ chmod 600 $CATALINA_HOME/conf/jmxremote.access
 $ chmod 600 $CATALINA_HOME/conf/jmxremote.password

Monitoring Remote JVM Over SSH

The easiest way to connect to the remote JMX is to use a SOCKS proxy.

 $ ssh user@external.server.ip -D 8888

You need to configure VisualVM to use this proxy. Go to Tools > Options > Network and edit Manual Proxy Settings. Configure SOCKS Proxy at localhost and port 8888.

Visualvm proxy.png

Now you can connect VisualVM to the remote target. Go to File > Add JMX Connection... and type the IP or hostname of the remote machine and the configured JMX port (in our sample configuration is 9090).

Visualvm jmx.png

More info:


Java includes HPROF, a profiler which collect application runtime information. HPROF is capable of presenting CPU usage, heap allocation statistics, and monitor contention profiles.

For example, can collect CPU usage information by sampling threads. Add this line to $TOMCAT_HOME/bin/ file (or setenv.bat if using Windows):

CATALINA_OPTS="$CATALINA_OPTS -agentlib:hprof=cpu=samples"

When Tomcat starts you can see a file called java.hprof.txt. The CPU profiling info will be dumped to this file once Tomcat process is stopped.

More info: