logstash-input-irc 3.0.5 → 3.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a906d1aa29a29c2110cd2ebb3f3c071edf20c1b8
-  data.tar.gz: ee82f1d99d13842c5283d00fbd5b9225ab9f0105
+SHA256:
+  metadata.gz: c61c7494644d96e7f3e5501d46712ace4228ff2b2bcf5cfabf93098eca16c0b9
+  data.tar.gz: 40a95b5e27c74dcbcd7ff78f999818aa3a1396c03d9b873cb06b7cd352b3ee57
 SHA512:
-  metadata.gz: 754f1c068911131beb8a2b5b233e77508a8d578d0deeee6618211baf1909b060fade16bfdb4e66a497a0d9f4b9c7817bd70ad8f044bf6e0e6215683d47b09144
-  data.tar.gz: de9fa78c0dc8dabd76d0ac39a93f5a32dc635513aba3acca5d61c652eb664c425120ac06cc777d304cdeb998418dc716d33217c0070de1fd82d91eae752207c0
+  metadata.gz: 3537b0a6d751872c48fdd403d47855e764a7aa83602a81587dba50c8c03858c0c9862f0cbec759e7957990396bc42265c40b3ef617df2c440211283705c0a71e
+  data.tar.gz: b32a07533cbcd777f7f47e45444e6fcb780041871e9161b3fe6217e6845d8203133aed0e84a61c112454917b95a000a5eb14c32d656910775281455dd6d45d9c

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.0.6
+ - Fix bug where a connection to an idle IRC channel consumed 100% available CPU
+ - Fix issue where a message that did not contain a user's hostname could cause irc input to hang or crash
+ - Fix issue where IRC bots could be left running after a pipeline reload
+
 ## 3.0.5
   - Update gemspec summary
 

data/lib/logstash/inputs/irc.rb

@@ -4,6 +4,9 @@ require "logstash/namespace"
 require "thread"
 require "stud/task"
 require "stud/interval"
+
+require "java"
+
 # Read events from an IRC Server.
 #
 class LogStash::Inputs::Irc < LogStash::Inputs::Base
@@ -66,7 +69,7 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
   def register
     require "cinch"
     @user_stats = Hash.new
-    @irc_queue = Queue.new
+    @irc_queue = java.util.concurrent.LinkedBlockingQueue.new
     @catch_all = true if  @get_stats
     @logger.info("Connecting to irc server", :host => @host, :port => @port, :nick => @nick, :channels => @channels)
 
@@ -110,13 +113,11 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
       end
     end
     while !stop?
-      begin
-        msg = @irc_queue.pop(true)
-        handle_response(msg, output_queue)
-      rescue ThreadError
-        # Empty queue
-      end
+      msg = @irc_queue.poll(1, java.util.concurrent.TimeUnit::SECONDS)
+      handle_response(msg, output_queue) unless msg.nil?
     end
+  ensure
+    stop rescue logger.warn("irc input failed to shutdown gracefully: #{$!.message}")
   end # def run
 
   RPL_NAMREPLY = "353"
@@ -149,7 +150,11 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
           event.set("channel", msg.channel.to_s)
           event.set("nick", msg.user.nick)
           event.set("server", "#{@host}:#{@port}")
-          event.set("host", msg.user.host)
+          # The user's host attribute is an optional part of the message format;
+          # when it is not included, `Cinch::User#host` times out waiting for it
+          # to be populated, raising an exception; use `Cinch::User#data` to get
+          # host, which includes the user attributes as-parsed.
+          event.set("host", msg.user.data[:host])
           output_queue << event
         end
       end
@@ -167,7 +172,7 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
   end
 
   def stop
-    @request_names_thread.stop! if @request_names_thread
-    @bot_thread.stop!
+    @request_names_thread.stop! if @request_names_thread && !@request_names_thread.stop?
+    @bot_thread.stop! if @bot_thread && !@bot_thread.stop?
   end
 end # class LogStash::Inputs::Irc

data/logstash-input-irc.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-irc'
-  s.version         = '3.0.5'
+  s.version         = '3.0.6'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads events from an IRC server"
   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/inputs/irc_spec.rb

@@ -33,11 +33,13 @@ describe LogStash::Inputs::Irc do
     let(:msg)    { double("message") }
     let(:user)   { double("user") }
 
+    let(:user_data) { { host: "host", nick: "nick"} }
+
     before(:each) do
       allow(msg).to receive(:message).and_return("message")
       allow(msg).to receive(:command).and_return("command")
-      allow(user).to receive(:host).and_return("host")
-      allow(user).to receive(:nick).and_return("nick")
+      allow(user).to receive(:data).and_return(user_data)
+      allow(user).to receive(:nick).and_return(user_data[:nick])
       allow(msg).to receive(:user).and_return(user)
       allow(msg).to receive(:prefix).and_return("prefix")
       allow(msg).to receive(:channel).and_return("channel")
@@ -74,5 +76,18 @@ describe LogStash::Inputs::Irc do
     it "receive events with nick information" do
       expect(event.get("nick")).to eq("nick")
     end
+
+    it "receive events with host information" do
+      expect(event.get("host")).to eq("host")
+    end
+
+    context "when host is unavailable" do
+
+      let(:user_data) { super().merge(host: nil)}
+
+      it "handles unknown host well" do
+        expect(event.get("host")).to be_nil
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-irc
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.0.6
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2017-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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
+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
 email: info@elastic.co
 executables: []
 extensions: []
@@ -125,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Reads events from an IRC server