Skip to content

Commit

Permalink
updated docs for main (#1690)
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] authored Jul 4, 2024
1 parent b975c96 commit ffebb77
Show file tree
Hide file tree
Showing 14 changed files with 66 additions and 44 deletions.
6 changes: 3 additions & 3 deletions docs/plugins/codecs/cloudfront.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/codecs/cloudtrail.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
19 changes: 15 additions & 4 deletions docs/plugins/filters/elastic_integration.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v0.1.10
:release_date: 2024-06-18
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.10/CHANGELOG.md
:version: v0.1.11
:release_date: 2024-07-02
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.11/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -50,9 +50,20 @@ Events that _fail_ ingest pipeline processing will be tagged with `_ingest_pipel

IMPORTANT: This plugin requires minimum Java 17 and Logstash 8.7.0 versions.

[id="plugins-{type}s-{plugin}-es-tips"]
===== Using `filter-elastic_integration` with `output-elasticsearch`

Elastic {integrations} are designed to work with {logstash-ref}/plugins-outputs-elasticsearch.html#plugins-outputs-elasticsearch-data-streams[data streams] and {logstash-ref}/plugins-outputs-elasticsearch.html#_compatibility_with_the_elastic_common_schema_ecs[ECS-compatible] output.
Be sure that these features are enabled in the {logstash-ref}/plugins-outputs-elasticsearch.html[`output-elasticsearch`] plugin.

* Set {logstash-ref}/plugins-outputs-elasticsearch.html#plugins-outputs-elasticsearch-data_stream[`data-stream`] to `true`. +
(Check out {logstash-ref}/plugins-outputs-elasticsearch.html#plugins-outputs-elasticsearch-data-streams[Data streams] for additional data streams settings.)
* Set {logstash-ref}/plugins-outputs-elasticsearch.html#plugins-outputs-elasticsearch-ecs_compatibility[`ecs-compatibility`] to `v1` or `v8`.

Check out the {logstash-ref}/plugins-outputs-elasticsearch.html[`output-elasticsearch` plugin] docs for additional settings.

[id="plugins-{type}s-{plugin}-minimum_configuration"]
==== Minimum Configuration
==== Minimum configuration

You will need to configure this plugin to connect to {es}, and may need to also need to provide local GeoIp databases.

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/cloudwatch.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
19 changes: 15 additions & 4 deletions docs/plugins/inputs/kafka.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v11.4.2
:release_date: 2024-05-17
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.4.2/CHANGELOG.md
:version: v11.5.0
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -99,6 +99,7 @@ See the https://kafka.apache.org/{kafka_client_doc}/documentation for more detai
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-auto_commit_interval_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-auto_create_topics>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-auto_offset_reset>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-bootstrap_servers>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-check_crcs>> |<<boolean,boolean>>|No
Expand Down Expand Up @@ -286,6 +287,17 @@ This will add a field named `kafka` to the logstash event containing the followi
* `offset`: The offset from the partition this message is associated with
* `key`: A ByteBuffer containing the message key


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

  * Value type is <<boolean,boolean>>
* Default value is `true`

Controls whether the topic is automatically created when subscribing to a non-existent topic.
A topic will be auto-created only if this configuration is set to `true` and auto-topic creation is enabled on the broker using `auto.create.topics.enable`;
otherwise auto-topic creation is not permitted. 

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

Expand Down Expand Up @@ -790,7 +802,6 @@ Filtering by a regular expression is done by retrieving the full list of topic n
NOTE: When the broker has some topics configured with ACL rules and they miss the DESCRIBE permission, then the subscription
happens but on the broker side it is logged that the subscription of some topics was denied to the configured user.


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

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/s3.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/sqs.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/integrations/aws.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/integrations/kafka.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v11.4.2
:release_date: 2024-05-17
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.4.2/CHANGELOG.md
:version: v11.5.0
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/outputs/cloudwatch.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/outputs/kafka.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v11.4.2
:release_date: 2024-05-17
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.4.2/CHANGELOG.md
:version: v11.5.0
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/outputs/s3.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/outputs/sns.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/outputs/sqs.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.1.6
:release_date: 2023-09-12
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.6/CHANGELOG.md
:version: v7.1.7
:release_date: 2024-07-02
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.7/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down

0 comments on commit ffebb77

Please sign in to comment.