sidekiq 7.1.2 → 7.2.0

data/lib/sidekiq/web/application.rb

@@ -15,7 +15,7 @@ module Sidekiq
       "manifest-src 'self'",
       "media-src 'self'",
       "object-src 'none'",
-      "script-src 'self' https: http: 'unsafe-inline'",
+      "script-src 'self' https: http:",
       "style-src 'self' https: http: 'unsafe-inline'",
       "worker-src 'self'",
       "base-uri 'self'"
@@ -328,9 +328,75 @@ module Sidekiq
       json Sidekiq::Stats.new.queues
     end
 
+    ########
+    # Filtering
+
+    get "/filter/metrics" do
+      redirect "#{root_path}metrics"
+    end
+
+    post "/filter/metrics" do
+      x = params[:substr]
+      q = Sidekiq::Metrics::Query.new
+      @period = h((params[:period] || "")[0..1])
+      @periods = METRICS_PERIODS
+      minutes = @periods.fetch(@period, @periods.values.first)
+      @query_result = q.top_jobs(minutes: minutes, class_filter: Regexp.new(Regexp.escape(x), Regexp::IGNORECASE))
+
+      erb :metrics
+    end
+
+    get "/filter/retries" do
+      x = params[:substr]
+      return redirect "#{root_path}retries" unless x && x != ""
+
+      @retries = search(Sidekiq::RetrySet.new, params[:substr])
+      erb :retries
+    end
+
+    post "/filter/retries" do
+      x = params[:substr]
+      return redirect "#{root_path}retries" unless x && x != ""
+
+      @retries = search(Sidekiq::RetrySet.new, params[:substr])
+      erb :retries
+    end
+
+    get "/filter/scheduled" do
+      x = params[:substr]
+      return redirect "#{root_path}scheduled" unless x && x != ""
+
+      @scheduled = search(Sidekiq::ScheduledSet.new, params[:substr])
+      erb :scheduled
+    end
+
+    post "/filter/scheduled" do
+      x = params[:substr]
+      return redirect "#{root_path}scheduled" unless x && x != ""
+
+      @scheduled = search(Sidekiq::ScheduledSet.new, params[:substr])
+      erb :scheduled
+    end
+
+    get "/filter/dead" do
+      x = params[:substr]
+      return redirect "#{root_path}morgue" unless x && x != ""
+
+      @dead = search(Sidekiq::DeadSet.new, params[:substr])
+      erb :morgue
+    end
+
+    post "/filter/dead" do
+      x = params[:substr]
+      return redirect "#{root_path}morgue" unless x && x != ""
+
+      @dead = search(Sidekiq::DeadSet.new, params[:substr])
+      erb :morgue
+    end
+
     def call(env)
       action = self.class.match(env)
-      return [404, {"content-type" => "text/plain", "x-cascade" => "pass"}, ["Not Found"]] unless action
+      return [404, {Rack::CONTENT_TYPE => "text/plain", Web::X_CASCADE => "pass"}, ["Not Found"]] unless action
 
       app = @klass
       resp = catch(:halt) do
@@ -347,10 +413,10 @@ module Sidekiq
       else
         # rendered content goes here
         headers = {
-          "content-type" => "text/html",
-          "cache-control" => "private, no-store",
-          "content-language" => action.locale,
-          "content-security-policy" => CSP_HEADER
+          Rack::CONTENT_TYPE => "text/html",
+          Rack::CACHE_CONTROL => "private, no-store",
+          Web::CONTENT_LANGUAGE => action.locale,
+          Web::CONTENT_SECURITY_POLICY => CSP_HEADER
         }
         # we'll let Rack calculate Content-Length for us.
         [200, headers, [resp]]

data/lib/sidekiq/web/csrf_protection.rb

@@ -62,7 +62,7 @@ module Sidekiq
 
       def deny(env)
         logger(env).warn "attack prevented by #{self.class}"
-        [403, {"Content-Type" => "text/plain"}, ["Forbidden"]]
+        [403, {Rack::CONTENT_TYPE => "text/plain"}, ["Forbidden"]]
       end
 
       def session(env)

data/lib/sidekiq/web/helpers.rb

@@ -21,6 +21,10 @@ module Sidekiq
       end
     end
 
+    def to_json(x)
+      Sidekiq.dump_json(x)
+    end
+
     def singularize(str, count)
       if count == 1 && str.respond_to?(:singularize) # rails
         str.singularize
@@ -49,8 +53,29 @@ module Sidekiq
       locale_files.select { |file| file =~ /\/#{lang}\.yml$/ }
     end
 
-    # This is a hook for a Sidekiq Pro feature.  Please don't touch.
-    def filtering(*)
+    def search(jobset, substr)
+      resultset = jobset.scan(substr).to_a
+      @current_page = 1
+      @count = @total_size = resultset.size
+      resultset
+    end
+
+    def filtering(which)
+      erb(:filtering, locals: {which: which})
+    end
+
+    def filter_link(jid, within = "retries")
+      if within.nil?
+        ::Rack::Utils.escape_html(jid)
+      else
+        "<a href='#{root_path}filter/#{within}?substr=#{jid}'>#{::Rack::Utils.escape_html(jid)}</a>"
+      end
+    end
+
+    def display_tags(job, within = "retries")
+      job.tags.map { |tag|
+        "<span class='label label-info jobtag'>#{filter_link(tag, within)}</span>"
+      }.join(" ")
     end
 
     # This view helper provide ability display you html code in
@@ -111,13 +136,6 @@ module Sidekiq
       end
     end
 
-    # within is used by Sidekiq Pro
-    def display_tags(job, within = nil)
-      job.tags.map { |tag|
-        "<span class='label label-info jobtag'>#{::Rack::Utils.escape_html(tag)}</span>"
-      }.join(" ")
-    end
-
     # sidekiq/sidekiq#3243
     def unfiltered?
       yield unless env["PATH_INFO"].start_with?("/filter/")
@@ -278,23 +296,13 @@ module Sidekiq
       elsif rss_kb < 10_000_000
         "#{number_with_delimiter((rss_kb / 1024.0).to_i)} MB"
       else
-        "#{number_with_delimiter((rss_kb / (1024.0 * 1024.0)).round(1))} GB"
+        "#{number_with_delimiter((rss_kb / (1024.0 * 1024.0)), precision: 1)} GB"
       end
     end
 
-    def number_with_delimiter(number)
-      return "" if number.nil?
-
-      begin
-        Float(number)
-      rescue ArgumentError, TypeError
-        return number
-      end
-
-      options = {delimiter: ",", separator: "."}
-      parts = number.to_s.to_str.split(".")
-      parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{options[:delimiter]}")
-      parts.join(options[:separator])
+    def number_with_delimiter(number, options = {})
+      precision = options[:precision] || 0
+      %(<span data-nwp="#{precision}">#{number.round(precision)}</span>)
     end
 
     def h(text)

data/lib/sidekiq/web.rb

@@ -34,6 +34,18 @@ module Sidekiq
       "Metrics" => "metrics"
     }
 
+    if Gem::Version.new(Rack::RELEASE) < Gem::Version.new("3")
+      CONTENT_LANGUAGE = "Content-Language"
+      CONTENT_SECURITY_POLICY = "Content-Security-Policy"
+      LOCATION = "Location"
+      X_CASCADE = "X-Cascade"
+    else
+      CONTENT_LANGUAGE = "content-language"
+      CONTENT_SECURITY_POLICY = "content-security-policy"
+      LOCATION = "location"
+      X_CASCADE = "x-cascade"
+    end
+
     class << self
       def settings
         self
@@ -137,7 +149,7 @@ module Sidekiq
       m = middlewares
 
       rules = []
-      rules = [[:all, {"Cache-Control" => "private, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
+      rules = [[:all, {Rack::CACHE_CONTROL => "private, max-age=86400"}]] unless ENV["SIDEKIQ_WEB_TESTING"]
 
       ::Rack::Builder.new do
         use Rack::Static, urls: ["/stylesheets", "/images", "/javascripts"],

data/web/assets/javascripts/application.js

@@ -33,6 +33,7 @@ function addListeners() {
 
   addShiftClickListeners()
   updateFuzzyTimes();
+  updateNumbers();
   setLivePollFromUrl();
 
   var buttons = document.querySelectorAll(".live-poll");
@@ -102,6 +103,20 @@ function updateFuzzyTimes() {
   t.cancel();
 }
 
+function updateNumbers() {
+  document.querySelectorAll("[data-nwp]").forEach(node => {
+    let number = parseFloat(node.textContent);
+    let precision = parseInt(node.dataset["nwp"] || 0);
+    if (typeof number === "number") {
+      let formatted = number.toLocaleString(undefined, {
+        minimumFractionDigits: precision,
+        maximumFractionDigits: precision,
+      });
+      node.textContent = formatted;
+    }
+  });
+}
+
 function setLivePollFromUrl() {
   var url_params = new URL(window.location.href).searchParams
 
@@ -140,6 +155,7 @@ function checkResponse(resp) {
 
 function scheduleLivePoll() {
   let ti = parseInt(localStorage.sidekiqTimeInterval) || 5000;
+  if (ti < 2000) { ti = 2000 }
   livePollTimer = setTimeout(livePollCallback, ti);
 }
 

data/web/assets/javascripts/dashboard-charts.js

@@ -57,7 +57,9 @@ class DashboardChart extends BaseChart {
 class RealtimeChart extends DashboardChart {
   constructor(el, options) {
     super(el, options);
-    this.delay = parseInt(localStorage.sidekiqTimeInterval) || 5000;
+    let d = parseInt(localStorage.sidekiqTimeInterval) || 5000;
+    if (d < 2000) { d = 2000; }
+    this.delay = d
     this.startPolling();
     document.addEventListener("interval:update", this.handleUpdate.bind(this));
   }
@@ -84,6 +86,7 @@ class RealtimeChart extends DashboardChart {
     updateStatsSummary(this.stats.sidekiq);
     updateRedisStats(this.stats.redis);
     updateFooterUTCTime(this.stats.server_utc_time);
+    updateNumbers();
     pulseBeacon();
 
     this.stats = stats;
@@ -164,3 +167,16 @@ class RealtimeChart extends DashboardChart {
     };
   }
 }
+
+  var rc = document.getElementById("realtime-chart")
+  if (rc != null) {
+    var rtc = new RealtimeChart(rc, JSON.parse(rc.textContent))
+    rtc.registerLegend(document.getElementById("realtime-legend"))
+    window.realtimeChart = rtc
+  }
+
+  var hc = document.getElementById("history-chart")
+  if (hc != null) {
+    var htc = new DashboardChart(hc, JSON.parse(hc.textContent))
+    window.historyChart = htc
+  }

data/web/assets/javascripts/dashboard.js

@@ -1,15 +1,13 @@
 Sidekiq = {};
 
-var nf = new Intl.NumberFormat();
-
 var updateStatsSummary = function(data) {
-  document.getElementById("txtProcessed").innerText = nf.format(data.processed);
-  document.getElementById("txtFailed").innerText = nf.format(data.failed);
-  document.getElementById("txtBusy").innerText = nf.format(data.busy);
-  document.getElementById("txtScheduled").innerText = nf.format(data.scheduled);
-  document.getElementById("txtRetries").innerText = nf.format(data.retries);
-  document.getElementById("txtEnqueued").innerText = nf.format(data.enqueued);
-  document.getElementById("txtDead").innerText = nf.format(data.dead);
+  document.getElementById("txtProcessed").innerText = data.processed;
+  document.getElementById("txtFailed").innerText = data.failed;
+  document.getElementById("txtBusy").innerText = data.busy;
+  document.getElementById("txtScheduled").innerText = data.scheduled;
+  document.getElementById("txtRetries").innerText = data.retries;
+  document.getElementById("txtEnqueued").innerText = data.enqueued;
+  document.getElementById("txtDead").innerText = data.dead;
 }
 
 var updateRedisStats = function(data) {

data/web/assets/javascripts/metrics.js

@@ -262,3 +262,37 @@ class HistBubbleChart extends BaseChart {
     };
   }
 }
+
+var ch = document.getElementById("job-metrics-overview-chart");
+if (ch != null) {
+  var jm = new JobMetricsOverviewChart(ch, JSON.parse(ch.textContent));
+  document.querySelectorAll(".metrics-swatch-wrapper > input[type=checkbox]").forEach((imp) => {
+    jm.registerSwatch(imp.id)
+  });
+  window.jobMetricsChart = jm;
+}
+
+var htc = document.getElementById("hist-totals-chart");
+if (htc != null) {
+  var tc = new HistTotalsChart(htc, JSON.parse(htc.textContent));
+  window.histTotalsChart = tc
+}
+
+var hbc = document.getElementById("hist-bubble-chart");
+if (hbc != null) {
+  var bc = new HistBubbleChart(hbc, JSON.parse(hbc.textContent));
+  window.histBubbleChart = bc
+}
+
+var form = document.getElementById("metrics-form")
+document.querySelectorAll("#period-selector").forEach(node => {
+  node.addEventListener("input", debounce(() => form.submit()))
+})
+
+function debounce(func, timeout = 300) {
+  let timer;
+  return (...args) => {
+    clearTimeout(timer);
+    timer = setTimeout(() => { func.apply(this, args); }, timeout);
+  };
+}

data/web/assets/stylesheets/application.css

@@ -370,6 +370,15 @@ img.smallogo {
 .stat p {
   font-size: 0.9em;
 }
+
+.num {
+  font-family: monospace;
+}
+
+td.num {
+  text-align: right;
+}
+
 @media (max-width: 767px) {
   .stats-container {
     display: block;

data/web/locales/en.yml

@@ -97,3 +97,5 @@ en:
   Context: Context
   Bucket: Bucket
   NoJobMetricsFound: No recent job metrics were found
+  Filter: Filter
+  AnyJobContent: Any job content

data/web/locales/pt-br.yml

@@ -5,10 +5,13 @@
   AreYouSureDeleteJob: Deseja deletar esta tarefa?
   AreYouSureDeleteQueue: Deseja deletar a fila %{queue}? Isso irá deletar todas as tarefas desta fila.
   Arguments: Argumentos
+  AvgExecutionTime: Tempo médio de execução
   BackToApp: De volta ao aplicativo
+  Bucket: Bucket
   Busy: Ocupados
   Class: Classe
   Connections: Conexões
+  Context: Contexto
   CreatedAt: Criado em
   CurrentMessagesInQueue: Mensagens atualmente na <span class='title'>%{queue}</span>
   Dashboard: Painel
@@ -16,13 +19,16 @@
   DeadJobs: Tarefas mortas
   Delete: Apagar
   DeleteAll: Apagar tudo
+  Deploy: Deploy
   Enqueued: Na fila
   Error: Erro
   ErrorBacktrace: Rastreamento do erro
   ErrorClass: Classe de erro
   ErrorMessage: Mensagem de erro
+  ExecutionTime: Tempo de execução
   Extras: Extras
   Failed: Falhas
+  Failure: Falha
   Failures: Falhas
   GoBack: ← Voltar
   History: Histórico
@@ -34,10 +40,13 @@
   Latency: Latência
   LivePoll: Live Poll
   MemoryUsage: Uso de memória
+  Metrics: Métricas
   Name: Nome
   Namespace: Namespace
   NextRetry: Próxima Tentativa
+  NoDataFound: Nenhum dado encontrado
   NoDeadJobsFound: Nenhuma tarefa morta foi encontrada
+  NoJobMetricsFound: Nenhuma métrica de tarefa encontrada
   NoRetriesFound: Nenhuma tentativa encontrada
   NoScheduledFound: Nenhuma tarefa agendada foi encontrada
   NotYetEnqueued: Ainda não enfileirado
@@ -47,6 +56,7 @@
   Pause: Pausar
   Paused: Pausado
   PeakMemoryUsage: Pico de uso de memória
+  Uptime: Tempo de atividade
   Plugins: Plug-ins
   PollingInterval: Intervalo de Polling
   Process: Processo
@@ -63,14 +73,24 @@
   RetryNow: Tentar novamente agora
   Scheduled: Agendados
   ScheduledJobs: Tarefas agendadas
+  idle: Ocioso
+  active: Ativo
+  Seconds: Segundos
   ShowAll: Mostrar todos
   SixMonths: 6 meses
   Size: Tamanho
+  Started: Iniciado
   Stop: Parar
   StopAll: Parar Todos
   StopPolling: Parar Polling
+  Success: Sucesso
+  Summary: Resumo
   Thread: Thread
   Threads: Threads
+  ThreeMonths: 3 meses
+  TotalExecutionTime: Tempo total de execução
   Unpause: Despausar
   Utilization: Utilização
+  Version: Versão
+  When: Quando
   Worker: Trabalhador

data/web/views/_job_info.erb

@@ -37,7 +37,7 @@
       <tr>
         <th>BID</th>
         <td>
-          <a href="<%= root_path %>batches/<%= job.bid %>"><%= job.bid %>
+          <a href="<%= root_path %>batches/<%= job.bid %>"><%= job.bid %></a>
         </td>
       </tr>
       <% end %>

data/web/views/_metrics_period_select.erb

@@ -1,5 +1,5 @@
 <div>
-  <select class="form-control" onchange="window.location.href = '<%= path %>?period=' + event.target.value">
+  <select class="form-control" data-metric-period="<%= path %>">
     <% periods.each_key do |code| %>
 
       <% if code == period %>

data/web/views/_summary.erb

@@ -1,39 +1,39 @@
 <ul class="list-unstyled summary row">
   <li class="processed col-sm-1">
-    <span id="txtProcessed" class="count"><%= number_with_delimiter(stats.processed) %></span>
+    <span id="txtProcessed" class="count" data-nwp><%= stats.processed %></span>
     <span class="desc"><%= t('Processed') %></span>
   </li>
   <li class="failed col-sm-1">
-    <span id="txtFailed" class="count"><%= number_with_delimiter(stats.failed) %></span>
+    <span id="txtFailed" class="count" data-nwp><%= stats.failed %></span>
     <span class="desc"><%= t('Failed') %></span>
   </li>
   <li class="busy col-sm-1">
     <a href="<%= root_path %>busy">
-      <span id="txtBusy" class="count"><%= number_with_delimiter(workset.size) %></span>
+      <span id="txtBusy" class="count" data-nwp><%= workset.size %></span>
       <span class="desc"><%= t('Busy') %></span>
     </a>
   </li>
   <li class="enqueued col-sm-1">
     <a href="<%= root_path %>queues">
-      <span id="txtEnqueued" class="count"><%= number_with_delimiter(stats.enqueued) %></span>
+      <span id="txtEnqueued" class="count" data-nwp><%= stats.enqueued %></span>
       <span class="desc"><%= t('Enqueued') %></span>
     </a>
   </li>
   <li class="retries col-sm-1">
     <a href="<%= root_path %>retries">
-      <span id="txtRetries" class="count"><%= number_with_delimiter(stats.retry_size) %></span>
+      <span id="txtRetries" class="count" data-nwp><%= stats.retry_size %></span>
       <span class="desc"><%= t('Retries') %></span>
     </a>
   </li>
   <li class="scheduled col-sm-1">
     <a href="<%= root_path %>scheduled">
-      <span id="txtScheduled" class="count"><%= number_with_delimiter(stats.scheduled_size) %></span>
+      <span id="txtScheduled" class="count" data-nwp><%= stats.scheduled_size %></span>
       <span class="desc"><%= t('Scheduled') %></span>
     </a>
   </li>
   <li class="dead col-sm-1">
     <a href="<%= root_path %>morgue">
-      <span id="txtDead" class="count"><%= number_with_delimiter(stats.dead_size) %></span>
+      <span id="txtDead" class="count" data-nwp><%= stats.dead_size %></span>
       <span class="desc"><%= t('Dead') %></span>
     </a>
   </li>

data/web/views/busy.erb

@@ -86,9 +86,9 @@
           <% end %>
         </td>
         <td><%= relative_time(Time.at(process['started_at'])) %></td>
-        <td><%= format_memory(process['rss'].to_i) %></td>
-        <td><%= process['concurrency'] %></td>
-        <td><%= process['busy'] %></td>
+        <td class="num"><%= format_memory(process['rss'].to_i) %></td>
+        <td class="num"><%= number_with_delimiter(process['concurrency']) %></td>
+        <td class="num"><%= number_with_delimiter(process['busy']) %></td>
         <td>
           <% unless process.embedded? %>
             <form method="POST">

data/web/views/dashboard.erb

@@ -1,7 +1,3 @@
-<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/base-charts.js"></script>
-<script type="text/javascript" src="<%= root_path %>javascripts/dashboard-charts.js"></script>
 <script type="text/javascript" src="<%= root_path %>javascripts/dashboard.js"></script>
 <div class= "dashboard clearfix">
   <h3 >
@@ -20,26 +16,19 @@
 </div>
 
 <div class="row chart">
-  <canvas id="realtime-chart"></canvas>
-  <script>
-    window.realtimeChart = new RealtimeChart(
-      document.getElementById("realtime-chart"),
-      <%= Sidekiq.dump_json({
-        processedLabel: t('Processed'),
-        failedLabel: t('Failed'),
-        labels: Array.new(50, ""),
-        processed: Array.new(50),
-        failed: Array.new(50),
-        updateUrl: "#{root_path}stats",
-      }) %>
-    )
-  </script>
+  <canvas id="realtime-chart">
+    <%= to_json({
+      processedLabel: t('Processed'),
+      failedLabel: t('Failed'),
+      labels: Array.new(50, ""),
+      processed: Array.new(50),
+      failed: Array.new(50),
+      updateUrl: "#{root_path}stats",
+    }) %>
+  </canvas>
 
   <!-- start with a space in the legend so the height doesn't change when we add content dynamically -->
   <div id="realtime-legend">&nbsp;</div>
-  <script>
-    realtimeChart.registerLegend(document.getElementById("realtime-legend"))
-  </script>
 </div>
 
 <div class="row header">
@@ -55,18 +44,14 @@
     <a href="<%= root_path %>?days=180" class="history-graph <%= "active" if params[:days] == "180" %>"><%= t('SixMonths') %></a>
   </div>
 
-  <canvas id="history-chart"></canvas>
-  <script>
-    window.historyChart = new DashboardChart(
-      document.getElementById("history-chart"),
-      <%= Sidekiq.dump_json({
-        processedLabel: t('Processed'),
-        failedLabel: t('Failed'),
-        processed: @processed_history.to_a.reverse,
-        failed: @failed_history.to_a.reverse,
-      }) %>
-    )
-  </script>
+  <canvas id="history-chart">
+    <%= to_json({
+      processedLabel: t('Processed'),
+      failedLabel: t('Failed'),
+      processed: @processed_history.to_a.reverse,
+      failed: @failed_history.to_a.reverse,
+    }) %>
+  </canvas>
 </div>
 
 <br/>
@@ -113,3 +98,8 @@
     <% end %>
   </div>
 </div>
+
+<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/base-charts.js"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/dashboard-charts.js"></script>

data/web/views/filtering.erb

@@ -0,0 +1,7 @@
+<div>
+  <form method="post" class="form-inline" action='<%= root_path %>filter/<%= which %>'>
+    <%= csrf_tag %>
+    <label for="substr"><%= t('Filter') %></label>
+    <input class="search form-control" type="search" name="substr" value="<%= h params[:substr] %>" placeholder="<%= t('AnyJobContent') %>"/>
+  </form>
+</div>