logstash-input-udp 3.3.3 → 3.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e1175824b16831674875cc4ede62188e3e6d38bff5aed42b169453be00c3cdf
-  data.tar.gz: fc54de7e53214b4f68db927f8e6bf5e81e6cb530a7fa104cb439ceb8920b03bf
+  metadata.gz: fa380c5310565f3b74449cda1e9105f3becb648783328a93aeb824d6eec25f91
+  data.tar.gz: 0d08f2b0646f20f2c34392a3e4d68110712d8d8a49c4ed3b454c9156dcd22d52
 SHA512:
-  metadata.gz: bee71becfe577ce656daecce595d2b97dafc208a3b93d3dda7718f8f647adbb806e08caadd4ea81e0819158d1914c7efbe3f4745296c80c2dd6d71861faf4b21
-  data.tar.gz: e6cd007d1d904bff2a511101112d40b27f896294f820fc0bdba5213895f5ee5f7219d20cc2dbcaae07c9374ba6ae617237dcddabae3e4ad9833353d4990d5a38
+  metadata.gz: 5179c29aee0fcb092d9e22691863f1320c823e0e0353647569e82e132758de545dedbe6055fbebf0a22fd8e950903c30be8e223fb894cf96822e0191def2ee1e
+  data.tar.gz: 3efdd9cd5de25320f949454959601f8144605c6fc773c611e3a05d84b091e21097107ac68e4b574a3ed670a3197abe7b3ad39f9fd16beba1bfa56e522e3911b6

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.3.4
+  - Fixed input workers exception handling and shutdown handling [#44](https://github.com/logstash-plugins/logstash-input-udp/pull/44)
+
 ## 3.3.3
   - Work around jruby/jruby#5148 by cloning messages on jruby 9k, therefore resizing the underlying byte buffer
 

data/docs/index.asciidoc

@@ -40,6 +40,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 | <<plugins-{type}s-{plugin}-queue_size>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-receive_buffer_bytes>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-workers>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-source_ip_fieldname>> |<<string,string>>|No
 |=======================================================================
 
 Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
@@ -101,9 +102,15 @@ Consult your operating system documentation if you need to increase this max all
 
 Number of threads processing packets
 
+[id="plugins-{type}s-{plugin}-source_ip_fieldname"]
+===== `source_ip_fieldname`
 
+  * Value type is <<string,string>>
+  * Default value is `"host"`
+
+The name of the field where the source IP address will be stored.
 
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
 
-:default_codec!:
+:default_codec!:

data/lib/logstash/inputs/udp.rb

@@ -38,7 +38,8 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
   # before packets will start dropping.
   config :queue_size, :validate => :number, :default => 2000
 
-  HOST_FIELD = "host".freeze
+  # The name of the field where the source IP address will be stored
+  config :source_ip_fieldname, :validate => :string, :default => 'host'
 
   def initialize(params)
     super
@@ -53,14 +54,27 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
   def run(output_queue)
     @output_queue = output_queue
 
+    @input_to_worker = SizedQueue.new(@queue_size)
+    metric.gauge(:queue_size, @queue_size)
+    metric.gauge(:workers, @workers)
+
+    @input_workers = (1..@workers).to_a.map do |i|
+      @logger.debug("Starting UDP worker thread", :worker => i)
+      Thread.new(i, @codec.clone) { |i, codec| inputworker(i, codec) }
+    end
+
     begin
       # udp server
       udp_listener(output_queue)
     rescue => e
-      @logger.warn("UDP listener died", :exception => e, :backtrace => e.backtrace)
+      @logger.error("UDP listener died", :exception => e, :backtrace => e.backtrace)
       @metric_errors.increment(:listener)
       Stud.stoppable_sleep(5) { stop? }
       retry unless stop?
+    ensure
+      # signal workers to end
+      @input_workers.size.times { @input_to_worker.push([:END, nil]) }
+      @input_workers.each { |thread| thread.join }
     end
   end
 
@@ -102,14 +116,6 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
     @udp.bind(@host, @port)
     @logger.info("UDP listener started", :address => "#{@host}:#{@port}", :receive_buffer_bytes => "#{rcvbuf}", :queue_size => "#{@queue_size}")
 
-    @input_to_worker = SizedQueue.new(@queue_size)
-    metric.gauge(:queue_size, @queue_size)
-    metric.gauge(:workers, @workers)
-
-    @input_workers = @workers.times do |i|
-      @logger.debug("Starting UDP worker thread", :worker => i)
-      Thread.new(i, @codec.clone) { |i, codec| inputworker(i, codec) }
-    end
 
     while !stop?
       next if IO.select([@udp], [], [], 0.5).nil?
@@ -134,17 +140,20 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
   def inputworker(number, codec)
     LogStash::Util::set_thread_name("<udp.#{number}")
 
-    begin
-      while true
+    while true
+      # a worker should never terminate from an exception, only when it receives the :END symbol
+      begin
         payload, client = @input_to_worker.pop
-        host = client[3]
+        break if payload == :END
 
-        codec.decode(payload) { |event| push_decoded_event(host, event) }
-        codec.flush { |event| push_decoded_event(host, event) }
+        ip_address = client[3]
+
+        codec.decode(payload) { |event| push_decoded_event(ip_address, event) }
+        codec.flush { |event| push_decoded_event(ip_address, event) }
+      rescue => e
+        @logger.error("Exception in inputworker", "exception" => e, "backtrace" => e.backtrace)
+        @metric_errors.increment(:worker)
       end
-    rescue => e
-      @logger.error("Exception in inputworker", "exception" => e, "backtrace" => e.backtrace)
-      @metric_errors.increment(:worker)
     end
   end
 
@@ -163,9 +172,9 @@ class LogStash::Inputs::Udp < LogStash::Inputs::Base
     end
   end
 
-  def push_decoded_event(host, event)
+  def push_decoded_event(ip_address, event)
     decorate(event)
-    event.set(HOST_FIELD, host) if event.get(HOST_FIELD).nil?
+    event.set(source_ip_fieldname, ip_address) if event.get(source_ip_fieldname).nil?
     @output_queue.push(event)
     metric.increment(:events)
   end

data/logstash-input-udp.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-udp'
-  s.version         = '3.3.3'
+  s.version         = '3.3.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads events over UDP"
   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/udp_spec.rb

@@ -1,9 +1,19 @@
 # encoding: utf-8
 require_relative "../spec_helper"
 require_relative "../support/client"
+require "logstash/codecs/base"
 
-describe LogStash::Inputs::Udp do
 
+class LogStash::Codecs::Crash < LogStash::Codecs::Base
+  config_name "crash"
+
+  def decode(data)
+    raise("decode crash") if data == "crash"
+    yield LogStash::Event.new({"message" => data })
+  end
+end
+
+describe LogStash::Inputs::Udp do
   before do
     srand(RSpec.configuration.seed)
   end
@@ -87,4 +97,30 @@ describe LogStash::Inputs::Udp do
   it_behaves_like "an interruptible input plugin" do
     # see https://github.com/elastic/logstash-devutils/blob/9c4a1fbf2b0c4547e428c5a40ed84f60aad17f97/lib/logstash/devutils/rspec/shared_examples.rb
   end
+
+  describe "worker should ignore codec exception" do
+    # see custom "crash" codec above which raises upon decoding the "crash" straing payload
+    let(:config) { { "port" => port, "workers" => 1, "codec" => "crash" } }
+
+    let(:events) do
+      helper.input(subject, 3) do
+        client.send("crash")
+        client.send("foo")
+        client.send("bar")
+        client.send("crash")
+        client.send("baz")
+      end
+    end
+
+    before(:each) do
+      subject.register
+    end
+
+    it "should receive events been generated" do
+      expect(events.size).to be(3)
+      expect(events[0].get("message")).to match("foo")
+      expect(events[1].get("message")).to match("bar")
+      expect(events[2].get("message")).to match("baz")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-udp
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.3.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement