class Sidekiq::Throttled::Strategy::Concurrency

Concurrency throttling strategy

Constants

SCRIPT

LUA script used to limit fetch concurrency. Logic behind the scene can be described in following pseudo code:

if @limit <= LLEN(@key)
  return 1
else
  PUSH(@key, @jid)
  return 0
end

Public Class Methods

new(strategy_key, limit:, ttl: 900, key_suffix: nil) click to toggle source

@param [#to_s] strategy_key @param [#to_i, call] limit Amount of allowed concurrent jobs

per processors running for given key.

@param [#to_i] ttl Concurrency lock TTL in seconds. @param [Proc] key_suffix Dynamic key suffix generator.

# File lib/sidekiq/throttled/strategy/concurrency.rb, line 31
def initialize(strategy_key, limit:, ttl: 900, key_suffix: nil)
  @base_key   = "#{strategy_key}:concurrency.v2"
  @limit      = limit
  @ttl        = ttl.to_i
  @key_suffix = key_suffix
end

Public Instance Methods

count(*job_args) click to toggle source

@return [Integer] Current count of jobs

# File lib/sidekiq/throttled/strategy/concurrency.rb, line 58
def count(*job_args)
  Sidekiq.redis { |conn| conn.zcard(key(job_args)) }.to_i
end
dynamic?() click to toggle source

@return [Boolean] Whenever strategy has dynamic config

# File lib/sidekiq/throttled/strategy/concurrency.rb, line 39
def dynamic?
  @key_suffix || @limit.respond_to?(:call)
end
finalize!(jid, *job_args) click to toggle source

Remove jid from the pool of jobs in progress @return [void]

# File lib/sidekiq/throttled/strategy/concurrency.rb, line 70
def finalize!(jid, *job_args)
  Sidekiq.redis { |conn| conn.zrem(key(job_args), jid.to_s) }
end
reset!(*job_args) click to toggle source

Resets count of jobs @return [void]

# File lib/sidekiq/throttled/strategy/concurrency.rb, line 64
def reset!(*job_args)
  Sidekiq.redis { |conn| conn.del(key(job_args)) }
end
throttled?(jid, *job_args) click to toggle source

@return [Boolean] whenever job is throttled or not

# File lib/sidekiq/throttled/strategy/concurrency.rb, line 44
def throttled?(jid, *job_args)
  job_limit = limit(job_args)
  return false unless job_limit
  return true if job_limit <= 0

  keys = [key(job_args)]
  argv = [jid.to_s, job_limit, @ttl, Time.now.to_f]

  Sidekiq.redis do |redis|
    1 == SCRIPT.eval(redis, :keys => keys, :argv => argv)
  end
end