logstash-input-tcp 5.0.2-java → 5.0.3-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 194c2ce3a58504f3d3290cc5adc7945faffd3ff6
-  data.tar.gz: 46faee2a86e761688e5168709c986b3f295af60c
+SHA256:
+  metadata.gz: e583a67a7f5b0fe1ea4b0e800a43102f82431cfd1b57f54213d7306a6d35366e
+  data.tar.gz: b9818207449346d5f863b0edf5fdc5cd29ab1660bec6c0ba056a7b70a803901a
 SHA512:
-  metadata.gz: bc017846852684f7cc36c933a5d4e58b9155a778a7d23589d06e6c44f08e6eafe1c7f80b70f750188a85633b69dfbbd3b11024e26c7b6b535dab24f5c51f6ee2
-  data.tar.gz: f90e391609b3f666aeba6f5ba9e283239b147728d3d15674cf31bb543a240260b47337cbca9aa46012d610fee6f975eb8f4ef505ceb0be2a5f7c704059b34c2d
+  metadata.gz: fc0c0e58436f8d2c1049abb53a8f31cbb1cb3db84587c3a6c93b0f5929f3912dffd54420472b8ded67997ba9a81a72dd5db3cd3c61f970e266e79afd2258fb19
+  data.tar.gz: 2e0433042a7af1d19c1c87e07686b32b733f13622034c20ae10470d994b3b5dd1a4c4ed81575813e3c5acbb58854a1a12142a4c419744e29e92e5fe4893bea18

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 5.0.3
+  - Fix bug where codec was not flushed when client disconnected
+  - Restore INFO logging statement on startup
+  - Fixed typo in @metadata tag
+  - Update gemspec summary
+
 ## 5.0.2
   - Fix bug where this input would crash logstash during some socket reads when acting as an SSL server
 

data/lib/logstash/inputs/tcp.rb

@@ -106,7 +106,7 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
   config :ssl_extra_chain_certs, :validate => :array, :default => []
 
   HOST_FIELD = "host".freeze
-  HOST_IP_FIELD = "[@metdata][ip_address]".freeze
+  HOST_IP_FIELD = "[@metadata][ip_address]".freeze
   PORT_FIELD = "port".freeze
   PROXY_HOST_FIELD = "proxy_host".freeze
   PROXY_PORT_FIELD = "proxy_port".freeze
@@ -135,6 +135,7 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
     # in the close method even if we also close it in the stop method since we could have
     # a situation where register is called but not run & stop.
 
+    @logger.info("Starting tcp input listener", :address => "#{@host}:#{@port}", :ssl_enable => "#{@ssl_enable}")
     if server?
       if @ssl_enable
         self.server_socket = new_server_socket
@@ -187,6 +188,12 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
     end
   end
 
+  def flush_codec(codec, client_ip_address, client_address, client_port)
+    codec.flush do |event|
+      enqueue_decorated(event, client_ip_address, client_address, client_port)
+    end
+  end
+
   private
 
   RUN_LOOP_ERROR_MESSAGE="TCP input server encountered error"
@@ -277,10 +284,7 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
   ensure
     # catch all rescue nil on close to discard any close errors or invalid socket
     socket.close rescue nil
-
-    codec.respond_to?(:flush) && codec.flush do |event|
-      enqueue_decorated(event, client_ip_address, client_address, client_port)
-    end
+    flush_codec(codec, client_ip_address, client_address, client_port)
   end
 
   def enqueue_decorated(event, client_ip_address, client_address, client_port)
@@ -324,7 +328,6 @@ class LogStash::Inputs::Tcp < LogStash::Inputs::Base
   end
 
   def new_server_socket
-    @logger.info("Starting tcp input listener", :address => "#{@host}:#{@port}")
     begin
       socket = TCPServer.new(@host, @port)
     rescue Errno::EADDRINUSE

data/lib/logstash/inputs/tcp/decoder_impl.rb

@@ -25,10 +25,14 @@ class DecoderImpl
                        @proxy_address, @proxy_port, tbuf)
   end
 
-  def copy()
+  def copy
     DecoderImpl.new(@codec.clone, @tcp)
   end
 
+  def flush
+    @tcp.flush_codec(@codec, @ip_address, @address, @port)
+  end
+
   private
   def init_first_read(channel_addr, received)
     if @tcp.proxy_protocol

data/logstash-input-tcp.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   s.name          = 'logstash-input-tcp'
   s.version       = ::File.read('version').split("\n").first
   s.licenses      = ['Apache License (2.0)']
-  s.summary       = "Read events over a TCP socket."
+  s.summary       = "Reads events from a TCP socket"
   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"
   s.authors       = ["Elastic"]
   s.email         = 'info@elastic.co'
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'logstash-codec-line'
   s.add_runtime_dependency 'logstash-codec-json'
   s.add_runtime_dependency 'logstash-codec-json_lines'
+  s.add_runtime_dependency 'logstash-codec-multiline'
 
   s.add_development_dependency 'logstash-devutils'
   s.add_development_dependency 'flores', '~> 0.0.6'

data/spec/inputs/tcp_spec.rb

@@ -72,11 +72,12 @@ describe LogStash::Inputs::Tcp do
     end
 
     insist { events.length } == event_count
+    events = events.sort_by {|e| e.get("message")} # the ordering of events in the queue is highly timing-dependent
     event_count.times do |i|
       event = events[i]
       insist { event.get("message") } == "#{i} ☹"
-      insist { event.get("host") } == host
-      insist { event.get("[@metdata][ip_address]") } == '127.0.0.1'
+      insist { ["localhost","ip6-localhost"].includes? event.get("host") }
+      insist { event.get("[@metadata][ip_address]") } == '127.0.0.1'
     end
   end
 
@@ -106,6 +107,7 @@ describe LogStash::Inputs::Tcp do
     end
 
     insist { events.length } == event_count
+    events = events.sort_by {|e| e.get("message")} # the ordering of events in the queue is highly timing-dependent
     event_count.times do |i|
       insist { events[i].get("message") } == "#{i} ☹"
       insist { events[i].get("host") } == "1.2.3.4"
@@ -231,6 +233,7 @@ describe LogStash::Inputs::Tcp do
       (1..event_count).map{queue.pop}
     end
 
+    events = events.sort_by {|e| e.get("idx")} # the ordering of events in the queue is highly timing-dependent
     events.each_with_index do |event, idx|
       insist { event.get("hello") } == data["hello"]
       insist { event.get("foo").to_a } == data["foo"] # to_a to cast Java ArrayList produced by JrJackson
@@ -266,6 +269,41 @@ describe LogStash::Inputs::Tcp do
     end
   end
 
+  it "should flush codec after client disconnects" do
+    # verifies fix for https://github.com/logstash-plugins/logstash-input-tcp/issues/90
+    conf = <<-CONFIG
+      input {
+        tcp {
+          port => #{port}
+          codec => multiline {
+              pattern => "^\s"
+              what => "previous"
+          }
+        }
+      }
+    CONFIG
+
+    data = "a\n 1\n 2\nb\n 1"
+    event_count = 2
+
+    events = input(conf) do |pipeline, queue|
+      socket = Stud::try(5.times) { TCPSocket.new("127.0.0.1", port) }
+      socket.puts(data)
+      socket.close
+
+      # If the codec is not properly flushed, there will be only one event and the second call to queue.pop
+      # will block indefinitely. Wrapping this with a timeout ensures that failure mode does not hang the
+      # test.
+      Timeout.timeout(5) do
+        event_count.times.collect do
+          queue.pop
+        end
+      end
+    end
+
+    expect(events.length).to equal(event_count)
+  end
+
   # below are new specs added in the context of the shutdown semantic refactor.
   # TODO:
   #   - refactor all specs using this new model

data/version

@@ -1 +1 @@
-5.0.2
+5.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-tcp
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.0.3
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-30 00:00:00.000000000 Z
+date: 2017-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-multiline
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -128,7 +142,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.22
-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: []
@@ -147,7 +163,7 @@ files:
 - logstash-input-tcp.gemspec
 - spec/inputs/tcp_spec.rb
 - spec/spec_helper.rb
-- vendor/jar-dependencies/org/logstash/inputs/logstash-input-tcp/5.0.2/logstash-input-tcp-5.0.2.jar
+- vendor/jar-dependencies/org/logstash/inputs/logstash-input-tcp/5.0.3/logstash-input-tcp-5.0.3.jar
 - version
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
@@ -172,10 +188,10 @@ 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: Read events over a TCP socket.
+summary: Reads events from a TCP socket
 test_files:
 - spec/inputs/tcp_spec.rb
 - spec/spec_helper.rb