github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 22:57:16 -04:00
Code Issues Projects Releases Packages Wiki Activity

Doc:Add section and update JVM settings

Browse source 
This work breaks out the JVM setting info into a new section, and
expands and updates the content. It adds new subheadings to make
scanning the content easier.
This commit is contained in:
Karen Metts 2020-06-05 16:03:20 -04:00
parent 9bb792a0d6
commit 6832040d28
2 changed files with 49 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/static/getting-started-with-logstash.asciidoc vendored
View file

@ -7,40 +7,17 @@ input, parses the logs, and writes the parsed data to an Elasticsearch cluster.
This section includes the following topics:
* <<ls-jvm>>
* <<installing-logstash>>
* <<first-event>>
* {logstash-ref}/advanced-pipeline.html[Parsing Logs with Logstash]
* {logstash-ref}/multiple-input-output-plugins.html[Stitching Together Multiple Input and Output Plugins]
include::jvm.asciidoc[]
[[installing-logstash]]
=== Installing Logstash
NOTE: Logstash requires Java 8 or Java 11. Use the
http://www.oracle.com/technetwork/java/javase/downloads/index.html[official Oracle distribution] or an open-source
distribution such as http://openjdk.java.net/[OpenJDK].
To check your Java version, run the following command:
[source,shell]
java -version
On systems with Java installed, this command produces output similar to the following:
[source,shell]
-----
java version "11.0.1" 2018-10-16 LTS
Java(TM) SE Runtime Environment 18.9 (build 11.0.1+13-LTS)
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.1+13-LTS, mixed mode)
-----
On some Linux systems, you may also need to have the `JAVA_HOME` environment
exported before attempting the install, particularly if you installed Java from
a tarball. This is because Logstash uses Java during installation to
automatically detect your environment and install the correct startup method
(SysV init scripts, Upstart, or systemd). If Logstash is unable to find the
JAVA_HOME environment variable during package installation time, you may get an
error message, and Logstash will be unable to start properly.
[float]
[[installing-binary]]
=== Installing from a Downloaded Binary

46
docs/static/jvm.asciidoc vendored Normal file
View file

@ -0,0 +1,46 @@
[float]
[[ls-jvm]]
=== Java (JVM) version
{ls} requires one of these versions:
* Java 8
* Java 11
* Java 14
Use the
http://www.oracle.com/technetwork/java/javase/downloads/index.html[official
Oracle distribution] or an open-source distribution, such as
http://openjdk.java.net/[OpenJDK].
[float]
[[check-jvm]]
==== Check your Java version
Run the following command:
[source,shell]
java -version
On systems with Java installed, this command produces output similar to the following:
[source,shell]
-----
java version "11.0.1" 2018-10-16 LTS
Java(TM) SE Runtime Environment 18.9 (build 11.0.1+13-LTS)
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.1+13-LTS, mixed mode)
-----
[float]
[[java-home]]
==== `JAVA_HOME`
{ls} uses the Java version set in `JAVA_HOME`. The `JAVA_HOME` environment
variable must be set for {ls} to operate correctly.
On some Linux systems, you may need to have the `JAVA_HOME` environment
exported before installing {ls}, particularly if you installed Java from
a tarball.
{ls} uses Java during installation to automatically detect your environment and
install the correct startup method (SysV init scripts, Upstart, or systemd). If
{ls} is unable to find the `JAVA_HOME` environment variable during package
installation, you may get an error message, and {ls} will not start properly.