QuickStart modified by Barak Nirenberg

Barak Nirenberg — Sun, 06 Oct 2013 15:48:04 -0000

--- v1
+++ v2
@@ -13,3 +13,57 @@

 The actual leaks scan will take several seconds.
 All detected leaks will be printed in XML format to JLeaker's standard output stream.
+
+***
+
+##Example:##
+
+In the following example JLeaker is scanning the JConsole program (provided as part of the JDK) and reports 3 suspicious maps (that thier size is greater than 300).
+5 random elements from each suspicious map are printed for your convenience (in the **map-element** XML node), and the shortest reference chain to root reference is printed according to the referencing order (in the **reference** XML element).
+
+    jleaker --pid 4369
+    
+    
+        
+                
+                        
+                        
+                        
+                        
+                        
+                
+                
+                        
+                
+        
+        
+                
+                        
+                        
+                        
+                        
+                        
+                
+                
+                        
+                
+        
+        
+                
+                        
+                        
+                        
+                        
+                        
+                
+                
+                        
+                        
+                
+        
+    
+
+***
+
+After analyzing the results, if you decide that these maps should be allowed to reach this mangnitude  of sizes, you may [create an exclussion list](ExclussionList) for them.
+This will make JLeaker ignore these maps next time it runs.

QuickStart modified by Barak Nirenberg

Barak Nirenberg — Sun, 06 Oct 2013 15:14:03 -0000

The following page describes the basic steps required in order to detect memory leaks using JLeaker:

1. Find the PID (process ID) of the Java program you wish to scan for memory leaks:

Windows:

Use "Windows task manager" to find the PID (it will usually appear as a "java.exe"/"javaw.exe" process).

Linux:

Use the "ps" command line utility or similar tool.

2. Run JLeaker to scan for potential memory leaks

From the command line, run:

 jleaker --pid <PID>

The actual leaks scan will take several seconds.
All detected leaks will be printed in XML format to JLeaker's standard output stream.

Recent changes to QuickStart

QuickStart modified by Barak Nirenberg

QuickStart modified by Barak Nirenberg

1. Find the PID (process ID) of the Java program you wish to scan for memory leaks:

Windows:

Linux:

2. Run JLeaker to scan for potential memory leaks