sidekiq 6.5.1 → 6.5.5

data/web/assets/javascripts/metrics.js

@@ -0,0 +1,262 @@
+if (window.matchMedia('(prefers-color-scheme: dark)').matches) {
+  Chart.defaults.borderColor = "#333"
+  Chart.defaults.color = "#aaa"
+}
+
+class BaseChart {
+  constructor(id, options) {
+    this.ctx = document.getElementById(id);
+    this.options = options
+    this.fallbackColor = "#999";
+    this.colors = [
+      // Colors taken from https://www.chartjs.org/docs/latest/samples/utils.html
+      "#537bc4",
+      "#4dc9f6",
+      "#f67019",
+      "#f53794",
+      "#acc236",
+      "#166a8f",
+      "#00a950",
+      "#58595b",
+      "#8549ba",
+      "#991b1b",
+    ];
+
+    this.chart = new Chart(this.ctx, {
+      type: this.options.chartType,
+      data: { labels: this.options.labels, datasets: this.datasets },
+      options: this.chartOptions,
+    });
+  }
+
+  addMarksToChart() {
+    this.options.marks.forEach(([bucket, label], i) => {
+      this.chart.options.plugins.annotation.annotations[`deploy-${i}`] = {
+        type: "line",
+        xMin: bucket,
+        xMax: bucket,
+        borderColor: "rgba(220, 38, 38, 0.4)",
+        borderWidth: 2,
+      };
+    });
+  }
+}
+
+class JobMetricsOverviewChart extends BaseChart {
+  constructor(id, options) {
+    super(id, { ...options, chartType: "line" });
+    this.swatches = [];
+
+    this.addMarksToChart();
+    this.chart.update();
+  }
+
+  registerSwatch(id) {
+    const el = document.getElementById(id);
+    el.onchange = () => this.toggle(el.value, el.checked);
+    this.swatches[el.value] = el;
+    this.updateSwatch(el.value);
+  }
+
+  updateSwatch(kls) {
+    const el = this.swatches[kls];
+    const ds = this.chart.data.datasets.find((ds) => ds.label == kls);
+    el.checked = !!ds;
+    el.style.color = ds ? ds.borderColor : null;
+  }
+
+  toggle(kls, visible) {
+    if (visible) {
+      this.chart.data.datasets.push(this.dataset(kls));
+    } else {
+      const i = this.chart.data.datasets.findIndex((ds) => ds.label == kls);
+      this.colors.unshift(this.chart.data.datasets[i].borderColor);
+      this.chart.data.datasets.splice(i, 1);
+    }
+
+    this.updateSwatch(kls);
+    this.chart.update();
+  }
+
+  dataset(kls) {
+    const color = this.colors.shift() || this.fallbackColor;
+
+    return {
+      label: kls,
+      data: this.options.series[kls],
+      borderColor: color,
+      backgroundColor: color,
+      borderWidth: 2,
+      pointRadius: 2,
+    };
+  }
+
+  get datasets() {
+    return Object.entries(this.options.series)
+      .filter(([kls, _]) => this.options.visible.includes(kls))
+      .map(([kls, _]) => this.dataset(kls));
+  }
+
+  get chartOptions() {
+    return {
+      aspectRatio: 4,
+      scales: {
+        y: {
+          beginAtZero: true,
+          title: {
+            text: "Total execution time (sec)",
+            display: true,
+          },
+        },
+      },
+      interaction: {
+        mode: "x",
+      },
+      plugins: {
+        legend: {
+          display: false,
+        },
+        tooltip: {
+          callbacks: {
+            title: (items) => `${items[0].label} UTC`,
+            label: (item) =>
+              `${item.dataset.label}: ${item.parsed.y.toFixed(1)} seconds`,
+            footer: (items) => {
+              const bucket = items[0].label;
+              const marks = this.options.marks.filter(([b, _]) => b == bucket);
+              return marks.map(([b, msg]) => `Deploy: ${msg}`);
+            },
+          },
+        },
+      },
+    };
+  }
+}
+
+class HistTotalsChart extends BaseChart {
+  constructor(id, options) {
+    super(id, { ...options, chartType: "bar" });
+  }
+
+  get datasets() {
+    return [{
+      data: this.options.series,
+      backgroundColor: this.colors[0],
+      borderWidth: 0,
+    }];
+  }
+
+  get chartOptions() {
+    return {
+      aspectRatio: 6,
+      scales: {
+        y: {
+          beginAtZero: true,
+          title: {
+            text: "Total jobs",
+            display: true,
+          },
+        },
+      },
+      interaction: {
+        mode: "x",
+      },
+      plugins: {
+        legend: {
+          display: false,
+        },
+        tooltip: {
+          callbacks: {
+            label: (item) => `${item.parsed.y} jobs`,
+          },
+        },
+      },
+    };
+  }
+}
+
+class HistBubbleChart extends BaseChart {
+  constructor(id, options) {
+    super(id, { ...options, chartType: "bubble" });
+
+    this.addMarksToChart();
+    this.chart.update();
+  }
+
+  get datasets() {
+    const data = [];
+    let maxCount = 0;
+
+    Object.entries(this.options.hist).forEach(([bucket, hist]) => {
+      hist.forEach((count, histBucket) => {
+        if (count > 0) {
+          data.push({
+            x: bucket,
+            // histogram data is ordered fastest to slowest, but this.histIntervals is
+            // slowest to fastest (so it displays correctly on the chart).
+            y:
+              this.options.histIntervals[this.options.histIntervals.length - 1 - histBucket] /
+              1000,
+            count: count,
+          });
+
+          if (count > maxCount) maxCount = count;
+        }
+      });
+    });
+
+    // Chart.js will not calculate the bubble size. We have to do that.
+    const maxRadius = this.ctx.offsetWidth / this.options.labels.length;
+    const minRadius = 1
+    const multiplier = (maxRadius / maxCount) * 1.5;
+    data.forEach((entry) => {
+      entry.r = entry.count * multiplier + minRadius;
+    });
+
+    return [{
+      data: data,
+      backgroundColor: "#537bc4",
+      borderColor: "#537bc4",
+    }];
+  }
+
+  get chartOptions() {
+    return {
+      aspectRatio: 3,
+      scales: {
+        x: {
+          type: "category",
+          labels: this.options.labels,
+        },
+        y: {
+          title: {
+            text: "Execution time (sec)",
+            display: true,
+          },
+        },
+      },
+      interaction: {
+        mode: "x",
+      },
+      plugins: {
+        legend: {
+          display: false,
+        },
+        tooltip: {
+          callbacks: {
+            title: (items) => `${items[0].raw.x} UTC`,
+            label: (item) =>
+              `${item.parsed.y} seconds: ${item.raw.count} job${
+                item.raw.count == 1 ? "" : "s"
+              }`,
+            footer: (items) => {
+              const bucket = items[0].raw.x;
+              const marks = this.options.marks.filter(([b, _]) => b == bucket);
+              return marks.map(([b, msg]) => `Deploy: ${msg}`);
+            },
+          },
+        },
+      },
+    };
+  }
+}

data/web/assets/stylesheets/application.css

@@ -67,10 +67,15 @@ body {
   padding: 0 20px;
 }
 
-h3 {
+h1, h2, h3 {
+  font-size: 24px;
   line-height: 45px;
 }
 
+.header-with-subheader h2 {
+  margin-top: -18px;
+}
+
 .centered {
   text-align: center;
 }
@@ -954,3 +959,41 @@ div.interval-slider input {
   padding: 3px 7px;
   margin-left: 5px;
 }
+
+.metrics-swatch-wrapper {
+  display: flex;
+  align-items: center;
+  gap: 6px;
+}
+
+.metrics-swatch[type=checkbox] {
+  display: inline-block;
+  width: 16px;
+  height: 16px;
+  margin: 0;
+  border-radius: 2px;
+  appearance: none;
+  -webkit-appearance: none;
+  -moz-appearance: none;
+  border: 1px solid #bbb;
+  color: white;
+  background-color: currentColor;
+}
+
+/* We need to add the checkmark since we've taken over the appearance */
+.metrics-swatch[type=checkbox]:checked {
+  border-color: currentColor;
+  background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e");
+  background-size: 100% 100%;
+  background-position: center;
+  background-repeat: no-repeat;
+}
+
+.metrics-swatch[type=checkbox]:focus {
+  outline: 1px solid #888;
+  outline-offset: 2px;
+}
+
+canvas {
+  margin: 20px 0 30px;
+}

data/web/locales/el.yml

@@ -6,11 +6,12 @@ el: # <---- change this to your locale code
   Namespace: Namespace
   Realtime: Τρέχουσα Κατάσταση
   History: Ιστορικό
-  Busy: Απασχολημένο
-  Processed: Επεξεργάστηκε
-  Failed: Απέτυχε
-  Scheduled: Προγραματίστηκε
-  Retries: Προσπάθειες
+  Busy: Υπό επεξεργασία
+  Utilization: Σε χρήση
+  Processed: Επεξεργάστηκαν
+  Failed: Απέτυχαν
+  Scheduled: Προγραμματισμένα
+  Retries: Επαναλήψεις
   Enqueued: Μπήκαν στην στοίβα
   Worker: Εργάτης
   LivePoll: Τρέχουσα Κατάσταση
@@ -20,40 +21,42 @@ el: # <---- change this to your locale code
   Job: Εργασία
   Arguments: Ορίσματα
   Extras: Extras
-  Started: Ξεκίνησαν
+  Started: Ξεκίνησε
   ShowAll: Εμφάνιση Όλων
   CurrentMessagesInQueue: Τρέχουσες εργασίες <span class='title'>%{queue}</span>
   Delete: Διαγραφή
   AddToQueue: Προσθήκη στην στοίβα
-  AreYouSureDeleteJob: Θέλετε να διαγράψετε την εργασία αυτη;
-  AreYouSureDeleteQueue: Θέλετε να διαγράψετε την %{queue} στοίβα?
+  AreYouSureDeleteJob: Θέλετε να διαγράψετε αυτή την εργασία;
+  AreYouSureDeleteQueue: Θέλετε να διαγράψετε την στοίβα %{queue}; Αυτό θα διαγράψει όλες τις εργασίες εντός της στοίβας, θα εμφανιστεί ξανά εάν προωθήσετε περισσότερες εργασίες σε αυτήν στο μέλλον.
   Queues: Στοίβες
   Size: Μέγεθος
   Actions: Ενέργειες
-  NextRetry: Επόμενη προσπάθεια
-  RetryCount: Αριθμός προσπαθειών
-  RetryNow: Προσπάθησε τώρα
-  LastRetry: Τελευταία προσπάθεια
+  NextRetry: Επόμενη Προσπάθεια
+  RetryCount: Αριθμός Προσπαθειών
+  RetryNow: Επανάληψη Τώρα
+  # Kill: Kill
+  LastRetry: Τελευταία Προσπάθεια
   OriginallyFailed: Αρχικές Αποτυχίες
-  AreYouSure: Είστε σίγουρος?
-  DeleteAll: Διαγραφή όλων
+  AreYouSure: Είστε σίγουρος;
+  DeleteAll: Διαγραφή Όλων
   RetryAll: Επανάληψη Όλων
-  NoRetriesFound: Δεν βρέθηκαν προσπάθειες
+  # KillAll: Kill All
+  NoRetriesFound: Δεν βρέθηκαν εργασίες προς επαναλήψη
   Error: Σφάλμα
   ErrorClass: Κλάση σφάλματος
   ErrorMessage: Μήνυμα Σφάλματος
-  ErrorBacktrace: Σφάλμα Backtrace
+  ErrorBacktrace: Backtrace Σφάλματος
   GoBack: ← Πίσω
   NoScheduledFound: Δεν βρέθηκαν προγραμματισμένες εργασίες
   When: Πότε
   ScheduledJobs: Προγραμματισμένες Εργασίες
-  idle: αδρανής
-  active: ενεργή
+  idle: αδρανές
+  active: ενεργό
   Version: Έκδοση
   Connections: Συνδέσεις
   MemoryUsage: Χρήση Μνήμης
   PeakMemoryUsage: Μέγιστη Χρήση Μνήμης
-  Uptime: Διάρκεια Λειτουργείας (ημέρες)
+  Uptime: Ημέρες Λειτουργίας
   OneWeek: 1 εβδομάδα
   OneMonth: 1 μήνας
   ThreeMonths: 3 μήνες
@@ -62,7 +65,28 @@ el: # <---- change this to your locale code
   DeadJobs: Αδρανείς Εργασίες
   NoDeadJobsFound: Δεν βρέθηκαν αδρανείς εργασίες
   Dead: Αδρανείς
+  Process: Διεργασία
   Processes: Διεργασίες
+  Name: Όνομα
   Thread: Νήμα
   Threads: Νήματα
   Jobs: Εργασίες
+  Paused: Σε παύση
+  Stop: Διακοπή
+  Quiet: Σίγαση
+  StopAll: Διακοπή Όλων
+  QuietAll: Σίγαση Όλων
+  PollingInterval: Συχνότητα Ανανέωσης
+  Plugins: Πρόσθετα
+  NotYetEnqueued: Δεν προστέθηκε στην στοίβα ακόμη
+  CreatedAt: Δημιουργήθηκε στις
+  BackToApp: Πίσω στην Εφαρμογή
+  Latency: Καθυστέρηση
+  Pause: Παύση
+  Unpause: Κατάργηση Παύσης
+  Metrics: Μετρήσεις
+  NoDataFound: Δεν βρέθηκαν δεδομένα
+  ExecutionTime: Συνολικός Χρόνος Εκτέλεσης
+  AvgExecutionTime: Μέσος Χρόνος Εκτέλεσης
+  # Context: Context
+

data/web/locales/en.yml

@@ -84,3 +84,10 @@ en: # <---- change this to your locale code
   Latency: Latency
   Pause: Pause
   Unpause: Unpause
+  Metrics: Metrics
+  NoDataFound: No data found
+  ExecutionTime: Total Execution Time
+  AvgExecutionTime: Average Execution Time
+  Context: Context
+  Bucket: Bucket
+  NoJobMetricsFound: No recent job metrics were found

data/web/views/_nav.erb

@@ -1,7 +1,7 @@
 <div class="navbar navbar-default navbar-fixed-top">
   <div class="container-fluid">
     <div class="navbar-header" data-navbar="static">
-      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-menu">
+      <button type="button" class="navbar-toggle collapsed" data-toggle="navbar-menu" data-target="#navbar-menu">
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>

data/web/views/busy.erb

@@ -54,7 +54,7 @@
       <th>&nbsp;</th>
     </thead>
     <% lead = processes.leader %>
-    <% processes.each do |process| %>
+    <% sorted_processes.each do |process| %>
       <tr>
         <td class="box">
           <%= "#{process['hostname']}:#{process['pid']}" %>

data/web/views/dashboard.erb

@@ -1,3 +1,4 @@
+<script type="text/javascript" src="<%= root_path %>javascripts/graph.js"></script>
 <script type="text/javascript" src="<%= root_path %>javascripts/dashboard.js"></script>
 <div class= "dashboard clearfix">
   <h3 >

data/web/views/metrics.erb

@@ -0,0 +1,69 @@
+<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/metrics.js"></script>
+
+<h2>Total execution time</h2>
+
+<%
+  table_limit = 20
+  chart_limit = 5
+  job_results = @query_result.job_results.sort_by { |(kls, jr)| jr.totals["s"] }.reverse.first(table_limit)
+  visible_kls = job_results.first(chart_limit).map(&:first)
+%>
+
+<canvas id="job-metrics-overview-chart"></canvas>
+
+<script>
+  window.jobMetricsChart = new JobMetricsOverviewChart(
+    "job-metrics-overview-chart",
+    <%= Sidekiq.dump_json({
+      series: job_results.map { |(kls, jr)| [kls, jr.dig("series", "s")] }.to_h,
+      marks: @query_result.marks.map { |m| [m.bucket, m.label] },
+      visible: visible_kls,
+      labels: @query_result.buckets,
+    }) %>
+  )
+</script>
+
+<h2>Most Time-Consuming Jobs</h2>
+
+<div class="table_container">
+  <table class="table table-bordered table-striped table-hover">
+    <tbody>
+      <tr>
+        <th><%= t('Name') %></th>
+        <th><%= t('Processed') %></th>
+        <th><%= t('Failed') %></th>
+        <th><%= t('ExecutionTime') %></th>
+        <th><%= t('AvgExecutionTime') %></th>
+      </tr>
+      <% if job_results.any? %>
+        <% job_results.each_with_index do |(kls, jr), i| %>
+          <tr>
+            <td>
+              <div class="metrics-swatch-wrapper">
+                <% id = "metrics-swatch-#{kls}" %>
+                <input
+                  type="checkbox"
+                  id="<%= id %>"
+                  class="metrics-swatch"
+                  value="<%= kls %>"
+                />
+                <code><a href="<%= root_path %>metrics/<%= kls %>"><%= kls %></a></code>
+              </div>
+              <script>jobMetricsChart.registerSwatch("<%= id %>")</script>
+            </td>
+            <td><%= jr.dig("totals", "p") %></td>
+            <td><%= jr.dig("totals", "f") %></td>
+            <td><%= jr.dig("totals", "s").round(2) %> seconds</td>
+            <td><%= jr.total_avg("s").round(2) %> seconds</td>
+          </tr>
+        <% end %>
+      <% else %>
+          <tr><td colspan=5><%= t("NoDataFound") %></td></tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>
+
+<p><small>Data from <%= @query_result.starts_at %> to <%= @query_result.ends_at %></small></p>

data/web/views/metrics_for_job.erb

@@ -0,0 +1,87 @@
+<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/metrics.js"></script>
+
+<%
+  job_result = @query_result.job_results[@name]
+  hist_totals = job_result.hist.values.first.zip(*job_result.hist.values[1..-1]).map(&:sum)
+  bucket_labels =Sidekiq::Metrics::Histogram::LABELS
+  bucket_intervals =Sidekiq::Metrics::Histogram::BUCKET_INTERVALS.reverse
+
+  # Replace INFINITY since it can't be represented as JSON
+  bucket_intervals[0] = bucket_intervals[1] * 2
+%>
+
+<% if job_result.totals["s"] > 0 %>
+  <div class="header-with-subheader">
+    <h1>
+      <a href="<%= root_path %>/metrics"><%= t(:metrics).to_s.titleize %></a> /
+      <%= h @name %>
+    </h1>
+    <h2>Histogram summary</h2>
+  </div>
+
+  <canvas id="hist-totals-chart"></canvas>
+
+  <script>
+    window.histTotalsChart = new HistTotalsChart(
+      "hist-totals-chart",
+      <%= Sidekiq.dump_json({
+        series: hist_totals,
+        labels: bucket_labels,
+      }) %>
+    )
+  </script>
+
+  <h2>Performance over time</h2>
+
+  <canvas id="hist-bubble-chart"></canvas>
+
+  <script>
+    window.histBubbleChart = new HistBubbleChart(
+      "hist-bubble-chart",
+      <%= Sidekiq.dump_json({
+        hist: job_result.hist,
+        marks: @query_result.marks.map { |m| [m.bucket, m.label] },
+        labels: @query_result.buckets,
+        histIntervals: bucket_intervals,
+      }) %>
+    )
+  </script>
+
+  <div class="table_container">
+    <table class="table table-bordered table-striped table-hover">
+      <tbody>
+        <tr>
+          <th><%= t('Time') %></th>
+          <th><%= t('Processed') %></th>
+          <th><%= t('Failed') %></th>
+          <th><%= t('ExecutionTime') %></th>
+          <th><%= t('AvgExecutionTime') %></th>
+        </tr>
+        <% @query_result.buckets.reverse.each do |bucket| %>
+          <tr>
+            <td><%= bucket %></td>
+            <td><%= job_result.series.dig("p", bucket) %></td>
+            <td><%= job_result.series.dig("f", bucket) %></td>
+            <% if (total_sec = job_result.series.dig("s", bucket)) > 0 %>
+              <td><%= total_sec.round(2) %> seconds</td>
+              <td><%= job_result.series_avg("s")[bucket].round(2) %> seconds</td>
+            <% else %>
+              <td>&mdash;</td>
+              <td>&mdash;</td>
+            <% end %>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+  <p><small>Data from <%= @query_result.starts_at %> to <%= @query_result.ends_at %></small></p>
+<% else %>
+  <h1>
+    <a href="<%= root_path %>/metrics"><%= t(:metrics).to_s.titleize %></a> /
+    <%= h @name %>
+  </h1>
+
+  <div class="alert alert-success"><%= t('NoJobMetricsFound') %></div>
+<% end %>

data/web/views/queue.erb

@@ -18,6 +18,7 @@
       <th><a href="<%= url %>?direction=<%= params[:direction] == 'asc' ? 'desc' : 'asc' %>"># <%= sort_direction_label %></a></th>
       <th><%= t('Job') %></th>
       <th><%= t('Arguments') %></th>
+      <th><%= t('Context') %></th>
       <th></th>
     </thead>
     <% @jobs.each_with_index do |job, index| %>
@@ -35,12 +36,15 @@
           <% a = job.display_args %>
           <% if a.inspect.size > 100 %>
             <span id="job_<%= index %>"><%= h(a.inspect[0..100]) + "... " %></span>
-            <button data-toggle="job_<%= index %>" class="btn btn-default btn-xs"><%= t('ShowAll') %></button>
+            <button data-toggle="job_<%= index %>_full" class="btn btn-default btn-xs"><%= t('ShowAll') %></button>
             <div class="toggle" id="job_<%= index %>_full"><%= display_args(a) %></div>
           <% else %>
             <%= display_args(job.display_args) %>
           <% end %>
         </td>
+        <td>
+          <%= h(job["cattr"].inspect) if job["cattr"]&.any? %>
+        </td>
         <td>
           <form action="<%= root_path %>queues/<%= CGI.escape(@name) %>/delete" method="post">
             <%= csrf_tag %>