roundhouse_ui 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30b9ee99930148d47a69b86e7a4c079231f8a2504a9a24aaa17a625e39e96429
-  data.tar.gz: 333e7892afa4690288d35c671249f3fad6c3a19e304f9b4952346fe0f873a9fd
+  metadata.gz: 73ff2f1bc8db03a06168ee39d18b1de518e1a373860e1e0faafdbd08370d5eab
+  data.tar.gz: e1bb6668de35f02e64c369d016a21af989984f604a6009efba39160bd05b5b6a
 SHA512:
-  metadata.gz: 9391d5af40b1fa0db7de47fab56009cf6d11bb80f2c16d4d65bc4b7b2b376eb7ac7cff595dfe0ebdaa0df401436f811cfc1f9a3d52028aef491c7d5821b0e322
-  data.tar.gz: 8099ad548223bbb7d91f13a51b86e62010eb269f446d380c95fa4a416a1f4f95979631e9cbdd5115973bfa98d363ab04f5ef9d1801462a51ce215a5a28f57abe
+  metadata.gz: a27aa6ed4d0a91982e1997a6dcb6492a734edbfcbe3c4cf1c914366b4019b8ba49e922c7bfe59a45da662493d12b196c1f5bcd5ac47f9486248458877f42bb7f
+  data.tar.gz: faa3b64f3da583b3e361b431b8e6fa7b89b4c077a07cc981d54dfd2b20f248144c2798a1497aae4220de86fe385aca7f335b15d6b63c9d9648b22aa05f4acde5

data/README.md

@@ -83,6 +83,11 @@ RoundhouseUi.configure do |c|
   # Fold sidekiq-failures' `failed` set into the Errors view (see below).
   # No-op unless the sidekiq-failures gem is loaded. Default: off.
   c.show_sidekiq_failures = true
+
+  # Set false to hide queue pause/resume controls and the "not enforced" warning,
+  # e.g. when you run reliable fetch (super_fetch) instead of RoundhouseUi::Fetch.
+  # Default: true.
+  # c.pause_enabled = false
 end
 ```
 
@@ -110,7 +115,8 @@ Roundhouse detects whether a fetcher has reported in).
 > ⚠️ **Sidekiq Pro/Enterprise users:** super_fetch / reliable fetch sets its own
 > `fetch_class`, and Sidekiq allows only one. Installing `RoundhouseUi::Fetch` would
 > **replace reliable fetch and lose its crash-recovery guarantees** — don't. On those
-> tiers, leave the fetch strategy out; pause/resume stays inert and the UI says so.
+> tiers, leave the fetch strategy out and set `RoundhouseUi.pause_enabled = false` to
+> hide the pause controls and the (otherwise permanent) "not enforced" warning.
 
 ## Surfacing sidekiq-failures
 

data/app/controllers/roundhouse_ui/busy_controller.rb

@@ -9,9 +9,7 @@ module RoundhouseUi
 
     def index
       @threshold = LONG_RUNNING
-      @work = Sidekiq::WorkSet.new.map do |process_id, tid, work|
-        { process: process_id, tid: tid, queue: work.queue, run_at: work.run_at, job: work.job }
-      end
+      @work = Sidekiq::WorkSet.new.map { |process_id, tid, work| normalize(process_id, tid, work) }
     end
 
     def cancel
@@ -21,6 +19,18 @@ module RoundhouseUi
 
     private
 
+    # Sidekiq 7+ yields a Sidekiq::Work (queue/run_at/job methods); Sidekiq 6.x
+    # yields a plain Hash (string keys, an epoch run_at, a JSON payload). Normalize
+    # both to the same shape the view expects (run_at as a Time, job as a JobRecord).
+    def normalize(process_id, tid, work)
+      if work.respond_to?(:queue)
+        { process: process_id, tid: tid, queue: work.queue, run_at: work.run_at, job: work.job }
+      else
+        { process: process_id, tid: tid, queue: work["queue"],
+          run_at: Time.at(work["run_at"]), job: Sidekiq::JobRecord.new(work["payload"]) }
+      end
+    end
+
     def require_writable!
       return unless RoundhouseUi.read_only
       redirect_to busy_path, alert: "Roundhouse is in read-only mode — cancellation is disabled."

data/app/controllers/roundhouse_ui/capsules_controller.rb

@@ -13,6 +13,10 @@ module RoundhouseUi
       capsules = Hash.new { |h, k| h[k] = { name: k, concurrency: 0, processes: 0, queues: {} } }
 
       Sidekiq::ProcessSet.new.each do |process|
+        # `capsules` is a Sidekiq 8.0.8+ Process attribute; absent on 6.x/early 7,
+        # where calling it would raise NoMethodError. Skip → view shows empty state.
+        next unless process.respond_to?(:capsules)
+
         (process.capsules || {}).each do |name, data|
           cap = capsules[name]
           cap[:concurrency] += data["concurrency"].to_i

data/app/helpers/roundhouse_ui/observability_helper.rb

@@ -9,5 +9,17 @@ module RoundhouseUi
 
       link_to "↗ #{adapter.label}", url, target: "_blank", rel: "noopener", class: "rh-trace"
     end
+
+    # Deep-link for a grouped error row (no single JID) — a class-wide search.
+    # respond_to? keeps older/custom adapters that lack error_url working.
+    def error_trace_link(klass:, error: nil)
+      adapter = RoundhouseUi.observability
+      return unless adapter.respond_to?(:error_url)
+
+      url = adapter.error_url(klass: klass, error: error)
+      return unless url
+
+      link_to "↗ #{adapter.label}", url, target: "_blank", rel: "noopener", class: "rh-trace"
+    end
   end
 end

data/app/views/layouts/roundhouse_ui/application.html.erb

@@ -157,7 +157,9 @@
   <script nonce="<%= content_nonce %>">
     (function () {
       var fmt = function (n) { return Number(n).toLocaleString(); };
-      var started = false, lastProcessed = null, lastFailed = null, lastBacklog = null, lastT = null, series = [];
+      var started = false, lastProcessed = null, lastFailed = null, lastBacklog = null, lastT = null;
+      var POLL_MS = <%= (RoundhouseUi.poll_interval.to_f * 1000).round %>;
+      var samples = [], buckets = [], bucketStart = null; // samples = current bucket; buckets = finalized per-interval averages
       function setText(id, t) { var el = document.getElementById(id); if (el) el.textContent = t; }
       function humanizeEta(s) {
         if (s < 60) return "~" + Math.round(s) + "s";
@@ -166,15 +168,23 @@
         return "~" + (s / 86400).toFixed(1) + "d";
       }
 
+      // Bucket interval in seconds, from the picker — a new chart point lands
+      // once per interval, so "per 1m" advances every minute (not every poll).
+      function chartInterval() { var s = document.getElementById("rh-chart-interval"); return s ? parseInt(s.value, 10) : 30; }
+      function avg(a) { return a.length ? a.reduce(function (s, v) { return s + v; }, 0) / a.length : 0; }
       function draw() {
         var cv = document.getElementById("rh-chart"); if (!cv) return;
-        var ctx = cv.getContext("2d"), w = cv.width, h = cv.height, pad = 6, n = series.length;
-        ctx.clearRect(0, 0, w, h); if (n < 2) return;
-        var max = Math.max.apply(null, series) * 1.25 || 1;
+        var ctx = cv.getContext("2d"), w = cv.width, h = cv.height, pad = 6;
+        ctx.clearRect(0, 0, w, h);
+        // finalized buckets + the in-progress bucket as a provisional last point,
+        // so the chart shows data immediately instead of waiting a full interval.
+        var pts = buckets.slice(-60); if (samples.length) pts = pts.concat([ avg(samples) ]);
+        var n = pts.length; if (n < 2) return;
+        var max = Math.max.apply(null, pts) * 1.25 || 1;
         var x = function (i) { return i / (n - 1) * w; }, y = function (v) { return h - pad - v / max * (h - pad * 2); };
         var g = ctx.createLinearGradient(0, 0, 0, h); g.addColorStop(0, "rgba(110,139,255,.30)"); g.addColorStop(1, "rgba(110,139,255,0)");
-        ctx.beginPath(); ctx.moveTo(0, h); series.forEach(function (v, i) { ctx.lineTo(x(i), y(v)); }); ctx.lineTo(w, h); ctx.closePath(); ctx.fillStyle = g; ctx.fill();
-        ctx.beginPath(); series.forEach(function (v, i) { i ? ctx.lineTo(x(i), y(v)) : ctx.moveTo(x(i), y(v)); }); ctx.strokeStyle = "#6E8BFF"; ctx.lineWidth = 2; ctx.lineJoin = "round"; ctx.stroke();
+        ctx.beginPath(); ctx.moveTo(0, h); pts.forEach(function (v, i) { ctx.lineTo(x(i), y(v)); }); ctx.lineTo(w, h); ctx.closePath(); ctx.fillStyle = g; ctx.fill();
+        ctx.beginPath(); pts.forEach(function (v, i) { i ? ctx.lineTo(x(i), y(v)) : ctx.moveTo(x(i), y(v)); }); ctx.strokeStyle = "#6E8BFF"; ctx.lineWidth = 2; ctx.lineJoin = "round"; ctx.stroke();
       }
       function apply(d) {
         Object.keys(d).forEach(function (k) {
@@ -196,7 +206,15 @@
               var rate = dt > 0 ? Math.max(0, dp / dt) : 0;
               var re = document.querySelector('[data-stat="rate"]'); if (re) re.textContent = fmt(Math.round(rate * 60));
               var ne = document.getElementById("rh-chart-now"); if (ne) ne.textContent = Math.round(rate);
-              series.push(rate); if (series.length > 60) series.shift(); draw();
+              // Accumulate into the current bucket; finalize it (one averaged point)
+              // once the chosen interval has elapsed. Live "/s" still updates each poll.
+              samples.push(rate);
+              if (bucketStart == null) bucketStart = now;
+              if ((now - bucketStart) / 1000 >= chartInterval()) {
+                buckets.push(avg(samples)); if (buckets.length > 240) buckets.shift();
+                samples = []; bucketStart = now;
+              }
+              draw();
 
               // Metrics tab live rates (these elements exist only on that page).
               setText("rh-m-throughput", Math.round(rate) + "/s");
@@ -212,7 +230,7 @@
           })
           .catch(function () {});
       }
-      function startOnce() { if (started) return; started = true; poll(); setInterval(poll, 2500); }
+      function startOnce() { if (started) return; started = true; poll(); setInterval(poll, POLL_MS); }
       function syncTheme() { var b = document.getElementById("rh-theme"); if (b) b.textContent = document.documentElement.getAttribute("data-theme") === "light" ? "☀" : "☾"; }
       function syncWidth() { var b = document.getElementById("rh-width"); if (b) b.classList.toggle("is-on", document.documentElement.getAttribute("data-width") === "full"); }
 
@@ -255,7 +273,7 @@
         { label: "Retries", path: "<%= retries_path %>", icon: "↻" },
         { label: "Errors", path: "<%= errors_path %>", icon: "⚠" },
         { label: "Dead", path: "<%= dead_set_path %>", icon: "✕" },
-        { label: "Capsules", path: "<%= capsules_path %>", icon: "⊞" },
+        <% if defined?(Sidekiq::Capsule) %>{ label: "Capsules", path: "<%= capsules_path %>", icon: "⊞" },<% end %>
         { label: "Redis", path: "<%= redis_info_path %>", icon: "◈" },
         { label: "Snapshots", path: "<%= snapshots_path %>", icon: "⛁" },
         { label: "Audit log", path: "<%= audit_log_path %>", icon: "☷" },
@@ -303,6 +321,18 @@
         if (e.target && e.target.id === "rh-palette") { palClose(); return; }
         if (e.target.closest && e.target.closest("#rh-palette-open")) { e.preventDefault(); palOpen(); }
       });
+      // Throughput interval picker — persist the choice; changing it re-buckets
+      // from here on, so reset the in-progress bucket and redraw.
+      function restoreChartInterval() {
+        var s = document.getElementById("rh-chart-interval"); if (!s) return;
+        try { var v = localStorage.getItem("rh-chart-iv"); if (v) s.value = v; } catch (_) {}
+      }
+      document.addEventListener("change", function (e) {
+        if (!e.target || e.target.id !== "rh-chart-interval") return;
+        try { localStorage.setItem("rh-chart-iv", e.target.value); } catch (_) {}
+        samples = []; bucketStart = null; draw();
+      });
+
       document.addEventListener("keydown", function (e) {
         if ((e.metaKey || e.ctrlKey) && (e.key === "k" || e.key === "K")) { e.preventDefault(); var p = palEl(); (p && p.hidden) ? palOpen() : palClose(); return; }
         var p = palEl(); if (!p || p.hidden) return;
@@ -312,8 +342,8 @@
         else if (e.key === "Enter") { e.preventDefault(); if (palFiltered[palSel]) palRun(palFiltered[palSel]); }
       });
 
-      document.addEventListener("turbo:load", function () { startOnce(); syncTheme(); syncWidth(); setActiveNav(); draw(); });
-      document.addEventListener("DOMContentLoaded", function () { startOnce(); syncTheme(); syncWidth(); setActiveNav(); });
+      document.addEventListener("turbo:load", function () { startOnce(); syncTheme(); syncWidth(); setActiveNav(); restoreChartInterval(); draw(); });
+      document.addEventListener("DOMContentLoaded", function () { startOnce(); syncTheme(); syncWidth(); setActiveNav(); restoreChartInterval(); });
       document.addEventListener("visibilitychange", function () { if (!document.hidden) poll(); });
     })();
   </script>
@@ -343,7 +373,10 @@
       </nav>
       <nav class="rh-grp">
         <div class="rh-grp-label">Infrastructure</div>
-        <%= nav_link "Capsules", capsules_path, icon: "⊞" %>
+        <%# Capsules are a Sidekiq 7+ concept — hide the nav entirely on 6.x. %>
+        <% if defined?(Sidekiq::Capsule) %>
+          <%= nav_link "Capsules", capsules_path, icon: "⊞" %>
+        <% end %>
         <%= nav_link "Redis", redis_info_path, icon: "◈" %>
         <%= nav_link "Snapshots", snapshots_path, icon: "⛁" %>
         <%= nav_link "Audit log", audit_log_path, icon: "☷" %>

data/app/views/roundhouse_ui/dashboard/show.html.erb

@@ -27,7 +27,7 @@
   <div class="rh-card">
     <div class="k">Processed</div>
     <div class="v num" data-stat="processed"><%= number_with_delimiter @stats.processed %></div>
-    <div class="d up">▲ <span class="num" data-stat="rate">—</span> / min</div>
+    <div class="d"><span class="num" data-stat="rate">—</span> / min</div>
   </div>
   <div class="rh-card">
     <div class="k">Failed · total</div>
@@ -42,7 +42,7 @@
 </div>
 
 <div class="rh-chart-wrap">
-  <div class="top"><h3>Throughput</h3><span class="rh-sub">jobs / sec · live</span><span class="now"><span id="rh-chart-now">—</span>/s</span></div>
+  <div class="top"><h3>Throughput</h3><span class="rh-sub">jobs / sec · live</span><span class="now"><span id="rh-chart-now">—</span>/s</span><select id="rh-chart-interval" aria-label="Throughput interval" style="margin-left:12px;background:var(--panel-2);color:var(--muted);border:1px solid var(--line);border-radius:7px;padding:3px 6px;font:12px var(--sans)"><option value="10">per 10s</option><option value="30" selected>per 30s</option><option value="60">per 1m</option><option value="300">per 5m</option></select></div>
   <canvas id="rh-chart" width="1100" height="180"></canvas>
 </div>
 

data/app/views/roundhouse_ui/errors/index.html.erb

@@ -13,7 +13,7 @@
     <% else %>
       <% @groups.each do |g| %>
         <tr>
-          <td><%= g[:klass] %><br><span class="rh-err"><%= g[:error] %></span></td>
+          <td><%= g[:klass] %> <%= error_trace_link(klass: g[:klass], error: g[:error]) %><br><span class="rh-err"><%= g[:error] %></span></td>
           <td class="r"><%= number_with_delimiter g[:count] %></td>
           <td><span class="rh-sub"><%= g[:sources].join(", ") %></span></td>
           <td><span class="rh-sub"><%= g[:queues].join(", ") %></span></td>

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

@@ -4,7 +4,7 @@
   <div class="rh-toolbar"><%= link_to "+ Enqueue job", new_job_path, class: "rh-btn rh-btn-primary" %></div>
 <% end %>
 
-<% unless @fetch_installed %>
+<% if RoundhouseUi.pause_enabled && !@fetch_installed %>
   <div class="rh-warn">
     Pausing is <strong>recorded but not enforced</strong> — no Roundhouse fetcher has reported in.
     Add it to your Sidekiq config: <code>config[:fetch_class] = RoundhouseUi::Fetch</code>
@@ -26,10 +26,12 @@
           <td class="r"><%= number_with_delimiter q.size %></td>
           <td class="r <%= "rh-lat-warn" if q.latency > 60 %>"><%= q.latency.round(2) %>s</td>
           <td class="r">
-            <% if paused %>
-              <%= button_to "Resume", resume_queue_path(q.name), method: :post, class: "rh-btn", form_class: "rh-inline" %>
-            <% else %>
-              <%= button_to "Pause", pause_queue_path(q.name), method: :post, class: "rh-btn", form_class: "rh-inline" %>
+            <% if RoundhouseUi.pause_enabled %>
+              <% if paused %>
+                <%= button_to "Resume", resume_queue_path(q.name), method: :post, class: "rh-btn", form_class: "rh-inline" %>
+              <% else %>
+                <%= button_to "Pause", pause_queue_path(q.name), method: :post, class: "rh-btn", form_class: "rh-inline" %>
+              <% end %>
             <% end %>
             <%= button_to "Snapshot", snapshot_queue_path(q.name), method: :post, class: "rh-btn", form_class: "rh-inline" %>
             <%= button_to "Purge", purge_queue_path(q.name),

data/app/views/roundhouse_ui/workers/index.html.erb

@@ -1,15 +1,17 @@
 <% content_for :title, "Workers" %>
 
 <h2 class="rh-h2">Workers · <%= @processes.size %> <%= "process".pluralize(@processes.size) %></h2>
-<p class="rh-sub" style="margin:-4px 0 16px">
-  Fetch strategy:
-  <% if @fetch_active %>
-    <span class="rh-st rh-st-ok">RoundhouseUi::Fetch — pause-aware</span>
-  <% else %>
-    <span class="rh-st rh-st-paused">default — pause not enforced</span>
-  <% end %>
-  <span class="rh-sub" style="margin-left:6px">crash-reliable fetch (super_fetch) is Sidekiq Pro</span>
-</p>
+<% if RoundhouseUi.pause_enabled %>
+  <p class="rh-sub" style="margin:-4px 0 16px">
+    Fetch strategy:
+    <% if @fetch_active %>
+      <span class="rh-st rh-st-ok">RoundhouseUi::Fetch — pause-aware</span>
+    <% else %>
+      <span class="rh-st rh-st-paused">default — pause not enforced</span>
+    <% end %>
+    <span class="rh-sub" style="margin-left:6px">crash-reliable fetch (super_fetch) is Sidekiq Pro</span>
+  </p>
+<% end %>
 <table class="rh-table">
   <thead><tr><th>Process</th><th class="r">Threads</th><th>Queues</th><th class="r">Started</th><th class="r">Heartbeat</th><th class="r">Actions</th></tr></thead>
   <tbody>

data/lib/roundhouse_ui/observability.rb

@@ -14,6 +14,7 @@ module RoundhouseUi
       def label = "trace"
       def job_url(**) = nil
       def queue_url(_name) = nil
+      def error_url(**) = nil
     end
 
     class DatadogAdapter
@@ -36,6 +37,16 @@ module RoundhouseUi
         traces_url([ "@sidekiq.queue:#{name}" ])
       end
 
+      # Grouped Errors rows have no single JID, so link to a class-wide search.
+      # The exact facet depends on your Datadog tagging; tune via `extra_query`
+      # if `resource_name` isn't how your Sidekiq spans are tagged.
+      def error_url(klass:, error: nil)
+        terms = [ "resource_name:#{klass}" ]
+        terms << "service:#{@service}" if @service
+        terms << @extra_query if @extra_query
+        traces_url(terms)
+      end
+
       private
 
       def traces_url(terms)

data/lib/roundhouse_ui/version.rb

@@ -1,3 +1,3 @@
 module RoundhouseUi
-  VERSION = "0.4.0"
+  VERSION = "0.6.0"
 end

data/lib/roundhouse_ui.rb

@@ -57,6 +57,18 @@ module RoundhouseUi
     # Sidekiq's retry/dead sets, so this is the only way to surface them here.
     attr_accessor :show_sidekiq_failures
 
+    # Seconds between dashboard stat polls. Lower = livelier, but each poll also
+    # re-runs the host's auth/routing on the mount, so a busy console can add DB
+    # load. Default 5s; raise it if polling shows up in your traces.
+    attr_accessor :poll_interval
+
+    # Queue pause/resume is only enforced when RoundhouseUi::Fetch is installed
+    # as the server's fetch strategy. If you run reliable fetch (Sidekiq
+    # Pro/Enterprise super_fetch) you can't also run our fetcher, so pause can't
+    # be enforced — set this to false to hide the pause controls and the
+    # "not enforced" warning entirely. Default: true.
+    attr_accessor :pause_enabled
+
     # Configure in an initializer:
     #
     #   RoundhouseUi.configure do |c|
@@ -77,4 +89,6 @@ module RoundhouseUi
   self.allow_job_editing = false
   self.redact_args = []
   self.show_sidekiq_failures = false
+  self.pause_enabled = true
+  self.poll_interval = 5
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roundhouse_ui
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - R.J. Robinson