Skip to content

Commit

Permalink
updated docs for main (#1534)
Browse files Browse the repository at this point in the history
Co-authored-by: Karen Metts <[email protected]>
  • Loading branch information
github-actions[bot] and karenzone authored Oct 3, 2023
1 parent ed47af4 commit d9234bd
Show file tree
Hide file tree
Showing 30 changed files with 468 additions and 132 deletions.
6 changes: 3 additions & 3 deletions docs/plugins/codecs/cloudfront.asciidoc
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.5
:release_date: 2023-08-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.5/CHANGELOG.md
: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
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/codecs/cloudtrail.asciidoc
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.5
:release_date: 2023-08-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.5/CHANGELOG.md
: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
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/codecs/protobuf.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v1.2.9
:release_date: 2023-04-11
:changelog_url: https://github.com/logstash-plugins/logstash-codec-protobuf/blob/v1.2.9/CHANGELOG.md
:version: v1.3.0
:release_date: 2023-09-20
:changelog_url: https://github.com/logstash-plugins/logstash-codec-protobuf/blob/v1.3.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/filters/elasticsearch.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.15.2
:release_date: 2023-07-24
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v3.15.2/CHANGELOG.md
:version: v3.15.3
:release_date: 2023-09-08
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v3.15.3/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
130 changes: 117 additions & 13 deletions docs/plugins/filters/http.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v1.4.3
:release_date: 2023-03-21
:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v1.4.3/CHANGELOG.md
:version: v1.5.0
:release_date: 2023-09-01
:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v1.5.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -56,28 +56,37 @@ There are also multiple configuration options related to the HTTP connectivity:
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-automatic_retries>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-cacert>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-client_cert>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-client_key>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-cacert>> |a valid filesystem path|__Deprecated__
| <<plugins-{type}s-{plugin}-client_cert>> |a valid filesystem path|__Deprecated__
| <<plugins-{type}s-{plugin}-client_key>> |a valid filesystem path|__Deprecated__
| <<plugins-{type}s-{plugin}-connect_timeout>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-cookies>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-follow_redirects>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-keepalive>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-keystore>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-keystore_type>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-keystore>> |a valid filesystem path|__Deprecated__
| <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|__Deprecated__
| <<plugins-{type}s-{plugin}-keystore_type>> |<<string,string>>|__Deprecated__
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-pool_max>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-pool_max_per_route>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-proxy>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-request_timeout>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-retry_non_idempotent>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-socket_timeout>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-ssl_certificate>> |<<path,path>>|No
| <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> |list of <<path,path>>|No
| <<plugins-{type}s-{plugin}-ssl_cipher_suites>> |list of <<string,string>>|No
| <<plugins-{type}s-{plugin}-ssl_keystore_password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-ssl_keystore_path>> |<<path,path>>|No
| <<plugins-{type}s-{plugin}-ssl_keystore_type>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-ssl_supported_protocols>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-ssl_verification_mode>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-truststore>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-truststore_password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-truststore_type>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-ssl_truststore_password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-ssl_truststore_path>> |<<path,path>>|No
| <<plugins-{type}s-{plugin}-ssl_truststore_type>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-ssl_verification_mode>> |<<string,string>>, one of `["full", "none"]`|No
| <<plugins-{type}s-{plugin}-truststore>> |a valid filesystem path|__Deprecated__
| <<plugins-{type}s-{plugin}-truststore_password>> |<<password,password>>|__Deprecated__
| <<plugins-{type}s-{plugin}-truststore_type>> |<<string,string>>|__Deprecated__
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|no
| <<plugins-{type}s-{plugin}-validate_after_inactivity>> |<<number,number>>|No
|=======================================================================
Expand Down Expand Up @@ -198,6 +207,7 @@ Note: if `retry_non_idempotent` is set only GET, HEAD, PUT, DELETE, OPTIONS, and

[id="plugins-{type}s-{plugin}-cacert"]
===== `cacert`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>]

* Value type is <<path,path>>
* There is no default value for this setting.
Expand All @@ -206,6 +216,7 @@ If you need to use a custom X.509 CA (.pem certs) specify the path to that here

[id="plugins-{type}s-{plugin}-client_cert"]
===== `client_cert`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate>>]

* Value type is <<path,path>>
* There is no default value for this setting.
Expand All @@ -214,6 +225,7 @@ If you'd like to use a client certificate (note, most people don't want this) se

[id="plugins-{type}s-{plugin}-client_key"]
===== `client_key`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_key>>]

* Value type is <<path,path>>
* There is no default value for this setting.
Expand Down Expand Up @@ -256,6 +268,7 @@ one with this to fix interactions with broken keepalive implementations.

[id="plugins-{type}s-{plugin}-keystore"]
===== `keystore`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_path>>]

* Value type is <<path,path>>
* There is no default value for this setting.
Expand All @@ -264,6 +277,7 @@ If you need to use a custom keystore (`.jks`) specify that here. This does not w

[id="plugins-{type}s-{plugin}-keystore_password"]
===== `keystore_password`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_password>>]

* Value type is <<password,password>>
* There is no default value for this setting.
Expand All @@ -273,6 +287,7 @@ Note, most .jks files created with keytool require a password!

[id="plugins-{type}s-{plugin}-keystore_type"]
===== `keystore_type`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_type>>]

* Value type is <<string,string>>
* Default value is `"JKS"`
Expand Down Expand Up @@ -339,6 +354,67 @@ If `automatic_retries` is enabled this will cause non-idempotent HTTP verbs (suc

Timeout (in seconds) to wait for data on the socket. Default is `10s`

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

SSL certificate to use to authenticate the client. This certificate should be an OpenSSL-style X.509 certificate file.

NOTE: This setting can be used only if <<plugins-{type}s-{plugin}-ssl_key>> is set.

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

* Value type is a list of <<path,path>>
* There is no default value for this setting

The .cer or .pem CA files to validate the server's certificate.

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

* Value type is a list of <<string,string>>
* There is no default value for this setting

The list of cipher suites to use, listed by priorities.
Supported cipher suites vary depending on the Java and protocol versions.

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

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

OpenSSL-style RSA private key that corresponds to the <<plugins-{type}s-{plugin}-ssl_certificate>>.

NOTE: This setting can be used only if <<plugins-{type}s-{plugin}-ssl_certificate>> is set.

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

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

Set the keystore password

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

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

The keystore used to present a certificate to the server.
It can be either `.jks` or `.p12`

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

* Value can be any of: `jks`, `pkcs12`
* If not provided, the value will be inferred from the keystore filename.

The format of the keystore file. It must be either `jks` or `pkcs12`.

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

Expand All @@ -356,6 +432,31 @@ NOTE: If you configure the plugin to use `'TLSv1.1'` on any recent JVM, such as
the protocol is disabled by default and needs to be enabled manually by changing `jdk.tls.disabledAlgorithms` in
the *$JDK_HOME/conf/security/java.security* configuration file. That is, `TLSv1.1` needs to be removed from the list.

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

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

Set the truststore password

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

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

The truststore to validate the server's certificate.
It can be either `.jks` or `.p12`.

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

* Value can be any of: `jks`, `pkcs12`
* If not provided, the value will be inferred from the truststore filename.

The format of the truststore file. It must be either `jks` or `pkcs12`.

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

Expand All @@ -374,6 +475,7 @@ Using `none` in production environments is strongly discouraged.

[id="plugins-{type}s-{plugin}-truststore"]
===== `truststore`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_path>>]

* Value type is <<path,path>>
* There is no default value for this setting.
Expand All @@ -382,6 +484,7 @@ If you need to use a custom truststore (`.jks`) specify that here. This does not

[id="plugins-{type}s-{plugin}-truststore_password"]
===== `truststore_password`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_password>>]

* Value type is <<password,password>>
* There is no default value for this setting.
Expand All @@ -391,6 +494,7 @@ Note, most .jks files created with keytool require a password!

[id="plugins-{type}s-{plugin}-truststore_type"]
===== `truststore_type`
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_type>>]

* Value type is <<string,string>>
* Default value is `"JKS"`
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/filters/jdbc_static.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v5.4.4
:release_date: 2023-06-15
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.4/CHANGELOG.md
:version: v5.4.5
:release_date: 2023-09-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.5/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/filters/jdbc_streaming.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v5.4.4
:release_date: 2023-06-15
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.4/CHANGELOG.md
:version: v5.4.5
:release_date: 2023-09-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.5/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/filters/useragent.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v3.3.4
:release_date: 2023-03-13
:changelog_url: https://github.com/logstash-plugins/logstash-filter-useragent/blob/v3.3.4/CHANGELOG.md
:version: v3.3.5
:release_date: 2023-09-19
:changelog_url: https://github.com/logstash-plugins/logstash-filter-useragent/blob/v3.3.5/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
9 changes: 4 additions & 5 deletions docs/plugins/inputs/beats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v6.6.3
:release_date: 2023-07-03
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.6.3/CHANGELOG.md
:version: v6.7.0
:release_date: 2023-09-07
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.7.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -301,8 +301,7 @@ Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed info
explicitly specified, _excluding_ `codec_metadata` from `enrich` will
disable `ecs_compatibility` for this plugin.
| source_metadata | Information about the _source_ of the event, such as the IP address
of the inbound connection this input received the event from and the
name of the Logstash host that processed the event
of the inbound connection this input received the event from
| ssl_peer_metadata | Detailed information about the _SSL peer_ we received the event from,
such as identity information from the SSL client certificate that was
presented when establishing a connection to this input
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins/inputs/cloudwatch.asciidoc
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.5
:release_date: 2023-08-04
:changelog_url: https://github.com/logstash-plugins/logstash-integration-aws/blob/v7.1.5/CHANGELOG.md
: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
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down
9 changes: 4 additions & 5 deletions docs/plugins/inputs/elastic_agent.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: v6.6.3
:release_date: 2023-07-03
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.6.3/CHANGELOG.md
:version: v6.7.0
:release_date: 2023-09-07
:changelog_url: https://github.com/logstash-plugins/logstash-input-beats/blob/v6.7.0/CHANGELOG.md
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
Expand Down Expand Up @@ -301,8 +301,7 @@ Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed info
explicitly specified, _excluding_ `codec_metadata` from `enrich` will
disable `ecs_compatibility` for this plugin.
| source_metadata | Information about the _source_ of the event, such as the IP address
of the inbound connection this input received the event from and the
name of the Logstash host that processed the event
of the inbound connection this input received the event from
| ssl_peer_metadata | Detailed information about the _SSL peer_ we received the event from,
such as identity information from the SSL client certificate that was
presented when establishing a connection to this input
Expand Down
Loading

0 comments on commit d9234bd

Please sign in to comment.