Class: Logster::RedisStore

Inherits:
BaseStore show all
Defined in:
lib/logster/redis_store.rb

Instance Attribute Summary collapse

Attributes inherited from BaseStore

#allow_custom_patterns, #ignore, #level, #max_retention, #skip_empty

Instance Method Summary collapse

Methods inherited from BaseStore

#clear_suppression_patterns_cache, #report

Constructor Details

#initialize(redis = nil) ⇒ RedisStore

Returns a new instance of RedisStore.



13
14
15
16
17
18
19
 
# File 'lib/logster/redis_store.rb', line 13

def initialize(redis = nil)
  super()
  @redis = redis || Redis.new
  @max_backlog = 1000
  @redis_prefix = nil
  @redis_raw_connection = nil
end

Instance Attribute Details

#max_backlog ⇒ Object

Returns the value of attribute max_backlog.



10
11
12
 
# File 'lib/logster/redis_store.rb', line 10

def max_backlog
  @max_backlog
end

#redis ⇒ Object

Returns the value of attribute redis.



10
11
12
 
# File 'lib/logster/redis_store.rb', line 10

def redis
  @redis
end

#redis_prefix ⇒ Object 



239
240
241
242
243
 
# File 'lib/logster/redis_store.rb', line 239

def redis_prefix
  return 'default'.freeze if !@redis_prefix
  @prefix_is_proc ||= @redis_prefix.respond_to?(:call)
  @prefix_is_proc ? @redis_prefix.call : @redis_prefix
end

#redis_raw_connection ⇒ Object

Returns the value of attribute redis_raw_connection.



10
11
12
 
# File 'lib/logster/redis_store.rb', line 10

def redis_raw_connection
  @redis_raw_connection
end

Instance Method Details

#bulk_get(message_keys) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/logster/redis_store.rb', line 192

def bulk_get(message_keys)
  envs = @redis.hmget(env_key, message_keys)
  @redis.hmget(hash_key, message_keys).map!.with_index do |json, ind|
    message = Message.from_json(json)
    env = envs[ind]
    if !message.env || message.env.size == 0
      env = env && env.size > 0 ? ::JSON.parse(env) : {}
      message.env = env
    end
    message
  end
end

#clear ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/logster/redis_store.rb', line 129

def clear
  RedisRateLimiter.clear_all(@redis)
  @redis.del(solved_key)
  @redis.del(list_key)
  keys = @redis.smembers(protected_key) || []
  if keys.empty?
    @redis.del(hash_key)
    @redis.del(env_key)
  else
    protected = @redis.mapped_hmget(hash_key, *keys)
    protected_env = @redis.mapped_hmget(env_key, *keys)
    @redis.del(hash_key)
    @redis.del(env_key)
    @redis.mapped_hmset(hash_key, protected)
    @redis.mapped_hmset(env_key, protected_env)

    sorted = protected
      .values
      .map { |string|
        Message.from_json(string) rescue nil
      }
      .compact
      .sort
      .map(&:key)

    @redis.pipelined do
      sorted.each do |message_key|
        @redis.rpush(list_key, message_key)
      end
    end
  end
end

#clear_all ⇒ Object

Delete everything, included protected messages (use in tests)



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/logster/redis_store.rb', line 164

def clear_all
  @redis.del(list_key)
  @redis.del(protected_key)
  @redis.del(hash_key)
  @redis.del(env_key)
  @redis.del(grouping_key)
  @redis.del(solved_key)
  @redis.del(ignored_logs_count_key)
  Logster::PATTERNS.each do |klass|
    @redis.del(klass.set_name)
  end
  @redis.keys.each do |key|
    @redis.del(key) if key.include?(Logster::RedisRateLimiter::PREFIX)
    @redis.del(key) if key.start_with?(ip_rate_limit_key(""))
  end
end

#count ⇒ Object 



70
71
72
 
# File 'lib/logster/redis_store.rb', line 70

def count
  @redis.llen(list_key)
end

#delete(msg) ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'lib/logster/redis_store.rb', line 40

def delete(msg)
  @redis.multi do
    @redis.hdel(hash_key, msg.key)
    @redis.hdel(env_key, msg.key)
    @redis.hdel(grouping_key, msg.grouping_key)
    @redis.lrem(list_key, -1, msg.key)
  end
end

#get(message_key, load_env: true) ⇒ Object 



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/logster/redis_store.rb', line 181

def get(message_key, load_env: true)
  json = @redis.hget(hash_key, message_key)
  return nil unless json

  message = Message.from_json(json)
  if load_env
    message.env = get_env(message_key) || {}
  end
  message
end

#get_all_ignore_count ⇒ Object 



269
270
271
 
# File 'lib/logster/redis_store.rb', line 269

def get_all_ignore_count
  @redis.hgetall(ignored_logs_count_key)
end

#get_env(message_key) ⇒ Object 



205
206
207
208
209
 
# File 'lib/logster/redis_store.rb', line 205

def get_env(message_key)
  json = @redis.hget(env_key, message_key)
  return if !json || json.size == 0
  JSON.parse(json)
end

#get_patterns(set_name) ⇒ Object 



257
258
259
 
# File 'lib/logster/redis_store.rb', line 257

def get_patterns(set_name)
  @redis.smembers(set_name)
end

#increment_ignore_count(pattern) ⇒ Object 



261
262
263
 
# File 'lib/logster/redis_store.rb', line 261

def increment_ignore_count(pattern)
  @redis.hincrby(ignored_logs_count_key, pattern, 1)
end

#insert_pattern(set_name, pattern) ⇒ Object 



249
250
251
 
# File 'lib/logster/redis_store.rb', line 249

def insert_pattern(set_name, pattern)
  @redis.sadd(set_name, pattern)
end

#latest(opts = {}) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/logster/redis_store.rb', line 84

def latest(opts = {})
  limit = opts[:limit] || 50
  severity = opts[:severity]
  before = opts[:before]
  after = opts[:after]
  search = opts[:search]

  start, finish = find_location(before, after, limit)

  return [] unless start && finish

  results = []

  direction = after ? 1 : -1

  begin
    keys = @redis.lrange(list_key, start, finish) || []
    break unless keys && (keys.count > 0)
    rows = bulk_get(keys)

    temp = []

    rows.each do |row|
      break if before && before == row.key
      row = nil if severity && !severity.include?(row.severity)

      row = filter_search(row, search)
      temp << row if row
    end

    if direction == -1
      results = temp + results
    else
      results += temp
    end

    start += limit * direction
    finish += limit * direction

    finish = -1 if finish > -1
  end while rows.length > 0 && results.length < limit && start < 0

  results
end

#protect(message_key) ⇒ Object 



211
212
213
214
215
216
 
# File 'lib/logster/redis_store.rb', line 211

def protect(message_key)
  if message = get(message_key)
    message.protected = true
    update_message(message)
  end
end

#rate_limited?(ip_address, perform: false, limit: 60) ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/logster/redis_store.rb', line 273

def rate_limited?(ip_address, perform: false, limit: 60)
  key = ip_rate_limit_key(ip_address)

  limited = @redis.exists(key)

  if perform && !limited
    @redis.setex key, limit, ""
  end

  limited
end

#rate_limits ⇒ Object 



245
246
247
 
# File 'lib/logster/redis_store.rb', line 245

def rate_limits
  @rate_limits ||= {}
end

#register_rate_limit_per_hour(severities, limit, &block) ⇒ Object 



235
236
237
 
# File 'lib/logster/redis_store.rb', line 235

def register_rate_limit_per_hour(severities, limit, &block)
  register_rate_limit(severities, limit, 3600, block)
end

#register_rate_limit_per_minute(severities, limit, &block) ⇒ Object 



231
232
233
 
# File 'lib/logster/redis_store.rb', line 231

def register_rate_limit_per_minute(severities, limit, &block)
  register_rate_limit(severities, limit, 60, block)
end

#remove_ignore_count(pattern) ⇒ Object 



265
266
267
 
# File 'lib/logster/redis_store.rb', line 265

def remove_ignore_count(pattern)
  @redis.hdel(ignored_logs_count_key, pattern)
end

#remove_pattern(set_name, pattern) ⇒ Object 



253
254
255
 
# File 'lib/logster/redis_store.rb', line 253

def remove_pattern(set_name, pattern)
  @redis.srem(set_name, pattern)
end

#replace_and_bump(message, save_env: true) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/logster/redis_store.rb', line 49

def replace_and_bump(message, save_env: true)
  # TODO make it atomic
  exists = @redis.hexists(hash_key, message.key)
  return false unless exists

  @redis.multi do
    @redis.hset(hash_key, message.key, message.to_json(exclude_env: true))
    @redis.hset(env_key, message.key, (message.env || {}).to_json) if save_env
    @redis.lrem(list_key, -1, message.key)
    @redis.rpush(list_key, message.key)
  end

  check_rate_limits(message.severity)

  true
end

#save(message) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/logster/redis_store.rb', line 21

def save(message)
  if keys = message.solved_keys
    keys.each do |solved|
      return true if @redis.hget(solved_key, solved)
    end
  end

  @redis.multi do
    @redis.hset(grouping_key, message.grouping_key, message.key)
    @redis.rpush(list_key, message.key)
    update_message(message)
  end

  trim
  check_rate_limits(message.severity)

  true
end

#similar_key(message) ⇒ Object 



66
67
68
 
# File 'lib/logster/redis_store.rb', line 66

def similar_key(message)
  @redis.hget(grouping_key, message.grouping_key)
end

#solve(message_key) ⇒ Object 



74
75
76
77
78
79
80
81
82
 
# File 'lib/logster/redis_store.rb', line 74

def solve(message_key)
  if (message = get(message_key)) && (keys = message.solved_keys)
    # add a time so we can expire it
    keys.each do |s_key|
      @redis.hset(solved_key, s_key, Time.now.to_f.to_i)
    end
  end
  clear_solved
end

#solved ⇒ Object 



227
228
229
 
# File 'lib/logster/redis_store.rb', line 227

def solved
  @redis.hkeys(solved_key) || []
end

#unprotect(message_key) ⇒ Object 



218
219
220
221
222
223
224
225
 
# File 'lib/logster/redis_store.rb', line 218

def unprotect(message_key)
  if message = get(message_key)
    message.protected = false
    update_message(message)
  else
    raise "Message already deleted"
  end
end