Skip to content

Commit 4f7ce60

Browse files
committed
Flame graph manual and command documentation refresh
1 parent 80d93d0 commit 4f7ce60

25 files changed

+778
-419
lines changed

README.md

+29-27
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ What you can do with SJK?
1414
- [Monitor Java threads in real time][ttop]
1515
- [Analyze head dynamics with advanced class histograms][hh]
1616
- [Access MBean attributes and operation from command line][mx]
17-
- Create [flame graphs] and over reports from snapshots created VisualVM, Java Flight Recorder or [SJK's own sampler][stcap]
17+
- Create [flame graphs][html-flame] and over reports from snapshots created VisualVM, Java Flight Recorder or [SJK's own sampler][stcap]
1818

1919
See [full command reference](sjk-core/COMMANDS.md).
2020

@@ -44,18 +44,7 @@ Pools thread CPU usage of target JVM and periodically report to console.
4444
- display thread memory allocation rate and cumulative process allocation rate
4545
- display safe point time consumption (only if attache via PID)
4646

47-
[More details](sjk-core/COMMANDS.md#ttop-command)
48-
49-
[jps]
50-
----
51-
52-
Similar to `jps` from JDK.
53-
54-
- plus could display specific system properties of process in output
55-
- plus could display values of specific -XX for HotSpot JVM processes
56-
- plus could filter process java processes by their system properties
57-
58-
[More details](sjk-core/COMMANDS.md#jps-command)
47+
[More details][ttop]
5948

6049
[hh]
6150
----
@@ -65,9 +54,9 @@ Similar to `jmap -histo`.
6554
- plus can show histogram of dead objects (histograms of all and live requested, then difference is calculated)
6655
- plus can show N top buckets in histogram
6756

68-
[More details](sjk-core/COMMANDS.md#hh-command)
57+
[More details][hh]
6958

70-
[stcap], [stcpy] and [ssa]
59+
[stcap], [stcpy], [ssa] and [flame]
7160
----
7261

7362
These commands provide basic sample profiler capabilities. `stcap` produces hyper-dense stack trace dump
@@ -78,13 +67,13 @@ So far following reports are available
7867

7968
- [sophisticated filtering] (time, stack trace, thread name)
8069
- stack frame histogram with advanced filtering options
81-
- flame graph visualization (SVG)
70+
- flame graph visualization (SVG or [interactive HTML][html-flame])
8271
- per thread summary (CPU usage, memory allocation, etc)
8372
- converting back to text format
8473

8574
Dump file can be also processed programatically.
8675

87-
[More details](sjk-core/COMMANDS.md#ssa-command)
76+
[More details][ssa]
8877

8978
[mx]
9079
-----
@@ -101,27 +90,40 @@ It can
10190
- connect to local JVM processes by PID (e.i. any Java process, you do not need to enable JMX server)
10291
- connect to JMX using host:port (password authentication is supported)
10392

104-
[More details](sjk-core/COMMANDS.md#mx-command)
93+
[More details][mx]
94+
95+
[jps]
96+
----
97+
98+
Similar to `jps` from JDK.
99+
100+
- plus could display specific system properties of process in output
101+
- plus could display values of specific -XX for HotSpot JVM processes
102+
- plus could filter process java processes by their system properties
103+
104+
[More details][jps]
105105

106106
[gc]
107107
-----
108108

109109
Report information about GC in real time. Data is retrieved via JMX.
110110

111-
[More details](sjk-core/COMMANDS.md#gc-command)
111+
[More details][gc]
112112

113113
mxdump
114114
-----
115115

116116
Dumps all MBeans of target java process to JSON.
117117

118-
[ttop]: sjk-core/COMMANDS.md#ttop-command
119-
[jps]: sjk-core/COMMANDS.md#jps-command
120-
[hh]: sjk-core/COMMANDS.md#hh-command
121-
[gc]: sjk-core/COMMANDS.md#gc-command
122-
[mx]: sjk-core/COMMANDS.md#mx-command
123-
[stcap]: sjk-core/COMMANDS.md#stcap-command
124-
[stcpy]: sjk-core/COMMANDS.md#stcpy-command
125-
[ssa]: sjk-core/COMMANDS.md#ssa-command
118+
[ttop]: sjk-core/docs/TTOP.md
119+
[jps]: sjk-core/docs/JPS.md
120+
[hh]: sjk-core/docs/HH.md
121+
[gc]: sjk-core/docs/GC.md
122+
[mx]: sjk-core/docs/MX.md
123+
[stcap]: sjk-core/docs/STCAP.md
124+
[stcpy]: sjk-core/docs/STCPY.md
125+
[ssa]: sjk-core/docs/SSA.md
126+
[flame]: sjk-hflame/docs/FLAME.md
126127
[sophisticated filtering]: sjk-core/src/main/resources/org/gridkit/jvmtool/cmd/ssa-help.md
127128
[flame graphs]: http://blog.ragozin.info/2016/01/flame-graphs-vs-cold-numbers.html
129+
[html-flame]: sjk-hflame/docs/flame_graph_ui.md

0 commit comments

Comments
 (0)