README.md
1<b>jvmtop</b> is a lightweight console application to monitor all accessible, running jvms on a machine.<br>
2In a top-like manner, it displays <a href='https://github.com/patric-r/jvmtop/blob/master/doc/ExampleOutput.md'>JVM internal metrics</a> (e.g. memory information) of running java processes.<br>
3<br>
4Jvmtop does also include a <a href='https://github.com/patric-r/jvmtop/blob/master/doc/ConsoleProfiler.md'>CPU console profiler</a>.<br>
5<br>
6It's tested with different releases of Oracle JDK, IBM JDK and OpenJDK on Linux, Solaris, FreeBSD and Windows hosts.<br>
7Jvmtop requires a JDK - a JRE will not suffice.<br>
8<br>
9Please note that it's currently in an alpha state -<br>
10if you experience an issue or need further help, please <a href='https://github.com/patric-r/jvmtop/issues'>let us know</a>.<br>
11<br>
12Jvmtop is open-source. Checkout the <a href='https://github.com/patric-r/jvmtop'>source code</a>. Patches are very welcome!<br>
13<br>
14Also have a look at the <a href='https://github.com/patric-r/jvmtop/blob/master/doc/Documentation.md'>documentation</a> or at a <a href='https://github.com/patric-r/jvmtop/blob/master/doc/ExampleOutput.md'>captured live-example</a>.<br>
15
16```
17 JvmTop 0.8.0 alpha amd64 8 cpus, Linux 2.6.32-27, load avg 0.12
18 https://github.com/patric-r/jvmtop
19
20 PID MAIN-CLASS HPCUR HPMAX NHCUR NHMAX CPU GC VM USERNAME #T DL
21 3370 rapperSimpleApp 165m 455m 109m 176m 0.12% 0.00% S6U37 web 21
2211272 ver.resin.Resin [ERROR: Could not attach to VM]
2327338 WatchdogManager 11m 28m 23m 130m 0.00% 0.00% S6U37 web 31
2419187 m.jvmtop.JvmTop 20m 3544m 13m 130m 0.93% 0.47% S6U37 web 20
2516733 artup.Bootstrap 159m 455m 166m 304m 0.12% 0.00% S6U37 web 46
26```
27
28<hr />
29
30<h3>Installation</h3>
31Click on the <a href="https://github.com/patric-r/jvmtop/releases"> releases tab</a>, download the
32most recent tar.gz archive. Extract it, ensure that the `JAVA_HOME` environment variable points to a valid JDK and run `./jvmtop.sh`.<br><br>
33Further information can be found in the [INSTALL file](https://github.com/patric-r/jvmtop/blob/master/INSTALL)
34
35
36
37<h3>08/14/2013 jvmtop 0.8.0 released</h3>
38<b>Changes:</b>
39<ul><li>improved attach compatibility for all IBM jvms<br>
40</li><li>fixed wrong CPU/GC values for IBM J9 jvms<br>
41</li><li>in case of unsupported heap size metric retrieval, n/a will be displayed instead of 0m<br>
42</li><li>improved argument parsing, support for short-options, added help (pass <code>--help</code>), see <a href='https://github.com/patric-r/jvmtop/issues/28'>issue #28</a> (now using the great <a href='http://pholser.github.io/jopt-simple'>jopt-simple</a> library)<br>
43</li><li>when passing the <code>--once</code> option, terminal will not be cleared anymore (see <a href='https://github.com/patric-r/jvmtop/issues/27'>issue #27</a>)<br>
44</li><li>improved shell script for guessing the path if a <code>JAVA_HOME</code> environment variable is not present (thanks to <a href='https://groups.google.com/forum/#!topic/jvmtop-discuss/KGg_WpL_yAU'>Markus Kolb</a>)</li></ul>
45
46<a href='https://github.com/patric-r/jvmtop/blob/master/doc/Changelog.md'>Full changelog</a>
47
48<hr />
49
50In <a href='https://github.com/patric-r/jvmtop/blob/master/doc/ExampleOutput.md'>VM detail mode</a> it shows you the top CPU-consuming threads, beside detailed metrics:<br>
51<br>
52<br>
53
54```
55 JvmTop 0.8.0 alpha amd64, 4 cpus, Linux 2.6.18-34
56 https://github.com/patric-r/jvmtop
57
58 PID 3539: org.apache.catalina.startup.Bootstrap
59 ARGS: start
60 VMARGS: -Djava.util.logging.config.file=/home/webserver/apache-tomcat-5.5[...]
61 VM: Sun Microsystems Inc. Java HotSpot(TM) 64-Bit Server VM 1.6.0_25
62 UP: 869:33m #THR: 106 #THRPEAK: 143 #THRCREATED: 128020 USER: webserver
63 CPU: 4.55% GC: 3.25% HEAP: 137m / 227m NONHEAP: 75m / 304m
64 TID NAME STATE CPU TOTALCPU BLOCKEDBY
65 25 http-8080-Processor13 RUNNABLE 4.55% 1.60%
66 128022 RMI TCP Connection(18)-10.101. RUNNABLE 1.82% 0.02%
67 36578 http-8080-Processor164 RUNNABLE 0.91% 2.35%
68 36453 http-8080-Processor94 RUNNABLE 0.91% 1.52%
69 27 http-8080-Processor15 RUNNABLE 0.91% 1.81%
70 14 http-8080-Processor2 RUNNABLE 0.91% 3.17%
71 128026 JMX server connection timeout TIMED_WAITING 0.00% 0.00%
72```
73
74<a href='https://github.com/patric-r/jvmtop/issues'>Pull requests / bug reports</a> are always welcome.<br>
75<br>
76