logstash-input-beats 6.0.13-java → 6.1.3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef7779105775e36517acd284df5cbb37c939bd8b0efd65e4a3ffb666800e4c6a
-  data.tar.gz: f9d9e7d95f1bcae77c92bff84eb8c80b74abc8065e4ebcec602104aac08ce029
+  metadata.gz: e3d70597b1b447c581f1a7c6d9757aeff377cb57f9e0bf30ae62a1a82ae2e3d7
+  data.tar.gz: f2fbd686d950b35fb9d337330e226029b4dce5eaaf56e3ac31722cc6dbd849ac
 SHA512:
-  metadata.gz: 5d0894f99926e28eead2857c4f3290b6bc2e59595b305c7feb5c4fb331d54267030eb3791bbff0c6838103528161a64f02d41f4ce9345dd500e58b3a3723219b
-  data.tar.gz: ce4d2455d86c6f1d40d92d9e476ca942bd92ca156fdc764ecf8941716295c0038ec799004da6c7f7e7d626e2aabd5e96d5555a80c0de5386cf885d4cec930240
+  metadata.gz: 892b7166ecd256432677e4bda1dbc2ebd4c9555fc2aecf26e73ed0d2747b2e736b6e1421582b3ec786ba6bef4c6a705c4c0a6d0b54423980c0f9f7ddbf4ddaf9
+  data.tar.gz: e8101ebad94b1924d68a2000b8c2b9c9996ef2634fcb1e8d87d445e64941b5278b6af8c24d7f93e3c271638028f36f258c717d9401595c213a3f99ec46f138ed

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 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
+
+## 6.1.1
+ - [DOC] Enhanced ECS compatibility information for ease of use and readability
+ [#413](https://github.com/logstash-plugins/logstash-input-beats/pull/413)
+
+## 6.1.0
+ - ECS compatibility enablement. Adds `ecs_compatibility` setting to declare the level of ECS compatibility (`disabled` or `v1`) at plugin level. When `disabled`, the plugin behaves like before, while `v1` does a rename of
+   `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)
+
 ## 6.0.13
  - [DOC] Update links to use shared attributes
 

data/VERSION

@@ -1 +1 @@
-6.0.13
+6.1.3

data/docs/index.asciidoc

@@ -1,6 +1,7 @@
 :plugin: beats
 :type: input
 :default_codec: plain
+:plugin-uc: Beats
 
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
@@ -15,7 +16,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 [id="plugins-{type}s-{plugin}"]
 
-=== Beats input plugin
+=== {plugin-uc} input plugin
 
 include::{include_path}/plugin_header.asciidoc[]
 
@@ -25,9 +26,9 @@ 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.
+5044 for incoming {plugin-uc} connections and to index into Elasticsearch.
 
-[source,logstash]
+["source","sh",subs="attributes"]
 -----
 
 input {
@@ -45,16 +46,16 @@ 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 Beat's version. For example:
+the {plugin-uc}'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.
+will be similar to events directly indexed by {plugin-uc} 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.
+coming from {plugin-uc}.
 
 IMPORTANT: If you are shipping events that span multiple lines, you need to use
 the {filebeat-ref}/multiline-examples.html[configuration options available in
@@ -64,7 +65,7 @@ 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
+==== Versioned indices
 
 To minimize the impact of future schema changes on your existing indices and
 mappings in Elasticsearch, configure the Elasticsearch output to write to
@@ -86,8 +87,32 @@ 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 {plugin-uc} events, this plugin adds two fields related to the event:
+the deprecated `host` which contains the `hostname` provided by {plugin-uc} 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. Here's how
+<<plugins-{type}s-{plugin}-ecs_compatibility,ECS compatibility mode>> affects
+output.  
+
+[cols="<l,<l,e,<e"]
+|=======================================================================
+|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
+|[@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}-options"]
-==== Beats 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.
 
@@ -97,6 +122,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<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
@@ -144,6 +170,19 @@ The list of ciphers suite to use, listed by priorities.
 
 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`.
+
+Refer to <<plugins-{type}s-{plugin}-ecs_metadata,ECS mapping>> for detailed information.
+
 [id="plugins-{type}s-{plugin}-host"]
 ===== `host`
 

data/lib/logstash-input-beats_jars.rb

@@ -5,7 +5,7 @@ require_jar('io.netty', 'netty-all', '4.1.49.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.0.13')
+require_jar('org.logstash.beats', 'logstash-input-beats', '6.1.3')

data/lib/logstash/inputs/beats.rb

@@ -5,6 +5,7 @@ require "logstash/timestamp"
 require "logstash/codecs/multiline"
 require "logstash/util"
 require "logstash-input-beats_jars"
+require "logstash/plugin_mixins/ecs_compatibility_support"
 require_relative "beats/patch"
 
 # This input plugin enables Logstash to receive events from the
@@ -49,6 +50,9 @@ class LogStash::Inputs::Beats < LogStash::Inputs::Base
   require "logstash/inputs/beats/message_listener"
   require "logstash/inputs/beats/tls"
 
+  # adds ecs_compatibility config which could be :disabled or :v1
+  include LogStash::PluginMixins::ECSCompatibilitySupport(:disabled,:v1)
+
   config_name "beats"
 
   default :codec, "plain"
@@ -121,6 +125,8 @@ class LogStash::Inputs::Beats < LogStash::Inputs::Base
   # Beats handler executor thread
   config :executor_threads, :validate => :number, :default => LogStash::Config::CpuCoreStrategy.maximum
 
+  attr_reader :field_hostname, :field_hostip
+
   def register
     # For Logstash 2.4 we need to make sure that the logger is correctly set for the
     # java classes before actually loading them.
@@ -156,6 +162,13 @@ class LogStash::Inputs::Beats < LogStash::Inputs::Base
       configuration_error "Multiline codec with beats input is not supported. Please refer to the beats documentation for how to best manage multiline data. See https://www.elastic.co/guide/en/beats/filebeat/current/multiline-examples.html"
     end
 
+    # define ecs name mapping
+    @field_hostname = ecs_select[disabled: "host", v1: "[@metadata][input][beats][host][name]"]
+    @field_hostip   = ecs_select[disabled: "[@metadata][ip_address]", v1: "[@metadata][input][beats][host][ip]"]
+    @field_tls_protocol_version   = ecs_select[disabled: "[@metadata][tls_peer][protocol]", v1: "[@metadata][input][beats][tls][version_protocol]"]
+    @field_tls_peer_subject   = ecs_select[disabled: "[@metadata][tls_peer][subject]", v1: "[@metadata][input][beats][tls][client][subject]"]
+    @field_tls_cipher   = ecs_select[disabled: "[@metadata][tls_peer][cipher_suite]", v1: "[@metadata][input][beats][tls][cipher]"]
+
     @logger.info("Starting input listener", :address => "#{@host}:#{@port}")
 
     @server = create_server
@@ -220,7 +233,7 @@ class LogStash::Inputs::Beats < LogStash::Inputs::Base
     rescue java.lang.IllegalArgumentException => e
       @logger.error("SSL configuration invalid", error_details(e))
       raise LogStash::ConfigurationError, e
-    rescue java.security.GeneralSecurityException => e
+    rescue java.lang.Exception => e # java.security.GeneralSecurityException
       @logger.error("SSL configuration failed", error_details(e, true))
       raise e
     end
@@ -254,6 +267,11 @@ class LogStash::Inputs::Beats < LogStash::Inputs::Base
   def error_details(e, trace = false)
     error_details = { :exception => e.class, :message => e.message }
     error_details[:backtrace] = e.backtrace if trace || @logger.debug?
+    cause = e.cause
+    if cause && e != cause
+      error_details[:cause] = { :exception => cause.class, :message => cause.message }
+      error_details[:cause][:backtrace] = cause.backtrace if trace || @logger.debug?
+    end
     error_details
   end
 

data/lib/logstash/inputs/beats/decoded_event_transform.rb

@@ -9,7 +9,16 @@ module LogStash module Inputs class Beats
       ts = coerce_ts(hash.delete("@timestamp"))
 
       event.set("@timestamp", ts) unless ts.nil?
-      hash.each { |k, v| event.set(k, v) }
+      hash.each do |k, v|
+        #could be a nested map, so we need to merge and not overwrite
+        existing_value = event.get(k)
+        if existing_value.is_a?(Hash)
+          existing_value = existing_value.merge(v)
+        else
+          existing_value = v
+        end
+        event.set(k, existing_value)
+      end
       super(event)
       event.tag("beats_input_codec_#{codec_name}_applied") if include_codec_tag?
       event

data/lib/logstash/inputs/beats/event_transform_common.rb

@@ -15,8 +15,8 @@ module LogStash module Inputs class Beats
       return unless @input.add_hostname
       host = event.get("[beat][hostname]")
 
-      if host && event.get("host").nil?
-        event.set("host", host)
+      if host && event.get(@input.field_hostname).nil?
+        event.set(@input.field_hostname, host)
       end
     end
 

data/lib/logstash/inputs/beats/message_listener.rb

@@ -31,7 +31,9 @@ module LogStash module Inputs class Beats
       hash = message.getData
       ip_address = ip_address(ctx)
 
-      hash['@metadata']['ip_address'] = ip_address unless ip_address.nil? || hash['@metadata'].nil?
+      unless ip_address.nil? || hash['@metadata'].nil?
+        set_nested(hash, @input.field_hostip, ip_address)
+      end
       target_field = extract_target_field(hash)
 
       extract_tls_peer(hash, ctx)
@@ -140,11 +142,12 @@ module LogStash module Inputs class Beats
         end
 
         if tls_verified
+          set_nested(hash, @field_tls_protocol_version, tls_session.getProtocol())
+          set_nested(hash, @field_tls_peer_subject, tls_session.getPeerPrincipal().getName())
+          set_nested(hash, @field_tls_cipher, tls_session.getCipherSuite())
+
           hash['@metadata']['tls_peer'] = {
-            :status       => "verified",
-            :protocol     => tls_session.getProtocol(),
-            :subject      => tls_session.getPeerPrincipal().getName(),
-            :cipher_suite => tls_session.getCipherSuite()
+            :status       => "verified"
           }
         else
           hash['@metadata']['tls_peer'] = {
@@ -154,6 +157,28 @@ module LogStash module Inputs class Beats
       end
     end
 
+    # set the value for field_name into the hash, nesting into sub-hashes and creating hashes where necessary
+    public #only to make it testable
+    def set_nested(hash, field_name, value)
+      field_ref = Java::OrgLogstash::FieldReference.from(field_name)
+      # create @metadata sub-hash if needed
+      if field_ref.type == Java::OrgLogstash::FieldReference::META_CHILD
+        unless hash.key?("@metadata")
+          hash["@metadata"] = {}
+        end
+        nesting_hash = hash["@metadata"]
+      else
+        nesting_hash = hash
+      end
+
+      field_ref.path.each do |token|
+        nesting_hash[token] = {} unless nesting_hash.key?(token)
+        nesting_hash = nesting_hash[token]
+      end
+      nesting_hash[field_ref.key] = value
+    end
+
+    private
     def extract_target_field(hash)
       if from_filebeat?(hash)
         hash.delete(FILEBEAT_LOG_LINE_FIELD).to_s

data/logstash-input-beats.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "thread_safe", "~> 0.3.5"
   s.add_runtime_dependency "logstash-codec-multiline", ">= 2.0.5"
   s.add_runtime_dependency 'jar-dependencies', '~> 0.3', '>= 0.3.4'
+  s.add_runtime_dependency 'logstash-mixin-ecs_compatibility_support', '~>1.1'
 
   s.add_development_dependency "flores", "~>0.0.6"
   s.add_development_dependency "rspec"

data/spec/inputs/beats/decoded_event_transform_spec.rb

@@ -29,7 +29,8 @@ describe LogStash::Inputs::Beats::DecodedEventTransform do
 
   subject { described_class.new(input).transform(event, map) }
 
-  include_examples "Common Event Transformation"
+  include_examples "Common Event Transformation", :disabled, "host"
+  include_examples "Common Event Transformation", :v1, "[@metadata][input][beats][host][name]"
 
   it "tags the event" do
     expect(subject.get("tags")).to include("beats_input_codec_plain_applied")
@@ -43,7 +44,7 @@ describe LogStash::Inputs::Beats::DecodedEventTransform do
   context "map contains a timestamp" do
     context "when its valid" do
       let(:timestamp) { Time.now }
-      let(:map) { super.merge({"@timestamp" => timestamp }) }
+      let(:map) { super().merge({"@timestamp" => timestamp }) }
      
       it "uses as the event timestamp" do
         expect(subject.get("@timestamp")).to eq(LogStash::Timestamp.coerce(timestamp)) 
@@ -51,7 +52,7 @@ describe LogStash::Inputs::Beats::DecodedEventTransform do
     end
 
     context "when its not valid" do
-      let(:map) { super.merge({"@timestamp" => "invalid" }) }
+      let(:map) { super().merge({"@timestamp" => "invalid" }) }
 
       it "fallback the current time" do
         expect(subject.get("@timestamp")).to be_kind_of(LogStash::Timestamp)

data/spec/inputs/beats/event_transform_common_spec.rb

@@ -7,5 +7,6 @@ require "spec_helper"
 describe LogStash::Inputs::Beats::EventTransformCommon do
   subject { described_class.new(input).transform(event) }
 
-  include_examples "Common Event Transformation"
+  include_examples "Common Event Transformation", :disabled, "host"
+  include_examples "Common Event Transformation", :v1, "[@metadata][input][beats][host][name]"
 end

data/spec/inputs/beats/message_listener_spec.rb

@@ -52,10 +52,73 @@ class DummyCodec < LogStash::Codecs::Base
   end
 end
 
+shared_examples "when the message is from any libbeat" do |ecs_compatibility, host_field_name|
+  let(:input) do
+    input = LogStash::Inputs::Beats.new({ "port" => 5555, "codec" => codec, "ecs_compatibility" => "#{ecs_compatibility}" })
+    input.register
+    input
+  end
+
+  #Requires data modeled as Java, not Ruby since the actual code pulls from Java backed (Netty) object
+  let(:data) do
+    d = HashMap.new
+    d.put('@metadata', HashMap.new)
+    d.put('metric',  1)
+    d.put('name', "super-stats")
+    d
+  end
+
+  let(:message) { MockMessage.new("abc",  data)}
+
+  it "extract the event" do
+    subject.onNewMessage(ctx, message)
+    event = queue.pop
+    expect(event.get("message")).to be_nil
+    expect(event.get("metric")).to eq(1)
+    expect(event.get("name")).to eq("super-stats")
+    expect(event.get(host_field_name)).to eq(ip_address)
+  end
+
+  context 'when the remote address is nil' do
+    let(:ctx) { OngoingMethodMock.new("remoteAddress", nil)}
+
+    it 'extracts the event' do
+      subject.onNewMessage(ctx, message)
+      event = queue.pop
+      expect(event.get("message")).to be_nil
+      expect(event.get("metric")).to eq(1)
+      expect(event.get("name")).to eq("super-stats")
+      expect(event.get(host_field_name)).to eq(nil)
+    end
+  end
+
+  context 'when getting the remote address raises' do
+    let(:raising_ctx) { double("context")}
+
+    before  do
+      allow(raising_ctx).to receive(:channel).and_raise("nope")
+      subject.onNewConnection(raising_ctx)
+    end
+
+    it 'extracts the event' do
+      subject.onNewMessage(raising_ctx, message)
+      event = queue.pop
+      expect(event.get("message")).to be_nil
+      expect(event.get("metric")).to eq(1)
+      expect(event.get("name")).to eq("super-stats")
+      expect(event.get(host_field_name)).to eq(nil)
+    end
+  end
+end
+
 describe LogStash::Inputs::Beats::MessageListener do
   let(:queue)  { Queue.new }
   let(:codec) { DummyCodec.new }
-  let(:input) { LogStash::Inputs::Beats.new({ "port" => 5555, "codec" => codec }) }
+  let(:input) do
+    input = LogStash::Inputs::Beats.new({ "port" => 5555, "codec" => codec })
+    input.register
+    input
+  end
 
   let(:ip_address) { "10.0.0.1" }
   let(:remote_address) { OngoingMethodMock.new("getHostAddress", ip_address) }
@@ -146,59 +209,8 @@ describe LogStash::Inputs::Beats::MessageListener do
       end
     end
 
-    context "when the message is from any libbeat" do
-      #Requires data modeled as Java, not Ruby since the actual code pulls from Java backed (Netty) object
-      let(:data) do
-        d = HashMap.new
-        d.put('@metadata', HashMap.new)
-        d.put('metric',  1)
-        d.put('name', "super-stats")
-        d
-      end
-
-      let(:message) { MockMessage.new("abc",  data)}
-
-      it "extract the event" do
-        subject.onNewMessage(ctx, message)
-        event = queue.pop
-        expect(event.get("message")).to be_nil
-        expect(event.get("metric")).to eq(1)
-        expect(event.get("name")).to eq("super-stats")
-        expect(event.get("[@metadata][ip_address]")).to eq(ip_address)
-      end
-
-      context 'when the remote address is nil' do
-        let(:ctx) { OngoingMethodMock.new("remoteAddress", nil)}
-
-        it 'extracts the event' do
-          subject.onNewMessage(ctx, message)
-          event = queue.pop
-          expect(event.get("message")).to be_nil
-          expect(event.get("metric")).to eq(1)
-          expect(event.get("name")).to eq("super-stats")
-          expect(event.get("[@metadata][ip_address]")).to eq(nil)
-        end
-      end
-
-      context 'when getting the remote address raises' do
-        let(:raising_ctx) { double("context")}
-
-        before  do
-          allow(raising_ctx).to receive(:channel).and_raise("nope")
-          subject.onNewConnection(raising_ctx)
-        end
-
-        it 'extracts the event' do
-          subject.onNewMessage(raising_ctx, message)
-          event = queue.pop
-          expect(event.get("message")).to be_nil
-          expect(event.get("metric")).to eq(1)
-          expect(event.get("name")).to eq("super-stats")
-          expect(event.get("[@metadata][ip_address]")).to eq(nil)
-        end
-      end
-
-    end
+    it_behaves_like "when the message is from any libbeat", :disabled, "[@metadata][ip_address]"
+    it_behaves_like "when the message is from any libbeat", :v1, "[@metadata][input][beats][host][ip]"
   end
 
   context "onException" do
@@ -222,4 +234,20 @@ describe LogStash::Inputs::Beats::MessageListener do
       expect(queue).not_to be_empty
     end
   end
+
+  context "set_nested" do
+    let(:hash) {{}}
+
+    it "creates correctly the nested maps" do
+      subject.set_nested(hash, "[root][inner][leaf]", 5)
+      expect(hash["root"]["inner"]["leaf"]).to eq(5)
+    end
+
+    it "doesn't overwrite existing the nested maps" do
+      hash = {"root" => {"foo" => {"bar" => "Hello"}}}
+      subject.set_nested(hash, "[root][inner][leaf]", 5)
+      expect(hash["root"]["inner"]["leaf"]).to eq(5)
+      expect(hash["root"]["foo"]["bar"]).to eq("Hello")
+    end
+  end
 end

data/spec/inputs/beats/raw_event_transform_spec.rb

@@ -18,7 +18,8 @@ describe LogStash::Inputs::Beats::RawEventTransform do
 
   subject { described_class.new(input).transform(event) }
 
-  include_examples "Common Event Transformation"
+  include_examples "Common Event Transformation", :disabled, "host"
+  include_examples "Common Event Transformation", :v1, "[@metadata][input][beats][host][name]"
 
   it "tags the event" do
     expect(subject.get("tags")).to include("beats_input_raw_event")

data/spec/inputs/beats_spec.rb

@@ -25,7 +25,7 @@ describe LogStash::Inputs::Beats do
 
   context "#register" do
     context "host related configuration" do
-      let(:config) { super.merge("host" => host, "port" => port, "client_inactivity_timeout" => client_inactivity_timeout, "executor_threads" => threads) }
+      let(:config) { super().merge("host" => host, "port" => port, "client_inactivity_timeout" => client_inactivity_timeout, "executor_threads" => threads) }
       let(:host) { "192.168.1.20" }
       let(:port) { 9000 }
       let(:client_inactivity_timeout) { 400 }
@@ -76,7 +76,7 @@ describe LogStash::Inputs::Beats do
       end
 
       context "with invalid ciphers" do
-        let(:config) { super.merge("ssl" => true, "cipher_suites" => "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA38") }
+        let(:config) { super().merge("ssl" => true, "cipher_suites" => "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA38") }
 
         it "should raise a configuration error" do
           plugin = LogStash::Inputs::Beats.new(config)
@@ -90,7 +90,7 @@ describe LogStash::Inputs::Beats do
 
       context "verify_mode" do
         context "verify_mode configured to PEER" do
-          let(:config) { super.merge("ssl" => true, "ssl_verify_mode" => "peer") }
+          let(:config) { super().merge("ssl" => true, "ssl_verify_mode" => "peer") }
 
           it "raise a ConfigurationError when certificate_authorities is not set" do
             plugin = LogStash::Inputs::Beats.new(config)
@@ -105,7 +105,7 @@ describe LogStash::Inputs::Beats do
         end
 
         context "verify_mode configured to FORCE_PEER" do
-          let(:config) { super.merge("ssl" => true, "ssl_verify_mode" => "force_peer") }
+          let(:config) { super().merge("ssl" => true, "ssl_verify_mode" => "force_peer") }
 
           it "raise a ConfigurationError when certificate_authorities is not set" do
             plugin = LogStash::Inputs::Beats.new(config)
@@ -154,7 +154,7 @@ describe LogStash::Inputs::Beats do
       let(:codec) { LogStash::Codecs::Multiline.new("pattern" => '^2015',
                                                     "what" => "previous",
                                                     "negate" => true) }
-      let(:config) { super.merge({ "codec" => codec }) }
+      let(:config) { super().merge({ "codec" => codec }) }
 
       it "raise a ConfigurationError when multiline codec is set" do
         plugin = LogStash::Inputs::Beats.new(config)

data/spec/integration/filebeat_spec.rb

@@ -86,7 +86,7 @@ describe "Filebeat", :integration => true do
     end
 
     context "without pipelining" do
-      let(:filebeat_config) { config = super; config["output"]["logstash"]["pipelining"] = 0; config }
+      let(:filebeat_config) { config = super(); config["output"]["logstash"]["pipelining"] = 0; config }
       include_examples "send events"
 
       context "with large batches" do
@@ -99,7 +99,7 @@ describe "Filebeat", :integration => true do
   context "TLS" do
     context "Server verification" do
       let(:filebeat_config) do
-        super.merge({
+        super().merge({
           "output" => {
             "logstash" => {
               "hosts" => ["#{host}:#{port}"],
@@ -111,7 +111,7 @@ describe "Filebeat", :integration => true do
       end
 
       let(:input_config) do
-        super.merge({
+        super().merge({
           "ssl" => true,
           "ssl_certificate" => certificate_file,
           "ssl_key" => certificate_key_file
@@ -129,7 +129,7 @@ describe "Filebeat", :integration => true do
 
         context "when specifying a cipher" do
           let(:filebeat_config) do
-            super.merge({
+            super().merge({
               "output" => {
                 "logstash" => {
                   "hosts" => ["#{host}:#{port}"],
@@ -145,7 +145,7 @@ describe "Filebeat", :integration => true do
           end
 
           let(:input_config) {
-            super.merge({
+            super().merge({
               "cipher_suites" => [logstash_cipher],
               "tls_min_version" => "1.2"
             })
@@ -194,7 +194,7 @@ describe "Filebeat", :integration => true do
             LogStash::Inputs::Beats.new(input_config)
           }
           let(:input_config) {
-            super.merge({
+            super().merge({
             "ssl_key_passphrase" => passphrase,
             "ssl_key" => certificate_key_file_pkcs8
           })}
@@ -229,7 +229,7 @@ describe "Filebeat", :integration => true do
 
       context "Client verification / Mutual validation" do
         let(:filebeat_config) do
-          super.merge({
+          super().merge({
             "output" => {
               "logstash" => {
                 "hosts" => ["#{host}:#{port}"],
@@ -245,7 +245,7 @@ describe "Filebeat", :integration => true do
         end
 
         let(:input_config) do
-          super.merge({
+          super().merge({
             "ssl" => true,
             "ssl_certificate_authorities" => certificate_authorities,
             "ssl_certificate" => server_certificate_file,
@@ -327,7 +327,7 @@ describe "Filebeat", :integration => true do
 
               context "client from secondary CA" do
                 let(:filebeat_config) do
-                  super.merge({
+                  super().merge({
                     "output" => {
                       "logstash" => {
                         "hosts" => ["#{host}:#{port}"],

data/spec/integration/logstash_forwarder_spec.rb

@@ -74,7 +74,7 @@ describe "Logstash-Forwarder", :integration => true do
   context "TLS" do
     context "Server Verification" do
       let(:input_config) do
-        super.merge({
+        super().merge({
           "ssl" => true,
           "ssl_certificate" => certificate_file,
           "ssl_key" => certificate_key_file,

data/spec/support/shared_examples.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-shared_examples "Common Event Transformation" do
+shared_examples "Common Event Transformation" do |ecs_compatibility, host_field_name|
   let(:tag) { "140-rpm-beats" }
   let(:config) do
     {
@@ -21,17 +21,23 @@ shared_examples "Common Event Transformation" do
     }
   end
 
+  def key_as_nested_maps(key, value)
+    evt = LogStash::Event.new
+    evt.set(key, value)
+    evt.to_hash_with_metadata
+  end
+
   it "adds configured tags to the event" do
     expect(subject.get("tags")).to include(tag)
   end
 
   context 'when add_hostname is true' do
-    let(:config) { super.merge({'add_hostname' => true})}
+    let(:config) { super().merge({'add_hostname' => true, 'ecs_compatibility' => ecs_compatibility})}
 
     context 'when a host is provided in beat.host.name' do
       let(:already_exist) { "already_exist" }
       let(:producer_host) { "newhost01" }
-      let(:event_map) { super.merge({ "beat" => { "host" => {"name" => producer_host }}}) }
+      let(:event_map) { super().merge({ "beat" => { "host" => {"name" => producer_host }}}) }
 
       context "when no `host` key already exists on the event" do
         it "does not set the host value" do
@@ -41,7 +47,7 @@ shared_examples "Common Event Transformation" do
 
       context "when `host` key exists on the event" do
         let(:already_exist) { "already_exist" }
-        let(:event_map) { super.merge({ "host" => already_exist }) }
+        let(:event_map) { super().merge({ "host" => already_exist }) }
 
         it "doesn't override it" do
           expect(subject.get("host")).to eq(already_exist)
@@ -51,99 +57,99 @@ shared_examples "Common Event Transformation" do
 
     context "when a host is set in `beat.hostname`" do
       let(:producer_host) { "newhost01" }
-      let(:event_map) { super.merge({ "beat" => { "hostname" => producer_host }}) }
+      let(:event_map) { super().merge({ "beat" => { "hostname" => producer_host }}) }
 
-      context "when no `host` key already exists on the event" do
-        it "copies the value in `beat.hostname` to `host`" do
-          expect(subject.get("host")).to eq(producer_host)
+      context "when no `#{host_field_name}` key already exists on the event" do
+        it "copies the value in `beat.hostname` to `#{host_field_name}`" do
+          expect(subject.get(host_field_name)).to eq(producer_host)
         end
       end
 
-      context "when `host` key exists on the event" do
+      context "when `#{host_field_name}` key exists on the event" do
         let(:already_exist) { "already_exist" }
-        let(:event_map) { super.merge({ "host" => already_exist }) }
+        let(:event_map) { super().merge(key_as_nested_maps(host_field_name, already_exist)) }
 
         it "doesn't override it" do
-          expect(subject.get("host")).to eq(already_exist)
+          expect(subject.get(host_field_name)).to eq(already_exist)
         end
       end
     end
 
     context "when no host is provided in beat" do
-      context "when no `host` key already exists on the event" do
+      context "when no `#{host_field_name}` key already exists on the event" do
         it "does not set the host" do
-          expect(subject.get("host")).to be_nil
+          expect(subject.get(host_field_name)).to be_nil
         end
       end
 
-      context "when `host` key already exists on the event" do
+      context "when `#{host_field_name}` key already exists on the event" do
         let(:already_exist) { "already_exist" }
-        let(:event_map) { super.merge({ "host" => already_exist }) }
+        let(:event_map) { super().merge(key_as_nested_maps(host_field_name, already_exist)) }
 
         it "doesn't override it" do
-          expect(subject.get("host")).to eq(already_exist)
+          expect(subject.get(host_field_name)).to eq(already_exist)
         end
       end
     end
   end
 
   context 'when add hostname is false' do
-    let(:config) { super.merge({'add_hostname' => false})}
+    let(:config) { super().merge({'add_hostname' => false})}
 
     context 'when a host is provided in beat.host.name' do
       let(:already_exist) { "already_exist" }
       let(:producer_host) { "newhost01" }
-      let(:event_map) { super.merge({ "beat" => { "host" => {"name" => producer_host }}}) }
+      let(:event_map) { super().merge({ "beat" => { "host" => {"name" => producer_host }}}) }
 
-      context "when no `host` key already exists on the event" do
+      context "when no `#{host_field_name}` key already exists on the event" do
         it "does not set the host" do
-          expect(subject.get("host")).to be_nil
+          expect(subject.get(host_field_name)).to be_nil
         end
       end
 
-      context "when `host` key already exists on the event" do
+      context "when `#{host_field_name}` key already exists on the event" do
         let(:already_exist) { "already_exist" }
-        let(:event_map) { super.merge({ "host" => already_exist }) }
+        let(:event_map) { super().merge(key_as_nested_maps(host_field_name, already_exist)) }
 
         it "doesn't override it" do
-          expect(subject.get("host")).to eq(already_exist)
+          expect(subject.get(host_field_name)).to eq(already_exist)
         end
       end
     end
 
     context "when a host is provided in `beat.hostname`" do
       let(:producer_host) { "newhost01" }
-      let(:event_map) { super.merge({ "beat" => { "hostname" => producer_host }}) }
+      let(:event_map) { super().merge({ "beat" => { "hostname" => producer_host }}) }
 
-      context "when no `host` key already exists on the event" do
+      context "when no `#{host_field_name}` key already exists on the event" do
         it "does not set the host" do
-          expect(subject.get("host")).to be_nil
+          expect(subject.get(host_field_name)).to be_nil
         end
       end
 
       context "when `host` key already exists on the event" do
         let(:already_exist) { "already_exist" }
-        let(:event_map) { super.merge({ "host" => already_exist }) }
+        let(:event_map) { super().merge(key_as_nested_maps(host_field_name, already_exist)) }
 
         it "doesn't override it" do
-          expect(subject.get("host")).to eq(already_exist)
+          expect(subject.get(host_field_name)).to eq(already_exist)
         end
       end
     end
 
     context "when no host is provided in beat" do
-      context "when no `host` key already exists on the event" do
+      context "when no `#{host_field_name}` key already exists on the event" do
         it "does not set the host" do
-          expect(subject.get("host")).to be_nil
+          expect(subject.get(host_field_name)).to be_nil
         end
       end
 
-      context "when `host` key already exists on the event" do
+      context "when `#{host_field_name}` key already exists on the event" do
         let(:already_exist) { "already_exist" }
-        let(:event_map) { super.merge({ "host" => already_exist }) }
+        let(:event_map) { super().merge(key_as_nested_maps(host_field_name, already_exist)) }
 
         it "doesn't override it" do
-          expect(subject.get("host")).to eq(already_exist)
+          expect(subject.get(host_field_name)).to eq(already_exist)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-beats
 version: !ruby/object:Gem::Version
-  version: 6.0.13
+  version: 6.1.3
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.4
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  name: logstash-mixin-ecs_compatibility_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -266,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/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.0.13/logstash-input-beats-6.0.13.jar
+- vendor/jar-dependencies/org/logstash/beats/logstash-input-beats/6.1.3/logstash-input-beats-6.1.3.jar
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)