Skip to content

Commit 287c176

Browse files
committed
Add some documentation about VisualVM
1 parent 7fdfdde commit 287c176

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

doc/user/installing-graalvm.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
[GraalVM](http://graalvm.org/) is the platform on which TruffleRuby runs.
44

5+
Installing GraalVM enables to run TruffleRuby both in the `--native` and `--jvm`
6+
[runtime configurations](../../README.md#truffleruby-runtime-configurations).
7+
58
## Dependencies
69

710
[TruffleRuby's dependencies](../../README.md#dependencies) need to be installed

doc/user/tools.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ c = a.compose(b, 0, 0)
1414
c.save('c.png')
1515
```
1616

17+
## VisualVM
18+
19+
You need to use the `--jvm` runtime configuration and [install GraalVM](installing-graalvm.md) to use VisualVM.
20+
21+
VisualVM is a GUI with many tools:
22+
23+
* Monitoring such as CPU usage, heap size, time spent in GC etc (tab: Monitor)
24+
* Capturing and exploring heap dumps (tab: Monitor)
25+
* A list of threads and their status, and thread dumps (tab: Threads)
26+
* CPU and Memory sampling profilers at the Java level (tab: Sampler)
27+
* A CPU sampling profiler at the **Ruby** level (tab: Polyglot Sampler)
28+
29+
There is more documentation about VisualVM on the [GraalVM website](https://www.graalvm.org/tools/visualvm/).
30+
1731
## Profiling
1832

1933
### CPU Tracer

0 commit comments

Comments
 (0)