logstash-integration-rabbitmq 7.0.3-java → 7.1.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6997aa19019326916e120623107352d7ba274e8370312017561cb4fae3a2e064
-  data.tar.gz: 3fc3f9aff8d9700f233392a7311637f0b78d26c66681d8e83f1b52e991285c72
+  metadata.gz: 9c1e05393387b83c218237946d3db74ead4bf025c6511b8e570c5ed0eefa4b93
+  data.tar.gz: e6999db3c7f8e2398b21e0744a7a24da9bf2d5219a35c6c86fcbd02c7d3f47da
 SHA512:
-  metadata.gz: 5c0265553a26b422764bd45d9f3e0599d39f391f98a2effcc20a171f30b4219869d831cb54519142dc4ee8b4a3aabf47135548e4e69d327fc780f80a0fe766ac
-  data.tar.gz: 28255006283a7f813b7336732bd99e0c5c32a27e53f3464cc2686ab514895c4cf5cbe772245ace33c564277115ffac64ff4c864c70c8eeabdb95224278f24b6b
+  metadata.gz: 90b33bd2d1e1fa18f7ec4a6366cf6ae6dc1d5d705065687df0c3b65bc1fb0b297f04cf9dca152df1af0fd227aeb5d46af674a605ab021e41d65eacfe601ae7bd
+  data.tar.gz: 6df53fd963c003e02c6d20bbfdc839c5cfe63738fbe03ae09109b3f2d2b4322a4a9a2df098b5e9331f8ea7239625840b5d463599c0a79d2aa274288d4a115f23

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 7.1.0
+  - Added support in Output plugin for `sprintf` templates in values provided to `message_properties` ([#8](https://github.com/logstash-plugins/logstash-integration-rabbitmq/issues/8))
+  - Added support for _extended_ metadata including raw payload to events generated by the Input Plugin [#13](https://github.com/logstash-plugins/logstash-integration-rabbitmq/issues/13)
+  - Fixes an issue with custom port assignment, in which the custom port was not being applied when more than one host was supplied [#12](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/12)
+  - Fixes bug where attempting to read from undeclared exchange resulted in infinite retry loop ([#10](https://github.com/logstash-plugins/logstash-integration-rabbitmq/issues/10))
+  - Fixes bug where failing to establish initial connection resulted in a pipeline that refused to shut down ([#11](https://github.com/logstash-plugins/logstash-integration-rabbitmq/issues/11))
+
 ## 7.0.3
   - Refactor: scope (and remove unused) java imports [#29](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/29)
 

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/docs/input-rabbitmq.asciidoc

@@ -34,7 +34,7 @@ and other parts of the RabbitMQ documentation are useful for deeper
 understanding.
 
 The properties of messages received will be stored in the
-`[@metadata][rabbitmq_properties]` field if the `@metadata_enabled` setting is checked.
+`[@metadata][rabbitmq_properties]` field if the `@metadata_enabled` setting is enabled.
 Note that storing metadata may degrade performance.
 The following properties may be available (in most cases dependent on whether
 they were set by the sender):
@@ -187,6 +187,8 @@ The default connection timeout in milliseconds. If not specified the timeout is
   * Default value is `false`
 
 Is this queue durable? (aka; Should it survive a broker restart?)
+If consuming directly from a queue you must set this value to match the existing queue setting,
+otherwise the connection will fail due to an inequivalent arg error.
 
 [id="plugins-{type}s-{plugin}-exchange"]
 ===== `exchange`
@@ -259,8 +261,14 @@ This is only relevant for direct or topic exchanges.
 [id="plugins-{type}s-{plugin}-metadata_enabled"]
 ===== `metadata_enabled`
 
-  * Value type is <<boolean,boolean>>
-  * Default value is `false`
+  * Value type is <<string,string>>
+  * Accepted values are:
+    - `none`: no metadata is added
+    - `basic`: headers and properties are added
+    - `extended`: headers, properties, and raw payload are added
+    - `false`: deprecated alias for `none`
+    - `true`: deprecated alias for `basic`
+  * Default value is `none`
 
 Enable the storage of message headers and properties in `@metadata`. This may impact performance
 

data/docs/output-rabbitmq.asciidoc

@@ -168,7 +168,8 @@ Key to route to by default. Defaults to 'logstash'
   * Value type is <<hash,hash>>
   * Default value is `{}`
 
-Add properties to be set per-message here, such as 'content_type', 'priority'
+Add properties to be set per-message here, such as 'content_type', 'priority'.
+Values can be {logstash-ref}/event-dependent-configuration.html#sprintf[`sprintf` templates], whose value for each message will be populated from the event.
 
 Example:
 [source,ruby]

data/lib/logstash/inputs/rabbitmq.rb

@@ -166,16 +166,26 @@ module LogStash
       config :subscription_retry_interval_seconds, :validate => :number, :required => true, :default => 5
 
       # Enable the storage of message headers and properties in `@metadata`. This may impact performance
-      config :metadata_enabled, :validate => :boolean, :default => false
+      config :metadata_enabled, :validate => %w(none basic extended false true), :default => "none"
 
       def register
         @internal_queue = java.util.concurrent.ArrayBlockingQueue.new(@prefetch_count*2)
+        @metadata_level = extract_metadata_level(@metadata_enabled)
       end
 
+      attr_reader :metadata_level
+
       def run(output_queue)
         setup!
         @output_queue = output_queue
         consume!
+      rescue => e
+        raise unless stop?
+
+        logger.warn("Ignoring exception thrown during plugin shutdown",
+                    :message  => e.message,
+                    :class    => e.class.name,
+                    :location => e.backtrace.first)
       end
 
       def setup!
@@ -184,14 +194,32 @@ module LogStash
         bind_exchange!
         @hare_info.channel.prefetch = @prefetch_count
       rescue => e
+        # when encountering an exception during shut-down,
+        # re-raise the exception instead of retrying
+        raise if stop?
+
+        reset!
+
         @logger.warn("Error while setting up connection for rabbitmq input! Will retry.",
-                     :message => e.message,
-                     :class => e.class.name,
+                     :message  => e.message,
+                     :class    => e.class.name,
                      :location => e.backtrace.first)
         sleep_for_retry
         retry
       end
 
+      # reset a partially-established connection, enabling subsequent
+      # call to `RabbitMQ#setup!` to succeed.
+      #
+      # @api private
+      def reset!
+        @hare_info.connection && @hare_info.connection.close
+      rescue => e
+        @logger.debug("Exception while resetting connection", :exception => e.message, :backtrace => e.backtrace)
+      ensure
+        @hare_info = nil
+      end
+
       def bind_exchange!
         if @exchange
           if @exchange_type # Only declare the exchange if @exchange_type is set!
@@ -250,12 +278,11 @@ module LogStash
 
           metadata, data = payload
           @codec.decode(data) do |event|
-            decorate(event)
-            if @metadata_enabled
-              event.set("[@metadata][rabbitmq_headers]", get_headers(metadata))
-              event.set("[@metadata][rabbitmq_properties]", get_properties(metadata))
+            if event
+              decorate(event, metadata, data)
+
+              @output_queue << event
             end
-            @output_queue << event if event
           end
 
           i += 1
@@ -270,6 +297,16 @@ module LogStash
         end
       end
 
+      def decorate(event, metadata, data)
+        super(event)
+
+        event.set("[@metadata][rabbitmq_headers]", get_headers(metadata))       if metadata_level.include?(:headers)
+        event.set("[@metadata][rabbitmq_properties]", get_properties(metadata)) if metadata_level.include?(:properties)
+        event.set("[@metadata][rabbitmq_payload]", data)                        if metadata_level.include?(:payload) && !data.nil?
+
+        nil
+      end
+
       def stop
         @internal_queue.put(INTERNAL_QUEUE_POISON)
         shutdown_consumer
@@ -311,6 +348,28 @@ module LogStash
           acc
         end
       end
+
+      METADATA_NONE     = Set[].freeze
+      METADATA_BASIC    = Set[:headers,:properties].freeze
+      METADATA_EXTENDED = Set[:headers,:properties,:payload].freeze
+      METADATA_DEPRECATION_MAP = { 'true' => 'basic', 'false' => 'none' }
+
+      private
+      def extract_metadata_level(metadata_enabled_setting)
+        metadata_enabled = metadata_enabled_setting
+
+        if METADATA_DEPRECATION_MAP.include?(metadata_enabled)
+          canonical_value = METADATA_DEPRECATION_MAP[metadata_enabled]
+          logger.warn("Deprecated value `#{metadata_enabled_setting}` for `metadata_enabled` option; use `#{canonical_value}` instead.")
+          metadata_enabled = canonical_value
+        end
+
+        case metadata_enabled
+        when 'none'     then METADATA_NONE
+        when 'basic'    then METADATA_BASIC
+        when 'extended' then METADATA_EXTENDED
+        end
+      end
     end
   end
 end

data/lib/logstash/outputs/rabbitmq.rb

@@ -48,6 +48,8 @@ module LogStash
       config :message_properties, :validate => :hash, :default => {}
 
       def register
+        @message_properties_template = MessagePropertiesTemplate.new(symbolize(@message_properties).merge(:persistent => @persistent))
+
         connect!
         @hare_info.exchange = declare_exchange!(@hare_info.channel, @exchange, @exchange_type, @durable)
         # The connection close should close all channels, so it is safe to store thread locals here without closing them
@@ -69,8 +71,10 @@ module LogStash
 
       def publish(event, message)
         raise ArgumentError, "No exchange set in HareInfo!!!" unless @hare_info.exchange
+        routing_key = event.sprintf(@key)
+        message_properties = @message_properties_template.build(event)
         @gated_executor.execute do
-          local_exchange.publish(message, :routing_key => event.sprintf(@key), :properties => symbolize(@message_properties.merge(:persistent => @persistent)))
+          local_exchange.publish(message, :routing_key => routing_key, :properties => message_properties)
         end
       rescue MarchHare::Exception, IOError, AlreadyClosedException, TimeoutException => e
         @logger.error("Error while publishing. Will retry.",
@@ -128,6 +132,64 @@ module LogStash
           end
         end
       end
+
+      ##
+      # A `MessagePropertiesTemplate` efficiently produces per-event message properties from the
+      # provided template Hash.
+      #
+      # In order to efficiently reuse constant-value objects, returned values may be frozen.
+      class MessagePropertiesTemplate
+        ##
+        # Creates a new `MessagePropertiesTemplate` from the provided `template`
+        # @param template [Hash{Symbol=>Object}]
+        def initialize(template)
+          constant_properties = template.reject { |_,v| templated?(v) }
+          variable_properties = template.select { |_,v| templated?(v) }
+
+          @constant_properties = normalize(constant_properties).freeze
+          @variable_properties = variable_properties
+        end
+
+        ##
+        # Builds a property mapping for the given `event`, including templated values.
+        #
+        # @param event [LogStash::Event]: the event with which to populated templated values, if any.
+        # @return [Hash{Symbol=>Object}] a possibly-frozen properties hash for the provided `event`.
+        def build(event)
+          return @constant_properties if @variable_properties.empty?
+
+          properties = @variable_properties.each_with_object(@constant_properties.dup) do |(k,v), memo|
+            memo.store(k, event.sprintf(v))
+          end
+
+          return normalize(properties)
+        end
+
+        private
+
+        ##
+        # Normalize the provided property mapping with respect to the value types the underlying
+        # client expects.
+        #
+        # @api private
+        # @param properties [Hash{Symbol=>Object}]: a possibly-frozen Hash whose values may need type-coercion.
+        # @return [Hash{Symbol=>Object}]
+        def normalize(properties)
+          if properties[:priority] && properties[:priority].kind_of?(String)
+            properties = properties.merge(:priority => properties[:priority].to_i)
+          end
+
+          properties
+        end
+
+        ##
+        # @api private
+        # @param [Object]: an object, which may or may not be a template `String`
+        # @return [Boolean]: returns `true` IFF `value` is a template `String`
+        def templated?(value)
+          value.kind_of?(String) && value.include?('%{')
+        end
+      end
     end
   end
 end

data/lib/logstash/plugin_mixins/rabbitmq_connection.rb

@@ -104,10 +104,10 @@ module LogStash
       def rabbitmq_settings
         return @rabbitmq_settings if @rabbitmq_settings
 
+
         s = {
           :vhost => @vhost,
-          :hosts => @host,
-          :port  => @port,
+          :addresses => addresses_from_hosts_and_port(@host, @port),
           :user  => @user,
           :automatic_recovery => @automatic_recovery,
           :pass => @password ? @password.value : "guest",
@@ -133,6 +133,11 @@ module LogStash
         @rabbitmq_settings = s
       end
 
+      def addresses_from_hosts_and_port(hosts, port)
+        hosts.map {|host| host.include?(':') ? host : "#{host}:#{port}"}
+      end
+
+
       def connect!
         @hare_info = connect() unless @hare_info # Don't duplicate the conn!
       rescue MarchHare::Exception, java.io.IOException => e

data/logstash-integration-rabbitmq.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name            = 'logstash-integration-rabbitmq'
-  s.version         = '7.0.3'
+  s.version         = '7.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Integration with RabbitMQ - input and output plugins"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline "+

data/spec/inputs/rabbitmq_spec.rb

@@ -21,8 +21,13 @@ describe LogStash::Inputs::RabbitMQ do
       "prefetch_count" => 123
     }
   }
-  let(:instance) { klass.new(rabbitmq_settings) }
+  subject(:instance) { klass.new(rabbitmq_settings) }
   let(:hare_info) { instance.instance_variable_get(:@hare_info) }
+  let(:instance_logger) { double("Logger").as_null_object }
+
+  before do
+    allow_any_instance_of(klass).to receive(:logger).and_return(instance_logger)
+  end
 
   context "when connected" do
     let(:connection) { double("MarchHare Connection") }
@@ -39,6 +44,7 @@ describe LogStash::Inputs::RabbitMQ do
       allow(connection).to receive(:on_shutdown)
       allow(connection).to receive(:on_blocked)
       allow(connection).to receive(:on_unblocked)
+      allow(connection).to receive(:close)
       allow(channel).to receive(:exchange).and_return(exchange)
       allow(channel).to receive(:queue).and_return(queue)
       allow(channel).to receive(:prefetch=)
@@ -127,6 +133,187 @@ describe LogStash::Inputs::RabbitMQ do
       end
     end
   end
+
+  context '#register' do
+    let(:rabbitmq_settings) { super().merge(metadata_enabled_override) }
+    let(:metadata_enabled_override) { { "metadata_enabled" => metadata_enabled } }
+    before do
+      instance.register
+    end
+
+    shared_examples('`metadata_enabled => none`') do
+      context 'metadata_level' do
+        subject(:metadata_level) { instance.metadata_level }
+        it { is_expected.to be_empty }
+        it { is_expected.to be_frozen }
+      end
+    end
+
+    shared_examples('`metadata_enabled => basic`') do
+      context 'metadata_level' do
+        subject(:metadata_level) { instance.metadata_level }
+        it { is_expected.to include :headers }
+        it { is_expected.to include :properties }
+        it { is_expected.to_not include :payload }
+        it { is_expected.to be_frozen }
+      end
+    end
+
+    shared_examples("deprecated `metadata_enabled` setting") do |deprecated_value|
+      context 'the logger' do
+        subject(:logger) { instance_logger }
+        it 'receives a useful deprecation warning' do
+          expect(logger).to have_received(:warn).with(/Deprecated value `#{Regexp.escape(deprecated_value)}`/)
+        end
+      end
+    end
+
+    context 'when `metadata_enabled` is `true`' do
+      let(:metadata_enabled) { "true" }
+      it_behaves_like '`metadata_enabled => basic`'
+      include_examples "deprecated `metadata_enabled` setting", "true"
+    end
+
+    context 'when `metadata_enabled` is `false`' do
+      let(:metadata_enabled) { "false" }
+      it_behaves_like '`metadata_enabled => none`'
+      include_examples "deprecated `metadata_enabled` setting", "false"
+    end
+
+    context 'when `metadata_enabled` is not provided' do
+      let(:metadata_enabled_override) { Hash.new }
+      it_behaves_like '`metadata_enabled => none`'
+    end
+
+    context 'when `metadata_enabled` is `basic`' do
+      let(:metadata_enabled) { "basic" }
+      include_examples '`metadata_enabled => basic`'
+    end
+
+    context 'when `metadata_enabled` is `none`' do
+      let(:metadata_enabled) { "none" }
+      include_examples '`metadata_enabled => none`'
+    end
+
+    context 'when `metadata_enabled` is `extended`' do
+      let(:metadata_enabled) { "extended" }
+      context 'metadata_level' do
+        subject(:metadata_level) { instance.metadata_level }
+        it { is_expected.to include :headers }
+        it { is_expected.to include :properties }
+        it { is_expected.to include :payload }
+        it { is_expected.to be_frozen }
+      end
+    end
+  end
+
+  describe "#decorate(event, metadata, data)" do
+    let(:rabbitmq_settings) do
+      super().merge("metadata_enabled" => metadata_enabled)
+    end
+    before(:each) { instance.register }
+
+    let(:metadata) { double("METADATA") }
+    let(:headers) { Hash("header_key"=>"header_value") }
+    let(:properties) { Hash("property_key"=>"property_value") }
+
+    let(:data) { %Q({"message"=>"fubar"}\n) }
+
+    before do
+      allow(instance).to receive(:get_headers).with(metadata).and_return(headers)
+      allow(instance).to receive(:get_properties).with(metadata).and_return(properties)
+    end
+
+    describe 'the decorated event' do
+      subject(:decorated_event) do
+        LogStash::Event.new("message"=>"fubar").tap do |e|
+          instance.decorate(e, metadata, data)
+        end
+      end
+
+      matcher :include_field do |fieldref|
+        match do |event|
+          # setting `@actual` makes failure messages clearer
+          @actual = event.to_hash_with_metadata
+
+          break false unless event.include?(fieldref)
+          break true unless @specific_value
+
+          values_match?(@expected_value, event.get(fieldref))
+        end
+        chain :with_value do |expected_value|
+          @specific_value = true
+          @expected_value = expected_value
+        end
+        description do
+          desc = "include field `#{fieldref}`"
+          desc += " with value matching `#{@expected_value.inspect}`" if @specific_value
+          desc
+        end
+      end
+
+      shared_examples('core decoration features') do
+        let(:rabbitmq_settings) do
+          super().merge("type" => "decorated_type",
+                        "add_field" => {"added_field" => "field_value"})
+        end
+        it 'has been decorated with core decoration features' do
+          expect(decorated_event).to include_field("added_field").with_value("field_value")
+          expect(decorated_event).to include_field("type").with_value("decorated_type")
+        end
+      end
+
+      let(:headers_fieldref) { "[@metadata][rabbitmq_headers]" }
+      let(:properties_fieldref) { "[@metadata][rabbitmq_properties]" }
+      let(:payload_fieldref) { "[@metadata][rabbitmq_payload]" }
+
+      shared_examples('`metadata_enabled => none`') do
+        it { is_expected.to_not include_field(headers_fieldref) }
+        it { is_expected.to_not include_field(properties_fieldref) }
+        it { is_expected.to_not include_field(payload_fieldref) }
+
+        include_examples 'core decoration features'
+      end
+
+      shared_examples('`metadata_enabled => basic`') do
+        it { is_expected.to include_field(headers_fieldref).with_value(headers) }
+        it { is_expected.to include_field(properties_fieldref).with_value(properties) }
+        it { is_expected.to_not include_field(payload_fieldref) }
+
+        include_examples 'core decoration features'
+      end
+
+      context "with `metadata_enabled => none`" do
+        let(:metadata_enabled) { "none" }
+        include_examples '`metadata_enabled => none`'
+      end
+
+      context "with `metadata_enabled => basic`" do
+        let(:metadata_enabled) { "basic" }
+        include_examples '`metadata_enabled => basic`'
+      end
+
+      context 'with `metadata_enabled => extended`' do
+        let(:metadata_enabled) { "extended" }
+        it { is_expected.to include_field(headers_fieldref).with_value(headers) }
+        it { is_expected.to include_field(properties_fieldref).with_value(properties) }
+        it { is_expected.to include_field(payload_fieldref).with_value(data) }
+        include_examples 'core decoration features'
+      end
+
+      # Deprecated alias: false -> none
+      context "with `metadata_enabled => false`" do
+        let(:metadata_enabled) { "false" }
+        it_behaves_like '`metadata_enabled => none`'
+      end
+
+      # Deprecated alias: true -> basic
+      context "with `metadata_enabled => true`" do
+        let(:metadata_enabled) { "true" }
+        it_behaves_like '`metadata_enabled => basic`'
+      end
+    end
+  end
 end
 
 describe "LogStash::Inputs::RabbitMQ with a live server", :integration => true do
@@ -186,7 +373,7 @@ describe "LogStash::Inputs::RabbitMQ with a live server", :integration => true d
   end
 
   describe "receiving a message with a queue + exchange specified" do
-    let(:config) { super.merge("queue" => queue_name, "exchange" => exchange_name, "exchange_type" => "fanout", "metadata_enabled" => true) }
+    let(:config) { super.merge("queue" => queue_name, "exchange" => exchange_name, "exchange_type" => "fanout", "metadata_enabled" => "true") }
     let(:event) { output_queue.pop }
     let(:exchange) { test_channel.exchange(exchange_name, :type => "fanout") }
     let(:exchange_name) { "logstash-input-rabbitmq-#{rand(0xFFFFFFFF)}" }

data/spec/outputs/rabbitmq_spec.rb

@@ -83,18 +83,67 @@ describe LogStash::Outputs::RabbitMQ do
         before do
           allow(exchange).to receive(:publish).with(any_args)
           allow(event).to receive(:sprintf).with(key).and_return(sprinted_key)
-          instance.send(:publish, event, encoded_event)
         end
 
         it "should send the correct message" do
+          instance.send(:publish, event, encoded_event)
           expect(exchange).to have_received(:publish).with(encoded_event, anything)
         end
 
         it "should send the correct metadata" do
           expected_metadata = {:routing_key => sprinted_key, :properties => {:persistent => persistent }}
 
+          instance.send(:publish, event, encoded_event)
+
           expect(exchange).to have_received(:publish).with(anything, expected_metadata)
         end
+
+        context 'with message_properties' do
+          let(:rabbitmq_settings) { super().merge("message_properties" => message_properties) }
+          let(:message_properties) { Hash.new }
+          context 'priority' do
+            let(:message_properties) { super().merge("priority" => priority) }
+            context 'as literal Integer value' do
+              let(:priority) { 3 }
+              it 'publishes with the constant-value priority' do
+                instance.send(:publish, event, encoded_event)
+                expect(exchange).to have_received(:publish).with(anything, hash_including(:properties => hash_including(:priority => 3)))
+              end
+            end
+
+            context 'as literal String value' do
+              let(:priority) { "7" }
+              it 'publishes with the constant-value priority' do
+                instance.send(:publish, event, encoded_event)
+                expect(exchange).to have_received(:publish).with(anything, hash_including(:properties => hash_including(:priority => 7)))
+              end
+            end
+
+            context 'as template value' do
+              let(:priority) { "%{[@metadata][priority]}" }
+              context 'when event expands template value' do
+                before do
+                  expect(event).to receive(:sprintf).with(priority).and_return("31")
+                end
+
+                it 'publishes with the priority extracted from the event' do
+                 instance.send(:publish, event, encoded_event)
+                 expect(exchange).to have_received(:publish).with(anything, hash_including(:properties => hash_including(:priority => 31)))
+                end
+              end
+              context 'when event cannot expand template value' do
+                before do
+                  expect(event).to receive(:sprintf).with(priority).and_return(priority)
+                end
+
+                it 'publishes with the priority of zero (`0`)' do
+                 instance.send(:publish, event, encoded_event)
+                 expect(exchange).to have_received(:publish).with(anything, hash_including(:properties => hash_including(:priority => 0)))
+                end
+              end
+            end
+          end
+        end
       end
 
       context 'when an exception is encountered' do

data/spec/plugin_mixins/rabbitmq_connection_spec.rb

@@ -14,12 +14,12 @@ end
 
 describe LogStash::PluginMixins::RabbitMQConnection do
   let(:klass) { TestPlugin }
+  let(:default_port) { 5672 }
   let(:host) { "localhost" }
-  let(:port) { 5672 }
+  let(:port) { default_port }
   let(:rabbitmq_settings) {
     {
-      "host" => host,
-      "port" => port,
+      "host" => host
     }
   }
   let(:instance) {
@@ -27,6 +27,22 @@ describe LogStash::PluginMixins::RabbitMQConnection do
   }
   let(:hare_info) { instance.instance_variable_get(:@hare_info) }
 
+  shared_examples_for 'it sets the addresses correctly' do
+    let(:file) { Stud::Temporary.file }
+    let(:path) { file.path }
+    let(:host) {%w(host01 host02 host03)}
+
+    it "should set addresses to the expected value" do
+      host.each_with_index do |each_host, index|
+        expect(instance.rabbitmq_settings[:addresses][index]).to eql("#{each_host}:#{port}")
+      end
+    end
+
+    it "should insert the correct number of address entries" do
+      expect(instance.rabbitmq_settings[:addresses].length).to eql(host.count)
+    end
+  end
+
   describe "rabbitmq_settings" do
     let(:file) { Stud::Temporary.file }
     let(:path) { file.path }
@@ -59,12 +75,13 @@ describe LogStash::PluginMixins::RabbitMQConnection do
       expect(instance.rabbitmq_settings[:tls_certificate_password]).to eql(rabbitmq_settings["ssl_certificate_password"])
     end
 
-    it "should set hosts to the expected value " do
-      expect(instance.rabbitmq_settings[:hosts][0]).to eql(host)
-    end
+    it_behaves_like 'it sets the addresses correctly'
+
+    context 'with a custom port' do
+      let(:port) { 123 }
+      let(:rabbitmq_settings) { super.merge({"port" => port})}
 
-    it "should only insert a single host entry" do
-      expect(instance.rabbitmq_settings[:hosts].length).to eql(1)
+      it_behaves_like 'it sets the addresses correctly'
     end
   end
 
@@ -79,21 +96,25 @@ describe LogStash::PluginMixins::RabbitMQConnection do
     end
 
   end
-  describe "rabbitmq_settings multiple hosts" do
-    let(:file) { Stud::Temporary.file }
-    let(:path) { file.path }
-    after { File.unlink(path)}
 
-    let(:rabbitmq_settings) { super.merge({"host" => ["host01", "host02", "host03"]}) }
+  describe "rabbitmq_settings with multiple hosts" do
+    it_behaves_like 'it sets the addresses correctly'
+
+    context 'with a custom port'  do
+      let(:port) { 999 }
+      let(:rabbitmq_settings) { super.merge({"port" => port})}
 
-    it "should set hosts to the expected value" do
-      expect(instance.rabbitmq_settings[:hosts][0]).to eql("host01")
-      expect(instance.rabbitmq_settings[:hosts][1]).to eql("host02")
-      expect(instance.rabbitmq_settings[:hosts][2]).to eql("host03")
+      it_behaves_like 'it sets the addresses correctly'
     end
 
-    it "should insert 3 host entries" do
-      expect(instance.rabbitmq_settings[:hosts].length).to eql(3)
+    context 'when ports are set in the host definition' do
+      let(:host) { %w(host01:4444 host02:4445 host03:4446)}
+
+      it "should set the address correctly" do
+        expect(instance.rabbitmq_settings[:addresses][0]).to eql("host01:4444")
+        expect(instance.rabbitmq_settings[:addresses][1]).to eql("host02:4445")
+        expect(instance.rabbitmq_settings[:addresses][2]).to eql("host03:4446")
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-integration-rabbitmq
 version: !ruby/object:Gem::Version
-  version: 7.0.3
+  version: 7.1.0
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-16 00:00:00.000000000 Z
+date: 2020-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement