Skip to content

Commit e8508fa

Browse files
authored
Suggest capturing a heap dump to diagnose high heap (#96526) (#96527)
The `high-jvm-memory-pressure.html` troubleshooting docs give some suggestions, but vitally they omit the advice to capture a heap dump which is what we really need users to do if they want to understand their high heap usage. This commit adds a note to the docs to that effect.
1 parent fa531b5 commit e8508fa

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

docs/reference/how-to/fix-common-cluster-issues.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ You can also use the <<cat-nodes,cat nodes API>> to get the current
158158
GET _cat/nodes?v=true&h=name,node*,heap*
159159
----
160160

161+
See <<high-jvm-memory-pressure>> for more details.
162+
161163
To get the JVM memory usage for each circuit breaker, use the
162164
<<cluster-nodes-stats,node stats API>>.
163165

docs/reference/troubleshooting/common-issues/high-jvm-memory-pressure.asciidoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,17 @@ collection.
2727
[timestamp_short_interval_from_last][INFO ][o.e.m.j.JvmGcMonitorService] [node_id] [gc][number] overhead, spent [21s] collecting in the last [40s]
2828
----
2929

30+
**Capture a JVM heap dump**
31+
32+
To determine the exact reason for the high JVM memory pressure, capture a heap
33+
dump of the JVM while its memory usage is high.
34+
3035
[discrete]
3136
[[reduce-jvm-memory-pressure]]
3237
==== Reduce JVM memory pressure
3338

39+
This section contains some common suggestions for reducing JVM memory pressure.
40+
3441
**Reduce your shard count**
3542

3643
Every shard uses memory. In most cases, a small set of large shards uses fewer
@@ -92,4 +99,4 @@ between them.
9299
**Upgrade node memory**
93100

94101
Heavy indexing and search loads can cause high JVM memory pressure. To better
95-
handle heavy workloads, upgrade your nodes to increase their memory capacity.
102+
handle heavy workloads, upgrade your nodes to increase their memory capacity.

0 commit comments

Comments
 (0)