Skip to content

Commit 8c72c3c

Browse files
authored
add availability info for default heap dump path change (#131713)
1 parent 2a735a9 commit 8c72c3c

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

docs/reference/elasticsearch/jvm-settings.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,25 @@ If you are running {{es}} as a Windows service, you can change the heap size usi
139139

140140
## JVM heap dump path setting [heap-dump-path-setting]
141141

142-
By default, {{es}} configures the JVM to dump the heap on out of memory exceptions to the default logs directory. On [RPM](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md) and [Debian](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md) packages, the logs directory is `/var/log/elasticsearch`. On [Linux and MacOS](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) and [Windows](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md) distributions, the `logs` directory is located under the root of the {{es}} installation.
142+
Depending on your stack version, {{es}} configures the JVM to dump the heap on out of memory exceptions to the following location by default:
143+
144+
* {applies_to}`stack: ga 9.1` The default logs directory
145+
* {applies_to}`stack: ga 9.0` The default data directory
146+
147+
Directory location:
148+
149+
::::{tab-set}
150+
:::{tab-item} Logs directory
151+
* [RPM](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md) and [Debian](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md) packages: `/var/log/elasticsearch`
152+
* [Linux and MacOS](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) and [Windows](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md) distributions: The `logs` directory at the root of the {{es}} installation
153+
:::
154+
:::{tab-item} Data directory
155+
* [RPM](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md) and [Debian](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md) packages: `/var/lib/elasticsearch`
156+
* [Linux and MacOS](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) and [Windows](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md) distributions: The `data` directory at the root of the {{es}} installation
157+
:::
158+
::::
143159

144-
If this path is not suitable for receiving heap dumps, add the `-XX:HeapDumpPath=...` entry in [`jvm.options`](#set-jvm-options):
160+
If this path is not suitable for receiving heap dumps, modify or add the `-XX:HeapDumpPath=...` entry in [`jvm.options`](#set-jvm-options):
145161

146162
* If you specify a directory, the JVM will generate a filename for the heap dump based on the PID of the running instance.
147163
* If you specify a fixed filename instead of a directory, the file must not exist when the JVM needs to perform a heap dump on an out of memory exception. Otherwise, the heap dump will fail.

0 commit comments

Comments
 (0)