Skip to content

Commit cc8a954

Browse files
updated docs for main with changes (#1789)
* Remove duplicate note Co-authored-by: Karen Metts <[email protected]>
1 parent c52cc1d commit cc8a954

22 files changed

+389
-629
lines changed

docs/plugins/filters/elastic_integration.asciidoc

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
///////////////////////////////////////////
66
START - GENERATED VARIABLES, DO NOT EDIT!
77
///////////////////////////////////////////
8-
:version: v0.1.17
9-
:release_date: 2024-12-07
10-
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v0.1.17/CHANGELOG.md
8+
:version: v8.17.0
9+
:release_date: 2025-01-08
10+
:changelog_url: https://github.com/elastic/logstash-filter-elastic_integration/blob/v8.17.0/CHANGELOG.md
1111
:include_path: ../../../../logstash/docs/include
1212
///////////////////////////////////////////
1313
END - GENERATED VARIABLES, DO NOT EDIT!
@@ -48,7 +48,14 @@ NOTE: Some multi-pipeline configurations such as logstash-to-logstash over http(
4848

4949
Events that _fail_ ingest pipeline processing will be tagged with `_ingest_pipeline_failure`, and their `[@metadata][_ingest_pipeline_failure]` will be populated with details as a key/value map.
5050

51-
IMPORTANT: This plugin requires minimum Java 17 and Logstash 8.7.0 versions.
51+
[id="plugins-{type}s-{plugin}-requirements"]
52+
===== Requirements and upgrade guidance
53+
54+
- This plugin requires Java 17 minimum with {ls} `8.x` versions and Java 21 minimum with {ls} `9.x` versions.
55+
- When you upgrade the {stack}, upgrade {ls} (or this plugin specifically) _before_ you upgrade {kib}.
56+
(Note that this requirement is a departure from the typical {stack} https://www.elastic.co/guide/en/elastic-stack/current/installing-elastic-stack.html#install-order-elastic-stack[installation order].)
57+
+
58+
The {es}-{ls}-{kib} installation order ensures the best experience with {agent}-managed pipelines, and embeds functionality from a version of {es} Ingest Node that is compatible with the plugin version (`major`.`minor`).
5259

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

docs/plugins/filters/elasticsearch.asciidoc

Lines changed: 17 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
///////////////////////////////////////////
66
START - GENERATED VARIABLES, DO NOT EDIT!
77
///////////////////////////////////////////
8-
:version: v3.16.2
9-
:release_date: 2024-12-09
10-
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v3.16.2/CHANGELOG.md
8+
:version: v4.0.0
9+
:release_date: 2025-01-10
10+
:changelog_url: https://github.com/logstash-plugins/logstash-filter-elasticsearch/blob/v4.0.0/CHANGELOG.md
1111
:include_path: ../../../../logstash/docs/include
1212
///////////////////////////////////////////
1313
END - GENERATED VARIABLES, DO NOT EDIT!
@@ -111,7 +111,7 @@ Authentication to a secure Elasticsearch cluster is possible using _one_ of the
111111
* <<plugins-{type}s-{plugin}-user>> AND <<plugins-{type}s-{plugin}-password>>
112112
* <<plugins-{type}s-{plugin}-cloud_auth>>
113113
* <<plugins-{type}s-{plugin}-api_key>>
114-
* <<plugins-{type}s-{plugin}-keystore>> and/or <<plugins-{type}s-{plugin}-keystore_password>>
114+
* <<plugins-{type}s-{plugin}-ssl_keystore_path>> and/or <<plugins-{type}s-{plugin}-ssl_keystore_password>>
115115

116116
[id="plugins-{type}s-{plugin}-autz"]
117117
==== Authorization
@@ -122,7 +122,10 @@ The `monitoring` permission at cluster level is necessary to perform periodic co
122122
[id="plugins-{type}s-{plugin}-options"]
123123
==== Elasticsearch Filter Configuration Options
124124

125-
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> and the <<plugins-{type}s-{plugin}-deprecated-options>> described later.
125+
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
126+
127+
NOTE: As of version `4.0.0` of this plugin, a number of previously deprecated settings related to SSL have been removed. Please see the
128+
<<plugins-{type}s-{plugin}-obsolete-options>> for more details.
126129

127130
[cols="<,<,<",options="header",]
128131
|=======================================================================
@@ -145,7 +148,6 @@ This plugin supports the following configuration options plus the <<plugins-{typ
145148
| <<plugins-{type}s-{plugin}-retry_on_failure>> |<<number,number>>|No
146149
| <<plugins-{type}s-{plugin}-retry_on_status>> |<<array,array>>|No
147150
| <<plugins-{type}s-{plugin}-sort>> |<<string,string>>|No
148-
| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|__Deprecated__
149151
| <<plugins-{type}s-{plugin}-ssl_certificate>> |<<path,path>>|No
150152
| <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> |list of <<path,path>>|No
151153
| <<plugins-{type}s-{plugin}-ssl_cipher_suites>> |list of <<string,string>>|No
@@ -520,57 +522,21 @@ Tags the event on failure to look up previous log event information. This can be
520522
Basic Auth - username
521523

522524

523-
[id="plugins-{type}s-{plugin}-deprecated-options"]
524-
==== Elasticsearch Filter Deprecated Configuration Options
525-
526-
This plugin supports the following deprecated configurations.
525+
[id="plugins-{type}s-{plugin}-obsolete-options"]
526+
==== Elasticsearch Filter Obsolete Configuration Options
527527

528-
WARNING: Deprecated options are subject to removal in future releases.
528+
WARNING: As of version `4.0.0` of this plugin, some configuration options have been replaced.
529+
The plugin will fail to start if it contains any of these obsolete options.
529530

530531
[cols="<,<,<",options="header",]
531532
|=======================================================================
532-
|Setting|Input type|Replaced by
533-
| <<plugins-{type}s-{plugin}-ca_file>> |a valid filesystem path|<<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
534-
| <<plugins-{type}s-{plugin}-keystore>> |a valid filesystem path|<<plugins-{type}s-{plugin}-ssl_keystore_path>>
535-
| <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|<<plugins-{type}s-{plugin}-ssl_keystore_password>>
533+
|Setting|Replaced by
534+
| ca_file |<<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
535+
| keystore |<<plugins-{type}s-{plugin}-ssl_keystore_path>>
536+
| keystore_password |<<plugins-{type}s-{plugin}-ssl_keystore_password>>
537+
| ssl |<<plugins-{type}s-{plugin}-ssl_enabled>>
536538
|=======================================================================
537539

538-
[id="plugins-{type}s-{plugin}-ca_file"]
539-
===== `ca_file`
540-
deprecated[3.15.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>]
541-
542-
* Value type is <<path,path>>
543-
* There is no default value for this setting.
544-
545-
SSL Certificate Authority file
546-
547-
[id="plugins-{type}s-{plugin}-ssl"]
548-
===== `ssl`
549-
deprecated[3.15.0, Replaced by <<plugins-{type}s-{plugin}-ssl_enabled>>]
550-
551-
* Value type is <<boolean,boolean>>
552-
* Default value is `false`
553-
554-
SSL
555-
556-
[id="plugins-{type}s-{plugin}-keystore"]
557-
===== `keystore`
558-
deprecated[3.15.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_path>>]
559-
560-
* Value type is <<path,path>>
561-
* There is no default value for this setting.
562-
563-
The keystore used to present a certificate to the server. It can be either .jks or .p12
564-
565-
[id="plugins-{type}s-{plugin}-keystore_password"]
566-
===== `keystore_password`
567-
deprecated[3.15.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_password>>]
568-
569-
* Value type is <<password,password>>
570-
* There is no default value for this setting.
571-
572-
Set the keystore password
573-
574540

575541
[id="plugins-{type}s-{plugin}-common-options"]
576542
include::{include_path}/{type}.asciidoc[]

docs/plugins/filters/http.asciidoc

Lines changed: 27 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
///////////////////////////////////////////
66
START - GENERATED VARIABLES, DO NOT EDIT!
77
///////////////////////////////////////////
8-
:version: v1.6.0
9-
:release_date: 2024-06-19
10-
:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v1.6.0/CHANGELOG.md
8+
:version: v2.0.0
9+
:release_date: 2024-12-18
10+
:changelog_url: https://github.com/logstash-plugins/logstash-filter-http/blob/v2.0.0/CHANGELOG.md
1111
:include_path: ../../../../logstash/docs/include
1212
///////////////////////////////////////////
1313
END - GENERATED VARIABLES, DO NOT EDIT!
@@ -36,6 +36,9 @@ See <<plugins-{type}s-{plugin}-target_body>>, and <<plugins-{type}s-{plugin}-tar
3636

3737
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
3838

39+
NOTE: As of version `2.0.0` of this plugin, a number of previously deprecated settings related to SSL have been removed.
40+
Please check out <<plugins-{type}s-{plugin}-obsolete-options>> for details.
41+
3942
[cols="<,<,<",options="header",]
4043
|=======================================================================
4144
|Setting |Input type|Required
@@ -56,16 +59,10 @@ There are also multiple configuration options related to the HTTP connectivity:
5659
|=======================================================================
5760
|Setting |Input type|Required
5861
| <<plugins-{type}s-{plugin}-automatic_retries>> |<<number,number>>|No
59-
| <<plugins-{type}s-{plugin}-cacert>> |a valid filesystem path|__Deprecated__
60-
| <<plugins-{type}s-{plugin}-client_cert>> |a valid filesystem path|__Deprecated__
61-
| <<plugins-{type}s-{plugin}-client_key>> |a valid filesystem path|__Deprecated__
6262
| <<plugins-{type}s-{plugin}-connect_timeout>> |<<number,number>>|No
6363
| <<plugins-{type}s-{plugin}-cookies>> |<<boolean,boolean>>|No
6464
| <<plugins-{type}s-{plugin}-follow_redirects>> |<<boolean,boolean>>|No
6565
| <<plugins-{type}s-{plugin}-keepalive>> |<<boolean,boolean>>|No
66-
| <<plugins-{type}s-{plugin}-keystore>> |a valid filesystem path|__Deprecated__
67-
| <<plugins-{type}s-{plugin}-keystore_password>> |<<password,password>>|__Deprecated__
68-
| <<plugins-{type}s-{plugin}-keystore_type>> |<<string,string>>|__Deprecated__
6966
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
7067
| <<plugins-{type}s-{plugin}-pool_max>> |<<number,number>>|No
7168
| <<plugins-{type}s-{plugin}-pool_max_per_route>> |<<number,number>>|No
@@ -85,9 +82,6 @@ There are also multiple configuration options related to the HTTP connectivity:
8582
| <<plugins-{type}s-{plugin}-ssl_truststore_path>> |<<path,path>>|No
8683
| <<plugins-{type}s-{plugin}-ssl_truststore_type>> |<<string,string>>|No
8784
| <<plugins-{type}s-{plugin}-ssl_verification_mode>> |<<string,string>>, one of `["full", "none"]`|No
88-
| <<plugins-{type}s-{plugin}-truststore>> |a valid filesystem path|__Deprecated__
89-
| <<plugins-{type}s-{plugin}-truststore_password>> |<<password,password>>|__Deprecated__
90-
| <<plugins-{type}s-{plugin}-truststore_type>> |<<string,string>>|__Deprecated__
9185
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|no
9286
| <<plugins-{type}s-{plugin}-validate_after_inactivity>> |<<number,number>>|No
9387
|=======================================================================
@@ -206,33 +200,6 @@ How many times should the client retry a failing URL. We highly recommend NOT se
206200
to zero if keepalive is enabled. Some servers incorrectly end keepalives early requiring a retry!
207201
Note: if `retry_non_idempotent` is set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.
208202

209-
[id="plugins-{type}s-{plugin}-cacert"]
210-
===== `cacert`
211-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate_authorities>>]
212-
213-
* Value type is <<path,path>>
214-
* There is no default value for this setting.
215-
216-
If you need to use a custom X.509 CA (.pem certs) specify the path to that here
217-
218-
[id="plugins-{type}s-{plugin}-client_cert"]
219-
===== `client_cert`
220-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_certificate>>]
221-
222-
* Value type is <<path,path>>
223-
* There is no default value for this setting.
224-
225-
If you'd like to use a client certificate (note, most people don't want this) set the path to the x509 cert here
226-
227-
[id="plugins-{type}s-{plugin}-client_key"]
228-
===== `client_key`
229-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_key>>]
230-
231-
* Value type is <<path,path>>
232-
* There is no default value for this setting.
233-
234-
If you're using a client certificate specify the path to the encryption key here
235-
236203
[id="plugins-{type}s-{plugin}-connect_timeout"]
237204
===== `connect_timeout`
238205

@@ -267,33 +234,6 @@ Should redirects be followed? Defaults to `true`
267234
Turn this on to enable HTTP keepalive support. We highly recommend setting `automatic_retries` to at least
268235
one with this to fix interactions with broken keepalive implementations.
269236

270-
[id="plugins-{type}s-{plugin}-keystore"]
271-
===== `keystore`
272-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_path>>]
273-
274-
* Value type is <<path,path>>
275-
* There is no default value for this setting.
276-
277-
If you need to use a custom keystore (`.jks`) specify that here. This does not work with .pem keys!
278-
279-
[id="plugins-{type}s-{plugin}-keystore_password"]
280-
===== `keystore_password`
281-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_password>>]
282-
283-
* Value type is <<password,password>>
284-
* There is no default value for this setting.
285-
286-
Specify the keystore password here.
287-
Note, most .jks files created with keytool require a password!
288-
289-
[id="plugins-{type}s-{plugin}-keystore_type"]
290-
===== `keystore_type`
291-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_keystore_type>>]
292-
293-
* Value type is <<string,string>>
294-
* Default value is `"JKS"`
295-
296-
Specify the keystore type here. One of `JKS` or `PKCS12`. Default is `JKS`
297237

298238
[id="plugins-{type}s-{plugin}-password"]
299239
===== `password`
@@ -483,34 +423,6 @@ This mode disables many of the security benefits of SSL/TLS and should only be u
483423
It is primarily intended as a temporary diagnostic mechanism when attempting to resolve TLS errors.
484424
Using `none` in production environments is strongly discouraged.
485425

486-
[id="plugins-{type}s-{plugin}-truststore"]
487-
===== `truststore`
488-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_path>>]
489-
490-
* Value type is <<path,path>>
491-
* There is no default value for this setting.
492-
493-
If you need to use a custom truststore (`.jks`) specify that here. This does not work with .pem certs!
494-
495-
[id="plugins-{type}s-{plugin}-truststore_password"]
496-
===== `truststore_password`
497-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_password>>]
498-
499-
* Value type is <<password,password>>
500-
* There is no default value for this setting.
501-
502-
Specify the truststore password here.
503-
Note, most .jks files created with keytool require a password!
504-
505-
[id="plugins-{type}s-{plugin}-truststore_type"]
506-
===== `truststore_type`
507-
deprecated[1.5.0, Replaced by <<plugins-{type}s-{plugin}-ssl_truststore_type>>]
508-
509-
* Value type is <<string,string>>
510-
* Default value is `"JKS"`
511-
512-
Specify the truststore type here. One of `JKS` or `PKCS12`. Default is `JKS`
513-
514426
[id="plugins-{type}s-{plugin}-user"]
515427
===== `user`
516428

@@ -538,5 +450,26 @@ connection validation. This check helps detect connections that have become
538450
stale (half-closed) while kept inactive in the pool."
539451

540452

453+
454+
[id="plugins-{type}s-{plugin}-obsolete-options"]
455+
==== HTTP Filter Obsolete Configuration Options
456+
457+
WARNING: As of version `2.0.0` of this plugin, some configuration options have been replaced.
458+
The plugin will fail to start if it contains any of these obsolete options.
459+
460+
[cols="<,<",options="header",]
461+
|=======================================================================
462+
|Setting|Replaced by
463+
| cacert |<<plugins-{type}s-{plugin}-ssl_certificate_authorities>>
464+
| client_cert |<<plugins-{type}s-{plugin}-ssl_certificate>>
465+
| client_key |<<plugins-{type}s-{plugin}-ssl_key>>
466+
| keystore |<<plugins-{type}s-{plugin}-ssl_keystore_path>>
467+
| keystore_password |<<plugins-{type}s-{plugin}-ssl_keystore_password>>
468+
| keystore_type |<<plugins-{type}s-{plugin}-ssl_keystore_type>>
469+
| truststore |<<plugins-{type}s-{plugin}-ssl_truststore_path>>
470+
| truststore_password |<<plugins-{type}s-{plugin}-ssl_truststore_password>>
471+
| truststore_type |<<plugins-{type}s-{plugin}-ssl_truststore_type>>
472+
|=======================================================================
473+
541474
[id="plugins-{type}s-{plugin}-common-options"]
542475
include::{include_path}/{type}.asciidoc[]

docs/plugins/filters/jdbc_static.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
///////////////////////////////////////////
77
START - GENERATED VARIABLES, DO NOT EDIT!
88
///////////////////////////////////////////
9-
:version: v5.5.1
10-
:release_date: 2024-12-03
11-
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.1/CHANGELOG.md
9+
:version: v5.5.2
10+
:release_date: 2024-12-23
11+
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md
1212
:include_path: ../../../../logstash/docs/include
1313
///////////////////////////////////////////
1414
END - GENERATED VARIABLES, DO NOT EDIT!

docs/plugins/filters/jdbc_streaming.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
///////////////////////////////////////////
77
START - GENERATED VARIABLES, DO NOT EDIT!
88
///////////////////////////////////////////
9-
:version: v5.5.1
10-
:release_date: 2024-12-03
11-
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.1/CHANGELOG.md
9+
:version: v5.5.2
10+
:release_date: 2024-12-23
11+
:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.5.2/CHANGELOG.md
1212
:include_path: ../../../../logstash/docs/include
1313
///////////////////////////////////////////
1414
END - GENERATED VARIABLES, DO NOT EDIT!

docs/plugins/inputs/azure_event_hubs.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
///////////////////////////////////////////
77
START - GENERATED VARIABLES, DO NOT EDIT!
88
///////////////////////////////////////////
9-
:version: v1.5.0
10-
:release_date: 2024-10-25
11-
:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.5.0/CHANGELOG.md
9+
:version: v1.5.1
10+
:release_date: 2025-01-03
11+
:changelog_url: https://github.com/logstash-plugins/logstash-input-azure_event_hubs/blob/v1.5.1/CHANGELOG.md
1212
:include_path: ../../../../logstash/docs/include
1313
///////////////////////////////////////////
1414
END - GENERATED VARIABLES, DO NOT EDIT!

0 commit comments

Comments
 (0)