Class: Logster::RedisRateLimiter

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

Constant Summary collapse

BUCKETS = 
6
PREFIX = 
"__LOGSTER__RATE_LIMIT".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(redis, severities, limit, duration, redis_prefix = nil, callback = nil) ⇒ RedisRateLimiter

Returns a new instance of RedisRateLimiter.



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/logster/redis_rate_limiter.rb', line 21

def initialize(redis, severities, limit, duration, redis_prefix = nil, callback = nil)
  @severities = severities
  @limit = limit
  @duration = duration
  @callback = callback
  @redis_prefix = redis_prefix
  @redis = redis
  @bucket_range = @duration / BUCKETS
  @mget_keys = (0..(BUCKETS - 1)).map { |i| "#{key}:#{i}" }
end

Instance Attribute Details

#callback ⇒ Object (readonly)

Returns the value of attribute callback.



8
9
10
 
# File 'lib/logster/redis_rate_limiter.rb', line 8

def callback
  @callback
end

#duration ⇒ Object (readonly)

Returns the value of attribute duration.



8
9
10
 
# File 'lib/logster/redis_rate_limiter.rb', line 8

def duration
  @duration
end

Class Method Details

.clear_all(redis, redis_prefix = nil) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
 
# File 'lib/logster/redis_rate_limiter.rb', line 10

def self.clear_all(redis, redis_prefix = nil)
  prefix = key_prefix(redis_prefix)

  redis.eval "
  local keys = redis.call('keys', '*#{prefix}*')
  if (table.getn(keys) > 0) then
    redis.call('del', unpack(keys))
  end
  "
end

Instance Method Details

#callback_key ⇒ Object 



77
78
79
 
# File 'lib/logster/redis_rate_limiter.rb', line 77

def callback_key
  "#{key}:callback_triggered"
end

#check(severity) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/logster/redis_rate_limiter.rb', line 36

def check(severity)
  return unless @severities.include?(severity)
  time = Time.now.to_i
  num = bucket_number(time)
  redis_key = "#{key}:#{num}"

  current_rate = @redis.eval "    local bucket_number = \#{num}\n    local bucket_count = redis.call(\"INCR\", \"\#{redis_key}\")\n\n    if bucket_count == 1 then\n      redis.call(\"EXPIRE\", \"\#{redis_key}\", \"\#{bucket_expiry(time)}\")\n      redis.call(\"DEL\", \"\#{callback_key}\")\n    end\n\n    local function retrieve_rate ()\n      local sum = 0\n      local values = redis.call(\"MGET\", \#{mget_keys(num)})\n      for index, value in ipairs(values) do\n        if value ~= false then sum = sum + value end\n      end\n      return sum\n    end\n\n    return (retrieve_rate() + bucket_count)\n  LUA\n\n  if [email protected](callback_key) && (current_rate >= @limit)\n    @callback.call(current_rate) if @callback\n    @redis.set(callback_key, 1)\n  end\n\n  current_rate\nend\n"

#key ⇒ Object 



71
72
73
74
75
 
# File 'lib/logster/redis_rate_limiter.rb', line 71

def key
  # "_LOGSTER_RATE_LIMIT:012:20:30"
  # Triggers callback when log levels of :debug, :info and :warn occurs 20 times within 30 secs
  "#{key_prefix}:#{@severities.join("")}:#{@limit}:#{@duration}"
end

#retrieve_rate ⇒ Object 



32
33
34
 
# File 'lib/logster/redis_rate_limiter.rb', line 32

def retrieve_rate
  @redis.mget(@mget_keys).reduce(0) { |sum, value| sum + value.to_i }
end