Tool for analyzing large Java heap dumps

Question

I have a HotSpot JVM heap dump that I would like to analyze. The VM ran with -Xmx31g, and the heap dump file is 48 GB large.

• I won't even try jhat, as it requires about five times the heap memory (that would be 240 GB in my case) and is awfully slow.
• Eclipse MAT crashes with an ArrayIndexOutOfBoundsException after analyzing the heap dump for several hours.

What other tools are available for that task? A suite of command line tools would be best, consisting of one program that transforms the heap dump into efficient data structures for analysis, combined with several other tools that work on the pre-structured data.

Answer 1

Normally, what I use is ParseHeapDump.sh included within Eclipse Memory Analyzer and described here, and I do that onto one our more beefed up servers (download and copy over the linux .zip distro, unzip there). The shell script needs less resources than parsing the heap from the GUI, plus you can run it on your beefy server with more resources (you can allocate more resources by adding something like -vmargs -Xmx40g -XX:-UseGCOverheadLimit to the end of the last line of the script. For instance, the last line of that file might look like this after modification

./MemoryAnalyzer -consolelog -application org.eclipse.mat.api.parse "$@" -vmargs -Xmx40g -XX:-UseGCOverheadLimit

Run it like ./path/to/ParseHeapDump.sh ../today_heap_dump/jvm.hprof

After that succeeds, it creates a number of "index" files next to the .hprof file.

After creating the indices, I try to generate reports from that and scp those reports to my local machines and try to see if I can find the culprit just by that (not just the reports, not the indices). Here's a tutorial on creating the reports.

Example report:

./ParseHeapDump.sh ../today_heap_dump/jvm.hprof org.eclipse.mat.api:suspects

Other report options:

org.eclipse.mat.api:overview and org.eclipse.mat.api:top_components

If those reports are not enough and if I need some more digging (i.e. let's say via oql), I scp the indices as well as hprof file to my local machine, and then open the heap dump (with the indices in the same directory as the heap dump) with my Eclipse MAT GUI. From there, it does not need too much memory to run.

EDIT: I just liked to add two notes :

• As far as I know, only the generation of the indices is the memory intensive part of Eclipse MAT. After you have the indices, most of your processing from Eclipse MAT would not need that much memory.
• Doing this on a shell script means I can do it on a headless server (and I normally do it on a headless server as well, because they're normally the most powerful ones). And if you have a server that can generate a heap dump of that size, chances are, you have another server out there that can process that much of a heap dump as well.

Answer 2

First step: increase the amount of RAM you are allocating to MAT. By default it's not very much and it can't open large files.

In case of using MAT on MAC (OSX) you'll have file MemoryAnalyzer.ini file in MemoryAnalyzer.app/Contents/MacOS. It wasn't working for me to make adjustments to that file and have them "take". You can instead create a modified startup command/shell script based on content of this file and run it from that directory. In my case I wanted 20 GB heap:

./MemoryAnalyzer -vmargs -Xmx20g --XX:-UseGCOverheadLimit ... other params desired

Just run this command/script from Contents/MacOS directory via terminal, to start the GUI with more RAM available.

Answer 3

I suggest trying YourKit. It usually needs a little less memory than the heap dump size (it indexes it and uses that information to retrieve what you want)

Answer 4

The accepted answer to this related question should provide a good start for you (if you have access to the running process, generates live jmap histograms instead of heap dumps, it's very fast):

Method for finding memory leak in large Java heap dumps

Most other heap analysers (I use IBM http://www.alphaworks.ibm.com/tech/heapanalyzer) require at least a percentage of RAM more than the heap if you're expecting a nice GUI tool.

Other than that, many developers use alternative approaches, like live stack analysis to get an idea of what's going on.

Although I must question why your heaps are so large? The effect on allocation and garbage collection must be massive. I'd bet a large percentage of what's in your heap should actually be stored in a database / a persistent cache etc etc.

Answer 5

This person http://blog.ragozin.info/2015/02/programatic-heapdump-analysis.html

wrote a custom "heap analyzer" that just exposes a "query style" interface through the heap dump file, instead of actually loading the file into memory.

https://github.com/aragozin/heaplib

Though I don't know if "query language" is better than the eclipse OQL mentioned in the accepted answer here.

Answer 6

The latest snapshot build of Eclipse Memory Analyzer has a facility to randomly discard a certain percentage of objects to reduce memory consumption and allow the remaining objects to be analyzed. See Bug 563960 and the nightly snapshot build to test this facility before it is included in the next release of MAT. Update: it is now included in released version 1.11.0.

Answer 7

A not so well known tool - http://dr-brenschede.de/bheapsampler/ works well for large heaps. It works by sampling so it doesn't have to read the entire thing, though a bit finicky.

Answer 8

This is not a command line solution, however I like the tools:

Copy the heap dump to a server large enough to host it. It is very well possible that the original server can be used.

Enter the server via ssh -X to run the graphical tool remotely and use jvisualvm from the Java binary directory to load the .hprof file of the heap dump.

The tool does not load the complete heap dump into memory at once, but loads parts when they are required. Of course, if you look around enough in the file the required memory will finally reach the size of the heap dump.

Answer 9

When the problem can be "easily" reproduced, one unmentioned alternative is to take heap dumps before memory grows that big (e.g., jmap -dump:format=b,file=heap.bin <pid>).

In many cases you will already get an idea of what's going on without waiting for an OOM.

In addition, MAT provides a feature to compare different snapshots, which can come handy (see https://stackoverflow.com/a/55926302/898154 for instructions and a description).

Answer 10

Idea is that use the headless MAT option , as in windows system with limited RAM you cannot do the analysis of large heap dump files.

1. Download the latest mat for unix env - eg. MemoryAnalyzer-1.14.0.20230315-linux.gtk.x86_64.zip https://www.eclipse.org/mat/downloads.php , and extract in any directory of your server.

   Update the MAT config present in /MAT-folder-path/MemoryAnalyzer.ini :

   • MAT tool requires min jdk-17 , set JVM path ( version > java-17 )

   • Increase the heap memory eg -Xmx16384m as per heap dump size.

      -vm  
      /path-to/jdk-17/bin  
      -vmargs  
      -Xmx16384m 
     

2. Useful to have a utility script for generating reports out of your heap dump file - heapAnalysis.sh (Do keep the free disc space > twice the heap dump size)

       #!/bin/sh
       heapFilePath="$1";
       if [[ -z $heapFilePath ]]; then
            echo "The heapFilePath received : $heapFilePath";
            if [ -f $heapFilePath ]; then
                # MAT folder path : - ParseHeapDump.sh script
                matDirectory="/MAT-folder-path/mat"
                matScript="ParseHeapDump.sh"
   
                heapDumpParserScript=$matDirectory/$matScript
   
                # To parse the heap dump file and generate the html report in zip format.
                echo "[1] Leak suspect report analysis started..";
                $heapDumpParserScript $heapFilePath org.eclipse.mat.api:suspects
                echo "Analysis completed : Leak suspect report.";
   
                # You can comment out below [2] and [3] blocks. Usually LeakSuspect report helps in 80% of cases.
   
                echo "[2] System overview report analysis started..";
                $heapDumpParserScript $heapFilePath org.eclipse.mat.api:overview
                echo "Analysis completed : System overview report.";
   
                echo" [3] Top Component report analysis started..";
                $heapDumpParserScript $heapFilePath org.eclipse.mat.api:top_components
                echo "Analysis completed : Top Component report.";
           else
                echo "Provide the correct filepath of heap dump, $heapFilePath file doesn't exist.";
           fi 
       else 
            echo "Provide the mandatory argument of the script."; 
        fi 
   

3. To execute the script to analyze heap dump. ( Use screen utility to detach your session in unix terminal to avoid aborting the process. Because such analysis takes hours. )

         source /script/heapAnalysis.sh /path-to/heapDumpFile.hprof
   

4. Now you can download the html report (~few mb size) into your local system using winSCP tool. If you want, you can transfer the indexed files (ParseHeapDump.sh creates indexed files ) into windows system and load using MAT

Answer 11

I came across an interesting tool called JXray. It provides limited evaluation trial license. Found it very useful to find memory leaks. You may give it a shot.

Answer 12

Try using jprofiler , its works good in analyzing large .hprof, I have tried with file sized around 22 GB.

https://www.ej-technologies.com/products/jprofiler/overview.html

$499/dev license but has a free 10 day evaluation