karafka-web 0.5.2 → 0.6.1

data/lib/karafka/web/ui/pro/views/errors/show.erb

@@ -1,9 +1,8 @@
 <%==
   type = @error_message.payload[:type]
   error_class = @error_message.payload[:error_class]
-  offset = @error_message.offset
 
-  view_title("#{type}: #{error_class} #{offset}")
+  view_title("#{type}: #{error_class}")
 %>
 
 <div class="container">
@@ -36,6 +35,7 @@
       </table>
     </div>
   </div>
+
   <div class="row mb-4">
     <div class="col-sm-12">
       <h5 class="mb-2">
@@ -44,6 +44,7 @@
       <hr/>
     </div>
   </div>
+
   <div class="row mb-4">
     <div class="col-sm-12">
       <div class="card">

data/lib/karafka/web/ui/public/stylesheets/application.css

@@ -108,3 +108,7 @@ code.wrapped {
 #metrics ul {
   padding-left: 0;
 }
+
+.blurred {
+  filter: blur(4px)
+}

data/lib/karafka/web/ui/views/consumers/_no_consumers.erb

@@ -0,0 +1,9 @@
+<div class="alert alert-info" role="alert">
+  <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>
+</div>

data/lib/karafka/web/ui/views/consumers/index.erb

@@ -4,26 +4,30 @@
 <div class="container">
   <div class="row">
     <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>Name</th>
-            <th class="col-sm-2">Started</th>
-            <th class="col-sm-1">Memory</th>
-            <th class="col-sm-1">Utilization</th>
-            <th class="col-sm-1">Total lag</th>
-          </tr>
-        </thead>
-        <tbody>
-          <%==
-            render_each(
-              @processes,
-              'consumers/_consumer',
-              local: :process
-            )
-          %>
-        </tbody>
-      </table>
+      <% if @processes.empty? %>
+        <%== partial 'consumers/no_consumers' %>
+      <% else %>
+        <table class="processes bg-white table table-hover table-bordered table-striped mb-0 align-middle">
+          <thead>
+            <tr class="align-middle">
+              <th>Name</th>
+              <th class="col-sm-2">Started</th>
+              <th class="col-sm-1">Memory</th>
+              <th class="col-sm-1">Utilization</th>
+              <th class="col-sm-1">Total lag</th>
+            </tr>
+          </thead>
+          <tbody>
+            <%==
+              render_each(
+                @processes,
+                'consumers/_consumer',
+                local: :process
+              )
+            %>
+          </tbody>
+        </table>
+      <% end %>
     </div>
   </div>
 </div>

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

@@ -10,9 +10,8 @@
       <%=
         type = @error_message.payload[:type]
         error_class = @error_message.payload[:error_class]
-        offset = @error_message.offset
 
-        "#{type}: #{error_class} #{offset}"
+        "#{type}: #{error_class}"
       %>
     </a>
   </li>

data/lib/karafka/web/ui/views/errors/_detail.erb

@@ -21,8 +21,16 @@
       <%= k %>
     </td>
     <td>
-      <% if k == :occurred_at %>
+      <% case k
+         when :occurred_at
+      %>
         <%== relative_time v %>
+      <% when :error_class %>
+        <code><%= v %></code>
+      <% when :type %>
+        <span class="badge bg-secondary">
+          <%= v %>
+        </span>
       <% else %>
         <%= v %>
       <% end %>

data/lib/karafka/web/ui/views/errors/_error.erb

@@ -9,14 +9,16 @@
 
   <tr>
     <td>
-      <% if error[:details].key?(:topic) %>
-        <%= error[:details][:topic] %>: <%= error[:details][:partition] %>
-      <% else %>
-        <%= error[:type] %>
-      <% end %>
+      <span class="badge bg-secondary badge-topic">
+        <% if error[:details].key?(:topic) %>
+          <%= error[:details][:topic] %>: <%= error[:details][:partition] %>
+        <% else %>
+          <%= error[:type] %>
+        <% end %>
+      </span>
     </td>
     <td>
-      <%== error[:process_name] %>
+      <%== error[:process][:name] %>
     </td>
     <td>
       <%= error[:error_class] %>:

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

@@ -1,12 +1,20 @@
 <%==
   type = @error_message.payload[:type]
   error_class = @error_message.payload[:error_class]
-  offset = @error_message.offset
 
-  view_title("#{type}: #{error_class} #{offset}", hr: true)
+  view_title("#{type}: #{error_class}")
 %>
 
 <div class="container">
+  <div class="row mb-4">
+    <div class="col-sm-12">
+      <h5 class="mb-2">
+        Metadata
+      </h5>
+      <hr/>
+    </div>
+  </div>
+
   <div class="row mb-5">
     <div class="col-sm-12 table-responsive">
       <table class="processes bg-white table table-hover table-bordered table-striped mb-0 align-middle">
@@ -27,4 +35,44 @@
       </table>
     </div>
   </div>
+
+  <div class="row mb-2">
+    <div class="col-sm-12">
+      <h5 class="mb-2">
+        Backtrace
+      </h5>
+      <hr/>
+    </div>
+  </div>
+
+  <div class="mb-4">
+    <%== partial 'shared/feature_pro' %>
+  </div>
+
+  <div class="row mb-4">
+    <div class="col-sm-12">
+      <div class="card">
+        <div class="card-body">
+          <pre class="m-0 p-0 blurred"><code class="wrapped json p-0 m-0">this is just an example backtrace
+please subscribe to our Pro offering to be able to view the real one
+gems/karafka-rdkafka/lib/rdkafka/consumer.rb:255:in `query_watermark_offsets'
+gems/karafka/lib/karafka/admin.rb:56:in `block in read_topic'
+gems/karafka/lib/karafka/admin.rb:184:in `with_consumer'
+gems/karafka/lib/karafka/admin.rb:55:in `read_topic'
+/mnt/software/Karafka/karafka-web/lib/karafka/web/processing/consumers/state.rb:19:in `current'
+/mnt/software/Karafka/karafka-web/lib/karafka/web/processing/consumers/aggregator.rb:45:in `state'
+/mnt/software/Karafka/karafka-web/lib/karafka/web/processing/consumers/aggregator.rb:38:in `to_json'
+gems/karafka/lib/karafka/processing/strategies/default.rb:136:in `block in handle_shutdown'
+gems/karafka-core/lib/karafka/core/monitoring/notifications.rb:118:in `measure_time_taken'
+gems/karafka-core/lib/karafka/core/monitoring/notifications.rb:94:in `instrument'
+gems/karafka-core/lib/karafka/core/monitoring/monitor.rb:34:in `instrument'
+gems/karafka/lib/karafka/processing/strategies/default.rb:135:in `handle_shutdown'
+gems/karafka/lib/karafka/base_consumer.rb:134:in `on_shutdown'
+gems/karafka/lib/karafka/processing/executor.rb:123:in `shutdown'
+gems/karafka/lib/karafka/processing/jobs/shutdown.rb:18:in `call'
+gems/karafka/lib/karafka/helpers/async.rb:28:in `block in async_call'</code></pre>
+        </div>
+      </div>
+    </div>
+  </div>
 </div>

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

@@ -0,0 +1,4 @@
+<div class="alert alert-light">
+  This Web UI feature is available only to <a target="_blank" href="https://karafka.io/#become-pro">Pro</a>
+  users.
+</div>

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

@@ -3,9 +3,15 @@
     <div class="row">
       <nav>
         <ul class="pagination justify-content-center">
+          <li class="page-item <%= 'disabled' if @current_page <= 1 %>">
+            <a class="page-link" href="<%= current_path(page: 1) %>">
+              <span>&laquo;</span>
+            </a>
+          </li>
+
           <li class="page-item <%= 'disabled' if @current_page <= 1 %>">
             <a class="page-link" href="<%= current_path(page: @current_page - 1) %>">
-              <span>&laquo; Prev</span>
+              <span>&lsaquo; Prev</span>
             </a>
           </li>
 
@@ -17,7 +23,7 @@
 
           <li class="page-item <%= 'disabled' unless @next_page %>">
             <a class="page-link" href="<%= current_path(page: @next_page) %>">
-              <span>Next &raquo;</span>
+              <span>Next &rsaquo;</span>
             </a>
           </li>
         </ul>

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

@@ -37,10 +37,6 @@
           <li>Architecture consultations</li>
         </ul>
 
-        <p class="mb-5">
-          If you were looking for a given process or other real-time information, the state might have changed, and the information you are looking for no longer exists.
-        </p>
-
         <p>
           <a href="<%= root_path %>" class="btn btn-primary">Go Home</a>
           <a href="https://karafka.io/#become-pro" class="btn btn-success" target="_blank">Become Pro!</a>

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

@@ -7,14 +7,5 @@
 </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.
+  To fix this, you need to ensure that the <code>bundle exec karafka-web install</code> runs successfully.
 </p>

data/lib/karafka/web/ui/views/status/info/_components.erb

@@ -13,7 +13,12 @@
   </span>
 
   <span class="badge bg-secondary">
-    karafka core
+    karafka-web
+    <%= @sampler.karafka_web_version %>
+  </span>
+
+  <span class="badge bg-secondary">
+    karafka-core
     <%= @sampler.karafka_core_version %>
   </span>
 

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

@@ -8,7 +8,12 @@
           "status/#{@status.connection.to_s}",
           locals: {
             title: 'Connection to Kafka',
-            description: partial('status/failures/connection')
+            description: partial(
+              "status/#{@status.connection.partial_namespace}/connection",
+              locals: {
+                details: @status.connection.details
+              }
+            )
           }
         )
       %>

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

@@ -0,0 +1 @@
+<%# Expected to be empty. No content on success needed. %>

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

@@ -0,0 +1,11 @@
+<p>
+  High latency detected when connecting to the Kafka cluster from the Web-UI.
+</p>
+
+<p>
+  Kafka is not designed to perform optimally under high network latencies; even when configurations seem appropriate, you may still encounter disconnects and other unexpected issues.
+</p>
+
+<p class="mb-0">
+  It took Web-UI <strong><%= details[:time].round(2) %> ms</strong> to get the cluster info.
+</p>

data/lib/karafka/web/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-web
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2023-06-25 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.40
+        version: 2.1.4
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -67,7 +67,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.40
+        version: 2.1.4
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -77,7 +77,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.13
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -87,7 +87,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.12
+        version: 2.0.13
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -97,14 +97,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.63'
+        version: '3.68'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.68'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.63'
+        version: '3.68'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.68'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -171,7 +177,6 @@ files:
 - lib/karafka/web/processing/consumer.rb
 - lib/karafka/web/processing/consumers/aggregator.rb
 - lib/karafka/web/processing/consumers/state.rb
-- lib/karafka/web/tracking/base_contract.rb
 - lib/karafka/web/tracking/consumers/contracts/consumer_group.rb
 - lib/karafka/web/tracking/consumers/contracts/job.rb
 - lib/karafka/web/tracking/consumers/contracts/partition.rb
@@ -185,9 +190,17 @@ files:
 - lib/karafka/web/tracking/consumers/listeners/statistics.rb
 - lib/karafka/web/tracking/consumers/listeners/status.rb
 - lib/karafka/web/tracking/consumers/listeners/tags.rb
+- lib/karafka/web/tracking/consumers/reporter.rb
 - lib/karafka/web/tracking/consumers/sampler.rb
+- lib/karafka/web/tracking/contracts/base.rb
+- lib/karafka/web/tracking/contracts/error.rb
+- lib/karafka/web/tracking/helpers/error_info.rb
 - lib/karafka/web/tracking/memoized_shell.rb
-- lib/karafka/web/tracking/reporter.rb
+- lib/karafka/web/tracking/producers/listeners/base.rb
+- lib/karafka/web/tracking/producers/listeners/errors.rb
+- lib/karafka/web/tracking/producers/listeners/reporter.rb
+- lib/karafka/web/tracking/producers/reporter.rb
+- lib/karafka/web/tracking/producers/sampler.rb
 - lib/karafka/web/tracking/sampler.rb
 - lib/karafka/web/tracking/ttl_array.rb
 - lib/karafka/web/tracking/ttl_hash.rb
@@ -207,6 +220,7 @@ files:
 - lib/karafka/web/ui/lib/hash_proxy.rb
 - lib/karafka/web/ui/lib/paginate_array.rb
 - lib/karafka/web/ui/models/consumer_group.rb
+- lib/karafka/web/ui/models/counters.rb
 - lib/karafka/web/ui/models/health.rb
 - lib/karafka/web/ui/models/job.rb
 - lib/karafka/web/ui/models/message.rb
@@ -231,7 +245,6 @@ files:
 - 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
-- lib/karafka/web/ui/pro/views/consumers/_summary.erb
 - lib/karafka/web/ui/pro/views/consumers/consumer/_consumer_group.erb
 - lib/karafka/web/ui/pro/views/consumers/consumer/_job.erb
 - lib/karafka/web/ui/pro/views/consumers/consumer/_metrics.erb
@@ -249,10 +262,7 @@ files:
 - lib/karafka/web/ui/pro/views/dlq/_topic.erb
 - lib/karafka/web/ui/pro/views/dlq/index.erb
 - lib/karafka/web/ui/pro/views/errors/_breadcrumbs.erb
-- lib/karafka/web/ui/pro/views/errors/_cleaned.erb
-- lib/karafka/web/ui/pro/views/errors/_detail.erb
 - lib/karafka/web/ui/pro/views/errors/_error.erb
-- lib/karafka/web/ui/pro/views/errors/_no_errors.erb
 - lib/karafka/web/ui/pro/views/errors/_partition_option.erb
 - lib/karafka/web/ui/pro/views/errors/index.erb
 - lib/karafka/web/ui/pro/views/errors/show.erb
@@ -273,7 +283,6 @@ files:
 - lib/karafka/web/ui/pro/views/health/_breadcrumbs.erb
 - lib/karafka/web/ui/pro/views/health/_partition.erb
 - lib/karafka/web/ui/pro/views/health/index.erb
-- lib/karafka/web/ui/pro/views/jobs/_breadcrumbs.erb
 - lib/karafka/web/ui/pro/views/jobs/_job.erb
 - lib/karafka/web/ui/pro/views/jobs/_no_jobs.erb
 - lib/karafka/web/ui/pro/views/jobs/index.erb
@@ -293,9 +302,9 @@ files:
 - lib/karafka/web/ui/views/cluster/_broker.erb
 - lib/karafka/web/ui/views/cluster/_partition.erb
 - lib/karafka/web/ui/views/cluster/index.erb
-- lib/karafka/web/ui/views/consumers/_breadcrumbs.erb
 - lib/karafka/web/ui/views/consumers/_consumer.erb
 - lib/karafka/web/ui/views/consumers/_counters.erb
+- lib/karafka/web/ui/views/consumers/_no_consumers.erb
 - lib/karafka/web/ui/views/consumers/_summary.erb
 - lib/karafka/web/ui/views/consumers/index.erb
 - lib/karafka/web/ui/views/errors/_breadcrumbs.erb
@@ -320,6 +329,7 @@ files:
 - lib/karafka/web/ui/views/shared/_become_pro.erb
 - lib/karafka/web/ui/views/shared/_brand.erb
 - lib/karafka/web/ui/views/shared/_content.erb
+- lib/karafka/web/ui/views/shared/_feature_pro.erb
 - lib/karafka/web/ui/views/shared/_header.erb
 - lib/karafka/web/ui/views/shared/_navigation.erb
 - lib/karafka/web/ui/views/shared/_pagination.erb
@@ -339,6 +349,8 @@ files:
 - lib/karafka/web/ui/views/status/failures/_topics.erb
 - lib/karafka/web/ui/views/status/info/_components.erb
 - lib/karafka/web/ui/views/status/show.erb
+- lib/karafka/web/ui/views/status/successes/_connection.erb
+- lib/karafka/web/ui/views/status/warnings/_connection.erb
 - lib/karafka/web/ui/views/status/warnings/_pro_subscription.erb
 - lib/karafka/web/version.rb
 - renovate.json

data/lib/karafka/web/tracking/base_contract.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Web
-    module Tracking
-      # Base for all the metric related contracts
-      class BaseContract < ::Karafka::Core::Contractable::Contract
-        class << self
-          # This layer is not for users extensive feedback, thus we can easily use the minimum
-          # error messaging there is.
-          def configure
-            super do |config|
-              config.error_messages = YAML.safe_load(
-                File.read(
-                  File.join(Karafka::Web.gem_root, 'config', 'locales', 'errors.yml')
-                )
-              ).fetch('en').fetch('validations').fetch('web')
-            end
-          end
-        end
-
-        # @param data [Hash] data for validation
-        # @return [Boolean] true if all good
-        # @raise [Errors::ContractError] invalid report
-        def validate!(data)
-          super(data, Errors::Tracking::ContractError)
-        end
-      end
-    end
-  end
-end