Skip to content

Commit 551ed6b

Browse files
committed
Update docs for max_worker_queue_len
1 parent 0ab243b commit 551ed6b

File tree

3 files changed

+19
-7
lines changed

3 files changed

+19
-7
lines changed

doc/configuration/outgoing-connections.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,17 @@ Number of workers to be started by the pool.
5757

5858
Number of milliseconds after which a call to the pool will time out.
5959

60+
### `outgoing_pools.*.*.max_worker_queue_len`
61+
* **Syntax:** non-negative integer
62+
* **Default:** not set
63+
* **Example:** `max_worker_queue_len = 1000`
64+
65+
Maximum number of requests waiting in the incoming message queue of a worker. By default there is no such limit.
66+
When this queue length is reached for all workers, further incoming requests will be dropped.
67+
68+
!!! Note
69+
This option is applicable only to the `best_worker` strategy. Using it for other strategies is not allowed.
70+
6071
## Connection options
6172

6273
Options specific to a pool connection are defined in a subsection starting with `[outgoing_pools.*.*.connection]`.
@@ -338,13 +349,6 @@ Sets the RabbitMQ Virtual Host. The host needs to exist, as it is **not** create
338349

339350
Enables/disables one-to-one publishers confirms.
340351

341-
### `outgoing_pools.rabbit.*.connection.max_worker_queue_len`
342-
* **Syntax:** non-negative integer or `"infinity"`
343-
* **Default:** `1000`
344-
* **Example:** `max_worker_queue_len = "infinity"`
345-
346-
Sets a limit of messages in a worker's mailbox above which the worker starts dropping the messages. If a worker message queue length reaches the limit, messages from the head of the queue are dropped until the queue length is again below the limit. Use `infinity` to disable.
347-
348352
---
349353
To enable TLS, you need to include the [TLS section](#tls-options) in the connection options.
350354

doc/migrations/6.5.0_6.x.x.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Configuration options
2+
3+
### RabbitMQ connection pool
4+
5+
The RabbitMQ-specific connection option `max_worker_queue_len` is now replaced with a more generic [worker pool option](../configuration/outgoing-connections.md#outgoing_poolsmax_worker_queue_len) with the same name.
6+
Contrary to the removed option, it now ensures that the queue limit is never exceeded.
7+
Make sure you use the new option instead of the removed one.

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,7 @@ nav:
219219
- '6.3.1 to 6.3.2': 'migrations/6.3.1_6.3.2.md'
220220
- '6.3.3 to 6.4.0': 'migrations/6.3.3_6.4.0.md'
221221
- '6.4.0 to 6.5.0': 'migrations/6.4.0_6.5.0.md'
222+
- '6.5.0 to 6.x.x': 'migrations/6.5.0_6.x.x.md'
222223
- 'MAM MUC migration helper': 'migrations/jid-from-mam-muc-script.md'
223224
- 'Contributions to the Ecosystem': 'Contributions.md'
224225
- 'MongooseIM History': 'History.md'

0 commit comments

Comments
 (0)