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

[[heap-dump-path]]
=== JVM heap dump path

By default, Elasticsearch configures the JVM to dump the heap on out of
memory exceptions to the default data directory (this is
`/var/lib/elasticsearch` for the <<rpm,RPM>> and <<deb,Debian>> package
distributions, and the `data` directory under the root of the
Elasticsearch installation for the <<zip-targz,tar and zip>> archive
distributions). If this path is not suitable for receiving heap dumps,
you should modify the entry `-XX:HeapDumpPath=...` in
<<jvm-options,`jvm.options`>>. If you specify a fixed filename instead
of a directory, the JVM will repeatedly use the same file; this is one
mechanism for preventing heap dumps from accumulating in the heap dump
path. Alternatively, you can configure a scheduled task via your OS to
remove heap dumps that are older than a configured age.
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 10:24:37 -05:00			`[[heap-dump-path]]`
			`=== JVM heap dump path`

Configure heap dump path for archive packages (#29130) This is a follow up to a previous change which set the heap dump path for the package distributions. The observation here is that we always set the working directory of Elasticsearch to to the root of installation (i.e., Elasticsearch home). Therefore, we can specify the heap dump path relative to this directory and default it to the data directory, similar to the package distributions. 2018-03-18 15:32:37 -04:00			`By default, Elasticsearch configures the JVM to dump the heap on out of`
			`memory exceptions to the default data directory (this is`
			`/var/lib/elasticsearch` for the <<rpm,RPM>> and <<deb,Debian>> package
			distributions, and the `data` directory under the root of the
			`Elasticsearch installation for the <<zip-targz,tar and zip>> archive`
			`distributions). If this path is not suitable for receiving heap dumps,`
			you should modify the entry `-XX:HeapDumpPath=...` in
			<<jvm-options,`jvm.options`>>. If you specify a fixed filename instead
			`of a directory, the JVM will repeatedly use the same file; this is one`
			`mechanism for preventing heap dumps from accumulating in the heap dump`
			`path. Alternatively, you can configure a scheduled task via your OS to`
			`remove heap dumps that are older than a configured age.`