Class: Sentiero::Stores::Redis

Inherits:
Sentiero::Store show all
Defined in:
lib/sentiero/stores/redis.rb,
lib/sentiero/stores/redis/lua.rb,
lib/sentiero/stores/redis/keys.rb

Defined Under Namespace

Modules: Lua Classes: Keys

Constant Summary collapse

LIST_SERVER_EVENTS_SCAN_CHUNK =

LIMIT on the zset alone would return fewer than limit rows whenever earlier events in the range don't match the filters, so page through in chunks and filter each page before counting it against the limit. Scanning is bounded by max_server_events, the same cap that already bounds how many rows can exist in this zset.

500
PURGE_BATCH_SIZE = 
500

Constants inherited from Sentiero::Store

Sentiero::Store::MAX_METADATA_KEYS, Sentiero::Store::MAX_METADATA_VALUE_SIZE, Sentiero::Store::PROBLEM_TITLE_MAX, Sentiero::Store::VALID_ID, Sentiero::Store::VALID_STATUS

Instance Attribute Summary

Attributes inherited from Sentiero::Store

#limits

Instance Method Summary collapse

Constructor Details

#initialize(redis:, ttl: nil, prefix: "sentiero:", limits: nil) ⇒ Redis

Key layout (all under @prefix): events in per-window sorted sets scored by timestamp, session metadata in hashes, window membership in sets, and a global sessions sorted set scored by updated_at. See Keys for the exact key names and Lua for the scripts run via EVAL.



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/sentiero/stores/redis.rb', line 18

def initialize(redis:, ttl: nil, prefix: "sentiero:", limits: nil)
  unless defined?(::Redis)
    raise LoadError, "The redis gem is required for Sentiero::Stores::Redis. Add `gem 'redis'` to your Gemfile."
  end

  @limits = limits
  @redis = redis
  @ttl = ttl
  @prefix = prefix
  @keys = Keys.new(prefix)
end

Instance Method Details

#clear! ⇒ Object 



397
398
399
400
401
 
# File 'lib/sentiero/stores/redis.rb', line 397

def clear!
  # SCAN, not KEYS: KEYS is O(N) over the whole keyspace and blocks the server.
  @redis.scan_each(match: "#{@prefix}*") { |key| @redis.del(key) }
  nil
end

#count_occurrences(problem_id, after: nil) ⇒ Object

ZCOUNT counts server-side without parsing a single member.



292
293
294
295
296
 
# File 'lib/sentiero/stores/redis.rb', line 292

def count_occurrences(problem_id, after: nil)
  validate_id!(problem_id)
  min = after ? "(#{after.to_f}" : "-inf"
  @redis.zcount(@keys.occurrences(problem_id), min, "+inf")
end

#delete_session(session_id) ⇒ Object 



202
203
204
205
206
207
208
 
# File 'lib/sentiero/stores/redis.rb', line 202

def delete_session(session_id)
  validate_id!(session_id)
  evict_session(session_id)
  erase_session_occurrences(session_id)
  erase_session_server_events(session_id)
  nil
end

#delete_window(ref) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/sentiero/stores/redis.rb', line 210

def delete_window(ref)
  validate_window_ref!(ref)
  session_id = ref.session_id
  window_id = ref.window_id

  now = Time.now.to_f
  @redis.eval(
    Lua::DELETE_WINDOW,
    keys: [@keys.events(session_id, window_id), @keys.windows(session_id), @keys.session(session_id), @keys.sessions],
    argv: [window_id, session_id, now.to_s]
  )
  nil
end

#each_session_events(limit: nil, since: nil, until_time: nil) ⇒ Object

Batched scan: three pipelined round-trips total instead of the base's get_session + get_events per window.



79
80
81
82
83
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
 
# File 'lib/sentiero/stores/redis.rb', line 79

def each_session_events(limit: nil, since: nil, until_time: nil)
  return enum_for(:each_session_events, limit: limit, since: since, until_time: until_time) unless block_given?

  cap = limit || limits.analytics_max_scan_sessions
  min = since ? since.to_f.to_s : "-inf"
  max = until_time ? until_time.to_f.to_s : "+inf"
  session_ids = @redis.zrevrangebyscore(@keys.sessions, max, min, limit: [0, cap])
  return if session_ids.empty?

  meta_futures = {}
  window_futures = {}
  @redis.pipelined do |pipe|
    session_ids.each do |sid|
      meta_futures[sid] = pipe.hgetall(@keys.session(sid))
      window_futures[sid] = pipe.smembers(@keys.windows(sid))
    end
  end

  event_futures = {}
  @redis.pipelined do |pipe|
    session_ids.each do |sid|
      next if meta_futures[sid].value.empty?

      window_futures[sid].value.each do |wid|
        event_futures[[sid, wid]] = pipe.zrange(@keys.events(sid, wid), 0, -1)
      end
    end
  end

  session_ids.each do |sid|
    meta = meta_futures[sid].value
    next if meta.empty?

    window_ids = window_futures[sid].value
    next if window_ids.empty?

    windows = window_ids.to_h { |wid| [wid, parse_events(event_futures[[sid, wid]].value)] }
    summary = scan_summary(sid, meta, window_ids, windows.values.sum(&:size))
    windows.each { |wid, events| yield summary, wid, events }
  end
end

#get_events(ref, after: nil, limit: nil) ⇒ Object 



184
185
186
187
188
189
 
# File 'lib/sentiero/stores/redis.rb', line 184

def get_events(ref, after: nil, limit: nil)
  validate_window_ref!(ref)
  session_id = ref.session_id
  window_id = ref.window_id
  parse_events(zrange_page(@keys.events(session_id, window_id), after: after, limit: limit))
end

#get_occurrences(problem_id, after: nil, limit: nil) ⇒ Object 



283
284
285
286
287
288
289
 
# File 'lib/sentiero/stores/redis.rb', line 283

def get_occurrences(problem_id, after: nil, limit: nil)
  validate_id!(problem_id)
  raw = zrange_page(@keys.occurrences(problem_id), after: after, limit: limit)
  return [] if raw.nil? || raw.empty?

  raw.map { |json| JSON.parse(json) }
end

#get_problem(problem_id) ⇒ Object 



277
278
279
280
281
 
# File 'lib/sentiero/stores/redis.rb', line 277

def get_problem(problem_id)
  validate_id!(problem_id)
  json = @redis.get(@keys.problem(problem_id))
  json ? problem_from_strings(JSON.parse(json)) : nil
end

#get_server_event(event_id) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
 
# File 'lib/sentiero/stores/redis.rb', line 324

def get_server_event(event_id)
  validate_id!(event_id)
  # O(n) scan of the server_events zset, bounded by max_server_events.
  all_members = @redis.zrange(@keys.server_events, 0, -1)
  all_members.each do |json|
    event = JSON.parse(json)
    return event if event["id"] == event_id
  end
  nil
end

#get_session(session_id) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/sentiero/stores/redis.rb', line 152

def get_session(session_id)
  validate_id!(session_id)
  meta = @redis.hgetall(@keys.session(session_id))
  return nil if meta.empty?

  window_ids = @redis.smembers(@keys.windows(session_id))
  return nil if window_ids.empty?

  window_data = window_ids.map do |wid|
    key = @keys.events(session_id, wid)
    first_scores = @redis.zrangebyscore(key, "-inf", "+inf", limit: [0, 1], with_scores: true)
    last_scores = @redis.zrevrangebyscore(key, "+inf", "-inf", limit: [0, 1], with_scores: true)
    {
      window_id: wid,
      event_count: @redis.zcard(key),
      first_event_at: first_scores.first&.last,
      last_event_at: last_scores.first&.last
    }
  end

  result = {
    session_id: session_id,
    windows: window_data,
    created_at: meta["created_at"].to_f,
    updated_at: meta["updated_at"].to_f,
    first_event_at: meta["first_event_at"]&.to_f,
    last_event_at: meta["last_event_at"]&.to_f
  }
  result[:metadata] = JSON.parse(meta["metadata"]) if meta["metadata"]
  result
end

#list_problems(project:, limit:, offset: 0, status: nil, sort_by: nil, search: nil, since: nil, until_time: nil) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/sentiero/stores/redis.rb', line 249

def list_problems(project:, limit:, offset: 0, status: nil, sort_by: nil, search: nil, since: nil, until_time: nil)
  fps = if project.nil?
    @redis.zrevrange(@keys.problems, 0, -1)
  else
    @redis.smembers(@keys.problems_project(project))
  end
  return [] if fps.empty?

  items = fps.filter_map do |fp|
    json = @redis.get(@keys.problem(fp))
    json ? problem_from_strings(JSON.parse(json)) : nil
  end

  filter_and_page_problems(
    items,
    project: project,
    status: status,

    since: since,
    until_time: until_time,
    search: search,

    sort_by: sort_by,
    offset: offset,
    limit: limit
  )
end

#list_server_events(project:, limit:, name: nil, level: nil, session_id: nil, after: nil) ⇒ Object 



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/sentiero/stores/redis.rb', line 342

def list_server_events(project:, limit:, name: nil, level: nil, session_id: nil, after: nil)
  key = project.nil? ? @keys.server_events : @keys.server_events_project(project)
  min = after ? "(#{after.to_f}" : "-inf"
  max_scan = limits.max_server_events || Float::INFINITY

  matches = []
  offset = 0
  loop do
    batch = @redis.zrangebyscore(key, min, "+inf", limit: [offset, LIST_SERVER_EVENTS_SCAN_CHUNK])
    break if batch.empty?

    batch.each do |json|
      event = JSON.parse(json)
      next unless server_event_matches?(event, name: name, level: level, session_id: session_id)

      matches << event
      break if matches.size >= limit
    end

    offset += batch.size
    break if matches.size >= limit
    break if batch.size < LIST_SERVER_EVENTS_SCAN_CHUNK
    break if offset >= max_scan
  end

  matches
end

#list_sessions(limit:, offset: 0, since: nil, until_time: nil, sort_by: nil, search: nil) ⇒ Object

Default sort with no search needs no summaries beyond the requested page: ZREVRANGEBYSCORE with LIMIT pages the score-ordered sessions zset directly. created_at/event_count sort or search need every matching session's summary first, so those go through the general path below.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/sentiero/stores/redis.rb', line 125

def list_sessions(limit:, offset: 0, since: nil, until_time: nil, sort_by: nil, search: nil)
  min = since ? since.to_f.to_s : "-inf"
  max = until_time ? until_time.to_f.to_s : "+inf"

  if default_sort?(sort_by) && (search.nil? || search.empty?)
    session_ids = @redis.zrevrangebyscore(@keys.sessions, max, min, limit: [offset, limit])
    return build_session_summaries(session_ids)
  end

  session_ids = @redis.zrevrangebyscore(@keys.sessions, max, min)
  return [] if session_ids.empty?

  summaries = build_session_summaries(session_ids)

  summaries.select! { |summary| session_matches_search?(summary, search) } if search && !search.empty?

  case sort_by
  when "created_at"
    summaries.sort_by! { |summary| -summary[:created_at] }
  when "event_count"
    summaries.sort_by! { |summary| -summary[:event_count] }
  end
  # default sort needs no work: zrevrangebyscore already returns updated_at desc

  summaries.slice(offset, limit) || []
end

#occurrences_for_session(session_id, limit: nil) ⇒ Object 



370
371
372
373
374
375
376
377
 
# File 'lib/sentiero/stores/redis.rb', line 370

def occurrences_for_session(session_id, limit: nil)
  validate_id!(session_id)
  key = @keys.session_occurrences(session_id)
  raw = limit ? @redis.zrange(key, 0, limit - 1) : @redis.zrange(key, 0, -1)
  return [] if raw.nil? || raw.empty?

  raw.map { |json| JSON.parse(json) }
end

#purge_older_than(seconds) ⇒ Object

Range-query the updated_at-scored sessions zset for stale ids, paged in batches to bound memory. Orthogonal to the :ttl option: delete_session's DEL/ZREM are no-ops on already-expired keys, so they never collide.



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/sentiero/stores/redis.rb', line 408

def purge_older_than(seconds)
  cutoff = Time.now.to_f - seconds
  deleted = 0

  loop do
    batch = @redis.zrangebyscore(@keys.sessions, "-inf", "(#{cutoff}", limit: [0, PURGE_BATCH_SIZE])
    break if batch.empty?

    batch.each { |session_id| delete_session(session_id) }
    deleted += batch.size
  end

  purge_error_data_older_than!(cutoff)

  deleted
end

#save_events(ref, events) ⇒ Object 



30
31
32
33
34
35
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
70
71
72
73
74
75
 
# File 'lib/sentiero/stores/redis.rb', line 30

def save_events(ref, events)
  return if events.nil? || events.empty?

  validate_window_ref!(ref)
  session_id = ref.session_id
  window_id = ref.window_id

  now = Time.now.to_f
  events_key = @keys.events(session_id, window_id)
  windows_key = @keys.windows(session_id)
  session_key = @keys.session(session_id)

  event_timestamps = events.filter_map { |event| event["timestamp"]&.to_f }
  batch_min = event_timestamps.min
  batch_max = event_timestamps.max

  @redis.pipelined do |pipe|
    events.each_with_index do |event, i|
      score = event["timestamp"] || (now + i * 0.0001)
      member = JSON.generate(event.merge("_seq" => "#{now}_#{i}"))
      pipe.zadd(events_key, score, member)
    end

    pipe.sadd(windows_key, window_id)

    pipe.hsetnx(session_key, "created_at", now.to_s)
    pipe.hset(session_key, "updated_at", now.to_s)

    pipe.zadd(@keys.sessions, now, session_id)

    if @ttl
      pipe.expire(events_key, @ttl)
      pipe.expire(windows_key, @ttl)
      pipe.expire(session_key, @ttl)
      pipe.expire(@keys.sessions, @ttl)
    end
  end

  # Atomic compare-and-set of first/last event timestamps, hence Lua.
  update_event_timestamps(session_key, batch_min, batch_max)

  enforce_max_events(session_id)
  enforce_max_sessions

  nil
end

#save_metadata(session_id, metadata) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/sentiero/stores/redis.rb', line 191

def save_metadata(session_id, metadata)
  return unless metadata.is_a?(Hash) && !metadata.empty?

  validate_id!(session_id)
  validate_metadata!(metadata)

  key = @keys.session(session_id)
  @redis.eval(Lua::SAVE_METADATA, keys: [key], argv: [JSON.generate(metadata.transform_keys(&:to_s))])
  nil
end

#save_occurrence(occurrence) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/sentiero/stores/redis.rb', line 224

def save_occurrence(occurrence)
  validate_occurrence!(occurrence)
  fp = occurrence["fingerprint"]
  ts = occurrence["timestamp"].to_f
  occ_id = SecureRandom.uuid
  stored = occurrence.merge("id" => occ_id)

  created = @redis.eval(
    Lua::PROBLEM_UPSERT,
    keys: [@keys.problem(fp), @keys.problems, @keys.problems_project(occurrence["project"])],
    argv: [fp, ts, occurrence["message"].to_s, JSON.generate(new_problem_attrs(occurrence, ts))]
  )
  enforce_max_problems if created == 1

  @redis.pipelined do |pipe|
    pipe.zadd(@keys.occurrences(fp), ts, JSON.generate(stored))
    if occurrence["session_id"]
      pipe.zadd(@keys.session_occurrences(occurrence["session_id"]), ts, JSON.generate(stored))
    end
  end

  save_metadata(occurrence["session_id"], {"has_errors" => true}) if occurrence["session_id"]
  fp
end

#save_server_event(event) ⇒ Object 



311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/sentiero/stores/redis.rb', line 311

def save_server_event(event)
  validate_server_event!(event)
  ev_id = SecureRandom.uuid
  stored = event.merge("id" => ev_id)
  ts = event["timestamp"].to_f
  @redis.pipelined do |pipe|
    pipe.zadd(@keys.server_events, ts, JSON.generate(stored))
    pipe.zadd(@keys.server_events_project(event["project"]), ts, JSON.generate(stored))
  end
  enforce_max_server_events
  nil
end

#server_events_for_session(session_id, limit: nil) ⇒ Object 



379
380
381
382
383
384
385
386
387
 
# File 'lib/sentiero/stores/redis.rb', line 379

def server_events_for_session(session_id, limit: nil)
  validate_id!(session_id)
  raw = @redis.zrange(@keys.server_events, 0, -1)
  return [] if raw.nil? || raw.empty?

  items = raw.map { |json| JSON.parse(json) }
    .select { |e| e["session_id"] == session_id }
  limit ? items.first(limit) : items
end

#session_ids_for_problem(problem_id, limit: nil) ⇒ Object 



389
390
391
392
393
394
395
 
# File 'lib/sentiero/stores/redis.rb', line 389

def session_ids_for_problem(problem_id, limit: nil)
  validate_id!(problem_id)
  raw = @redis.zrange(@keys.occurrences(problem_id), 0, -1)
  return [] if raw.nil? || raw.empty?

  latest_session_ids(raw.map { |json| JSON.parse(json) }, limit: limit)
end

#update_problem_status(problem_id, status) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/sentiero/stores/redis.rb', line 298

def update_problem_status(problem_id, status)
  validate_id!(problem_id)
  validate_status!(status)
  json = @redis.get(@keys.problem(problem_id))
  return nil unless json

  problem = JSON.parse(json)
  problem["status"] = status
  problem["resolved_at"] = (status == "resolved") ? Time.now.to_f : nil
  @redis.set(@keys.problem(problem_id), JSON.generate(problem))
  nil
end