solid_queue_web 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65caaec8c90225e3645116b206b9a3f81c4ff2389b2dd688e2e3fccca8a0121d
-  data.tar.gz: 217dd8f2c0dcdaf13fe69cff9f3bf1c0857a416e88de8643248fc54a85efe917
+  metadata.gz: e28c1cc2c32722a5b876083166f98549f60c2788cb5e225d6d6fa1122a2964ae
+  data.tar.gz: b68d4c0cf42091242b1816956e217ae64f471142df5ce974f71772ae8b454d83
 SHA512:
-  metadata.gz: ed20d5b71f733c2e7eea80a249ff42c45094507f129dd69899b5938bc9594f575cb0a5958fc3e94bbf7b28fda0c70256257ba1651738d42dfa5c0661e61a7b73
-  data.tar.gz: d7ab81704638739b1108e666d87797a0f4d21c690d428ec321ce04ae98a3af15e181d783e5a498fd9e892b8b1e8041648d9666c356c1aebc194dbc76173cfdfe
+  metadata.gz: ba9a31d372ecf83a97b0ed708ce8209ea5b24e9e042d11f7ff61ce54925bef988d0a6e12a7337c9757051268210279bd46eb6e011b6008d602832d340448b0db
+  data.tar.gz: 0c41966b6dab2b47e4049b0afbf884d016d62fb78feb424934738900d4f676978c05c0129c7b02b31cc2eb47caf7770e090ad2921f8fec56e8854bc307b7f1df

data/README.md

@@ -8,6 +8,8 @@
 
 A monitoring and management dashboard for [Solid Queue](https://github.com/rails/solid_queue), mountable as a Rails engine in any app.
 
+![SolidQueueWeb dashboard](docs/solid-queue-web.png)
+
 ## The problem
 
 Solid Queue ships without a web interface. When jobs fail, queues back up, or workers go silent in production, the only options are `rails console` or raw SQL queries. SolidQueueWeb gives your team a real-time dashboard to inspect, retry, and discard jobs without leaving the browser — and without standing up any additional infrastructure.
@@ -38,7 +40,7 @@ SolidQueueWeb surfaces all of this in a browser UI available at any route you ch
 - **Jobs** — filterable by status (ready, scheduled, claimed, blocked, failed), queue, and priority; search by job class name with dynamic auto-submit; time-based period filter (1 h / 24 h / 7 d); discard individual or all jobs; Turbo Frame navigation so only the table updates on filter or search; auto-refreshes every 10 seconds
 - **Scheduled job management** — reschedule a scheduled job to run immediately ("Run Now") or push its `scheduled_at` forward by 1 h, 24 h, or 7 d; Turbo Stream responses update the row in place; "Run All Now" bulk action promotes every scheduled job in the current filtered view in a single operation
 - **Failed jobs** — list of failed executions with error details; search by class name; filter by queue; time-based period filter; retry or discard individually or in bulk; bulk retry with configurable stagger (+5s / +10s / +30s / +1m) to avoid thundering herd on recovery
-- **Job detail** — full arguments, timestamps, blocked-until date, and error backtrace; action buttons based on job status
+- **Job detail** — full arguments, timestamps, blocked-until date, and error backtrace; action buttons based on job status; failed jobs show an editable arguments textarea so you can correct a bad payload and retry in one step without redeploying
 - **Queue management** — pause and resume individual queues; queue-scoped job list with status filter, search, and discard
 - **Recurring tasks** — all configured recurring tasks with cron schedule, next run time, last run time, and static/dynamic classification; "Run Now" button enqueues a task immediately without waiting for its next scheduled run
 - **Processes** — workers, dispatchers, and supervisors with heartbeat health status; auto-refreshes every 10 seconds
@@ -53,10 +55,6 @@ SolidQueueWeb surfaces all of this in a browser UI available at any route you ch
 - **Performance analytics** — per-job-class statistics at `/jobs/performance` showing run count, average, p50, p95, min, and max duration; sorted by p95 descending so the slowest classes surface first; period filter scopes to 1h / 24h / 7d or all time; each class name links to the filtered History view
 - **Metrics / health endpoint** — `GET /jobs/metrics.json` returns a machine-readable JSON document with job counts, throughput, per-queue depth and pause state, and process health summary; suitable for Prometheus scraping, uptime monitors, or external dashboards; `slow_jobs` count included when `slow_job_threshold` is configured
 
-## Screenshots
-
-![SolidQueueWeb dashboard](docs/solid-queue-web.png)
-
 ## Compatibility
 
 | Dependency  | Version    |
@@ -102,9 +100,10 @@ SolidQueueWeb.configure do |config|
   config.default_refresh_interval   = 30_000 # jobs/processes/history auto-refresh in ms (default: 10_000)
   config.search_results_limit       = 10     # max results per status in global search (default: 25)
   config.slow_job_threshold         = 5.minutes # flag claimed jobs running longer than this (default: nil = disabled)
-  config.alert_webhook_url          = "https://hooks.example.com/solid-queue" # POST target (default: nil = disabled)
+  config.alert_webhook_url          = "https://hooks.example.com/solid-queue" # POST target — string or array (default: nil = disabled)
   config.alert_failure_threshold    = 10         # fire when failed count >= this (default: nil = disabled)
-  config.alert_webhook_cooldown     = 1800       # seconds between repeated alerts (default: 3600)
+  config.alert_queue_thresholds     = { "critical" => 50, "default" => 200 } # fire when queue depth >= threshold (default: {})
+  config.alert_webhook_cooldown     = 1800       # seconds between repeated alerts per alert type (default: 3600)
   config.connects_to                = { reading: :reading, writing: :writing } # read replica (default: nil)
 end
 
@@ -129,6 +128,17 @@ SolidQueueWeb.configure do |config|
 end
 ```
 
+To fan out to multiple endpoints (e.g. Slack and PagerDuty simultaneously), pass an array:
+
+```ruby
+config.alert_webhook_url = [
+  "https://hooks.slack.com/services/...",
+  "https://events.pagerduty.com/..."
+]
+```
+
+All configured URLs receive the same payload. A failure posting to one URL is logged and skipped without blocking the remaining targets.
+
 The request body is JSON:
 
 ```json
@@ -142,6 +152,31 @@ The request body is JSON:
 
 The webhook fires asynchronously in a background thread so dashboard page loads are never delayed. HTTP errors are logged to `Rails.logger` and swallowed. The cooldown window prevents repeated alerts while the count stays elevated — the clock resets on each app restart.
 
+## Queue depth alerts
+
+Set `alert_queue_thresholds` to fire a webhook when any queue's ready job count meets or exceeds a per-queue limit:
+
+```ruby
+SolidQueueWeb.configure do |config|
+  config.alert_webhook_url      = "https://hooks.example.com/solid-queue"
+  config.alert_queue_thresholds = { "critical" => 50, "default" => 200 }
+end
+```
+
+The same `alert_webhook_url` endpoint(s) receive the payload, with a distinct event type so you can route it differently:
+
+```json
+{
+  "event": "queue_depth_threshold_exceeded",
+  "queue_name": "critical",
+  "depth": 63,
+  "threshold": 50,
+  "fired_at": "2026-05-21T12:34:56Z"
+}
+```
+
+Cooldown is tracked independently per queue, so a persistently deep "critical" queue does not suppress alerts for "default". The shared `alert_webhook_cooldown` setting applies to each queue separately.
+
 ## Metrics endpoint
 
 `GET /jobs/metrics.json` returns a machine-readable JSON document suitable for Prometheus scraping, uptime monitors, or external dashboards. No configuration is required — the endpoint is available as soon as the engine is mounted.
@@ -205,15 +240,7 @@ When `connects_to` is `nil` (the default), no connection switching occurs and si
 
 ## Roadmap
 
-Post-1.0 planned features:
-
-**Operations**
-- Admin audit log — record who retried or discarded which jobs and when (requires host-app user identity)
-- Failed job retry with modified arguments — edit the arguments JSON from the job detail page before retrying; useful for correcting bad payloads without redeploying
-
-**Notifications**
-- Multiple webhook targets — support an array of `alert_webhook_url` values so alerts can fan out to Slack, PagerDuty, and custom endpoints simultaneously
-- Queue depth alert — fire a webhook when a queue's ready job count exceeds a configurable threshold (complements the existing failure-count alert)
+See [ROADMAP.md](ROADMAP.md) for the full post-1.0 feature plan, organized by release milestone.
 
 Pull requests for any of these are welcome. See [Contributing](#contributing) below.
 

data/app/assets/stylesheets/solid_queue_web/_07_forms.css

@@ -117,4 +117,28 @@
   background: var(--muted);
   border-color: var(--muted);
   color: #fff;
+}
+
+.sqd-textarea {
+  width: 100%;
+  padding: 0.5rem 0.75rem;
+  border: 1px solid var(--border);
+  border-radius: 5px;
+  font-size: 13px;
+  background: var(--surface);
+  color: var(--text);
+  line-height: 1.6;
+  resize: vertical;
+  box-sizing: border-box;
+  display: block;
+}
+
+.sqd-textarea:focus {
+  outline: 2px solid var(--primary);
+  outline-offset: -1px;
+  border-color: var(--primary);
+}
+
+.sqd-args-form__submit {
+  margin-top: 0.75rem;
 }

data/app/controllers/solid_queue_web/dashboard_controller.rb

@@ -3,6 +3,7 @@ module SolidQueueWeb
     def index
       @stats = DashboardStats.new
       AlertWebhook.call(failure_count: @stats.counts[:failed])
+      QueueDepthAlert.call
     end
   end
 end

data/app/controllers/solid_queue_web/failed_jobs/arguments_controller.rb

@@ -0,0 +1,15 @@
+module SolidQueueWeb
+  class FailedJobs::ArgumentsController < ApplicationController
+    def update
+      execution = SolidQueue::FailedExecution.find(params[:failed_job_id])
+      new_arguments = JSON.parse(params[:arguments])
+      execution.job.update!(arguments: new_arguments)
+      execution.retry
+      redirect_to failed_jobs_path, notice: "Job arguments updated and queued for retry."
+    rescue JSON::ParserError
+      redirect_to job_path(execution.job), alert: "Invalid JSON: could not parse arguments."
+    rescue => e
+      redirect_to failed_jobs_path, alert: "Could not update job: #{e.message}"
+    end
+  end
+end

data/app/services/solid_queue_web/alert_webhook.rb

@@ -12,7 +12,8 @@ module SolidQueueWeb
         return if failure_count < SolidQueueWeb.alert_failure_threshold
         return unless should_fire?
 
-        Thread.new { post(SolidQueueWeb.alert_webhook_url, failure_count) }
+        urls = webhook_urls
+        Thread.new { urls.each { |url| post(url, failure_count) } }
       end
 
       def reset!
@@ -22,7 +23,11 @@ module SolidQueueWeb
       private
 
       def configured?
-        SolidQueueWeb.alert_webhook_url.present? && SolidQueueWeb.alert_failure_threshold.present?
+        webhook_urls.any? && SolidQueueWeb.alert_failure_threshold.present?
+      end
+
+      def webhook_urls
+        Array(SolidQueueWeb.alert_webhook_url).flatten.compact.select(&:present?)
       end
 
       def should_fire?

data/app/services/solid_queue_web/queue_depth_alert.rb

@@ -0,0 +1,74 @@
+require "net/http"
+require "json"
+require "uri"
+
+module SolidQueueWeb
+  class QueueDepthAlert
+    MUTEX = Mutex.new
+
+    class << self
+      def call
+        return unless configured?
+
+        queue_depths = SolidQueue::ReadyExecution
+          .joins(:job)
+          .group("solid_queue_jobs.queue_name")
+          .count
+
+        queue_depths.each do |queue_name, depth|
+          threshold = SolidQueueWeb.alert_queue_thresholds[queue_name.to_s]
+          next unless threshold && depth >= threshold
+          next unless should_fire?(queue_name)
+
+          urls = webhook_urls
+          Thread.new { urls.each { |url| post(url, queue_name, depth, threshold) } }
+        end
+      end
+
+      def reset!
+        MUTEX.synchronize { @last_fired_at = {} }
+      end
+
+      private
+
+      def configured?
+        SolidQueueWeb.alert_queue_thresholds.any? && webhook_urls.any?
+      end
+
+      def webhook_urls
+        Array(SolidQueueWeb.alert_webhook_url).flatten.compact.select(&:present?)
+      end
+
+      def should_fire?(queue_name)
+        MUTEX.synchronize do
+          @last_fired_at ||= {}
+          cooldown = SolidQueueWeb.alert_webhook_cooldown
+          return false if @last_fired_at[queue_name] && Time.current - @last_fired_at[queue_name] < cooldown
+
+          @last_fired_at[queue_name] = Time.current
+          true
+        end
+      end
+
+      def post(url_string, queue_name, depth, threshold)
+        uri = URI.parse(url_string)
+        payload = JSON.generate(
+          event:      "queue_depth_threshold_exceeded",
+          queue_name: queue_name,
+          depth:      depth,
+          threshold:  threshold,
+          fired_at:   Time.current.iso8601
+        )
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == "https"
+        http.open_timeout = 5
+        http.read_timeout = 10
+        request = Net::HTTP::Post.new(uri.path.presence || "/", "Content-Type" => "application/json")
+        request.body = payload
+        http.request(request)
+      rescue => e
+        Rails.logger.error("[SolidQueueWeb] Queue depth alert webhook failed: #{e.message}")
+      end
+    end
+  end
+end

data/app/views/solid_queue_web/jobs/show.html.erb

@@ -63,7 +63,19 @@
 
   <div class="sqd-card sqd-detail-section">
     <h2 class="sqd-section-title">Arguments</h2>
-    <pre class="sqd-pre"><%= JSON.pretty_generate(@job.arguments) rescue @job.arguments.inspect %></pre>
+    <% if @execution_status == "failed" && @job.failed_execution %>
+      <% args_json = begin; JSON.pretty_generate(@job.arguments); rescue; @job.arguments.inspect; end %>
+      <%= form_with url: failed_job_arguments_path(@job.failed_execution), method: :patch do |f| %>
+        <%= f.text_area :arguments,
+              value: args_json,
+              class: "sqd-textarea sqd-mono",
+              rows: [args_json.lines.count + 1, 6].max,
+              "aria-label": "Job arguments JSON" %>
+        <%= f.submit "Retry with these arguments", class: "sqd-btn sqd-btn--primary sqd-args-form__submit" %>
+      <% end %>
+    <% else %>
+      <pre class="sqd-pre"><%= JSON.pretty_generate(@job.arguments) rescue @job.arguments.inspect %></pre>
+    <% end %>
   </div>
 </div>
 

data/config/routes.rb

@@ -38,6 +38,7 @@ SolidQueueWeb::Engine.routes.draw do
   resource :failed_job_selection, path: "failed_jobs/selection", only: [:create, :destroy],
            controller: "failed_jobs/selections"
   resources :failed_jobs, only: [:index, :destroy] do
+    resource :arguments, only: [:update], controller: "failed_jobs/arguments"
     collection do
       post :retry_all,   to: "retry_failed_jobs#create"
       post :discard_all, action: :destroy

data/lib/solid_queue_web/version.rb

@@ -1,3 +1,3 @@
 module SolidQueueWeb
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/solid_queue_web.rb

@@ -6,7 +6,7 @@ module SolidQueueWeb
   class << self
     attr_writer :page_size, :dashboard_refresh_interval, :default_refresh_interval, :search_results_limit,
                 :slow_job_threshold, :alert_webhook_url, :alert_failure_threshold, :alert_webhook_cooldown,
-                :connects_to
+                :alert_queue_thresholds, :connects_to
 
     def page_size
       @page_size || 25
@@ -40,6 +40,10 @@ module SolidQueueWeb
       @alert_webhook_cooldown || 3600
     end
 
+    def alert_queue_thresholds
+      @alert_queue_thresholds || {}
+    end
+
     def connects_to
       @connects_to
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_queue_web
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -93,9 +93,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.2'
-description: Mount SolidQueueWeb in any Rails app using Solid Queue to get a dashboard
-  for your queues, jobs by status, failed executions, and job actions (retry, discard)
-  — all without leaving your app.
+description: 'Mount SolidQueueWeb in any Rails app using Solid Queue to get a full-featured
+  job dashboard: inspect jobs by status (ready, scheduled, running, blocked, failed),
+  retry or discard failed jobs, reschedule or run scheduled jobs immediately, manage
+  recurring tasks, filter by queue/priority/period, export to CSV, detect slow jobs,
+  view queue depth sparklines, track job performance (p50/p95), and scrape a /metrics
+  JSON endpoint for external monitoring — all without leaving your app.'
 email:
 - eclectic-coding@users.noreply.github.com
 executables: []
@@ -121,6 +124,7 @@ files:
 - app/controllers/solid_queue_web/application_controller.rb
 - app/controllers/solid_queue_web/blocked_jobs_controller.rb
 - app/controllers/solid_queue_web/dashboard_controller.rb
+- app/controllers/solid_queue_web/failed_jobs/arguments_controller.rb
 - app/controllers/solid_queue_web/failed_jobs/selections_controller.rb
 - app/controllers/solid_queue_web/failed_jobs_controller.rb
 - app/controllers/solid_queue_web/history_controller.rb
@@ -150,6 +154,7 @@ files:
 - app/services/solid_queue_web/dashboard_stats.rb
 - app/services/solid_queue_web/job_performance_stats.rb
 - app/services/solid_queue_web/metrics_payload.rb
+- app/services/solid_queue_web/queue_depth_alert.rb
 - app/services/solid_queue_web/queue_stats.rb
 - app/views/layouts/solid_queue_web/application.html.erb
 - app/views/solid_queue_web/dashboard/index.html.erb