logstash-filter-dns 3.1.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bfbc599a24bf91ca96cb549cbee80394e3660b968178c94739437b96b2639b4
-  data.tar.gz: 18f7cde848f00e8164cabd416e4fb1f2f0f6ee699bae018ae4c1f327e781adb1
+  metadata.gz: 53553697483fd03bdf2c112a17de6797e1433cfe9788c85a4503a748c0e4df3d
+  data.tar.gz: 8e4f0800c03f7d3d3894ea7d5aa9d7f74ea1f2caf1ac95fc828163fdd8676026
 SHA512:
-  metadata.gz: 4b899b43f760b97f33f88637591cd4367edc9c919c2d55db9d7726e783ba424396a2641a1f54c3cba1eb1562d54eb0d413456e70f21cf83c5585bb766eb3f104
-  data.tar.gz: a94cd76f11a1f4f85e4981f8b3b8d6d8cd9de2f625a1a87c22544876254f899c0099915eb39f1cea38b5c2075663826768c9ee663c30fe135d6b05def2508b63
+  metadata.gz: 3e706cb9f6424adba08d42ea7e686b4020f467557ffbcdc9420e211b10c0adeb6d4ea0db23d189bf81529916b86f326e94c149a69282f0340cc44f6df9ffbc6c
+  data.tar.gz: 92e0a9fec287c122d1ba68a3f15164988420e1174e89d1278e8d12c9bc9ddcdbc9016ef64fa76372ab8b2ee0f7e2db15601c00c5ac9dbfd14f5f93ae30533ffd

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+## 3.2.0
+  - Support adding tag(s) on DNS lookup times out, defaults to `["_dnstimeout"]` [#67](https://github.com/logstash-plugins/logstash-filter-dns/pull/67)
+  - As timeouts can be received through tags now, DNS lookup timeouts are logged in debug logs only. [#67](https://github.com/logstash-plugins/logstash-filter-dns/pull/67)
+
 ## 3.1.5
-  - Fixed an issue where a non-string value existing in the resolve/reverse field could cause the plugin to crash
+  - Fixed an issue where a non-string value existing in the resolve/reverse field could cause the plugin to crash [#65](https://github.com/logstash-plugins/logstash-filter-dns/pull/65)
 
 ## 3.1.4
   - Replaced Timeout::timeout block with `Resolv::DNS::timeouts=` [#62](https://github.com/logstash-plugins/logstash-filter-dns/pull/62)

data/docs/index.asciidoc

@@ -58,6 +58,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-nameserver>> |<<hash,hash>>|No
 | <<plugins-{type}s-{plugin}-resolve>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-reverse>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-tag_on_timeout>> |<<array,array>>|No
 | <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
 |=======================================================================
 
@@ -173,6 +174,13 @@ Reverse resolve one or more fields.
 
 `resolv` calls will be wrapped in a timeout instance
 
+[id="plugins-{type}s-{plugin}-tag_on_timeout"]
+===== `tag_on_timeout`
+
+* Value type is <<array,array>>
+* Defaults to `["_dnstimeout"]`.
+
+Add tag(s) on DNS lookup time out.
 
 
 [id="plugins-{type}s-{plugin}-common-options"]

data/lib/logstash/filters/dns.rb

@@ -86,6 +86,9 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
   # Use custom hosts file(s). For example: `["/var/db/my_custom_hosts"]`
   config :hostsfile, :validate => :array
 
+  # Tag(s) to apply if a DNS lookup times out. Defaults to `["_dnstimeout"]`.
+  config :tag_on_timeout, :validate => :string, :list => true, :default => ["_dnstimeout"]
+
   attr_reader :hit_cache
   attr_reader :failed_cache
 
@@ -219,8 +222,9 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
         end
       rescue Resolv::ResolvTimeout
         @failed_cache[raw] = true if @failed_cache
-        @logger.warn("DNS: timeout on resolving the hostname.",
+        @logger.debug("DNS: timeout on resolving the hostname.",
                       :field => field, :value => raw)
+        @tag_on_timeout.each { |tag| event.tag(tag) }
         return
       rescue SocketError => e
         @logger.error("DNS: Encountered SocketError.",
@@ -305,8 +309,9 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
         end
       rescue Resolv::ResolvTimeout
         @failed_cache[raw] = true if @failed_cache
-        @logger.warn("DNS: timeout on resolving address.",
+        @logger.debug("DNS: timeout on resolving address.",
                       :field => field, :value => raw)
+        @tag_on_timeout.each { |tag| event.tag(tag) }
         return
       rescue SocketError => e
         @logger.error("DNS: Encountered SocketError.",
@@ -345,7 +350,7 @@ class LogStash::Filters::DNS < LogStash::Filters::Base
     tries = 0
     begin
       block.call
-    rescue Resolv::ResolvTimeout,  SocketError
+    rescue Resolv::ResolvTimeout, SocketError
       if tries < @max_retries
         tries = tries + 1
         retry

data/logstash-filter-dns.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-dns'
-  s.version         = '3.1.5'
+  s.version         = '3.2.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Performs a standard or reverse DNS lookup"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/filters/dns_spec.rb

@@ -7,6 +7,7 @@ require "logstash/filters/dns/resolv_patch"
 
 
 describe LogStash::Filters::DNS do
+
   describe "with stubbed Resolv" do
     before(:each) do
       # We use `Resolv#each_address` and `Resolv#each_name`, which have
@@ -621,4 +622,115 @@ describe LogStash::Filters::DNS do
       end
     end
   end
+
+  describe "dns forward timeout" do
+
+    let(:subject) { LogStash::Filters::DNS.new(config) }
+
+    before(:each) do
+      allow(subject).to receive(:getaddress).and_raise(Resolv::ResolvTimeout)
+      subject.register
+      subject.filter(event)
+    end
+
+    context "when using the default tag" do
+      let(:config) { { "resolve" => ["message"] } }
+      let(:event) { LogStash::Event.new("message" => "carrera.databits.net") }
+
+      it "should add the default DNS timeout tag" do
+        expect(event.get("tags")).to eq(["_dnstimeout"])
+      end
+    end
+
+    context "when using a custom tag" do
+      let(:config) { { "resolve" => ["message"], "tag_on_timeout" => ["dns_custom_timeout"] } }
+      let(:event) { LogStash::Event.new("message" => "carrera.databits.net") }
+
+      it "should add the custom DNS timeout tag" do
+        expect(event.get("tags")).to eq(["dns_custom_timeout"])
+      end
+    end
+
+    context "when using no tags" do
+      let(:config) { { "resolve" => ["message"], "tag_on_timeout" => [] } }
+      let(:event) { LogStash::Event.new("message" => "carrera.databits.net") }
+
+      it "should not add any failure tags" do
+        expect(event.get("tags")).to eq(nil)
+      end
+    end
+
+    context "when logging" do
+
+      context "with debug" do
+        let(:config) { { "resolve" => ["message"] } }
+        let(:event) { LogStash::Event.new("message" => "127.0.0.1") }
+
+        before do
+          allow(subject.logger).to receive(:debug).with(any_args)
+        end
+
+        it "logs on timeout exception" do
+          subject.filter(event)
+          expect(subject.logger).to have_received(:debug).with("DNS: timeout on resolving the hostname.", :field => "message", :value => "127.0.0.1")
+        end
+      end
+    end
+  end
+
+  describe "dns reverse timeout" do
+
+    let(:subject) { LogStash::Filters::DNS.new(config) }
+
+    before(:each) do
+      allow(subject).to receive(:getname).and_raise(Resolv::ResolvTimeout)
+      subject.register
+      subject.filter(event)
+    end
+
+    context "when using the default tag" do
+      let(:config) { { "reverse" => ["message"] } }
+      let(:event) { LogStash::Event.new("message" => "127.0.0.1") }
+
+      it "should add the default DNS timeout tag" do
+        expect(event.get("tags")).to eq(["_dnstimeout"])
+      end
+    end
+
+    context "when using a custom tag" do
+      let(:config) { { "reverse" => ["message"], "tag_on_timeout" => ["dns_custom_timeout"] } }
+      let(:event) { LogStash::Event.new("message" => "127.0.0.1") }
+
+      it "should add the custom DNS timeout tag" do
+        expect(event.get("tags")).to eq(["dns_custom_timeout"])
+      end
+    end
+
+    context "when using no tags" do
+      let(:config) { { "reverse" => ["message"], "tag_on_timeout" => [] } }
+      let(:event) { LogStash::Event.new("message" => "127.0.0.1") }
+
+      it "should not add any failure tags" do
+        expect(event.get("tags")).to eq(nil)
+      end
+    end
+
+    context "when logging" do
+
+      context "with debug" do
+        let(:config) { { "reverse" => ["message"] } }
+        let(:event) { LogStash::Event.new("message" => "127.0.0.1") }
+
+        before do
+          allow(subject.logger).to receive(:debug).with(any_args)
+        end
+
+        it "logs timeout exception" do
+          subject.filter(event)
+          expect(subject.logger).to have_received(:debug).with("DNS: timeout on resolving address.", :field => "message", :value => "127.0.0.1")
+        end
+      end
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-dns
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 3.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement