karafka-web 0.7.9 → 0.8.0.rc1

data/lib/karafka/web/management/enable.rb

@@ -1,102 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Web
-    module Management
-      # @note This runs on each process start that has `karafka.rb`. It needs to be executed
-      #   also in the context of other processes types and not only karafka server, because it
-      #   installs producers instrumentation and routing as well.
-      class Enable < Base
-        # Enables routing consumer group and subscribes Web-UI listeners
-        def call
-          extend_routing
-          subscribe_to_monitor
-          subscribe_to_close_web_producer
-        end
-
-        private
-
-        # Enables all the needed routes
-        def extend_routing
-          ::Karafka::App.routes.draw do
-            web_deserializer = ::Karafka::Web::Deserializer.new
-
-            consumer_group ::Karafka::Web.config.processing.consumer_group do
-              # Topic we listen on to materialize the states
-              topic ::Karafka::Web.config.topics.consumers.reports do
-                config(active: false)
-                active ::Karafka::Web.config.processing.active
-                # Since we materialize state in intervals, we can poll for half of this time without
-                # impacting the reporting responsiveness
-                max_wait_time ::Karafka::Web.config.processing.interval / 2
-                max_messages 1_000
-                consumer ::Karafka::Web::Processing::Consumer
-                # This needs to be true in order not to reload the consumer in dev. This consumer
-                # should not be affected by the end user development process
-                consumer_persistence true
-                deserializer web_deserializer
-                manual_offset_management true
-                # Start from the most recent data, do not materialize historical states
-                # This prevents us from dealing with cases, where client id would be changed and
-                # consumer group name would be renamed and we would start consuming all historical
-                initial_offset 'latest'
-              end
-
-              # We define those three here without consumption, so Web understands how to deserialize
-              # them when used / viewed
-              topic ::Karafka::Web.config.topics.consumers.states do
-                config(active: false)
-                active false
-                deserializer web_deserializer
-              end
-
-              topic ::Karafka::Web.config.topics.consumers.metrics do
-                config(active: false)
-                active false
-                deserializer web_deserializer
-              end
-
-              topic ::Karafka::Web.config.topics.errors do
-                config(active: false)
-                active false
-                deserializer web_deserializer
-              end
-            end
-          end
-        end
-
-        # Subscribes with all needed listeners
-        def subscribe_to_monitor
-          # Installs all the consumer related listeners
-          ::Karafka::Web.config.tracking.consumers.listeners.each do |listener|
-            ::Karafka.monitor.subscribe(listener)
-          end
-
-          # Installs all the producer related listeners into Karafka default listener and
-          # into Karafka::Web listener in case it would be different than the Karafka one
-          ::Karafka::Web.config.tracking.producers.listeners.each do |listener|
-            ::Karafka.producer.monitor.subscribe(listener)
-
-            # Do not instrument twice in case only one default producer is used
-            next if ::Karafka.producer == ::Karafka::Web.producer
-
-            ::Karafka::Web.producer.monitor.subscribe(listener)
-          end
-        end
-
-        # In most cases we want to close the producer if possible.
-        # While we cannot do it easily in user processes and we should rely on WaterDrop
-        # finalization logic, we can do it in `karafka server` on terminate
-        #
-        # In other places, this producer anyhow should not be used.
-        def subscribe_to_close_web_producer
-          ::Karafka::App.monitor.subscribe('app.terminated') do
-            # If Web producer is the same as `Karafka.producer` it will do nothing as you can
-            # call `#close` multiple times without side effects
-            ::Karafka::Web.producer.close
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/web/management/extend_boot_file.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Web
-    module Management
-      # Extends the boot file with Web components
-      class ExtendBootFile < Base
-        # Code that is needed in the `karafka.rb` to connect Web UI to Karafka
-        ENABLER_CODE = 'Karafka::Web.enable!'
-
-        # Template with initial Web UI configuration
-        # Session secret needs to be set per user and per env
-        SETUP_TEMPLATE = <<~CONFIG.freeze
-          Karafka::Web.setup do |config|
-            # You may want to set it per ENV. This value was randomly generated.
-            config.ui.sessions.secret = '#{SecureRandom.hex(32)}'
-          end
-
-          #{ENABLER_CODE}
-        CONFIG
-
-        # Adds needed code
-        def call
-          if File.read(Karafka.boot_file).include?(ENABLER_CODE)
-            puts "Web UI #{already} installed."
-          else
-            puts 'Updating the Karafka boot file...'
-            File.open(Karafka.boot_file, 'a') do |f|
-              f << "\n#{SETUP_TEMPLATE}\n"
-            end
-            puts "Karafka boot file #{successfully} updated."
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Web
-    module Tracking
-      # Array that allows us to store data points that expire over time automatically.
-      class TtlArray
-        include ::Karafka::Core::Helpers::Time
-        include Enumerable
-
-        # @param ttl [Integer] milliseconds ttl
-        def initialize(ttl)
-          @ttl = ttl
-          @accu = []
-        end
-
-        # Iterates over only active elements
-        def each
-          clear
-
-          @accu.each do |sample|
-            yield sample[:value]
-          end
-        end
-
-        # @param value [Object] adds value to the array
-        # @return [Object] added element
-        def <<(value)
-          @accu << { value: value, added_at: monotonic_now }
-
-          clear
-
-          value
-        end
-
-        # @return [Boolean] is the array empty
-        def empty?
-          clear
-          @accu.empty?
-        end
-
-        # @return [Array] pure array version with only active elements
-        def to_a
-          clear
-          super
-        end
-
-        private
-
-        # Evicts outdated samples
-        def clear
-          @accu.delete_if do |sample|
-            monotonic_now - sample[:added_at] > @ttl
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Web
-    module Tracking
-      # Hash that accumulates data that has an expiration date (ttl)
-      # Used to keep track of metrics in a window
-      class TtlHash < Hash
-        # @param ttl [Integer] milliseconds ttl
-        def initialize(ttl)
-          super() { |k, v| k[v] = TtlArray.new(ttl) }
-        end
-      end
-    end
-  end
-end

data/lib/karafka/web/ui/pro/views/dashboard/_ranges_selector.erb

@@ -1,39 +0,0 @@
-<div class="container">
-  <div class="row">
-    <div class="col-sm-12 text-end">
-      <div class="btn-group btn-group-sm" role="group" aria-label="Small button group">
-        <%
-          path = root_path('dashboard?range=seconds')
-          active = params.current_range == :seconds ? 'active' : false
-        %>
-        <a type="button" href="<%= path %>" class="btn btn-outline-primary <%= active %>">
-          5 minutes
-        </a>
-
-        <%
-          path = root_path('dashboard?range=minutes')
-          active = params.current_range == :minutes ? 'active' : false
-        %>
-        <a type="button" href="<%= path %>" class="btn btn-outline-primary <%= active %>">
-          1 hour
-        </a>
-
-        <%
-          path = root_path('dashboard?range=hours')
-          active = params.current_range == :hours ? 'active' : false
-        %>
-        <a type="button" href="<%= path %>" class="btn btn-outline-primary <%= active %>">
-          24 hours
-        </a>
-
-        <%
-          path = root_path('dashboard?range=days')
-          active = params.current_range == :days ? 'active' : false
-        %>
-        <a type="button" href="<%= path %>" class="btn btn-outline-primary <%= active %>">
-          7 days
-        </a>
-      </div>
-    </div>
-  </div>
-</div>

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

@@ -1,74 +0,0 @@
-<%== view_title('Cluster informations') %>
-
-<div class="container mb-5">
-  <div class="row mb-3">
-    <div class="col-sm-12">
-      <h4 class="mb-4">
-        Brokers
-      </h4>
-      <hr/>
-    </div>
-  </div>
-
-  <div class="row">
-    <div class="col-lg-12">
-        <table class="processes bg-white table table-hover table-bordered table-striped">
-          <thead>
-            <tr class="align-middle">
-              <th>Broker id</th>
-              <th>Name</th>
-              <th>Port</th>
-            </tr>
-          </thead>
-          <tbody>
-            <%==
-              each_partial(
-                @cluster_info.brokers,
-                'cluster/broker'
-              )
-            %>
-          </tbody>
-        </table>
-    </div>
-  </div>
-</div>
-
-<div class="container mb-5">
-  <div class="row mb-3">
-    <div class="col-sm-12">
-      <h4 class="mb-4">
-        Topics and partitions
-      </h4>
-      <hr/>
-    </div>
-  </div>
-  <div class="row">
-    <div class="col-lg-12">
-      <% if @partitions.empty? && params.current_page <= 1 %>
-        <%== partial 'cluster/no_partitions' %>
-      <% elsif @partitions.empty? %>
-        <%== partial 'shared/no_paginated_data' %>
-      <% else %>
-        <table class="processes bg-white table table-hover table-bordered table-striped">
-          <thead>
-            <tr class="align-middle">
-              <th>Topic name</th>
-              <th>Partition id</th>
-              <th>Leader</th>
-              <th>Replica count</th>
-              <th>In sync brokers</th>
-            </tr>
-          </thead>
-          <tbody>
-            <%==
-              each_partial(
-                @partitions,
-                'cluster/partition'
-              )
-            %>
-          </tbody>
-        </table>
-      <% end %>
-    </div>
-  </div>
-</div>