Module: DeadBro::Collectors::Jobs

Defined in:
lib/dead_bro/collectors/jobs.rb

Overview

Jobs collector is responsible for building the unified “jobs” payload that the background job queue monitor sends once per interval.

It encapsulates queue backend detection (Sidekiq, SolidQueue, etc.) and enriches the payload with optional database, process, and system statistics.

Class Method Summary collapse

Class Method Details

.collect ⇒ Object

Public entry point: returns a single Hash suitable for JSON encoding.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/dead_bro/collectors/jobs.rb', line 18

def collect
  queue_system = detect_queue_system

  payload = {
    queue_system: queue_system
  }

  # Queue backend–specific stats
  payload[:queue] = collect_sidekiq_stats if queue_system == :sidekiq
  payload[:queue] = collect_solid_queue_stats if queue_system == :solid_queue
  payload[:queue] = collect_delayed_job_stats if queue_system == :delayed_job
  payload[:queue] = collect_good_job_stats if queue_system == :good_job

  # Optional collectors moved to Monitor

  payload
rescue => e
  {
    error_class: e.class.name,
    error_message: e.message.to_s[0, 500]
  }
end

.collect_delayed_job_stats ⇒ Object

— Delayed::Job collector ————————————————-



242
243
244
245
246
247
248
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/dead_bro/collectors/jobs.rb', line 242

def collect_delayed_job_stats
  return {} unless defined?(Delayed::Job)
  return {} unless defined?(ActiveRecord)

  stats = {total_queued: 0, total_busy: 0, queues: {}}

  begin
    return stats unless ActiveRecord::Base.connection.table_exists?("delayed_jobs")

    # queued jobs
    queued = Delayed::Job.where("locked_at IS NULL AND attempts < max_attempts").count
    stats[:total_queued] = queued
    stats[:queues]["default"] = {queued: queued, busy: 0, scheduled: 0, retries: 0}

    # busy jobs
    busy = Delayed::Job.where("locked_at IS NOT NULL AND locked_by IS NOT NULL").count
    stats[:total_busy] = busy
    stats[:queues]["default"][:busy] = busy

    # failed jobs
    failed = Delayed::Job.where("attempts >= max_attempts").count
    stats[:total_failed] = failed
  rescue => e
    stats[:error_class] = e.class.name
    stats[:error_message] = e.message.to_s[0, 500]
  end

  stats
rescue => e
  {
    error_class: e.class.name,
    error_message: e.message.to_s[0, 500]
  }
end

.collect_good_job_stats ⇒ Object

— GoodJob collector ——————————————————



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/dead_bro/collectors/jobs.rb', line 279

def collect_good_job_stats
  return {} unless defined?(GoodJob)
  return {} unless defined?(ActiveRecord)
  return {} unless ActiveRecord::Base.respond_to?(:connected?) && ActiveRecord::Base.connected?

  stats = {total_queued: 0, total_busy: 0, queues: {}}

  begin
    conn = ActiveRecord::Base.connection
    return stats unless conn.respond_to?(:table_exists?) && conn.table_exists?("good_jobs")

    # queued
    result = conn.execute("SELECT queue_name, COUNT(*) as count FROM good_jobs WHERE finished_at IS NULL GROUP BY queue_name")
    parse_query_result(result).each do |row|
      queue_name = (row["queue_name"] || row[:queue_name] || "default").to_s
      count = (row["count"] || row[:count] || 0).to_i
      stats[:queues][queue_name] = {queued: count, busy: 0, scheduled: 0, retries: 0}
      stats[:total_queued] += count
    end

    # busy
    result = conn.execute("SELECT queue_name, COUNT(*) as count FROM good_jobs WHERE finished_at IS NULL AND performed_at IS NOT NULL GROUP BY queue_name")
    parse_query_result(result).each do |row|
      queue_name = (row["queue_name"] || row[:queue_name] || "default").to_s
      count = (row["count"] || row[:count] || 0).to_i
      stats[:queues][queue_name] ||= {queued: 0, busy: 0, scheduled: 0, retries: 0}
      stats[:queues][queue_name][:busy] = count
      stats[:total_busy] += count
    end

    # scheduled
    result = conn.execute("SELECT COUNT(*) as count FROM good_jobs WHERE scheduled_at > NOW()")
    scheduled_count = parse_query_result(result).first
    stats[:total_scheduled] = (scheduled_count&.dig("count") || scheduled_count&.dig(:count) || 0).to_i

    # failed
    result = conn.execute("SELECT COUNT(*) as count FROM good_jobs WHERE finished_at IS NOT NULL AND error IS NOT NULL")
    failed_count = parse_query_result(result).first
    stats[:total_failed] = (failed_count&.dig("count") || failed_count&.dig(:count) || 0).to_i
  rescue => e
    stats[:error_class] = e.class.name
    stats[:error_message] = e.message.to_s[0, 500]
  end

  stats
rescue => e
  {
    error_class: e.class.name,
    error_message: e.message.to_s[0, 500]
  }
end

.collect_sidekiq_stats ⇒ Object

— Sidekiq collector ——————————————————



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
120
121
122
123
124
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
 
# File 'lib/dead_bro/collectors/jobs.rb', line 53

def collect_sidekiq_stats
  return {} unless defined?(Sidekiq)

  stats = {
    processed: nil,
    failed: nil,
    enqueued: nil,
    scheduled_size: nil,
    retry_size: nil,
    dead_size: nil,
    workers_size: nil,
    processes_size: nil,
    memory_rss_bytes: nil,
    queues: []
  }

  begin
    sidekiq_stats = safe_sidekiq_stats
    if sidekiq_stats
      stats[:processed] = begin
        sidekiq_stats.processed
      rescue
        nil
      end
      stats[:failed] = begin
        sidekiq_stats.failed
      rescue
        nil
      end
      stats[:enqueued] = begin
        sidekiq_stats.enqueued
      rescue
        nil
      end
      stats[:scheduled_size] = begin
        sidekiq_stats.scheduled_size
      rescue
        nil
      end
      stats[:retry_size] = begin
        sidekiq_stats.retry_size
      rescue
        nil
      end
      stats[:dead_size] = begin
        sidekiq_stats.dead_size
      rescue
        nil
      end
      stats[:workers_size] = begin
        sidekiq_stats.workers_size
      rescue
        nil
      end
      stats[:processes_size] = begin
        sidekiq_stats.processes_size
      rescue
        nil
      end
    end

    # Per-queue size and latency
    queue_class = begin
      Sidekiq.const_get(:Queue)
    rescue
      nil
    end
    if queue_class && queue_class.respond_to?(:all)
      queue_class.all.each do |queue|
        stats[:queues] << {
          name: queue.name,
          size: safe_integer(queue.size),
          latency_s: safe_latency(queue)
        }
      end
    end

    # Process RSS at collection time (best-effort)
    if DeadBro.configuration.respond_to?(:enable_process_stats) && DeadBro.configuration.enable_process_stats
      stats[:memory_rss_bytes] = begin
        ProcessInfo.rss_bytes
      rescue
        nil
      end
    end
  rescue => e
    stats[:error_class] = e.class.name
    stats[:error_message] = e.message.to_s[0, 500]
  end

  stats
rescue => e
  {
    error_class: e.class.name,
    error_message: e.message.to_s[0, 500]
  }
end

.collect_solid_queue_stats ⇒ Object

— SolidQueue collector (database-backed) ———————————



186
187
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
232
233
234
235
236
237
238
 
# File 'lib/dead_bro/collectors/jobs.rb', line 186

def collect_solid_queue_stats
  return {} unless defined?(SolidQueue)
  return {} unless defined?(ActiveRecord)
  return {} unless ActiveRecord::Base.respond_to?(:connected?) && ActiveRecord::Base.connected?

  stats = {total_queued: 0, total_busy: 0, queues: {}}

  begin
    conn = ActiveRecord::Base.connection
    return stats unless conn.respond_to?(:table_exists?) && conn.table_exists?("solid_queue_jobs")

    # queued jobs
    result = conn.execute("SELECT queue_name, COUNT(*) as count FROM solid_queue_jobs WHERE finished_at IS NULL GROUP BY queue_name")
    parse_query_result(result).each do |row|
      queue_name = (row["queue_name"] || row[:queue_name] || "default").to_s
      count = (row["count"] || row[:count] || 0).to_i
      stats[:queues][queue_name] = {queued: count, busy: 0, scheduled: 0, retries: 0}
      stats[:total_queued] += count
    end

    # busy jobs
    result = conn.execute("SELECT queue_name, COUNT(*) as count FROM solid_queue_jobs WHERE finished_at IS NULL AND claimed_at IS NOT NULL GROUP BY queue_name")
    parse_query_result(result).each do |row|
      queue_name = (row["queue_name"] || row[:queue_name] || "default").to_s
      count = (row["count"] || row[:count] || 0).to_i
      stats[:queues][queue_name] ||= {queued: 0, busy: 0, scheduled: 0, retries: 0}
      stats[:queues][queue_name][:busy] = count
      stats[:total_busy] += count
    end

    # scheduled jobs
    result = conn.execute("SELECT COUNT(*) as count FROM solid_queue_jobs WHERE scheduled_at > NOW()")
    scheduled_count = parse_query_result(result).first
    stats[:total_scheduled] = (scheduled_count&.dig("count") || scheduled_count&.dig(:count) || 0).to_i

    # failed jobs
    if conn.table_exists?("solid_queue_failed_jobs")
      result = conn.execute("SELECT COUNT(*) as count FROM solid_queue_failed_jobs")
      failed_count = parse_query_result(result).first
      stats[:total_failed] = (failed_count&.dig("count") || failed_count&.dig(:count) || 0).to_i
    end
  rescue => e
    stats[:error_class] = e.class.name
    stats[:error_message] = e.message.to_s[0, 500]
  end

  stats
rescue => e
  {
    error_class: e.class.name,
    error_message: e.message.to_s[0, 500]
  }
end

.default_hostname ⇒ Object 



389
390
391
392
393
394
 
# File 'lib/dead_bro/collectors/jobs.rb', line 389

def default_hostname
  require "socket"
  Socket.gethostname
rescue
  "unknown"
end

.detect_queue_system ⇒ Object

— Queue system detection ————————————————-



43
44
45
46
47
48
49
 
# File 'lib/dead_bro/collectors/jobs.rb', line 43

def detect_queue_system
  return :sidekiq if defined?(Sidekiq)
  return :solid_queue if defined?(SolidQueue)
  return :delayed_job if defined?(Delayed::Job)
  return :good_job if defined?(GoodJob)
  :unknown
end

.parse_query_result(result) ⇒ Object

— Shared helpers ———————————————————



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/dead_bro/collectors/jobs.rb', line 333

def parse_query_result(result)
  if result.respond_to?(:each)
    if result.respond_to?(:values)
      begin
        columns = begin
          result.fields
        rescue
          result.column_names
        end
      rescue
        []
      end
      result.values.map do |row|
        columns.each_with_index.each_with_object({}) do |(col, idx), hash|
          hash[col.to_s] = row[idx]
          hash[col.to_sym] = row[idx]
        end
      end
    elsif result.is_a?(Array)
      result
    else
      result.to_a
    end
  else
    []
  end
rescue
  []
end

.process_hostname ⇒ Object 



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/dead_bro/collectors/jobs.rb', line 375

def process_hostname
  if defined?(ProcessInfo)
    begin
      ProcessInfo.safe_hostname
    rescue
      default_hostname
    end
  else
    default_hostname
  end
rescue
  default_hostname
end

.safe_app_name ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/dead_bro/collectors/jobs.rb', line 363

def safe_app_name
  if defined?(Rails) && Rails.respond_to?(:application) && Rails.application
    begin
      Rails.application.class.module_parent_name
    rescue
      Rails.application.class.name
    end
  end
rescue
  nil
end

.safe_collect ⇒ Object 



396
397
398
399
400
 
# File 'lib/dead_bro/collectors/jobs.rb', line 396

def safe_collect
  yield
rescue => e
  {error_class: e.class.name, error_message: e.message.to_s[0, 500]}
end

.safe_integer(value) ⇒ Object 



158
159
160
161
162
 
# File 'lib/dead_bro/collectors/jobs.rb', line 158

def safe_integer(value)
  Integer(value)
rescue
  nil
end

.safe_latency(queue) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/dead_bro/collectors/jobs.rb', line 164

def safe_latency(queue)
  latency = begin
    queue.latency
  rescue
    nil
  end
  return nil unless latency

  value = begin
    Float(latency)
  rescue
    nil
  end
  return nil unless value && value.finite?

  value
rescue
  nil
end

.safe_sidekiq_stats ⇒ Object 



151
152
153
154
155
156
 
# File 'lib/dead_bro/collectors/jobs.rb', line 151

def safe_sidekiq_stats
  require "sidekiq/api"
  Sidekiq::Stats.new
rescue LoadError, NameError, StandardError
  nil
end