logstash-input-irc 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e59a0260be408291418aa4dcc980025e1f5ad81e
-  data.tar.gz: e53e0306323c1a7c708ec9fb85fbf4a9e63c2bbf
+  metadata.gz: bff489f521755ff86ab1a651e99a0f9fc5b6d237
+  data.tar.gz: 48b7b53e0afa268840c7be0fca06b59d702d4530
 SHA512:
-  metadata.gz: ec867a1053500599043e4e32051243dffdcabdf48cf1da2a6e579cafbce77b2e58a31b71e33e7f70aca265b37511daf2c6e886265c54853b5561a0f068b58a9c
-  data.tar.gz: 3bf22e9ccfe38dc322ea10cd59368d44aecc7435de7bc0e11cea12ef8deaf7c86a250edec7f9028cdb68276d353d3b18a600e2fa7f78484f647a437859a76a77
+  metadata.gz: c3c7f8fe563344601340753d69c8f61e06026c6e8563c65ce4b4ac42a6da659ef3db99804743a58acad34eb71cc3623ae2ac9a6314ad94a9bc1eb1d2337babbc
+  data.tar.gz: 6c9aa83d937645850b044fd06261beaf7a3e28b4e41b78fadcd03421f20fa30f547a6b77216c4493e7da37238f57a93db744efd44b2cd8ed70f7c683b7549cfe

data/lib/logstash/inputs/irc.rb

@@ -32,20 +32,31 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
   # IRC Server password
   config :password, :validate => :password
 
+  # Catch all IRC channel/user events not just channel messages
+  config :catch_all, :validate => :boolean, :default => false
+
+  # Gather and send user counts for channels - this requires catch_all and will force it
+  config :get_stats, :validate => :boolean, :default => false
+
+  # How often in minutes to get the user count stats
+  config :stats_interval, :validate => :number, :default => 5
+
   # Channels to join and read messages from.
   #
-  # These should be full channel names including the `#` symbol, such as
-  # `#logstash`.
+  # These should be full channel names including the '#' symbol, such as
+  # "#logstash".
   #
   # For passworded channels, add a space and the channel password, such as
-  # `#logstash password`.
+  # "#logstash password".
   #
   config :channels, :validate => :array, :required => true
 
   public
   def register
     require "cinch"
+    @user_stats = Hash.new
     @irc_queue = Queue.new
+    @catch_all = true if  @get_stats
     @logger.info("Connecting to irc server", :host => @host, :port => @port, :nick => @nick, :channels => @channels)
 
     @bot = Cinch::Bot.new
@@ -61,27 +72,86 @@ class LogStash::Inputs::Irc < LogStash::Inputs::Base
       c.ssl.use = @secure
     end
     queue = @irc_queue
-    @bot.on :channel  do |m|
-      queue << m
+    if @catch_all
+        @bot.on :catchall  do |m|
+          queue << m
+        end
+    else
+        @bot.on :channel  do |m|
+          queue << m
+        end
     end
+
   end # def register
 
   public
   def run(output_queue)
-    Thread.new(@bot) do |bot|
-      bot.start
+    @bot_thread = Stud::Task.new(@bot) do |bot|
+        bot.start
+    end
+    if @get_stats
+      @request_names_thread = Stud::Task.new do
+        loop do
+          sleep (@stats_interval * 60)
+          request_names
+        end
+      end
     end
     loop do
       msg = @irc_queue.pop
-      if msg.user
+      handle_response(msg, output_queue)
+    end
+  end # def run
+
+  RPL_NAMREPLY = "353"
+  RPL_ENDOFNAMES = "366"
+
+  def handle_response (msg, output_queue)
+      # Set some constant variables based on https://www.alien.net.au/irc/irc2numerics.html
+
+      if @get_stats and msg.command.to_s == RPL_NAMREPLY
+        # Got a names list event
+        # Count the users returned in msg.params[3] split by " "
+        users = msg.params[3].split(" ")
+        @user_stats[msg.channel.to_s] = (@user_stats[msg.channel.to_s] || 0)  + users.length
+      end
+      if @get_stats and msg.command.to_s == RPL_ENDOFNAMES
+        # Got an end of names event, now we can send the info down the pipe.
+        event = LogStash::Event.new()
+        decorate(event)
+        event["channel"] = msg.channel.to_s
+        event["users"] = @user_stats[msg.channel.to_s]
+        event["server"] = "#{@host}:#{@port}"
+        output_queue << event
+      end
+      if msg.command and msg.user
+        @logger.debug("IRC Message", :data => msg)
         @codec.decode(msg.message) do |event|
           decorate(event)
+          event["user"] = msg.prefix.to_s
+          event["command"] = msg.command.to_s
           event["channel"] = msg.channel.to_s
           event["nick"] = msg.user.nick
           event["server"] = "#{@host}:#{@port}"
+          event["host"] = msg.user.host
           output_queue << event
         end
       end
+  end
+
+  def request_names
+    # Go though list of channels, and request a NAMES for them
+    # Note : Logstash channel list can have passwords ie : "channel password"
+    # Need to account for that
+    @channels.each do |channel|
+        channel = channel.split(' ').first if channel.include?(' ')
+        @user_stats[channel] = 0
+        @bot.irc.send("NAMES #{channel}")
     end
-  end # def run
+  end
+
+  def teardown
+    @request_names_thread#stop!
+    @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         = '0.1.4'
+  s.version         = '0.1.5'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read 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/plugin install gemname. This gem is not a stand-alone program"

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-irc
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -19,10 +20,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,48 +28,50 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-plain
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: cinch
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: cinch
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-devutils
   prerelease: false
   type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !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/plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []