sidekiq 6.4.1 → 6.5.7

data/web/views/_summary.erb

@@ -9,7 +9,7 @@
   </li>
   <li class="busy col-sm-1">
     <a href="<%= root_path %>busy">
-      <span id="txtBusy" class="count"><%= number_with_delimiter(workers.size) %></span>
+      <span id="txtBusy" class="count"><%= number_with_delimiter(workset.size) %></span>
       <span class="desc"><%= t('Busy') %></span>
     </a>
   </li>

data/web/views/busy.erb

@@ -15,7 +15,7 @@
       <p><%= t('Threads') %></p>
     </div>
     <div class="stat">
-      <h3><%= ws = workers.size; number_with_delimiter(ws) %></h3>
+      <h3><%= ws = workset.size; number_with_delimiter(ws) %></h3>
       <p><%= t('Busy') %></p>
     </div>
     <div class="stat">
@@ -48,13 +48,13 @@
     <thead>
       <th><%= t('Name') %></th>
       <th><%= t('Started') %></th>
-      <th class="col-sm-1"><%= t('RSS') %><a href="https://github.com/mperham/sidekiq/wiki/Memory#rss"><span class="info-circle" title="Click to learn more about RSS">?</span></a></th>
+      <th class="col-sm-1"><%= t('RSS') %><a target="blank" href="https://github.com/mperham/sidekiq/wiki/Memory#rss"><span class="info-circle" title="Click to learn more about RSS">?</span></a></th>
       <th class="col-sm-1"><%= t('Threads') %></th>
       <th class="col-sm-1"><%= t('Busy') %></th>
       <th>&nbsp;</th>
     </thead>
     <% lead = processes.leader %>
-    <% processes.each do |process| %>
+    <% sorted_processes.each do |process| %>
       <tr>
         <td class="box">
           <%= "#{process['hostname']}:#{process['pid']}" %>
@@ -109,7 +109,7 @@
       <th><%= t('Arguments') %></th>
       <th><%= t('Started') %></th>
     </thead>
-    <% workers.each do |process, thread, msg| %>
+    <% workset.each do |process, thread, msg| %>
       <% job = Sidekiq::JobRecord.new(msg['payload']) %>
       <tr>
         <td><%= process %></td>

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 %>

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 6.4.1
+  version: 6.5.7
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-07 00:00:00.000000000 Z
+date: 2022-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.2
+        version: 2.2.5
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +81,8 @@ files:
 - lib/sidekiq/api.rb
 - lib/sidekiq/cli.rb
 - lib/sidekiq/client.rb
+- lib/sidekiq/component.rb
 - lib/sidekiq/delay.rb
-- lib/sidekiq/exception_handler.rb
 - lib/sidekiq/extensions/action_mailer.rb
 - lib/sidekiq/extensions/active_record.rb
 - lib/sidekiq/extensions/class_methods.rb
@@ -89,20 +95,27 @@ files:
 - lib/sidekiq/launcher.rb
 - lib/sidekiq/logger.rb
 - lib/sidekiq/manager.rb
+- lib/sidekiq/metrics/deploy.rb
+- lib/sidekiq/metrics/query.rb
+- lib/sidekiq/metrics/shared.rb
+- lib/sidekiq/metrics/tracking.rb
 - lib/sidekiq/middleware/chain.rb
 - lib/sidekiq/middleware/current_attributes.rb
 - lib/sidekiq/middleware/i18n.rb
+- lib/sidekiq/middleware/modules.rb
 - lib/sidekiq/monitor.rb
 - lib/sidekiq/paginator.rb
 - lib/sidekiq/processor.rb
 - lib/sidekiq/rails.rb
+- lib/sidekiq/redis_client_adapter.rb
 - lib/sidekiq/redis_connection.rb
+- lib/sidekiq/ring_buffer.rb
 - lib/sidekiq/scheduled.rb
 - lib/sidekiq/sd_notify.rb
 - lib/sidekiq/systemd.rb
 - lib/sidekiq/testing.rb
 - lib/sidekiq/testing/inline.rb
-- lib/sidekiq/util.rb
+- lib/sidekiq/transaction_aware_client.rb
 - lib/sidekiq/version.rb
 - lib/sidekiq/web.rb
 - lib/sidekiq/web/action.rb
@@ -117,7 +130,11 @@ files:
 - web/assets/images/logo.png
 - web/assets/images/status.png
 - web/assets/javascripts/application.js
+- web/assets/javascripts/chart.min.js
+- web/assets/javascripts/chartjs-plugin-annotation.min.js
 - web/assets/javascripts/dashboard.js
+- web/assets/javascripts/graph.js
+- web/assets/javascripts/metrics.js
 - web/assets/stylesheets/application-dark.css
 - web/assets/stylesheets/application-rtl.css
 - web/assets/stylesheets/application.css
@@ -162,6 +179,8 @@ files:
 - web/views/dashboard.erb
 - web/views/dead.erb
 - web/views/layout.erb
+- web/views/metrics.erb
+- web/views/metrics_for_job.erb
 - web/views/morgue.erb
 - web/views/queue.erb
 - web/views/queues.erb

data/lib/sidekiq/exception_handler.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "sidekiq"
-
-module Sidekiq
-  module ExceptionHandler
-    class Logger
-      def call(ex, ctx)
-        Sidekiq.logger.warn(Sidekiq.dump_json(ctx)) unless ctx.empty?
-        Sidekiq.logger.warn("#{ex.class.name}: #{ex.message}")
-        Sidekiq.logger.warn(ex.backtrace.join("\n")) unless ex.backtrace.nil?
-      end
-
-      Sidekiq.error_handlers << Sidekiq::ExceptionHandler::Logger.new
-    end
-
-    def handle_exception(ex, ctx = {})
-      Sidekiq.error_handlers.each do |handler|
-        handler.call(ex, ctx)
-      rescue => ex
-        Sidekiq.logger.error "!!! ERROR HANDLER THREW AN ERROR !!!"
-        Sidekiq.logger.error ex
-        Sidekiq.logger.error ex.backtrace.join("\n") unless ex.backtrace.nil?
-      end
-    end
-  end
-end

data/lib/sidekiq/util.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-require "forwardable"
-require "socket"
-require "securerandom"
-require "sidekiq/exception_handler"
-
-module Sidekiq
-  ##
-  # This module is part of Sidekiq core and not intended for extensions.
-  #
-
-  class RingBuffer
-    include Enumerable
-    extend Forwardable
-    def_delegators :@buf, :[], :each, :size
-
-    def initialize(size, default = 0)
-      @size = size
-      @buf = Array.new(size, default)
-      @index = 0
-    end
-
-    def <<(element)
-      @buf[@index % @size] = element
-      @index += 1
-      element
-    end
-
-    def buffer
-      @buf
-    end
-
-    def reset(default = 0)
-      @buf.fill(default)
-    end
-  end
-
-  module Util
-    include ExceptionHandler
-
-    # hack for quicker development / testing environment #2774
-    PAUSE_TIME = $stdout.tty? ? 0.1 : 0.5
-
-    # Wait for the orblock to be true or the deadline passed.
-    def wait_for(deadline, &condblock)
-      remaining = deadline - ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-      while remaining > PAUSE_TIME
-        return if condblock.call
-        sleep PAUSE_TIME
-        remaining = deadline - ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
-      end
-    end
-
-    def watchdog(last_words)
-      yield
-    rescue Exception => ex
-      handle_exception(ex, {context: last_words})
-      raise ex
-    end
-
-    def safe_thread(name, &block)
-      Thread.new do
-        Thread.current.name = name
-        watchdog(name, &block)
-      end
-    end
-
-    def logger
-      Sidekiq.logger
-    end
-
-    def redis(&block)
-      Sidekiq.redis(&block)
-    end
-
-    def tid
-      Thread.current["sidekiq_tid"] ||= (Thread.current.object_id ^ ::Process.pid).to_s(36)
-    end
-
-    def hostname
-      ENV["DYNO"] || Socket.gethostname
-    end
-
-    def process_nonce
-      @@process_nonce ||= SecureRandom.hex(6)
-    end
-
-    def identity
-      @@identity ||= "#{hostname}:#{::Process.pid}:#{process_nonce}"
-    end
-
-    def fire_event(event, options = {})
-      reverse = options[:reverse]
-      reraise = options[:reraise]
-
-      arr = Sidekiq.options[:lifecycle_events][event]
-      arr.reverse! if reverse
-      arr.each do |block|
-        block.call
-      rescue => ex
-        handle_exception(ex, {context: "Exception during Sidekiq lifecycle event.", event: event})
-        raise ex if reraise
-      end
-      arr.clear
-    end
-  end
-end