diff options
author | Adam Niedzielski <adamsunday@gmail.com> | 2017-04-10 17:52:25 +0300 |
---|---|---|
committer | Adam Niedzielski <adamsunday@gmail.com> | 2017-04-10 17:52:25 +0300 |
commit | 075bdd6cadbf36bb297157671dafaf30b165f959 (patch) | |
tree | cf6e9fb366501bbd027bc17d4f8cd917a98c95f8 /doc/administration/polling.md | |
parent | c98add157732004d9a2eaa39770edf84eaca6896 (diff) |
Document how polling interval is used
Diffstat (limited to 'doc/administration/polling.md')
-rw-r--r-- | doc/administration/polling.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/administration/polling.md b/doc/administration/polling.md new file mode 100644 index 00000000000..35aaa20df2c --- /dev/null +++ b/doc/administration/polling.md @@ -0,0 +1,24 @@ +# Polling configuration + +The GitLab UI polls for updates for different resources (issue notes, issue +titles, pipeline statuses, etc.) on a schedule appropriate to the resource. + +In "Application settings -> Real-time features" you can configure "Polling +interval multiplier". This multiplier is applied to all resources at once, +and decimal values are supported. For the sake of the examples below, we will +say that issue notes poll every 2 seconds, and issue titles poll every 5 +seconds; these are _not_ the actual values. + +- 1 is the default, and recommended for most installations. (Issue notes poll +every 2 seconds, and issue titles poll every 5 seconds.) +- 0 will disable UI polling completely. (On the next poll, clients will stop +polling for updates.) +- A value greater than 1 will slow 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 this is set to 2, then issue notes poll every 4 +seconds, and issue titles poll every 10 seconds.) +- A value between 0 and 1 will make the UI poll more frequently (so updates +will show in other sessions faster), but is **not recommended**. 1 should be +fast enough. (For example, if this is set to 0.5, then issue notes poll every +1 second, and issue titles poll every 2.5 seconds.) |