You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Common configuration fields, showing default values
25
25
input:
26
26
label: ""
27
27
amqp_0_9:
28
28
urls: [] # No default (required)
29
29
queue: "" # No default (required)
30
-
consumer_tag: ""
30
+
consumer_tag: "" # Optional
31
31
prefetch_count: 10
32
32
```
33
33
@@ -37,7 +37,7 @@ Advanced::
37
37
--
38
38
39
39
```yml
40
-
# All config fields, showing default values
40
+
# All configuration fields, showing default values
41
41
input:
42
42
label: ""
43
43
amqp_0_9:
@@ -47,8 +47,9 @@ input:
47
47
enabled: false
48
48
durable: true
49
49
auto_delete: false
50
+
arguments: {} # No default (optional)
50
51
bindings_declare: [] # No default (optional)
51
-
consumer_tag: ""
52
+
consumer_tag: "" # Optional
52
53
auto_ack: false
53
54
nack_reject_patterns: []
54
55
prefetch_count: 10
@@ -57,37 +58,37 @@ input:
57
58
enabled: false
58
59
skip_cert_verify: false
59
60
enable_renegotiation: false
60
-
root_cas: ""
61
-
root_cas_file: ""
61
+
root_cas: "" # Optional
62
+
root_cas_file: "" # Optional
62
63
client_certs: []
63
64
```
64
65
65
66
--
66
67
======
67
68
68
-
TLS is automatic when connecting to an `amqps` URL, but custom settings can be enabled in the `tls` section.
69
+
TLS is automatically enabled when connecting to an `amqps` URL. However, you can customize <<tls, TLS settings>> if required.
69
70
70
71
== Metadata
71
72
72
73
This input adds the following metadata fields to each message:
73
74
74
-
- amqp_content_type
75
-
- amqp_content_encoding
76
-
- amqp_delivery_mode
77
-
- amqp_priority
78
-
- amqp_correlation_id
79
-
- amqp_reply_to
80
-
- amqp_expiration
81
-
- amqp_message_id
82
-
- amqp_timestamp
83
-
- amqp_type
84
-
- amqp_user_id
85
-
- amqp_app_id
86
-
- amqp_consumer_tag
87
-
- amqp_delivery_tag
88
-
- amqp_redelivered
89
-
- amqp_exchange
90
-
- amqp_routing_key
75
+
- `amqp_content_type`
76
+
- `amqp_content_encoding`
77
+
- `amqp_delivery_mode`
78
+
- `amqp_priority`
79
+
- `amqp_correlation_id`
80
+
- `amqp_reply_to`
81
+
- `amqp_expiration`
82
+
- `amqp_message_id`
83
+
- `amqp_timestamp`
84
+
- `amqp_type`
85
+
- `amqp_user_id`
86
+
- `amqp_app_id`
87
+
- `amqp_consumer_tag`
88
+
- `amqp_delivery_tag`
89
+
- `amqp_redelivered`
90
+
- `amqp_exchange`
91
+
- `amqp_routing_key`
91
92
- All existing message headers, including nested headers prefixed with the key of their respective parent.
92
93
93
94
You can access these metadata fields using xref:configuration:interpolation.adoc#bloblang-queries[function interpolations].
@@ -96,8 +97,9 @@ You can access these metadata fields using xref:configuration:interpolation.adoc
96
97
97
98
=== `urls`
98
99
99
-
A list of URLs to connect to. The first URL to successfully establish a connection will be used until the connection is closed. If an item of the list contains commas it will be expanded into multiple URLs.
100
+
A list of URLs to connect to. This input attempts to connect to each URL in the list, in order, until a successful connection is established. It then continues to use that URL until the connection is closed.
100
101
102
+
If an item in the list contains commas, it is split into multiple URLs.
101
103
102
104
*Type*: `array`
103
105
@@ -129,17 +131,14 @@ An AMQP queue to consume from.
129
131
130
132
=== `queue_declare`
131
133
132
-
Allows you to passively declare the target queue. If the queue already exists then the declaration passively verifies that they match the target fields.
133
-
134
+
Passively declares the <<queue, target queue>> to make sure a queue with the specified name exists and is configured correctly. If the queue exists, then the passive declaration verifies that fields specified in this object match the its properties.
134
135
135
136
*Type*: `object`
136
137
137
-
138
138
=== `queue_declare.enabled`
139
139
140
140
Whether to enable queue declaration.
141
141
142
-
143
142
*Type*: `bool`
144
143
145
144
*Default*: `false`
@@ -148,34 +147,96 @@ Whether to enable queue declaration.
148
147
149
148
Whether the declared queue is durable.
150
149
151
-
152
150
*Type*: `bool`
153
151
154
152
*Default*: `true`
155
153
156
154
=== `queue_declare.auto_delete`
157
155
158
-
Whether the declared queue will auto-delete.
159
-
156
+
Whether the declared queue auto-deletes when there are no active consumers.
160
157
161
158
*Type*: `bool`
162
159
163
160
*Default*: `false`
164
161
165
-
=== `bindings_declare`
162
+
=== `queue_declare.arguments`
166
163
167
-
Allows you to passively declare bindings for the target queue.
164
+
Arguments for server-specific implementations of the queue (optional). You can use arguments to configure additional parameters for queue types that require them. For more information about available arguments, see the https://github.com/rabbitmq/amqp091-go/blob/b3d409fe92c34bea04d8123a136384c85e8dc431/types.go#L282-L362[RabbitMQ Client Library^].
168
165
166
+
*Type*: `object`
169
167
170
-
*Type*: `array`
171
168
169
+
```yml
170
+
# Examples
171
+
172
+
arguments:
173
+
x-max-length: 1000
174
+
x-max-length-bytes: 4096
175
+
x-queue-type: quorum
176
+
```
177
+
178
+
179
+
|===
180
+
| Argument | Description | Accepted values
181
+
182
+
| `x-queue-type`
183
+
| Declares the type of queue.
184
+
| Options: `classic` (default), `quorum`, `stream`, `drop-head`, `reject-publish`, and `reject-publish-dlx`.
185
+
186
+
| `x-max-length`
187
+
| The maximum number of messages in the queue.
188
+
| A non-negative integer.
189
+
190
+
| `x-max-length-bytes`
191
+
| The maximum size of messages (in bytes) in the queue.
| The duration (in milliseconds) that messages remain in the queue before they expire and are discarded.
200
+
| A string that represents the number of milliseconds. For example, `60000` retains messages for one minute.
201
+
202
+
| `x-expires`
203
+
| The duration after which the queue automatically expires.
204
+
| A positive integer.
205
+
206
+
| `x-max-age`
207
+
| The duration (in configurable units) that streamed messages are retained on disk before they are discarded.
208
+
| Options: `Y`, `M`, `D`, `h`, `m`, `s`. For example, `7D` retains messages for a week.
209
+
210
+
| `x-stream-max-segment-size-bytes`
211
+
| The maximum size (in bytes) of the segment files held on disk.
212
+
| A positive integer. Default: `500000000` (approximately 500 MB).
213
+
214
+
| `x-queue-version`
215
+
| The version of the classic queue to use.
216
+
| Options: `1` or `2`.
217
+
218
+
| `x-consumer-timeout`
219
+
| The duration (in milliseconds) that a consumer can remain idle before it is automatically canceled.
220
+
| A positive integer that represents the number of milliseconds. For example, `60000` sets a timeout duration of one minute.
221
+
222
+
| `x-single-active-consumer`
223
+
| When set to `true`, a single consumer receives messages from the queue even when multiple consumers are subscribed to it.
224
+
| A boolean.
225
+
226
+
|===
227
+
228
+
=== `bindings_declare`
229
+
230
+
Passively declares the bindings of the target queue to make sure they exist and are configured correctly. If the bindings exist, then the passive declaration verifies that fields specified in this object match them.
231
+
232
+
*Type*: `array`
172
233
173
234
```yml
174
235
# Examples
175
236
176
237
bindings_declare:
177
-
- exchange: foo
178
-
key: bar
238
+
- exchange: my_exchange
239
+
key: my_routing_key
179
240
```
180
241
181
242
=== `bindings_declare[].exchange`
@@ -198,7 +259,7 @@ The key of the declared binding.
198
259
199
260
=== `consumer_tag`
200
261
201
-
A consumer tag.
262
+
A consumer tag to uniquely identify the consumer.
202
263
203
264
204
265
*Type*: `string`
@@ -207,17 +268,17 @@ A consumer tag.
207
268
208
269
=== `auto_ack`
209
270
210
-
Acknowledge messages automatically as they are consumed rather than waiting for acknowledgments from downstream. This can improve throughput and prevent the pipeline from blocking but at the cost of eliminating delivery guarantees.
211
-
271
+
Set to `true` to automatically acknowledge messages as soon as they are consumed rather than waiting for acknowledgments from downstream. This can improve throughput and prevent the pipeline from becoming blocked, but delivery guarantees are lost.
212
272
213
273
*Type*: `bool`
214
274
215
275
*Default*: `false`
216
276
217
277
=== `nack_reject_patterns`
218
278
219
-
A list of regular expression patterns whereby if a message that has failed to be delivered by Redpanda Connect has an error that matches it will be dropped (or delivered to a dead-letter queue if one exists). By default failed messages are nacked with requeue enabled.
279
+
A list of regular expression patterns to match against errors in messages that Redpanda Connect fails to deliver. When a message has an error that matches a pattern, it is dropped or delivered to a dead-letter queue (if a queue has been configured).
220
280
281
+
By default, failed messages are negatively acknowledged (nacked) and requeued.
221
282
222
283
*Type*: `array`
223
284
@@ -236,16 +297,15 @@ nack_reject_patterns:
236
297
237
298
=== `prefetch_count`
238
299
239
-
The maximum number of pending messages to have consumed at a time.
240
-
300
+
The maximum number of pending messages at a given time.
241
301
242
302
*Type*: `int`
243
303
244
304
*Default*: `10`
245
305
246
306
=== `prefetch_size`
247
307
248
-
The maximum amount of pending messages measured in bytes to have consumed at a time.
308
+
The maximum size of pending messages (in bytes) at a given time.
249
309
250
310
251
311
*Type*: `int`
@@ -254,12 +314,10 @@ The maximum amount of pending messages measured in bytes to have consumed at a t
254
314
255
315
=== `tls`
256
316
257
-
Custom TLS settings can be used to override system defaults.
258
-
317
+
Override system defaults with custom TLS settings.
259
318
260
319
*Type*: `object`
261
320
262
-
263
321
=== `tls.enabled`
264
322
265
323
Whether custom TLS settings are enabled.
@@ -271,7 +329,7 @@ Whether custom TLS settings are enabled.
271
329
272
330
=== `tls.skip_cert_verify`
273
331
274
-
Whether to skip serverside certificate verification.
332
+
Whether to skip server-side certificate verification.
275
333
276
334
277
335
*Type*: `bool`
@@ -293,7 +351,7 @@ endif::[]
293
351
294
352
=== `tls.root_cas`
295
353
296
-
An optional root certificate authority to use. This is a string, representing a certificate chain from the parenttrusted root certificate, to possible intermediate signing certificates, to the host certificate.
354
+
Specify a certificate authority to use (optional). This is a string that represents a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate.
297
355
298
356
include::components:partial$secret_warning.adoc[]
299
357
@@ -313,8 +371,7 @@ root_cas: |-
313
371
314
372
=== `tls.root_cas_file`
315
373
316
-
An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.
317
-
374
+
Specify the path to a root certificate authority file (optional). This is a file, often with a `.pem` extension, that contains a certificate chain from the parent-trusted root certificate, through possible intermediate signing certificates, to the host certificate.
318
375
319
376
*Type*: `string`
320
377
@@ -328,7 +385,7 @@ root_cas_file: ./root_cas.pem
328
385
329
386
=== `tls.client_certs`
330
387
331
-
A list of client certificates to use. For each certificateeither the fields `cert` and `key`, or `cert_file` and `key_file` should be specified, but not both.
388
+
A list of client certificates to use. For each certificate, specify values for either the `cert` and `key` fields, or the `cert_file` and `key_file` fields.
332
389
333
390
334
391
*Type*: `array`
@@ -389,12 +446,10 @@ The path of a certificate key to use.
389
446
390
447
A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete `pbeWithMD5AndDES-CBC` algorithm is not supported for the PKCS#8 format.
391
448
392
-
Because the obsolete pbeWithMD5AndDES-CBC algorithm does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.
449
+
WARNING: The `pbeWithMD5AndDES-CBC` algorithm does not authenticate ciphertext, and is vulnerable to padding oracle attacks, which may allow an attacker to recover the plain text password.
0 commit comments