summaryrefslogtreecommitdiff
path: root/doc/administration
diff options
context:
space:
mode:
authorPatricio Cano <suprnova32@gmail.com>2016-11-10 11:36:52 -0600
committerPatricio Cano <suprnova32@gmail.com>2016-11-11 11:14:58 -0600
commite840749b84ceb226e46ebdfb489c735e3370cff7 (patch)
tree54026ef9b905cdbfad9d6aee9320f0f530c4dd09 /doc/administration
parent208530494e5d2c5c62a3e1c24489aae0e4935e3a (diff)
downloadgitlab-ce-e840749b84ceb226e46ebdfb489c735e3370cff7.tar.gz
Refactored Sidekiq Throttler and updated documentationsidekiq-job-throttling
Diffstat (limited to 'doc/administration')
-rw-r--r--doc/administration/operations/sidekiq_job_throttling.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/administration/operations/sidekiq_job_throttling.md b/doc/administration/operations/sidekiq_job_throttling.md
index 33cedee7ebd..ddeaa22e288 100644
--- a/doc/administration/operations/sidekiq_job_throttling.md
+++ b/doc/administration/operations/sidekiq_job_throttling.md
@@ -3,14 +3,15 @@
> Note: Introduced with GitLab 8.14
When your GitLab installation needs to handle tens of thousands of background
-jobs, it can be convenient to prioritize queues that need to be executed
-immediately, e.g. user initiated actions like merging a Merge Request.
+jobs, it can be convenient to throttle queues that do not need to be executed
+immediately, e.g. long running jobs like Pipelines, thus allowing jobs that do
+need to be executed immediately to have access to more resources.
In order to accomplish this, you can limit the amount of workers that certain
-slow running queues get can have available. This is what we call Sidekiq Job
+slow running queues can have available. This is what we call Sidekiq Job
Throttling. Depending on your infrastructure, you might have different slow
-running queues, which is why you can choose which queues to throttle and by
-how much you want to throttle them.
+running queues, which is why you can choose which queues you want to throttle
+and by how much you want to throttle them.
These settings are available in the Application Settings of your GitLab
installation.
@@ -24,8 +25,8 @@ and rounded up to the closest full integer.
So, for example, you set the `:concurrency` to 25 and the `Throttling factor` to
0.1, the maximum workers assigned to the selected queues would be 3.
-```
-limit = (factor * Sidekiq.options[:concurrency]).ceil
+```ruby
+queue_limit = (factor * Sidekiq.options[:concurrency]).ceil
```
After enabling the job throttling, you will need to restart your GitLab