root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/setup/important-settings/heap-dump-path.asciidoc

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

19 lines
861 B
Plaintext
Raw Normal View History

Reorganize configuring Elasticsearch docs This commit reorganizes some of the content in the configuring Elasticsearch section of the docs. The changes are: - move JVM options out of system configuration into configuring Elasticsearch - move JVM options to its own page of the docs - move configuring the heap to important Elasticsearch settings - move configuring the heap to its own page of the docs - move all important settings to individual pages in the docs - remove bootstrap.memory_lock from important settings, this is covered in the swap section of system configuration Relates #27755
2017-12-12 23:24:37 +08:00
[[heap-dump-path]]
[DOCS] Combining important config settings into a single page (#63849) * Combining important config settings into a single page. * Updating ids for two pages causing link errors and implementing redirects.
2020-10-19 22:02:22 +08:00
[discrete]
[DOCS] Edit JVM settings info. Closes #72259 (#72350) * [DOCS] Edit JVM settings info. Closes #72259 * Apply suggestions from code review Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> * Incorporated review feedback.
2021-04-29 09:30:32 +08:00
==== JVM heap dump path setting
Reorganize configuring Elasticsearch docs This commit reorganizes some of the content in the configuring Elasticsearch section of the docs. The changes are: - move JVM options out of system configuration into configuring Elasticsearch - move JVM options to its own page of the docs - move configuring the heap to important Elasticsearch settings - move configuring the heap to its own page of the docs - move all important settings to individual pages in the docs - remove bootstrap.memory_lock from important settings, this is covered in the swap section of system configuration Relates #27755
2017-12-12 23:24:37 +08:00
[DOCS] Combining important config settings into a single page (#63849) * Combining important config settings into a single page. * Updating ids for two pages causing link errors and implementing redirects.
2020-10-19 22:02:22 +08:00
By default, {es} configures the JVM to dump the heap on out of
memory exceptions to the default data directory. On <<rpm,RPM>> and
<<deb,Debian>> packages, the data directory is `/var/lib/elasticsearch`. On
<<targz,Linux and MacOS>> and <<zip-windows,Windows>> distributions,
the `data` directory is located under the root of the {es} installation.
If this path is not suitable for receiving heap dumps, modify the
[DOCS] Edit JVM settings info. Closes #72259 (#72350) * [DOCS] Edit JVM settings info. Closes #72259 * Apply suggestions from code review Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> * Incorporated review feedback.
2021-04-29 09:30:32 +08:00
`-XX:HeapDumpPath=...` entry in <<set-jvm-options,`jvm.options`>>:
[DOCS] Combining important config settings into a single page (#63849) * Combining important config settings into a single page. * Updating ids for two pages causing link errors and implementing redirects.
2020-10-19 22:02:22 +08:00
* If you specify a directory, the JVM will generate a filename for the heap
dump based on the PID of the running instance.
* If you specify a fixed filename instead of a directory, the file must
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).
2018-08-16 23:32:35 +08:00
not exist when the JVM needs to perform a heap dump on an out of memory
[DOCS] Combining important config settings into a single page (#63849) * Combining important config settings into a single page. * Updating ids for two pages causing link errors and implementing redirects.
2020-10-19 22:02:22 +08:00
exception. Otherwise, the heap dump will fail.