logstash-input-jmx 3.0.6 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5036f5be1331e266e3760bd750f62fd9cecf1ead4bf311a7ca193896593c7fa
-  data.tar.gz: 2927501779f323bbee6b0fb3f196e7fec74ef7bbc3ebc3083f5796466d00e0cf
+  metadata.gz: c53771abfa6de01498a61244afba4617cc15f2b018c6049ec11fb4e9337b5b9c
+  data.tar.gz: 333a64bfec48374fb106d44967017081a18a091469eb2a39ee80e1cf943f86f4
 SHA512:
-  metadata.gz: 4a0c91f1da07a43b56275d80d922f25b694891c033d38e903290767a01bfc7dca34043552dd83d1302e78eba53fbb6280411fc3a29caabc8fb1a51216ca0fa84
-  data.tar.gz: f0d3fceb40422062e5e40acfde3a1e896d68b218ac8ad2c90e3d026672cd01e9dc43c2b37b84d37d669b6987510d5055d39beb41864f137c4d6cb7a96a04edf7
+  metadata.gz: 367ab754640b80f64eab341adcdd6391354f1f851acf7bb3d235f3dcd6c9a96179905a994b577f39d909d6cd7c0588f98549003c1cea98084c1d1b23c2c4722c
+  data.tar.gz: 5ef2eba33289c66cf37a2685aa70130455b1b5da59a11d20b6c3fdf7421b7d0be5e3ccd5d27bc218f51c71b2f2f4c8d178c82bf37ef86cd41d67067e9cc8275f

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.7
+ - Fixed shutdown handling [#47](https://github.com/logstash-plugins/logstash-input-jmx/pull/47)
+
 ## 3.0.6
  - Fix documentation issue (correct subheading format)
 

data/lib/logstash/inputs/jmx.rb

@@ -202,7 +202,14 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
       begin
         @logger.debug('Wait config to retrieve from queue conf')
         thread_hash_conf = queue_conf.pop
-        @logger.debug("Retrieve config #{thread_hash_conf} from queue conf")
+
+        if thread_hash_conf == :END
+          # the :END symbol is a signal to terminate the thread
+          @logger.debug? && @logger.debug("Received jmx thread termination signal")
+          return
+        else
+          @logger.debug? && @logger.debug("Retrieve config #{thread_hash_conf} from queue conf")
+        end
 
         @logger.debug('Check if jmx connection need a user/password')
         if thread_hash_conf.has_key?('username') and thread_hash_conf.has_key?('password')
@@ -213,12 +220,16 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
                                                  :username => thread_hash_conf['username'],
                                                  :password => thread_hash_conf['password']
         else
-          @logger.debug("Connect to #{thread_hash_conf['host']}:#{thread_hash_conf['port']}")
+          @logger.debug("Connect to #{thread_hash_conf['host']}:#{thread_hash_conf['port']}:#{thread_hash_conf['url']}")
           jmx_connection = JMX::MBean.connection :host => thread_hash_conf['host'],
                                                  :port => thread_hash_conf['port'],
                                                  :url => thread_hash_conf['url']
         end
 
+        if jmx_connection.nil?
+          @logger.warn("Invalid nil jmx connection, ignoring", :host => thread_hash_conf['host'], :port => thread_hash_conf['port'],  :url => thread_hash_conf['url'])
+          next
+        end
 
         if thread_hash_conf.has_key?('alias')
           @logger.debug("Set base_metric_path to alias: #{thread_hash_conf['alias']}")
@@ -291,8 +302,6 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
           end
         end
         jmx_connection.close
-      rescue LogStash::ShutdownSignal
-        break #free
       rescue Exception => ex
         @logger.error(ex.message)
         @logger.error(ex.backtrace.join("\n"))
@@ -321,7 +330,7 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
         threads << Thread.new { thread_jmx(@queue_conf,queue) }
       end
 
-      while !@interrupted
+      while !stop?
         @logger.info("Loading configuration files in path", :path => @path)
         Dir.foreach(@path) do |item|
           next if item == '.' or item == '..'
@@ -343,6 +352,7 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
               :exception => ex.message, :backtrace => ex.backtrace)
           end
         end
+
         @logger.debug('Wait until the queue conf is empty')
         delta=0
         until @queue_conf.empty?
@@ -350,30 +360,25 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
           delta=delta+1
           sleep(1)
         end
+
         wait_time=@polling_frequency-delta
         if wait_time>0
           @logger.debug("Wait #{wait_time}s (#{@polling_frequency}-#{delta}(seconds wait until queue conf empty)) before to launch again a new jmx metrics collection")
-          sleep(wait_time)
+          Stud.stoppable_sleep(wait_time) { stop? }
         else
           @logger.warn("The time taken to retrieve metrics is more important than the retrieve_interval time set.
                        \nYou must adapt nb_thread, retrieve_interval to the number of jvm/metrics you want to retrieve.")
         end
       end
-    rescue LogStash::ShutdownSignal
-        #exiting
     rescue Exception => ex
       @logger.error(ex.message)
       @logger.error(ex.backtrace.join("\n"))
     ensure
-      threads.each do |thread|
-        thread.raise(LogStash::ShutdownSignal) if thread.alive?
+      @nb_thread.times do |i|
+        @logger.debug? && @logger.debug("Signaling termination to jmx thread #{i + 1}")
+        @queue_conf << :END
       end
+      threads.each {|t| t.join }
     end
-
   end
-
-  public
-  def close
-    @interrupted = true
-  end # def close
 end

data/logstash-input-jmx.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-jmx'
-  s.version         = '3.0.6'
+  s.version         = '3.0.7'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Retrieves metrics from remote Java applications over JMX"
   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/jmx_spec.rb

@@ -12,6 +12,10 @@ describe LogStash::Inputs::Jmx do
     FileUtils.remove_dir(jmx_config_path)
   end
 
+  it_behaves_like "an interruptible input plugin" do
+    let(:config) {{"path" => jmx_config_path, "nb_thread" => 1, "polling_frequency" => 1}}
+  end
+
   subject { LogStash::Inputs::Jmx.new("path" => jmx_config_path)}
 
   context "#validate_configuration(conf_hash)" do
@@ -83,6 +87,7 @@ describe LogStash::Inputs::Jmx do
     subject { LogStash::Inputs::Jmx.new("path" => jmx_config_path, "nb_thread" => 1, "polling_frequency" => 1)}
 
     let(:queue) { Queue.new }
+
     it "pass host/port connection parameters to jmx4r" do
       File.open(File.join(jmx_config_path,"my.config.json"), "wb") { |file|  file.write(<<-EOT)
       {
@@ -100,7 +105,7 @@ describe LogStash::Inputs::Jmx do
       }).and_return(nil)
 
       subject.register
-      Thread.new(subject) { sleep 0.5; subject.close } # force the plugin to exit
+      Thread.new(subject) { sleep 0.5; subject.do_stop } # force the plugin to exit
       subject.run(queue)
     end
 
@@ -122,7 +127,7 @@ describe LogStash::Inputs::Jmx do
       }).and_return(nil)
 
       subject.register
-      Thread.new(subject) { sleep 0.5; subject.close } # force the plugin to exit
+      Thread.new(subject) { sleep 0.5; subject.do_stop } # force the plugin to exit
       subject.run(queue)
     end
 
@@ -147,7 +152,7 @@ describe LogStash::Inputs::Jmx do
       }).and_return(nil)
 
       subject.register
-      Thread.new(subject) { sleep 0.5; subject.close } # force the plugin to exit
+      Thread.new(subject) { sleep 0.5; subject.do_stop } # force the plugin to exit
       subject.run(queue)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jmx
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement