Permalink
Browse files

Allow the Sidekiq queues to throttle and the factor by which to throt…

…tle them to be configurable
  • Loading branch information...
supernova32 committed Nov 4, 2016
1 parent 9e2964c commit b95216aabadb336e4ed8cdc01f69e873f47f10d0
@@ -118,6 +118,7 @@ def application_setting_params
:container_registry_token_expire_delay,
:enabled_git_access_protocol,
:sidekiq_throttling_enabled,
:sidekiq_throttling_factor,
:housekeeping_enabled,
:housekeeping_bitmaps_enabled,
:housekeeping_incremental_repack_period,
@@ -126,7 +127,8 @@ def application_setting_params
repository_storages: [],
restricted_visibility_levels: [],
import_sources: [],
disabled_oauth_sign_in_sources: []
disabled_oauth_sign_in_sources: [],
sidekiq_throttling_queues: []
)
end
end
@@ -100,4 +100,8 @@ def repository_storages_options_for_select
options_for_select(options, @application_setting.repository_storages)
end
def sidekiq_queue_options_for_select
options_for_select(Sidekiq::Queue.all.map(&:name), @application_setting.sidekiq_throttling_queues)
end
end
@@ -19,6 +19,7 @@ class ApplicationSetting < ActiveRecord::Base
serialize :domain_whitelist, Array
serialize :domain_blacklist, Array
serialize :repository_storages
serialize :sidekiq_throttling_queues
cache_markdown_field :sign_in_text
cache_markdown_field :help_page_text
@@ -85,6 +86,15 @@ class ApplicationSetting < ActiveRecord::Base
presence: { message: 'Domain blacklist cannot be empty if Blacklist is enabled.' },
if: :domain_blacklist_enabled?
validates :sidekiq_throttling_factor,
numericality: { greater_than: 0, less_than: 1 },
presence: { message: 'Throttling factor cannot be empty if Sidekiq Throttling is enabled.' },
if: :sidekiq_throttling_enabled?
validates :sidekiq_throttling_queues,
presence: { message: 'Queues to throttle cannot be empty if Sidekiq Throttling is enabled.' },
if: :sidekiq_throttling_enabled?
validates :housekeeping_incremental_repack_period,
presence: true,
numericality: { only_integer: true, greater_than: 0 }
@@ -295,6 +295,18 @@
Enable Sidekiq Job Throttling
.help-block
Limit the amount of resources slow running jobs are assigned.
.form-group
= f.label :sidekiq_throttling_queues, 'Sidekiq queues to throttle', class: 'control-label col-sm-2'
.col-sm-10
= f.select :sidekiq_throttling_queues, sidekiq_queue_options_for_select, { include_hidden: false }, multiple: true, class: 'select2 select-wide', data: { field: 'sidekiq_throttling_queues' }
.help-block
Choose which queues you wish to throttle.
.form-group
= f.label :sidekiq_throttling_factor, 'Throttling Factor', class: 'control-label col-sm-2'
.col-sm-10
= f.number_field :sidekiq_throttling_factor, class: 'form-control', min: '0', max: '0.99', step: '0.01'
.help-block
The factor by which the queues should be throttled. A value between 0.1 and 0.9.
%fieldset
%legend Spam and Anti-bot Protection
@@ -1,6 +1,3 @@
require 'gitlab/current_settings'
include Gitlab::CurrentSettings
# Custom Redis configuration
redis_config_hash = Gitlab::Redis.params
redis_config_hash[:namespace] = Gitlab::Redis::SIDEKIQ_NAMESPACE
@@ -32,16 +29,11 @@
end
Sidekiq::Cron::Job.load_from_hash! cron_jobs
# allow it to fail: it may do so when create_from_defaults is executed before migrations are actually done
begin
throttling_enabled = current_application_settings.sidekiq_throttling_enabled
rescue
throttling_enabled = false
end
if Gitlab::CurrentSettings.sidekiq_throttling_enabled?
factor = current_application_settings.sidekiq_throttling_factor
if throttling_enabled
{ 'project_cache' => 0.1, 'pipeline' => 0.1 }.each do |queue, ratio|
Sidekiq::Queue[queue].limit = (ratio * Sidekiq.options[:concurrency]).ceil
current_application_settings.sidekiq_throttling_queues.each do |queue|
Sidekiq::Queue[queue].limit = (factor * Sidekiq.options[:concurrency]).ceil
end
end
@@ -25,5 +25,7 @@ class AddSidekiqThrottlingToApplicationSettings < ActiveRecord::Migration
def change
add_column :application_settings, :sidekiq_throttling_enabled, :boolean, default: false
add_column :application_settings, :sidekiq_throttling_queues, :string
add_column :application_settings, :sidekiq_throttling_factor, :decimal
end
end
View
@@ -99,6 +99,8 @@
t.text "shared_runners_text_html"
t.text "after_sign_up_text_html"
t.boolean "sidekiq_throttling_enabled", default: false
t.string "sidekiq_throttling_queues"
t.decimal "sidekiq_throttling_factor"
t.boolean "housekeeping_enabled", default: true, null: false
t.boolean "housekeeping_bitmaps_enabled", default: true, null: false
t.integer "housekeeping_incremental_repack_period", default: 10, null: false
@@ -23,6 +23,10 @@ def ensure_application_settings!
settings || fake_application_settings
end
def sidekiq_throttling_enabled?
current_application_settings.sidekiq_throttling_enabled
end
def fake_application_settings
OpenStruct.new(
default_projects_limit: Settings.gitlab['default_projects_limit'],

0 comments on commit b95216a

Please sign in to comment.