updated docs for main (#1666)

elastic · May 28, 2024 · 93c80fb · 93c80fb
1 parent e9486fc
commit 93c80fb
Show file tree

Hide file tree

Showing 6 changed files with 67 additions and 51 deletions.
diff --git a/docs/plugins/filters/de_dot.asciidoc b/docs/plugins/filters/de_dot.asciidoc
@@ -5,9 +5,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v1.0.4
-:release_date: 2019-02-04
-:changelog_url: https://github.com/logstash-plugins/logstash-filter-de_dot/blob/v1.0.4/CHANGELOG.md
+:version: v1.1.0
+:release_date: 2024-05-27
+:changelog_url: https://github.com/logstash-plugins/logstash-filter-de_dot/blob/v1.1.0/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -38,6 +38,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-fields>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-nested>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-recursive>> |<<boolean,boolean>>|No
 | <<plugins-{type}s-{plugin}-separator>> |<<string,string>>|No
 |=======================================================================
 
@@ -59,7 +60,6 @@ will result in "field_suffix" and nested or sub field ["foo"]["bar_suffix"]
 
 WARNING: This is an expensive operation.
 
-
 [id="plugins-{type}s-{plugin}-nested"]
 ===== `nested` 
 
@@ -69,6 +69,15 @@ WARNING: This is an expensive operation.
 If `nested` is _true_, then create sub-fields instead of replacing dots with
 a different separator.
 
+[id="plugins-{type}s-{plugin}-recursive"]
+===== `recursive`
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+If `recursive` is _true_, then recursively check sub-fields. It is recommended you
+only use this when setting specific fields, as this is an expensive operation.
+
 [id="plugins-{type}s-{plugin}-separator"]
 ===== `separator` 
 

diff --git a/docs/plugins/filters/geoip.asciidoc b/docs/plugins/filters/geoip.asciidoc
@@ -5,9 +5,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v7.2.13
-:release_date: 2023-02-07
-:changelog_url: https://github.com/logstash-plugins/logstash-filter-geoip/blob/v7.2.13/CHANGELOG.md
+: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
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!
@@ -191,37 +191,44 @@ When ECS compatibility is enabled, the fields are structured to fit into an ECS
 |===========================
 | Database Field Name | ECS Field | Example
 
-| `ip`               | `[ip]`                     | `12.34.56.78`
-
-| `city_name`        | `[geo][city_name]`         | `Seattle`
-| `country_name`     | `[geo][country_name]`      | `United States`
-| `continent_code`   | `[geo][continent_code]`    | `NA`
-| `continent_name`   | `[geo][continent_name]`    | `North America`
-| `country_code2`    | `[geo][country_iso_code]`  | `US`
-| `country_code3`    | _N/A_                      | `US`
-
-                                                    _maintained for legacy
-                                                    support, but populated
-                                                    with 2-character country
-                                                    code_
-
-| `postal_code`      | `[geo][postal_code]`       | `98106`
-| `region_name`      | `[geo][region_name]`       | `Washington`
-| `region_code`      | `[geo][region_code]`       | `WA`
-| `region_iso_code`* | `[geo][region_iso_code]`   | `US-WA`
-| `timezone`         | `[geo][timezone]`          | `America/Los_Angeles`
-| `location`*        | `[geo][location]`          | `{"lat": 47.6062, "lon": -122.3321}"`
-| `latitude`         | `[geo][location][lat]`     | `47.6062`
-| `longitude`        | `[geo][location][lon]`     | `-122.3321`
-
-| `domain`           | `[domain]`                 | `example.com`
-
-| `asn`              | `[as][number]`             | `98765`
-| `as_org`           | `[as][organization][name]` | `Elastic, NV`
-
-| `isp`              | `[mmdb][isp]`              | `InterLink Supra LLC`
-| `dma_code`         | `[mmdb][dma_code]`         | `819`
-| `organization`     | `[mmdb][organization]`     | `Elastic, NV`
+| `ip`                | `[ip]`                           | `12.34.56.78`
+| `anonymous`         | `[ip_traits][anonymous]`         | `false`
+| `anonymous_vpn`     | `[ip_traits][anonymous_vpn]`     | `false`
+| `hosting_provider`  | `[ip_traits][hosting_provider]`  | `true`
+| `network`           | `[ip_traits][network]`           | `12.34.56.78/20`
+| `public_proxy`      | `[ip_traits][public_proxy]`      | `true`
+| `residential_proxy` | `[ip_traits][residential_proxy]` | `false`
+| `tor_exit_node`     | `[ip_traits][tor_exit_node]`     | `true`
+
+| `city_name`         | `[geo][city_name]`               | `Seattle`
+| `country_name`      | `[geo][country_name]`            | `United States`
+| `continent_code`    | `[geo][continent_code]`          | `NA`
+| `continent_name`    | `[geo][continent_name]`          | `North America`
+| `country_code2`     | `[geo][country_iso_code]`        | `US`
+| `country_code3`     | _N/A_                            | `US`
+
+                                                           _maintained for legacy
+                                                           support, but populated
+                                                           with 2-character country
+                                                           code_
+
+| `postal_code`       | `[geo][postal_code]`             | `98106`
+| `region_name`       | `[geo][region_name]`             | `Washington`
+| `region_code`       | `[geo][region_code]`             | `WA`
+| `region_iso_code`*  | `[geo][region_iso_code]`         | `US-WA`
+| `timezone`          | `[geo][timezone]`                | `America/Los_Angeles`
+| `location`*         | `[geo][location]`                | `{"lat": 47.6062, "lon": -122.3321}"`
+| `latitude`          | `[geo][location][lat]`           | `47.6062`
+| `longitude`         | `[geo][location][lon]`           | `-122.3321`
+
+| `domain`            | `[domain]`                       | `example.com`
+
+| `asn`               | `[as][number]`                   | `98765`
+| `as_org`            | `[as][organization][name]`       | `Elastic, NV`
+
+| `isp`               | `[mmdb][isp]`                    | `InterLink Supra LLC`
+| `dma_code`          | `[mmdb][dma_code]`               | `819`
+| `organization`      | `[mmdb][organization]`           | `Elastic, NV`
 |===========================
 
 NOTE: `*` indicates a composite field, which is only populated if GeoIP lookup result contains all components.
@@ -302,7 +309,7 @@ number of cache misses and waste memory.
 The path to MaxMind's database file that Logstash should use.
 The default database is `GeoLite2-City`.
 This plugin supports several free databases (`GeoLite2-City`, `GeoLite2-Country`, `GeoLite2-ASN`)
-and a selection of commercially-licensed databases (`GeoIP2-City`, `GeoIP2-ISP`, `GeoIP2-Country`).
+and a selection of commercially-licensed databases (`GeoIP2-City`, `GeoIP2-ISP`, `GeoIP2-Country`, `GeoIP2-Domain`, `GeoIP2-Enterprise`, `GeoIP2-Anonymous-IP`).
 
 Database auto-update applies to the default distribution.
 When `database` points to user's database path, auto-update is disabled.

diff --git a/docs/plugins/filters/jdbc_static.asciidoc b/docs/plugins/filters/jdbc_static.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v5.4.10
-:release_date: 2024-05-08
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.10/CHANGELOG.md
+:version: v5.4.11
+:release_date: 2024-05-23
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.11/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/filters/jdbc_streaming.asciidoc b/docs/plugins/filters/jdbc_streaming.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v5.4.10
-:release_date: 2024-05-08
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.10/CHANGELOG.md
+:version: v5.4.11
+:release_date: 2024-05-23
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.11/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/inputs/jdbc.asciidoc b/docs/plugins/inputs/jdbc.asciidoc
@@ -7,9 +7,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v5.4.10
-:release_date: 2024-05-08
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.10/CHANGELOG.md
+:version: v5.4.11
+:release_date: 2024-05-23
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.11/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!

diff --git a/docs/plugins/integrations/jdbc.asciidoc b/docs/plugins/integrations/jdbc.asciidoc
@@ -6,9 +6,9 @@
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
 ///////////////////////////////////////////
-:version: v5.4.10
-:release_date: 2024-05-08
-:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.10/CHANGELOG.md
+:version: v5.4.11
+:release_date: 2024-05-23
+:changelog_url: https://github.com/logstash-plugins/logstash-integration-jdbc/blob/v5.4.11/CHANGELOG.md
 :include_path: ../../../../logstash/docs/include
 ///////////////////////////////////////////
 END - GENERATED VARIABLES, DO NOT EDIT!