logstash-integration-rabbitmq 7.0.0-java → 7.1.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6bbe63689bc0b3dcdb01d9bad482e1425a77805e793873b4b4739db79e49144
-  data.tar.gz: 2e8b2111e92926ae9d5f5fc857289509909b4d1f02ca9dc2df3463830c9226dc
+  metadata.gz: b3d2d391069d509cbbfc1be1a7fc4cf46bb2738f9955fe89d4a058fdf566a8b8
+  data.tar.gz: 84836fc3352e4db58aff484dc568c2913e8c86614f98784e561f2d362541aff5
 SHA512:
-  metadata.gz: 3d7efe8f934f4b234f5ccfccbc3c206a4dbc04a0351b7d4e7541c236fb5cebb043d9bffb2f59acefcb7f4d383bb56d2d5863251ca3fedb8e10e2a4da715eb40d
-  data.tar.gz: fa953afe5684037dc67dfbdf1a1319fa0d7bf8ea622078a0be6e18af3e0f04755c3fe12a59d4d6d59f69dde8d3e919e59e235d565da7d87e15a476083d786a6e
+  metadata.gz: d66b88866a2910cd8410aed61de3be225a3adf57537ec686fa514c25106129e4036f345af66a1382fe6461af97dbf84fda2f9287407d05a441753dbaa6e2610d
+  data.tar.gz: be0cc16060e0bc4663f1d4c935fb1a21fc3ae6246894379df0d8f4e3a548e5ad8116ccdc37b173fbf8d60f27ec1e6dda221b6fa78d29d567877db50768d021c1

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 7.1.1
+  - DOC:Replaced plugin_header file with plugin_header-integration file. ([#34](https://github.com/logstash-plugins/logstash-integration-rabbitmq/issues/34))
+
+## 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)
+
+## 7.0.2
+  - Fixes issue in Output where failure to register connection reovery hooks prevented the output from starting
+
+## 7.0.1
+  - Improves Input Plugin documentation to better align with upstream guidance [#4](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/4)
+
 ## 7.0.0
   - Initial release of the RabbitMQ Integration Plugin, which combines
     previously-separate RabbitMQ plugins and shared dependencies into a single

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

@@ -1,3 +1,4 @@
+:integration: rabbitmq
 :plugin: rabbitmq
 :type: input
 :default_codec: json
@@ -17,7 +18,7 @@ END - GENERATED VARIABLES, DO NOT EDIT!
 
 === Rabbitmq input plugin
 
-include::{include_path}/plugin_header.asciidoc[]
+include::{include_path}/plugin_header-integration.asciidoc[]
 
 ==== Description
 
@@ -34,7 +35,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):
@@ -116,7 +117,7 @@ input plugins.
  
 
 [id="plugins-{type}s-{plugin}-ack"]
-===== `ack` 
+===== `ack`
 
   * Value type is <<boolean,boolean>>
   * Default value is `true`
@@ -131,16 +132,21 @@ This will only send an ack back every `prefetch_count` messages.
 Working in batches provides a performance boost here.
 
 [id="plugins-{type}s-{plugin}-arguments"]
-===== `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"}`
+Optional queue arguments as an array.
+
+Relevant RabbitMQ doc guides:
+
+ * https://www.rabbitmq.com/queues.html#optional-arguments[Optional queue arguments]
+ * https://www.rabbitmq.com/parameters.html#policies[Policies]
+ * https://www.rabbitmq.com/quorum-queues.html[Quorum Queues]
 
 [id="plugins-{type}s-{plugin}-auto_delete"]
-===== `auto_delete` 
+===== `auto_delete`
 
   * Value type is <<boolean,boolean>>
   * Default value is `false`
@@ -151,15 +157,16 @@ on the broker, queueing up messages until a consumer comes along to
 consume them.
 
 [id="plugins-{type}s-{plugin}-automatic_recovery"]
-===== `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!!!
+Set this to https://www.rabbitmq.com/connections.html#automatic-recovery[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` 
+===== `connect_retry_interval`
 
   * Value type is <<number,number>>
   * Default value is `1`
@@ -167,7 +174,7 @@ Set this to automatically recover from a broken connection. You almost certainly
 Time in seconds to wait before retrying a connection
 
 [id="plugins-{type}s-{plugin}-connection_timeout"]
-===== `connection_timeout` 
+===== `connection_timeout`
 
   * Value type is <<number,number>>
   * There is no default value for this setting.
@@ -175,15 +182,17 @@ Time in seconds to wait before retrying a connection
 The default connection timeout in milliseconds. If not specified the timeout is infinite.
 
 [id="plugins-{type}s-{plugin}-durable"]
-===== `durable` 
+===== `durable`
 
   * Value type is <<boolean,boolean>>
   * 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` 
+===== `exchange`
 
   * Value type is <<string,string>>
   * There is no default value for this setting.
@@ -192,7 +201,7 @@ The name of the exchange to bind the queue to. Specify `exchange_type`
 as well to declare the exchange if it does not exist
 
 [id="plugins-{type}s-{plugin}-exchange_type"]
-===== `exchange_type` 
+===== `exchange_type`
 
   * Value type is <<string,string>>
   * There is no default value for this setting.
@@ -201,7 +210,7 @@ The type of the exchange to bind to. Specifying this will cause this plugin
 to declare the exchange if it does not exist.
 
 [id="plugins-{type}s-{plugin}-exclusive"]
-===== `exclusive` 
+===== `exclusive`
 
   * Value type is <<boolean,boolean>>
   * Default value is `false`
@@ -211,15 +220,16 @@ that declared them and will be deleted when it is closed (e.g. due to a Logstash
 restart).
 
 [id="plugins-{type}s-{plugin}-heartbeat"]
-===== `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
+https://www.rabbitmq.com/heartbeats.html[Heartbeat timeout] in seconds.
+If unspecified then heartbeat timeout of 60 seconds will be used.
 
 [id="plugins-{type}s-{plugin}-host"]
-===== `host` 
+===== `host`
 
   * This is a required setting.
   * Value type is <<string,string>>
@@ -238,7 +248,7 @@ 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` 
+===== `key`
 
   * Value type is <<string,string>>
   * Default value is `"logstash"`
@@ -250,15 +260,21 @@ This is only relevant for direct or topic exchanges.
 * Wildcards are not valid on direct exchanges.
 
 [id="plugins-{type}s-{plugin}-metadata_enabled"]
-===== `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
 
 [id="plugins-{type}s-{plugin}-passive"]
-===== `passive` 
+===== `passive`
 
   * Value type is <<boolean,boolean>>
   * Default value is `false`
@@ -270,7 +286,7 @@ a queue that already exists, the queue options for this plugin
 (durable etc) must match those of the existing queue.
 
 [id="plugins-{type}s-{plugin}-password"]
-===== `password` 
+===== `password`
 
   * Value type is <<password,password>>
   * Default value is `"guest"`
@@ -278,7 +294,7 @@ a queue that already exists, the queue options for this plugin
 RabbitMQ password
 
 [id="plugins-{type}s-{plugin}-port"]
-===== `port` 
+===== `port`
 
   * Value type is <<number,number>>
   * Default value is `5672`
@@ -286,7 +302,7 @@ RabbitMQ password
 RabbitMQ port to connect on
 
 [id="plugins-{type}s-{plugin}-prefetch_count"]
-===== `prefetch_count` 
+===== `prefetch_count`
 
   * Value type is <<number,number>>
   * Default value is `256`
@@ -296,7 +312,7 @@ option, specifies the number of outstanding unacknowledged
 messages allowed.
 
 [id="plugins-{type}s-{plugin}-queue"]
-===== `queue` 
+===== `queue`
 
   * Value type is <<string,string>>
   * Default value is `""`
@@ -321,7 +337,7 @@ left empty, a transient queue with an randomly chosen name
 will be created.
 
 [id="plugins-{type}s-{plugin}-ssl"]
-===== `ssl` 
+===== `ssl`
 
   * Value type is <<boolean,boolean>>
   * There is no default value for this setting.
@@ -332,7 +348,7 @@ Specify ssl_certificate_path and ssl_certificate_password if you need
 certificate verification
 
 [id="plugins-{type}s-{plugin}-ssl_certificate_password"]
-===== `ssl_certificate_password` 
+===== `ssl_certificate_password`
 
   * Value type is <<string,string>>
   * There is no default value for this setting.
@@ -340,7 +356,7 @@ certificate verification
 Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certificate_path
 
 [id="plugins-{type}s-{plugin}-ssl_certificate_path"]
-===== `ssl_certificate_path` 
+===== `ssl_certificate_path`
 
   * Value type is <<path,path>>
   * There is no default value for this setting.
@@ -348,7 +364,7 @@ Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certi
 Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote host
 
 [id="plugins-{type}s-{plugin}-ssl_version"]
-===== `ssl_version` 
+===== `ssl_version`
 
   * Value type is <<string,string>>
   * Default value is `"TLSv1.2"`
@@ -356,7 +372,7 @@ Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote
 Version of the SSL protocol to use.
 
 [id="plugins-{type}s-{plugin}-subscription_retry_interval_seconds"]
-===== `subscription_retry_interval_seconds` 
+===== `subscription_retry_interval_seconds`
 
   * This is a required setting.
   * Value type is <<number,number>>
@@ -366,13 +382,13 @@ Amount of time in seconds to wait after a failed subscription request
 before retrying. Subscribes can fail if the server goes away and then comes back.
 
 [id="plugins-{type}s-{plugin}-threads"]
-===== `threads` 
+===== `threads`
 
   * Value type is <<number,number>>
   * Default value is `1`
 
 [id="plugins-{type}s-{plugin}-user"]
-===== `user` 
+===== `user`
 
   * Value type is <<string,string>>
   * Default value is `"guest"`
@@ -380,7 +396,7 @@ before retrying. Subscribes can fail if the server goes away and then comes back
 RabbitMQ username
 
 [id="plugins-{type}s-{plugin}-vhost"]
-===== `vhost` 
+===== `vhost`
 
   * Value type is <<string,string>>
   * Default value is `"/"`
@@ -395,4 +411,4 @@ slash.
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
 
-:default_codec!:
+:default_codec!: