diff options
| author | Eileen M. Uchitelle <eileencodes@users.noreply.github.com> | 2019-02-12 19:09:41 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-12 19:09:41 -0500 |
| commit | 8d9d46fdae4502b8881eca641c51a64ee7804194 (patch) | |
| tree | 739fe3eec895bf35168d328ebb262d3c91e39360 | |
| parent | bc2954d02b7bae0c1ae3a9a647d5cf6699c25b51 (diff) | |
| parent | 2929186e211addc52c3243d6afde151bc800bb22 (diff) | |
| download | rails-8d9d46fdae4502b8881eca641c51a64ee7804194.tar.gz rails-8d9d46fdae4502b8881eca641c51a64ee7804194.tar.bz2 rails-8d9d46fdae4502b8881eca641c51a64ee7804194.zip | |
Merge pull request #35034 from sponomarev/chore/ac-docs-worker-pool
Add Worker Pool section to Action Cable configuration docs
| -rw-r--r-- | guides/source/action_cable_overview.md | 20 | ||||
| -rw-r--r-- | guides/source/configuring.md | 3 |
2 files changed, 18 insertions, 5 deletions
diff --git a/guides/source/action_cable_overview.md b/guides/source/action_cable_overview.md index 8f5c44849a..7a9ff96c44 100644 --- a/guides/source/action_cable_overview.md +++ b/guides/source/action_cable_overview.md @@ -671,6 +671,21 @@ To configure the URL, add a call to `action_cable_meta_tag` in your HTML layout HEAD. This uses a URL or path typically set via `config.action_cable.url` in the environment configuration files. +### Worker Pool Configuration + +The worker pool is used to run connection callbacks and channel actions in +isolation from the server's main thread. Action Cable allows the application +to configure the number of simultaneously processed threads in the worker pool. + +```ruby +config.action_cable.worker_pool_size = 4 +``` + +Also, note that your server must provide at least the same number of database +connections as you have workers. The default worker pool size is set to 4, so +that means you have to make at least 4 database connections available. + You can change that in `config/database.yml` through the `pool` attribute. + ### Other Configurations The other common option to configure is the log tags applied to the @@ -688,11 +703,6 @@ config.action_cable.log_tags = [ For a full list of all configuration options, see the `ActionCable::Server::Configuration` class. -Also, note that your server must provide at least the same number of database -connections as you have workers. The default worker pool size is set to 4, so -that means you have to make at least that available. You can change that in -`config/database.yml` through the `pool` attribute. - ## Running Standalone Cable Servers ### In App diff --git a/guides/source/configuring.md b/guides/source/configuring.md index e7129dd274..ad82614a0d 100644 --- a/guides/source/configuring.md +++ b/guides/source/configuring.md @@ -791,6 +791,9 @@ main application. You can set this as nil to not mount Action Cable as part of your normal Rails server. +You can find more detailed configuration options in the +[Action Cable Overview](action_cable_overview.html#configuration). + ### Configuring Active Storage |