Difference between revisions of "Profiling OpenKM"
From OpenKM Documentation
| (17 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
You can profiling local and remote Java applications using [http://docs.oracle.com/javase/6/docs/technotes/guides/visualvm/index.html 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. | You can profiling local and remote Java applications using [http://docs.oracle.com/javase/6/docs/technotes/guides/visualvm/index.html 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/setenv.sh''' (or '''setenv.bat''' if using Windows) | + | First of all add this line to '''$TOMCAT_HOME/bin/setenv.sh''' file (or '''setenv.bat''' if using Windows): |
<source lang="bash"> | <source lang="bash"> | ||
| Line 8: | Line 8: | ||
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.ssl=false" | CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.ssl=false" | ||
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.authenticate=false" | CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.authenticate=false" | ||
| − | CATALINA_OPTS="$CATALINA_OPTS -Djava.rmi.server.hostname= | + | CATALINA_OPTS="$CATALINA_OPTS -Djava.rmi.server.hostname=127.0.0.1" |
</source> | </source> | ||
| − | {{Note|The '''java.rmi.server.hostname''' should match the IP of the remote server, so replace ''' | + | {{Note|The '''java.rmi.server.hostname''' should match the internal IP of the remote server, so replace '''127.0.0.1''' 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 '''com.sun.management.jmxremote.port''' property. | 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 '''com.sun.management.jmxremote.port''' property. | ||
| + | |||
| + | === Authentication === | ||
| + | To enhance security, enable authentication: | ||
| + | |||
| + | <source lang="bash"> | ||
| + | CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.authenticate=true" | ||
| + | CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.password.file=$CATALINA_HOME/conf/jmxremote.password" | ||
| + | CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.access.file=$CATALINA_HOME/conf/jmxremote.access" | ||
| + | </source> | ||
| + | |||
| + | Edit the access allow file $CATALINA_HOME/conf/jmxremote.access: | ||
| + | |||
| + | monitorRole readonly | ||
| + | controlRole readwrite | ||
| + | |||
| + | {{Note|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 [http://en.wikipedia.org/wiki/SOCKS 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''. | ||
| + | |||
| + | |||
| + | [[File:Visualvm proxy.png|500px|center]] | ||
| + | |||
| + | |||
| + | 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). | ||
| + | |||
| + | |||
| + | [[File:Visualvm jmx.png|360px|center]] | ||
| + | |||
More info: | More info: | ||
| Line 19: | Line 62: | ||
* [https://blogs.oracle.com/nbprofiler/entry/profiling_with_visualvm_part_1 Profiling With VisualVM, Part 1] | * [https://blogs.oracle.com/nbprofiler/entry/profiling_with_visualvm_part_1 Profiling With VisualVM, Part 1] | ||
* [https://blogs.oracle.com/nbprofiler/entry/profiling_with_visualvm_part_2 Profiling With VisualVM, Part 2] | * [https://blogs.oracle.com/nbprofiler/entry/profiling_with_visualvm_part_2 Profiling With VisualVM, Part 2] | ||
| + | * [http://blog.markwshead.com/1129/connecting-visual-vm-to-tomcat-7/ Connecting Visual VM to Tomcat 7] | ||
| + | * [http://tomcat.apache.org/tomcat-7.0-doc/monitoring.html Monitoring and Managing Tomcat 7] | ||
* [http://hillert.blogspot.com.es/2010/01/remote-profiling-of-jboss-using.html Remote Profiling of JBoss using VisualVM] | * [http://hillert.blogspot.com.es/2010/01/remote-profiling-of-jboss-using.html Remote Profiling of JBoss using VisualVM] | ||
| + | * [http://www.skill-guru.com/blog/2010/11/11/troubleshooting-application-performance-with-visualvm/ Troubleshooting application performance with VisualVM] | ||
| + | * [http://techblog.zabuchy.net/2012/monitoring-of-tomcat-with-visualvm-and-visualgc/ Monitoring of Tomcat with VisualVM and VisualGC] | ||
| + | * [http://blog.tty.nl/2010/09/03/using-visualvm-to-fix-live-tomcat-and-jvm-problems/ Using VisualVM to fix live Tomcat and JVM problems] | ||
== HPROF == | == HPROF == | ||
Java includes HPROF, a profiler which collect application runtime information. HPROF is capable of presenting CPU usage, heap allocation statistics, and monitor contention profiles. | 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/setenv.sh''' (or '''setenv.bat''' if using Windows) | + | For example, can collect CPU usage information by sampling threads. Add this line to '''$TOMCAT_HOME/bin/setenv.sh''' file (or '''setenv.bat''' if using Windows): |
<source lang="bash"> | <source lang="bash"> | ||
Latest revision as of 19:45, 12 December 2012
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/setenv.sh file (or setenv.bat if using Windows):
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote=true"
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.port=9090"
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.ssl=false"
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.authenticate=false"
CATALINA_OPTS="$CATALINA_OPTS -Djava.rmi.server.hostname=127.0.0.1"
 |
The java.rmi.server.hostname should match the internal IP of the remote server, so replace 127.0.0.1 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 com.sun.management.jmxremote.port property.
Authentication
To enhance security, enable authentication:
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.authenticate=true"
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.password.file=$CATALINA_HOME/conf/jmxremote.password"
CATALINA_OPTS="$CATALINA_OPTS -Dcom.sun.management.jmxremote.access.file=$CATALINA_HOME/conf/jmxremote.access"
Edit the access allow file $CATALINA_HOME/conf/jmxremote.access:
monitorRole readonly controlRole readwrite
|
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.
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).
More info:
- Profiling With VisualVM, Part 1
- Profiling With VisualVM, Part 2
- Connecting Visual VM to Tomcat 7
- Monitoring and Managing Tomcat 7
- Remote Profiling of JBoss using VisualVM
- Troubleshooting application performance with VisualVM
- Monitoring of Tomcat with VisualVM and VisualGC
- Using VisualVM to fix live Tomcat and JVM problems
HPROF
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/setenv.sh 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:
