logstash-input-syslog 3.4.3 → 3.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc9057a2c876b1bdb746a10c07fcc32b66d265aeb5658e1116fb0435bd29ea76
-  data.tar.gz: f33e03b2bb5cdad71d2152c6d563db6c2a1d7175e7cb24d6f5b872d707dbfc42
+  metadata.gz: 50ec0d9128316dbe4a546b2a2437e2b412dc96fce564ace036dd5b0a724ccd71
+  data.tar.gz: 200037f6000b598cf2abb5e13804343c455cf3c8af4239b12ae94bb570b93e90
 SHA512:
-  metadata.gz: 877bd6b44875b1b4318e08073d53caef55c90dbe636ab49a0e7c4e2af5d3c6f8a12527250e0988442aa12e884eee8902db89803cd0a517aa0506bb1127de4ea1
-  data.tar.gz: 477cd68ad7aedb6125205b4c88d0ec2bdae3e5e58d82bc91c21317eef919f1047b7c9d4bbc2ccc7e381c447d1af2adda0ed8d69585544fd95d0a65884af91abb
+  metadata.gz: 799c2ca8d23eeb77d7c532fc5692db5c4a1e3c5a3e40c871b55892e3b9b332d2156dc1c205f67674eb2a196ad02a334fc19b6b05fc52ff18d0f36dfd209c6121
+  data.tar.gz: e802df38eed4687cf96da91b3bb0b1817cf30f7bef86583f532d35033c37702ffdf3b66f95e78cbf7ea408853caa154d69efa496391e4fc9ddaf18a05a8d489e

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.4.4
+  - Refactor: avoid global side-effect + cleanup [#62](https://github.com/logstash-plugins/logstash-input-syslog/pull/62)
+    * avoid setting `BasicSocket.do_not_reverse_lookup` as it has side effects for others 
+
 ## 3.4.3
   - [DOC] Added expanded descriptions and requirements for facility_labels and severity_labels. [#52](https://github.com/logstash-plugins/logstash-input-syslog/pull/52)
 

data/lib/logstash/inputs/syslog.rb

@@ -59,8 +59,7 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
 
   # Specify a time zone canonical ID to be used for date parsing.
   # The valid IDs are listed on the [Joda.org available time zones page](http://joda-time.sourceforge.net/timezones.html).
-  # This is useful in case the time zone cannot be extracted from the value,
-  # and is not the platform default.
+  # This is useful in case the time zone cannot be extracted from the value, and is not the platform default.
   # If this is not specified the platform default will be used.
   # Canonical ID is good as it takes care of daylight saving time for you
   # For example, `America/Los_Angeles` or `Europe/France` are valid IDs.
@@ -75,12 +74,6 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
   #
   config :locale, :validate => :string
 
-  public
-  def initialize(params)
-    super
-    BasicSocket.do_not_reverse_lookup = true
-  end # def initialize
-
   public
   def register
     @metric_errors = metric.namespace(:errors)
@@ -146,6 +139,7 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
 
     @udp.close if @udp
     @udp = UDPSocket.new(Socket::AF_INET)
+    @udp.do_not_reverse_lookup = true
     @udp.bind(@host, @port)
 
     while !stop?
@@ -165,6 +159,7 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
   def tcp_listener(output_queue)
     @logger.info("Starting syslog tcp listener", :address => "#{@host}:#{@port}")
     @tcp = TCPServer.new(@host, @port)
+    @tcp.do_not_reverse_lookup = true
 
     while !stop?
       socket = @tcp.accept
@@ -217,7 +212,7 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
     logger.info("connection error: #{ioerror.message}")
   ensure
     @tcp_sockets.delete(socket)
-    socket.close rescue log_and_squash
+    socket.close rescue log_and_squash(:close_tcp_receiver_socket)
   end
 
   private
@@ -231,7 +226,7 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
     end
   rescue => e
     # swallow and log all decoding exceptions, these will never be socket related
-    @logger.error("Error decoding data", :data => data.inspect, :exception => e, :backtrace => e.backtrace)
+    @logger.error("Error decoding data", :data => data.inspect, :exception => e.class, :message => e.message, :backtrace => e.backtrace)
     @metric_errors.increment(:decoding)
   end
 
@@ -244,16 +239,15 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
   private
   def close_udp
     if @udp
-      @udp.close_read rescue log_and_squash
-      @udp.close_write rescue log_and_squash
+      @udp.close_read rescue log_and_squash(:close_udp_read)
+      @udp.close_write rescue log_and_squash(:close_udp_write)
     end
     @udp = nil
   end
 
   private
 
-  # Helper for inline rescues, which logs the squashed exception at "TRACE" level
-  # and returns nil.
+  # Helper for inline rescues, which logs the exception at "DEBUG" level and returns nil.
   #
   # Instead of:
   # ~~~ ruby
@@ -261,19 +255,19 @@ class LogStash::Inputs::Syslog < LogStash::Inputs::Base
   # ~~~
   # Do:
   # ~~~ ruby
-  #.  foo rescue log_and_squash
+  #.  foo rescue log_and_squash(:foo)
   # ~~~
-  def log_and_squash
-    $! && logger.trace("SQUASHED EXCEPTION: `#{$!.message}` at (`#{caller.first}`)")
+  def log_and_squash(label)
+    $! && logger.debug("#{label} failed:", :exception => $!.class, :message => $!.message)
     nil
   end
 
   def close_tcp
     # If we somehow have this left open, close it.
     @tcp_sockets.each do |socket|
-      socket.close rescue log_and_squash
+      socket.close rescue log_and_squash(:close_tcp_socket)
     end
-    @tcp.close if @tcp rescue log_and_squash
+    @tcp.close if @tcp rescue log_and_squash(:close_tcp)
     @tcp = nil
   end
 

data/logstash-input-syslog.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-syslog'
-  s.version         = '3.4.3'
+  s.version         = '3.4.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads syslog messages as events"
   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"
@@ -30,7 +30,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'logstash-filter-date'
 
   s.add_development_dependency 'logstash-devutils'
-  s.add_development_dependency 'insist'
   s.add_development_dependency 'logstash-codec-cef'
 end
 

data/spec/inputs/syslog_spec.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
-require "insist"
 require "logstash/devutils/rspec/shared_examples"
 
 # running the grok code outside a logstash package means
@@ -55,11 +54,11 @@ describe LogStash::Inputs::Syslog do
       event_count.times.collect { queue.pop }
     end
 
-    insist { events.length } == event_count
+    expect( events.length ).to eql event_count
     events.each do |event|
-      insist { event.get("priority") } == 164
-      insist { event.get("severity") } == 4
-      insist { event.get("facility") } == 20
+      expect( event.get("priority") ).to eql 164
+      expect( event.get("severity") ).to eql 4
+      expect( event.get("facility") ).to eql 20
     end
   end
 
@@ -89,12 +88,12 @@ describe LogStash::Inputs::Syslog do
       event_count.times.collect { queue.pop }
     end
 
-    insist { events.length } == event_count
+    expect( events.length ).to eql event_count
     events.each do |event|
-      insist { event.get("priority") } == 164
-      insist { event.get("severity") } == 4
-      insist { event.get("facility") } == 20
-      insist { event.get("host") } == "1.2.3.4"
+      expect( event.get("priority") ).to eql 164
+      expect( event.get("severity") ).to eql 4
+      expect( event.get("facility") ).to eql 20
+      expect( event.get("host") ).to eql "1.2.3.4"
     end
   end
 
@@ -121,9 +120,9 @@ describe LogStash::Inputs::Syslog do
       event_count.times.collect { queue.pop }
     end
 
-    insist { events.length } == event_count
+    expect( events.length ).to eql event_count
     event_count.times do |i|
-      insist { events[i].get("tags") } == ["_grokparsefailure_sysloginput"]
+      expect( events[i].get("tags") ).to eql ["_grokparsefailure_sysloginput"]
     end
   end
 
@@ -152,9 +151,9 @@ describe LogStash::Inputs::Syslog do
       event_count.times.collect { queue.pop }
     end
 
-    insist { events.length } == event_count
+    expect( events.length ).to eql event_count
     events.each do |event|
-      insist { event.get("@timestamp").to_iso8601 } == "#{Time.now.year}-10-26T15:19:25.000Z"
+      expect( event.get("@timestamp").to_iso8601 ).to eql "#{Time.now.year}-10-26T15:19:25.000Z"
     end
   end
 
@@ -179,7 +178,7 @@ describe LogStash::Inputs::Syslog do
     end
 
     # chances platform timezone is not UTC so ignore the hours
-    insist { event.get("@timestamp").to_iso8601 } =~ /#{Time.now.year}-10-26T\d\d:19:25.000Z/
+    expect( event.get("@timestamp").to_iso8601 ).to match /#{Time.now.year}-10-26T\d\d:19:25.000Z/
   end
 
   it "should support non UTC timezone" do
@@ -190,7 +189,7 @@ describe LogStash::Inputs::Syslog do
 
     syslog_event = LogStash::Event.new({ "message" => "<164>Oct 26 15:19:25 1.2.3.4 %ASA-4-106023: Deny udp src DRAC:10.1.2.3/43434" })
     input.syslog_relay(syslog_event)
-    insist { syslog_event.get("@timestamp").to_iso8601 } == "#{Time.now.year}-10-26T20:19:25.000Z"
+    expect( syslog_event.get("@timestamp").to_iso8601 ).to eql "#{Time.now.year}-10-26T20:19:25.000Z"
 
     input.close
   end
@@ -202,13 +201,13 @@ describe LogStash::Inputs::Syslog do
     # event which is not syslog should have a new tag
     event = LogStash::Event.new({ "message" => "hello world, this is not syslog RFC3164" })
     input.syslog_relay(event)
-    insist { event.get("tags") } ==  ["_grokparsefailure_sysloginput"]
+    expect( event.get("tags") ).to eql  ["_grokparsefailure_sysloginput"]
 
     syslog_event = LogStash::Event.new({ "message" => "<164>Oct 26 15:19:25 1.2.3.4 %ASA-4-106023: Deny udp src DRAC:10.1.2.3/43434" })
     input.syslog_relay(syslog_event)
-    insist { syslog_event.get("priority") } ==  164
-    insist { syslog_event.get("severity") } ==  4
-    insist { syslog_event.get("tags") } ==  nil
+    expect( syslog_event.get("priority") ).to eql 164
+    expect( syslog_event.get("severity") ).to eql 4
+    expect( syslog_event.get("tags") ).to be nil
 
     input.close
   end
@@ -245,13 +244,13 @@ describe LogStash::Inputs::Syslog do
       event_count.times.collect { queue.pop }
     end
 
-    insist { events.length } == event_count
+    expect( events.length ).to eql event_count
     events.each do |event|
-      insist { event.get("priority")  } == 164
-      insist { event.get("severity")  } == 4
-      insist { event.get("facility")  } == 20
-      insist { event.get("message")   } == "#{message_field}\n"
-      insist { event.get("timestamp") } == timestamp
+      expect( event.get("priority") ).to eql 164
+      expect( event.get("severity") ).to eql 4
+      expect( event.get("facility") ).to eql 20
+      expect( event.get("message") ).to eql "#{message_field}\n"
+      expect( event.get("timestamp") ).to eql timestamp
     end
   end
 
@@ -284,13 +283,13 @@ describe LogStash::Inputs::Syslog do
       event_count.times.collect { queue.pop }
     end
 
-    insist { events.length } == event_count
+    expect( events.length ).to eql event_count
     events.each do |event|
-      insist { event.get("priority")  } == 134
-      insist { event.get("severity")  } == 6
-      insist { event.get("facility")  } == 16
-      insist { event.get("message")   } == message_field
-      insist { event.get("timestamp") } == timestamp
+      expect( event.get("priority") ).to eql 134
+      expect( event.get("severity") ).to eql 6
+      expect( event.get("facility") ).to eql 16
+      expect( event.get("message") ).to eql message_field
+      expect( event.get("timestamp") ).to eql timestamp
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-syslog
 version: !ruby/object:Gem::Version
-  version: 3.4.3
+  version: 3.4.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -120,20 +120,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  name: insist
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements: