solid_queue_web 0.8.0 → 1.0.0

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

@@ -5,22 +5,29 @@
 
 <div class="sqd-page-header">
   <div class="sqd-filters">
-    <%= link_to "Ready",     jobs_path(status: "ready",     q: @search, period: @period), class: @status == "ready"     ? "active" : "" %>
-    <%= link_to "Scheduled", jobs_path(status: "scheduled", q: @search, period: @period), class: @status == "scheduled" ? "active" : "" %>
-    <%= link_to "Running",   jobs_path(status: "claimed",   q: @search, period: @period), class: @status == "claimed"   ? "active" : "" %>
-    <%= link_to "Blocked",   jobs_path(status: "blocked",   q: @search, period: @period), class: @status == "blocked"   ? "active" : "" %>
-    <%= link_to "Failed",    jobs_path(status: "failed",    q: @search, period: @period), class: @status == "failed"    ? "active" : "" %>
+    <%= link_to "Ready",     jobs_path(status: "ready",     q: @search, period: @period, priority: @priority), class: @status == "ready"     ? "active" : "" %>
+    <%= link_to "Scheduled", jobs_path(status: "scheduled", q: @search, period: @period, priority: @priority), class: @status == "scheduled" ? "active" : "" %>
+    <%= link_to "Running",   jobs_path(status: "claimed",   q: @search, period: @period, priority: @priority), class: @status == "claimed"   ? "active" : "" %>
+    <%= link_to "Blocked",   jobs_path(status: "blocked",   q: @search, period: @period, priority: @priority), class: @status == "blocked"   ? "active" : "" %>
+    <%= link_to "Failed",    jobs_path(status: "failed",    q: @search, period: @period, priority: @priority), class: @status == "failed"    ? "active" : "" %>
   </div>
   <% if @jobs.any? %>
     <div class="sqd-actions">
       <%= link_to "Export CSV", jobs_path(format: :csv, status: @status, q: @search, period: @period),
             class: "sqd-btn sqd-btn--muted", data: { turbo: false } %>
+      <% if @status == "scheduled" %>
+        <%= button_to "Run All Now", run_all_now_scheduled_jobs_path,
+              method: :post,
+              params: { period: @period },
+              class: "sqd-btn sqd-btn--primary",
+              data: { confirm: "Run all #{@pagy.count} scheduled jobs immediately?" } %>
+      <% end %>
       <% if discardable %>
         <%= button_to "Discard All", discard_all_jobs_path,
               method: :post,
               params: { status: @status, period: @period },
               class: "sqd-btn sqd-btn--danger",
-              data: { confirm: "Discard all #{@jobs.size} #{@status} jobs? This cannot be undone." } %>
+              data: { confirm: "Discard all #{@pagy.count} #{@status} jobs? This cannot be undone." } %>
       <% end %>
     </div>
   <% end %>
@@ -32,14 +39,23 @@
   <input class="sqd-search__input" type="search" name="q" value="<%= @search %>"
          placeholder="Filter by job class…" autocomplete="off" aria-label="Filter by job class"
          data-action="input->search#filter">
-  <% if @search.present? %>
+  <% if @priority_options.size > 1 %>
+    <select name="priority" class="sqd-select" aria-label="Filter by priority"
+            onchange="this.form.submit()">
+      <option value="" <%= @priority.nil? ? "selected" : "" %>>All priorities</option>
+      <% @priority_options.each do |p| %>
+        <option value="<%= p %>" <%= @priority.to_s == p.to_s ? "selected" : "" %>>Priority <%= p %></option>
+      <% end %>
+    </select>
+  <% end %>
+  <% if @search.present? || @priority.present? %>
     <%= link_to "Clear", jobs_path(status: @status, period: @period), class: "sqd-btn sqd-btn--muted" %>
   <% end %>
   <div class="sqd-period-filter" role="group" aria-label="Time period">
-    <%= link_to "All", jobs_path(status: @status, q: @search),                       class: @period.nil?       ? "active" : "", aria: { current: @period.nil?       ? "true" : nil }, aria_label: "All time" %>
-    <%= link_to "1h",  jobs_path(status: @status, q: @search, period: "1h"),  class: @period == "1h"  ? "active" : "", aria: { current: @period == "1h"  ? "true" : nil }, aria_label: "Last 1 hour" %>
-    <%= link_to "24h", jobs_path(status: @status, q: @search, period: "24h"), class: @period == "24h" ? "active" : "", aria: { current: @period == "24h" ? "true" : nil }, aria_label: "Last 24 hours" %>
-    <%= link_to "7d",  jobs_path(status: @status, q: @search, period: "7d"),  class: @period == "7d"  ? "active" : "", aria: { current: @period == "7d"  ? "true" : nil }, aria_label: "Last 7 days" %>
+    <%= link_to "All", jobs_path(status: @status, q: @search, priority: @priority),                       class: @period.nil?       ? "active" : "", aria: { current: @period.nil?       ? "true" : nil }, aria_label: "All time" %>
+    <%= link_to "1h",  jobs_path(status: @status, q: @search, priority: @priority, period: "1h"),  class: @period == "1h"  ? "active" : "", aria: { current: @period == "1h"  ? "true" : nil }, aria_label: "Last 1 hour" %>
+    <%= link_to "24h", jobs_path(status: @status, q: @search, priority: @priority, period: "24h"), class: @period == "24h" ? "active" : "", aria: { current: @period == "24h" ? "true" : nil }, aria_label: "Last 24 hours" %>
+    <%= link_to "7d",  jobs_path(status: @status, q: @search, priority: @priority, period: "7d"),  class: @period == "7d"  ? "active" : "", aria: { current: @period == "7d"  ? "true" : nil }, aria_label: "Last 7 days" %>
   </div>
 </form>
 
@@ -87,18 +103,31 @@
               </td>
               <td>
                 <span class="sqd-badge sqd-badge--<%= @status %>"><%= @status %></span>
-                <%= link_to job.class_name, job_path(job), style: "margin-left: 0.5rem;", data: { turbo_frame: "_top" } %>
+                <%= link_to job.class_name, job_path(job), class: "sqd-table-link", style: "margin-left: 0.5rem;", data: { turbo_frame: "_top" } %>
               </td>
               <td>
                 <%= link_to job.queue_name, queue_jobs_path(queue_name: job.queue_name, status: @status),
                       class: "sqd-mono", style: "color: inherit;" %>
               </td>
               <td><%= job.priority %></td>
-              <td class="sqd-mono">
+              <td id="scheduled_at_<%= execution.id %>" class="sqd-mono">
                 <%= job.scheduled_at ? job.scheduled_at.strftime("%Y-%m-%d %H:%M:%S") : "—" %>
               </td>
               <td class="sqd-mono"><%= job.created_at.strftime("%Y-%m-%d %H:%M:%S") %></td>
               <td class="sqd-row-actions">
+                <% if @status == "scheduled" %>
+                  <%= button_to "Run Now", scheduled_job_path(execution),
+                        method: :patch,
+                        params: { offset: "now", period: @period },
+                        class: "sqd-btn sqd-btn--primary sqd-btn--sm",
+                        data: { confirm: "Run this job immediately?" } %>
+                  <% %w[1h 24h 7d].each do |offset| %>
+                    <%= button_to "+#{offset}", scheduled_job_path(execution),
+                          method: :patch,
+                          params: { offset: offset, period: @period },
+                          class: "sqd-btn sqd-btn--muted sqd-btn--sm" %>
+                  <% end %>
+                <% end %>
                 <%= button_to "Discard", job_path(execution),
                       method: :delete,
                       params: { status: @status, period: @period },
@@ -116,6 +145,7 @@
     <% if @jobs.empty? %>
       <div class="sqd-empty">No <%= @status %> jobs.</div>
     <% else %>
+      <% slow_threshold = @status == "claimed" ? SolidQueueWeb.slow_job_threshold : nil %>
       <table>
         <thead>
           <tr>
@@ -124,15 +154,22 @@
             <th scope="col">Priority</th>
             <th scope="col">Scheduled At</th>
             <th scope="col">Enqueued At</th>
+            <% if @status == "claimed" %>
+              <th scope="col">Running For</th>
+            <% end %>
           </tr>
         </thead>
         <tbody>
           <% @jobs.each do |execution| %>
             <% job = execution.job %>
-            <tr id="execution_<%= execution.id %>">
+            <% slow = slow_threshold && execution.created_at <= slow_threshold.ago %>
+            <tr id="execution_<%= execution.id %>"<%= slow ? ' class="sqd-row--slow"'.html_safe : "" %>>
               <td>
                 <span class="sqd-badge sqd-badge--<%= @status %>"><%= @status %></span>
-                <%= link_to job.class_name, job_path(job), style: "margin-left: 0.5rem;", data: { turbo_frame: "_top" } %>
+                <% if slow %>
+                  <span class="sqd-badge sqd-badge--slow">slow</span>
+                <% end %>
+                <%= link_to job.class_name, job_path(job), class: "sqd-table-link", style: "margin-left: 0.5rem;", data: { turbo_frame: "_top" } %>
               </td>
               <td>
                 <%= link_to job.queue_name, queue_jobs_path(queue_name: job.queue_name, status: @status),
@@ -143,6 +180,11 @@
                 <%= job.scheduled_at ? job.scheduled_at.strftime("%Y-%m-%d %H:%M:%S") : "—" %>
               </td>
               <td class="sqd-mono"><%= job.created_at.strftime("%Y-%m-%d %H:%M:%S") %></td>
+              <% if @status == "claimed" %>
+                <td class="sqd-mono<%= slow ? " sqd-slow-duration" : "" %>">
+                  <%= time_ago_in_words(execution.created_at) %>
+                </td>
+              <% end %>
             </tr>
           <% end %>
         </tbody>

data/app/views/solid_queue_web/performance/index.html.erb

@@ -0,0 +1,50 @@
+<div class="sqd-page-header">
+  <h1 class="sqd-page-title">Performance</h1>
+</div>
+
+<form class="sqd-search" action="<%= performance_path %>" method="get">
+  <div class="sqd-period-filter" role="group" aria-label="Time period">
+    <%= link_to "All",  performance_path,                      class: @period.nil?       ? "active" : "", aria: { current: @period.nil?       ? "true" : nil } %>
+    <%= link_to "1h",   performance_path(period: "1h"),  class: @period == "1h"  ? "active" : "", aria: { current: @period == "1h"  ? "true" : nil } %>
+    <%= link_to "24h",  performance_path(period: "24h"), class: @period == "24h" ? "active" : "", aria: { current: @period == "24h" ? "true" : nil } %>
+    <%= link_to "7d",   performance_path(period: "7d"),  class: @period == "7d"  ? "active" : "", aria: { current: @period == "7d"  ? "true" : nil } %>
+  </div>
+</form>
+
+<% if @rows.any? %>
+  <div class="sqd-card" style="margin-top: 1rem;">
+    <table>
+      <thead>
+        <tr>
+          <th scope="col">Job Class</th>
+          <th scope="col" style="text-align: right;">Runs</th>
+          <th scope="col" style="text-align: right;">Avg</th>
+          <th scope="col" style="text-align: right;">p50</th>
+          <th scope="col" style="text-align: right;">p95</th>
+          <th scope="col" style="text-align: right;">Min</th>
+          <th scope="col" style="text-align: right;">Max</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @rows.each do |row| %>
+          <tr>
+            <td>
+              <%= link_to row.class_name, history_path(q: row.class_name, period: @period),
+                    class: "sqd-table-link" %>
+            </td>
+            <td class="sqd-mono" style="text-align: right;"><%= row.count %></td>
+            <td class="sqd-mono" style="text-align: right;"><%= format_duration(row.avg) %></td>
+            <td class="sqd-mono" style="text-align: right;"><%= format_duration(row.p50) %></td>
+            <td class="sqd-mono" style="text-align: right;"><%= format_duration(row.p95) %></td>
+            <td class="sqd-mono" style="text-align: right;"><%= format_duration(row.min) %></td>
+            <td class="sqd-mono" style="text-align: right;"><%= format_duration(row.max) %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+<% else %>
+  <div class="sqd-card" style="margin-top: 1rem;">
+    <div class="sqd-empty">No finished jobs found<%= " in the last #{@period}" if @period %>.</div>
+  </div>
+<% end %>

data/app/views/solid_queue_web/queues/index.html.erb

@@ -12,6 +12,7 @@
           <th scope="col">Latency</th>
           <th scope="col">Done (24h)</th>
           <th scope="col">Failed (24h)</th>
+          <th scope="col">Failure Rate (12h)</th>
           <th scope="col">Status</th>
           <th scope="col"><span class="sqd-sr-only">Actions</span></th>
         </tr>
@@ -34,6 +35,22 @@
             </td>
             <td style="color: var(--success);"><%= @completed_24h[queue.name] || 0 %></td>
             <td style="color: <%= (@failed_24h[queue.name] || 0) > 0 ? "var(--danger)" : "inherit" %>;"><%= @failed_24h[queue.name] || 0 %></td>
+            <td>
+              <% sparkline = @failure_sparklines[queue.name] %>
+              <% if sparkline.any? %>
+                <div class="sqd-mini-sparkline" aria-label="Failure rate last 12 hours for <%= queue.name %>">
+                  <% sparkline.each_with_index do |rate, i| %>
+                    <% pct = rate || 0 %>
+                    <% hour_label = (12 - i).hours.ago.strftime("%-I%p").downcase %>
+                    <div class="sqd-mini-sparkline__bar sqd-mini-sparkline__bar--<%= rate ? "data" : "empty" %>"
+                         style="height: <%= [pct, 2].max %>%"
+                         title="<%= hour_label %>: <%= rate ? "#{rate}% failure rate" : "no data" %>"></div>
+                  <% end %>
+                </div>
+              <% else %>
+                <span style="color: var(--muted)">—</span>
+              <% end %>
+            </td>
             <td>
               <% if queue.paused? %>
                 <span class="sqd-badge sqd-badge--paused">Paused</span>
@@ -43,10 +60,10 @@
             </td>
             <td class="sqd-row-actions">
               <% if queue.paused? %>
-                <%= button_to "Resume", resume_queue_path(queue.name), method: :post,
+                <%= button_to "Resume", queue_pause_path(queue.name), method: :delete,
                       class: "sqd-btn sqd-btn--primary sqd-btn--sm" %>
               <% else %>
-                <%= button_to "Pause", pause_queue_path(queue.name), method: :post,
+                <%= button_to "Pause", queue_pause_path(queue.name), method: :post,
                       class: "sqd-btn sqd-btn--muted sqd-btn--sm",
                       data: { confirm: "Pause queue \"#{queue.name}\"?" } %>
               <% end %>

data/app/views/solid_queue_web/queues/jobs/index.html.erb

@@ -60,7 +60,7 @@
           <tr id="execution_<%= execution.id %>">
             <td>
               <span class="sqd-badge sqd-badge--<%= @status %>"><%= @status %></span>
-              <%= link_to job.class_name, job_path(job), style: "margin-left: 0.5rem;", data: { turbo_frame: "_top" } %>
+              <%= link_to job.class_name, job_path(job), class: "sqd-table-link", style: "margin-left: 0.5rem;", data: { turbo_frame: "_top" } %>
             </td>
             <td><%= job.priority %></td>
             <td class="sqd-mono">

data/app/views/solid_queue_web/recurring_tasks/index.html.erb

@@ -14,6 +14,7 @@
           <th scope="col">Next Run</th>
           <th scope="col">Last Run</th>
           <th scope="col">Type</th>
+          <th scope="col"><span class="sqd-sr-only">Actions</span></th>
         </tr>
       </thead>
       <tbody>
@@ -60,6 +61,12 @@
                 <span class="sqd-badge sqd-badge--dynamic">Dynamic</span>
               <% end %>
             </td>
+            <td class="sqd-row-actions">
+              <%= button_to "Run Now", recurring_task_run_path(task.key),
+                    method: :post,
+                    class: "sqd-btn sqd-btn--primary sqd-btn--sm",
+                    data: { confirm: "Run \"#{task.key}\" immediately?" } %>
+            </td>
           </tr>
         <% end %>
       </tbody>

data/app/views/solid_queue_web/scheduled_jobs/update.turbo_stream.erb

@@ -0,0 +1,9 @@
+<% if @run_now %>
+  <%= turbo_stream.remove "execution_#{@execution.id}" %>
+<% else %>
+  <%= turbo_stream.replace "scheduled_at_#{@execution.id}" do %>
+    <td id="scheduled_at_<%= @execution.id %>" class="sqd-mono">
+      <%= @execution.scheduled_at.strftime("%Y-%m-%d %H:%M:%S") %>
+    </td>
+  <% end %>
+<% end %>

data/app/views/solid_queue_web/search/index.html.erb

@@ -50,7 +50,7 @@
               <% data[:executions].each do |execution| %>
                 <% job = execution.job %>
                 <tr>
-                  <td><%= link_to job.class_name, job_path(job) %></td>
+                  <td><%= link_to job.class_name, job_path(job), class: "sqd-table-link" %></td>
                   <td class="sqd-mono"><%= job.queue_name %></td>
                   <td class="sqd-mono"><%= job.created_at.strftime("%Y-%m-%d %H:%M:%S") %></td>
                 </tr>

data/config/routes.rb

@@ -1,27 +1,33 @@
 SolidQueueWeb::Engine.routes.draw do
   root to: "dashboard#index"
-  post "retry_all_failed",    to: "dashboard#retry_all_failed",    as: :retry_all_failed
-  post "discard_all_blocked", to: "dashboard#discard_all_blocked", as: :discard_all_blocked
+  resource :blocked_jobs, only: [:destroy]
 
-  get "search", to: "search#index", as: :search
-  get "history", to: "history#index", as: :history
+  get "metrics", to: "metrics#index", as: :metrics, defaults: { format: :json }
+  get "search",      to: "search#index",      as: :search
+  get "history",     to: "history#index",     as: :history
+  get "performance", to: "performance#index", as: :performance
 
-  resources :recurring_tasks, only: [:index]
+  resources :recurring_tasks, only: [:index], param: :key do
+    resource :run, only: [:create], controller: "recurring_tasks/runs"
+  end
   resources :processes, only: [:index]
   resources :queues, only: [:index], param: :name do
-    member do
-      post :pause
-      post :resume
-    end
+    resource :pause, only: [:create, :destroy], controller: "queues/pauses"
     resources :jobs, path: "list", only: [:index, :destroy], controller: "queues/jobs" do
       collection do
-        post :discard_all
+        post :discard_all, action: :destroy
       end
     end
   end
 
   # Singular selection resources must be defined before the member routes of their
   # parent resources, otherwise DELETE /list/selection matches /list/:id first.
+  resources :scheduled_jobs, only: [:update] do
+    collection do
+      post :run_all_now, action: :create
+    end
+  end
+
   resource :job_selection, path: "list/selection", only: [:destroy], controller: "jobs/selections"
   resources :jobs, path: "list", only: [:index, :show, :destroy] do
     collection do

data/lib/solid_queue_web/version.rb

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

data/lib/solid_queue_web.rb

@@ -4,7 +4,9 @@ require "solid_queue_web/engine"
 
 module SolidQueueWeb
   class << self
-    attr_writer :page_size, :dashboard_refresh_interval, :default_refresh_interval, :search_results_limit
+    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
 
     def page_size
       @page_size || 25
@@ -22,6 +24,26 @@ module SolidQueueWeb
       @search_results_limit || 25
     end
 
+    def slow_job_threshold
+      @slow_job_threshold
+    end
+
+    def alert_webhook_url
+      @alert_webhook_url
+    end
+
+    def alert_failure_threshold
+      @alert_failure_threshold
+    end
+
+    def alert_webhook_cooldown
+      @alert_webhook_cooldown || 3600
+    end
+
+    def connects_to
+      @connects_to
+    end
+
     def configure
       yield self
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_queue_web
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -119,17 +119,23 @@ files:
 - app/assets/stylesheets/solid_queue_web/_12_dark_mode.css
 - app/assets/stylesheets/solid_queue_web/application.css
 - 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/selections_controller.rb
 - app/controllers/solid_queue_web/failed_jobs_controller.rb
 - app/controllers/solid_queue_web/history_controller.rb
 - app/controllers/solid_queue_web/jobs/selections_controller.rb
 - app/controllers/solid_queue_web/jobs_controller.rb
+- app/controllers/solid_queue_web/metrics_controller.rb
+- app/controllers/solid_queue_web/performance_controller.rb
 - app/controllers/solid_queue_web/processes_controller.rb
 - app/controllers/solid_queue_web/queues/jobs_controller.rb
+- app/controllers/solid_queue_web/queues/pauses_controller.rb
 - app/controllers/solid_queue_web/queues_controller.rb
+- app/controllers/solid_queue_web/recurring_tasks/runs_controller.rb
 - app/controllers/solid_queue_web/recurring_tasks_controller.rb
 - app/controllers/solid_queue_web/retry_failed_jobs_controller.rb
+- app/controllers/solid_queue_web/scheduled_jobs_controller.rb
 - app/controllers/solid_queue_web/search_controller.rb
 - app/helpers/solid_queue_web/application_helper.rb
 - app/javascript/solid_queue_web/application.js
@@ -140,6 +146,11 @@ files:
 - app/jobs/solid_queue_web/application_job.rb
 - app/models/solid_queue_web/application_record.rb
 - app/models/solid_queue_web/job.rb
+- app/services/solid_queue_web/alert_webhook.rb
+- 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_stats.rb
 - app/views/layouts/solid_queue_web/application.html.erb
 - app/views/solid_queue_web/dashboard/index.html.erb
 - app/views/solid_queue_web/failed_jobs/index.html.erb
@@ -147,11 +158,13 @@ files:
 - app/views/solid_queue_web/jobs/destroy.turbo_stream.erb
 - app/views/solid_queue_web/jobs/index.html.erb
 - app/views/solid_queue_web/jobs/show.html.erb
+- app/views/solid_queue_web/performance/index.html.erb
 - app/views/solid_queue_web/processes/index.html.erb
 - app/views/solid_queue_web/queues/index.html.erb
 - app/views/solid_queue_web/queues/jobs/destroy.turbo_stream.erb
 - app/views/solid_queue_web/queues/jobs/index.html.erb
 - app/views/solid_queue_web/recurring_tasks/index.html.erb
+- app/views/solid_queue_web/scheduled_jobs/update.turbo_stream.erb
 - app/views/solid_queue_web/search/index.html.erb
 - config/importmap.rb
 - config/routes.rb