-
Notifications
You must be signed in to change notification settings - Fork 25k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for error file configuration (#29032)
This commit adds docs for configuring the error file setting for where the JVM writes fatal error logs.
- Loading branch information
1 parent
4dc3ada
commit 4faf3cf
Showing
1 changed file
with
16 additions
and
0 deletions.
There are no files selected for viewing
16 changes: 16 additions & 0 deletions
16
docs/reference/setup/important-settings/error-file.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
[[error-file-path]] | ||
=== JVM fatal error logs | ||
|
||
The <<rpm,RPM>> and <<deb,Debian>> package distributions default to configuring | ||
the JVM to write fatal error logs to `/var/lib/elasticsearch`; these are logs | ||
produced by the JVM when it encounters a fatal error (e.g., a segmentation | ||
fault). If this path is not suitable for receiving logs, you should modify the | ||
entry `-XX:ErrorFile=/var/lib/elasticsearch/hs_err_pid%p.log` in | ||
<<jvm-options,`jvm.options`>> to an alternate path. | ||
|
||
Note that the archive distributions do not configure the error file path by | ||
default. Instead, the JVM will default to writing to the working directory for | ||
the Elasticsearch process. If you wish to configure an error file path, you | ||
should modify the entry `#-XX:ErrorFile=/error/file/path` in | ||
<<jvm-options,`jvm.options`>> to remove the comment marker `#` and to specify an | ||
actual path. |