We’d like to set some cookies to understand how you use this site and remember your settings.
We also use cookies set by other sites to help us deliver content from their services.
You have accepted additional cookies. You can change your cookie settings at any time.
You have rejected additional cookies. You can change your cookie settings at any time.
Gem to provide common config for Sidekiq in GOV.UK applications
Provides a unified set of configurations and behaviours when using Sidekiq in GOV.UK applications.
What does govuk_sidekiq do for you?
govuk_request_id) will be passed on to downstream applications.
Read more about request tracing.# Gemfile
gem "govuk_sidekiq"
# config/sidekiq.yml
---
:concurrency: 2
This file also allows you to configure queues with priority. See the Sidekiq wiki for available options.
For each environment (integration, staging and production), add a REDIS_URL environment variable for your application with a value of redis://shared-redis-govuk.eks.{environment}.govuk-internal.digital.
Additionally, set the value of workerEnabled to true for your application. This will result in a worker process running alongside the web application. The queue length and max delay can be monitored using the Sidekiq Grafana dashboard, once the Sidekiq worker is initialised.
There’s no step-by-step guide for this, but you can copy the changes made when Sidekiq was added to the release application. You may also want to resize resource requests for the app depending on the predicted request rate.
# your-application/config/deploy.rb
after "deploy:restart", "deploy:restart_procfile_worker"
You can use normal Sidekiq jobs:
# app/workers/hard_worker.rb
class HardWorker
include Sidekiq::Worker
def perform(name, count)
# do something
end
end
Note that the convention is to use app/workers as the directory for your workers.
See Sidekiq testing documentation on how to test Sidekiq workers.
Because of the way we use middleware, you may see errors that indicate that
your job is called with the wrong number of arguments. To set up testing
correctly, replace require 'sidekiq/testing' with:
require 'govuk_sidekiq/testing'