Skip to content

Commit bc46e7e

Browse files
committed
remove consume_all
1 parent eb044e6 commit bc46e7e

File tree

4 files changed

+27
-47
lines changed

4 files changed

+27
-47
lines changed

queues/amqp.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -117,11 +117,6 @@ jobs:
117117
# If the job has priority set to 0, it will inherit the pipeline's priority. Default: 10.
118118
priority: 1
119119

120-
# Consume any payload type (not only Jobs structured)
121-
#
122-
# Default: false
123-
consume_all: false
124-
125120
# Redial timeout (in seconds). How long to try to reconnect to the AMQP server.
126121
#
127122
# Default: 60
@@ -221,11 +216,6 @@ from `pipe1` have been processed.
221216

222217
`queue` - required, AMQP internal (inside the driver) queue name.
223218

224-
### Consume all
225-
226-
`consume_all` - by default, RoadRunner only supports `Jobs` structures from the queue. Enable this option by setting it
227-
to true if you wish to consume raw payloads as well.
228-
229219
### Exchange
230220

231221
`exchange` - required, rabbitMQ exchange name.

queues/beanstalk.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,6 @@ jobs:
4646
# Default: 10
4747
priority: 10
4848

49-
# Consume any payload type (not only Jobs structured)
50-
# Default: false
51-
consume_all: false
52-
5349
# Optional section.
5450
# Default: 1
5551
tube_priority: 1
@@ -82,8 +78,3 @@ value should not exceed `int32` size.
8278
### Tube
8379

8480
`tube` - The name of the inner "tube" specific to the Beanstalk driver.
85-
86-
### Consume all
87-
88-
`consume_all` - By default, RR supports only `Jobs` structures from the queue. Set this option to true if you want to
89-
also consume the raw payloads.

queues/nats.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,6 @@ jobs:
3333
# Messages to read into the channel
3434
prefetch: 100
3535

36-
# Consume any payload type (not only Jobs structured)
37-
# Default: false
38-
consume_all: false
39-
4036
# NATS subject
4137
# Default: default
4238
subject: default
@@ -91,8 +87,3 @@ jobs:
9187
### Delete after ack
9288

9389
`delete_after_ack` - delete message after it successfully acknowledged.
94-
95-
### Consume all
96-
97-
`consume_all` - By default, RR supports only `Jobs` structures from the queue. Set this option to true if you want to
98-
also consume the raw payloads.

queues/sqs.md

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -132,10 +132,6 @@ jobs:
132132
# Default: 10
133133
prefetch: 10
134134
135-
# Consume any payload type (not only Jobs structured)
136-
# Default: false
137-
consume_all: false
138-
139135
# Get queue URL only
140136
# Default: false
141137
skip_queue_declaration: false
@@ -203,8 +199,8 @@ Default: `0`
203199

204200
`retain_failed_jobs` - If enabled, jobs will not be deleted and requeued if they fail. Instead, RoadRunner will
205201
simply let them be processed again after `visibility_timeout` has passed. If you set `error_visibility_timeout` and
206-
enable this feature, RoadRunner will change the timeout to the value of `error_visibility_timeout`. This lets you
207-
customize the timeout for errors specifically. If you enable this feature, you can configure SQS to automatically
202+
enable this feature, RoadRunner will change the timeout of the job to the value of `error_visibility_timeout`. This lets
203+
you customize the timeout for errors specifically. If you enable this feature, you can configure SQS to automatically
208204
move jobs that fail multiple times to a
209205
[dead-letter queue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html).
210206

@@ -214,20 +210,35 @@ Default: `false`
214210

215211
`wait_time_seconds` - The duration (in seconds) for which the call waits for a message to arrive in the queue before
216212
returning. If a message is available, the call returns sooner than `wait_time_seconds`. If no messages are available and
217-
the wait time expires, the call returns successfully with an empty list of messages. If you do not provide a value for
218-
this parameter or set it to 0, the `ReceiveMessageWaitTimeSeconds` attribute of the queue is used, which defaults to 0,
219-
in which case you will be using short polling. See the documentation on the differences between
220-
[short and long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html).
213+
the wait time expires, the call returns successfully with an empty list of messages. Please note that this parameter
214+
cannot be explicitly configured to use zero, as zero will apply the queue defaults.
221215

222216
Default: `0`
223217

218+
{% hint style="warning" %}
219+
### Shor vs. Long Polling
220+
221+
By default, SQS and RoadRunner is configured to use **short polling**. Please review the documentation on the
222+
differences between
223+
[short and long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html)
224+
and make sure that your queue and RoadRunner is configured correctly. Long polling will *usually* be a cost-saving
225+
feature with no practical impact on performance or functionality. Remember that not providing a value (or zero) for
226+
`wait_time_seconds` will cause your queue polling to be based on the `ReceiveMessageWaitTimeSeconds` attribute
227+
configured on the queue.
228+
{% endhint %}
229+
224230
### Queue
225231

226232
`queue` - The name of the queue. May only contain alphanumeric characters, hyphens (`-`), and underscores (`_`). On AWS,
227233
this will form the last part of the queue URL, i.e. `https://sqs.<region>.amazonaws.com/<account id>/<queue>`.
228234

229235
Default: `default`
230236

237+
{% hint style="info" %}
238+
Please note that [FIFO](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-fifo-queues.html)
239+
queue names **must** end with `.fifo`.
240+
{% endhint %}
241+
231242
### Message Group ID
232243

233244
`message_group_id` - Message group ID is required for FIFO queues. Messages that belong to the same message group are
@@ -236,7 +247,7 @@ More info:
236247
[link](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html#SQS-SendMessage-request-MessageGroupId)
237248

238249
### Skip Queue Declaration
239-
250+
"https://sqs.eu-central-1.amazonaws.com"
240251
`skip_queue_declaration` - By default, RR tries to create the queue (using the `queue` name) if it does not exist. Set
241252
this option to `true` if the queue already exists.
242253

@@ -248,18 +259,11 @@ For queue creation to work, the credentials or the IAM role used must have the
248259
such as `sqs:CreateQueue` and `sqs:SetQueueAttributes`.
249260
{% endhint %}
250261

251-
### Consume All
252-
253-
`consume_all` - By default, RR consumes only messages in the queue with the `Jobs` structure. Set this option to `true`
254-
if you want to consume all messages in the queue.
255-
256-
Default: `false`
257-
258262
### Attributes
259263

260264
`attributes` - A list of
261265
[AWS SQS attributes](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SetQueueAttributes.html)
262-
to configure for the queue. Attributes are only set if RR creates the queue. Existing queues are not modified.
266+
to configure for the queue.
263267

264268
{% code title=".rr.yaml" %}
265269

@@ -274,6 +278,10 @@ attributes:
274278

275279
{% endcode %}
276280

281+
{% hint style="info" %}
282+
Attributes are only set if RoadRunner creates the queue. Attributes of existing queues are **not modified**.
283+
{% endhint %}
284+
277285
### Tags
278286

279287
`tags` - Tags don't have any semantic meaning. Amazon SQS interprets tags as character. Tags are only set if RR creates

0 commit comments

Comments
 (0)