logstash-input-beats 6.1.2-java → 6.1.6-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93be68545c73c99fadedfbc85c39ca333da359204980ac825ca7ee3cacda5595
-  data.tar.gz: e5dc98aba318950d3aa4f8d2c8ae47e6bb42fd928b0d484b2ae7e7aa321fa83e
+  metadata.gz: bdfb961f6671cbce9a01f9df53f0e2fa83ec6ac2f14521b51f2dfe32508b181b
+  data.tar.gz: ebf3b53c4b9efd6dd9be89b76e3d46ee2cae71f9c01d481fabddb4104e0ea546
 SHA512:
-  metadata.gz: 91149e12bae583a7386b740331302ceadf518ce973dac0a75f0288551f2717d648fad25a54b6a49f1a472467496c4eba5476dc4e6d3a0aae6368a576c5c78e89
-  data.tar.gz: 552642c0592c7d09387f737b1cf520d02d9b5d1bbf8c958bd90fb698f763385300490b173d03768d0584951cb1409e10a4248490c327344934e9c4986c4d827b
+  metadata.gz: a060db6f3d84a1aaa41d7da73728c16d959484af1d85efce09ac811597288faf7d89a66bff10a7254f394ee51eb70b9723df8488b1c61916b9b48ea2bba6bc70
+  data.tar.gz: 467e8d01b6a2c94dcf0afffcea88aa967fb3518b6be42722691b85f4497864e8645d468b3adbdba07dd8900be23a9b858b50be3c005f777f4da49b021b40fd63

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 6.1.6
+ - [DOC] Applied more attributes to manage plugin name in doc content, and implemented conditional text processing. [#423](https://github.com/logstash-plugins/logstash-input-http/pull/423)
+
+## 6.1.5
+ - Changed jar dependencies to reflect newer versions [#425](https://github.com/logstash-plugins/logstash-input-beats/pull/425)
+
+## 6.1.4
+ - Fix: reduce error logging on connection resets [#424](https://github.com/logstash-plugins/logstash-input-beats/pull/424)
+
+## 6.1.3
+ - Fix: safe-guard byte buf allocation [#420](https://github.com/logstash-plugins/logstash-input-beats/pull/420) 
+ - Updated Jackson dependencies
+
 ## 6.1.2
  - [DOC] Added naming attribute to control plugin name that appears in docs, and set up framework to make attributes viable in code sample
 
@@ -10,7 +23,7 @@
    `host` and `@metadata.ip_address` event fields. [#404](https://github.com/logstash-plugins/logstash-input-beats/pull/404)
 
 ## 6.0.14
-- Feat: log + unwrap generic SSL context exceptions [#405](https://github.com/logstash-plugins/logstash-input-beats/pull/405)
+ - Feat: log + unwrap generic SSL context exceptions [#405](https://github.com/logstash-plugins/logstash-input-beats/pull/405)
 
 ## 6.0.13
  - [DOC] Update links to use shared attributes

data/VERSION

@@ -1 +1 @@
-6.1.2
+6.1.6

data/docs/index.asciidoc

@@ -2,6 +2,7 @@
 :type: input
 :default_codec: plain
 :plugin-uc: Beats
+:plugin-singular: Beat
 
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
@@ -18,21 +19,27 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === {plugin-uc} input plugin
 
+NOTE: The `input-elastic_agent` plugin is the next generation of the
+`input-beats` plugin. 
+They currently share code and a https://github.com/logstash-plugins/logstash-input-beats[common codebase].
+
 include::{include_path}/plugin_header.asciidoc[]
 
 ==== Description
 
 This input plugin enables Logstash to receive events from the
-https://www.elastic.co/products/beats[Elastic Beats] framework.
+{plugin-uc} framework.
 
 The following example shows how to configure Logstash to listen on port
 5044 for incoming {plugin-uc} connections and to index into Elasticsearch.
 
+//Example for Beats
+ifeval::["{plugin}"=="beats"]
 ["source","sh",subs="attributes"]
 -----
 
 input {
-  beats {
+  {plugin} {
     port => 5044
   }
 }
@@ -45,9 +52,8 @@ output {
 }
 -----
 <1> `%{[@metadata][beat]}` sets the first part of the index name to the value
-of the `beat` metadata field and `%{[@metadata][version]}` sets the second part to
-the {plugin-uc}'s version. For example:
-metricbeat-7.4.0.
+of the metadata field and `%{[@metadata][version]}` sets the second part to
+the {plugin-singular} version. For example: metricbeat-6.1.6.
 
 Events indexed into Elasticsearch with the Logstash configuration shown here
 will be similar to events directly indexed by {plugin-uc} into Elasticsearch.
@@ -56,14 +62,56 @@ NOTE: If ILM is not being used, set `index` to
 `%{[@metadata][beat]}-%{[@metadata][version]}-%{+YYYY.MM.dd}` instead so
 Logstash creates an index per day, based on the `@timestamp` value of the events
 coming from {plugin-uc}.
+endif::[]
+
+//Example for Elastic Agent
+ifeval::["{plugin}"!="beats"]
+["source","sh",subs="attributes"]
+-----
+
+input {
+  {plugin} {
+    port => 5044
+  }
+}
 
-IMPORTANT: If you are shipping events that span multiple lines, you need to use
+output {
+  elasticsearch {
+    hosts => ["http://localhost:9200"]
+    data_stream => "true"
+  }
+}
+-----
+
+Events indexed into Elasticsearch with the Logstash configuration shown here
+will be similar to events directly indexed by {plugin-uc} into Elasticsearch.
+endif::[]
+
+
+//Content for Beats
+ifeval::["{plugin}"=="beats"]
+[id="plugins-{type}s-{plugin}-multiline"]
+===== Multi-line events
+
+If you are shipping events that span multiple lines, you need to use
 the {filebeat-ref}/multiline-examples.html[configuration options available in
 Filebeat] to handle multiline events before sending the event data to Logstash.
 You cannot use the {logstash-ref}/plugins-codecs-multiline.html[Multiline codec
 plugin] to handle multiline events. Doing so will result in the failure to start
 Logstash.
+endif::[]
+
+//Content for Elastic Agent
+ifeval::["{plugin}"!="beats"]
+[id="plugins-{type}s-{plugin}-limitations"]
+===== Elastic Agent and Fleet limitations
+
+Early releases of Elastic Agent and Fleet have some limitations, including support for advanced Beats settings like multiline, processors, and so forth. 
+For more information, see {fleet-guide}/fleet-limitations.html[Limitations of this release]. 
+endif::[]
 
+//Content for Beats
+ifeval::["{plugin}"=="beats"]
 [id="plugins-{type}s-{plugin}-versioned-indexes"]
 ==== Versioned indices
 
@@ -86,6 +134,7 @@ Logstash `@timestamp` field.
 
 This configuration results in daily index names like
 +filebeat-{logstash_version}-{localdate}+.
+endif::[]
 
 
 [id="plugins-{type}s-{plugin}-ecs_metadata"]
@@ -103,8 +152,8 @@ output.
 |=======================================================================
 |ECS disabled |ECS v1 |Availability |Description
 
-|[host]                  |[@metadata][input][beats][host][name]   |Always       |Name or address of the beat host
-|[@metadata][ip_address] |[@metadata][input][beats][host][ip]     |Always       |IP address of the Beats client
+|[host]                  |[@metadata][input][beats][host][name]   |Always       |Name or address of the {plugin-singular} host
+|[@metadata][ip_address] |[@metadata][input][beats][host][ip]     |Always       |IP address of the {plugin-uc} client
 |[@metadata][tls_peer][status] | [@metadata][tls_peer][status] | When SSL related fields are populated | Contains "verified"/"unverified" labels in `disabled`, `true`/`false` in `v1`
 |[@metadata][tls_peer][protocol] | [@metadata][input][beats][tls][version_protocol] | When SSL status is "verified" | Contains the TLS version used (e.g. `TLSv1.2`)
 |[@metadata][tls_peer][subject] | [@metadata][input][beats][tls][client][subject] | When SSL status is "verified" | Contains the identity name of the remote end (e.g. `CN=artifacts-no-kpi.elastic.co`)
@@ -112,7 +161,7 @@ output.
 |=======================================================================
 
 [id="plugins-{type}s-{plugin}-options"]
-==== {plugin-uc} Input Configuration Options
+==== {plugin-uc} input configuration options
 
 This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
 
@@ -151,7 +200,7 @@ input plugins.
   * Value type is <<boolean,boolean>>
   * Default value is `false`
 
-Flag to determine whether to add `host` field to event using the value supplied by the beat in the `hostname` field.
+Flag to determine whether to add `host` field to event using the value supplied by the {plugin-singular} in the `hostname` field.
 
 
 [id="plugins-{type}s-{plugin}-cipher_suites"]

data/lib/logstash-input-beats_jars.rb

@@ -1,11 +1,11 @@
 # AUTOGENERATED BY THE GRADLE SCRIPT. DO NOT EDIT.
 
 require 'jar_dependencies'
-require_jar('io.netty', 'netty-all', '4.1.49.Final')
+require_jar('io.netty', 'netty-all', '4.1.65.Final')
 require_jar('org.javassist', 'javassist', '3.24.0-GA')
 require_jar('com.fasterxml.jackson.core', 'jackson-core', '2.9.10')
 require_jar('com.fasterxml.jackson.core', 'jackson-annotations', '2.9.10')
-require_jar('com.fasterxml.jackson.core', 'jackson-databind', '2.9.10.4')
+require_jar('com.fasterxml.jackson.core', 'jackson-databind', '2.9.10.8')
 require_jar('com.fasterxml.jackson.module', 'jackson-module-afterburner', '2.9.10')
 require_jar('org.apache.logging.log4j', 'log4j-api', '2.11.1')
-require_jar('org.logstash.beats', 'logstash-input-beats', '6.1.2')
+require_jar('org.logstash.beats', 'logstash-input-beats', '6.1.6')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-beats
 version: !ruby/object:Gem::Version
-  version: 6.1.2
+  version: 6.1.6
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -20,8 +20,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
   name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -37,8 +37,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-plain
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,8 +51,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: concurrent-ruby
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -65,8 +65,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.5
   name: thread_safe
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -79,8 +79,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.5
   name: logstash-codec-multiline
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,8 +96,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.3.4
   name: jar-dependencies
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -113,8 +113,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
   name: logstash-mixin-ecs_compatibility_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -127,8 +127,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.6
   name: flores
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -141,8 +141,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -155,8 +155,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: stud
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -169,8 +169,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: pry
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -183,8 +183,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: rspec-wait
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -197,8 +197,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -211,8 +211,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-json
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -225,8 +225,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: childprocess
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -248,7 +248,6 @@ files:
 - PROTOCOL.md
 - README.md
 - VERSION
-- docs/agent.asciidoc
 - docs/index.asciidoc
 - lib/logstash-input-beats_jars.rb
 - lib/logstash/inputs/beats.rb
@@ -281,12 +280,12 @@ files:
 - spec/support/shared_examples.rb
 - vendor/jar-dependencies/com/fasterxml/jackson/core/jackson-annotations/2.9.10/jackson-annotations-2.9.10.jar
 - vendor/jar-dependencies/com/fasterxml/jackson/core/jackson-core/2.9.10/jackson-core-2.9.10.jar
-- vendor/jar-dependencies/com/fasterxml/jackson/core/jackson-databind/2.9.10.4/jackson-databind-2.9.10.4.jar
+- vendor/jar-dependencies/com/fasterxml/jackson/core/jackson-databind/2.9.10.8/jackson-databind-2.9.10.8.jar
 - vendor/jar-dependencies/com/fasterxml/jackson/module/jackson-module-afterburner/2.9.10/jackson-module-afterburner-2.9.10.jar
-- vendor/jar-dependencies/io/netty/netty-all/4.1.49.Final/netty-all-4.1.49.Final.jar
+- vendor/jar-dependencies/io/netty/netty-all/4.1.65.Final/netty-all-4.1.65.Final.jar
 - vendor/jar-dependencies/org/apache/logging/log4j/log4j-api/2.11.1/log4j-api-2.11.1.jar
 - vendor/jar-dependencies/org/javassist/javassist/3.24.0-GA/javassist-3.24.0-GA.jar
-- vendor/jar-dependencies/org/logstash/beats/logstash-input-beats/6.1.2/logstash-input-beats-6.1.2.jar
+- vendor/jar-dependencies/org/logstash/beats/logstash-input-beats/6.1.6/logstash-input-beats-6.1.6.jar
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -309,8 +308,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Receives events from the Elastic Beats framework

data/docs/agent.asciidoc

@@ -1,320 +0,0 @@
-:plugin: agent
-:type: input
-:default_codec: plain
-
-///////////////////////////////////////////
-START - GENERATED VARIABLES, DO NOT EDIT!
-///////////////////////////////////////////
-
-// Copied from Beats generated plugin output.
-// Not actively generated at this time!
-
-////
-:version: %VERSION%
-:release_date: %RELEASE_DATE%
-:changelog_url: %CHANGELOG_URL%
-:include_path: ../../../../logstash/docs/include
-////
-
-///////////////////////////////////////////
-END - GENERATED VARIABLES, DO NOT EDIT!
-///////////////////////////////////////////
-
-[id="plugins-{type}s-{plugin}"]
-
-=== Agent input plugin
-
-include::{include_path}/plugin_header.asciidoc[]
-
-==== Description
-
-This input plugin enables Logstash to receive events from the
-https://www.elastic.co/products/beats[Elastic Beats] framework.
-
-The following example shows how to configure Logstash to listen on port
-5044 for incoming Beats connections and to index into Elasticsearch.
-
-[source,logstash]
------
-
-input {
-  beats {
-    port => 5044
-  }
-}
-
-output {
-  elasticsearch {
-    hosts => ["http://localhost:9200"]
-    index => "%{[@metadata][beat]}-%{[@metadata][version]}" <1>
-  }
-}
------
-<1> `%{[@metadata][beat]}` sets the first part of the index name to the value
-of the `beat` metadata field and `%{[@metadata][version]}` sets the second part to
-the Beat's version. For example:
-metricbeat-7.4.0.
-
-Events indexed into Elasticsearch with the Logstash configuration shown here
-will be similar to events directly indexed by Beats into Elasticsearch.
-
-NOTE: If ILM is not being used, set `index` to
-`%{[@metadata][beat]}-%{[@metadata][version]}-%{+YYYY.MM.dd}` instead so
-Logstash creates an index per day, based on the `@timestamp` value of the events
-coming from Beats.
-
-IMPORTANT: If you are shipping events that span multiple lines, you need to use
-the {filebeat-ref}/multiline-examples.html[configuration options available in
-Filebeat] to handle multiline events before sending the event data to Logstash.
-You cannot use the {logstash-ref}/plugins-codecs-multiline.html[Multiline codec
-plugin] to handle multiline events. Doing so will result in the failure to start
-Logstash.
-
-[id="plugins-{type}s-{plugin}-versioned-indexes"]
-==== Versioned Beats Indices
-
-To minimize the impact of future schema changes on your existing indices and
-mappings in Elasticsearch, configure the Elasticsearch output to write to
-versioned indices. The pattern that you specify for the `index` setting
-controls the index name:
-
-[source,yaml]
-----
-index => "%{[@metadata][beat]}-%{[@metadata][version]}-%{+YYYY.MM.dd}"
-----
-
-`%{[@metadata][beat]}`:: Sets the first part of the index name to the value of
-the `beat` metadata field, for example, `filebeat`.
-`%{[@metadata][version]}`:: Sets the second part of the name to the Beat
-version, for example, +{logstash_version}+.
-`%{+YYYY.MM.dd}`:: Sets the third part of the name to a date based on the
-Logstash `@timestamp` field.
-
-This configuration results in daily index names like
-+filebeat-{logstash_version}-{localdate}+.
-
-
-[id="plugins-{type}s-{plugin}-ecs_metadata"]
-==== Event Metadata and the Elastic Common Schema (ECS)
-When decoding `beats` events, this plugin adds two fields related to the event: the deprecated `host`
-which contains the `hostname` provided by beats and the `ip_address` containing the remote address
-of the client's connection. When <<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> is
-enabled these are now moved in ECS compatible namespace.
-
-[id="plugins-{type}s-{plugin}-options"]
-==== Agent Input Configuration Options
-
-This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
-
-[cols="<,<,<",options="header",]
-|=======================================================================
-|Setting |Input type|Required
-| <<plugins-{type}s-{plugin}-add_hostname>> |<<boolean,boolean>>|No
-| <<plugins-{type}s-{plugin}-cipher_suites>> |<<array,array>>|No
-| <<plugins-{type}s-{plugin}-client_inactivity_timeout>> |<<number,number>>|No
-| <<plugins-{type}s-{plugin}-ecs_compatibility>> | <<string,string>>|No
-| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|No
-| <<plugins-{type}s-{plugin}-include_codec_tag>> |<<boolean,boolean>>|No
-| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|Yes
-| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|No
-| <<plugins-{type}s-{plugin}-ssl_certificate>> |a valid filesystem path|No
-| <<plugins-{type}s-{plugin}-ssl_certificate_authorities>> |<<array,array>>|No
-| <<plugins-{type}s-{plugin}-ssl_handshake_timeout>> |<<number,number>>|No
-| <<plugins-{type}s-{plugin}-ssl_key>> |a valid filesystem path|No
-| <<plugins-{type}s-{plugin}-ssl_key_passphrase>> |<<password,password>>|No
-| <<plugins-{type}s-{plugin}-ssl_verify_mode>> |<<string,string>>, one of `["none", "peer", "force_peer"]`|No
-| <<plugins-{type}s-{plugin}-ssl_peer_metadata>> |<<boolean,boolean>>|No
-| <<plugins-{type}s-{plugin}-tls_max_version>> |<<number,number>>|No
-| <<plugins-{type}s-{plugin}-tls_min_version>> |<<number,number>>|No
-|=======================================================================
-
-Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
-input plugins.
-
-&nbsp;
-
-[id="plugins-{type}s-{plugin}-add_hostname"]
-===== `add_hostname`
-
-  deprecated[6.0.0, The default value has been changed to `false`. In 7.0.0 this setting will be removed]
-
-  * Value type is <<boolean,boolean>>
-  * Default value is `false`
-
-Flag to determine whether to add `host` field to event using the value supplied by the beat in the `hostname` field.
-
-
-[id="plugins-{type}s-{plugin}-cipher_suites"]
-===== `cipher_suites`
-
-  * Value type is <<array,array>>
-  * Default value is `java.lang.String[TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256]@459cfcca`
-
-The list of ciphers suite to use, listed by priorities.
-
-[id="plugins-{type}s-{plugin}-client_inactivity_timeout"]
-===== `client_inactivity_timeout`
-
-  * Value type is <<number,number>>
-  * Default value is `60`
-
-Close Idle clients after X seconds of inactivity.
-
-[id="plugins-{type}s-{plugin}-ecs_compatibility"]
-===== `ecs_compatibility`
-
-* Value type is <<string,string>>
-* Supported values are:
-** `disabled`: unstructured connection metadata added at root level
-** `v1`: structured connection metadata added under ECS compliant namespaces
-* Default value depends on which version of Logstash is running:
-** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
-** Otherwise, the default value is `disabled`.
-
-Controls this plugin's compatibility with the {ecs-ref}[Elastic Common Schema (ECS)].
-The value of this setting affects the keys for the Beats connection's metadata on the event:
-
-.Metadata Location by `ecs_compatibility` value
-[cols="<l,<l,e,<e"]
-|=======================================================================
-|`disabled`              |`v1`                      |Availability |Description
-
-|[host]                  |[@metadata][input][beats][host][name]   |Always       |Name or address of the beat host
-|[@metadata][ip_address] |[@metadata][input][beats][host][ip]     |Always       |IP address of the Beats client
-|[@metadata][tls_peer][status] | [@metadata][tls_peer][status] | When SSL related fields are populated | Contains "verified"/"unverified" labels in `disabled`, `true`/`false` in `v1`
-|[@metadata][tls_peer][protocol] | [@metadata][input][beats][tls][version_protocol] | When SSL status is "verified" | Contains the TLS version used (e.g. `TLSv1.2`)
-|[@metadata][tls_peer][subject] | [@metadata][input][beats][tls][client][subject] | When SSL status is "verified" | Contains the identity name of the remote end (e.g. `CN=artifacts-no-kpi.elastic.co`)
-|[@metadata][tls_peer][cipher_suite] | [@metadata][input][beats][tls][cipher] | When SSL status is "verified" | Contains the name of cipher suite used (e.g. `TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256`)
-|=======================================================================
-
-[id="plugins-{type}s-{plugin}-host"]
-===== `host`
-
-  * Value type is <<string,string>>
-  * Default value is `"0.0.0.0"`
-
-The IP address to listen on.
-
-[id="plugins-{type}s-{plugin}-include_codec_tag"]
-===== `include_codec_tag`
-
-  * Value type is <<boolean,boolean>>
-  * Default value is `true`
-
-
-
-[id="plugins-{type}s-{plugin}-port"]
-===== `port`
-
-  * This is a required setting.
-  * Value type is <<number,number>>
-  * There is no default value for this setting.
-
-The port to listen on.
-
-[id="plugins-{type}s-{plugin}-ssl"]
-===== `ssl`
-
-  * Value type is <<boolean,boolean>>
-  * Default value is `false`
-
-Events are by default sent in plain text. You can
-enable encryption by setting `ssl` to true and configuring
-the `ssl_certificate` and `ssl_key` options.
-
-[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.
-
-[id="plugins-{type}s-{plugin}-ssl_certificate_authorities"]
-===== `ssl_certificate_authorities`
-
-  * Value type is <<array,array>>
-  * Default value is `[]`
-
-Validate client certificates against these authorities.
-You can define multiple files or paths. All the certificates will
-be read and added to the trust store. You need to configure the `ssl_verify_mode`
-to `peer` or `force_peer` to enable the verification.
-
-
-[id="plugins-{type}s-{plugin}-ssl_handshake_timeout"]
-===== `ssl_handshake_timeout`
-
-  * Value type is <<number,number>>
-  * Default value is `10000`
-
-Time in milliseconds for an incomplete ssl handshake to timeout
-
-[id="plugins-{type}s-{plugin}-ssl_key"]
-===== `ssl_key`
-
-  * Value type is <<path,path>>
-  * There is no default value for this setting.
-
-SSL key to use.
-NOTE: This key need to be in the PKCS8 format, you can convert it with https://www.openssl.org/docs/man1.1.0/apps/pkcs8.html[OpenSSL]
-for more information.
-
-[id="plugins-{type}s-{plugin}-ssl_key_passphrase"]
-===== `ssl_key_passphrase`
-
-  * Value type is <<password,password>>
-  * There is no default value for this setting.
-
-SSL key passphrase to use.
-
-[id="plugins-{type}s-{plugin}-ssl_verify_mode"]
-===== `ssl_verify_mode`
-
-  * Value can be any of: `none`, `peer`, `force_peer`
-  * Default value is `"none"`
-
-By default the server doesn't do any client verification.
-
-`peer` will make the server ask the client to provide a certificate.
-If the client provides a certificate, it will be validated.
-
-`force_peer` will make the server ask the client to provide a certificate.
-If the client doesn't provide a certificate, the connection will be closed.
-
-This option needs to be used with `ssl_certificate_authorities` and a defined list of CAs.
-
-[id="plugins-{type}s-{plugin}-ssl_peer_metadata"]
-===== `ssl_peer_metadata`
-
-  * Value type is <<boolean,boolean>>
-  * Default value is `false`
-
-Enables storing client certificate information in event's metadata.
-
-This option is only valid when `ssl_verify_mode` is set to `peer` or `force_peer`.
-
-[id="plugins-{type}s-{plugin}-tls_max_version"]
-===== `tls_max_version`
-
-  * Value type is <<number,number>>
-  * Default value is `1.2`
-
-The maximum TLS version allowed for the encrypted connections. The value must be the one of the following:
-1.0 for TLS 1.0, 1.1 for TLS 1.1, 1.2 for TLS 1.2
-
-[id="plugins-{type}s-{plugin}-tls_min_version"]
-===== `tls_min_version`
-
-  * Value type is <<number,number>>
-  * Default value is `1`
-
-The minimum TLS version allowed for the encrypted connections. The value must be one of the following:
-1.0 for TLS 1.0, 1.1 for TLS 1.1, 1.2 for TLS 1.2
-
-
-
-[id="plugins-{type}s-{plugin}-common-options"]
-include::{include_path}/{type}.asciidoc[]
-
-:default_codec!: