logstash-input-jmx 0.1.5 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7086a6d48c28232b76bc569a275c3bb32a09c08e
-  data.tar.gz: b84125c9b177064bc94aa5b1379089fd3c931296
+  metadata.gz: fb0381af11cf452bd3d7bb53ac8cc4ef0b2a2903
+  data.tar.gz: 09acbb74bd4d7b8090c631f673b1640a8b48cdf0
 SHA512:
-  metadata.gz: db45a1f480c834c8b1d12e2648cf61b9d33eb6670abd356d966adf4406a7db7f1190a9b2d7098adfad75046d2fdd0961c07d6fad3ca128840228677739007f5a
-  data.tar.gz: b0d578838b8d9da72a0e6fe3e5e3c1815ee7faa4d2952688a217878f9e98dfddffd2fbf6e7115fa39baad7518caf0aee6d5ac55b86aeab9b906d7202fd7d1242
+  metadata.gz: 1402c93ba0da3e1c34bbce409f6ac9c97a139863d5434b50a23aca259ae04229913314d05c5208bd73a03abd03d9e2c8e2e75e69e9cde4725de68c9d1d99bf29
+  data.tar.gz: fcb04004db853801d769185dcd00e76d70667376f8024988c5859848e3d879ea29843737ad4a64bfa4a9ca82bf22f37bd55b4bc365b104deb6062da5637ddb13

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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -1,19 +1,19 @@
 # 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?
 
-Need help? Try #logstash on freenode IRC or the logstash-users@googlegroups.com mailing list.
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
 
 ## Developing
 
@@ -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/jmx.rb

@@ -191,6 +191,7 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
       event['metric_path'] = metric_path_substituted
       event['metric_value_string'] = metric_value.to_s
     end
+    decorate(event)
     queue << event
   end
 
@@ -208,12 +209,14 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
           @logger.debug("Connect to #{thread_hash_conf['host']}:#{thread_hash_conf['port']} with user #{thread_hash_conf['username']}")
           jmx_connection = JMX::MBean.connection :host => thread_hash_conf['host'],
                                                  :port => thread_hash_conf['port'],
+                                                 :url => thread_hash_conf['url'],
                                                  :username => thread_hash_conf['username'],
                                                  :password => thread_hash_conf['password']
         else
           @logger.debug("Connect to #{thread_hash_conf['host']}:#{thread_hash_conf['port']}")
           jmx_connection = JMX::MBean.connection :host => thread_hash_conf['host'],
-                                                 :port => thread_hash_conf['port']
+                                                 :port => thread_hash_conf['port'],
+                                                 :url => thread_hash_conf['url']
         end
 
 
@@ -288,6 +291,8 @@ 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"))
@@ -316,7 +321,7 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
         threads << Thread.new { thread_jmx(@queue_conf,queue) }
       end
 
-      while true
+      while !@interrupted
         @logger.info("Loading configuration files in path", :path => @path)
         Dir.foreach(@path) do |item|
           next if item == '.' or item == '..'
@@ -354,9 +359,21 @@ class LogStash::Inputs::Jmx < LogStash::Inputs::Base
                        \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?
+      end
     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         = '0.1.5'
+  s.version         = '2.0.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Retrieve metrics from jmx."
   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,7 +20,7 @@ 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 'jmx4r'
 

data/spec/inputs/jmx_spec.rb

@@ -3,6 +3,7 @@ require "logstash/devutils/rspec/spec_helper"
 require "logstash/inputs/jmx"
 require "logstash/codecs/plain"
 require 'stud/temporary'
+require "jmx4r"
 
 describe LogStash::Inputs::Jmx do
 
@@ -79,4 +80,77 @@ describe LogStash::Inputs::Jmx do
       end
     end
   end
+
+  context "establish JMX connection" 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)
+      {
+        "host" : "localhost",
+        "port" : 1234,
+        "queries": []
+      }
+      EOT
+      }
+
+      expect(JMX::MBean).to receive(:connection).with({
+        :host => "localhost",
+        :port => 1234,
+        :url => nil
+      }).and_return(nil)
+
+      subject.register
+      Thread.new(subject) { sleep 0.5; subject.close } # force the plugin to exit
+      subject.run(queue)
+    end
+
+    it "pass custom url in addition of host/port connection parameters to jmx4r" do
+      File.open(File.join(jmx_config_path,"my.config.json"), "wb") { |file|  file.write(<<-EOT)
+      {
+        "host" : "localhost",
+        "port" : 1234,
+        "url" : "abcdefg",
+        "queries": []
+      }
+      EOT
+      }
+
+      expect(JMX::MBean).to receive(:connection).with({
+        :host => "localhost",
+        :port => 1234,
+        :url => "abcdefg"
+      }).and_return(nil)
+
+      subject.register
+      Thread.new(subject) { sleep 0.5; subject.close } # force the plugin to exit
+      subject.run(queue)
+    end
+
+    it "pass host/port username/password connection parameters to jmx4r" do
+      File.open(File.join(jmx_config_path,"my.config.json"), "wb") { |file|  file.write(<<-EOT)
+      {
+        "host" : "localhost",
+        "port" : 1234,
+        "username" : "me",
+        "password" : "secret",
+        "queries": []
+      }
+      EOT
+      }
+
+      expect(JMX::MBean).to receive(:connection).with({
+        :host => "localhost",
+        :port => 1234,
+        :url => nil,
+        :username => "me",
+        :password => "secret"
+      }).and_return(nil)
+
+      subject.register
+      Thread.new(subject) { sleep 0.5; subject.close } # force the plugin to exit
+      subject.run(queue)
+    end
+  end
 end

metadata

@@ -1,89 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jmx
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 2.0.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: logstash-core
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
   requirement: !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
+  name: logstash-core
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: jmx4r
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0.snapshot
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+  name: jmx4r
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency
-  name: logstash-devutils
   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'
+  name: logstash-devutils
   prerelease: false
   type: :development
-- !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'
+  name: logstash-codec-plain
   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/jmx.rb
 - logstash-input-jmx.gemspec
 - spec/inputs/jmx_spec.rb
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Retrieve metrics from jmx.

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"