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.



117
118
119
120
121
122
123
 
# File 'lib/logster/redis_store.rb', line 117

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.



114
115
116
 
# File 'lib/logster/redis_store.rb', line 114

def max_backlog
  @max_backlog
end

#redis ⇒ Object

Returns the value of attribute redis.



114
115
116
 
# File 'lib/logster/redis_store.rb', line 114

def redis
  @redis
end

#redis_prefix ⇒ Object 



341
342
343
344
345
 
# File 'lib/logster/redis_store.rb', line 341

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.



114
115
116
 
# File 'lib/logster/redis_store.rb', line 114

def redis_raw_connection
  @redis_raw_connection
end

Instance Method Details

#bulk_get(message_keys) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/logster/redis_store.rb', line 294

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 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/logster/redis_store.rb', line 233

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)



268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/logster/redis_store.rb', line 268

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)
  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)
  end
end

#count ⇒ Object 



174
175
176
 
# File 'lib/logster/redis_store.rb', line 174

def count
  @redis.llen(list_key)
end

#delete(msg) ⇒ Object 



144
145
146
147
148
149
150
151
 
# File 'lib/logster/redis_store.rb', line 144

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 



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/logster/redis_store.rb', line 283

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_env(message_key) ⇒ Object 



307
308
309
310
311
 
# File 'lib/logster/redis_store.rb', line 307

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 



359
360
361
 
# File 'lib/logster/redis_store.rb', line 359

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

#insert_pattern(set_name, pattern) ⇒ Object 



351
352
353
 
# File 'lib/logster/redis_store.rb', line 351

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

#latest(opts = {}) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/logster/redis_store.rb', line 188

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 



313
314
315
316
317
318
 
# File 'lib/logster/redis_store.rb', line 313

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

#rate_limits ⇒ Object 



347
348
349
 
# File 'lib/logster/redis_store.rb', line 347

def rate_limits
  @rate_limits ||= {}
end

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



337
338
339
 
# File 'lib/logster/redis_store.rb', line 337

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 



333
334
335
 
# File 'lib/logster/redis_store.rb', line 333

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

#remove_pattern(set_name, pattern) ⇒ Object 



355
356
357
 
# File 'lib/logster/redis_store.rb', line 355

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

#replace_and_bump(message, save_env: true) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/logster/redis_store.rb', line 153

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 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/logster/redis_store.rb', line 125

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 



170
171
172
 
# File 'lib/logster/redis_store.rb', line 170

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

#solve(message_key) ⇒ Object 



178
179
180
181
182
183
184
185
186
 
# File 'lib/logster/redis_store.rb', line 178

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 



329
330
331
 
# File 'lib/logster/redis_store.rb', line 329

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

#unprotect(message_key) ⇒ Object 



320
321
322
323
324
325
326
327
 
# File 'lib/logster/redis_store.rb', line 320

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