Skip to content

Commit 6fd0970

Browse files
committed
Fix docs for fixed filename for heap dump path (#32882)
The docs here incorrectly state that it is okay for a heap dump file to exist when heap dump path is configured to a fixed filename. This is incorrect, the JVM will fail to write the heap dump if a heap dump file already exists at the specified location (see the DumpWriter constructor DumpWriter::DumpWriter(const char* path) in the JVM source).
1 parent 094f914 commit 6fd0970

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/reference/setup/important-settings/heap-dump-path.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ distributions, and the `data` directory under the root of the
88
Elasticsearch installation for the <<zip-targz,tar and zip>> archive
99
distributions). If this path is not suitable for receiving heap dumps,
1010
you should modify the entry `-XX:HeapDumpPath=...` in
11-
<<jvm-options,`jvm.options`>>. If you specify a fixed filename instead
12-
of a directory, the JVM will repeatedly use the same file; this is one
13-
mechanism for preventing heap dumps from accumulating in the heap dump
14-
path. Alternatively, you can configure a scheduled task via your OS to
15-
remove heap dumps that are older than a configured age.
11+
<<jvm-options,`jvm.options`>>. If you specify a directory, the JVM
12+
will generate a filename for the heap dump based on the PID of the running
13+
instance. If you specify a fixed filename instead of a directory, the file must
14+
not exist when the JVM needs to perform a heap dump on an out of memory
15+
exception, otherwise the heap dump will fail.

0 commit comments

Comments
 (0)