karafka-web 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f0eb0ab715c86da7538f8c83f3caa648f36663437ec1895c4a14fcd51d350d5
-  data.tar.gz: c40f2936ea80c059e94c9d911ad8765859fd737d90d12a43490feb5b1b2c4282
+  metadata.gz: 1b6f97a725c2cd9e8458d8b4a32a347e42898e1f5598b3998a460e063fc0b149
+  data.tar.gz: 4a8762c41fa42f5e9c75380ce098423acd72db1720dbf412fd33cb412efc3855
 SHA512:
-  metadata.gz: dcb9e83ad553937ff1de9c760d38e599de491a6866112c0ea55ba944d985026736392981c74e5c1d4b0e3c19157f6759b4deca8281c3a3ef5301724e51a79d6b
-  data.tar.gz: aa56092d3ea42cb02880f4caa32a1e741a989ccdc9491e65c7d787dd68cd713758df3dc06475de217b277f6bcde794a67047c5107ca5d127834bf90b4007ad42
+  metadata.gz: b1899bee43d1597e59755ce9f148b817e2c69c3b1b76ee7c6058aef2fc4a985f057b50c26bd000cc121c3cf73c694f906a92a85885e2d5337630ed728ba3e1a1
+  data.tar.gz: aaca8f979aa93075cceb315f25be6ca98dcde650a6302cca3b4d134df7159210996c71010be28043cb673d0ec54a8a54f5c058ec3f83d30a3d343c230de1a4cb

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Karafka Web changelog
 
+## 0.3.1 (2023-03-27)
+- [Fix] Add missing retention policy for states topic.
+- [Fix] Fix display of compacted messages placeholders for offsets lower than low watermark.
+- [Fix] Fix invalid pagination per page count.
+
+### Upgrade notes
+
+If upgrading from `0.3.0`, nothing.
+
+If upgrading from lower, please follow `0.3.0` upgrade procedure.
+
+## 0.3.0 (2023-03-27)
+- **[Feature]** Support paginating over compacted topics partitions.
+- [Improvement] Display watermark offsets in the errors view.
+- [Improvement] Display informative message when partition is empty due to a retention policy.
+- [Improvement] Display informative message when partition is empty instead of displaying nothing.
+- [Improvement] Display current watermark offsets in the Explorer when viewing list of messages from a given partition.
+- [Improvement] Report extra debug info in the status section.
+- [Improvement] Report not only `Karafka` and `WaterDrop` versions but also `Karafka::Core`, `Rdkafka` and `librdkafka` versions.
+- [Improvement] Small CSS improvements.
+- [Improvement] Provide nicer info when errors topic does not contain any errors or was compacted.
+- [Improvement] Improve listing of errors including compacted once.
+- [Fix] Fix pagination for compacted indexes that would display despite no data being available below the low watermark offset.
+- [Fix] Fix a case where reading from a compacted offset would return no data despite data being available.
+- [Fix] Fix a case where explorer pagination would suggest more pages for compacted topics.
+- [Fix] Fix incorrect support of compacted partitions and partitions with low watermark offset other than 0.
+- [Fix] Display `N/A` instead of `-1` and `-1001` on lag stored and stored offset for consumer processes that did not mark any messages as consumed yet in the per consumer view.
+- [Maintenance] Remove compatibility fallbacks for job and process tags (#1342)
+- [Maintenance] Extract base sampler for tracking and web.
+
+### Upgrade notes
+
+Because of the removal of compatibility fallbacks for some metrics fetches, it is recommended to:
+
+- First, deploy **all** the Karafka consumer processes (`karafka server`)
+- Deploy the Web update to your web server.
+
+Please note that if you decide to use the updated Web UI with not updated consumers, you may hit a 500 error.
+
 ## 0.2.5 (2023-03-17)
 - [Fix] Critical instrumentation async errors intercepted by Web don't have JID for job removal (#1366)
 

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.2.5)
+    karafka-web (0.3.1)
       erubi (~> 1.4)
-      karafka (>= 2.0.35, < 3.0.0)
+      karafka (>= 2.0.38, < 3.0.0)
       karafka-core (>= 2.0.12, < 3.0.0)
       roda (~> 3.63)
       tilt (~> 2.0)
@@ -26,7 +26,7 @@ GEM
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    karafka (2.0.35)
+    karafka (2.0.38)
       karafka-core (>= 2.0.12, < 3.0.0)
       thor (>= 0.20)
       waterdrop (>= 2.4.10, < 3.0.0)

data/karafka-web.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.licenses    = %w[LGPL-3.0 Commercial]
 
   spec.add_dependency 'erubi', '~> 1.4'
-  spec.add_dependency 'karafka', '>= 2.0.35', '< 3.0.0'
+  spec.add_dependency 'karafka', '>= 2.0.38', '< 3.0.0'
   spec.add_dependency 'karafka-core', '>= 2.0.12', '< 3.0.0'
   spec.add_dependency 'roda', '~> 3.63'
   spec.add_dependency 'tilt', '~> 2.0'

data/lib/karafka/web/installer.rb

@@ -102,8 +102,13 @@ module Karafka
             consumers_states_topic,
             1,
             replication_factor,
-            # We care only about the most recent state, previous are irrelevant
-            { 'cleanup.policy': 'compact' }
+            # We care only about the most recent state, previous are irrelevant. So we can easily
+            # compact after one minute. We do not use this beyond the most recent collective
+            # state, hence it all can easily go away.
+            {
+              'cleanup.policy': 'compact',
+              'retention.ms': 60 * 60 * 1_000
+            }
           )
         end
 

data/lib/karafka/web/tracking/consumers/sampler.rb

@@ -6,7 +6,7 @@ module Karafka
       # Namespace for all the things related to tracking consumers and consuming processes
       module Consumers
         # Samples for fetching and storing metrics samples about the consumer process
-        class Sampler
+        class Sampler < Tracking::Sampler
           include ::Karafka::Core::Helpers::Time
 
           attr_reader :counters, :consumer_groups, :errors, :times, :pauses, :jobs
@@ -14,7 +14,7 @@ module Karafka
           # Current schema version
           # This can be used in the future for detecting incompatible changes and writing
           # migrations
-          SCHEMA_VERSION = '1.0.1'
+          SCHEMA_VERSION = '1.0.2'
 
           # 60 seconds window for time tracked window-based metrics
           TIMES_TTL = 60
@@ -25,6 +25,8 @@ module Karafka
           private_constant :TIMES_TTL, :TIMES_TTL_MS, :SCHEMA_VERSION
 
           def initialize
+            super
+
             @counters = {
               batches: 0,
               messages: 0,
@@ -72,8 +74,11 @@ module Karafka
 
               versions: {
                 ruby: ruby_version,
-                karafka: ::Karafka::VERSION,
-                waterdrop: ::WaterDrop::VERSION
+                karafka: karafka_version,
+                waterdrop: waterdrop_version,
+                karafka_core: karafka_core_version,
+                rdkafka: rdkafka_version,
+                librdkafka: librdkafka_version
               },
 
               stats: jobs_queue_statistics.merge(
@@ -118,11 +123,6 @@ module Karafka
             Karafka::Server.listeners&.count.to_i
           end
 
-          # @return [String] Unique process name
-          def process_name
-            @process_name ||= "#{Socket.gethostname}:#{::Process.pid}:#{SecureRandom.hex(6)}"
-          end
-
           # @return [Integer] memory used by this process in kilobytes
           def memory_usage
             pid = ::Process.pid
@@ -210,19 +210,6 @@ module Karafka
             @cpu_count ||= Etc.nprocessors
           end
 
-          # @return [String] currently used ruby version with details
-          def ruby_version
-            if defined?(JRUBY_VERSION)
-              revision = JRUBY_REVISION.to_s
-              version = JRUBY_VERSION
-            else
-              revision = RUBY_REVISION.to_s
-              version = RUBY_ENGINE_VERSION
-            end
-
-            "#{RUBY_ENGINE} #{version}-#{RUBY_PATCHLEVEL} #{revision[0..5]}"
-          end
-
           # @return [Integer] number of threads that process work
           def concurrency
             @concurrency ||= Karafka::App.config.concurrency

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Tracking
+      # Base sampler with some basic info collectors
+      # This sampler should store **only** collectors that can be used for producers, consumers and
+      # the Web-UI itself. All specific to a given aspect of operations should be moved out.
+      class Sampler
+        # @return [String] Unique process name
+        def process_name
+          @process_name ||= "#{Socket.gethostname}:#{::Process.pid}:#{SecureRandom.hex(6)}"
+        end
+
+        # @return [String] currently used ruby version with details
+        def ruby_version
+          return @ruby_version if @ruby_version
+
+          if defined?(JRUBY_VERSION)
+            revision = JRUBY_REVISION.to_s
+            version = JRUBY_VERSION
+          else
+            revision = RUBY_REVISION.to_s
+            version = RUBY_ENGINE_VERSION
+          end
+
+          @ruby_version = "#{RUBY_ENGINE} #{version}-#{RUBY_PATCHLEVEL} #{revision[0..5]}"
+        end
+
+        # @return [String] Karafka version
+        def karafka_version
+          ::Karafka::VERSION
+        end
+
+        # @return [String] Karafka::Core version
+        def karafka_core_version
+          ::Karafka::Core::VERSION
+        end
+
+        # @return [String] rdkafka version
+        def rdkafka_version
+          ::Rdkafka::VERSION
+        end
+
+        # @return [String] librdkafka version
+        def librdkafka_version
+          ::Rdkafka::LIBRDKAFKA_VERSION
+        end
+
+        # @return [String] WaterDrop version
+        def waterdrop_version
+          ::WaterDrop::VERSION
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/ui/controllers/errors.rb

@@ -16,6 +16,8 @@ module Karafka
               @params.current_page
             )
 
+            @watermark_offsets = Ui::Models::WatermarkOffsets.find(errors_topic, 0)
+
             respond
           end
 

data/lib/karafka/web/ui/controllers/status.rb

@@ -13,6 +13,7 @@ module Karafka
           # Displays the Web UI setup status
           def show
             @status = Models::Status.new
+            @sampler = Tracking::Sampler.new
 
             respond
           end

data/lib/karafka/web/ui/models/job.rb

@@ -6,10 +6,6 @@ module Karafka
       module Models
         # Single job data representation model
         class Job < Lib::HashProxy
-          # @return [Array<String>] tags of this consuming job / consumer
-          def tags
-            @hash[:tags] || []
-          end
         end
       end
     end

data/lib/karafka/web/ui/models/message.rb

@@ -38,43 +38,83 @@ module Karafka
             # @return [Array] We return both page data as well as all the details needed to build
             #   the pagination details.
             def page(topic_id, partition_id, page)
-              # Establish the leading offset
-              lead = Karafka::Admin.read_topic(topic_id, partition_id, 1).first
+              low_offset, high_offset = Karafka::Admin.read_watermark_offsets(
+                topic_id,
+                partition_id
+              )
 
               partitions_count = fetch_partition_count(topic_id)
 
+              no_data_result = [false, [], false, partitions_count]
+
               # If there is not even one message, we need to early exit
-              return [false, [], false, partitions_count] unless lead
+              # If low and high watermark offsets are of the same value, it means no data in the
+              # topic is present
+              return no_data_result if low_offset == high_offset
 
               # We add plus one because we compute previous offset from which we want to start and
               # not previous page leading offset
-              previous_offset = lead.offset - (per_page * page) + 1
+              start_offset = high_offset - (per_page * page)
 
-              if previous_offset.negative?
-                count = per_page + previous_offset
+              if start_offset <= low_offset
+                count = per_page - (low_offset - start_offset)
                 previous_page = page < 2 ? false : page - 1
                 next_page = false
-                previous_offset = 0
+                start_offset = low_offset
               else
                 previous_page = page < 2 ? false : page - 1
                 next_page = page + 1
                 count = per_page
               end
 
-              [
-                previous_page,
-                read_topic(topic_id, partition_id, count, previous_offset).reverse,
-                next_page,
-                partitions_count
-              ]
+              # This code is a bit tricky. Since topics can be compacted and certain offsets may
+              # not be present at all, it may happen that we want to read from a non-existing
+              # offset. In case like this we need to catch this error (we do it in `read_topic`)
+              # and we need to move to an offset closer to high offset. This is not fast but it is
+              # an edge case that should not happen often when inspecting real time data. This can
+              # happen more often for heavily compacted topics with short retention but even then
+              # it is ok for 25 elements we usually operate on a single page.
+              count.times do |index|
+                context_offset = start_offset + index
+                # We need to get less if we move up with missing offsets to get exactly
+                # the number we needed
+                context_count = count - index
+
+                messages = read_topic(
+                  topic_id,
+                  partition_id,
+                  context_count,
+                  context_offset,
+                  # We do not reset the offset here because we are not interested in seeking from
+                  # any offset. We are interested in the indication, that there is no offset of a
+                  # given value so we can try with a more recent one
+                  'auto.offset.reset': 'error'
+                )
+
+                next unless messages
+
+                return [
+                  previous_page,
+                  fill_compacted(messages, context_offset, context_count).reverse,
+                  next_page,
+                  partitions_count
+                ]
+              end
+
+              no_data_result
             end
 
             private
 
             # @param args [Object] anything required by the admin `#read_topic`
-            # @return [Array<Karafka::Messages::Message>] topic partition messages
+            # @return [Array<Karafka::Messages::Message>, false] topic partition messages or false
+            #   in case we hit a non-existing offset
             def read_topic(*args)
               ::Karafka::Admin.read_topic(*args)
+            rescue Rdkafka::RdkafkaError => e
+              return false if e.code == :auto_offset_reset
+
+              raise
             end
 
             # @param topic_id [String] id of the topic
@@ -91,6 +131,23 @@ module Karafka
             def per_page
               ::Karafka::Web.config.ui.per_page
             end
+
+            # Since we paginate with compacted offsets visible but we do not get compacted messages
+            # we need to fill those with  just the missing offset and handle this on the UI.
+            #
+            # @param messages [Array<Karafka::Messages::Message>] selected messages
+            # @param start_offset [Integer] offset of the first message (lowest) that we received
+            # @param count [Integer] how many messages we wanted - we need that to fill spots to
+            #   have exactly the number that was  requested and not more
+            # @return [Array<Karafka::Messages::Message, Integer>] array with gaps filled with the
+            #   missing offset
+            def fill_compacted(messages, start_offset, count)
+              Array.new(count) do |index|
+                messages.find do |message|
+                  (message.offset - start_offset) == index
+                end || start_offset + index
+              end
+            end
           end
         end
       end

data/lib/karafka/web/ui/models/process.rb

@@ -40,13 +40,6 @@ module Karafka
               .sort_by(&:started_at)
           end
 
-          # @return [Array<String>] tags of this consuming process
-          # @note We use direct reference here and a fallback for users that come from the versions
-          #   that did not report tags
-          def tags
-            @hash[:process][:tags] || []
-          end
-
           # @return [Integer] collective lag on this process
           def lag_stored
             consumer_groups

data/lib/karafka/web/ui/models/watermark_offsets.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Ui
+      module Models
+        # Model used for accessing watermark offsets
+        class WatermarkOffsets < Lib::HashProxy
+          class << self
+            # Retrieve watermark offsets for given topic partition
+            #
+            # @param topic_id [String]
+            # @param partition_id [Integer]
+            # @return [WatermarkOffsets]
+            def find(topic_id, partition_id)
+              offsets = ::Karafka::Admin.read_watermark_offsets(topic_id, partition_id)
+
+              new(
+                low: offsets.first,
+                high: offsets.last
+              )
+            end
+          end
+
+          # @return [Boolean] true if given partition never had any messages and is empty
+          def empty?
+            low.zero? && high.zero?
+          end
+
+          # @return [Boolean] true if given partition had data but all of it was removed due
+          #   to log retention and compaction policies
+          def cleaned?
+            !empty? && low == high
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/ui/pro/controllers/errors.rb

@@ -29,6 +29,8 @@ module Karafka
                   @params.current_page
                 )
 
+              @watermark_offsets = Ui::Models::WatermarkOffsets.find(errors_topic, @partition_id)
+
               respond
             end
 
@@ -38,7 +40,6 @@ module Karafka
             # @param offset [Integer]
             def show(partition_id, offset)
               errors_topic = ::Karafka::Web.config.topics.errors
-
               @partition_id = partition_id
               @offset = offset
               @error_message = Models::Message.find(

data/lib/karafka/web/ui/pro/controllers/explorer.rb

@@ -36,6 +36,9 @@ module Karafka
             def partition(topic_id, partition_id)
               @topic_id = topic_id
               @partition_id = partition_id
+
+              @watermark_offsets = Ui::Models::WatermarkOffsets.find(topic_id, partition_id)
+
               @previous_page, @messages, @next_page, @partitions_count = Ui::Models::Message.page(
                 @topic_id,
                 @partition_id,

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

@@ -102,27 +102,35 @@
         <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 class="card-text text-center">
+              <span class="badge bg-secondary">
+                <%= @process.ruby %>
+              </span>
+
+              <span class="badge bg-secondary">
+                karafka
+                <%= @process.karafka %>
+              </span>
+
+              <span class="badge bg-secondary">
+                karafka core
+                <%= @process.karafka_core %>
+              </span>
+
+              <span class="badge bg-secondary">
+                rdkafka
+                <%= @process.rdkafka %>
+              </span>
+
+              <span class="badge bg-secondary">
+                librdkafka
+                <%= @process.librdkafka %>
+              </span>
+
+              <span class="badge bg-secondary">
+                waterdrop
+                <%= @process.waterdrop %>
+              </span>
             </p>
           </div>
         </div>

data/lib/karafka/web/ui/pro/views/consumers/consumer/_partition.erb

@@ -6,7 +6,13 @@
     <%= partition.id %>
   </td>
   <td>
-    <%= partition.lag_stored %>
+    <% if partition.lag_stored.to_i < 0 %>
+      <span class="badge bg-secondary" title="Not available until first offset commit">
+        N/A
+      </span>
+    <% else %>
+      <%= partition.lag_stored %>
+    <% end %>
   </td>
   <td>
     <span class="badge <%= lag_trend_bg(partition.lag_stored_d) %>">
@@ -17,7 +23,13 @@
     <%= partition.committed_offset %>
   </td>
   <td>
-    <%= partition.stored_offset %>
+    <% if partition.stored_offset.to_i < 0 %>
+      <span class="badge bg-secondary" title="Not available until first offset commit">
+        N/A
+      </span>
+    <% else %>
+      <%= partition.stored_offset %>
+    <% end %>
   </td>
   <td>
     <span class="badge <%= kafka_state_bg(partition.fetch_state) %> mt-1 mb-1">

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

@@ -0,0 +1,3 @@
+<div class="alert alert-info" role="alert">
+  This errors topic partition had all of its errored compacted and cleaned.
+</div>

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

@@ -1,26 +1,34 @@
-<% error = error_msg.payload %>
+<% if error_msg.is_a?(Integer) %>
+  <tr>
+    <td colspan="5" class="text-center text-muted">
+      This error has either been removed or compacted and is no longer available.
+    </td>
+  </tr>
+<% else %>
+  <% error = error_msg.payload %>
 
-<tr>
-  <td>
-    <% if error[:details].key?(:topic) %>
-      <%= error[:details][:topic] %>: <%= error[:details][:partition] %>
-    <% else %>
-      <%= error[:type] %>
-    <% end %>
-  </td>
-  <td>
-    <%== error[:process_name] %>
-  </td>
-  <td>
-    <%= error[:error_class] %>:
-    <%= error[:error_message].first(200) %>
-  </td>
-  <td>
-    <%== relative_time error[:occurred_at] %>
-  </td>
-  <td>
-    <a href="<%= root_path('errors', error_msg.partition, error_msg.offset) %>" class="btn btn-sm btn-secondary text-white">
-      Details
-    </a>
-  </td>
-</tr>
+  <tr>
+    <td>
+      <% if error[:details].key?(:topic) %>
+        <%= error[:details][:topic] %>: <%= error[:details][:partition] %>
+      <% else %>
+        <%= error[:type] %>
+      <% end %>
+    </td>
+    <td>
+      <%== error[:process_name] %>
+    </td>
+    <td>
+      <%= error[:error_class] %>:
+      <%= error[:error_message].first(200) %>
+    </td>
+    <td>
+      <%== relative_time error[:occurred_at] %>
+    </td>
+    <td class="text-center">
+      <a href="<%= root_path('errors', error_msg.partition, error_msg.offset) %>" class="btn btn-sm btn-secondary text-white">
+        Details
+      </a>
+    </td>
+  </tr>
+<% end %>

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

@@ -0,0 +1,3 @@
+<div class="alert alert-info" role="alert">
+  There are no errors in this errors topic partition.
+</div>

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

@@ -1,4 +1,4 @@
-<div class="container mb-5">
+<div class="container mb-4">
   <div class="row">
     <div class="col">
       <h3>
@@ -33,26 +33,34 @@
 <div class="container">
   <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>Origin</th>
-            <th>Process name</th>
-            <th>Error</th>
-            <th>Occurred at</th>
-            <th></th>
-          </tr>
-        </thead>
-        <tbody>
-          <%==
-            each_partial(
-              @error_messages,
-              'errors/error',
-              local: :error_msg
-            )
-          %>
-        </tbody>
-      </table>
+      <%== partial('explorer/partition/watermark_offsets') %>
+
+      <% if @watermark_offsets.empty? %>
+        <%== partial 'errors/no_errors' %>
+      <% elsif @watermark_offsets.cleaned? %>
+        <%== partial 'errors/cleaned' %>
+      <% else %>
+        <table class="processes bg-white table table-hover table-bordered table-striped mb-0 align-middle">
+          <thead>
+            <tr class="align-middle">
+              <th>Origin</th>
+              <th>Process name</th>
+              <th>Error</th>
+              <th>Occurred at</th>
+              <th></th>
+            </tr>
+          </thead>
+          <tbody>
+            <%==
+              each_partial(
+                @error_messages,
+                'errors/error',
+                local: :error_msg
+              )
+            %>
+          </tbody>
+        </table>
+      <% end %>
     </div>
   </div>
 </div>

data/lib/karafka/web/ui/pro/views/explorer/_message.erb

@@ -1,16 +1,27 @@
-<tr>
-  <td>
-    <%= message.offset %>
-  </td>
-  <td>
-    <%== relative_time message.timestamp %>
-  </td>
-  <td>
-    <%= message.key %>
-  </td>
-  <td class="text-center">
-    <a href="<%= root_path('explorer', message.topic, message.partition, message.offset) %>" class="btn btn-sm btn-secondary">
-      Details
-    </a>
-  </td>
-</tr>
+<% if message.is_a?(Integer) %>
+  <tr>
+    <td class="text-muted">
+      <%= message %>
+    </td>
+    <td colspan="3" class="text-center text-muted">
+      This message has either been removed or compacted and is no longer available.
+    </td>
+  </tr>
+<% else %>
+  <tr>
+    <td>
+      <%= message.offset %>
+    </td>
+    <td>
+      <%== relative_time message.timestamp %>
+    </td>
+    <td>
+      <%= message.key %>
+    </td>
+    <td class="text-center">
+      <a href="<%= root_path('explorer', message.topic, message.partition, message.offset) %>" class="btn btn-sm btn-secondary">
+        Details
+      </a>
+    </td>
+  </tr>
+<% end %>

data/lib/karafka/web/ui/pro/views/explorer/partition/_cleaned.erb

@@ -0,0 +1,3 @@
+<div class="alert alert-info mt-4" role="alert">
+  This partition no longer contains any data and has been fully compacted.
+</div>

data/lib/karafka/web/ui/pro/views/explorer/partition/_empty.erb

@@ -0,0 +1,3 @@
+<div class="alert alert-info mt-4" role="alert">
+  This partition is empty and does not contain any data.
+</div>

data/lib/karafka/web/ui/pro/views/explorer/partition/_messages.erb

@@ -0,0 +1,18 @@
+<table class="processes bg-white table table-hover table-bordered table-striped mb-0 align-middle">
+  <thead>
+    <tr class="align-middle">
+      <th>Offset</th>
+      <th>Timestamp</th>
+      <th>Key</th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <%==
+      each_partial(
+        @messages,
+        'explorer/message'
+      )
+    %>
+  </tbody>
+</table>

data/lib/karafka/web/ui/pro/views/explorer/partition/_watermark_offsets.erb

@@ -0,0 +1,10 @@
+<p class="text-end mb-4">
+  Watermark offsets:
+  <span class="badge bg-secondary mt-1 mb-1">
+    high: <%= @watermark_offsets.high %>
+  </span>
+
+  <span class="badge bg-secondary mt-1 mb-1">
+    low: <%= @watermark_offsets.low %>
+  </span>
+</p>

data/lib/karafka/web/ui/pro/views/explorer/partition.erb

@@ -1,4 +1,4 @@
-<div class="container mb-5">
+<div class="container mb-4">
   <div class="row">
     <div class="col">
       <h3>
@@ -33,24 +33,15 @@
 <div class="container">
   <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>Offset</th>
-            <th>Timestamp</th>
-            <th>Key</th>
-            <th></th>
-          </tr>
-        </thead>
-        <tbody>
-          <%==
-            each_partial(
-              @messages,
-              'explorer/message'
-            )
-          %>
-        </tbody>
-      </table>
+      <%== partial('explorer/partition/watermark_offsets') %>
+
+      <% if @watermark_offsets.empty? %>
+        <%== partial 'explorer/partition/empty' %>
+      <% elsif @watermark_offsets.cleaned? %>
+        <%== partial 'explorer/partition/cleaned' %>
+      <% else %>
+        <%== partial('explorer/partition/messages') %>
+      <% end %>
     </div>
   </div>
 </div>

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

@@ -104,3 +104,7 @@ code.wrapped {
 #content .error-message {
   max-width: 700px;
 }
+
+#metrics ul {
+  padding-left: 0;
+}

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

@@ -0,0 +1,3 @@
+<div class="alert alert-info" role="alert">
+  This errors topic partition had all of its errored compacted and cleaned.
+</div>

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

@@ -1,26 +1,34 @@
-<% error = error_msg.payload %>
+<% if error_msg.is_a?(Integer) %>
+  <tr>
+    <td colspan="5" class="text-center text-muted">
+      This error has either been removed or compacted and is no longer available.
+    </td>
+  </tr>
+<% else %>
+  <% error = error_msg.payload %>
 
-<tr>
-  <td>
-    <% if error[:details].key?(:topic) %>
-      <%= error[:details][:topic] %>: <%= error[:details][:partition] %>
-    <% else %>
-      <%= error[:type] %>
-    <% end %>
-  </td>
-  <td>
-    <%== error[:process_name] %>
-  </td>
-  <td>
-    <%= error[:error_class] %>:
-    <%= error[:error_message].first(200) %>
-  </td>
-  <td>
-    <%== relative_time error[:occurred_at] %>
-  </td>
-  <td>
-    <a href="<%= root_path('errors', error_msg.offset) %>" class="btn btn-sm btn-secondary text-white">
-      Details
-    </a>
-  </td>
-</tr>
+  <tr>
+    <td>
+      <% if error[:details].key?(:topic) %>
+        <%= error[:details][:topic] %>: <%= error[:details][:partition] %>
+      <% else %>
+        <%= error[:type] %>
+      <% end %>
+    </td>
+    <td>
+      <%== error[:process_name] %>
+    </td>
+    <td>
+      <%= error[:error_class] %>:
+      <%= error[:error_message].first(200) %>
+    </td>
+    <td>
+      <%== relative_time error[:occurred_at] %>
+    </td>
+    <td class="text-center">
+      <a href="<%= root_path('errors', error_msg.offset) %>" class="btn btn-sm btn-secondary text-white">
+        Details
+      </a>
+    </td>
+  </tr>
+<% end %>

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

@@ -0,0 +1,3 @@
+<div class="alert alert-info" role="alert">
+  There are no errors in this errors topic partition.
+</div>

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

@@ -0,0 +1,10 @@
+<p class="text-end mb-4">
+  Watermark offsets:
+  <span class="badge bg-secondary mt-1 mb-1">
+    high: <%= @watermark_offsets.high %>
+  </span>
+
+  <span class="badge bg-secondary mt-1 mb-1">
+    low: <%= @watermark_offsets.low %>
+  </span>
+</p>

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

@@ -1,4 +1,4 @@
-<div class="container mb-5">
+<div class="container mb-4">
   <div class="row">
     <div class="col">
       <h3>
@@ -13,26 +13,34 @@
 <div class="container">
   <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>Origin</th>
-            <th>Process name</th>
-            <th>Error</th>
-            <th>Occurred at</th>
-            <th></th>
-          </tr>
-        </thead>
-        <tbody>
-          <%==
-            each_partial(
-              @error_messages,
-              'errors/error',
-              local: :error_msg
-            )
-          %>
-        </tbody>
-      </table>
+      <%== partial('errors/watermark_offsets') %>
+
+      <% if @watermark_offsets.empty? %>
+        <%== partial 'errors/no_errors' %>
+      <% elsif @watermark_offsets.cleaned? %>
+        <%== partial 'errors/cleaned' %>
+      <% else %>
+        <table class="processes bg-white table table-hover table-bordered table-striped mb-0 align-middle">
+          <thead>
+            <tr class="align-middle">
+              <th>Origin</th>
+              <th>Process name</th>
+              <th>Error</th>
+              <th>Occurred at</th>
+              <th></th>
+            </tr>
+          </thead>
+          <tbody>
+            <%==
+              each_partial(
+                @error_messages,
+                'errors/error',
+                local: :error_msg
+              )
+            %>
+          </tbody>
+        </table>
+      <% end %>
     </div>
   </div>
 </div>

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

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

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

@@ -0,0 +1,34 @@
+<p>
+  Below you can find information about your setup. This can be helpful when debugging or reporting bugs and issues.
+</p>
+
+<p class="mb-0">
+  <span class="badge bg-secondary">
+    <%= @sampler.ruby_version %>
+  </span>
+
+  <span class="badge bg-secondary">
+    karafka
+    <%= @sampler.karafka_version %>
+  </span>
+
+  <span class="badge bg-secondary">
+    karafka core
+    <%= @sampler.karafka_core_version %>
+  </span>
+
+  <span class="badge bg-secondary">
+    rdkafka
+    <%= @sampler.rdkafka_version %>
+  </span>
+
+  <span class="badge bg-secondary">
+    librdkafka
+    <%= @sampler.librdkafka_version %>
+  </span>
+
+  <span class="badge bg-secondary">
+    waterdrop
+    <%= @sampler.waterdrop_version %>
+  </span>
+</p>

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

@@ -3,7 +3,6 @@
 <div class="container mb-5">
   <div class="row">
     <div class="col-lg-10 offset-md-1">
-
       <%==
         partial(
           "status/#{@status.connection.to_s}",
@@ -104,6 +103,15 @@
         )
       %>
 
+      <%==
+        partial(
+          'status/info',
+          locals: {
+            title: 'Components info',
+            description: partial('status/info/components')
+          }
+        )
+      %>
     </div>
   </div>
 </div>

data/lib/karafka/web/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-web
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-03-27 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.35
+        version: 2.0.38
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -67,7 +67,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.35
+        version: 2.0.38
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -186,6 +186,7 @@ files:
 - lib/karafka/web/tracking/consumers/sampler.rb
 - lib/karafka/web/tracking/memoized_shell.rb
 - lib/karafka/web/tracking/reporter.rb
+- lib/karafka/web/tracking/sampler.rb
 - lib/karafka/web/tracking/ttl_array.rb
 - lib/karafka/web/tracking/ttl_hash.rb
 - lib/karafka/web/ui/app.rb
@@ -213,6 +214,7 @@ files:
 - 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/models/watermark_offsets.rb
 - lib/karafka/web/ui/pro/app.rb
 - lib/karafka/web/ui/pro/controllers/cluster.rb
 - lib/karafka/web/ui/pro/controllers/consumers.rb
@@ -243,8 +245,10 @@ 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
@@ -257,6 +261,10 @@ files:
 - lib/karafka/web/ui/pro/views/explorer/_topic.erb
 - lib/karafka/web/ui/pro/views/explorer/index.erb
 - lib/karafka/web/ui/pro/views/explorer/partition.erb
+- lib/karafka/web/ui/pro/views/explorer/partition/_cleaned.erb
+- lib/karafka/web/ui/pro/views/explorer/partition/_empty.erb
+- lib/karafka/web/ui/pro/views/explorer/partition/_messages.erb
+- lib/karafka/web/ui/pro/views/explorer/partition/_watermark_offsets.erb
 - lib/karafka/web/ui/pro/views/explorer/show.erb
 - lib/karafka/web/ui/pro/views/health/_breadcrumbs.erb
 - lib/karafka/web/ui/pro/views/health/_partition.erb
@@ -287,8 +295,11 @@ files:
 - lib/karafka/web/ui/views/consumers/_summary.erb
 - lib/karafka/web/ui/views/consumers/index.erb
 - lib/karafka/web/ui/views/errors/_breadcrumbs.erb
+- lib/karafka/web/ui/views/errors/_cleaned.erb
 - lib/karafka/web/ui/views/errors/_detail.erb
 - lib/karafka/web/ui/views/errors/_error.erb
+- lib/karafka/web/ui/views/errors/_no_errors.erb
+- lib/karafka/web/ui/views/errors/_watermark_offsets.erb
 - lib/karafka/web/ui/views/errors/index.erb
 - lib/karafka/web/ui/views/errors/show.erb
 - lib/karafka/web/ui/views/jobs/_breadcrumbs.erb
@@ -313,6 +324,7 @@ files:
 - 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/_info.erb
 - lib/karafka/web/ui/views/status/_success.erb
 - lib/karafka/web/ui/views/status/_warning.erb
 - lib/karafka/web/ui/views/status/failures/_connection.erb
@@ -321,6 +333,7 @@ files:
 - 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/info/_components.erb
 - lib/karafka/web/ui/views/status/show.erb
 - lib/karafka/web/ui/views/status/warnings/_pro_subscription.erb
 - lib/karafka/web/version.rb