logstash-output-jms 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d86a4edf2e5572ad3d27982f750018be1dd9bb8
+  data.tar.gz: e3aea5a3055bc9217339df42de36d93e782c1f92
+SHA512:
+  metadata.gz: 1567060b1bbcf72d8e217827af12ef53e47d74d52f99c57fd97b3d9ea46f28405adcfc9a7f67c0be61cb133ca50dc9d79076378064250a576b899552f76f4cd3
+  data.tar.gz: 5315b0a25c649ed3ff90128bfb53e35207ee991bfdc1139a3ce24cd0a8460d31862176762dbfbf143e66222021c11001e327384b5a7582b7b841fdfba1ba2dcb

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/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 logstash-users@googlegroups.com mailing list.
+
+## 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/outputs/jms.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+
+# Write events to 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
+#     queue_name => "myqueue"
+#     yaml_file => "~/jms.yml"
+#     yaml_section => "mybroker"
+#   }
+#
+#
+class LogStash::Outputs::Jms < LogStash::Outputs::Base
+  config_name "jms"
+
+# Name of delivery mode to use
+# Options are "persistent" and "non_persistent" if not defined nothing will be passed.
+config :delivery_mode, :validate => :string, :default => nil
+
+# If pub-sub (topic) style should be used or not.
+# Mandatory
+config :pub_sub, :validate => :boolean, :default => false
+# Name of the destination queue or topic to use.
+# Mandatory
+config :destination, :validate => :string
+
+# 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)
+    @connection = JMS::Connection.new(@jms_config)
+    @session = @connection.create_session()
+
+    # Cache the producer since we should keep reusing this one.
+    destination_key = @pub_sub ? :topic_name : :queue_name
+    @producer = @session.create_producer(@session.create_destination(destination_key => @destination))
+
+    if !@delivery_mode.nil?
+      @producer.delivery_mode_sym = @deliver_mode
+    end
+  end # def register
+
+  def receive(event)
+      
+
+      begin
+        @producer.send(@session.message(event.to_json))
+      rescue => e
+        @logger.warn("Failed to send event to JMS", :event => event, :exception => e,
+                     :backtrace => e.backtrace)
+      end
+  end # def receive
+
+  def close
+    @producer.close()
+    @session.close()
+    @connection.close()
+  end
+end # class LogStash::Output::Jms

data/logstash-input-jms.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+
+	s.name            = 'logstash-output-jms'
+	s.version         = '2.0.1'
+	s.licenses        = ['Apache License (2.0)']
+	s.summary         = "Push events to 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" => "output" }
+
+	s.add_runtime_dependency "logstash-core", ">= 2.0.0.snapshot", "< 3.0.0"
+
+	s.add_runtime_dependency 'logstash-codec-plain'
+	s.add_runtime_dependency 'logstash-codec-json'
+
+  s.add_runtime_dependency "jruby-jms" #(Apache 2.0 license)
+	s.add_development_dependency 'logstash-devutils'
+end

data/spec/outputs/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/outputs/jms_spec.rb

@@ -0,0 +1,35 @@
+require "logstash/devutils/rspec/spec_helper"
+require 'logstash/outputs/jms'
+require 'jms'
+require 'json'
+
+def getYamlPath()
+  return File.join(File.dirname(__FILE__),"jms.yml")
+end
+
+describe "outputs/jms" do
+  let (:jms_config) {{'yaml_file' => getYamlPath(), 'yaml_section' => 'hornetq', 'destination' => 'ExampleQueue'}}
+  let (:event) { LogStash::Event.new({'message' => 'hello',
+                                      '@timestamp' => LogStash::Timestamp.now}) }
+
+  context 'when initializing' do
+    it "should register" do
+      output = LogStash::Plugin.lookup("output", "jms").new(jms_config)
+      expect {output.register}.to_not raise_error
+    end
+
+    it 'should populate jms config with default values' do
+      jms = LogStash::Outputs::Jms.new(jms_config)
+      expect(jms.pub_sub).to eq(false)
+    end
+  end
+
+  context 'when outputting messages' do
+    it 'should send logstash event to jms queue' do
+      jms = LogStash::Outputs::Jms.new(jms_config)
+      jms.register
+      jms.receive(event)
+      # Add code to check the message is correct on the queue.
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-jms
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+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-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: 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: 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/outputs/jms.rb
+- logstash-input-jms.gemspec
+- spec/outputs/jms.yml
+- spec/outputs/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: output
+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: Push events to a JMS topic or queue.
+test_files:
+- spec/outputs/jms.yml
+- spec/outputs/jms_spec.rb