Skip to content

Commit

Permalink
updated docs for main (#1745)
Browse files Browse the repository at this point in the history
* updated docs for main
* Add missing text

---------

Co-authored-by: logstashmachine <[email protected]>
Co-authored-by: Karen Metts <[email protected]>
  • Loading branch information
3 people authored Oct 16, 2024
1 parent 8cf48d5 commit 84f598c
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 23 deletions.
6 changes: 3 additions & 3 deletions docs/plugins/filters/elastic_integration.asciidoc
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.14
:release_date: 2024-09-23
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.14/CHANGELOG.md
:version: v0.1.15
:release_date: 2024-10-11
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.15/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/filters/geoip.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v7.3.0
:release_date: 2024-05-22
:changelog_url: https://github.com/logstash-plugins/logstash-filter-geoip/blob/v7.3.0/CHANGELOG.md
:version: v7.3.1
:release_date: 2024-10-11
:changelog_url: https://github.com/logstash-plugins/logstash-filter-geoip/blob/v7.3.1/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/azure_event_hubs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v1.4.7
:release_date: 2024-06-07
:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.4.7/CHANGELOG.md
:version: v1.4.9
:release_date: 2024-10-02
:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.4.9/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
11 changes: 6 additions & 5 deletions docs/plugins/inputs/google_pubsub.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v1.3.0
:release_date: 2023-08-22
:changelog_url: https://github.com/logstash-plugins/logstash-input-google_pubsub/blob/v1.3.0/CHANGELOG.md
:version: v1.4.0
:release_date: 2024-10-15
:changelog_url: https://github.com/logstash-plugins/logstash-input-google_pubsub/blob/v1.4.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -80,8 +80,9 @@ plugin will return the raw text in as `raw_message` in the logstash `event`.
You have two options for authentication depending on where you run Logstash.

1. If you are running Logstash outside of Google Cloud Platform, then you will
need to create a Google Cloud Platform Service Account and specify the full
path to the JSON private key file in your config. You must assign sufficient
need to provide the path to the JSON private key file in your config in `json_key_file` setting.
If you don't want to upload the file and use its content as a string, then add the content
of JSON private key in `json_key_file_content` setting. You must assign sufficient
roles to the Service Account to create a subscription and to pull messages
from the subscription. Learn more about GCP Service Accounts and IAM roles
here:
Expand Down
14 changes: 11 additions & 3 deletions docs/plugins/inputs/kafka.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v11.5.1
:release_date: 2024-07-26
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.1/CHANGELOG.md
:version: v11.5.2
:release_date: 2024-10-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.2/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -131,6 +131,7 @@ See the https://kafka.apache.org/{kafka_client_doc}/documentation for more detai
| <<plugins-{type}s-{plugin}-reconnect_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-request_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_client_callback_handler_class>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_jaas_config>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_kerberos_service_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_mechanism>> |<<string,string>>|No
Expand Down Expand Up @@ -556,6 +557,13 @@ retries are exhausted.
The amount of time to wait before attempting to retry a failed fetch request
to a given topic partition. This avoids repeated fetching-and-failing in a tight loop.

[id="plugins-{type}s-{plugin}-sasl_client_callback_handler_class""]
===== `sasl_client_callback_handler_class`
* Value type is <<string,string>>
* There is no default value for this setting.

The SASL client callback handler class the specified SASL mechanism should use.

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

Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/integrations/kafka.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v11.5.1
:release_date: 2024-07-26
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.1/CHANGELOG.md
:version: v11.5.2
:release_date: 2024-10-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.2/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
14 changes: 11 additions & 3 deletions docs/plugins/outputs/kafka.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v11.5.1
:release_date: 2024-07-26
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.1/CHANGELOG.md
:version: v11.5.2
:release_date: 2024-10-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-kafka/blob/v11.5.2/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -102,6 +102,7 @@ See the https://kafka.apache.org/{kafka_client_doc}/documentation for more detai
| <<plugins-{type}s-{plugin}-request_timeout_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-retries>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-sasl_client_callback_handler_class>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_jaas_config>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_kerberos_service_name>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-sasl_mechanism>> |<<string,string>>|No
Expand Down Expand Up @@ -392,6 +393,13 @@ In versions prior to 10.5.0, any exception is retried indefinitely unless the `r

The amount of time to wait before attempting to retry a failed produce request to a given topic partition.

[id="plugins-{type}s-{plugin}-sasl_client_callback_handler_class""]
===== `sasl_client_callback_handler_class`
* Value type is <<string,string>>
* There is no default value for this setting.

The SASL client callback handler class the specified SASL mechanism should use.

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

Expand Down

0 comments on commit 84f598c

Please sign in to comment.