que-view 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d07972f8adf809f3f10f495824376c64724e1526e7afd6d85a05da93632741e0
-  data.tar.gz: 95d6ce6e4d1340dcb550a1ae4b85560f19a18de0b9c0dec1eea5ce5a44726ddf
+  metadata.gz: 062e48206fe33c45a7f007d831b31a5c4566d6eb4af6891cfad6949108f45b56
+  data.tar.gz: c3c2fd233567554fc46e7296a9895d7e8c7b650789fcb1fb7f49d2d023cc3670
 SHA512:
-  metadata.gz: 9553edb70775fc2fa268ad2ec3e14d3ab51c3858b54363efbb0d6b8aae85f00d450d99e925cd576dc7117f1ff784bbbe664d763305123598acc35bda57e38e8b
-  data.tar.gz: ce8bc2cbfef7844814f60125bbad375bf676bc2ef14180d5a2bdc2b4a9fd5cc3ac1920f5b5f40b540a2e600ee4107c247c3b89f90d3e7662725de1a6539c2461
+  metadata.gz: 3a4b0f0e2bac21033c9e3db5a8ea193b599679e88abb064f7a07b71608893e861e192196d2b688f70c8f9cf5c092d48b40925bfa190d1760172965ac8c319149
+  data.tar.gz: 3db157d3fb95fa530c43607ac9c7924b9ca84cbc305f134ae08635048d77c0213e71401770e4e8c30bbffbfc414c4f233d17bd5896ce2b661b12d464f1914c93

data/README.md

@@ -4,12 +4,13 @@ SQL queries came from Que::Web, some styling from there too.
 
 Benefits for using this one:
 - no Sinatra (que-web based on Sinatra),
-- no Foundation for styles,
-- no jQuery,
+- no Foundation for styles (and no external styles at all),
+- no jQuery (and no java scripts at all),
 - Que::Web was last updated 2 years ago.
 
-<img width="1735" alt="Снимок экрана 2024-02-21 в 15 10 35" src="https://github.com/kortirso/que-view/assets/6195394/cd2812c7-abb0-48d9-92d5-4dbef93bcd9e">
-<img width="1735" alt="Снимок экрана 2024-02-21 в 15 11 12" src="https://github.com/kortirso/que-view/assets/6195394/8af01e7f-a002-4ef1-aeff-f96fd27c639f">
+<img width="1731" alt="Снимок экрана 2024-03-03 в 08 28 09" src="https://github.com/kortirso/que-view/assets/6195394/fdaf315d-6c6e-40ee-a60f-cd740cc7ec93">
+<img width="1734" alt="Снимок экрана 2024-03-03 в 08 27 47" src="https://github.com/kortirso/que-view/assets/6195394/e45d334e-7637-41f8-af16-d6a9ac35f263">
+<img width="1730" alt="Снимок экрана 2024-03-03 в 23 09 57" src="https://github.com/kortirso/que-view/assets/6195394/d790066f-3e96-4775-afd6-018750d0afd3">
 
 
 ## Installation

data/app/assets/stylesheets/que/view/application.css

@@ -29,6 +29,10 @@ body {
   background: #fafafa;
 }
 
+h1 {
+  margin-top: 0;
+}
+
 .row {
   display: flex;
 }
@@ -112,7 +116,7 @@ body {
 }
 
 .pagination {
-  margin: 1rem auto;
+  margin: 0 auto 1rem;
 }
 
 .pagination .pagination-link {
@@ -181,6 +185,10 @@ body {
   background: #e7e5e4;
 }
 
+.search-form {
+  margin-bottom: 1rem;
+}
+
 .search-form .form-select {
   margin-right: 1rem;
   padding: .5rem 1rem;
@@ -221,6 +229,19 @@ table p {
   margin: 0;
 }
 
+.lockers {
+  margin-top: 2rem;
+}
+
+.lockers .locker-process {
+  display: flex;
+  flex-direction: column;
+}
+
+.metrics a {
+  color: #000;
+}
+
 @media screen and (max-width: 768px) {
   .dashboard-row {
     flex-direction: column;

data/app/controllers/que/view/jobs_controller.rb

@@ -84,7 +84,7 @@ module Que
 
       def find_jobs(params)
         case params[:status]&.to_sym
-        when :running then ::Que::View.fetch_running_jobs(params)
+        when :running then ::Que::View.fetch_running_jobs
         when :failing then ::Que::View.fetch_failing_jobs(PER_PAGE, offset, params)
         when :scheduled then ::Que::View.fetch_scheduled_jobs(PER_PAGE, offset, params)
         when :finished then ::Que::View.fetch_finished_jobs(PER_PAGE, offset, params)

data/app/controllers/que/view/queue_metrics_controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Que
+  module View
+    class QueueMetricsController < Que::View::ApplicationController
+      before_action :find_queue_metrics, only: %i[index]
+      before_action :find_queue_latencies, only: %i[index]
+
+      def index; end
+
+      private
+
+      def find_queue_metrics
+        @queue_metrics = ::Que::View.fetch_queue_metrics
+      end
+
+      def find_queue_latencies
+        current_time = DateTime.now.to_i
+        @queue_latencies =
+          ::Que::View
+            .fetch_queue_latencies(@queue_metrics.keys)
+            .transform_values { |value| current_time - value.to_time.to_i }
+      end
+    end
+  end
+end

data/app/controllers/que/view/welcome_controller.rb

@@ -5,6 +5,7 @@ module Que
     class WelcomeController < Que::View::ApplicationController
       def index
         @dashboard_stats = ::Que::View.fetch_dashboard_stats[0]
+        @lockers = ::Que::View.fetch_que_lockers
       end
     end
   end

data/app/views/layouts/que/view/application.html.erb

@@ -26,6 +26,9 @@
           <li class="<%= 'active' if params[:status] == 'expired' %>">
             <%= link_to 'Expired', jobs_path(status: 'expired') %>
           </li>
+          <li class="<%= 'active' if current_page?(queue_metrics_path) %>">
+            <%= link_to 'Queue metrics', queue_metrics_path %>
+          </li>
         </ul>
         <ul class="version">
           <li>Que <%= Que::VERSION %></li>

data/app/views/que/view/jobs/index.html.erb

@@ -1,3 +1,4 @@
+<h1><%= params[:status].capitalize %> jobs</h1>
 <%= form_with url: jobs_path, method: :get, class: 'search-form' do |form| %>
   <%= form.hidden_field :status, value: params[:status] %>
   <div class="row">
@@ -6,77 +7,73 @@
     <%= form.submit 'Search', class: 'btn-primary' %>
   </div>
 <% end %>
-<% if @jobs.any? %>
-  <% if @pagination %>
-    <div class="row pagination">
-      <% if @pagination.previous_page? %>
-        <%= link_to 'First', jobs_path(status: params[:status], page: 1), class: 'pagination-link' %>
-        <%= link_to '< Previous', jobs_path(status: params[:status], page: @pagination.previous_page), class: 'pagination-link' %>
-      <% else %>
-        <p class="pagination-link disabled">First</p>
-        <p class="pagination-link disabled">&#60; Previous</p>
+<% if @pagination && @pagination.total_pages > 1 %>
+  <div class="row pagination">
+    <% if @pagination.previous_page? %>
+      <%= link_to 'First', jobs_path(status: params[:status], page: 1), class: 'pagination-link' %>
+      <%= link_to '< Previous', jobs_path(status: params[:status], page: @pagination.previous_page), class: 'pagination-link' %>
+    <% else %>
+      <p class="pagination-link disabled">First</p>
+      <p class="pagination-link disabled">&#60; Previous</p>
+    <% end %>
+    <p class="total-pages"><%= "Page #{@pagination.page} of #{@pagination.total_pages}" %></p>
+    <% if @pagination.next_page? %>
+      <%= link_to 'Next >', jobs_path(status: params[:status], page: @pagination.next_page), class: 'pagination-link' %>
+      <%= link_to 'Last', jobs_path(status: params[:status], page: @pagination.total_pages), class: 'pagination-link' %>
+    <% else %>
+      <p class="pagination-link disabled">Next &#62;</p>
+      <p class="pagination-link disabled">Last </p>
+    <% end %>
+  </div>
+<% end %>
+<table cellspacing="0" class="jobs-list">
+  <thead>
+    <tr>
+      <th>ID</th>
+      <th>Job</th>
+      <th>Queue</th>
+      <th>Run at</th>
+      <th>Arguments</th>
+      <% if params[:status] == 'failing' %>
+        <th>Failures</th>
+        <th>Error</th>
       <% end %>
-      <p class="total-pages"><%= "Page #{@pagination.page} of #{@pagination.total_pages}" %></p>
-      <% if @pagination.next_page? %>
-        <%= link_to 'Next >', jobs_path(status: params[:status], page: @pagination.next_page), class: 'pagination-link' %>
-        <%= link_to 'Last', jobs_path(status: params[:status], page: @pagination.total_pages), class: 'pagination-link' %>
-      <% else %>
-        <p class="pagination-link disabled">Next &#62;</p>
-        <p class="pagination-link disabled">Last </p>
+      <% if %w[failing scheduled].include?(params[:status]) %>
+        <th>Actions</th>
       <% end %>
-    </div>
-  <% end %>
-  <table cellspacing="0" class="jobs-list">
-    <thead>
+    </tr>
+  </thead>
+  <tbody>
+    <% @jobs.each do |job| %>
       <tr>
-        <th>ID</th>
-        <th>Job</th>
-        <th>Queue</th>
-        <th>Run at</th>
-        <th>Arguments</th>
+        <td><%= link_to job[:id], job_path(job[:id]) %></td>
+        <td><%= humanized_job_class(job) %></td>
+        <td><%= job[:queue] %></td>
+        <td><%= job[:run_at].strftime("%Y-%m-%d %H:%M:%S") %></td>
+        <td>
+          <% job.dig(:args, 0, :arguments).each do |argument| %>
+            <p><%= argument %></p>
+          <% end %>
+        </td>
         <% if params[:status] == 'failing' %>
-          <th>Failures</th>
-          <th>Error</th>
+          <td><%= job[:error_count] %></td>
+          <td><%= format_error(job) %></td>
         <% end %>
         <% if %w[failing scheduled].include?(params[:status]) %>
-          <th>Actions</th>
-        <% end %>
-      </tr>
-    </thead>
-    <tbody>
-      <% @jobs.each do |job| %>
-        <tr>
-          <td><%= link_to job[:id], job_path(job[:id]) %></td>
-          <td><%= humanized_job_class(job) %></td>
-          <td><%= job[:queue] %></td>
-          <td><%= job[:run_at].strftime("%Y-%m-%d %H:%M:%S") %></td>
           <td>
-            <% job.dig(:args, 0, :arguments).each do |argument| %>
-              <p><%= argument %></p>
-            <% end %>
+            <div class="actions">
+              <%= button_to 'Run', job_path(job[:id]), class: 'btn-danger', method: :patch, onclick: "return confirm('Are you sure you wish to reschedule job?')" %>
+              <%= button_to 'Delete', job_path(job[:id]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete job?')" %>
+            </div>
           </td>
-          <% if params[:status] == 'failing' %>
-            <td><%= job[:error_count] %></td>
-            <td><%= format_error(job) %></td>
-          <% end %>
-          <% if %w[failing scheduled].include?(params[:status]) %>
-            <td>
-              <div class="actions">
-                <%= button_to 'Run', job_path(job[:id]), class: 'btn-danger', method: :patch, onclick: "return confirm('Are you sure you wish to reschedule job?')" %>
-                <%= button_to 'Delete', job_path(job[:id]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete job?')" %>
-              </div>
-            </td>
-          <% end %>
-        </tr>
-      <% end %>
-    </tbody>
-  </table>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+<% if @pagination && %w[failing scheduled].include?(params[:status]) %>
   <div class="row">
     <%= button_to 'Run All', reschedule_all_jobs_path(status: params[:status]), class: 'btn-danger', method: :post, onclick: "return confirm('Are you sure you wish to reschedule all jobs?')" %>
     <%= button_to 'Delete All', destroy_all_jobs_path(status: params[:status]), class: 'btn-danger', method: :delete, onclick: "return confirm('Are you sure you wish to delete all jobs?')" %>
   </div>
-<% else %>
-  <div class="row">
-    <p>No jobs found</p>
-  </div>
 <% end %>

data/app/views/que/view/jobs/show.html.erb

@@ -18,6 +18,10 @@
         <th>Priority</th>
         <td><%= @job[:priority] %></td>
       </tr>
+      <tr>
+        <th>Enqueued at</th>
+        <td><%= @job.dig(:args, 0, :enqueued_at).to_time.strftime("%Y-%m-%d %H:%M:%S") %></td>
+      </tr>
       <tr>
         <th>Run at</th>
         <td><%= @job[:run_at].strftime("%Y-%m-%d %H:%M:%S") %></td>

data/app/views/que/view/queue_metrics/index.html.erb

@@ -0,0 +1,29 @@
+<div class="metrics">
+  <h1>Queue Metrics</h1>
+  <table cellspacing="0">
+    <thead>
+      <tr>
+        <th>Queue</th>
+        <th>Scheduled</th>
+        <th>Failing</th>
+        <th>Running</th>
+        <th>Finished</th>
+        <th>Expired</th>
+        <th>Latency (seconds)</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @queue_metrics.each do |queue, values| %>
+        <tr>
+          <td><%= queue %></td>
+          <td><%= link_to values[:scheduled], jobs_path(status: 'scheduled', queue_name: queue) %></td>
+          <td><%= link_to values[:failing], jobs_path(status: 'failing', queue_name: queue) %></td>
+          <td><%= link_to values[:running], jobs_path(status: 'running', queue_name: queue) %></td>
+          <td><%= link_to values[:finished], jobs_path(status: 'finished', queue_name: queue) %></td>
+          <td><%= link_to values[:expired], jobs_path(status: 'expired', queue_name: queue) %></td>
+          <td><%= @queue_latencies[queue] %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/que/view/welcome/index.html.erb

@@ -58,3 +58,29 @@
     <% end %>
   </div>
 </div>
+<div class="lockers">
+  <h1>Processes</h1>
+  <table cellspacing="0">
+    <thead>
+      <tr>
+        <th>ID</th>
+        <th>Worker count</th>
+        <th>Worker priorities</th>
+        <th>Listening</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% @lockers.each.with_index do |locker, index| %>
+        <tr>
+          <td class="locker-process">
+            <span>Process <%= index + 1 %></span>
+            <span><strong>Queues:</strong> <%= locker[:queues][1..-2].split(',').join(', ') %></span>
+          </td>
+          <td><%= locker[:worker_count] %></td>
+          <td><%= locker[:worker_priorities] %></td>
+          <td><%= locker[:listening] %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/config/routes.rb

@@ -5,6 +5,7 @@ Que::View::Engine.routes.draw do
     post :reschedule_all, on: :collection
     delete :destroy_all, on: :collection
   end
+  resources :queue_metrics, only: %i[index]
 
   root 'welcome#index'
 end

data/lib/que/view/dsl.rb

@@ -8,6 +8,21 @@ module Que
         execute(fetch_dashboard_stats_sql)
       end
 
+      def fetch_que_lockers
+        execute(fetch_que_lockers_sql)
+      end
+
+      def fetch_queue_metrics
+        execute(fetch_queue_metrics_sql).each_with_object({}) { |element, acc|
+          acc[element[:queue_name].to_sym] ||= basis_queue_stats
+          acc[element[:queue_name].to_sym][element[:status].to_sym] = element[:count_all]
+        }
+      end
+
+      def fetch_queue_latencies(queue_names)
+        queue_names.index_with { |queue_name| execute(fetch_queue_oldest_job_sql(queue_name)).dig(0, :enqueued_at) }
+      end
+
       def fetch_queue_names
         execute(fetch_queue_names_sql).map { |queues_data|
           ["#{queues_data[:queue_name]} (#{queues_data[:count_all]})", queues_data[:queue_name]]
@@ -20,7 +35,7 @@ module Que
         }
       end
 
-      def fetch_running_jobs(...)
+      def fetch_running_jobs
         Que.job_states
       end
 
@@ -70,6 +85,10 @@ module Que
 
       private
 
+      def basis_queue_stats
+        { scheduled: 0, failing: 0, running: 0, finished: 0, expired: 0 }
+      end
+
       # rubocop: disable Metrics/MethodLength
       def fetch_dashboard_stats_sql
         <<-SQL.squish
@@ -88,6 +107,52 @@ module Que
         SQL
       end
 
+      def fetch_que_lockers_sql
+        <<-SQL.squish
+          SELECT *
+          FROM que_lockers
+        SQL
+      end
+
+      def fetch_queue_metrics_sql
+        <<-SQL.squish
+          SELECT COUNT(*) AS count_all, queue AS queue_name,
+            CASE
+            WHEN expired_at IS NOT NULL THEN 'expired'
+            WHEN finished_at IS NOT NULL THEN 'finished'
+            WHEN locks.job_id IS NULL AND error_count > 0 THEN 'failing'
+            WHEN locks.job_id IS NULL AND error_count = 0 THEN 'scheduled'
+            ELSE 'running'
+            END status
+          FROM que_jobs
+          LEFT JOIN (
+            SELECT (classid::bigint << 32) + objid::bigint AS job_id
+            FROM pg_locks
+            WHERE locktype = 'advisory'
+          ) locks ON (que_jobs.id=locks.job_id)
+          GROUP BY queue,
+            CASE
+            WHEN expired_at IS NOT NULL THEN 'expired'
+            WHEN finished_at IS NOT NULL THEN 'finished'
+            WHEN locks.job_id IS NULL AND error_count > 0 THEN 'failing'
+            WHEN locks.job_id IS NULL AND error_count = 0 THEN 'scheduled'
+            ELSE 'running'
+            END
+        SQL
+      end
+
+      def fetch_queue_oldest_job_sql(queue_name)
+        <<-SQL.squish
+          SELECT args #>> '{0, enqueued_at}' AS enqueued_at
+          FROM que_jobs
+          WHERE queue = '#{queue_name}'
+            AND expired_at IS NULL
+            AND finished_at IS NULL
+          ORDER BY args #>> '{0, enqueued_at}'
+          LIMIT 1
+        SQL
+      end
+
       def fetch_queue_names_sql
         <<-SQL.squish
           SELECT COUNT(*) AS count_all, queue AS queue_name

data/lib/que/view/version.rb

@@ -2,6 +2,6 @@
 
 module Que
   module View
-    VERSION = '0.3.1'
+    VERSION = '0.3.3'
   end
 end

data/lib/que/view.rb

@@ -34,7 +34,7 @@ module Que
     end
 
     # Public: All the methods delegated to instance. These should match the interface of Que::View::DSL.
-    def_delegators :instance, :fetch_dashboard_stats,
+    def_delegators :instance, :fetch_dashboard_stats, :fetch_que_lockers, :fetch_queue_metrics, :fetch_queue_latencies,
                    :fetch_queue_names, :fetch_job_names,
                    :fetch_running_jobs, :fetch_failing_jobs, :fetch_scheduled_jobs, :fetch_finished_jobs,
                    :fetch_expired_jobs, :fetch_job,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que-view
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Bogdanov Anton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: que
@@ -164,11 +164,13 @@ files:
 - app/assets/stylesheets/que/view/application.css
 - app/controllers/que/view/application_controller.rb
 - app/controllers/que/view/jobs_controller.rb
+- app/controllers/que/view/queue_metrics_controller.rb
 - app/controllers/que/view/welcome_controller.rb
 - app/helpers/que/view/application_helper.rb
 - app/views/layouts/que/view/application.html.erb
 - app/views/que/view/jobs/index.html.erb
 - app/views/que/view/jobs/show.html.erb
+- app/views/que/view/queue_metrics/index.html.erb
 - app/views/que/view/welcome/index.html.erb
 - config/routes.rb
 - lib/que/view.rb