@@ -23,3 +23,31 @@ existing <<jvm-options,`jvm.options`>>, you should add the line
2323`-Djava.io.tmpdir=${ES_TMPDIR}`. It is safe to do this on all OS as we preserve
2424using a private temporary directory on non-Linux systems with the same
2525mechanism.
26+
27+ === GC logging
28+
29+ Starting in Elasticsearch 6.2.0, JVM <<gc-logging,GC logging>> is enabled out of
30+ the box. This lightweight facility gives insight into GC issues. The settings
31+ for this are in <<jvm-options,`jvm.options`>> and default to keeping 2 GB worth
32+ (rotating every 64 MB) of logs in the default logs directory. If you are
33+ upgrading from a previous version of Elasticsearch and preserve your existing
34+ <<jvm-options,`jvm.options`>>, you should add the following GC logging settings
35+ so that this valuable debugging information is available:
36+
37+ [source,sh]
38+ --------------------------------------------------
39+ -XX:+PrintGCDetails
40+ -XX:+PrintGCDateStamps
41+ -XX:+PrintTenuringDistribution
42+ -XX:+PrintGCApplicationStoppedTime
43+ -Xloggc:logs/gc.log or /var/log/elasticsearch/gc.log <1>
44+ -XX:+UseGCLogFileRotation
45+ -XX:NumberOfGCLogFiles=32
46+ -XX:GCLogFileSize=64m
47+ --------------------------------------------------
48+
49+ <1> If you have installed Elasticsearch from the RPM or the Debian packaging
50+ distributions and use the default logging location use `/var/log/elasticsearch`
51+ otherwise if you have installed from the `tar.gz` or `zip` archive distributions
52+ and use the default logging location use `logs/gc.log`; otherwise, set the
53+ location to the absolute path to your log files.
0 commit comments