logstash-input-jms 2.0.4-java → 3.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90ee9fb9254aa206fc4413c73de2b93f2916700e
-  data.tar.gz: d2d817a3908358f9dd50323865b421b6a9bc0629
+  metadata.gz: 1d6da6295a849725f21b5329a1c8b6ce76678d6f
+  data.tar.gz: b5964363f134aa555145b699d99af3df70cdc753
 SHA512:
-  metadata.gz: 404e50acea9abe786bc5bbdfc46660a3efb8660a8d9f72465cd083a906c297790fb5acab30da85d10dde26df2a76c0bfd4f024ca0a1622681d792147e945097b
-  data.tar.gz: b5d1c3ebd6acfa3eef525930aeca6752ba25c376e80addc3a2886bf3afd52140203700755c6d281f86f3f24848f9d17260f7cd7a6bcf33eea63fa7c1732db179
+  metadata.gz: 3747e4e2c81817ce2ad2ba18f8b0ffd100ce096cba48a0e6bc67ca21e7d860f052225af31badc4fd3535b15d3c9cde4e31811671d41ce3e1f7b833fb656d2bc9
+  data.tar.gz: 6f8dc5e2d7e6f28cfce0d1f3eaf919a0f16bff3d4a754a4c6d6eb71534a0e24bc44fac49a5785a9a2f5edb7dae357947d5e9edf46127ede2fea0759e79d11d0c

data/CHANGELOG.md

@@ -1,11 +1,19 @@
-# 2.0.4
-  - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
-# 2.0.3
-  - New dependency requirements for logstash-core for the 5.0 release
+## 3.0.0
+ - Breaking: Updated plugin to use new Java Event APIs
+ - relax logstash-core-plugin-api constrains
+ - update .travis.yml
+ - fix issue #6 - use missing calls from Plugin API - stop, close, stop?
+
+## 2.0.4
+ - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
+
+## 2.0.3
+ - New dependency requirements for logstash-core for the 5.0 release
+
 ## 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
 
-# 0.1.1
-  - make the plugin, 1.5 friendly by using logstash-core
+## 0.1.1
+ - make the plugin, 1.5 friendly by using logstash-core

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-jms-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-jms-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-jms.svg)](https://travis-ci.org/logstash-plugins/logstash-input-jms)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -83,7 +82,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
 ```
 - Start Logstash and proceed to test the plugin
 

data/lib/logstash/inputs/jms.rb

@@ -7,14 +7,15 @@ require "logstash/namespace"
 #
 # For more information about Jms, see <http://docs.oracle.com/javaee/6/tutorial/doc/bncdq.html>
 # For more information about the Ruby Gem used, see <http://github.com/reidmorrison/jruby-jms>
-# Here is a config example :
+# Here is a config example to pull from a queue:
 #  jms {
 #     include_header => false
 #     include_properties => false
 #     include_body => true
 #     use_jms_timestamp => false
 #     interval => 10
-#     queue_name => "myqueue"
+#     destination => "myqueue"
+#     pub-sub => false
 #     yaml_file => "~/jms.yml"
 #     yaml_section => "mybroker"
 #   }
@@ -39,8 +40,8 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
   # If the JMS Message is a MapMessage, then all the key/value pairs will be added in the Hashmap of the event
   # StreamMessage and ObjectMessage are not supported
   config :include_body, :validate => :boolean, :default => true
+  
   # Convert the JMSTimestamp header field to the @timestamp value of the event
-  # Don't use it for now, it is buggy
   config :use_jms_timestamp, :validate => :boolean, :default => false
 
   # Choose an implementation of the run block. Value can be either consumer, async or thread
@@ -57,7 +58,7 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
   # This parameter has non influence in the case of a subcribed Topic.
   config :interval, :validate => :number, :default => 10
 
-  # If pub-sub (topic) style should be used or not.
+  # If pub-sub (topic) style should be used.
   config :pub_sub, :validate => :boolean, :default => false
 
   # Name of the destination queue or topic to use.
@@ -137,7 +138,7 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
         if msg.java_kind_of?(JMS::MapMessage)
           event = LogStash::Event.new
           msg.data.each do |field, value|
-            event[field.to_s] = value # TODO(claveau): needs codec.decode or converter.convert ?
+            event.set(field.to_s, value) # TODO(claveau): needs codec.decode or converter.convert ?
           end
         elsif msg.java_kind_of?(JMS::TextMessage) || msg.java_kind_of?(JMS::BytesMessage)
           @codec.decode(msg.to_s) do |event_message|
@@ -152,18 +153,18 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
 
       # Here, we can use the JMS Enqueue timestamp as the @timestamp
       if @use_jms_timestamp && msg.jms_timestamp
-        event.timestamp = ::Time.at(msg.jms_timestamp/1000)
+        event.set("@timestamp", LogStash::Timestamp.at(msg.jms_timestamp / 1000, (msg.jms_timestamp % 1000) * 1000))
       end
 
       if @include_header
         msg.attributes.each do |field, value|
-          event[field.to_s] = value
+          event.set(field.to_s, value)
         end
       end
 
       if @include_properties
         msg.properties.each do |field, value|
-          event[field.to_s] = value
+          event.set(field.to_s, value)
         end
       end
 
@@ -182,20 +183,19 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
   def run_consumer(output_queue)
     JMS::Connection.session(@jms_config) do |session|
       destination_key = @pub_sub ? :topic_name : :queue_name
-      while(true)
+      while !stop?
         session.consume(destination_key => @destination, :timeout=>@timeout, :selector => @selector) do |message|
           queue_event message, output_queue
+          break if stop?
         end
         sleep @interval
       end
     end
-  rescue LogStash::ShutdownSignal
-    # Do nothing, let us quit.
   rescue => e
     @logger.warn("JMS Consumer died", :exception => e, :backtrace => e.backtrace)
     sleep(10)
-    retry
-  end # def run
+    retry unless stop?
+  end # def run_consumer
 
   # Consume all available messages on the queue through a listener
   private
@@ -210,19 +210,15 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
       queue_event message, output_queue
     end
     connection.start
-    while(true)
+    while !stop?
       @logger.debug("JMS Thread sleeping ...")
       sleep @interval
     end
-  rescue LogStash::ShutdownSignal
-    connection.close
   rescue => e
     @logger.warn("JMS Consumer died", :exception => e, :backtrace => e.backtrace)
     sleep(10)
-    retry
-  end # def run
-
-
+    retry unless stop?
+  end # def run_thread
 
   # Consume all available messages on the queue through a listener
   private
@@ -241,18 +237,16 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
       end
       # Since the on_message handler above is in a separate thread the thread needs
       # to do some other work. It will just sleep for 10 seconds.
-      while(true)
+      while !stop?
+        @logger.debug("JMS Thread sleeping ...")
         sleep @interval
       end
     end
-  rescue LogStash::ShutdownSignal
-    # Do nothing, let us quit.
   rescue => e
     @logger.warn("JMS Consumer died", :exception => e, :backtrace => e.backtrace)
     sleep(10)
-    retry
-  end # def run
-
+    retry unless stop?
+  end # def run_async
 
   public
   def run(output_queue)
@@ -266,4 +260,15 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
     end
   end # def run
 
+  public
+  def close
+    @logger.info("Closing JMS connection")
+    @connection.close rescue nil
+  end # def close
+
+  public
+  def stop
+    @logger.info("Stopping JMS consumer")
+    @connection.stop rescue nil
+  end # def stop
 end # class LogStash::Inputs::Jms

data/logstash-input-jms.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-jms'
-  s.version         = '2.0.4'
+  s.version         = '3.0.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Pull events from a JMS topic or queue."
-  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"
+  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         = ["Elasticsearch"]
   s.email           = 'info@elasticsearch.com'
   s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
@@ -20,10 +20,9 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 1.0"
-
-  s.add_runtime_dependency 'logstash-codec-json'
-  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-codec-json', '~> 3.0'
+  s.add_runtime_dependency 'logstash-codec-plain', '~> 3.0'
 
   if RUBY_PLATFORM == 'java'
     s.platform = RUBY_PLATFORM

metadata

@@ -1,57 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jms
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.0
 platform: java
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2017-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.99'
   name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   name: logstash-codec-json
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   name: logstash-codec-plain
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -80,7 +86,7 @@ dependencies:
     - - ">="
       - !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
+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@elasticsearch.com
 executables: []
 extensions: []