Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configure heap dump path out of the box #26755

Merged
merged 1 commit into from
Sep 22, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions distribution/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -537,6 +537,12 @@ Map<String, String> expansionsForDistribution(distributionType) {
'heap.min': defaultHeapSize,
'heap.max': defaultHeapSize,

'heap.dump.path': [
'deb': "-XX:HeapDumpPath=/var/lib/elasticsearch",
'rpm': "-XX:HeapDumpPath=/var/lib/elasticsearch",
'def': "#-XX:HeapDumpPath=/heap/dump/path"
],

'stopping.timeout': [
'rpm': 86400,
],
Expand Down
2 changes: 1 addition & 1 deletion distribution/src/main/resources/config/jvm.options
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@

# specify an alternative path for heap dumps
# ensure the directory exists and has sufficient space
#-XX:HeapDumpPath=${heap.dump.path}
${heap.dump.path}

## GC logging

Expand Down
21 changes: 21 additions & 0 deletions docs/reference/setup/important-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ configured before going into production.
* <<network.host,`network.host`>>
* <<unicast.hosts,`discovery.zen.ping.unicast.hosts`>>
* <<minimum_master_nodes,`discovery.zen.minimum_master_nodes`>>
* <<heap-dump-path,JVM heap dump path>>

[float]
[[path-settings]]
Expand Down Expand Up @@ -180,3 +181,23 @@ nodes should be set to `(3 / 2) + 1` or `2`:
discovery.zen.minimum_master_nodes: 2
--------------------------------------------------

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

The <<rpm,RPM>> and <<deb,Debian>> package distributions default to configuring
the JVM to dump the heap on out of memory exceptions to
`/var/lib/elasticsearch`. If this path is not suitable for storing heap dumps,
you should modify the entry `-XX:HeapDumpPath=/var/lib/elasticsearch` in
<<jvm-options,`jvm.options`>> to an alternate path. If you specify a 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.

Note that the archive distributions do not configure the heap dump path by
default. Instead, the JVM will default to dumping to the working directory for
the Elasticsearch process. If you wish to configure a heap dump path, you should
modify the entry `#-XX:HeapDumpPath=/heap/dump/path` in
<<jvm-options,`jvm.options`>> to remove the comment marker `#` and to specify an
actual path.