Add a job-queue health check so stalled background jobs can't go unnoticed again

Abierto Apto para principiantes
  • ¿Algo no está bien?
#7,291 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
rails, ruby
Área
backend, observability

Línea de trabajo

Empieza en app/controllers/health_controller.rb, junto a la acción health existente, y añade la acción jobs; la ruta va bajo resources :health en config/routes.rb. Cuenta solo las filas de Delayed::Job vencidas y no fallidas (run_at <= now, failed_at nil) usando dos consultas agregadas, y devuelve 503 cuando el trabajo vencido más antiguo supere el umbral de ENV (por defecto 3600). Está terminado cuando spec/requests/health_spec.rb cubra 200 vacío, 200 reciente, 503 obsoleto y un cuerpo sin datos del manejador ni de los argumentos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Difficulty: Intermediate Good First Issue Help Wanted

Problem

From early 2022 until 2026-11-01, production background jobs (delayed_job) never ran: no worker dyno was on and nothing in Heroku Scheduler processed the queue. About 8,000 jobs piled up, mostly emails: followup notifications, supervisor reimbursement requests, and completed-reimbursement notices. Nobody noticed for 4.5 years, because nothing checks that jobs are actually being processed.

A Scheduler entry now runs rake jobs:workoff every 10 minutes. If it stops (removed by mistake, failing on boot, a rake-only bug like #7283), we'd be blind again.

Proposal

Add a cheap queue-health signal that an uptime monitor can poll.

  • New endpoint, e.g. GET /health/jobs.json, next to the existing /health (app/controllers/health_controller.rb, route in config/routes.rb under resources :health). It returns only aggregate numbers, never job payloads (handlers contain record IDs and arguments): 
    {"queued": 3, "oldest_queued_age_seconds": 412, "failing": 0}
    • queued: Delayed::Job.where(failed_at: nil).count
    • oldest_queued_age_seconds: age of the oldest job that is due to run (run_at <= now, not failed), or null
    • failing: jobs with last_error set, or attempts > 0
  • Respond 503 when the oldest due job is older than a threshold (e.g. 1 hour; configurable via ENV, default 3600), so a simple HTTP uptime check can alert on it. Otherwise 200.
  • Request spec in spec/requests/health_spec.rb: 200 with an empty queue, 200 with a fresh job, 503 with a job older than the threshold, and no handler or argument data in the response body.
  • Keep it cheap: two indexed aggregate queries, no loading of job rows.
  • Document the endpoint in the wiki deploy checklist / README so a maintainer can point an uptime monitor at it. A maintainer will set up the actual monitor.

Notes

  • Jobs with a future run_at (retry backoff) shouldn't count as "stuck". Only count jobs that are due.
  • Don't require auth for the JSON, since it exposes only counts. If you'd rather gate it, follow the token pattern used by old_objects in the same controller.

Difficulty: beginner–intermediate. One controller action, one route, one request spec.

Lenguaje dominante
Ruby
Estrellas
382
Forks
547
Merge medio
2 d 22 h
PR fusionados (30 d)
46

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de rubyforgood/casa

Todos los issues de rubyforgood/casa

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.