logstash-input-beats 5.1.3-java → 5.1.4-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0fcf631f64e0aa00c02946e8e6a49eddcee3377ec7c7358df64d79e22afc202
-  data.tar.gz: 97c7b62266a712ff1e3ce714321d1316f17e22924cc5de2c719c8b3ea2fe6530
+  metadata.gz: dd86798555d6cc46b4dcbdb365f9b7dbed5d7299b73738be880e339e6f6fcb2b
+  data.tar.gz: '0839c7ac1f1ef8a5526d8874b8d78aa240009a7fc5a7bced2e7a5c0b87e9accd'
 SHA512:
-  metadata.gz: 1b9936a104ff6cbccc9eea6b8eefcca5d8866fad4ddb5fefcf8c98ce4f2cd09d088bf9fc60e70e5f9c3b4965a4356bda82d610a4fa7e33fe67136362acde8884
-  data.tar.gz: 4cb4bd9dc769ad74108acb0625c1e5212743cbcae145a8217a8eec221fac6d6743b5d3f20c6073f9acf223223189d5d207320e85c98d581ed9e0da4b2af449b2
+  metadata.gz: 391b7b0bec241f963f3ea81495bdb57f8ec623c874f82e8668cdecdefbb86c3cef4a255a4bfbb7a081585d4441842063e90f574c35f455a5ab1fbcbc5e987be6
+  data.tar.gz: 046ca1c1e1a8bf71abc07166bca6d00659bb9c5ce0a416862b708ad9ac0696f765edcb2b74840cad2da5c94f23f08de075465f11abec1b741b8fcf265b084a4b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 5.1.4
+ - Added `add_hostname` flag to enable/disable the population of the `host` field from the beats.hostname field [#340](https://github.com/logstash-plugins/logstash-input-beats/pull/340)
+
 ## 5.1.3
  - Fixed handling of batches where the sequence numbers do not start with 1 [#342](https://github.com/logstash-plugins/logstash-input-beats/pull/342)
 

data/VERSION

@@ -1 +1 @@
-5.1.3
+5.1.4

data/docs/index.asciidoc

@@ -90,6 +90,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 [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}-host>> |<<string,string>>|No
@@ -112,6 +113,18 @@ input plugins.
 
 &nbsp;
 
+[id="plugins-{type}s-{plugin}-add_hostname"]
+===== `add_hostname`
+
+  added[5.1.4, Field was added to allow users to control whether or not the `host` field is automatically added to events.]
+  deprecated[5.1.4, In future versions of this plugin, this setting will be removed, and the 'hosts' field will not be added to events.]
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+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`
 

data/lib/logstash-input-beats_jars.rb

@@ -9,4 +9,4 @@ require_jar('com.fasterxml.jackson.core', 'jackson-annotations', '2.9.5')
 require_jar('com.fasterxml.jackson.core', 'jackson-databind', '2.9.5')
 require_jar('com.fasterxml.jackson.module', 'jackson-module-afterburner', '2.9.5')
 require_jar('org.apache.logging.log4j', 'log4j-api', '2.6.2')
-require_jar('org.logstash.beats', 'logstash-input-beats', '5.1.3')
+require_jar('org.logstash.beats', 'logstash-input-beats', '5.1.4')

data/lib/logstash/inputs/beats.rb

@@ -82,6 +82,10 @@ class LogStash::Inputs::Beats < LogStash::Inputs::Base
   # 
   config :ssl_certificate_authorities, :validate => :array, :default => []
 
+  # Flag to determine whether to add host information (provided by the beat in the 'hostname' field) to the event
+  config :add_hostname, :validate => :boolean, :default => true, :deprecated => 'Host field will not be automatically populated by future version of the Beats input'
+
+
   # By default the server doesn't do any client verification.
   # 
   # `peer` will make the server ask the client to provide a certificate. 

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

@@ -12,6 +12,7 @@ module LogStash module Inputs class Beats
     # Copies the beat.hostname field into the host field unless
     # the host field is already defined
     def copy_beat_hostname(event)
+      return unless @input.add_hostname
       host = event.get("[beat][hostname]")
 
       if host && event.get("host").nil?

data/spec/support/shared_examples.rb

@@ -25,31 +25,126 @@ shared_examples "Common Event Transformation" do
     expect(subject.get("tags")).to include(tag)
   end
 
-  context "when the `beats.hostname` doesnt exist on the event" do
-    let(:already_exist) { "already_exist" }
-    let(:event_map) { super.merge({ "host" => already_exist }) }
+  context 'when add_hostname is true' do
+    let(:config) { super.merge({'add_hostname' => true})}
 
-    it "doesnt change the value" do
-      expect(subject.get("host")).to eq(already_exist)
+    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 }}}) }
+
+      context "when no `host` key already exists on the event" do
+        it "does not set the host value" do
+          expect(subject.get("host")).to be_nil
+        end
+      end
+
+      context "when `host` key exists on the event" do
+        let(:already_exist) { "already_exist" }
+        let(:event_map) { super.merge({ "host" => already_exist }) }
+
+        it "doesn't override it" do
+          expect(subject.get("host")).to eq(already_exist)
+        end
+      end
     end
-  end
 
-  context "when the `beat.hostname` exist in the event" do
-    let(:producer_host) { "newhost01" }
-    let(:event_map) { super.merge({ "beat" => { "hostname" => producer_host }}) }
+    context "when a host is set in `beat.hostname`" do
+      let(:producer_host) { "newhost01" }
+      let(:event_map) { super.merge({ "beat" => { "hostname" => producer_host }}) }
 
-    context "when `host` key doesn't exist on the event" do
-      it "copy the `beat.hostname` to `host` or backward compatibility" do
-        expect(subject.get("host")).to eq(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)
+        end
+      end
+
+      context "when `host` key exists on the event" do
+        let(:already_exist) { "already_exist" }
+        let(:event_map) { super.merge({ "host" => already_exist }) }
+
+        it "doesn't override it" do
+          expect(subject.get("host")).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
+        it "does not set the host" do
+          expect(subject.get("host")).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 }) }
+
+        it "doesn't override it" do
+          expect(subject.get("host")).to eq(already_exist)
+        end
       end
     end
+  end
 
-    context "when `host` key exists on the event" do
+  context 'when add hostname is false' do
+    let(:config) { super.merge({'add_hostname' => false})}
+
+    context 'when a host is provided in beat.host.name' do
       let(:already_exist) { "already_exist" }
-      let(:event_map) { super.merge({ "host" => already_exist }) }
+      let(:producer_host) { "newhost01" }
+      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" do
+          expect(subject.get("host")).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 }) }
+
+        it "doesn't override it" do
+          expect(subject.get("host")).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 }}) }
+
+      context "when no `host` key already exists on the event" do
+        it "does not set the host" do
+          expect(subject.get("host")).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 }) }
+
+        it "doesn't override it" do
+          expect(subject.get("host")).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
+        it "does not set the host" do
+          expect(subject.get("host")).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 }) }
 
-      it "doesn't override it" do
-        expect(subject.get("host")).to eq(already_exist)
+        it "doesn't override it" do
+          expect(subject.get("host")).to eq(already_exist)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-beats
 version: !ruby/object:Gem::Version
-  version: 5.1.3
+  version: 5.1.4
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-20 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -266,7 +266,7 @@ files:
 - vendor/jar-dependencies/io/netty/netty-tcnative-boringssl-static/2.0.7.Final/netty-tcnative-boringssl-static-2.0.7.Final.jar
 - vendor/jar-dependencies/org/apache/logging/log4j/log4j-api/2.6.2/log4j-api-2.6.2.jar
 - vendor/jar-dependencies/org/javassist/javassist/3.20.0-GA/javassist-3.20.0-GA.jar
-- vendor/jar-dependencies/org/logstash/beats/logstash-input-beats/5.1.3/logstash-input-beats-5.1.3.jar
+- vendor/jar-dependencies/org/logstash/beats/logstash-input-beats/5.1.4/logstash-input-beats-5.1.4.jar
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)