Troubleshooting Sidekiq (FREE SELF)
Sidekiq is the background job processor GitLab uses to asynchronously run tasks. When things go wrong it can be difficult to troubleshoot. These situations also tend to be high-pressure because a production system job queue may be filling up. Users notice when this happens because new branches may not show up and merge requests may not be updated. The following are some troubleshooting steps to help you diagnose the bottleneck.
GitLab administrators/users should consider working through these debug steps with GitLab Support so the backtraces can be analyzed by our team. It may reveal a bug or necessary improvement in GitLab.
In any of the backtraces, be wary of suspecting cases where every thread appears to be waiting in the database, Redis, or waiting to acquire a mutex. This may mean there's contention in the database, for example, but look for one thread that is different than the rest. This other thread may be using all available CPU, or have a Ruby Global Interpreter Lock, preventing other threads from continuing.
Log arguments to Sidekiq jobs
In GitLab 13.6 and later some arguments passed to Sidekiq jobs are logged by default. To avoid logging sensitive information (for instance, password reset tokens), GitLab logs numeric arguments for all workers, with overrides for some specific workers where their arguments are not sensitive.
Example log output:
{"severity":"INFO","time":"2020-06-08T14:37:37.892Z","class":"AdminEmailsWorker","args":["[FILTERED]","[FILTERED]","[FILTERED]"],"retry":3,"queue":"admin_emails","backtrace":true,"jid":"9e35e2674ac7b12d123e13cc","created_at":"2020-06-08T14:37:37.373Z","meta.user":"root","meta.caller_id":"Admin::EmailsController#create","correlation_id":"37D3lArJmT1","uber-trace-id":"2d942cc98cc1b561:6dc94409cfdd4d77:9fbe19bdee865293:1","enqueued_at":"2020-06-08T14:37:37.410Z","pid":65011,"message":"AdminEmailsWorker JID-9e35e2674ac7b12d123e13cc: done: 0.48085 sec","job_status":"done","scheduling_latency_s":0.001012,"redis_calls":9,"redis_duration_s":0.004608,"redis_read_bytes":696,"redis_write_bytes":6141,"duration_s":0.48085,"cpu_s":0.308849,"completed_at":"2020-06-08T14:37:37.892Z","db_duration_s":0.010742}
{"severity":"INFO","time":"2020-06-08T14:37:37.894Z","class":"ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper","wrapped":"ActionMailer::MailDeliveryJob","queue":"mailers","args":["[FILTERED]"],"retry":3,"backtrace":true,"jid":"e47a4f6793d475378432e3c8","created_at":"2020-06-08T14:37:37.884Z","meta.user":"root","meta.caller_id":"AdminEmailsWorker","correlation_id":"37D3lArJmT1","uber-trace-id":"2d942cc98cc1b561:29344de0f966446d:5c3b0e0e1bef987b:1","enqueued_at":"2020-06-08T14:37:37.885Z","pid":65011,"message":"ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper JID-e47a4f6793d475378432e3c8: start","job_status":"start","scheduling_latency_s":0.009473}
{"severity":"INFO","time":"2020-06-08T14:39:50.648Z","class":"NewIssueWorker","args":["455","1"],"retry":3,"queue":"new_issue","backtrace":true,"jid":"a24af71f96fd129ec47f5d1e","created_at":"2020-06-08T14:39:50.643Z","meta.user":"root","meta.project":"h5bp/html5-boilerplate","meta.root_namespace":"h5bp","meta.caller_id":"Projects::IssuesController#create","correlation_id":"f9UCZHqhuP7","uber-trace-id":"28f65730f99f55a3:a5d2b62dec38dffc:48ddd092707fa1b7:1","enqueued_at":"2020-06-08T14:39:50.646Z","pid":65011,"message":"NewIssueWorker JID-a24af71f96fd129ec47f5d1e: start","job_status":"start","scheduling_latency_s":0.001144}
When using Sidekiq JSON logging,
arguments logs are limited to a maximum size of 10 kilobytes of text;
any arguments after this limit are discarded and replaced with a
single argument containing the string "..."
.
You can set SIDEKIQ_LOG_ARGUMENTS
environment variable
to 0
(false) to disable argument logging.
Example:
gitlab_rails['env'] = {"SIDEKIQ_LOG_ARGUMENTS" => "0"}
In GitLab 13.5 and earlier, set SIDEKIQ_LOG_ARGUMENTS
to 1
to start logging arguments passed to Sidekiq.
Investigating Sidekiq queue backlogs or slow performance
Symptoms of slow Sidekiq performance include problems with merge request status updates, and delays before CI pipelines start running.
Potential causes include:
-
The GitLab instance may need more Sidekiq workers. By default, a single-node Linux package installation runs one worker, restricting the execution of Sidekiq jobs to a maximum of one CPU core. Read more about running multiple Sidekiq workers.
-
The instance is configured with more Sidekiq workers, but most of the extra workers are not configured to run any job that is queued. This can result in a backlog of jobs when the instance is busy, if the workload has changed in the months or years since the workers were configured, or as a result of GitLab product changes.
Gather data on the state of the Sidekiq workers with the following Ruby script.
-
Create the script:
cat > /var/opt/gitlab/sidekiqcheck.rb <<EOF require 'sidekiq/monitor' Sidekiq::Monitor::Status.new.display('overview') Sidekiq::Monitor::Status.new.display('processes'); nil Sidekiq::Monitor::Status.new.display('queues'); nil puts "----------- workers ----------- " workers = Sidekiq::Workers.new workers.each do |_process_id, _thread_id, work| pp work end puts "----------- Queued Jobs ----------- " Sidekiq::Queue.all.each do |queue| queue.each do |job| pp job end end ;nil puts "----------- done! ----------- " EOF
-
Execute and capture the output:
sudo gitlab-rails runner /var/opt/gitlab/sidekiqcheck.rb > /tmp/sidekiqcheck_$(date '+%Y%m%d-%H:%M').out
If the performance issue is intermittent:
-
Run this in a cron job every five minutes. Write the files to a location with enough space: allow for at least 500 KB per file.
cat > /etc/cron.d/sidekiqcheck <<EOF */5 * * * * root /opt/gitlab/bin/gitlab-rails runner /var/opt/gitlab/sidekiqcheck.rb > /tmp/sidekiqcheck_$(date '+\%Y\%m\%d-\%H:\%M').out 2>&1 EOF
-
Refer back to the data to see what went wrong.
-
-
Analyze the output. The following commands assume that you have a directory of output files.
-
grep 'Busy: ' *
shows how many jobs were being run.grep 'Enqueued: ' *
shows the backlog of work at that time. -
Look at the number of busy threads across the workers in samples where Sidekiq is under load:
ls | while read f ; do if grep -q 'Enqueued: 0' $f; then : else echo $f; egrep 'Busy:|Enqueued:|---- Processes' $f grep 'Threads:' $f ; fi done | more
Example output:
sidekiqcheck_20221024-14:00.out Busy: 47 Enqueued: 363 ---- Processes (13) ---- Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 23 (0 busy) Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 30 (0 busy) Threads: 30 (24 busy) Threads: 30 (23 busy)
-
In this output file, 47 threads were busy, and there was a backlog of 363 jobs.
-
Of the 13 worker processes, only two were busy.
-
This indicates that the other workers are configured too specifically.
-
Look at the full output to work out which workers were busy. Correlate with your
sidekiq_queues
configuration ingitlab.rb
. -
An overloaded single-worker environment might look like this:
sidekiqcheck_20221024-14:00.out Busy: 25 Enqueued: 363 ---- Processes (1) ---- Threads: 25 (25 busy)
-
-
Look at the
---- Queues (xxx) ----
section of the output file to determine what jobs were queued up at the time. -
The files also include low level details about the state of Sidekiq at the time. This could be useful for identifying where spikes in workload are coming from.
- The
----------- workers -----------
section details the jobs that make up theBusy
count in the summary. - The
----------- Queued Jobs -----------
section provides details on jobs that areEnqueued
.
- The
-
Thread dump
Send the Sidekiq process ID the TTIN
signal to output thread
backtraces in the log file.
kill -TTIN <sidekiq_pid>
Check in /var/log/gitlab/sidekiq/current
or $GITLAB_HOME/log/sidekiq.log
for
the backtrace output. The backtraces are lengthy and generally start with
several WARN
level messages. Here's an example of a single thread's backtrace:
2016-04-13T06:21:20.022Z 31517 TID-orn4urby0 WARN: ActiveRecord::RecordNotFound: Couldn't find Note with 'id'=3375386
2016-04-13T06:21:20.022Z 31517 TID-orn4urby0 WARN: /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/activerecord-4.2.5.2/lib/active_record/core.rb:155:in `find'
/opt/gitlab/embedded/service/gitlab-rails/app/workers/new_note_worker.rb:7:in `perform'
/opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/sidekiq-4.0.1/lib/sidekiq/processor.rb:150:in `execute_job'
/opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/sidekiq-4.0.1/lib/sidekiq/processor.rb:132:in `block (2 levels) in process'
/opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/sidekiq-4.0.1/lib/sidekiq/middleware/chain.rb:127:in `block in invoke'
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/sidekiq_middleware/memory_killer.rb:17:in `call'
/opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/sidekiq-4.0.1/lib/sidekiq/middleware/chain.rb:129:in `block in invoke'
/opt/gitlab/embedded/service/gitlab-rails/lib/gitlab/sidekiq_middleware/arguments_logger.rb:6:in `call'
...
In some cases Sidekiq may be hung and unable to respond to the TTIN
signal.
Move on to other troubleshooting methods if this happens.
rbspy
Ruby profiling with rbspy is an easy to use and low-overhead Ruby profiler that can be used to create flamegraph-style diagrams of CPU usage by Ruby processes.
No changes to GitLab are required to use it and it has no dependencies. To install it:
- Download the binary from the
rbspy
releases page. - Make the binary executable.
To profile a Sidekiq worker for one minute, run:
sudo ./rbspy record --pid <sidekiq_pid> --duration 60 --file /tmp/sidekiq_profile.svg
In this example of a flamegraph generated by rbspy
, almost all of the Sidekiq process's time is spent in rev_parse
, a native C
function in Rugged. In the stack, we can see rev_parse
is being called by the ExpirePipelineCacheWorker
.
perf
Process profiling with Linux has a process profiling tool called perf
that is helpful when a certain
process is eating up a lot of CPU. If you see high CPU usage and Sidekiq isn't
responding to the TTIN
signal, this is a good next step.
If perf
is not installed on your system, install it with apt-get
or yum
:
# Debian
sudo apt-get install linux-tools
# Ubuntu (may require these additional Kernel packages)
sudo apt-get install linux-tools-common linux-tools-generic linux-tools-`uname -r`
# Red Hat/CentOS
sudo yum install perf
Run perf
against the Sidekiq PID:
sudo perf record -p <sidekiq_pid>
Let this run for 30-60 seconds and then press Ctrl-C. Then view the perf
report:
$ sudo perf report
# Sample output
Samples: 348K of event 'cycles', Event count (approx.): 280908431073
97.69% ruby nokogiri.so [.] xmlXPathNodeSetMergeAndClear
0.18% ruby libruby.so.2.1.0 [.] objspace_malloc_increase
0.12% ruby libc-2.12.so [.] _int_malloc
0.10% ruby libc-2.12.so [.] _int_free
Above you see sample output from a perf
report. It shows that 97% of the CPU is
being spent inside Nokogiri and xmlXPathNodeSetMergeAndClear
. For something
this obvious you should then go investigate what job in GitLab would use
Nokogiri and XPath. Combine with TTIN
or gdb
output to show the
corresponding Ruby code where this is happening.
gdb
)
The GNU Project Debugger (gdb
can be another effective tool for debugging Sidekiq. It gives you a little
more interactive way to look at each thread and see what's causing problems.
Attaching to a process with gdb
suspends the standard operation
of the process (Sidekiq does not process jobs while gdb
is attached).
Start by attaching to the Sidekiq PID:
gdb -p <sidekiq_pid>
Then gather information on all the threads:
info threads
# Example output
30 Thread 0x7fe5fbd63700 (LWP 26060) 0x0000003f7cadf113 in poll () from /lib64/libc.so.6
29 Thread 0x7fe5f2b3b700 (LWP 26533) 0x0000003f7ce0b68c in pthread_cond_wait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
28 Thread 0x7fe5f2a3a700 (LWP 26534) 0x0000003f7ce0ba5e in pthread_cond_timedwait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
27 Thread 0x7fe5f2939700 (LWP 26535) 0x0000003f7ce0b68c in pthread_cond_wait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
26 Thread 0x7fe5f2838700 (LWP 26537) 0x0000003f7ce0b68c in pthread_cond_wait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
25 Thread 0x7fe5f2737700 (LWP 26538) 0x0000003f7ce0b68c in pthread_cond_wait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
24 Thread 0x7fe5f2535700 (LWP 26540) 0x0000003f7ce0b68c in pthread_cond_wait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
23 Thread 0x7fe5f2434700 (LWP 26541) 0x0000003f7ce0b68c in pthread_cond_wait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
22 Thread 0x7fe5f2232700 (LWP 26543) 0x0000003f7ce0b68c in pthread_cond_wait@@GLIBC_2.3.2 () from /lib64/libpthread.so.0
21 Thread 0x7fe5f2131700 (LWP 26544) 0x00007fe5f7b570f0 in xmlXPathNodeSetMergeAndClear ()
from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
...
If you see a suspicious thread, like the Nokogiri one above, you may want to get more information:
thread 21
bt
# Example output
#0 0x00007ff0d6afe111 in xmlXPathNodeSetMergeAndClear () from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
#1 0x00007ff0d6b0b836 in xmlXPathNodeCollectAndTest () from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
#2 0x00007ff0d6b09037 in xmlXPathCompOpEval () from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
#3 0x00007ff0d6b09017 in xmlXPathCompOpEval () from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
#4 0x00007ff0d6b092e0 in xmlXPathCompOpEval () from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
#5 0x00007ff0d6b0bc37 in xmlXPathRunEval () from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
#6 0x00007ff0d6b0be5f in xmlXPathEvalExpression () from /opt/gitlab/embedded/service/gem/ruby/2.1.0/gems/nokogiri-1.6.7.2/lib/nokogiri/nokogiri.so
#7 0x00007ff0d6a97dc3 in evaluate (argc=2, argv=0x1022d058, self=<value optimized out>) at xml_xpath_context.c:221
#8 0x00007ff0daeab0ea in vm_call_cfunc_with_frame (th=0x1022a4f0, reg_cfp=0x1032b810, ci=<value optimized out>) at vm_insnhelper.c:1510
To output a backtrace from all threads at once:
set pagination off
thread apply all bt
Once you're done debugging with gdb
, be sure to detach from the process and
exit:
detach
exit
Sidekiq kill signals
TTIN was described above as the signal to print backtraces for logging, however Sidekiq responds to other signals as well. For example, TSTP and TERM can be used to gracefully shut Sidekiq down, see the Sidekiq Signals docs.
Check for blocking queries
Sometimes the speed at which Sidekiq processes jobs can be so fast that it can cause database contention. Check for blocking queries when backtraces above show that many threads are stuck in the database adapter.
The PostgreSQL wiki has details on the query you can run to see blocking queries. The query is different based on PostgreSQL version. See Lock Monitoring for the query details.
Managing Sidekiq queues
It is possible to use Sidekiq API to perform a number of troubleshooting steps on Sidekiq.
These are the administrative commands and it should only be used if currently administration interface is not suitable due to scale of installation.
All these commands should be run using gitlab-rails console
.
View the queue size
Sidekiq::Queue.new("pipeline_processing:build_queue").size
Enumerate all enqueued jobs
queue = Sidekiq::Queue.new("chaos:chaos_sleep")
queue.each do |job|
# job.klass # => 'MyWorker'
# job.args # => [1, 2, 3]
# job.jid # => jid
# job.queue # => chaos:chaos_sleep
# job["retry"] # => 3
# job.item # => {
# "class"=>"Chaos::SleepWorker",
# "args"=>[1000],
# "retry"=>3,
# "queue"=>"chaos:chaos_sleep",
# "backtrace"=>true,
# "queue_namespace"=>"chaos",
# "jid"=>"39bc482b823cceaf07213523",
# "created_at"=>1566317076.266069,
# "correlation_id"=>"c323b832-a857-4858-b695-672de6f0e1af",
# "enqueued_at"=>1566317076.26761},
# }
# job.delete if job.jid == 'abcdef1234567890'
end
Enumerate currently running jobs
workers = Sidekiq::Workers.new
workers.each do |process_id, thread_id, work|
# process_id is a unique identifier per Sidekiq process
# thread_id is a unique identifier per thread
# work is a Hash which looks like:
# {"queue"=>"chaos:chaos_sleep",
# "payload"=>
# { "class"=>"Chaos::SleepWorker",
# "args"=>[1000],
# "retry"=>3,
# "queue"=>"chaos:chaos_sleep",
# "backtrace"=>true,
# "queue_namespace"=>"chaos",
# "jid"=>"b2a31e3eac7b1a99ff235869",
# "created_at"=>1566316974.9215662,
# "correlation_id"=>"e484fb26-7576-45f9-bf21-b99389e1c53c",
# "enqueued_at"=>1566316974.9229589},
# "run_at"=>1566316974}],
end
Remove Sidekiq jobs for given parameters (destructive)
The general method to kill jobs conditionally is the following command, which removes jobs that are queued but not started. Running jobs cannot be killed.
queue = Sidekiq::Queue.new('<queue name>')
queue.each { |job| job.delete if <condition>}
Have a look at the section below for cancelling running jobs.
In the method above, <queue-name>
is the name of the queue that contains the jobs you want to delete and <condition>
decides which jobs get deleted.
Commonly, <condition>
references the job arguments, which depend on the type of job in question. To find the arguments for a specific queue, you can have a look at the perform
function of the related worker file, commonly found at /app/workers/<queue-name>_worker.rb
.
For example, repository_import
has project_id
as the job argument, while update_merge_requests
has project_id, user_id, oldrev, newrev, ref
.
Arguments need to be referenced by their sequence ID using job.args[<id>]
because job.args
is a list of all arguments provided to the Sidekiq job.
Here are some examples:
queue = Sidekiq::Queue.new('update_merge_requests')
# In this example, we want to remove any update_merge_requests jobs
# for the Project with ID 125 and ref `ref/heads/my_branch`
queue.each { |job| job.delete if job.args[0] == 125 and job.args[4] == 'ref/heads/my_branch' }
# Cancelling jobs like: `RepositoryImportWorker.new.perform_async(100)`
id_list = [100]
queue = Sidekiq::Queue.new('repository_import')
queue.each do |job|
job.delete if id_list.include?(job.args[0])
end
Remove specific job ID (destructive)
queue = Sidekiq::Queue.new('repository_import')
queue.each do |job|
job.delete if job.jid == 'my-job-id'
end
Canceling running jobs (destructive)
Introduced in GitLab 12.3.
This is highly risky operation and use it as last resort. Doing that might result in data corruption, as the job is interrupted mid-execution and it is not guaranteed that proper rollback of transactions is implemented.
Gitlab::SidekiqDaemon::Monitor.cancel_job('job-id')
This requires the Sidekiq to be run with
SIDEKIQ_MONITOR_WORKER=1
environment variable.
To perform of the interrupt we use Thread.raise
which
has number of drawbacks, as mentioned in Why Ruby's Timeout is dangerous (and Thread.raise is terrifying):
This is where the implications get interesting, and terrifying. This means that an exception can get raised:
- during a network request (ok, as long as the surrounding code is prepared to catch Timeout::Error)
- during the cleanup for the network request
- during a rescue block
- while creating an object to save to the database afterwards
- in any of your code, regardless of whether it could have possibly raised an exception before
Nobody writes code to defend against an exception being raised on literally any line. That's not even possible. So Thread.raise is basically like a sneak attack on your code that could result in almost anything. It would probably be okay if it were pure-functional code that did not modify any state. But this is Ruby, so that's unlikely :)
Manually trigger a cron job
By visiting /admin/background_jobs
, you can look into what jobs are scheduled/running/pending on your instance.
You can trigger a cron job from the UI by selecting the "Enqueue Now" button. To trigger a cron job programmatically first open a Rails console.
To find the cron job you want to test:
job = Sidekiq::Cron::Job.find('job-name')
# get status of job:
job.status
# enqueue job right now!
job.enque!
For example, to trigger the update_all_mirrors_worker
cron job that updates the repository mirrors:
irb(main):001:0> job = Sidekiq::Cron::Job.find('update_all_mirrors_worker')
=>
#<Sidekiq::Cron::Job:0x00007f147f84a1d0
...
irb(main):002:0> job.status
=> "enabled"
irb(main):003:0> job.enque!
=> 257
The list of available jobs can be found in the workers directory.
For more information about Sidekiq jobs, see the Sidekiq-cron documentation.
Clearing a Sidekiq job deduplication idempotency key
Occasionally, jobs that are expected to run (for example, cron jobs) are observed to not run at all. When checking the logs, there might be instances where jobs are seen to not run with a "job_status": "deduplicated"
.
This can happen when a job failed and the idempotency key was not cleared properly. For example, stopping Sidekiq kills any remaining jobs after 25 seconds.
By default, the key expires after 6 hours,
but if you want to clear the idempotency key immediately, follow the following steps (the example provided is for Geo::VerificationBatchWorker
):
- Find the worker class and
args
of the job in the Sidekiq logs:
{ ... "class":"Geo::VerificationBatchWorker","args":["container_repository"] ... }
- Start a Rails console session.
- Run the following snippet:
worker_class = Geo::VerificationBatchWorker
args = ["container_repository"]
dj = Gitlab::SidekiqMiddleware::DuplicateJobs::DuplicateJob.new({ 'class' => worker_class.name, 'args' => args }, worker_class.queue)
dj.send(:idempotency_key)
dj.delete!
sidekiq-cluster
service (Linux package installations)
GitLab 14.0 and later: remove the Linux package instances that were configured to run sidekiq-cluster
prior to GitLab 14.0
might still have this service running along side sidekiq
in later releases.
The code to manage sidekiq-cluster
was removed in GitLab 14.0.
The configuration files remain on disk so the sidekiq-cluster
process continues
to be started by the GitLab systemd service .
The extra service can be identified as running by:
-
gitlab-ctl status
showing both services:run: sidekiq: (pid 1386) 445s; run: log: (pid 1385) 445s run: sidekiq-cluster: (pid 1388) 445s; run: log: (pid 1381) 445s
-
ps -ef | grep 'runsv sidekiq'
showing two processes:root 31047 31045 0 13:54 ? 00:00:00 runsv sidekiq-cluster root 31054 31045 0 13:54 ? 00:00:00 runsv sidekiq
To remove the sidekiq-cluster
service from servers running GitLab 14.0 and later:
-
Stop GitLab and the systemd service:
sudo gitlab-ctl stop sudo systemctl stop gitlab-runsvdir.service
-
Remove the
runsv
service definition:sudo rm -rf /opt/gitlab/sv/sidekiq-cluster
-
Restart GitLab:
sudo systemctl start gitlab-runsvdir.service
-
Check that all services are up, and the
sidekiq-cluster
service is not listed:sudo gitlab-ctl status
This change might reduce the amount of work Sidekiq can do. Symptoms like delays creating pipelines
indicate that additional Sidekiq processes would be beneficial.
Consider adding additional Sidekiq processes
to compensate for removing the sidekiq-cluster
service.