logstash-input-jms 2.0.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfbf32ba96211fade087827f1e3832eaf1f7b650
+  data.tar.gz: ebc1dc1b98c094bb53888256e117797ec287be4e
+SHA512:
+  metadata.gz: a9e72638775b4480357628ce479d349f7496b156b9aac4a52d1981264cdcc30f446d81394ea2099ed410f4c24705fecb97f3247226421e6f1b3390bf28f00d62
+  data.tar.gz: 59ed87fbb9f77704eb68eec7ab61dfe18462f4a3a1157e631edad60d5e183cd402e08d36b2caac668eec6e8db4de0866758f1413f217cbca4846dd752f154186

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

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

@@ -0,0 +1,95 @@
+# Logstash Plugin
+
+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.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/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+```sh
+bundle exec rspec
+```
+
+The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
+```
+To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
+```ruby
+gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
+```
+```ruby
+gem "logstash", :path => "/your/local/logstash"
+```
+
+Then update your dependencies and run your tests:
+
+```sh
+bundle install
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Update Logstash dependencies
+```sh
+rake vendor:gems
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to me that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/jms.rb

@@ -0,0 +1,269 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/inputs/threadable"
+require "logstash/namespace"
+
+# 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 :
+#  jms {
+#     include_header => false
+#     include_properties => false
+#     include_body => true
+#     use_jms_timestamp => false
+#     interval => 10
+#     queue_name => "myqueue"
+#     yaml_file => "~/jms.yml"
+#     yaml_section => "mybroker"
+#   }
+#
+#
+class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
+  config_name "jms"
+
+  # 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
+  config :include_header, :validate => :boolean, :default => true
+  # Include JMS Message Properties Field values in the event
+  config :include_properties, :validate => :boolean, :default => 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
+  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
+  config :runner, :validate => [ "consumer", "async", "thread" ], :default => "consumer"
+
+  # Set the selector to use to get messages off the queue or topic
+  config :selector, :validate => :string
+
+  # Initial connection timeout in seconds.
+  config :timeout, :validate => :number, :default => 60
+
+  # 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.
+  config :interval, :validate => :number, :default => 10
+
+  # If pub-sub (topic) style should be used or not.
+  config :pub_sub, :validate => :boolean, :default => false
+
+  # Name of the destination queue or topic to use.
+  config :destination, :validate => :string, :required => true
+
+  # Yaml config file
+  config :yaml_file, :validate => :string
+  # Yaml config file section name
+  # For some known examples, see: [Example jms.yml](https://github.com/reidmorrison/jruby-jms/blob/master/examples/jms.yml)
+  config :yaml_section, :validate => :string
+
+  # 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.
+  config :require_jars, :validate => :array
+
+  # Name of JMS Provider Factory class
+  config :factory, :validate => :string
+  # Username to connect to JMS provider with
+  config :username, :validate => :string
+  # Password to use when connecting to the JMS provider
+  config :password, :validate => :string
+  # Url to use when connecting to the JMS provider
+  config :broker_url, :validate => :string
+
+  # Name of JNDI entry at which the Factory can be found
+  config :jndi_name, :validate => :string
+  # Mandatory if jndi lookup is being used,
+  # contains details on how to connect to JNDI server
+  config :jndi_context, :validate => :hash
+
+  # :yaml_file, :factory and :jndi_name are mutually exclusive, both cannot be supplied at the
+  # same time. The priority order is :yaml_file, then :jndi_name, then :factory
+  #
+  # JMS Provider specific properties can be set if the JMS Factory itself
+  # has setters for those properties.
+  #
+  # For some known examples, see: [Example jms.yml](https://github.com/reidmorrison/jruby-jms/blob/master/examples/jms.yml)
+
+  public
+  def register
+    require "jms"
+    @connection = nil
+
+    if @yaml_file
+      @jms_config = YAML.load_file(@yaml_file)[@yaml_section]
+
+    elsif @jndi_name
+      @jms_config = {
+        :require_jars => @require_jars,
+        :jndi_name => @jndi_name,
+        :jndi_context => @jndi_context}
+
+    elsif @factory
+      @jms_config = {
+        :require_jars => @require_jars,
+        :factory => @factory,
+        :username => @username,
+        :password => @password,
+        :broker_url => @broker_url,
+        :url => @broker_url # "broker_url" is named "url" with Oracle AQ
+      }
+    end
+
+    @logger.debug("JMS Config being used", :context => @jms_config)
+
+  end # def register
+
+
+  private
+  def queue_event(msg, output_queue)
+    begin
+      if @include_body
+        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 ?
+          end
+        elsif msg.java_kind_of?(JMS::TextMessage) || msg.java_kind_of?(JMS::BytesMessage)
+          @codec.decode(msg.to_s) do |event_message|
+            event = event_message
+          end
+        else
+          @logger.error( "Unknown data type #{msg.data.class.to_s} in Message" )
+        end
+      end
+
+      event ||= LogStash::Event.new
+
+      # 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)
+      end
+
+      if @include_header
+        msg.attributes.each do |field, value|
+          event[field.to_s] = value
+        end
+      end
+
+      if @include_properties
+        msg.properties.each do |field, value|
+          event[field.to_s] = value
+        end
+      end
+
+      decorate(event)
+      output_queue << event
+
+    rescue => e # parse or event creation error
+      @logger.error("Failed to create event", :message => msg, :exception => e,
+                    :backtrace => e.backtrace);
+    end
+  end
+
+  # Consume all available messages on the queue
+  # sleeps some time, then consume again
+  private
+  def run_consumer(output_queue)
+    JMS::Connection.session(@jms_config) do |session|
+      destination_key = @pub_sub ? :topic_name : :queue_name
+      while(true)
+        session.consume(destination_key => @destination, :timeout=>@timeout, :selector => @selector) do |message|
+          queue_event message, output_queue
+        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
+
+  # Consume all available messages on the queue through a listener
+  private
+  def run_thread(output_queue)
+    connection = JMS::Connection.new(@jms_config)
+    connection.on_exception do |jms_exception|
+      @logger.warn("JMS Exception has occurred: #{jms_exception}")
+    end
+
+    destination_key = @pub_sub ? :topic_name : :queue_name
+    connection.on_message(destination_key => @destination, :selector => @selector) do |message|
+      queue_event message, output_queue
+    end
+    connection.start
+    while(true)
+      @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
+
+
+
+  # Consume all available messages on the queue through a listener
+  private
+  def run_async(output_queue)
+    JMS::Connection.start(@jms_config) do |connection|
+      # Define exception listener
+      # The problem here is that we do not handle any exception
+      connection.on_exception do |jms_exception|
+        @logger.warn("JMS Exception has occurred: #{jms_exception}")
+        raise jms_exception
+      end
+      # Define Asynchronous code block to be called every time a message is received
+      destination_key = @pub_sub ? :topic_name : :queue_name
+      connection.on_message(destination_key => @destination, :selector => @selector) do |message|
+        queue_event message, output_queue
+      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)
+        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
+
+
+  public
+  def run(output_queue)
+    case @runner
+    when "consumer" then
+      run_consumer(output_queue)
+    when "async" then
+      run_async(output_queue)
+    when "thread" then
+      run_thread(output_queue)
+    end
+  end # def run
+
+end # class LogStash::Inputs::Jms

data/logstash-input-jms.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-input-jms'
+  s.version         = '2.0.1'
+  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.authors         = ["Elasticsearch"]
+  s.email           = 'info@elasticsearch.com'
+  s.homepage        = "http://www.elasticsearch.org/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", ">= 2.0.0.snapshot", "< 3.0.0"
+
+  s.add_runtime_dependency 'logstash-codec-json'
+  s.add_runtime_dependency 'logstash-codec-plain'
+
+  if RUBY_PLATFORM == 'java'
+    s.platform = RUBY_PLATFORM
+    s.add_runtime_dependency "jruby-jms" #(Apache 2.0 license)
+  end
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/inputs/jms.yml

@@ -0,0 +1,18 @@
+---
+# HornetQ Broker
+hornetq:
+  # Connect to a local HornetQ Broker using JNDI
+  :jndi_name: /ConnectionFactory
+  :jndi_context:
+    java.naming.factory.initial: org.jnp.interfaces.NamingContextFactory
+    java.naming.provider.url: jnp://localhost:1099
+    java.naming.factory.url.pkgs: org.jboss.naming:org.jnp.interfaces
+    java.naming.security.principal: guest
+    java.naming.security.credentials: guest
+  :require_jars:
+    - /Applications/hornetq-2.4.0.Final/lib/hornetq-commons.jar
+    - /Applications/hornetq-2.4.0.Final/lib/hornetq-core-client.jar
+    - /Applications/hornetq-2.4.0.Final/lib/hornetq-jms-client.jar
+    - /Applications/hornetq-2.4.0.Final/lib/jboss-jms-api.jar
+    - /Applications/hornetq-2.4.0.Final/lib/jnp-client.jar
+    - /Applications/hornetq-2.4.0.Final/lib/netty.jar

data/spec/inputs/jms_spec.rb

@@ -0,0 +1,30 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/jms"
+require "jms"
+
+describe LogStash::Inputs::Jms do
+  let(:queue) { Queue.new }
+  let(:jms_config) {{:require_jars => ["some.jar"],  :jndi_name => "", :jndi_context => {}}}
+  let(:config) do
+    config = { "destination" => "ExampleQueue" }
+    jms_config.each {|k, v| config[k.to_s] = v }
+    config
+  end
+  subject { LogStash::Inputs::Jms.new(config.dup) }
+
+  context "using default runner (consumer)" do
+    before :each do
+      subject.register
+    end
+
+    it "should call the consumer runner" do
+      expect(subject).to receive(:run_consumer).with(queue)
+      subject.run(queue)
+    end
+
+    it "should create a JMS session based on JMS config" do
+      expect(JMS::Connection).to receive(:session).with(jms_config)
+      subject.run(queue)
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-jms
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: java
+authors:
+- Elasticsearch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.snapshot
+    - - <
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        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: logstash-codec-json
+  prerelease: false
+  type: :runtime
+  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: :runtime
+  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: jruby-jms
+  prerelease: false
+  type: :runtime
+  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
+  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@elasticsearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- NOTICE.TXT
+- README.md
+- lib/logstash/inputs/jms.rb
+- logstash-input-jms.gemspec
+- spec/inputs/jms.yml
+- spec/inputs/jms_spec.rb
+homepage: http://www.elasticsearch.org/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Pull events from a JMS topic or queue.
+test_files:
+- spec/inputs/jms.yml
+- spec/inputs/jms_spec.rb