karafka-web 0.11.5 → 0.11.6

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

@@ -27,7 +27,7 @@ module Karafka
                 # Reading this that way is cheaper than running a shell command
                 when /linux/
                   File.readlines("/proc/#{pid}/status").each do |line|
-                    next unless line.start_with?('VmRSS:')
+                    next unless line.start_with?("VmRSS:")
 
                     break line.split[1].to_i
                   end
@@ -49,7 +49,8 @@ module Karafka
               # This represents system-wide (or container-wide) memory usage by summing RSS
               # across all processes.
               # On bare metal: sums memory for all processes on the host
-              # In containers: sums memory for all processes within the container (due to PID namespace)
+              # In containers: sums memory for all processes within the container
+              #   (due to PID namespace)
               # @note This is DIFFERENT from memory_usage which only shows current process memory
               # @note Used in Web UI to show "OS memory used" metric
               def memory_total_usage(memory_threads_ps)
@@ -69,22 +70,22 @@ module Karafka
                 return @memory_size if instance_variable_defined?(:@memory_size)
 
                 @memory_size = case RUBY_PLATFORM
-                               when /linux/
-                                 mem_info = File.read('/proc/meminfo')
-                                 mem_total_line = mem_info.match(/MemTotal:\s*(?<total>\d+)/)
-                                 mem_total_line['total'].to_i
-                               when /darwin|bsd/
-                                 shell
-                               .call('sysctl -a')
-                               .split("\n")
-                               .find { |line| line.start_with?('hw.memsize:') }
-                               .to_s
-                               .split
-                               .last
-                               .to_i
-                               else
-                                 0
-                               end
+                when /linux/
+                  mem_info = File.read("/proc/meminfo")
+                  mem_total_line = mem_info.match(/MemTotal:\s*(?<total>\d+)/)
+                  mem_total_line["total"].to_i
+                when /darwin|bsd/
+                  shell
+                    .call("sysctl -a")
+                    .split("\n")
+                    .find { |line| line.start_with?("hw.memsize:") }
+                    .to_s
+                    .split
+                    .last
+                    .to_i
+                else
+                  0
+                end
               end
 
               # @return [Array<Float>] load averages for last 1, 5 and 15 minutes
@@ -92,13 +93,13 @@ module Karafka
                 case RUBY_PLATFORM
                 when /linux/
                   File
-                    .read('/proc/loadavg')
+                    .read("/proc/loadavg")
                     .split
                     .first(3)
                     .map(&:to_f)
                 when /darwin|bsd/
                   shell
-                    .call('w | head -1')
+                    .call("w | head -1")
                     .strip
                     .split
                     .map(&:to_f)
@@ -124,10 +125,11 @@ module Karafka
               end
 
               # Loads process information for all running processes
-              # @return [Array<Array<Integer, Integer, Integer>>, false] array of [rss_kb, threads, pid]
-              #   for each process, or false if unavailable
+              # @return [Array<Array<Integer, Integer, Integer>>, false] array of
+              #   [rss_kb, threads, pid] for each process, or false if unavailable
               #
-              # This method reads information about ALL processes on the system (or in the container).
+              # This method reads information about ALL processes on the system
+              # (or in the container).
               # The data is used by multiple metrics:
               # - memory_total_usage: sums RSS across all processes
               # - threads: extracts thread count for current process
@@ -142,10 +144,12 @@ module Karafka
               # - macOS: Uses `ps -A` to get all processes
               # - Containers: Due to PID namespaces, only sees processes within the container
               #
-              # @note Sampler calls this once per sample cycle (every ~5 seconds) and caches the result
-              #   in @memory_threads_ps to ensure consistent data within a single sample snapshot
+              # @note Sampler calls this once per sample cycle (every ~5 seconds) and caches
+              #   the result in @memory_threads_ps to ensure consistent data within a single
+              #   sample snapshot
               # @note The cache is refreshed on EVERY sample cycle, so data stays current
-              # @note On Linux, thread count is only extracted for the current process to optimize performance
+              # @note On Linux, thread count is only extracted for the current process to
+              #   optimize performance
               def memory_threads_ps
                 case RUBY_PLATFORM
                 when /linux/
@@ -153,27 +157,27 @@ module Karafka
                   current_pid = ::Process.pid
 
                   # Read all processes from /proc
-                  Dir.glob('/proc/[0-9]*/statm').filter_map do |statm_file|
+                  Dir.glob("/proc/[0-9]*/statm").filter_map do |statm_file|
                     pid = statm_file.match(%r{/proc/(\d+)/statm})[1].to_i
                     status_file = "/proc/#{pid}/status"
 
                     # Extract RSS from /proc/<pid>/statm (second field)
                     rss_pages = begin
                       File.read(statm_file).split[1].to_i
-                    rescue StandardError
+                    rescue
                       next # Process may have exited
                     end
 
                     # Extract thread count from /proc/<pid>/status (only for current process)
                     thcount = if pid == current_pid
-                                begin
-                                  File.read(status_file)[/^Threads:\s+(\d+)/, 1].to_i
-                                rescue StandardError
-                                  0
-                                end
-                              else
-                                0
-                              end
+                      begin
+                        File.read(status_file)[/^Threads:\s+(\d+)/, 1].to_i
+                      rescue
+                        0
+                      end
+                    else
+                      0
+                    end
 
                     # Convert RSS from pages to kilobytes
                     rss_kb = (rss_pages * page_size) / 1024
@@ -185,7 +189,7 @@ module Karafka
                 # we do on windows
                 when /darwin|bsd/
                   shell
-                    .call('ps -A -o rss=,pid=')
+                    .call("ps -A -o rss=,pid=")
                     .split("\n")
                     .map { |row| row.strip.split.map(&:to_i) }
                     .map { |row| [row.first, 0, row.last] }

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

@@ -10,12 +10,12 @@ module Karafka
           include ::Karafka::Core::Helpers::Time
 
           attr_reader :counters, :consumer_groups, :subscription_groups, :errors,
-                      :pauses, :jobs, :windows
+            :pauses, :jobs, :windows
 
           # Current schema version
           # This is used for detecting incompatible changes and not using outdated data during
           # upgrades
-          SCHEMA_VERSION = '1.5.0'
+          SCHEMA_VERSION = "1.6.0"
 
           # Counters that count events occurrences during the given window
           COUNTERS_BASE = {
@@ -76,10 +76,10 @@ module Karafka
             # Select and instantiate appropriate system metrics collector based on environment
             # Use container-aware collector if cgroups are available, otherwise use OS-based
             metrics_class = if Metrics::Container.active?
-                              Metrics::Container
-                            else
-                              Metrics::Os
-                            end
+              Metrics::Container
+            else
+              Metrics::Os
+            end
             @system_metrics = metrics_class.new(@shell)
             @network_metrics = Metrics::Network.new(@windows)
             @server_metrics = Metrics::Server.new
@@ -97,7 +97,7 @@ module Karafka
           def to_report
             {
               schema_version: SCHEMA_VERSION,
-              type: 'consumer',
+              type: "consumer",
               dispatched_at: float_now,
 
               process: {

data/lib/karafka/web/tracking/helpers/error_info.rb

@@ -14,17 +14,17 @@ module Karafka
           def extract_error_info(error)
             app_root = "#{::Karafka.root}/"
 
-            gem_home = if ENV.key?('GEM_HOME')
-                         ENV['GEM_HOME']
-                       else
-                         File.expand_path(File.join(Karafka.gem_root.to_s, '../'))
-                       end
+            gem_home = if ENV.key?("GEM_HOME")
+              ENV["GEM_HOME"]
+            else
+              File.expand_path(File.join(Karafka.gem_root.to_s, "../"))
+            end
 
             gem_home = "#{gem_home}/"
 
             backtrace = error.backtrace || []
-            backtrace.map! { |line| line.gsub(app_root, '') }
-            backtrace.map! { |line| line.gsub(gem_home, '') }
+            backtrace.map! { |line| line.gsub(app_root, "") }
+            backtrace.map! { |line| line.gsub(gem_home, "") }
 
             [
               error.class.name,
@@ -37,11 +37,11 @@ module Karafka
           # @return [String] formatted exception message
           def extract_error_message(error)
             error_message = error.message.to_s[0, 10_000]
-            error_message.force_encoding('utf-8')
+            error_message.force_encoding("utf-8")
             error_message.scrub! if error_message.respond_to?(:scrub!)
             error_message
-          rescue StandardError
-            '!!! Error message extraction failed !!!'
+          rescue
+            "!!! Error message extraction failed !!!"
           end
         end
       end

data/lib/karafka/web/tracking/helpers/sysconf.rb

@@ -11,10 +11,10 @@ module Karafka
 
           case RUBY_PLATFORM
           when /linux/
-            ffi_lib 'libc.so.6' # Standard C library on Linux
+            ffi_lib "libc.so.6" # Standard C library on Linux
             SC_PAGESIZE = 30 # _SC_PAGESIZE constant
           when /darwin/
-            ffi_lib 'libSystem.B.dylib' # Standard C library on macOS
+            ffi_lib "libSystem.B.dylib" # Standard C library on macOS
             SC_PAGESIZE = 29 # _SC_PAGESIZE constant
           end
 

data/lib/karafka/web/tracking/helpers/ttls/array.rb

@@ -64,7 +64,7 @@ module Karafka
               parts = ["ttl=#{@ttl}ms"]
               parts << "size=#{size}"
 
-              "#<#{self.class.name}:#{format('%#x', object_id)} #{parts.join(' ')}>"
+              "#<#{self.class.name}:#{format("%#x", object_id)} #{parts.join(" ")}>"
             end
 
             private

data/lib/karafka/web/tracking/helpers/ttls/hash.rb

@@ -29,7 +29,7 @@ module Karafka
 
             # @return [String] thread-safe inspect of the ttls hash
             def inspect
-              "#<#{self.class.name}:#{format('%#x', object_id)} size=#{size} ttl=#{@ttl}ms>"
+              "#<#{self.class.name}:#{format("%#x", object_id)} size=#{size} ttl=#{@ttl}ms>"
             end
           end
         end

data/lib/karafka/web/tracking/helpers/ttls/stats.rb

@@ -16,10 +16,10 @@ module Karafka
             # @param ttls_hash [Ttls::Hash, Hash] hash with window based samples
             def initialize(ttls_hash)
               @data = ttls_hash
-                      .values
-                      .map { |value| value.samples.to_a }
-                      .delete_if { |samples| samples.size < 2 }
-                      .map { |samples| samples.map(&:values) }
+                .values
+                .map { |value| value.samples.to_a }
+                .delete_if { |samples| samples.size < 2 }
+                .map { |samples| samples.map(&:values) }
             end
 
             # Computes the rate out of the samples provided on a per second basis. The samples need

data/lib/karafka/web/tracking/producers/listeners/booting.rb

@@ -15,7 +15,7 @@ module Karafka
             # @param _event [Karafka::Core::Monitoring::Event]
             def on_producer_connected(_event)
               ::Karafka::Web.config.tracking.scheduler.async_call(
-                'karafka.web.tracking.scheduler'
+                "karafka.web.tracking.scheduler"
               )
             end
           end

data/lib/karafka/web/tracking/producers/listeners/errors.rb

@@ -10,7 +10,7 @@ module Karafka
             include Tracking::Helpers::ErrorInfo
 
             # Schema used by producers error reporting
-            SCHEMA_VERSION = '1.2.0'
+            SCHEMA_VERSION = "1.2.0"
 
             private_constant :SCHEMA_VERSION
 
@@ -53,7 +53,7 @@ module Karafka
             # @return [Hash] hash with details
             def build_details(type, payload)
               case type
-              when 'librdkafka.dispatch_error'
+              when "librdkafka.dispatch_error"
                 payload.slice(:topic, :partition, :offset)
               else
                 {}

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

@@ -87,8 +87,8 @@ module Karafka
           # and we can just safely ignore this
           rescue WaterDrop::Errors::ProducerClosedError
             nil
-          rescue StandardError => e
-            p '------------------------------------------------'
+          rescue => e
+            p "------------------------------------------------"
             p e
           end
         end

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

@@ -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.1.0'
+          SCHEMA_VERSION = "1.1.0"
 
           def initialize
             super

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

@@ -15,7 +15,7 @@ module Karafka
           include Tracking::Helpers::ErrorInfo
 
           # Schema used by UI error reporting
-          SCHEMA_VERSION = '1.2.0'
+          SCHEMA_VERSION = "1.2.0"
 
           private_constant :SCHEMA_VERSION
 
@@ -24,7 +24,7 @@ module Karafka
           # @param event [Karafka::Core::Monitoring::Event]
           def on_error_occurred(event)
             # Only process UI errors, ignore all other error types
-            return unless event[:type] == 'web.ui.error'
+            return unless event[:type] == "web.ui.error"
 
             error_class, error_message, backtrace = extract_error_info(event[:error])
 
@@ -47,7 +47,7 @@ module Karafka
 
             # Dispatch error to Kafka asynchronously
             dispatch(error_data)
-          rescue StandardError => e
+          rescue => e
             # If we fail to report an error, log it but don't raise to avoid error loops
             ::Karafka.logger.error("Failed to report UI error: #{e.message}")
           end
@@ -66,7 +66,7 @@ module Karafka
               topic: ::Karafka::Web.config.topics.errors.name,
               payload: Zlib::Deflate.deflate(error_data.to_json),
               key: process_id,
-              headers: { 'zlib' => 'true' }
+              headers: { "zlib" => "true" }
             )
           end
         end

data/lib/karafka/web/ui/app.rb

@@ -7,7 +7,7 @@ module Karafka
       # Main Roda Web App that servers all the metrics and stats
       class App < Base
         # Use the gem views and assets location
-        opts[:root] = Karafka::Web.gem_root.join('lib/karafka/web/ui')
+        opts[:root] = Karafka::Web.gem_root.join("lib/karafka/web/ui")
 
         instance_exec(&CONTEXT_DETAILS)
 
@@ -29,7 +29,7 @@ module Karafka
         private_constant :SUB_ROUTES
 
         route do |r|
-          r.root { r.redirect root_path('dashboard') }
+          r.root { r.redirect root_path("dashboard") }
 
           SUB_ROUTES.each { |sub_route| sub_route.bind(self, r) }
 

data/lib/karafka/web/ui/base.rb

@@ -16,10 +16,10 @@ module Karafka
         CONTEXT_DETAILS = lambda do
           plugin(
             :public,
-            root: Karafka::Web.gem_root.join('lib/karafka/web/ui/public'),
+            root: Karafka::Web.gem_root.join("lib/karafka/web/ui/public"),
             # Cache all static files for the end user for as long as possible
             # We can do it because we ship per version assets so they invalidate with gem bumps
-            headers: { 'Cache-Control' => 'max-age=31536000, immutable' },
+            headers: { "Cache-Control" => "max-age=31536000, immutable" },
             gzip: true,
             brotli: true
           )
@@ -31,13 +31,13 @@ module Karafka
           # user to make the Web UI work.
           plugin(
             :sessions,
-            key: '_karafka_session',
-            env_key: 'karafka.session',
+            key: "_karafka_session",
+            env_key: "karafka.session",
             secret: SecureRandom.hex(64)
           )
         end
 
-        plugin :render, escape: true, engine: 'erb'
+        plugin :render, escape: true, engine: "erb"
         plugin :run_append_slash
         plugin :error_handler
         plugin :not_found
@@ -79,20 +79,20 @@ module Karafka
           result.flashes.each { |key, value| flash[key] = value }
 
           path = case result.path
-                 when :back
-                   session[:current_path]
-                 when :previous
-                   session[:previous_path]
-                 else
-                   root_path(result.path)
-                 end
+          when :back
+            session["current_path"]
+          when :previous
+            session["previous_path"]
+          else
+            root_path(result.path)
+          end
 
           response.redirect path || root_path
         end
 
         handle_block_result Controllers::Responses::File do |result|
-          response.headers['Content-Type'] = 'application/octet-stream'
-          response.headers['Content-Disposition'] = "attachment; filename=\"#{result.file_name}\""
+          response.headers["Content-Type"] = "application/octet-stream"
+          response.headers["Content-Disposition"] = "attachment; filename=\"#{result.file_name}\""
           response.write result.content
         end
 
@@ -103,35 +103,35 @@ module Karafka
           case e
           when Errors::Ui::ProOnlyError
             response.status = 402
-            view 'shared/exceptions/pro_only'
+            view "shared/exceptions/pro_only"
           when Errors::Ui::ForbiddenError
             response.status = 403
-            view 'shared/exceptions/not_allowed'
+            view "shared/exceptions/not_allowed"
           when Errors::Ui::NotFoundError
             response.status = 404
-            view 'shared/exceptions/not_found'
+            view "shared/exceptions/not_found"
           when ::Rdkafka::RdkafkaError
             response.status = 404
-            view 'shared/exceptions/not_found'
+            view "shared/exceptions/not_found"
           else
             # Report unhandled errors to Karafka monitoring
             ::Karafka.monitor.instrument(
-              'error.occurred',
+              "error.occurred",
               error: e,
               caller: self,
-              type: 'web.ui.error'
+              type: "web.ui.error"
             )
 
             # For all other unhandled errors, show a generic error page
             response.status = 500
-            view 'shared/exceptions/unhandled_error'
+            view "shared/exceptions/unhandled_error"
           end
         end
 
         not_found do
           @error = true
           response.status = 404
-          view 'shared/exceptions/not_found'
+          view "shared/exceptions/not_found"
         end
 
         before do
@@ -175,13 +175,13 @@ module Karafka
           merged_params = deep_merge(request.params, query_data)
 
           # Flatten the merged parameters
-          flattened_params = flatten_params('', merged_params)
+          flattened_params = flatten_params("", merged_params)
 
           # Build the query string from the flattened parameters
           query_string = URI.encode_www_form(flattened_params)
 
           # Construct the full path with query string
-          [request.path, query_string].compact.join('?')
+          [request.path, query_string].compact.join("?")
         end
 
         # Builds a consumer instance with all needed details
@@ -218,21 +218,21 @@ module Karafka
         def store_paths_history(request, session)
           # Code below tracks previous paths so we can use it to redirect users back
           return unless request.get?
-          return unless request.env['HTTP_ACCEPT']&.include?('text/html')
+          return unless request.env["HTTP_ACCEPT"]&.include?("text/html")
 
           requested_path = request.path
 
-          if session[:current_path].nil?
-            session[:current_path] = requested_path
+          if session["current_path"].nil?
+            session["current_path"] = requested_path
 
             return
           end
 
-          return if request.path == session[:current_path]
+          return if request.path == session["current_path"]
 
           # When navigating to a different page
-          session[:previous_path] = session[:current_path]
-          session[:current_path] = requested_path
+          session["previous_path"] = session["current_path"]
+          session["current_path"] = requested_path
         end
       end
     end

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

@@ -25,16 +25,16 @@ module Karafka
           # Detect that the state of the cache has changed
           before do
             cache.clear_if_needed(
-              session[:cache_hash],
-              session[:cache_timestamp].to_i
+              session["cache_hash"],
+              session["cache_timestamp"].to_i
             )
           end
 
           after do
             next unless cache.exist?
 
-            session[:cache_hash] = cache.hash
-            session[:cache_timestamp] = cache.timestamp.to_i
+            session["cache_hash"] = cache.hash
+            session["cache_timestamp"] = cache.timestamp.to_i
           end
 
           # @param params [Karafka::Web::Ui::Controllers::Requests::Params] request parameters
@@ -58,31 +58,31 @@ module Karafka
           def render(attributes: {})
             attributes = attributes.dup
 
-            full_parts = self.class.to_s.split('::')
-            separator = full_parts.index('Controllers')
+            full_parts = self.class.to_s.split("::")
+            separator = full_parts.index("Controllers")
             base = full_parts[(separator + 1)..]
 
             base.map!.with_index do |path_part, index|
               if index == (base.size - 1)
-                path_part.gsub(/(.)([A-Z])/, '\1_\2').downcase.gsub('_controller', '')
+                path_part.gsub(/(.)([A-Z])/, '\1_\2').downcase.gsub("_controller", "")
               else
                 path_part.gsub(/(.)([A-Z])/, '\1_\2').downcase
               end
             end
 
-            scope = base.join('/')
-            action = caller_locations(1, 1)[0].label.split('#').last
+            scope = base.join("/")
+            action = caller_locations(1, 1)[0].label.split("#").last
 
             attributes[:breadcrums_scope] = scope
 
             @current_action_name = action.to_sym
-            @current_controller_name = base.join('-')
+            @current_controller_name = base.join("-")
 
             instance_variables.each do |iv|
-              next if iv.to_s.start_with?('@_')
-              next if iv.to_s.start_with?('@params')
+              next if iv.to_s.start_with?("@_")
+              next if iv.to_s.start_with?("@params")
 
-              attributes[iv.to_s.delete('@').to_sym] = instance_variable_get(iv)
+              attributes[iv.to_s.delete("@").to_sym] = instance_variable_get(iv)
             end
 
             Responses::Render.new(
@@ -108,7 +108,7 @@ module Karafka
           # @return [String] formatted string
           def format_flash(message, *args)
             args.each do |arg|
-              message = message.sub('?', "<strong>#{arg}</strong>")
+              message = message.sub("?", "<strong>#{arg}</strong>")
             end
 
             message
@@ -143,15 +143,15 @@ module Karafka
           # @param args Any arguments accepted by the selected pagination engine
           def paginate(*args)
             engine = case args.count
-                     when 2
-                       Ui::Lib::Paginations::PageBased
-                     when 3
-                       Ui::Lib::Paginations::WatermarkOffsetsBased
-                     when 4
-                       Ui::Lib::Paginations::OffsetBased
-                     else
-                       raise ::Karafka::Errors::UnsupportedCaseError, args.count
-                     end
+            when 2
+              Ui::Lib::Paginations::PageBased
+            when 3
+              Ui::Lib::Paginations::WatermarkOffsetsBased
+            when 4
+              Ui::Lib::Paginations::OffsetBased
+            else
+              raise ::Karafka::Errors::UnsupportedCaseError, args.count
+            end
 
             @pagination = engine.new(*args)
           end
@@ -160,7 +160,7 @@ module Karafka
           #
           # @param resource_id [String] resource id that was not found
           # @raise [::Karafka::Web::Errors::Ui::NotFoundError]
-          def not_found!(resource_id = '')
+          def not_found!(resource_id = "")
             raise(::Karafka::Web::Errors::Ui::NotFoundError, resource_id)
           end
         end

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

@@ -63,12 +63,12 @@ module Karafka
           #   order
           def displayable_topics(cluster_info)
             all = cluster_info
-                  .topics
-                  .sort_by { |topic| topic[:topic_name] }
+              .topics
+              .sort_by { |topic| topic[:topic_name] }
 
             return all if ::Karafka::Web.config.ui.visibility.internal_topics
 
-            all.reject { |topic| topic[:topic_name].start_with?('__') }
+            all.reject { |topic| topic[:topic_name].start_with?("__") }
           end
         end
       end