Class: SimpleThrottle

Inherits:
Object
  • Object
show all
Defined in:
lib/simple_throttle.rb

Overview

Create a simple throttle that can be used to limit the number of request for a resouce per time period. These objects are thread safe.

Constant Summary collapse

LUA_SCRIPT =

Server side Lua script that maintains the throttle in redis. The throttle is stored as a list of timestamps in milliseconds. When the script is invoked it will scan the oldest entries removing any that should be expired from the list. If the list is below the specified limit then the current entry will be added. The list is marked to expire with the oldest entry so there’s no need to cleanup the lists.

"local list_key = KEYS[1]\nlocal limit = tonumber(ARGV[1])\nlocal ttl = tonumber(ARGV[2])\nlocal now = ARGV[3]\nlocal push = tonumber(ARGV[4])\n\nlocal size = redis.call('llen', list_key)\nif size >= limit then\n  local expired = tonumber(now) - ttl\n  while size > 0 do\n    local t = redis.call('lpop', list_key)\n    if tonumber(t) > expired then\n      redis.call('lpush', list_key, t)\n      break\n    end\n    size = size - 1\n  end\nend\n\nif push > 0 and size < limit then\n  redis.call('rpush', list_key, now)\n  redis.call('pexpire', list_key, ttl)\nend\n\nreturn size\n"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, ttl:, limit:, redis: nil) ⇒ SimpleThrottle

Create a new throttle.

Parameters:

  • name (String) —

    unique name for the throttle

  • ttl (Numeric) —

    number of seconds that the throttle will remain active

  • limit (Integer) —

    number of allowed requests within the throttle ttl

  • redis (Redis, Proc) (defaults to: nil) —

    Redis instance to use or a Proc that yields a Redos instance



120
121
122
123
124
125
126
 
# File 'lib/simple_throttle.rb', line 120

def initialize(name, ttl:, limit:, redis: nil)
  @name = name.to_s
  @name = name.dup.freeze unless name.frozen?
  @limit = limit.to_i
  @ttl = ttl.to_f
  @redis = redis
end

Instance Attribute Details

#limit ⇒ Object (readonly)

Returns the value of attribute limit.



112
113
114
 
# File 'lib/simple_throttle.rb', line 112

def limit
  @limit
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



112
113
114
 
# File 'lib/simple_throttle.rb', line 112

def name
  @name
end

#ttl ⇒ Object (readonly)

Returns the value of attribute ttl.



112
113
114
 
# File 'lib/simple_throttle.rb', line 112

def ttl
  @ttl
end

Class Method Details

.[](name) ⇒ SimpleThrottle

Returns a globally defined throttle with the specfied name.

Parameters:

  • name (String, Symbol) —

    name of the throttle

Returns:



64
65
66
67
68
 
# File 'lib/simple_throttle.rb', line 64

def [](name)
  if defined?(@throttles) && @throttles
    @throttles[name.to_s]
  end
end

.add(name, ttl:, limit:, redis: nil) ⇒ void

This method returns an undefined value.

Add a global throttle that can be referenced later with the [] method. This can be used to configure global throttles that you want to setup once and then use in multiple places.

Parameters:

  • name (String) —

    unique name for the throttle

  • ttl (Numeric) —

    number of seconds that the throttle will remain active

  • limit (Integer) —

    number of allowed requests within the throttle ttl

  • redis (Redis, Proc) (defaults to: nil) —

    Redis instance to use or a Proc that yields a Redos instance



53
54
55
56
57
58
 
# File 'lib/simple_throttle.rb', line 53

def add(name, ttl:, limit:, redis: nil)
  @lock.synchronize do
    @throttles ||= {}
    @throttles[name.to_s] = new(name, limit: limit, ttl: ttl, redis: redis)
  end
end

.redis ⇒ Redis

Return the Redis instance where the throttles are stored.

Returns:

  • (Redis) 


86
87
88
89
90
91
92
93
 
# File 'lib/simple_throttle.rb', line 86

def redis
  @redis_client ||= Redis.new
  if @redis_client.is_a?(Proc)
    @redis_client.call
  else
    @redis_client
  end
end

.set_redis(client = nil, &block) ⇒ void

This method returns an undefined value.

Set the Redis instance to use for maintaining the throttle. This can either be set with a hard coded value or by the value yielded by a block. If the block form is used it will be invoked at runtime to get the instance. Use this method if your Redis instance isn’t constant (for example if you’re in a forking environment and re-initialize connections on fork)

Parameters:

  • client (Redis, Proc) (defaults to: nil)

Yield Returns:

  • (Redis) 


79
80
81
 
# File 'lib/simple_throttle.rb', line 79

def set_redis(client = nil, &block)
  @redis_client = (client || block)
end

Instance Method Details

#allowed! ⇒ Boolean

Returns true if the limit for the throttle has not been reached yet. This method will also track the throttled resource as having been invoked on each call.

Returns:

  • (Boolean) 


132
133
134
135
 
# File 'lib/simple_throttle.rb', line 132

def allowed!
  size = current_size(true)
  size < limit
end

#peek ⇒ Integer

Peek at the current number for throttled calls being tracked.

Returns:

  • (Integer) 


147
148
149
 
# File 'lib/simple_throttle.rb', line 147

def peek
  current_size(false)
end

#reset! ⇒ void

This method returns an undefined value.

Reset a throttle back to zero.



140
141
142
 
# File 'lib/simple_throttle.rb', line 140

def reset!
  redis_client.del(redis_key)
end

#wait_time ⇒ Float

Returns when the next resource call should be allowed. Note that this doesn’t guarantee that calling allow! will return true if the wait time is zero since other processes or threads can claim the resource.

Returns:

  • (Float) 


156
157
158
159
160
161
162
163
164
165
 
# File 'lib/simple_throttle.rb', line 156

def wait_time
  if peek < limit
    0.0
  else
    first = redis_client.lindex(redis_key, 0).to_f / 1000.0
    delta = Time.now.to_f - first
    delta = 0.0 if delta < 0
    ttl - delta
  end
end