logstash-filter-grok 3.2.3 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e45feb32b6599f171a7d75ef08a165301a02a798
-  data.tar.gz: d6895d5112db9412404ddb9da3806210b85a15b4
+  metadata.gz: b034532a205ad23ce96a26ec94a38168714f89b5
+  data.tar.gz: 864f130d2549eeafff4c1f4b5fdd8ab6e2646bab
 SHA512:
-  metadata.gz: c5c7c112f2e3e3025ee58eb0ec4dd576db6073e07c3dfd40a53febeca25236aa585d4f8be56d4d6a7c55c4fb961cc665d4116655366ab899d84541da4dbd0301
-  data.tar.gz: 0d26a71dd53d0fd60bfbeaa7c16455c94206d0149c985677b1e413379d3eef5da3371321d1780102f925be5a47e05ca71d0ae7217f6a4e58bb2e8b922eee1b7e
+  metadata.gz: edd8cfade5fef7b64a5199c500574db16848de04fade4cabbfae9c58f07667cc94c23a41ed117f383c683baf44ec06b1b6aeb1048349ca620d147f0139d1d2e7
+  data.tar.gz: 1753891e587a891e65cb57b540814d619192a9bf5ef1d71fedb703207e9d5004fd1da26f3cd0725430620555e5bad05b19c2d3b43ef0e79ab937298e71e5931f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.2.4
+  - Fix mutex interruption bug that could crash logstash. See: https://github.com/logstash-plugins/logstash-filter-grok/issues/97
+
 ## 3.2.3
   - No longer use 'trace' log level as it breaks rspec
   - Fix race conditions in timeout enforcer

data/lib/logstash/filters/grok/timeout_enforcer.rb

@@ -1,6 +1,8 @@
+java_import java.util.concurrent.locks.ReentrantLock
+
 class LogStash::Filters::Grok::TimeoutEnforcer
   attr_reader :running
-  
+
   def initialize(logger, timeout_nanos)
     @logger = logger
     @running = true
@@ -8,8 +10,8 @@ class LogStash::Filters::Grok::TimeoutEnforcer
 
     # Stores running matches with their start time, this is used to cancel long running matches
     # Is a map of Thread => start_time
-    @timer_mutex = Mutex.new
-    @threads_to_start_time = {}        
+    @threads_to_start_time = {}
+    @state_lock = java.util.concurrent.locks.ReentrantLock.new
   end
 
   def grok_till_timeout(event, grok, field, value)
@@ -22,26 +24,59 @@ class LogStash::Filters::Grok::TimeoutEnforcer
     ensure
       stop_thread_groking(thread)
       # Clear any interrupts from any previous invocations that were not caught by Joni
+      # It may appear that this should go in #stop_thread_groking but that would actually
+      # break functionality! If this were moved there we would clear the interrupt
+      # immediately after setting it in #cancel_timed_out, hence this MUST be here
       thread.interrupted
     end
   end
 
+  def start!
+    @timer_thread = Thread.new do
+      while @running
+        begin
+          cancel_timed_out!
+        rescue Exception => e
+          @logger.error("Error while attempting to check/cancel excessively long grok patterns",
+                        :message => e.message,
+                        :class => e.class.name,
+                        :backtrace => e.backtrace
+                       )
+        end
+        sleep 0.25
+      end
+    end
+  end
+
+  def stop!
+    @running = false
+    # Check for the thread mostly for a fast start/shutdown scenario
+    @timer_thread.join if @timer_thread
+  end
+
+  private
+
+  # These methods are private in large part because if they aren't called
+  # in specific sequence and used together in specific ways the interrupt
+  # behavior will be incorrect. Do NOT use or modify these methods unless
+  # you know what you are doing!
+
   def start_thread_groking(thread)
     # Clear any interrupts from any previous invocations that were not caught by Joni
     thread.interrupted
-    @timer_mutex.synchronize do
+    synchronize do
       @threads_to_start_time[thread] = java.lang.System.nanoTime()
     end
   end
 
   def stop_thread_groking(thread)
-    @timer_mutex.synchronize do
+    synchronize do
       @threads_to_start_time.delete(thread)
     end
   end
 
   def cancel_timed_out!
-    @timer_mutex.synchronize do
+    synchronize do
       @threads_to_start_time.each do |thread,start_time|
         now = java.lang.System.nanoTime # save ourselves some nanotime calls
         elapsed = java.lang.System.nanoTime - start_time
@@ -56,26 +91,16 @@ class LogStash::Filters::Grok::TimeoutEnforcer
     end
   end
 
-  def start!
-    @timer_thread = Thread.new do
-      while @running
-        begin
-          cancel_timed_out!
-        rescue Exception => e
-          @logger.error("Error while attempting to check/cancel excessively long grok patterns",
-                        :message => e.message,
-                        :class => e.class.name,
-                        :backtrace => e.backtrace
-                       )
-        end                   
-        sleep 0.25
-      end
-    end
+  # We use this instead of a Mutex because JRuby mutexes are interruptible
+  # We actually don't want that behavior since we always clear the interrupt in
+  # grok_till_timeout
+  def synchronize
+    # The JRuby Mutex uses lockInterruptibly which is what we DO NOT want
+    @state_lock.lock()
+    yield
+  ensure
+    @state_lock.unlock()
   end
 
-  def stop!
-    @running = false
-    # Check for the thread mostly for a fast start/shutdown scenario
-    @timer_thread.join if @timer_thread
-  end
+
 end

data/logstash-filter-grok.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-grok'
-  s.version         = '3.2.3'
+  s.version         = '3.2.4'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parse arbitrary text and structure it."
   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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-grok
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.2.4
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement