66///////////////////////////////////////////
77START - GENERATED VARIABLES, DO NOT EDIT!
88///////////////////////////////////////////
9- :version: v6.0.0
10- :release_date: 2024-11-21
11- :changelog_url: https://github.com/logstash-plugins/logstash-output-http/blob/v6.0.0 /CHANGELOG.md
9+ :version: v5.7.1
10+ :release_date: 2024-11-18
11+ :changelog_url: https://github.com/logstash-plugins/logstash-output-http/blob/v5.7.1 /CHANGELOG.md
1212:include_path: ../../../../logstash/docs/include
1313///////////////////////////////////////////
1414END - GENERATED VARIABLES, DO NOT EDIT!
@@ -71,13 +71,13 @@ NOTE: The `retry_failed` option does not control the library level retry.
7171
7272This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
7373
74- NOTE: As of version `6.0.0` of this plugin, a number of previously deprecated settings related to SSL have been removed.
75- Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
76-
7774[cols="<,<,<",options="header",]
7875|=======================================================================
7976|Setting |Input type|Required
8077| <<plugins-{type}s-{plugin}-automatic_retries>> |<<number,number>>|No
78+ | <<plugins-{type}s-{plugin}-cacert>> |a valid filesystem path|__Deprecated__
79+ | <<plugins-{type}s-{plugin}-client_cert>> |a valid filesystem path|__Deprecated__
80+ | <<plugins-{type}s-{plugin}-client_key>> |a valid filesystem path|__Deprecated__
8181| <<plugins-{type}s-{plugin}-connect_timeout>> |<<number,number>>|No
8282| <<plugins-{type}s-{plugin}-content_type>> |<<string,string>>|No
8383| <<plugins-{type}s-{plugin}-cookies>> |<<boolean,boolean>>|No
@@ -88,6 +88,9 @@ Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
8888| <<plugins-{type}s-{plugin}-http_method>> |<<string,string>>, one of `["put", "post", "patch", "delete", "get", "head"]`|Yes
8989| <<plugins-{type}s-{plugin}-ignorable_codes>> |<<number,number>>|No
9090| <<plugins-{type}s-{plugin}-keepalive>> |<<boolean,boolean>>|No
91+ | <<plugins-{type}s-{plugin}-keystore>> |a valid filesystem path|__Deprecated__
92+ | <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|__Deprecated__
93+ | <<plugins-{type}s-{plugin}-keystore_type>> |<<string,string>>|__Deprecated__
9194| <<plugins-{type}s-{plugin}-mapping>> |<<hash,hash>>|No
9295| <<plugins-{type}s-{plugin}-message>> |<<string,string>>|No
9396| <<plugins-{type}s-{plugin}-pool_max>> |<<number,number>>|No
@@ -110,6 +113,9 @@ Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
110113| <<plugins-{type}s-{plugin}-ssl_truststore_path>> |<<path,path>>|No
111114| <<plugins-{type}s-{plugin}-ssl_truststore_type>> |<<string,string>>|No
112115| <<plugins-{type}s-{plugin}-ssl_verification_mode>> |<<string,string>>, one of `["full", "none"]`|No
116+ | <<plugins-{type}s-{plugin}-truststore>> |a valid filesystem path|__Deprecated__
117+ | <<plugins-{type}s-{plugin}-truststore_password>> |<<password,password>>|__Deprecated__
118+ | <<plugins-{type}s-{plugin}-truststore_type>> |<<string,string>>|__Deprecated__
113119| <<plugins-{type}s-{plugin}-url>> |<<string,string>>|Yes
114120| <<plugins-{type}s-{plugin}-validate_after_inactivity>> |<<number,number>>|No
115121|=======================================================================
@@ -130,6 +136,32 @@ to a value other than zero if the <<plugins-{type}s-{plugin}-keepalive,`keepaliv
130136Some servers incorrectly end keepalives early, requiring a retry.
131137See <<plugins-{type}s-{plugin}-retry_policy,Retry Policy>> for more information.
132138
139+ [id="plugins-{type}s-{plugin}-cacert"]
140+ ===== `cacert`
141+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>]
142+
143+ * Value type is <<path,path>>
144+ * There is no default value for this setting.
145+
146+ If you need to use a custom X.509 CA (.pem certs) specify the path to that here
147+
148+ [id="plugins-{type}s-{plugin}-client_cert"]
149+ ===== `client_cert`
150+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate>>]
151+
152+ * Value type is <<path,path>>
153+ * There is no default value for this setting.
154+
155+ If you'd like to use a client certificate (note, most people don't want this) set the path to the x509 cert here
156+
157+ [id="plugins-{type}s-{plugin}-client_key"]
158+ ===== `client_key`
159+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_key>>]
160+
161+ * Value type is <<path,path>>
162+ * There is no default value for this setting.
163+
164+ If you're using a client certificate specify the path to the encryption key here
133165
134166[id="plugins-{type}s-{plugin}-connect_timeout"]
135167===== `connect_timeout`
@@ -234,6 +266,34 @@ enumerate them here. Responses returning these codes will be considered successe
234266Turn this on to enable HTTP keepalive support. We highly recommend setting `automatic_retries` to at least
235267one with this to fix interactions with broken keepalive implementations.
236268
269+ [id="plugins-{type}s-{plugin}-keystore"]
270+ ===== `keystore`
271+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_path>>]
272+
273+ * Value type is <<path,path>>
274+ * There is no default value for this setting.
275+
276+ If you need to use a custom keystore (`.jks`) specify that here. This does not work with .pem keys!
277+
278+ [id="plugins-{type}s-{plugin}-keystore_password"]
279+ ===== `keystore_password`
280+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_password>>]
281+
282+ * Value type is <<password,password>>
283+ * There is no default value for this setting.
284+
285+ Specify the keystore password here.
286+ Note, most .jks files created with keytool require a password!
287+
288+ [id="plugins-{type}s-{plugin}-keystore_type"]
289+ ===== `keystore_type`
290+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_type>>]
291+
292+ * Value type is <<string,string>>
293+ * Default value is `"JKS"`
294+
295+ Specify the keystore type here. One of `JKS` or `PKCS12`. Default is `JKS`
296+
237297[id="plugins-{type}s-{plugin}-mapping"]
238298===== `mapping`
239299
@@ -464,6 +524,34 @@ This mode disables many of the security benefits of SSL/TLS and should only be u
464524It is primarily intended as a temporary diagnostic mechanism when attempting to resolve TLS errors.
465525Using `none` in production environments is strongly discouraged.
466526
527+ [id="plugins-{type}s-{plugin}-truststore"]
528+ ===== `truststore`
529+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_path>>]
530+
531+ * Value type is <<path,path>>
532+ * There is no default value for this setting.
533+
534+ If you need to use a custom truststore (`.jks`) specify that here. This does not work with .pem certs!
535+
536+ [id="plugins-{type}s-{plugin}-truststore_password"]
537+ ===== `truststore_password`
538+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_password>>]
539+
540+ * Value type is <<password,password>>
541+ * There is no default value for this setting.
542+
543+ Specify the truststore password here.
544+ Note, most .jks files created with keytool require a password!
545+
546+ [id="plugins-{type}s-{plugin}-truststore_type"]
547+ ===== `truststore_type`
548+ deprecated[5.6.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_type>>]
549+
550+ * Value type is <<string,string>>
551+ * Default value is `"JKS"`
552+
553+ Specify the truststore type here. One of `JKS` or `PKCS12`. Default is `JKS`
554+
467555[id="plugins-{type}s-{plugin}-url"]
468556===== `url`
469557
@@ -486,27 +574,6 @@ Quoting the Apache commons docs (this client is based Apache Commmons):
486574See https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/conn/PoolingHttpClientConnectionManager.html#setValidateAfterInactivity(int)[these docs for more info]
487575
488576
489- [id="plugins-{type}s-{plugin}-obsolete-options"]
490- ==== HTTP Output Obsolete Configuration Options
491-
492- WARNING: As of version `6.0.0` of this plugin, some configuration options have been replaced.
493- The plugin will fail to start if it contains any of these obsolete options.
494-
495-
496- [cols="<,<",options="header",]
497- |=======================================================================
498- |Setting|Replaced by
499- | cacert |<<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
500- | client_cert |<<plugins-{type}s-{plugin}-ssl_certificate>>
501- | client_key |<<plugins-{type}s-{plugin}-ssl_key>>
502- | keystore |<<plugins-{type}s-{plugin}-ssl_keystore_path>>
503- | keystore_password |<<plugins-{type}s-{plugin}-ssl_keystore_password>>
504- | keystore_type |<<plugins-{type}s-{plugin}-ssl_keystore_password>>
505- | truststore |<<plugins-{type}s-{plugin}-ssl_truststore_path>>
506- | truststore_password |<<plugins-{type}s-{plugin}-ssl_truststore_password>>
507- | truststore_type |<<plugins-{type}s-{plugin}-ssl_truststore_type>>
508- |=======================================================================
509-
510577
511578[id="plugins-{type}s-{plugin}-common-options"]
512579include::{include_path}/{type}.asciidoc[]
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments