[Docs] Remove LS_HEAP_SIZE and reference JVM.options instead #9335
Conversation
| @@ -100,4 +100,3 @@ Examining the in-depth GC statistics with a tool similar to the excellent https: | |||
|
|
|||
| NOTE: As long as the GC pattern is acceptable, heap sizes that occasionally increase to the maximum are acceptable. Such heap size spikes happen in response to a burst of large events passing through the pipeline. In general practice, maintain a gap between the used amount of heap memory and the maximum. | |||
| This document is not a comprehensive guide to JVM GC tuning. Read the official http://www.oracle.com/webfolder/technetwork/tutorials/obe/java/gc01/index.html[Oracle guide] for more information on the topic. We also recommend reading http://www.semicomplete.com/blog/geekery/debugging-java-performance.html[Debugging Java Performance]. | |||
There was a problem hiding this comment.
It looks like you've inadvertently trimmed the extra line from the end of the file. Because of how asciidoc processes files, you should include an empty line at the end of each asciidoc file.
docs/static/settings-file.asciidoc
Outdated
| @@ -1,5 +1,5 @@ | |||
| [[logstash-settings-file]] | |||
| === Settings File | |||
| === Logstash.yml | |||
There was a problem hiding this comment.
I'd avoid capitalizing this filename because it's logstash.yml on disk. I feel that actual names (like filenames and function names) should not be capitalized in titles.
| @@ -175,4 +175,3 @@ With this command, Logstash concatenates three config files, `/tmp/one`, `/tmp/t | |||
|
|
|||
| *`-h, --help`*:: | |||
| Print help | |||
There was a problem hiding this comment.
Same comment as above. Do not trim trailing lines. It'll work most of the time, but if somebody adds two includes without a line break between them, your topic might blow up.
|
Good stuff! @karenzone In addition to @dedemorton comments about trailing lines, I would also suggest you configure your editor to not remove trailing spaces on lines. It's not a huge deal but as with this PR it creates diffs that are not really actual changes and makes the reviewing process more difficult. I suggest that such cosmetic re-formatting is done as a separate PR. |
Remove doc references to LS_HEAP_SIZE setting and point to
jvm.optionsfile instead. (Fix for #6970.)Change heading for Setting File to logstash.yml. (I did not change the anchor name.)
The reference guide has a section called Logstash Configuration Files with a subsection called Settings Files. Logstash.yml is documented as an element of Settings Files and is also the subject of a section called Setting File. (This is an artifact from days when logstash.yml was THE setting file. This is my attempt to fix it.)