Skip to content

updated docs for 9.0 #1908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 19, 2025
Merged

updated docs for 9.0 #1908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
698f3df
updated docs for 9.0
logstashmachine Sep 9, 2025
a8873ab
Apply suggestions from code review
karenzone Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/plugins/inputs/beats.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.0.2
:release_date: 2025-02-12
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.2/CHANGELOG.md
:version: v7.0.3
:release_date: 2025-09-04
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.3/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -21,7 +21,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
=== {plugin-uc} input plugin

NOTE: The `input-elastic_agent` plugin is the next generation of the
`input-beats` plugin.
`input-beats` plugin.
They currently share code and a https://github.com/logstash-plugins/logstash-input-beats[common codebase].

include::{include_path}/plugin_header.asciidoc[]
Expand Down Expand Up @@ -94,9 +94,9 @@ endif::[]

This plugin uses "off-heap" direct memory in addition to heap memory.
By default, a JVM's off-heap direct memory limit is the same as the heap size.
For example, setting `-Xmx10G` without setting the direct memory limit will allocate `10GB` for heap and an additional `10GB` for direct memory, for a total of `20GB` allocated.
You can set the amount of direct memory with `-XX:MaxDirectMemorySize` in {logstash-ref}/jvm-settings.html[Logstash JVM Settings].
Consider setting direct memory to half of the heap size.
For example, setting `-Xmx10G` without setting the direct memory limit will allocate `10GB` for heap and an additional `10GB` for direct memory, for a total of `20GB` allocated.
You can set the amount of direct memory with `-XX:MaxDirectMemorySize` in {logstash-ref}/jvm-settings.html[Logstash JVM Settings].
Consider setting direct memory to half of the heap size.
Setting direct memory too low decreases the performance of ingestion.

NOTE: Be sure that heap and direct memory combined does not exceed the total memory available on the server to avoid an OutOfDirectMemoryError
Expand Down Expand Up @@ -146,7 +146,7 @@ endif::[]
[id="plugins-{type}s-{plugin}-ecs_metadata"]
==== Event enrichment and the Elastic Common Schema (ECS)

When decoding {plugin-uc} events, this plugin enriches each event with metadata about the event's source, making this information available during further processing.
When decoding {plugin-uc} events, this plugin enriches each event with metadata about the event's source, making this information available during further processing.
You can use the <<plugins-{type}s-{plugin}-enrich>> option to activate or deactivate individual enrichment categories.

The location of these enrichment fields depends on whether <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> is enabled:
Expand Down Expand Up @@ -352,7 +352,7 @@ See <<plugins-{type}s-{plugin}-executor_threads>> configuration if you need to s

The number of threads to be used to process incoming {plugin-uc} requests.
By default, the {plugin-uc} input creates a number of threads equal to the number of CPU cores.
These threads handle incoming connections, reading from established sockets, and executing most of the tasks related to network connection management.
These threads handle incoming connections, reading from established sockets, and executing most of the tasks related to network connection management.
Parsing the Lumberjack protocol is offloaded to a dedicated thread pool.

Generally you don't need to touch this setting.
Expand Down Expand Up @@ -459,7 +459,7 @@ Time in milliseconds for an incomplete ssl handshake to timeout
* There is no default value for this setting.

SSL key to use.
This key must be in the PKCS8 format and PEM encoded.
This key must be in the PKCS8 format and PEM encoded.
You can use the https://www.openssl.org/docs/man1.1.1/man1/openssl-pkcs8.html[openssl pkcs8] command to complete the conversion.
For example, the command to convert a PEM encoded PKCS1 private key to a PEM encoded, non-encrypted PKCS8 key is:

Expand Down
20 changes: 10 additions & 10 deletions docs/plugins/inputs/elastic_agent.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.0.2
:release_date: 2025-02-12
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.2/CHANGELOG.md
:version: v7.0.3
:release_date: 2025-09-04
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v7.0.3/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -21,7 +21,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
=== {plugin-uc} input plugin

NOTE: The `input-elastic_agent` plugin is the next generation of the
`input-beats` plugin.
`input-beats` plugin.
They currently share code and a https://github.com/logstash-plugins/logstash-input-beats[common codebase].

include::{include_path}/plugin_header.asciidoc[]
Expand Down Expand Up @@ -94,9 +94,9 @@ endif::[]

This plugin uses "off-heap" direct memory in addition to heap memory.
By default, a JVM's off-heap direct memory limit is the same as the heap size.
For example, setting `-Xmx10G` without setting the direct memory limit will allocate `10GB` for heap and an additional `10GB` for direct memory, for a total of `20GB` allocated.
You can set the amount of direct memory with `-XX:MaxDirectMemorySize` in {logstash-ref}/jvm-settings.html[Logstash JVM Settings].
Consider setting direct memory to half of the heap size.
For example, setting `-Xmx10G` without setting the direct memory limit will allocate `10GB` for heap and an additional `10GB` for direct memory, for a total of `20GB` allocated.
You can set the amount of direct memory with `-XX:MaxDirectMemorySize` in {logstash-ref}/jvm-settings.html[Logstash JVM Settings].
Consider setting direct memory to half of the heap size.
Setting direct memory too low decreases the performance of ingestion.

NOTE: Be sure that heap and direct memory combined does not exceed the total memory available on the server to avoid an OutOfDirectMemoryError
Expand Down Expand Up @@ -146,7 +146,7 @@ endif::[]
[id="plugins-{type}s-{plugin}-ecs_metadata"]
==== Event enrichment and the Elastic Common Schema (ECS)

When decoding {plugin-uc} events, this plugin enriches each event with metadata about the event's source, making this information available during further processing.
When decoding {plugin-uc} events, this plugin enriches each event with metadata about the event's source, making this information available during further processing.
You can use the <<plugins-{type}s-{plugin}-enrich>> option to activate or deactivate individual enrichment categories.

The location of these enrichment fields depends on whether <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> is enabled:
Expand Down Expand Up @@ -352,7 +352,7 @@ See <<plugins-{type}s-{plugin}-executor_threads>> configuration if you need to s

The number of threads to be used to process incoming {plugin-uc} requests.
By default, the {plugin-uc} input creates a number of threads equal to the number of CPU cores.
These threads handle incoming connections, reading from established sockets, and executing most of the tasks related to network connection management.
These threads handle incoming connections, reading from established sockets, and executing most of the tasks related to network connection management.
Parsing the Lumberjack protocol is offloaded to a dedicated thread pool.

Generally you don't need to touch this setting.
Expand Down Expand Up @@ -459,7 +459,7 @@ Time in milliseconds for an incomplete ssl handshake to timeout
* There is no default value for this setting.

SSL key to use.
This key must be in the PKCS8 format and PEM encoded.
This key must be in the PKCS8 format and PEM encoded.
You can use the https://www.openssl.org/docs/man1.1.1/man1/openssl-pkcs8.html[openssl pkcs8] command to complete the conversion.
For example, the command to convert a PEM encoded PKCS1 private key to a PEM encoded, non-encrypted PKCS8 key is:

Expand Down
50 changes: 25 additions & 25 deletions docs/plugins/inputs/http.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v4.1.2
:release_date: 2025-02-12
:changelog_url: https://github.com/logstash-plugins/logstash-input-http/blob/v4.1.2/CHANGELOG.md
:version: v4.1.3
:release_date: 2025-09-04
:changelog_url: https://github.com/logstash-plugins/logstash-input-http/blob/v4.1.3/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand All @@ -24,7 +24,7 @@ include::{include_path}/plugin_header.asciidoc[]

Using this input you can receive single or multiline events over http(s).
Applications can send an HTTP request to the endpoint started by this input and
Logstash will convert it into an event for subsequent processing. Users
Logstash will convert it into an event for subsequent processing. Users
can pass plain text, JSON, or any formatted data and use a corresponding codec with this
input. For Content-Type `application/json` the `json` codec is used, but for all other
data formats, `plain` codec is used.
Expand Down Expand Up @@ -57,16 +57,16 @@ Here’s how ECS compatibility mode affects output.

==== Blocking Behavior

The HTTP protocol doesn't deal well with long running requests. This plugin will either return
a 429 (busy) error when Logstash is backlogged, or it will time out the request.
The HTTP protocol doesn't deal well with long running requests. This plugin will either return
a 429 (busy) error when Logstash is backlogged, or it will time out the request.

If a 429 error is encountered clients should sleep, backing off exponentially with some random
If a 429 error is encountered clients should sleep, backing off exponentially with some random
jitter, then retry their request.

This plugin will block if the Logstash queue is blocked and there are available HTTP input threads.
This will cause most HTTP clients to time out. Sent events will still be processed in this case. This
behavior is not optimal and will be changed in a future release. In the future, this plugin will always
return a 429 if the queue is busy, and will not time out in the event of a busy queue.
behavior is not optimal and will be changed in a future release. In the future, this plugin will always
return a 429 if the queue is busy, and will not time out in the event of a busy queue.

==== Security
This plugin supports standard HTTP basic authentication headers to identify the requester.
Expand All @@ -77,7 +77,7 @@ validating the client's certificate.

[id="plugins-{type}s-{plugin}-codec-settings"]
==== Codec settings
This plugin has two configuration options for codecs: `codec` and `additional_codecs`.
This plugin has two configuration options for codecs: `codec` and `additional_codecs`.

Values in `additional_codecs` are prioritized over those specified in the
`codec` option. That is, the default `codec` is applied only if no codec
Expand Down Expand Up @@ -128,7 +128,7 @@ input plugins.
&nbsp;

[id="plugins-{type}s-{plugin}-additional_codecs"]
===== `additional_codecs`
===== `additional_codecs`

* Value type is <<hash,hash>>
* Default value is `{"application/json"=>"json"}`
Expand Down Expand Up @@ -203,7 +203,7 @@ See <<plugins-{type}s-{plugin}-ecs_metadata>> for detailed information.
-----

[id="plugins-{type}s-{plugin}-host"]
===== `host`
===== `host`

* Value type is <<string,string>>
* Default value is `"0.0.0.0"`
Expand All @@ -212,15 +212,15 @@ The host or ip to bind


[id="plugins-{type}s-{plugin}-password"]
===== `password`
===== `password`

* Value type is <<password,password>>
* There is no default value for this setting.

Password for basic authorization

[id="plugins-{type}s-{plugin}-port"]
===== `port`
===== `port`

* Value type is <<number,number>>
* Default value is `8080`
Expand Down Expand Up @@ -262,15 +262,15 @@ invalid credentials (401), internal errors (503) or backpressure (429).
If 204 (No Content) is set, the response body will not be sent in the response.

[id="plugins-{type}s-{plugin}-response_headers"]
===== `response_headers`
===== `response_headers`

* Value type is <<hash,hash>>
* Default value is `{"Content-Type"=>"text/plain"}`

specify a custom set of response headers

[id="plugins-{type}s-{plugin}-remote_host_target_field"]
===== `remote_host_target_field`
===== `remote_host_target_field`

* Value type is <<string,string>>
* Default value is `"host"` when ECS is disabled
Expand All @@ -279,7 +279,7 @@ specify a custom set of response headers
specify a target field for the client host of the http request

[id="plugins-{type}s-{plugin}-request_headers_target_field"]
===== `request_headers_target_field`
===== `request_headers_target_field`

* Value type is <<string,string>>
* Default value is `"headers"` when ECS is disabled
Expand All @@ -289,20 +289,20 @@ specify target field for the client host of the http request


[id="plugins-{type}s-{plugin}-ssl_certificate"]
===== `ssl_certificate`
===== `ssl_certificate`

* Value type is <<path,path>>
* There is no default value for this setting.

SSL certificate to use.

[id="plugins-{type}s-{plugin}-ssl_certificate_authorities"]
===== `ssl_certificate_authorities`
===== `ssl_certificate_authorities`

* Value type is <<array,array>>
* Default value is `[]`

Validate client certificates against these authorities.
Validate client certificates against these authorities.
You can define multiple files or paths. All the certificates will
be read and added to the trust store. You need to configure the <<plugins-{type}s-{plugin}-ssl_client_authentication>>
to `optional` or `required` to enable the verification.
Expand Down Expand Up @@ -341,15 +341,15 @@ Events are, by default, sent in plain text. You can enable encryption by setting
the <<plugins-{type}s-{plugin}-ssl_certificate>> and <<plugins-{type}s-{plugin}-ssl_key>> options.

[id="plugins-{type}s-{plugin}-ssl_handshake_timeout"]
===== `ssl_handshake_timeout`
===== `ssl_handshake_timeout`

* Value type is <<number,number>>
* Default value is `10000`

Time in milliseconds for an incomplete ssl handshake to timeout

[id="plugins-{type}s-{plugin}-ssl_key"]
===== `ssl_key`
===== `ssl_key`

* Value type is <<path,path>>
* There is no default value for this setting.
Expand All @@ -359,7 +359,7 @@ NOTE: This key need to be in the PKCS8 format, you can convert it with https://w
for more information.

[id="plugins-{type}s-{plugin}-ssl_key_passphrase"]
===== `ssl_key_passphrase`
===== `ssl_key_passphrase`

* Value type is <<password,password>>
* There is no default value for this setting.
Expand Down Expand Up @@ -438,7 +438,7 @@ The format of the truststore file. It must be either `jks` or `pkcs12`.


[id="plugins-{type}s-{plugin}-threads"]
===== `threads`
===== `threads`

* Value type is <<number,number>>
* Default value is number of processors
Expand All @@ -447,7 +447,7 @@ Number of threads to use for both accepting connections and handling requests


[id="plugins-{type}s-{plugin}-user"]
===== `user`
===== `user`

* Value type is <<string,string>>
* There is no default value for this setting.
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/kafka.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v11.6.3
:release_date: 2025-06-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.6.3/CHANGELOG.md
:version: v11.6.4
:release_date: 2025-08-28
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.6.4/CHANGELOG.md
:include_path: ../include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
Loading