karafka-web 0.5.2 → 0.6.1

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

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Web
-    module Tracking
-      # Reports the collected data about the process and sends it, so we can use it in the UI
-      class Reporter
-        include ::Karafka::Core::Helpers::Time
-        include ::Karafka::Helpers::Async
-
-        # Minimum number of messages to produce to produce then in sync mode
-        # This acts as a small back-off not to overload the system in case we would have extremely
-        # big number of errors happening
-        PRODUCE_SYNC_THRESHOLD = 25
-
-        private_constant :PRODUCE_SYNC_THRESHOLD
-
-        # This mutex is shared between tracker and samplers so there is no case where metrics
-        # would be collected same time tracker reports
-        MUTEX = Mutex.new
-
-        def initialize
-          # Move back so first report is dispatched fast to indicate, that the process is alive
-          @tracked_at = monotonic_now - 10_000
-          @consumer_contract = Consumers::Contracts::Report.new
-        end
-
-        # Dispatches the current state from sampler to appropriate topics
-        #
-        # @param forced [Boolean] should we report bypassing the time frequency or should we report
-        #   only in case we would not send the report for long enough time.
-        def report(forced: false)
-          MUTEX.synchronize do
-            # Start background thread only when needed
-            # This prevents us from starting it too early or for non-consumer processes where
-            # Karafka is being included
-            async_call unless @running
-
-            return unless report?(forced)
-
-            @tracked_at = monotonic_now
-
-            consumer_report = consumer_sampler.to_report
-
-            @consumer_contract.validate!(consumer_report)
-
-            process_name = consumer_report[:process][:name]
-
-            # Report consumers statuses
-            messages = [
-              {
-                topic: ::Karafka::Web.config.topics.consumers.reports,
-                payload: consumer_report.to_json,
-                key: process_name,
-                partition: 0
-              }
-            ]
-
-            # Report errors that occurred (if any)
-            messages += consumer_sampler.errors.map do |error|
-              {
-                topic: Karafka::Web.config.topics.errors,
-                payload: error.to_json,
-                # Always dispatch errors from the same process to the same partition
-                key: process_name
-              }
-            end
-
-            produce(messages)
-
-            # Clear the sampler so it tracks new state changes without previous once impacting
-            # the data
-            consumer_sampler.clear
-          end
-        # Since we run this in a background thread, there may be a case upon shutdown, where the
-        # producer is closed right before a potential dispatch. It is not worth dealing with this
-        # and we can just safely ignore this
-        rescue WaterDrop::Errors::ProducerClosedError
-          nil
-        end
-
-        # Reports bypassing frequency check. This can be used to report when state changes in the
-        # process drastically. For example when process is stopping, we want to indicate this as
-        # fast as possible in the UI, etc.
-        def report!
-          report(forced: true)
-        end
-
-        private
-
-        # Reports the process state once in a while
-        def call
-          @running = true
-
-          loop do
-            report
-
-            # We won't track more often anyhow but want to try frequently not to miss a window
-            # We need to convert the sleep interval into seconds for sleep
-            sleep(::Karafka::Web.config.tracking.interval / 1_000 / 10)
-          end
-        end
-
-        # @param forced [Boolean] is this report forced. Forced means that as long as we can flush
-        #   we will flush
-        # @return [Boolean] Should we report or is it not yet time to do so
-        def report?(forced)
-          # We never report in initializing phase because things are not yet fully configured
-          return false if ::Karafka::App.initializing?
-          # We never report in the initialized because server is not yet ready until Karafka is
-          # fully running and some of the things like listeners are not yet available
-          return false if ::Karafka::App.initialized?
-
-          return true if forced
-
-          (monotonic_now - @tracked_at) >= ::Karafka::Web.config.tracking.interval
-        end
-
-        # @return [Object] sampler for the metrics
-        def consumer_sampler
-          @consumer_sampler ||= ::Karafka::Web.config.tracking.consumers.sampler
-        end
-
-        # Produces messages to Kafka.
-        #
-        # @param messages [Array<Hash>]
-        #
-        # @note We pick either sync or async dependent on number of messages. The trick here is,
-        #   that we do not want to end up overloading the internal queue with messages in case
-        #   someone has a lot of errors from processing or other errors. Producing sync will wait
-        #   for the delivery, hence will slow things down a little bit. On the other hand during
-        #   normal operations we should not have that many messages to dispatch and it should not
-        #   slowdown any processing.
-        def produce(messages)
-          if messages.count >= PRODUCE_SYNC_THRESHOLD
-            ::Karafka.producer.produce_many_sync(messages)
-          else
-            ::Karafka.producer.produce_many_async(messages)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/web/ui/pro/views/consumers/_summary.erb

@@ -1,81 +0,0 @@
-<div id="summary" class="container text-center mb-5">
-  <div class="row">
-
-    <div class="col-lg-2 offset-md-1">
-      <div class="card mb-0">
-        <div class="card-body">
-          <p class="card-text">
-            <div class="stat mb-1">
-              <%= @counters.processes %>
-            </div>
-            <div class="desc">
-              Processes
-            </div>
-          </p>
-        </div>
-      </div>
-    </div>
-
-    <div class="col-lg-2">
-      <div class="card mb-0">
-        <div class="card-body">
-          <p class="card-text">
-            <div class="stat mb-1">
-              <%= @counters.threads_count %>
-            </div>
-            <div class="desc">
-              Worker threads
-            </div>
-          </p>
-        </div>
-      </div>
-    </div>
-
-    <div class="col-lg-2">
-      <div class="card mb-0">
-        <div class="card-body">
-          <p class="card-text">
-            <div class="stat mb-1">
-              <%= @counters.listeners_count %>
-            </div>
-            <div class="desc">
-              Listeners
-            </div>
-          </p>
-        </div>
-      </div>
-    </div>
-
-    <div class="col-lg-2">
-      <div class="card mb-0">
-        <div class="card-body">
-          <p class="card-text">
-            <div class="stat mb-1">
-              <%= @counters.utilization.round(2) %>
-              %
-            </div>
-            <div class="desc">
-              Utilization
-            </div>
-          </p>
-        </div>
-      </div>
-    </div>
-
-    <div class="col-lg-2">
-      <div class="card mb-0">
-        <div class="card-body">
-          <p class="card-text">
-            <div class="stat mb-1">
-              <%= format_memory @counters.rss %>
-            </div>
-            <div class="desc">
-              RSS
-            </div>
-          </p>
-        </div>
-      </div>
-    </div>
-
-  </div>
-</div>

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

@@ -1,3 +0,0 @@
-<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/_detail.erb

@@ -1,31 +0,0 @@
-<% if v.is_a?(Hash) %>
-  <% v.each do |k2, v2| %>
-    <tr>
-      <td>
-        <%= "#{k}.#{k2}" %>
-      </td>
-      <td>
-        <% if %w[sasl ssl].any? { |scope| k2.to_s.include?(scope) } %>
-          ***
-        <% elsif k2.to_s == 'tags' %>
-          <%== tags(v2) %>
-        <% else %>
-          <%= v2 %>
-        <% end %>
-      </td>
-    </tr>
-  <% end %>
-<% else %>
-  <tr>
-    <td>
-      <%= k %>
-    </td>
-    <td>
-      <% if k == :occurred_at %>
-        <%== relative_time v %>
-      <% else %>
-        <%= v %>
-      <% end %>
-    </td>
-  </tr>
-<% end %>

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

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

data/lib/karafka/web/ui/pro/views/jobs/_breadcrumbs.erb

@@ -1,5 +0,0 @@
-<li class="breadcrumb-item">
-  <a href="<%= root_path('jobs') %>">
-    Running jobs
-  </a>
-</li>

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

@@ -1,27 +0,0 @@
-<% if @process %>
-  <li class="breadcrumb-item">
-    <a href="<%= root_path('consumers') %>">
-      Consumers
-    </a>
-  </li>
-
-  <li class="breadcrumb-item">
-    <a href="<%= root_path('consumers', @process.id, 'subscriptions') %>">
-      <%= @process.name %>
-    </a>
-  </li>
-
-  <% if current_path.include?('/jobs') %>
-    <li class="breadcrumb-item">
-      <a href="<%= root_path('consumers', @process.id, 'jobs') %>">
-        Running jobs
-      </a>
-    </li>
-  <% else %>
-    <li class="breadcrumb-item">
-      <a href="<%= root_path('consumers', @process.id, 'subscriptions') %>">
-        Active subscriptions
-      </a>
-    </li>
-  <% end %>
-<% end %>