Skip to content

Commit 193af6a

Browse files
authored
Doc: Refine new MD docs (WIP) (elastic#17325)
1 parent 8d10baa commit 193af6a

File tree

3 files changed

+36
-11
lines changed

3 files changed

+36
-11
lines changed

docs/reference/ecs-ls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mapped_pages:
55

66
# ECS in Logstash [ecs-ls]
77

8-
The [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://reference/index.md)) is an open source specification, developed with support from the Elastic user community. ECS defines a common set of fields to be used for storing event data, such as logs and metrics, in {{es}}. With ECS, users can normalize event data to better analyze, visualize, and correlate the data represented in their events.
8+
The [Elastic Common Schema (ECS)](ecs://reference/index.md) is an open source specification, developed with support from the Elastic user community. ECS defines a common set of fields to be used for storing event data, such as logs and metrics, in {{es}}. With ECS, users can normalize event data to better analyze, visualize, and correlate the data represented in their events.
99

1010
## ECS compatibility [ecs-compatibility]
1111

docs/reference/getting-started-with-logstash.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@ mapped_pages:
55

66
# Getting started with Logstash [getting-started-with-logstash]
77

8-
This section guides you through the process of installing Logstash and verifying that everything is running properly. After learning how to stash your first event, you go on to create a more advanced pipeline that takes Apache web logs as input, parses the logs, and writes the parsed data to an Elasticsearch cluster. Then you learn how to stitch together multiple input and output plugins to unify data from a variety of disparate sources.
8+
This section guides you through the process of installing Logstash and verifying that everything is running properly.
9+
After learning how to stash your first event, you can go on to create a more advanced pipeline that takes Apache web logs as input, parses the logs, and writes the parsed data to an Elasticsearch cluster.
10+
Then you learn how to stitch together multiple input and output plugins to unify data from a variety of disparate sources.
911

10-
This section includes the following topics:
12+
This section includes these topics:
1113

1214
* [Java (JVM) version](#ls-jvm)
1315
* [Installing Logstash](/reference/installing-logstash.md)
@@ -20,8 +22,8 @@ This section includes the following topics:
2022

2123
{{ls}} requires one of these versions:
2224

23-
* Java 17 (default). Check out [Using JDK 17](#jdk17-upgrade) for settings info.
24-
* Java 21
25+
* Java 17
26+
* Java 21 (default).
2527

2628
Use the [official Oracle distribution](http://www.oracle.com/technetwork/java/javase/downloads/index.html) or an open-source distribution, such as [OpenJDK](http://openjdk.java.net/). See the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_jvm) for the official word on supported versions across releases.
2729

@@ -30,7 +32,7 @@ Use the [official Oracle distribution](http://www.oracle.com/technetwork/java/ja
3032

3133
:name: bundled-jdk
3234

33-
{{ls}} offers architecture-specific [downloads](https://www.elastic.co/downloads/logstash) that include Adoptium Eclipse Temurin 17, a long term support (LTS) release of the JDK.
35+
{{ls}} offers architecture-specific [downloads](https://www.elastic.co/downloads/logstash) that include Adoptium Eclipse Temurin 21, a long term support (LTS) release of the JDK.
3436

3537
Use the LS_JAVA_HOME environment variable if you want to use a JDK other than the version that is bundled. If you have the LS_JAVA_HOME environment variable set to use a custom JDK, Logstash will continue to use the JDK version you have specified, even after you upgrade.
3638

@@ -40,13 +42,13 @@ Use the LS_JAVA_HOME environment variable if you want to use a JDK other than th
4042

4143
#### Check your Java version [check-jvm]
4244

43-
Run the following command:
45+
Run this command:
4446

4547
```shell
4648
java -version
4749
```
4850

49-
On systems with Java installed, this command produces output similar to the following:
51+
On systems with Java installed, this command produces output similar to:
5052

5153
```shell
5254
openjdk version "17.0.12" 2024-07-16
@@ -62,9 +64,10 @@ OpenJDK 64-Bit Server VM Temurin-17.0.12+7 (build 17.0.12+7, mixed mode)
6264
On some Linux systems, you may need to have the `LS_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 `LS_JAVA_HOME` environment variable during package installation, you may get an error message, and {{ls}} will not start properly.
6365

6466

65-
#### Using JDK 17 [jdk17-upgrade]
67+
#### Update JDK settings when upgrading from {{ls}} 7.11.x (or earlier)[jdk-upgrade]
6668

67-
{{ls}} uses JDK 17 by default, but you need to update settings in `jvm.options` and `log4j2.properties` if you are upgrading from {{ls}} 7.11.x (or earlier) to 7.12 or later.
69+
{{ls}} uses JDK 21 by default.
70+
If you are upgrading from {{ls}} 7.11.x (or earlier), you need to update Java settings in `jvm.options` and `log4j2.properties`.
6871

6972

7073
##### Updates to `jvm.options` [_updates_to_jvm_options]

docs/reference/index.md

+23-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,26 @@ mapped_pages:
55
- https://www.elastic.co/guide/en/serverless/current/elasticsearch-ingest-data-through-logstash.html
66
---
77

8-
# Logstash
8+
# Logstash introduction [introduction]
9+
10+
Logstash is an open source data collection engine with real-time pipelining capabilities.
11+
Logstash can dynamically unify data from disparate sources and normalize the data into destinations of your choice.
12+
Cleanse and democratize all your data for diverse advanced downstream analytics and visualization use cases.
13+
14+
While Logstash originally drove innovation in log collection, its capabilities extend well beyond that use case.
15+
Any type of event can be enriched and transformed with a broad array of input, filter, and output plugins, with many native codecs further simplifying the ingestion process.
16+
Logstash accelerates your insights by harnessing a greater volume and variety of data.
17+
18+
::::{admonition} {{ls}} to {{serverless-full}}
19+
You’ll use the {{ls}} [{{es}} output plugin](/logstash/docs/reference/plugins-outputs-elasticsearch.md) to send data to {{serverless-full}}.
20+
Note these differences between {{es-serverless}} and both {{ess}} and self-managed {{es}}:
21+
22+
* Use **API keys** to access {{serverless-full}} from {{ls}}. Any user-based security settings in your in your [{{es}} output plugin](/logstash/docs/reference/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
23+
* {{serverless-full}} uses **data streams** and [{{dlm}} ({{dlm-init}})](docs-content://manage-data/lifecycle/data-stream.md) instead of {{ilm}} ({{ilm-init}}). Any {{ilm-init}} settings in your [{{es}} output plugin](/logstash/docs/reference/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
24+
* **{{ls}} monitoring** is available through the [{{ls}} Integration](https://github.com/elastic/integrations/blob/main/packages/logstash/_dev/build/docs/README.md) in [Elastic Observability](docs-content://solutions/observability.md) on {{serverless-full}}.
25+
26+
**Known issue for Logstash to Elasticsearch Serverless.**
27+
The logstash-output-elasticsearch `hosts` setting defaults to port :9200.
28+
Set the value to port :443 instead.
29+
30+
::::

0 commit comments

Comments
 (0)