logstash-integration-rabbitmq 7.0.0-java → 7.0.1-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a6bbe63689bc0b3dcdb01d9bad482e1425a77805e793873b4b4739db79e49144
4
- data.tar.gz: 2e8b2111e92926ae9d5f5fc857289509909b4d1f02ca9dc2df3463830c9226dc
3
+ metadata.gz: 1c9eb2d5cd3c2ee2cd302c99305d08768545cdca5c8a514d453889aa6261e88d
4
+ data.tar.gz: 3f02e987e179e543ccd1e3b1f2db5386aae98a415498c7c33f80c108e8463823
5
5
  SHA512:
6
- metadata.gz: 3d7efe8f934f4b234f5ccfccbc3c206a4dbc04a0351b7d4e7541c236fb5cebb043d9bffb2f59acefcb7f4d383bb56d2d5863251ca3fedb8e10e2a4da715eb40d
7
- data.tar.gz: fa953afe5684037dc67dfbdf1a1319fa0d7bf8ea622078a0be6e18af3e0f04755c3fe12a59d4d6d59f69dde8d3e919e59e235d565da7d87e15a476083d786a6e
6
+ metadata.gz: 7c39a3f8d79aac858797c485b3c1b749ebdf03ee4ba834b85b6ef6eba4e552d8668a5a40100e1c3c231730c5abe78fccced58b15b558c46ef06bb553a24bab50
7
+ data.tar.gz: 309dd81565fa462ca58ba87300e2273fde6b49a505bbfc6276d5ece07b0bfa81ddda98f78ab09894a9b4d4fa5354e52f0190467a42a708d3fa009a0b4f55ad26
data/CHANGELOG.md CHANGED
@@ -1,3 +1,6 @@
1
+ ## 7.0.1
2
+ - Improves Input Plugin documentation to better align with upstream guidance [#4](https://github.com/logstash-plugins/logstash-integration-rabbitmq/pull/4)
3
+
1
4
  ## 7.0.0
2
5
  - Initial release of the RabbitMQ Integration Plugin, which combines
3
6
  previously-separate RabbitMQ plugins and shared dependencies into a single
@@ -116,7 +116,7 @@ input plugins.
116
116
   
117
117
 
118
118
  [id="plugins-{type}s-{plugin}-ack"]
119
- ===== `ack`
119
+ ===== `ack`
120
120
 
121
121
  * Value type is <<boolean,boolean>>
122
122
  * Default value is `true`
@@ -131,16 +131,21 @@ This will only send an ack back every `prefetch_count` messages.
131
131
  Working in batches provides a performance boost here.
132
132
 
133
133
  [id="plugins-{type}s-{plugin}-arguments"]
134
- ===== `arguments`
134
+ ===== `arguments`
135
135
 
136
136
  * Value type is <<array,array>>
137
137
  * Default value is `{}`
138
138
 
139
- Extra queue arguments as an array.
140
- To make a RabbitMQ queue mirrored, use: `{"x-ha-policy" => "all"}`
139
+ Optional queue arguments as an array.
140
+
141
+ Relevant RabbitMQ doc guides:
142
+
143
+ * https://www.rabbitmq.com/queues.html#optional-arguments[Optional queue arguments]
144
+ * https://www.rabbitmq.com/parameters.html#policies[Policies]
145
+ * https://www.rabbitmq.com/quorum-queues.html[Quorum Queues]
141
146
 
142
147
  [id="plugins-{type}s-{plugin}-auto_delete"]
143
- ===== `auto_delete`
148
+ ===== `auto_delete`
144
149
 
145
150
  * Value type is <<boolean,boolean>>
146
151
  * Default value is `false`
@@ -151,15 +156,16 @@ on the broker, queueing up messages until a consumer comes along to
151
156
  consume them.
152
157
 
153
158
  [id="plugins-{type}s-{plugin}-automatic_recovery"]
154
- ===== `automatic_recovery`
159
+ ===== `automatic_recovery`
155
160
 
156
161
  * Value type is <<boolean,boolean>>
157
162
  * Default value is `true`
158
163
 
159
- Set this to automatically recover from a broken connection. You almost certainly don't want to override this!!!
164
+ Set this to https://www.rabbitmq.com/connections.html#automatic-recovery[automatically recover] from a broken connection.
165
+ You almost certainly don't want to override this!
160
166
 
161
167
  [id="plugins-{type}s-{plugin}-connect_retry_interval"]
162
- ===== `connect_retry_interval`
168
+ ===== `connect_retry_interval`
163
169
 
164
170
  * Value type is <<number,number>>
165
171
  * Default value is `1`
@@ -167,7 +173,7 @@ Set this to automatically recover from a broken connection. You almost certainly
167
173
  Time in seconds to wait before retrying a connection
168
174
 
169
175
  [id="plugins-{type}s-{plugin}-connection_timeout"]
170
- ===== `connection_timeout`
176
+ ===== `connection_timeout`
171
177
 
172
178
  * Value type is <<number,number>>
173
179
  * There is no default value for this setting.
@@ -175,7 +181,7 @@ Time in seconds to wait before retrying a connection
175
181
  The default connection timeout in milliseconds. If not specified the timeout is infinite.
176
182
 
177
183
  [id="plugins-{type}s-{plugin}-durable"]
178
- ===== `durable`
184
+ ===== `durable`
179
185
 
180
186
  * Value type is <<boolean,boolean>>
181
187
  * Default value is `false`
@@ -183,7 +189,7 @@ The default connection timeout in milliseconds. If not specified the timeout is
183
189
  Is this queue durable? (aka; Should it survive a broker restart?)
184
190
 
185
191
  [id="plugins-{type}s-{plugin}-exchange"]
186
- ===== `exchange`
192
+ ===== `exchange`
187
193
 
188
194
  * Value type is <<string,string>>
189
195
  * There is no default value for this setting.
@@ -192,7 +198,7 @@ The name of the exchange to bind the queue to. Specify `exchange_type`
192
198
  as well to declare the exchange if it does not exist
193
199
 
194
200
  [id="plugins-{type}s-{plugin}-exchange_type"]
195
- ===== `exchange_type`
201
+ ===== `exchange_type`
196
202
 
197
203
  * Value type is <<string,string>>
198
204
  * There is no default value for this setting.
@@ -201,7 +207,7 @@ The type of the exchange to bind to. Specifying this will cause this plugin
201
207
  to declare the exchange if it does not exist.
202
208
 
203
209
  [id="plugins-{type}s-{plugin}-exclusive"]
204
- ===== `exclusive`
210
+ ===== `exclusive`
205
211
 
206
212
  * Value type is <<boolean,boolean>>
207
213
  * Default value is `false`
@@ -211,15 +217,16 @@ that declared them and will be deleted when it is closed (e.g. due to a Logstash
211
217
  restart).
212
218
 
213
219
  [id="plugins-{type}s-{plugin}-heartbeat"]
214
- ===== `heartbeat`
220
+ ===== `heartbeat`
215
221
 
216
222
  * Value type is <<number,number>>
217
223
  * There is no default value for this setting.
218
224
 
219
- Heartbeat delay in seconds. If unspecified no heartbeats will be sent
225
+ https://www.rabbitmq.com/heartbeats.html[Heartbeat timeout] in seconds.
226
+ If unspecified then heartbeat timeout of 60 seconds will be used.
220
227
 
221
228
  [id="plugins-{type}s-{plugin}-host"]
222
- ===== `host`
229
+ ===== `host`
223
230
 
224
231
  * This is a required setting.
225
232
  * Value type is <<string,string>>
@@ -238,7 +245,7 @@ recovery attempts of the hosts is chosen at random and connected to.
238
245
  Note that only one host connection is active at a time.
239
246
 
240
247
  [id="plugins-{type}s-{plugin}-key"]
241
- ===== `key`
248
+ ===== `key`
242
249
 
243
250
  * Value type is <<string,string>>
244
251
  * Default value is `"logstash"`
@@ -250,7 +257,7 @@ This is only relevant for direct or topic exchanges.
250
257
  * Wildcards are not valid on direct exchanges.
251
258
 
252
259
  [id="plugins-{type}s-{plugin}-metadata_enabled"]
253
- ===== `metadata_enabled`
260
+ ===== `metadata_enabled`
254
261
 
255
262
  * Value type is <<boolean,boolean>>
256
263
  * Default value is `false`
@@ -258,7 +265,7 @@ This is only relevant for direct or topic exchanges.
258
265
  Enable the storage of message headers and properties in `@metadata`. This may impact performance
259
266
 
260
267
  [id="plugins-{type}s-{plugin}-passive"]
261
- ===== `passive`
268
+ ===== `passive`
262
269
 
263
270
  * Value type is <<boolean,boolean>>
264
271
  * Default value is `false`
@@ -270,7 +277,7 @@ a queue that already exists, the queue options for this plugin
270
277
  (durable etc) must match those of the existing queue.
271
278
 
272
279
  [id="plugins-{type}s-{plugin}-password"]
273
- ===== `password`
280
+ ===== `password`
274
281
 
275
282
  * Value type is <<password,password>>
276
283
  * Default value is `"guest"`
@@ -278,7 +285,7 @@ a queue that already exists, the queue options for this plugin
278
285
  RabbitMQ password
279
286
 
280
287
  [id="plugins-{type}s-{plugin}-port"]
281
- ===== `port`
288
+ ===== `port`
282
289
 
283
290
  * Value type is <<number,number>>
284
291
  * Default value is `5672`
@@ -286,7 +293,7 @@ RabbitMQ password
286
293
  RabbitMQ port to connect on
287
294
 
288
295
  [id="plugins-{type}s-{plugin}-prefetch_count"]
289
- ===== `prefetch_count`
296
+ ===== `prefetch_count`
290
297
 
291
298
  * Value type is <<number,number>>
292
299
  * Default value is `256`
@@ -296,7 +303,7 @@ option, specifies the number of outstanding unacknowledged
296
303
  messages allowed.
297
304
 
298
305
  [id="plugins-{type}s-{plugin}-queue"]
299
- ===== `queue`
306
+ ===== `queue`
300
307
 
301
308
  * Value type is <<string,string>>
302
309
  * Default value is `""`
@@ -321,7 +328,7 @@ left empty, a transient queue with an randomly chosen name
321
328
  will be created.
322
329
 
323
330
  [id="plugins-{type}s-{plugin}-ssl"]
324
- ===== `ssl`
331
+ ===== `ssl`
325
332
 
326
333
  * Value type is <<boolean,boolean>>
327
334
  * There is no default value for this setting.
@@ -332,7 +339,7 @@ Specify ssl_certificate_path and ssl_certificate_password if you need
332
339
  certificate verification
333
340
 
334
341
  [id="plugins-{type}s-{plugin}-ssl_certificate_password"]
335
- ===== `ssl_certificate_password`
342
+ ===== `ssl_certificate_password`
336
343
 
337
344
  * Value type is <<string,string>>
338
345
  * There is no default value for this setting.
@@ -340,7 +347,7 @@ certificate verification
340
347
  Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certificate_path
341
348
 
342
349
  [id="plugins-{type}s-{plugin}-ssl_certificate_path"]
343
- ===== `ssl_certificate_path`
350
+ ===== `ssl_certificate_path`
344
351
 
345
352
  * Value type is <<path,path>>
346
353
  * There is no default value for this setting.
@@ -348,7 +355,7 @@ Password for the encrypted PKCS12 (.p12) certificate file specified in ssl_certi
348
355
  Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote host
349
356
 
350
357
  [id="plugins-{type}s-{plugin}-ssl_version"]
351
- ===== `ssl_version`
358
+ ===== `ssl_version`
352
359
 
353
360
  * Value type is <<string,string>>
354
361
  * Default value is `"TLSv1.2"`
@@ -356,7 +363,7 @@ Path to an SSL certificate in PKCS12 (.p12) format used for verifying the remote
356
363
  Version of the SSL protocol to use.
357
364
 
358
365
  [id="plugins-{type}s-{plugin}-subscription_retry_interval_seconds"]
359
- ===== `subscription_retry_interval_seconds`
366
+ ===== `subscription_retry_interval_seconds`
360
367
 
361
368
  * This is a required setting.
362
369
  * Value type is <<number,number>>
@@ -366,13 +373,13 @@ Amount of time in seconds to wait after a failed subscription request
366
373
  before retrying. Subscribes can fail if the server goes away and then comes back.
367
374
 
368
375
  [id="plugins-{type}s-{plugin}-threads"]
369
- ===== `threads`
376
+ ===== `threads`
370
377
 
371
378
  * Value type is <<number,number>>
372
379
  * Default value is `1`
373
380
 
374
381
  [id="plugins-{type}s-{plugin}-user"]
375
- ===== `user`
382
+ ===== `user`
376
383
 
377
384
  * Value type is <<string,string>>
378
385
  * Default value is `"guest"`
@@ -380,7 +387,7 @@ before retrying. Subscribes can fail if the server goes away and then comes back
380
387
  RabbitMQ username
381
388
 
382
389
  [id="plugins-{type}s-{plugin}-vhost"]
383
- ===== `vhost`
390
+ ===== `vhost`
384
391
 
385
392
  * Value type is <<string,string>>
386
393
  * Default value is `"/"`
@@ -395,4 +402,4 @@ slash.
395
402
  [id="plugins-{type}s-{plugin}-common-options"]
396
403
  include::{include_path}/{type}.asciidoc[]
397
404
 
398
- :default_codec!:
405
+ :default_codec!:
@@ -121,8 +121,6 @@ module LogStash
121
121
  # restart).
122
122
  config :exclusive, :validate => :boolean, :default => false
123
123
 
124
- # Extra queue arguments as an array.
125
- # To make a RabbitMQ queue mirrored, use: `{"x-ha-policy" => "all"}`
126
124
  config :arguments, :validate => :array, :default => {}
127
125
 
128
126
  # Prefetch count. If acknowledgements are enabled with the `ack`
@@ -1,6 +1,6 @@
1
1
  Gem::Specification.new do |s|
2
2
  s.name = 'logstash-integration-rabbitmq'
3
- s.version = '7.0.0'
3
+ s.version = '7.0.1'
4
4
  s.licenses = ['Apache License (2.0)']
5
5
  s.summary = "Integration with RabbitMQ - input and output plugins"
6
6
  s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline "+
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-integration-rabbitmq
3
3
  version: !ruby/object:Gem::Version
4
- version: 7.0.0
4
+ version: 7.0.1
5
5
  platform: java
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-10-15 00:00:00.000000000 Z
11
+ date: 2019-11-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
218
218
  version: '0'
219
219
  requirements: []
220
220
  rubyforge_project:
221
- rubygems_version: 2.7.9
221
+ rubygems_version: 2.6.11
222
222
  signing_key:
223
223
  specification_version: 4
224
224
  summary: Integration with RabbitMQ - input and output plugins