diff options
Diffstat (limited to 'doc/administration/polling.md')
| -rw-r--r-- | doc/administration/polling.md | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/doc/administration/polling.md b/doc/administration/polling.md index ec5d6cd45d8..5c4ee837057 100644 --- a/doc/administration/polling.md +++ b/doc/administration/polling.md @@ -4,29 +4,31 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Polling configuration **(FREE SELF)** +# Polling interval multiplier **(FREE SELF)** -The GitLab UI polls for updates for different resources (issue notes, issue -titles, pipeline statuses, and so on) on a schedule appropriate to the resource. +The GitLab UI polls for updates for different resources (issue notes, issue titles, pipeline +statuses, and so on) on a schedule appropriate to the resource. -To configure the polling interval multiplier: +Adjust the multiplier on these schedules to adjust how frequently the GitLab UI polls for updates. If +you set the multiplier to: + +- A value greater than `1`, UI polling slows down. If you see issues with database load from lots of + clients polling for updates, increasing the multiplier can be a good alternative to disabling + polling completely. For example, if you set the value to `2`, all polling intervals + are multiplied by 2, which means that polling happens half as frequently. +- A value between `0` and `1`, the UI polls more frequently so updates occur more frequently. + **Not recommended**. +- `0`, all polling is disabled. On the next poll, clients stop polling for updates. + +The default value (`1`) is recommended for the majority of GitLab installations. + +## Configure + +To adjust the polling interval multiplier: 1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the left sidebar, select **Settings > Preferences**. -1. Expand **Real-time features**. -1. Set a value for the polling interval multiplier. This multiplier is applied - to all resources at once, and decimal values are supported: - - - `1.0` is the default, and recommended for most installations. - - `0` disables UI polling completely. On the next poll, clients stop - polling for updates. - - A value greater than `1` slows polling down. If you see issues with - database load from lots of clients polling for updates, increasing the - multiplier from 1 can be a good compromise, rather than disabling polling - completely. For example, if you set the value to `2`, all polling intervals - are multiplied by 2, which means that polling happens half as frequently. - - A value between `0` and `1` makes the UI poll more frequently (so updates - show in other sessions faster), but is **not recommended**. `1` should be - fast enough. - +1. Expand **Polling interval multiplier**. +1. Set a value for the polling interval multiplier. This multiplier is applied to all resources at + once. 1. Select **Save changes**. |