From 24cda6a8d3551449e49b0d2315b086452487421f Mon Sep 17 00:00:00 2001 From: Jason Tedor Date: Tue, 13 Mar 2018 16:38:33 -0400 Subject: [PATCH] Add docs for error file configuration This commit adds docs for configuring the error file setting for where the JVM writes fatal error logs. --- .../setup/important-settings/error-file.asciidoc | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/reference/setup/important-settings/error-file.asciidoc diff --git a/docs/reference/setup/important-settings/error-file.asciidoc b/docs/reference/setup/important-settings/error-file.asciidoc new file mode 100644 index 0000000000000..37f1d2a0b14ed --- /dev/null +++ b/docs/reference/setup/important-settings/error-file.asciidoc @@ -0,0 +1,16 @@ +[[error-file-path]] +=== JVM fatal error logs + +The <> and <> 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 +<> 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 +<> to remove the comment marker `#` and to specify an +actual path.