logstash-output-rabbitmq 4.0.7-java → 4.0.8-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1865cf666ef2f3cb3ad389fa70283db7bbe488a0
-  data.tar.gz: 18d9c2981691d76476326ab515938cdfe1553251
+  metadata.gz: dbde233852ddfa02201c3fe3e2bc05326624ef90
+  data.tar.gz: 2e0c0a8f71af46d29f42121155f4c8bc05907d14
 SHA512:
-  metadata.gz: 0cc31b65bebd56a4aa01e47d4345a882543b67b4a5d096e6bc0fde137c65320d7c246df77716bf0fcd61c4b09aa4f91a94514859b264bf6d243498c6f3df7980
-  data.tar.gz: 06d8d367ed0c3895dec7b0fee73db568d2188cb0a465c6e37dbb5c8cf7c477922e2c943e9dd5057c61669d7d0789dec233e2695e6b6d4c32a4f368e85a04ab3c
+  metadata.gz: 804b03b245fa79881a8fc914df74c1207eee2e2a3cda923f0ff5d68db4e4e0e41804cee786576f7e6649bb67a401adf62f36713c7a2a392c61ebc1d94cd0a55b
+  data.tar.gz: 05b45722189c028e8afcf8103540e368956598a583a269d49e648d85ef93b6a9773fdecfcb18a789cf5500dd599817ee1f9df1bac69f5069caa067ef59eb9fc0

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.gemspec
 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,279 @@
+:plugin: rabbitmq
+:type: output
+
+///////////////////////////////////////////
+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}"]
+
+=== Rabbitmq output plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Push events to a RabbitMQ exchange. Requires RabbitMQ 2.x
+or later version (3.x is recommended).
+
+Relevant links:
+
+* http://www.rabbitmq.com/[RabbitMQ]
+* http://rubymarchhare.info[March Hare]
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Rabbitmq Output 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}-arguments>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-automatic_recovery>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-connect_retry_interval>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-connection_timeout>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-durable>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-exchange>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-exchange_type>> |<<string,string>>, one of `["fanout", "direct", "topic", "x-consistent-hash", "x-modulus-hash"]`|Yes
+| <<plugins-{type}s-{plugin}-heartbeat>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-key>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-passive>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
+| <<plugins-{type}s-{plugin}-persistent>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-ssl>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-ssl_certificate_password>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-ssl_certificate_path>> |a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-ssl_version>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
+| <<plugins-{type}s-{plugin}-vhost>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+output plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-arguments"]
+===== `arguments` 
+
+  * Value type is <<array,array>>
+  * Default value is `{}`
+
+Extra queue arguments as an array.
+To make a RabbitMQ queue mirrored, use: `{"x-ha-policy" => "all"}`
+
+[id="plugins-{type}s-{plugin}-automatic_recovery"]
+===== `automatic_recovery` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Set this to automatically recover from a broken connection. You almost certainly don't want to override this!!!
+
+[id="plugins-{type}s-{plugin}-connect_retry_interval"]
+===== `connect_retry_interval` 
+
+  * Value type is <<number,number>>
+  * Default value is `1`
+
+Time in seconds to wait before retrying a connection
+
+[id="plugins-{type}s-{plugin}-connection_timeout"]
+===== `connection_timeout` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+The default connection timeout in milliseconds. If not specified the timeout is infinite.
+
+[id="plugins-{type}s-{plugin}-debug"]
+===== `debug`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Enable or disable logging
+
+[id="plugins-{type}s-{plugin}-durable"]
+===== `durable` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Is this exchange durable? (aka; Should it survive a broker restart?)
+
+[id="plugins-{type}s-{plugin}-exchange"]
+===== `exchange` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The name of the exchange
+
+[id="plugins-{type}s-{plugin}-exchange_type"]
+===== `exchange_type` 
+
+  * This is a required setting.
+  * Value can be any of: `fanout`, `direct`, `topic`, `x-consistent-hash`, `x-modulus-hash`
+  * There is no default value for this setting.
+
+The exchange type (fanout, topic, direct)
+
+[id="plugins-{type}s-{plugin}-heartbeat"]
+===== `heartbeat` 
+
+  * Value type is <<number,number>>
+  * There is no default value for this setting.
+
+Heartbeat delay in seconds. If unspecified no heartbeats will be sent
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Common functionality for the rabbitmq input/output
+RabbitMQ server address(es)
+host can either be a single host, or a list of hosts
+i.e.
+  host => "localhost"
+or
+  host => ["host01", "host02]
+
+if multiple hosts are provided on the initial connection and any subsequent
+recovery attempts of the hosts is chosen at random and connected to.
+Note that only one host connection is active at a time.
+
+[id="plugins-{type}s-{plugin}-key"]
+===== `key` 
+
+  * Value type is <<string,string>>
+  * Default value is `"logstash"`
+
+The default codec for this plugin is JSON. You can override this to suit your particular needs however.
+Key to route to by default. Defaults to 'logstash'
+
+* Routing keys are ignored on fanout exchanges.
+
+[id="plugins-{type}s-{plugin}-passive"]
+===== `passive` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `false`
+
+Passive queue creation? Useful for checking queue existance without modifying server state
+
+[id="plugins-{type}s-{plugin}-password"]
+===== `password` 
+
+  * Value type is <<password,password>>
+  * Default value is `"guest"`
+
+RabbitMQ password
+
+[id="plugins-{type}s-{plugin}-persistent"]
+===== `persistent` 
+
+  * Value type is <<boolean,boolean>>
+  * Default value is `true`
+
+Should RabbitMQ persist messages to disk?
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port` 
+
+  * Value type is <<number,number>>
+  * Default value is `5672`
+
+RabbitMQ port to connect on
+
+[id="plugins-{type}s-{plugin}-ssl"]
+===== `ssl` 
+
+  * Value type is <<boolean,boolean>>
+  * There is no default value for this setting.
+
+Enable or disable SSL.
+Note that by default remote certificate verification is off.
+Specify ssl_certificate_path and ssl_certificate_password if you need
+certificate verification
+
+[id="plugins-{type}s-{plugin}-ssl_certificate_password"]
+===== `ssl_certificate_password` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certificate_path
+
+[id="plugins-{type}s-{plugin}-ssl_certificate_path"]
+===== `ssl_certificate_path` 
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote host
+
+[id="plugins-{type}s-{plugin}-ssl_version"]
+===== `ssl_version` 
+
+  * Value type is <<string,string>>
+  * Default value is `"TLSv1.2"`
+
+Version of the SSL protocol to use.
+
+[id="plugins-{type}s-{plugin}-tls_certificate_password"]
+===== `tls_certificate_password`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+TLS certificate password
+
+[id="plugins-{type}s-{plugin}-tls_certificate_path"]
+===== `tls_certificate_path`  (DEPRECATED)
+
+  * DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+TLS certifcate path
+
+[id="plugins-{type}s-{plugin}-user"]
+===== `user` 
+
+  * Value type is <<string,string>>
+  * Default value is `"guest"`
+
+RabbitMQ username
+
+[id="plugins-{type}s-{plugin}-vhost"]
+===== `vhost` 
+
+  * Value type is <<string,string>>
+  * Default value is `"/"`
+
+The vhost (virtual host) to use. If you don't know what this
+is, leave the default. With the exception of the default
+vhost ("/"), names of vhosts should not begin with a forward
+slash.
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/outputs/rabbitmq.rb

@@ -1,6 +1,8 @@
 # encoding: UTF-8
 require "logstash/pipeline"
 require "logstash/plugin_mixins/rabbitmq_connection"
+java_import java.util.concurrent.TimeoutException
+java_import com.rabbitmq.client.AlreadyClosedException
 
 # Push events to a RabbitMQ exchange. Requires RabbitMQ 2.x
 # or later version (3.x is recommended).
@@ -52,7 +54,7 @@ module LogStash
       def publish(event, message)
         raise ArgumentError, "No exchange set in HareInfo!!!" unless @hare_info.exchange
         @hare_info.exchange.publish(message, :routing_key => event.sprintf(@key), :properties => { :persistent => @persistent })
-      rescue MarchHare::Exception, IOError, com.rabbitmq.client.AlreadyClosedException => e
+      rescue MarchHare::Exception, IOError, AlreadyClosedException, TimeoutException => e
         @logger.error("Error while publishing. Will retry.",
                       :message => e.message,
                       :exception => e.class,

data/logstash-output-rabbitmq.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-output-rabbitmq'
-  s.version         = '4.0.7'
+  s.version         = '4.0.8'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Push events to a RabbitMQ exchange"
   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"
@@ -10,7 +10,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)/})

data/spec/outputs/rabbitmq_spec.rb

@@ -2,6 +2,7 @@
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/pipeline"
 require "logstash/outputs/rabbitmq"
+java_import java.util.concurrent.TimeoutException
 
 describe LogStash::Outputs::RabbitMQ do
   let(:klass) { LogStash::Outputs::RabbitMQ }
@@ -24,6 +25,25 @@ describe LogStash::Outputs::RabbitMQ do
   let(:instance) { klass.new(rabbitmq_settings) }
   let(:hare_info) { instance.instance_variable_get(:@hare_info) }
 
+  shared_examples 'recovers from exception gracefully' do
+    it 'should execute publish twice due to a retry' do
+      expect(exchange).to have_received(:publish).twice
+    end
+
+    it 'should sleep for the retry' do
+      expect(instance).to have_received(:sleep_for_retry).once
+    end
+
+    it 'should send the correct message (twice)' do
+      expect(exchange).to have_received(:publish).with(encoded_event, anything).twice
+    end
+
+    it 'should send the correct metadata (twice)' do
+      expected_metadata = {:routing_key => event.sprintf(key), :properties => {:persistent => persistent }}
+      expect(exchange).to have_received(:publish).with(anything, expected_metadata).twice
+    end
+  end
+
   it "should register as an output plugin" do
     expect(LogStash::Plugin.lookup("output", "rabbitmq")).to eql(LogStash::Outputs::RabbitMQ)
   end
@@ -76,35 +96,34 @@ describe LogStash::Outputs::RabbitMQ do
         end
       end
 
-      context "when a MarchHare::Exception is encountered" do
+      context 'when an exception is encountered' do
+        let(:exception) { nil }
+
         before do
           i = 0
           allow(instance).to receive(:connect!)
           allow(instance).to receive(:sleep_for_retry)
           allow(exchange).to receive(:publish).with(any_args) do
             i += 1
-            raise(MarchHare::Exception, "foo") if i == 1
+            raise exception if i == 1
           end
 
           instance.send(:publish, event, encoded_event)
         end
 
-        it "should execute publish twice due to a retry" do
-          expect(exchange).to have_received(:publish).twice
+        context 'when it is a MarchHare exception' do
+          let(:exception) { MarchHare::Exception }
+          it_behaves_like 'recovers from exception gracefully'
         end
 
-        it "should sleep for the retry" do
-          expect(instance).to have_received(:sleep_for_retry).once
+        context 'when it is a MarchHare::ChannelAlreadyClosed' do
+          let(:exception) { MarchHare::ChannelAlreadyClosed }
+          it_behaves_like 'recovers from exception gracefully'
         end
 
-        it "should send the correct message (twice)" do
-          expect(exchange).to have_received(:publish).with(encoded_event, anything).twice
-        end
-
-        it "should send the correct metadata (twice)" do
-          expected_metadata = {:routing_key => event.sprintf(key), :properties => {:persistent => persistent }}
-
-          expect(exchange).to have_received(:publish).with(anything, expected_metadata).twice
+        context 'when it is a TimeoutException' do
+          let(:exception) { TimeoutException.new }
+          it_behaves_like 'recovers from exception gracefully'
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-rabbitmq
 version: !ruby/object:Gem::Version
-  version: 4.0.7
+  version: 4.0.8
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +104,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/outputs/rabbitmq.rb
 - logstash-output-rabbitmq.gemspec
 - spec/outputs/rabbitmq_spec.rb