karafka-web 0.1.3 → 0.2.1

data/lib/karafka/web/ui/views/jobs/_job.erb

@@ -12,6 +12,10 @@
   </td>
   <td>
     <code><%= job.consumer %></code>
+
+    <% job.tags.each do |tag| %>
+      <span class="badge bg-info"><%= tag %></span>
+    <% end %>
   </td>
   <td>
     <code>#<%= job.type %></code>

data/lib/karafka/web/ui/views/shared/_navigation.erb

@@ -45,6 +45,11 @@
         Cluster
       </a>
     </li>
+    <li class="nav-item ms-3">
+      <a class="nav-link <%= nav_class(start_with: '/status') %>" href="<%= root_path('status') %>">
+        Status
+      </a>
+    </li>
   </ul>
 </div>
 

data/lib/karafka/web/ui/views/shared/exceptions/not_found.erb

@@ -20,6 +20,7 @@
         </p>
 
         <ul class="mb-5 text-start">
+          <li>You have visited the <a href="<%= root_path('status') %>">Status</a> page to troubleshoot any potential issues</li>
           <li>All the topics required by Karafka Web exist</li>
           <li>You have used <code>bundle exec karafka-web install</code> to initialize the Web UI</li>
           <li>You have a working connection with your Kafka cluster</li>
@@ -32,6 +33,7 @@
 
         <p>
           <a href="<%= root_path %>" class="btn btn-primary">Go Home</a>
+          <a href="<%= root_path('status') %>" class="btn btn-success">Status page</a>
         </p>
       </div>
     </div>

data/lib/karafka/web/ui/views/status/_breadcrumbs.erb

@@ -0,0 +1,5 @@
+<li class="breadcrumb-item">
+  <a href="<%= root_path('status') %>">
+    Web UI status details
+  </a>
+</li>

data/lib/karafka/web/ui/views/status/_failure.erb

@@ -0,0 +1,14 @@
+<div class="card border-danger mb-3">
+  <div class="card-header text-bg-danger">
+    <span>
+      <%= title %>
+    </span>
+
+    <span class="float-end">
+      <span class="badge  text-bg-light">Failure</span>
+    </span>
+  </div>
+  <div class="card-body">
+    <%== description %>
+  </div>
+</div>

data/lib/karafka/web/ui/views/status/_halted.erb

@@ -0,0 +1,11 @@
+<div class="card text-bg-secondary mb-3">
+  <div class="card-header">
+    <span>
+      <%= title %>
+    </span>
+
+    <span class="float-end">
+      <span class="badge  text-bg-light">Halted</span>
+    </span>
+  </div>
+</div>

data/lib/karafka/web/ui/views/status/_success.erb

@@ -0,0 +1,11 @@
+<div class="card text-bg-success mb-3">
+  <div class="card-header">
+    <span>
+      <%= title %>
+    </span>
+
+    <span class="float-end">
+      <span class="badge  text-bg-light">Successful</span>
+    </span>
+  </div>
+</div>

data/lib/karafka/web/ui/views/status/failures/_connection.erb

@@ -0,0 +1,7 @@
+<p>
+  Web UI was not able to establish a connection with the Kafka cluster.
+</p>
+
+<p class="mb-0">
+  Please make sure that Web UI can reach Kafka.
+</p>

data/lib/karafka/web/ui/views/status/failures/_initial_state.erb

@@ -0,0 +1,20 @@
+<p>
+  The initial state for the Web UI was not created.
+</p>
+
+<p>
+  It means that the <code>bundle exec karafka-web install</code> was not executed or failed.
+</p>
+
+<p>
+  To fix this, you can either:
+</p>
+
+<ul>
+  <li>Run <code>bundle exec karafka-web install</code></li>
+  <li>Run at least one Karafka consumer process</li>
+</ul>
+
+<p class="mb-0">
+  Any of the above, when successful, will bootstrap the initial state.
+</p>

data/lib/karafka/web/ui/views/status/failures/_live_reporting.erb

@@ -0,0 +1,7 @@
+<p>
+  There are no Karafka consumer processes actively reporting to the Web UI.
+</p>
+
+<p class="mb-0">
+  If you are sure you are running at least one <code>karafka server</code> instance, please make sure that it can report to the <code><%= Karafka::Web.config.topics.consumers.reports %></code> topic.
+</p>

data/lib/karafka/web/ui/views/status/failures/_partitions.erb

@@ -0,0 +1,19 @@
+<p>
+  Both
+  <code><%= Karafka::Web.config.topics.consumers.states %></code>
+  and
+  <code><%= Karafka::Web.config.topics.consumers.reports %></code>
+  topics need to be configured with <strong>exactly</strong> one partition.
+</p>
+
+<p>
+  Your current setup contains the following:
+</p>
+
+<ul class="mb-0">
+  <% details.each do |name, details| %>
+    <li>
+      <code><%= name %> </code> with <code><%= details[:partitions] %> </code> partitions.
+    </li>
+  <% end %>
+</ul>

data/lib/karafka/web/ui/views/status/failures/_state_calculation.erb

@@ -0,0 +1,8 @@
+<p>
+  None of the <code>karafka server</code> processes is subscribed to handle the
+  <code><%= Karafka::Web.config.topics.consumers.reports %></code> topic data aggregations.
+</p>
+
+<p class="mb-0">
+  If you are limiting the topics you consume using the <a href="https://karafka.io/docs/CLI/#limiting-consumer-groups-used-per-process" target="_blank">limiting API</a>, please include the Karafka Web consumer group and the <code><%= Karafka::Web.config.topics.consumers.reports %></code> topic.
+</p>

data/lib/karafka/web/ui/views/status/failures/_topics.erb

@@ -0,0 +1,20 @@
+<p>
+  Web UI requires the following topics to exist:
+</p>
+
+<ul>
+  <% details.each do |name, details| %>
+    <li>
+      <code><%= name %></code> - <%= details[:present] ? 'Exists' : 'Missing' %>
+    </li>
+  <% end %>
+</ul>
+
+<p>
+  Please ensure all those topics exist and are accessible to your Karafka user.
+</p>
+
+<p class="mb-0">
+  You can read more about their setup and configuration
+  <a href="https://karafka.io/docs/Web-UI-Getting-Started/" target="_blank">here</a>.
+</p>

data/lib/karafka/web/ui/views/status/show.erb

@@ -0,0 +1,94 @@
+<%== view_title('Web UI status details') %>
+
+<div class="container mb-5">
+  <div class="row">
+    <div class="col-lg-10 offset-md-1">
+
+      <%==
+        partial(
+          "status/#{@status.connection.to_s}",
+          locals: {
+            title: 'Connection to Kafka',
+            description: partial('status/failures/connection')
+          }
+        )
+      %>
+
+      <%==
+        partial(
+          "status/#{@status.topics.to_s}",
+          locals: {
+            title: 'Topics presence',
+            description: partial(
+              'status/failures/topics',
+              locals: {
+                details: @status.topics.details
+              }
+            )
+          }
+        )
+      %>
+
+      <%==
+        partial(
+          "status/#{@status.partitions.to_s}",
+          locals: {
+            title: 'Partitions count',
+            description: partial(
+              'status/failures/partitions',
+              locals: {
+                details: @status.partitions.details
+              }
+            )
+          }
+        )
+      %>
+
+      <%==
+        partial(
+          "status/#{@status.initial_state.to_s}",
+          locals: {
+            title: 'Initial state presence',
+            description: partial(
+              'status/failures/initial_state',
+              locals: {
+                details: @status.initial_state.details
+              }
+            )
+          }
+        )
+      %>
+
+      <%==
+        partial(
+          "status/#{@status.live_reporting.to_s}",
+          locals: {
+            title: 'Live reporting',
+            description: partial(
+              'status/failures/live_reporting',
+              locals: {
+                details: @status.live_reporting.details
+              }
+            )
+          }
+        )
+      %>
+
+      <%==
+        partial(
+          "status/#{@status.state_calculation.to_s}",
+          locals: {
+            title: 'State calculation subscription',
+            description: partial(
+              'status/failures/state_calculation',
+              locals: {
+                details: @status.state_calculation.details
+              }
+            )
+          }
+        )
+      %>
+
+    </div>
+  </div>
+</div>

data/lib/karafka/web/version.rb

@@ -3,6 +3,6 @@
 module Karafka
   module Web
     # Current gem version
-    VERSION = '0.1.3'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-web
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -57,7 +57,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.29
+        version: 2.0.33
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -67,7 +67,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.29
+        version: 2.0.33
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -77,7 +77,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.12
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -87,7 +87,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.0.12
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -199,6 +199,7 @@ files:
 - lib/karafka/web/ui/controllers/requests/params.rb
 - lib/karafka/web/ui/controllers/responses/data.rb
 - lib/karafka/web/ui/controllers/routing.rb
+- lib/karafka/web/ui/controllers/status.rb
 - lib/karafka/web/ui/helpers/application_helper.rb
 - lib/karafka/web/ui/lib/hash_proxy.rb
 - lib/karafka/web/ui/lib/paginate_array.rb
@@ -210,6 +211,7 @@ files:
 - lib/karafka/web/ui/models/process.rb
 - lib/karafka/web/ui/models/processes.rb
 - lib/karafka/web/ui/models/state.rb
+- lib/karafka/web/ui/models/status.rb
 - lib/karafka/web/ui/models/topic.rb
 - lib/karafka/web/ui/pro/app.rb
 - lib/karafka/web/ui/pro/controllers/cluster.rb
@@ -220,6 +222,7 @@ files:
 - lib/karafka/web/ui/pro/controllers/health.rb
 - lib/karafka/web/ui/pro/controllers/jobs.rb
 - lib/karafka/web/ui/pro/controllers/routing.rb
+- lib/karafka/web/ui/pro/controllers/status.rb
 - lib/karafka/web/ui/pro/views/consumers/_breadcrumbs.erb
 - lib/karafka/web/ui/pro/views/consumers/_consumer.erb
 - lib/karafka/web/ui/pro/views/consumers/_counters.erb
@@ -282,14 +285,6 @@ files:
 - lib/karafka/web/ui/views/consumers/_consumer.erb
 - lib/karafka/web/ui/views/consumers/_counters.erb
 - lib/karafka/web/ui/views/consumers/_summary.erb
-- lib/karafka/web/ui/views/consumers/consumer/_consumer_group.erb
-- lib/karafka/web/ui/views/consumers/consumer/_job.erb
-- lib/karafka/web/ui/views/consumers/consumer/_metrics.erb
-- lib/karafka/web/ui/views/consumers/consumer/_no_jobs.erb
-- lib/karafka/web/ui/views/consumers/consumer/_no_subscriptions.erb
-- lib/karafka/web/ui/views/consumers/consumer/_partition.erb
-- lib/karafka/web/ui/views/consumers/consumer/_stopped.erb
-- lib/karafka/web/ui/views/consumers/consumer/_tabs.erb
 - lib/karafka/web/ui/views/consumers/index.erb
 - lib/karafka/web/ui/views/errors/_breadcrumbs.erb
 - lib/karafka/web/ui/views/errors/_detail.erb
@@ -315,6 +310,17 @@ files:
 - lib/karafka/web/ui/views/shared/_pagination.erb
 - lib/karafka/web/ui/views/shared/exceptions/not_found.erb
 - lib/karafka/web/ui/views/shared/exceptions/pro_only.erb
+- lib/karafka/web/ui/views/status/_breadcrumbs.erb
+- lib/karafka/web/ui/views/status/_failure.erb
+- lib/karafka/web/ui/views/status/_halted.erb
+- lib/karafka/web/ui/views/status/_success.erb
+- lib/karafka/web/ui/views/status/failures/_connection.erb
+- lib/karafka/web/ui/views/status/failures/_initial_state.erb
+- lib/karafka/web/ui/views/status/failures/_live_reporting.erb
+- lib/karafka/web/ui/views/status/failures/_partitions.erb
+- lib/karafka/web/ui/views/status/failures/_state_calculation.erb
+- lib/karafka/web/ui/views/status/failures/_topics.erb
+- lib/karafka/web/ui/views/status/show.erb
 - lib/karafka/web/version.rb
 homepage: https://karafka.io
 licenses:

data/lib/karafka/web/ui/views/consumers/consumer/_consumer_group.erb

@@ -1,109 +0,0 @@
-<div class="row mb-4">
-  <div class="col-sm-12">
-    <h5 class="mb-4">
-      <%= consumer_group.id %>
-    </h5>
-
-    <div class="card-group text-center">
-      <div class="card">
-        <div class="card-body d-flex flex-column align-items-center justify-content-center p-2">
-          State:&nbsp;
-          <span class="badge <%= kafka_state_bg(consumer_group[:state][:state]) %> mt-1 mb-1">
-            <%= consumer_group[:state][:state] %>
-          </span>
-        </div>
-      </div>
-      <div class="card">
-        <div class="card-body d-flex flex-column align-items-center justify-content-center p-2">
-          Join state:&nbsp;
-          <span class="badge <%= kafka_state_bg(consumer_group.join_state) %> mt-1 mb-1">
-            <%= consumer_group.join_state %>
-          </span>
-        </div>
-      </div>
-      <div class="card">
-        <div class="card-body d-flex flex-column align-items-center justify-content-center p-2">
-          State change:&nbsp;
-          <span class="badge bg-secondary mt-1 mb-1">
-            <%==
-              relative_time(
-                Time.at(@process.dispatched_at) - (consumer_group.stateage / 1_000)
-              )
-            %>
-          </span>
-        </div>
-      </div>
-      <div class="card">
-        <div class="card-body d-flex flex-column align-items-center justify-content-center p-2">
-          Last rebalance:&nbsp;
-          <span class="badge bg-secondary mt-1 mb-1">
-            <%==
-              relative_time(
-                Time.at(@process.dispatched_at) - (consumer_group.rebalance_age / 1_000)
-              )
-            %>
-          </span>
-        </div>
-      </div>
-      <div class="card">
-        <div class="card-body d-flex flex-column align-items-center justify-content-center p-2">
-          Rebalance count:&nbsp;
-          <span class="badge bg-secondary mt-1 mb-1">
-            <%= consumer_group.rebalance_cnt %>
-          </span>
-        </div>
-      </div>
-    </div>
-  </div>
-
-  <span class="text-end mt-3">
-    <small>
-      Last rebalance reason: <%= consumer_group.rebalance_reason %>
-    </small>
-  </span>
-</div>
-
-<% if consumer_group.topics.empty? %>
-  <div class="row">
-    <div class="col-lg-12">
-      <div class="alert alert-info" role="alert">
-        This process does not consume any messages from any topics of this consumer group.
-      </div>
-    </div>
-  </div>
-<% else %>
-  <div class="row mb-5">
-    <div class="col-sm-12">
-      <table class="processes bg-white table table-hover table-bordered table-striped mb-0 align-middle">
-        <thead>
-          <tr class="align-middle">
-            <th>Topic</th>
-            <th>Partition</th>
-            <th>Lag stored</th>
-            <th>Lag trend</th>
-            <th>Committed offset</th>
-            <th>Stored offset</th>
-            <th>Fetch state</th>
-            <th>Poll state</th>
-          </tr>
-        </thead>
-        <tbody>
-          <% consumer_group.topics.each do |topic| %>
-            <% topic.partitions.each do |partition| %>
-              <%==
-                partial(
-                  'consumers/consumer/partition',
-                  locals: {
-                    topic: topic,
-                    partition: partition,
-                    consumer_group: consumer_group
-                  }
-                )
-              %>
-            <% end %>
-          <% end %>
-        </tbody>
-      </table>
-    </div>
-  </div>
-<% end %>

data/lib/karafka/web/ui/views/consumers/consumer/_job.erb

@@ -1,26 +0,0 @@
-<tr>
-  <td>
-    <code><%= job.consumer %></code>
-  </td>
-  <td>
-    <span class="badge bg-secondary badge-topic" title="Consumer group: <%= job.consumer_group %>">
-      <%= job.topic %>:
-      <%= job.partition %>
-    </span>
-  </td>
-  <td>
-    <code>#<%= job.type %></code>
-  </td>
-  <td>
-    <%= job.first_offset %>
-  </td>
-  <td>
-    <%= job.last_offset %>
-  </td>
-  <td>
-    <%= job.comitted_offset %>
-  </td>
-  <td>
-    <%== relative_time job.started_at %>
-  </td>
-</tr>

data/lib/karafka/web/ui/views/consumers/consumer/_metrics.erb

@@ -1,126 +0,0 @@
-<div class="container mb-5">
-  <div class="row" id="metrics">
-    <div class="col-lg-12">
-      <div class="card-group">
-        <div class="card">
-          <div class="card-body">
-            <h5 class="card-title">Process</h5>
-            <p class="card-text">
-            <ul style="list-style: square !important;">
-              <li class="align-items-center d-flex justify-content-between">
-                Status:
-                <span class="badge <%= status_bg @process.status %>">
-                  <%= @process.status %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                Started:
-                <span class="badge bg-secondary">
-                  <%== relative_time @process.started_at %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                State from:
-                <span class="badge bg-secondary">
-                  <%== relative_time @process.dispatched_at %>
-                </span>
-              </li>
-            </ul>
-            </p>
-          </div>
-        </div>
-        <div class="card">
-          <div class="card-body">
-            <h5 class="card-title">Utilization</h5>
-            <p class="card-text">
-            <ul style="list-style: square !important;">
-              <li class="align-items-center d-flex justify-content-between">
-                Threads:
-                <span class="badge bg-primary">
-                  <%= @process.concurrency %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                Threads utilization:
-                <span class="badge bg-primary">
-                  <%= @process.utilization.round(2) %>%
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                CPUs:
-                <span class="badge bg-primary">
-                  <%= @process.cpu_count %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                CPU usage:
-                <% @process.cpu_usage.each_with_index do |usage, i| %>
-                  <span class="badge bg-primary">
-                    <%= usage %>
-                  </span>
-
-                  <%= i < 2 ? '/' : '' %>
-                <% end %>
-              </li>
-            </ul>
-            </p>
-          </div>
-        </div>
-        <div class="card">
-          <div class="card-body">
-            <h5 class="card-title">Memory usage</h5>
-            <p class="card-text">
-            <ul style="list-style: square !important;">
-              <li class="align-items-center d-flex justify-content-between">
-                RSS:
-                <span class="badge bg-primary">
-                  <%= format_memory @process.memory_usage %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                OS memory used:
-                <span class="badge bg-primary">
-                  <%= format_memory @process.memory_total_usage %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                OS memory available:
-                <span class="badge bg-primary">
-                  <%= format_memory @process.memory_size %>
-                </span>
-              </li>
-            </ul>
-            </p>
-          </div>
-        </div>
-        <div class="card">
-          <div class="card-body">
-            <h5 class="card-title">Versions</h5>
-            <p class="card-text">
-            <ul style="list-style: square !important;">
-              <li class="align-items-center d-flex justify-content-between">
-                Ruby:
-                <span class="badge bg-secondary">
-                  <%= @process.ruby %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                Karafka:
-                <span class="badge bg-secondary">
-                  <%= @process.karafka %>
-                </span>
-              </li>
-              <li class="align-items-center d-flex justify-content-between">
-                WaterDrop version:
-                <span class="badge bg-secondary">
-                  <%= @process.waterdrop %>
-                </span>
-              </li>
-            </ul>
-            </p>
-          </div>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>

data/lib/karafka/web/ui/views/consumers/consumer/_no_jobs.erb

@@ -1,9 +0,0 @@
-<div class="container mb-4">
-  <div class="row">
-    <div class="col-lg-12">
-      <div class="alert alert-info" role="alert">
-        This process is not running any jobs at the moment.
-      </div>
-    </div>
-  </div>
-</div>