logstash-input-udp 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0019df7ba57bb256f1575bc24e8165993afd26d
-  data.tar.gz: 9423e0737d5072150a205c1ea864ff9702eb4912
+  metadata.gz: ffc5e1f54afba7b7af046de112d9cdd081b2d8c8
+  data.tar.gz: 839bf1df40502b1f3fd88c0fef67834556a0bf55
 SHA512:
-  metadata.gz: 07626f7e822fd5ced68c7f822cb7096671daceda2c7ad5b474f608b57a9a20a917f76e8755775c2c608a0135a4c2684b515c2a1a7eec22db76533aab54d1adb6
-  data.tar.gz: fc10ab5d8258f0248b8a9463cd5a8f5102e2b26e53aa9b8cfdee4058314c4a2001dd96913f336ed690ffa9a545dfa9054ad2fe855395a5ab433f4bcc892f4e3b
+  metadata.gz: fd988a87f3edd6c2fa305ee67f56acbfc70557e52fb25a725ccdac09a1c5895da2ec5083d6f0bdf6dcb695fc7065bcff3ce268beaf85e4c562ab24d7b3736823
+  data.tar.gz: 02afb631b7faea97d073f5a023557ec4e321d5269a6afcc1a1f56dc039229aee86b0304710420086586e0ee1d5c2e27080462675fdaf3078377f1a1495afafd4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/README.md

@@ -1,15 +1,15 @@
 # Logstash Plugin
 
-This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
 It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
 
 ## Documentation
 
-Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
 
 - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
-- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
 
 ## Need Help?
 
@@ -83,4 +83,4 @@ Programming is not a required skill. Whatever you've seen about open source and
 
 It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/udp.rb

@@ -3,6 +3,7 @@ require "date"
 require "logstash/inputs/base"
 require "logstash/namespace"
 require "socket"
+require "stud/interval"
 
 # Read messages as events over the network via udp. The only required
 # configuration item is `port`, which specifies the udp port logstash
@@ -47,12 +48,10 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
     begin
       # udp server
       udp_listener(output_queue)
-    rescue LogStash::ShutdownSignal
-      # do nothing, shutdown was requested.
     rescue => e
       @logger.warn("UDP listener died", :exception => e, :backtrace => e.backtrace)
-      sleep(5)
-      retry
+      Stud.stoppable_sleep(5) { stop? }
+      retry unless stop?
     end # begin
   end # def run
 
@@ -74,9 +73,11 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
       Thread.new { inputworker(i) }
     end
 
-    while true
+    while !stop?
+      next if IO.select([@udp], [], [], 0.5).nil?
       #collect datagram message and add to queue
-      payload, client = @udp.recvfrom(@buffer_size)
+      payload, client = @udp.recvfrom_nonblock(@buffer_size)
+      next if payload.empty?
       @input_to_worker.push([payload, client])
     end
   ensure
@@ -104,8 +105,13 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
   end # def inputworker
 
   public
-  def teardown
-    @udp.close if @udp && !@udp.closed?
+  def close
+    @udp.close rescue nil
+  end
+
+  public
+  def stop
+    @udp.close rescue nil
   end
 
 end # class LogStash::Inputs::Udp

data/logstash-input-udp.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-udp'
-  s.version         = '1.0.0'
+  s.version         = '2.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Read messages as events over the network via udp."
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
@@ -20,9 +20,10 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.snapshot", "< 3.0.0"
 
   s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '~> 0.0.22'
   s.add_development_dependency 'logstash-devutils'
 end
 

data/spec/inputs/udp_spec.rb

@@ -1,6 +1,54 @@
 # encoding: utf-8
-require "logstash/devutils/rspec/spec_helper"
-require 'logstash/inputs/udp'
+require_relative "../spec_helper"
+require_relative "../support/client"
 
 describe LogStash::Inputs::Udp do
+
+  before do
+    srand(RSpec.configuration.seed)
+  end
+
+  let(:port)       { rand(1024..65535) }
+  subject { LogStash::Plugin.lookup("input", "udp").new({ "port" => port }) }
+
+  after :each do
+    subject.close rescue nil
+  end
+
+  describe "register" do
+    it "should register without errors" do
+      expect { subject.register }.to_not raise_error
+    end
+  end
+
+  describe "receive" do
+
+    let(:client) { LogStash::Inputs::Test::UDPClient.new(port) }
+    let(:nevents) { 10 }
+
+    let(:events) do
+      input(subject, nevents) do
+        nevents.times do |i|
+          client.send("msg #{i}")
+        end
+      end
+    end
+
+    before(:each) do
+      subject.register
+    end
+
+    it "should receive events been generated" do
+      expect(events.size).to be(nevents)
+      messages = events.map { |event| event["message"]}
+      messages.each do |message|
+        expect(message).to match(/msg \d+/)
+      end
+    end
+
+  end
+
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) { { "port" => port } }
+  end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require 'logstash/inputs/udp'
+
+# expose the udp socket so that we can assert, during
+# a spec, that it is open and we can start sending data
+class LogStash::Inputs::Udp
+  attr_reader :udp
+end
+
+module UdpHelpers
+
+  def input(plugin, size, &block)
+    queue = Queue.new
+    input_thread = Thread.new do
+      plugin.run(queue)
+    end
+    # because the udp socket is created and bound during #run
+    # we must ensure that it is open before sending data
+    sleep 0.1 until (plugin.udp && !plugin.udp.closed?)
+    block.call
+    sleep 0.1 while queue.size != size
+    result = nevents.times.inject([]) do |acc|
+      acc << queue.pop
+    end
+    plugin.do_stop
+    result
+  end
+
+end
+
+RSpec.configure do |c|
+  c.include UdpHelpers
+end

data/spec/support/client.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require "socket"
+
+module LogStash::Inputs::Test
+
+  class UDPClient
+
+    attr_reader :host, :port, :socket
+
+    def initialize(port)
+      @port = port
+      @host = "0.0.0.0"
+      @socket = UDPSocket.new
+      socket.connect(host, port)
+    end
+
+    def send(msg="")
+      begin
+        send(msg)
+      rescue Exception => e
+        puts "send.exception", e
+        retry
+      end
+    end
+
+    def send(msg)
+      socket.connect(host, port) if socket.closed?
+      socket.send(msg, 0)
+    end
+
+    def close
+      socket.close
+    end
+
+  end
+
+end

metadata

@@ -1,80 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-udp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   name: logstash-core
+  prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 2.0.0.snapshot
     - - <
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
+  name: logstash-codec-plain
   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'
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.22
+  name: stud
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.22
+- !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: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - CHANGELOG.md
 - CONTRIBUTORS
 - Gemfile
 - LICENSE
 - NOTICE.TXT
 - README.md
-- Rakefile
 - lib/logstash/inputs/udp.rb
 - logstash-input-udp.gemspec
 - spec/inputs/udp_spec.rb
+- spec/spec_helper.rb
+- spec/support/client.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -97,9 +111,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Read messages as events over the network via udp.
 test_files:
 - spec/inputs/udp_spec.rb
+- spec/spec_helper.rb
+- spec/support/client.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-Gemfile.lock
-.bundle
-vendor

data/Rakefile

@@ -1,7 +0,0 @@
-@files=[]
-
-task :default do
-  system("rake -T")
-end
-
-require "logstash/devutils/rake"