sidekiq 6.2.2 → 8.1.5

data/web/views/_nav.html.erb

@@ -0,0 +1,45 @@
+<header>
+  <div class="container">
+    <div class="navbar-header" data-navbar="static">
+      <button type="button" class="btn navbar-toggle" data-toggle="navbar-menu" data-target="#navbar-menu">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <div class="navbar-livereload">
+        <%= erb :_poll_link %>
+        <% if config.app_url %>
+          <a class="btn btn-inverse" href="<%= config.app_url %>"><%= t('BackToApp') %></a>
+        <% end %>
+      </div>
+      <a class="navbar-brand" href="<%= root_path %>">
+        <%= Sidekiq::NAME %>
+      </a>
+    </div>
+
+    <div class="navbar-collapse" role="navigation" id="navbar-menu">
+      <ul class="nav" data-navbar="static">
+        <% config.tabs.each do |title, url| %>
+          <% if url == '' %>
+            <li class="<%= current_path == url ? 'active' : '' %>">
+              <a href="<%= root_path %><%= url %>"><%= t(title) %></a>
+            </li>
+          <% else %>
+            <li class="<%= current_path.start_with?(url) ? 'active' : '' %>">
+              <a href="<%= root_path %><%= url %>"><%= t(title) %></a>
+            </li>
+          <% end %>
+        <% end %>
+
+        <li class="navbar-livereload">
+          <div class="poll-wrapper">
+            <%= erb :_poll_link %>
+            <% if config.app_url %>
+              <a class="btn btn-inverse" href="<%= config.app_url %>"><%= t('BackToApp') %></a>
+            <% end %>
+          </div>
+        </li>
+      </ul>
+    </div>
+  </div>
+</header>

data/web/views/_paging.html.erb

@@ -0,0 +1,26 @@
+
+<% if @total_size > @count %>
+  <div>
+    <ul class="pagination pull-right">
+      <li class="<%= 'disabled' if @current_page == 1 %>">
+        <a href="<%= url %>?page=1">&laquo;</a>
+      </li>
+      <% if @current_page > 1 %>
+        <li>
+          <a href="<%= url %>?<%= qparams(page: @current_page - 1) %>"><%= @current_page - 1 %></a>
+        </li>
+      <% end %>
+      <li class="active">
+        <a href="<%= url %>?<%= qparams(page: @current_page) %>"><%= @current_page %></a>
+      </li>
+      <% if @total_size > @current_page * @count %>
+        <li>
+          <a href="<%= url %>?<%= qparams(page: @current_page + 1) %>"><%= @current_page + 1 %></a>
+        </li>
+      <% end %>
+      <li class="<%= 'disabled' if @total_size <= @current_page * @count %>">
+        <a href="<%= url %>?<%= qparams(page: (@total_size.to_f / @count).ceil) %>">&raquo;</a>
+      </li>
+    </ul>
+  </div>
+<% end %>

data/web/views/_poll_link.html.erb

@@ -0,0 +1,4 @@
+<% if pollable? %>
+  <a href="#" class="btn live-poll live-poll-start btn-primary"><%= t('LivePoll') %></a>
+  <a href="#" class="btn live-poll live-poll-stop btn-danger"><%= t('StopPolling') %></a>
+<% end %>

data/web/views/_summary.html.erb

@@ -0,0 +1,40 @@
+<div class="cards-container">
+  <article>
+    <span id="txtProcessed" class="count" data-nwp><%= stats.processed %></span>
+    <span class="desc"><%= t('Processed') %></span>
+  </article>
+  <article>
+    <span id="txtFailed" class="count" data-nwp><%= stats.failed %></span>
+    <span class="desc"><%= t('Failed') %></span>
+  </article>
+  <article>
+    <a href="<%= root_path %>busy">
+      <span id="txtBusy" class="count" data-nwp><%= workset.size %></span>
+      <span class="desc"><%= t('Busy') %></span>
+    </a>
+  </article>
+  <article>
+    <a href="<%= root_path %>queues">
+      <span id="txtEnqueued" class="count" data-nwp><%= stats.enqueued %></span>
+      <span class="desc"><%= t('Enqueued') %></span>
+    </a>
+  </article>
+  <article>
+    <a href="<%= root_path %>retries">
+      <span id="txtRetries" class="count" data-nwp><%= stats.retry_size %></span>
+      <span class="desc"><%= t('Retries') %></span>
+    </a>
+  </article>
+  <article>
+    <a href="<%= root_path %>scheduled">
+      <span id="txtScheduled" class="count" data-nwp><%= stats.scheduled_size %></span>
+      <span class="desc"><%= t('Scheduled') %></span>
+    </a>
+  </article>
+  <article>
+    <a href="<%= root_path %>morgue">
+      <span id="txtDead" class="count" data-nwp><%= stats.dead_size %></span>
+      <span class="desc"><%= t('Dead') %></span>
+    </a>
+  </article>
+</div>

data/web/views/busy.html.erb

@@ -0,0 +1,151 @@
+<section>
+  <header>
+    <h1><%= t('Status') %></h1>
+  </header>
+
+  <div class="cards-container">
+    <article>
+      <h3><%= s = processes.size; number_with_delimiter(s) %></h3>
+      <p><%= t('Processes') %></p>
+    </article>
+    <article>
+      <h3><%= x = processes.total_concurrency; number_with_delimiter(x) %></h3>
+      <p><%= t('Threads') %></p>
+    </article>
+    <article>
+      <h3><%= ws = workset.size; number_with_delimiter(ws) %></h3>
+      <p><%= t('Busy') %></p>
+    </article>
+    <article>
+      <h3><%= x == 0 ? 0 : ((ws / x.to_f) * 100).round(0) %>%</h3>
+      <p><%= t('Utilization') %></p>
+    </article>
+    <article>
+      <h3><%= format_memory(processes.total_rss) %></h3>
+      <p><%= t('RSS') %></p>
+    </article>
+  </div>
+</section>
+
+<section>
+  <header>
+    <h2><%= t('Processes') %></h2>
+    <form method="POST" class="filter warning-messages">
+      <%= csrf_tag %>
+      <div class="btn-group pull-right flip">
+        <input class="btn btn-warn" type="submit" name="quiet" value="<%= t('QuietAll') %>" data-confirm="<%= t('AreYouSure') %>">
+        <input class="btn btn-danger" type="submit" name="stop" value="<%= t('StopAll') %>" data-confirm="<%= t('AreYouSure') %>">
+      </div>
+    </form>
+  </header>
+
+  <div class="table_container">
+    <table>
+      <thead>
+        <th><%= t('Name') %></th>
+        <th><%= t('Started') %></th>
+        <th class="col-sm-1"><%= t('RSS') %><a target="blank" href="https://github.com/sidekiq/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 %>
+      <% sorted_processes.each do |process| %>
+        <tr>
+          <td class="box">
+            <%= "#{process['hostname']}:#{process['pid']}" %>
+            <span class="label label-success"><%= process.tag %></span>
+            <% process.labels.each do |label| %>
+              <span class="label label-info"><%= label %></span>
+            <% end %>
+            <% if process.embedded? %>
+              <span class="label label-default">embedded</span>
+            <% end %>
+            <% if process.stopping? %>
+              <span class="label label-danger">quiet</span>
+            <% end %>
+            <% if process.identity == lead %>
+              <span class="label label-warning">leader</span>
+            <% end %>
+            <br>
+            <b><%= "#{t('Queues')}: " %></b>
+            <%= queue_names_by_capsule(process) %>
+            <% if process.version != Sidekiq::VERSION %>
+              <br>
+              <b><%= "#{t('Version')}: " %></b>
+              <% if process.version %>
+                <%= process.version %>
+              <% else %>
+                <%= t('Unknown') %>
+              <% end %>
+            <% end %>
+          </td>
+          <td><%= relative_time(Time.at(process['started_at'])) %></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">
+                <%= csrf_tag %>
+                <input type="hidden" name="identity" value="<%= process['identity'] %>">
+
+                <div class="btn-group">
+                  <% unless process.stopping? %><button class="btn btn-warn" type="submit" name="quiet" value="1"><%= t('Quiet') %></button><% end %>
+                  <button class="btn btn-danger" type="submit" name="stop" value="1"><%= t('Stop') %></button>
+                </div>
+              </form>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+</section>
+
+<section>
+  <header>
+    <h2><%= t('Jobs') %></h2>
+    <% if @workset.size > 0 && @total_size > @count %>
+      <%= erb :_paging, locals: { url: "#{root_path}busy" } %>
+    <% end %>
+  </header>
+
+  <div class="table_container">
+    <table>
+      <thead>
+        <th><%= t('Process') %></th>
+        <th><%= t('TID') %></th>
+        <th><%= t('JID') %></th>
+        <th><%= t('Queue') %></th>
+        <th><%= t('Job') %></th>
+        <th><%= t('Arguments') %></th>
+        <th><%= t('Started') %></th>
+      </thead>
+      <% @workset.each do |process, thread, work| %>
+        <% job = work.job %>
+        <tr>
+          <td><%= process %></td>
+          <td><%= thread %></td>
+          <td><%= job.jid %></td>
+          <td>
+            <a href="<%= root_path %>queues/<%= work.queue %>"><%= work.queue %></a>
+          </td>
+          <td>
+            <%= job.display_class %>
+            <%= display_tags(job, nil) %>
+          </td>
+          <td>
+            <code><div class="args"><%= display_args(job.display_args) %></div></code>
+          </td>
+          <td>
+            <%= relative_time(work.run_at) %>
+            <% if (state = @iterable_states[job.jid]) %>
+              <div><small>cursor=<%= h(truncate(state.cursor.inspect, 100)) %>; exec=<%= state.executions %>; rt=<%= number_with_delimiter(state.runtime, precision: 3) %>s</small></div>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
+    </table>
+  </div>
+</section>

data/web/views/dashboard.html.erb

@@ -0,0 +1,104 @@
+<script type="text/javascript" src="<%= root_path %>javascripts/dashboard.js" nonce="<%= csp_nonce %>"></script>
+
+<section>
+  <header>
+    <h1>
+      <%= t('Dashboard') %>
+      <span id="beacon" class="beacon"></span>
+    </h1>
+    <div class="filter interval-slider">
+      <span class="interval-slider-label"><%= t('PollingInterval') %>:</span>
+      <span id="sldr-text" class="current-interval">5 s</span>
+      <br>
+      <input id="sldr" aria-label="<%= t("PollingIntervalMilliseconds") %>" role="slider" type="range" min="2000" max="20000" step="1000" value="5000" autocomplete="off">
+    </div>
+  </header>
+
+  <div class="chart">
+    <span id="sr-last-dashboard-update-template" hidden><%= t("LastDashboardUpdateTemplateLiteral") %></span>
+    <span id="sr-last-dashboard-update" class="sr-only" role="status"></span>
+
+    <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>
+  </div>
+</section>
+
+<section>
+  <header>
+    <h2><%= t('History') %></h2>
+
+    <div class="filter">
+      <% d = url_params("days") %>
+      <a href="<%= root_path %>?days=7" class="history-graph <%= "active" if d == "7" %>"><%= t('OneWeek') %></a>
+      <a href="<%= root_path %>" class="history-graph <%= "active" if d.nil? || d == "30" %>"><%= t('OneMonth') %></a>
+      <a href="<%= root_path %>?days=90" class="history-graph <%= "active" if d == "90" %>"><%= t('ThreeMonths') %></a>
+      <a href="<%= root_path %>?days=180" class="history-graph <%= "active" if d == "180" %>"><%= t('SixMonths') %></a>
+    </div>
+  </header>
+
+  <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>
+</section>
+
+<section>
+  <header>
+    <h2><%= store_name %></h2>
+  </header>
+  <div class="cards-container">
+    <article>
+      <h3 id="redis_version"><%= store_version %></h3>
+      <p><%= t('Version') %></p>
+    </article>
+
+    <% if @redis_info.fetch("uptime_in_days", nil) %>
+      <article>
+        <h3 id="uptime_in_days"><%= @redis_info.fetch("uptime_in_days") %></h3>
+        <p><%= t('Uptime') %></p>
+      </article>
+    <% end %>
+
+    <% if @redis_info.fetch("connected_clients", nil) %>
+      <article>
+        <h3 id="connected_clients"><%= @redis_info.fetch("connected_clients") %></h3>
+        <p><%= t('Connections') %></p>
+      </article>
+    <% end %>
+
+    <% if @redis_info.fetch("used_memory_human", nil) %>
+      <article>
+        <h3 id="used_memory_human"><%= @redis_info.fetch("used_memory_human") %></h3>
+        <p><%= t('MemoryUsage') %></p>
+      </article>
+    <% end %>
+
+    <% if @redis_info.fetch("used_memory_peak_human", nil) %>
+      <article>
+        <h3 id="used_memory_peak_human"><%= @redis_info.fetch("used_memory_peak_human") %></h3>
+        <p><%= t('PeakMemoryUsage') %></p>
+      </article>
+    <% end %>
+  </div>
+</section>
+
+<script type="text/javascript" src="<%= root_path %>javascripts/chart.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-plugin-annotation.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/chartjs-adapter-date-fns.min.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/base-charts.js" nonce="<%= csp_nonce %>"></script>
+<script type="text/javascript" src="<%= root_path %>javascripts/dashboard-charts.js" nonce="<%= csp_nonce %>"></script>

data/web/views/dead.html.erb

@@ -0,0 +1,38 @@
+<%= erb :_job_info, locals: { job: @dead, type: :dead } %>
+
+<section>
+  <header>
+    <h1><%= t('Error') %></h1>
+  </header>
+  <div class="table_container">
+    <table>
+      <tbody>
+        <tr>
+          <th><%= t('ErrorClass') %></th>
+          <td>
+            <code><%= @dead['error_class'] %></code>
+          </td>
+        </tr>
+        <tr>
+          <th><%= t('ErrorMessage') %></th>
+          <td><%= h(@dead['error_message']) %></td>
+        </tr>
+        <% if @dead.error_backtrace %>
+          <tr>
+            <th><%= t('ErrorBacktrace') %></th>
+            <td>
+              <code><%= @dead.error_backtrace.join("<br/>") %></code>
+            </td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+
+  <form action="<%= root_path %>morgue/<%= job_params(@dead, @dead.score) %>" method="post">
+    <%= csrf_tag %>
+    <a class="btn btn-default" href="<%= root_path %>morgue"><%= t('GoBack') %></a>
+    <input class="btn btn-primary" type="submit" name="retry" value="<%= t('RetryNow') %>">
+    <input class="btn btn-danger" type="submit" name="delete" value="<%= t('Delete') %>">
+  </form>
+</section>

data/web/views/filtering.html.erb

@@ -0,0 +1,6 @@
+<div class="filter">
+  <form role="search" method="get" class="form-inline" action="<%= root_path %><%= which %>">
+    <label for="substr"><%= t(label_key) %></label>
+    <input class="form-control" type="search" name="substr" value="<%= h url_params("substr") %>" placeholder="<%= t(placeholder_key) %>" autocomplete="off">
+  </form>
+</div>

data/web/views/layout.html.erb

@@ -0,0 +1,26 @@
+<!doctype html>
+<html dir="<%= text_direction %>" lang="<%= locale %>">
+  <head>
+    <title><%= environment_title_prefix %><%= Sidekiq::NAME %></title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1.0">
+    <meta name="color-scheme" content="light dark">
+    <link href="<%= root_path %>stylesheets/style.css" media="screen" rel="stylesheet" type="text/css" nonce="<%= csp_nonce %>">
+    <link rel="apple-touch-icon" href="<%= root_path %>images/apple-touch-icon.png">
+    <link rel="shortcut icon" type="image/ico" href="<%= root_path %>images/favicon.ico">
+    <script type="text/javascript" src="<%= root_path %>javascripts/application.js" nonce="<%= csp_nonce %>"></script>
+    <meta name="google" content="notranslate">
+    <%= display_custom_head %>
+  </head>
+  <body class="admin" data-locale="<%= locale %>">
+    <%= erb :_nav %>
+    <main id="page">
+      <div class="container">
+        <%= erb :_summary %>
+        <% if flash? %><p class="flash"><%= get_flash %></p><% end %>
+        <%= yield %>
+      </div>
+    </main>
+    <%= erb :_footer %>
+  </body>
+</html>

data/web/views/metrics.html.erb

@@ -0,0 +1,85 @@
+<%= script_tag "javascripts/chart.min.js" %>
+<%= script_tag "javascripts/chartjs-plugin-annotation.min.js" %>
+<%= script_tag "javascripts/chartjs-adapter-date-fns.min.js" %>
+<%= script_tag "javascripts/base-charts.js" %>
+
+<section>
+  <header>
+    <h1>
+      <%= t('Metrics') %>
+      <a target="blank" href="https://github.com/sidekiq/sidekiq/wiki/Metrics"><span class="info-circle" title="Click to learn more about metrics">?</span></a>
+    </h1>
+
+    <%= erb :_metrics_period_select, locals: { periods: @periods, period: @period, path: "#{root_path}metrics" } %>
+  </header>
+
+  <%
+    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)
+  %>
+
+  <% if job_results.any? %>
+    <canvas id="job-metrics-overview-chart">
+      <%= to_json({
+        series: job_results.map { |(kls, jr)| [kls, jr.dig("series", "s")] }.to_h,
+        marks: @query_result.marks.map { |m| [m.bucket, m.label] },
+        starts_at: @query_result.starts_at.iso8601,
+        ends_at: @query_result.ends_at.iso8601,
+        visibleKls: visible_kls,
+        yLabel: t('TotalExecutionTime'),
+        units: t('Seconds').downcase,
+        markLabel: t('Deploy'),
+      }) %>
+    </canvas>
+  <% end %>
+
+  <div class="table_container">
+    <table>
+      <thead>
+        <tr>
+          <th><%= t('Name') %></th>
+          <th><%= t('Success') %></th>
+          <th><%= t('Failure') %></th>
+          <th><%= t('TotalExecutionTime') %> (<%= t('Seconds') %>)</th>
+          <th><%= t('AvgExecutionTime') %> (<%= t('Seconds') %>)</th>
+        </tr>
+      </thead>
+      <tbody>
+        <% 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 %>"
+                    <% if visible_kls.include?(kls) %>
+                    checked
+                    <% end %>>
+                  <code><a href="<%= root_path %>metrics/<%= kls %>?period=<%= @period %>"><%= kls %></a></code>
+                </div>
+              </td>
+              <td class="num"><%= number_with_delimiter(jr.dig("totals", "p") - jr.dig("totals", "f")) %></td>
+              <td class="num"><%= number_with_delimiter(jr.dig("totals", "f")) %></td>
+              <td class="num"><%= number_with_delimiter(jr.dig("totals", "s"), precision: 2) %></td>
+              <td class="num"><%= number_with_delimiter(jr.total_avg("s"), precision: 2) %></td>
+            </tr>
+          <% end %>
+        <% else %>
+          <tr><td colspan="5"><%= t("NoDataFound") %></td></tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+
+  <% if job_results.any? %>
+    <p><small>Data from <%= @query_result.starts_at %> to <%= @query_result.ends_at %>.<% if @period == "1h" %> Auto-refreshing every 60 seconds.<% end %></small></p>
+  <% end %>
+</section>
+
+<%= script_tag "javascripts/metrics.js" %>

data/web/views/metrics_for_job.html.erb

@@ -0,0 +1,58 @@
+<%= script_tag "javascripts/chart.min.js" %>
+<%= script_tag "javascripts/chartjs-plugin-annotation.min.js" %>
+<%= script_tag "javascripts/chartjs-adapter-date-fns.min.js" %>
+<%= script_tag "javascripts/base-charts.js" %>
+
+<%
+  job_result = @query_result.job_results[@name]
+  hist_totals = job_result.hist.values.first.zip(*job_result.hist.values[1..-1]).map(&:sum).reverse
+  bucket_labels = Sidekiq::Metrics::Histogram::LABELS
+  bucket_intervals = Sidekiq::Metrics::Histogram::BUCKET_INTERVALS
+%>
+<section>
+  <% if job_result.totals["s"] > 0 %>
+    <header>
+      <h1>
+        <a href="<%= root_path %>metrics?period=<%= @period %>"><%= t('Metrics') %></a> /
+        <%= h @name %>
+        <a target="blank" href="https://github.com/sidekiq/sidekiq/wiki/Metrics"><span class="info-circle" title="Click to learn more about metrics">?</span></a>
+      </h1>
+      <%= erb :_metrics_period_select, locals: { periods: @periods, period: @period, path: "#{root_path}metrics/#{@name}" } %>
+    </header>
+
+    <canvas id="hist-totals-chart">
+      <%= to_json({
+        series: hist_totals,
+        labels: bucket_labels,
+        xLabel: t('ExecutionTime'),
+        yLabel: t('Jobs'),
+        units: t('Jobs').downcase,
+      }) %>
+    </canvas>
+
+    <canvas id="hist-bubble-chart">
+      <%= to_json({
+        hist: job_result.hist,
+        marks: @query_result.marks.map { |m| [m.bucket, m.label] },
+        starts_at: @query_result.starts_at.iso8601,
+        ends_at: @query_result.ends_at.iso8601,
+        histIntervals: bucket_intervals,
+        yLabel: t('ExecutionTime'),
+        markLabel: t('Deploy'),
+        yUnits: t('Seconds').downcase,
+        zUnits: t('Jobs').downcase,
+      }) %>
+    </canvas>
+
+  <!--p><small>Data from <%= @query_result.starts_at %> to <%= @query_result.ends_at %></small></p-->
+  <% else %>
+    <header>
+      <h1>
+        <a href="<%= root_path %>/metrics"><%= t('Metrics') %></a> /
+        <%= h @name %>
+      </h1>
+    </header>
+    <div class="alert alert-success"><%= t('NoJobMetricsFound') %></div>
+  <% end %>
+</section>
+<%= script_tag "javascripts/metrics.js" %>