logstash-input-jms 3.0.1-java → 3.0.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6731dcbca2cad4c3c7bc82bef2e9cb4290cbd3f5
-  data.tar.gz: 4cbcf52bb4bffa1ebb002975dce130d9e702ad56
+  metadata.gz: 538e55695a5feb8466d82128a3c0ba25ab29ca2a
+  data.tar.gz: b2d3063c325badf9d05aa7066305daf8d08b421d
 SHA512:
-  metadata.gz: 4de9741aa8a1ac46788eb89d467a497e85e1ebc7721f94af8abf49f69e2703270a4ed108395f3152483fb089063bf18a95e7a4f875b038ad049672956b7c96ab
-  data.tar.gz: a0010bcd6053fa19b509c4740483f8edd4db5f996788bb5e073cabb82957f1f8014a7ba47309200319fbb9b8e6e457ad652c29aba77f0a55af24a379b050d52e
+  metadata.gz: 9d8800e40a80b7a4b17babb6c0cb6c27d5224f0d047ececb3473ed9caed068c131164e3a73757a4af5c80a2e3d95dffdb4c629d63d247a9397667524f2074606
+  data.tar.gz: 4315879d002e4ffab5689f79b389d17fbc696ea542e3a147537b4e3f53451644027af53c9badef6641349c84e16952430b9ddbb6b34bdf1c987970caca7aaeeb

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
+
 gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/docs/index.asciidoc

@@ -0,0 +1,259 @@
+:plugin: jms
+:type: input
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}-{plugin}"]
+
+=== Jms input plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Read events from a Jms Broker. Supports both Jms Queues and Topics.
+
+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 to pull from a queue:
+ jms {
+    include_header => false
+    include_properties => false
+    include_body => true
+    use_jms_timestamp => false
+    interval => 10
+    destination => "myqueue"
+    pub-sub => false
+    yaml_file => "~/jms.yml"
+    yaml_section => "mybroker"
+  }
+
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Jms Input Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-broker_url>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-destination>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-factory>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-include_body>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-include_header>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-include_properties>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-jndi_context>> |<<hash,hash>>|No
+| <<plugins-{type}s-{plugin}-jndi_name>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-password>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-pub_sub>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-require_jars>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-runner>> |<<string,string>>, one of `["consumer", "async", "thread"]`|No
+| <<plugins-{type}s-{plugin}-selector>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-use_jms_timestamp>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-username>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-yaml_file>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-yaml_section>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+input plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-broker_url"]
+===== `broker_url` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Url to use when connecting to the JMS provider
+
+[id="plugins-{type}s-{plugin}-destination"]
+===== `destination` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Name of the destination queue or topic to use.
+
+[id="plugins-{type}s-{plugin}-factory"]
+===== `factory` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Name of JMS Provider Factory class
+
+[id="plugins-{type}s-{plugin}-include_body"]
+===== `include_body` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Include JMS Message Body in the event
+Supports TextMessage, MapMessage and ByteMessage
+If the JMS Message is a TextMessage or ByteMessage, then the value will be in the "message" field of the event
+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
+
+[id="plugins-{type}s-{plugin}-include_header"]
+===== `include_header` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+A JMS message has three parts :
+ Message Headers (required)
+ Message Properties (optional)
+ Message Bodies (optional)
+You can tell the input plugin which parts should be included in the event produced by Logstash
+
+Include JMS Message Header Field values in the event
+
+[id="plugins-{type}s-{plugin}-include_properties"]
+===== `include_properties` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Include JMS Message Properties Field values in the event
+
+[id="plugins-{type}s-{plugin}-interval"]
+===== `interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `10`
+
+Polling interval in seconds.
+This is the time sleeping between asks to a consumed Queue.
+This parameter has non influence in the case of a subcribed Topic.
+
+[id="plugins-{type}s-{plugin}-jndi_context"]
+===== `jndi_context` 
+
+  * Value type is <<hash,hash>>
+  * There is no default value for this setting.
+
+Mandatory if jndi lookup is being used,
+contains details on how to connect to JNDI server
+
+[id="plugins-{type}s-{plugin}-jndi_name"]
+===== `jndi_name` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Name of JNDI entry at which the Factory can be found
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Password to use when connecting to the JMS provider
+
+[id="plugins-{type}s-{plugin}-pub_sub"]
+===== `pub_sub` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+If pub-sub (topic) style should be used.
+
+[id="plugins-{type}s-{plugin}-require_jars"]
+===== `require_jars` 
+
+  * Value type is <<array,array>>
+  * There is no default value for this setting.
+
+If you do not use an yaml configuration use either the factory or jndi_name.
+An optional array of Jar file names to load for the specified
+JMS provider. By using this option it is not necessary
+to put all the JMS Provider specific jar files into the
+java CLASSPATH prior to starting Logstash.
+
+[id="plugins-{type}s-{plugin}-runner"]
+===== `runner` 
+
+  * Value can be any of: `consumer`, `async`, `thread`
+  * Default value is `"consumer"`
+
+Choose an implementation of the run block. Value can be either consumer, async or thread
+
+[id="plugins-{type}s-{plugin}-selector"]
+===== `selector` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Set the selector to use to get messages off the queue or topic
+
+[id="plugins-{type}s-{plugin}-threads"]
+===== `threads` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+
+
+[id="plugins-{type}s-{plugin}-timeout"]
+===== `timeout` 
+
+  * Value type is <<number,number>>
+  * Default value is `60`
+
+Initial connection timeout in seconds.
+
+[id="plugins-{type}s-{plugin}-use_jms_timestamp"]
+===== `use_jms_timestamp` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Convert the JMSTimestamp header field to the @timestamp value of the event
+
+[id="plugins-{type}s-{plugin}-username"]
+===== `username` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Username to connect to JMS provider with
+
+[id="plugins-{type}s-{plugin}-yaml_file"]
+===== `yaml_file` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Yaml config file
+
+[id="plugins-{type}s-{plugin}-yaml_section"]
+===== `yaml_section` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Yaml config file section name
+For some known examples, see: [Example jms.yml](https://github.com/reidmorrison/jruby-jms/blob/master/examples/jms.yml)
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/logstash-input-jms.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-jms'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   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/logstash-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 = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jms
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: java
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +110,7 @@ files:
 - Gemfile
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/inputs/jms.rb
 - logstash-input-jms.gemspec
 - spec/inputs/jms.yml
@@ -136,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.8
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Pull events from a JMS topic or queue.