honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/setup/jvm-options.asciidoc

91 lines
3.7 KiB
Plaintext
Raw Normal View History

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
[[jvm-options]]
=== Setting JVM options
Reinsert paragraph about heap size This paragraph was accidentally dropped when preparing to merge setting the heap size.
2017-12-12 11:08:32 -05:00
You should rarely need to change Java Virtual Machine (JVM) options. If you do,
the most likely change is setting the <<heap-size,heap size>>. The remainder of
Document how to change GC logging behaviour (#52879) Closes #43990. Describe how to change the default GC settings without changing the default `jvm.options`. Give examples using `jvm.options.d`, and `ES_JAVA_OPTS` with Docker.
2020-02-28 16:26:53 -05:00
this document explains in detail how to set JVM options. You can set options
either with `jvm.options` files or with the `ES_JAVA_OPTS` environment variable.
Reinsert paragraph about heap size This paragraph was accidentally dropped when preparing to merge setting the heap size.
2017-12-12 11:08:32 -05:00
Introduce jvm.options.d for customizing JVM options (#51882) This commit introduces the ability to override JVM options by adding custom JVM options files to a jvm.options.d directory. This simplifies administration of Elasticsearch by not requiring administrators to keep the root jvm.options file in sync with changes that we make to the root jvm.options file. Instead, they are not expected to modify this file but instead supply their own in jvm.options.d. In Docker installations, this means they can bind mount this directory in. In future versions of Elasticsearch, we can consider removing the root jvm.options file (instead, providing all options there as system JVM options).
2020-02-08 18:50:14 -05:00
The preferred method of setting or overriding JVM options is via JVM options
files. When installing from the tar or zip distributions, the root `jvm.options`
configuration file is `config/jvm.options` and custom JVM options files can be
added to `config/jvm.options.d/`. When installing from the Debian or RPM
packages, the root `jvm.options` configuration file is
``/etc/elasticsearch/jvm.options` and custom JVM options files can be added to
`/etc/elasticsearch/jvm.options.d/`. When using the <<docker, Docker
distribution of {es}>> you can bind mount custom JVM options files into
`/usr/share/elasticsearch/config/jvm.options.d/`. You should never need to
modify the root `jvm.options` file instead preferring to use custom JVM options
files. The processing ordering of custom JVM options is lexicographic.
JVM options files must have the suffix '.options' and contain a line-delimited
list of JVM arguments following a special syntax:
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
* lines consisting of whitespace only are ignored
* lines beginning with `#` are treated as comments and are ignored
+
[source,text]
-------------------------------------
# this is a comment
-------------------------------------
* lines beginning with a `-` are treated as a JVM option that applies
independent of the version of the JVM
+
[source,text]
-------------------------------------
-Xmx2g
-------------------------------------
* lines beginning with a number followed by a `:` followed by a `-` are treated
as a JVM option that applies only if the version of the JVM matches the number
+
[source,text]
-------------------------------------
8:-Xmx2g
-------------------------------------
* lines beginning with a number followed by a `-` followed by a `:` are treated
as a JVM option that applies only if the version of the JVM is greater than or
equal to the number
+
[source,text]
-------------------------------------
8-:-Xmx2g
-------------------------------------
* lines beginning with a number followed by a `-` followed by a number followed
by a `:` are treated as a JVM option that applies only if the version of the
JVM falls in the range of the two numbers
+
[source,text]
-------------------------------------
8-9:-Xmx2g
-------------------------------------
* all other lines are rejected
An alternative mechanism for setting Java Virtual Machine options is via the
`ES_JAVA_OPTS` environment variable. For instance:
[source,sh]
---------------------------------
export ES_JAVA_OPTS="$ES_JAVA_OPTS -Djava.io.tmpdir=/path/to/temp/dir"
./bin/elasticsearch
---------------------------------
When using the RPM or Debian packages, `ES_JAVA_OPTS` can be specified in the
<<sysconfig,system configuration file>>.
The JVM has a built-in mechanism for observing the `JAVA_TOOL_OPTIONS`
environment variable. We intentionally ignore this environment variable in our
packaging scripts. The primary reason for this is that on some OS (e.g., Ubuntu)
there are agents installed by default via this environment variable that we do
Introduce jvm.options.d for customizing JVM options (#51882) This commit introduces the ability to override JVM options by adding custom JVM options files to a jvm.options.d directory. This simplifies administration of Elasticsearch by not requiring administrators to keep the root jvm.options file in sync with changes that we make to the root jvm.options file. Instead, they are not expected to modify this file but instead supply their own in jvm.options.d. In Docker installations, this means they can bind mount this directory in. In future versions of Elasticsearch, we can consider removing the root jvm.options file (instead, providing all options there as system JVM options).
2020-02-08 18:50:14 -05:00
not want interfering with {es}.
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
Additionally, some other Java programs support the `JAVA_OPTS` environment
variable. This is *not* a mechanism built into the JVM but instead a convention
in the ecosystem. However, we do not support this environment variable, instead
supporting setting JVM options via the `jvm.options` file or the environment
variable `ES_JAVA_OPTS` as above.