log_bench 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb8aba2b715d494f771f7bf0b1dda90719ae1a72e36823e86832f6ccbd7966b3
-  data.tar.gz: e7f5a7f4322778e74a4de3f33603c5de448e2e021c78e1506cf97507226ffa80
+  metadata.gz: 6190e59783385726fb1b48af6daf05113619df53ab0f614927e40850fdb69d71
+  data.tar.gz: fb9dad6de4675da021d49f9b2c6bf41e387b8bbbd7ae2637fa3345f7beb19682
 SHA512:
-  metadata.gz: 966d732d29bdbeaf30f1428b1f26126733120d2922c4a711a74e629fe78eae088702a51a6d20c311f097e98484bb93334a5eb8387b412b31449934e205013604
-  data.tar.gz: 628a28c650da6ed06b837397e3f79c09fc115ad36c2082ebb8dc9207a87e27034b04696a8d3462b2bb6be278a611ae08909ee4ecac3782509dce908dea5dda45
+  metadata.gz: '02058887b5e6192622b8397d163b53d9be4cf1b73b192a216284e40941b5833e7e485d144fe00c21c76face673e5c67036467ed28eaae95842109b81cce2b7b5'
+  data.tar.gz: 5722c117f9eb0962007d0d21d8c38a3039df687b792cf9899531acfa438c3ac279637e2256bc6a04d5847634d52e386e18e7b1119c6c2278626ca09432660f3f

data/README.md

@@ -46,6 +46,11 @@ Rails.application.configure do
   # LogBench: Configure structured logging
   config.lograge.enabled = true
   config.lograge.formatter = Lograge::Formatters::Json.new
+  config.log_bench.show_init_message = :full # or :min or :none
+  config.lograge.custom_options = lambda do |event|
+    params = event.payload[:params]&.except("controller", "action")
+    { params: params } if params.present?
+  end
   config.logger ||= ActiveSupport::Logger.new(config.default_log_file)
   config.logger.formatter = LogBench::JsonFormatter.new
 end

data/exe/log_bench

@@ -66,13 +66,12 @@ rescue Interrupt
   exit 0
 rescue => e
   Curses.close_screen if defined?(Curses)
-  puts "❌ Error: #{e.message}"
+  puts "❌ Error: #{e.message} \n#{e.backtrace.join("\n")}"
   puts
   puts "Common issues:"
   puts "  - Log file doesn't exist or is empty"
   puts "  - Lograge not configured (see README.md for setup)"
   puts "  - Log format not supported (LogBench requires lograge JSON format)"
-  puts " Error backtrace: \n #{e.backtrace.join("\n")}"
   puts
   puts "For help: log_bench --help"
   exit 1

data/lib/log_bench/app/main.rb

@@ -21,6 +21,7 @@ module LogBench
         self.log_file_path = find_log_file(log_file_path)
         self.state = State.new
         validate_log_file!
+        validate_configuration!
       end
 
       def run
@@ -37,6 +38,8 @@ module LogBench
 
       private
 
+      attr_accessor :log_file_path, :state, :screen, :monitor, :input_handler, :renderer
+
       def find_log_file(path)
         candidates = [path] + DEFAULT_LOG_PATHS
         candidates.find { |candidate| File.exist?(candidate) } || path
@@ -50,13 +53,24 @@ module LogBench
         end
       end
 
+      def log_file_name
+        File.basename(log_file_path)
+      end
+
+      def validate_configuration!
+        ConfigurationValidator.validate_rails_config!
+      rescue ConfigurationValidator::ConfigurationError => e
+        puts e.message
+        exit 1
+      end
+
       def setup_screen
         self.screen = Screen.new
         screen.setup
       end
 
       def setup_components
-        self.renderer = Renderer::Main.new(screen, state)
+        self.renderer = Renderer::Main.new(screen, state, log_file_name)
         self.input_handler = InputHandler.new(state, screen, renderer)
       end
 
@@ -93,10 +107,6 @@ module LogBench
         monitor&.stop
         screen&.cleanup
       end
-
-      private
-
-      attr_accessor :log_file_path, :state, :screen, :monitor, :input_handler, :renderer
     end
   end
 end

data/lib/log_bench/app/renderer/details.rb

@@ -7,6 +7,7 @@ module LogBench
     module Renderer
       class Details
         include Curses
+        EMPTY_LINE = {text: "", color: nil}
 
         def initialize(screen, state, scrollbar, ansi_renderer)
           self.screen = screen
@@ -110,7 +111,7 @@ module LogBench
           else color_pair(2) | A_BOLD
           end
 
-          lines << {text: "", color: nil}  # Empty line
+          lines << EMPTY_LINE
           lines << {
             text: "Method: #{log[:method]}",
             color: nil,
@@ -125,6 +126,7 @@ module LogBench
           add_status_duration_lines(lines, log)
           add_controller_lines(lines, log)
           add_request_id_lines(lines, log)
+          add_params_lines(lines, log, max_width)
           add_related_logs_section(lines, log)
 
           lines
@@ -138,6 +140,7 @@ module LogBench
             duration: request.duration,
             controller: request.controller,
             action: request.action,
+            params: request.params,
             request_id: request.request_id,
             related_logs: build_related_logs(request)
           }
@@ -240,6 +243,80 @@ module LogBench
           end
         end
 
+        def add_params_lines(lines, log, max_width)
+          return unless log[:params]
+
+          lines << EMPTY_LINE
+          lines << {
+            text: "Params:",
+            color: nil,
+            segments: [
+              {text: "Params:", color: color_pair(1) | A_BOLD}
+            ]
+          }
+
+          params_text = format_params(log[:params])
+          indent = "  "
+
+          # Split the params text into lines that fit within the available width
+          line_width = max_width - indent.length
+          remaining_text = params_text
+
+          while remaining_text && remaining_text.length > 0
+            line_chunk = remaining_text[0, line_width]
+            lines << {text: indent + line_chunk, color: nil}
+            remaining_text = remaining_text[line_width..] || ""
+          end
+        end
+
+        def format_params(params)
+          case params
+          when Hash
+            # Format as readable key-value pairs
+            if params.empty?
+              "{}"
+            else
+              formatted_pairs = params.map do |key, value|
+                formatted_value = case value
+                when Hash
+                  format_nested_hash(value)
+                when Array
+                  "[#{value.join(", ")}]"
+                else
+                  value.to_s
+                end
+                "#{key}: #{formatted_value}"
+              end
+              "{ #{formatted_pairs.join(", ")} }"
+            end
+          when String
+            params
+          else
+            params.to_s
+          end
+        end
+
+        def format_nested_hash(hash, depth = 1)
+          return "{}" if hash.empty?
+
+          if depth > 2  # Limit nesting depth to avoid overly complex display
+            "{...}"
+          else
+            formatted_pairs = hash.map do |key, value|
+              formatted_value = case value
+              when Hash
+                format_nested_hash(value, depth + 1)
+              when Array
+                "[#{value.join(", ")}]"
+              else
+                value.to_s
+              end
+              "#{key}: #{formatted_value}"
+            end
+            "{ #{formatted_pairs.join(", ")} }"
+          end
+        end
+
         def add_request_id_lines(lines, log)
           if log[:request_id]
             lines << {
@@ -276,7 +353,7 @@ module LogBench
             query_stats = calculate_query_stats(related_logs)
 
             # Add query summary
-            lines << {text: "", color: nil}  # Empty line
+            lines << EMPTY_LINE
 
             # Show filter status in summary if filtering is active
             summary_title = "Query Summary:"
@@ -310,7 +387,7 @@ module LogBench
               end
             end
 
-            lines << {text: "", color: nil}  # Empty line
+            lines << EMPTY_LINE
 
             # Show filtered logs section
             if state.detail_filter.present?
@@ -459,7 +536,7 @@ module LogBench
 
           # Add extra empty lines after all chunks
           extra_empty_lines.times do
-            lines << {text: "", color: nil}
+            lines << EMPTY_LINE
           end
 
           text_chunks.length

data/lib/log_bench/app/renderer/header.rb

@@ -13,15 +13,15 @@ module LogBench
 
         # Layout constants
         TITLE_X_OFFSET = 2
-        FILENAME_X_OFFSET = 15
 
         # Color constants
         HEADER_CYAN = 1
         SUCCESS_GREEN = 3
 
-        def initialize(screen, state)
+        def initialize(screen, state, log_file_name)
           self.screen = screen
           self.state = state
+          self.log_file_name = log_file_name
         end
 
         def draw
@@ -36,7 +36,7 @@ module LogBench
 
         private
 
-        attr_accessor :screen, :state
+        attr_accessor :screen, :state, :log_file_name
 
         def draw_title
           header_win.setpos(1, TITLE_X_OFFSET)
@@ -45,8 +45,8 @@ module LogBench
         end
 
         def draw_file_name
-          header_win.setpos(1, screen.width / 2 - FILENAME_X_OFFSET)
-          header_win.attron(color_pair(SUCCESS_GREEN)) { header_win.addstr(DEFAULT_LOG_FILENAME) }
+          header_win.setpos(1, (screen.width / 2) - (log_file_name.length / 2))
+          header_win.attron(color_pair(SUCCESS_GREEN)) { header_win.addstr(log_file_name) }
         end
 
         def draw_stats

data/lib/log_bench/app/renderer/main.rb

@@ -4,12 +4,12 @@ module LogBench
   module App
     module Renderer
       class Main
-        def initialize(screen, state)
+        def initialize(screen, state, log_file_name)
           self.screen = screen
           self.state = state
           self.scrollbar = Scrollbar.new(screen)
           self.ansi_renderer = Ansi.new(screen)
-          self.header = Header.new(screen, state)
+          self.header = Header.new(screen, state, log_file_name)
           self.request_list = RequestList.new(screen, state, scrollbar)
           self.details = Details.new(screen, state, scrollbar, ansi_renderer)
           self.update_modal = UpdateModal.new(screen, state)

data/lib/log_bench/configuration_validator.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module LogBench
+  # Validates that lograge is properly configured for LogBench
+  class ConfigurationValidator
+    class ConfigurationError < StandardError; end
+    ERROR_CONFIGS = {
+      enabled: {
+        title: "Lograge is not enabled",
+        description: "LogBench requires lograge to be enabled in your Rails application.",
+        fix: "config.lograge.enabled = true"
+      },
+      options: {
+        title: "Lograge custom_options missing",
+        description: "LogBench needs custom_options to include params fields.",
+        fix: <<~FIX.strip
+          config.lograge.custom_options = lambda do |event|
+            params = event.payload[:params]&.except("controller", "action")
+            { params: params } if params.present?
+          end
+        FIX
+      },
+      formatter: {
+        title: "Wrong lograge formatter",
+        description: "LogBench requires LogBench::JsonFormatter for proper log parsing.",
+        fix: "config.lograge.formatter = LogBench::JsonFormatter.new"
+      }
+    }.freeze
+
+    def self.validate_rails_config!
+      new.validate_rails_config!
+    end
+
+    def validate_rails_config!
+      return true unless defined?(Rails) && Rails.application
+
+      validate_lograge_enabled!
+      validate_custom_options!
+      validate_json_formatter!
+
+      true
+    end
+
+    private
+
+    def validate_lograge_enabled!
+      unless lograge_config&.enabled
+        raise ConfigurationError, build_error_message(:enabled)
+      end
+    end
+
+    def validate_custom_options!
+      unless lograge_config&.custom_options
+        raise ConfigurationError, build_error_message(:options)
+      end
+    end
+
+    def validate_json_formatter!
+      formatter = lograge_config&.formatter
+      unless formatter.is_a?(LogBench::JsonFormatter)
+        raise ConfigurationError, build_error_message(:formatter)
+      end
+    end
+
+    def lograge_config
+      return nil unless Rails.application.config.respond_to?(:lograge)
+      Rails.application.config.lograge
+    end
+
+    def build_error_message(error_type)
+      config = ERROR_CONFIGS[error_type]
+
+      <<~ERROR
+        ❌ #{config[:title]}
+
+        #{config[:description]}
+
+        Add this to config/environments/development.rb:
+        #{config[:fix]}
+
+        For complete setup: https://github.com/silva96/log_bench#configuration
+      ERROR
+    end
+  end
+end

data/lib/log_bench/log/request.rb

@@ -3,7 +3,7 @@
 module LogBench
   module Log
     class Request < Entry
-      attr_reader :method, :path, :status, :duration, :controller, :action
+      attr_reader :method, :path, :status, :duration, :controller, :action, :params
       attr_accessor :related_logs
 
       def initialize(raw_line)
@@ -65,13 +65,14 @@ module LogBench
           duration: duration,
           controller: controller,
           action: action,
+          params: params,
           related_logs: related_logs.map(&:to_h)
         )
       end
 
       private
 
-      attr_writer :method, :path, :status, :duration, :controller, :action
+      attr_writer :method, :path, :status, :duration, :controller, :action, :params
 
       def extract_from_json(data)
         return false unless super
@@ -83,8 +84,22 @@ module LogBench
         self.controller = data["controller"]
         self.action = data["action"]
         self.request_id = data["request_id"]
+        self.params = parse_params(data["params"])
         true
       end
+
+      def parse_params(params_data)
+        return nil unless params_data
+
+        case params_data
+        when String
+          JSON.parse(params_data)
+        when Hash
+          params_data
+        end
+      rescue JSON::ParserError
+        params_data.to_s
+      end
     end
   end
 end

data/lib/log_bench/railtie.rb

@@ -2,8 +2,12 @@ require "rails/railtie"
 
 module LogBench
   class Railtie < Rails::Railtie
+    LINE = "=" * 70
+
     railtie_name :log_bench
 
+    config.log_bench = ActiveSupport::OrderedOptions.new
+
     # LogBench uses manual configuration (see README.md)
 
     # Provide helpful rake tasks
@@ -11,33 +15,67 @@ module LogBench
       load "tasks/log_bench.rake"
     end
 
+    initializer "log_bench.configure" do |app|
+      LogBench.setup do |config|
+        config.show_init_message = app.config.log_bench.show_init_message
+        config.show_init_message = :full if config.show_init_message.nil?
+      end
+    end
+
     # Show installation instructions when Rails starts in development
     initializer "log_bench.show_instructions", after: :load_config_initializers do
-      if Rails.env.development?
-        # Check if lograge is properly configured
-        puts "\n" + "=" * 70
-        puts "\n" + "=" * 70
-        if Rails.application.config.respond_to?(:lograge) &&
-            Rails.application.config.lograge.enabled
-          puts "✅ LogBench is ready to use!"
-          puts "=" * 70
-          puts "View your logs: log_bench log/development.log"
-        else
-
-          puts "🚀 LogBench is ready to configure!"
-          puts "=" * 70
-          puts "To start using LogBench:"
-          puts "  1. See README.md for configuration instructions"
-          puts "  2. Configure lograge in config/environments/development.rb"
-          puts "  3. Restart your Rails server"
-          puts "  4. Make some requests to generate logs"
-          puts "  5. View logs: log_bench log/development.log"
-          puts
+      return unless Rails.env.development?
+
+      # Use configuration validator to check lograge setup
+      begin
+        ConfigurationValidator.validate_rails_config!
+        # Lograge is properly configured
+        if LogBench.configuration.show_init_message.eql? :full
+          print_full_init_message
+          print_help_instructions
+          puts LINE
+          puts LINE
+        elsif LogBench.configuration.show_init_message.eql? :min
+          print_min_init_message
         end
-        puts "For help: log_bench --help"
-        puts "=" * 70 + "\n"
-        puts "=" * 70 + "\n"
+      rescue ConfigurationValidator::ConfigurationError => e
+        # Lograge needs configuration
+        print_configuration_instructions
+        puts "⚠️  Configuration issue: #{e.message}"
+        print_help_instructions
+        puts LINE
+        puts LINE
       end
     end
+
+    private
+
+    def print_configuration_instructions
+      puts "🚀 LogBench is ready to configure!"
+      puts LINE
+      puts "To start using LogBench:"
+      puts "  1. See README.md for configuration instructions"
+      puts "  2. Configure lograge in config/environments/development.rb"
+      puts "  3. Restart your Rails server"
+      puts "  4. Make some requests to generate logs"
+      puts "  5. View logs: log_bench log/development.log"
+      puts ""
+    end
+
+    def print_min_init_message
+      puts "✅ LogBench is ready to use!"
+    end
+
+    def print_full_init_message
+      puts "\n" + LINE
+      puts "\n" + LINE
+      puts "✅ LogBench is ready to use!"
+      puts LINE
+      puts "View your logs: log_bench log/development.log"
+    end
+
+    def print_help_instructions
+      puts "For help: log_bench --help"
+    end
   end
 end

data/lib/log_bench/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LogBench
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

data/lib/log_bench.rb

@@ -13,12 +13,25 @@ loader.setup
 module LogBench
   class Error < StandardError; end
 
-  # Parse log lines and return an array of entries
-  def self.parse(lines)
-    lines = [lines] if lines.is_a?(String)
+  class Configuration
+    attr_accessor :show_init_message
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    # Parse log lines and return an array of entries
+    def parse(lines)
+      lines = [lines] if lines.is_a?(String)
+
+      collection = Log::Collection.new(lines)
+      collection.requests
+    end
 
-    collection = Log::Collection.new(lines)
-    collection.requests
+    def setup
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
   end
 end
 

data/lib/tasks/log_bench.rake

@@ -13,49 +13,6 @@ namespace :log_bench do
     puts "4. Restart Rails server"
   end
 
-  desc "Check LogBench configuration"
-  task check: :environment do
-    puts "\n" + "=" * 60
-    puts "🔍 LogBench Configuration Check"
-    puts "=" * 60
-
-    if Rails.application.config.respond_to?(:lograge) &&
-        Rails.application.config.lograge.enabled
-      puts "✅ Lograge is enabled"
-
-      if Rails.application.config.lograge.formatter.is_a?(Lograge::Formatters::Json)
-        puts "✅ JSON formatter is configured"
-      else
-        puts "⚠️  JSON formatter is not configured"
-        puts "   LogBench requires JSON format"
-        puts "   See README.md for configuration instructions"
-      end
-
-      # Check if log file exists and has content
-      log_file = "log/#{Rails.env}.log"
-      if File.exist?(log_file) && File.size(log_file) > 0
-        puts "✅ Log file exists: #{log_file}"
-      else
-        puts "⚠️  Log file is empty or doesn't exist: #{log_file}"
-        puts "   Make some requests to generate logs"
-      end
-
-      puts
-      puts "🎉 LogBench is ready to use!"
-      puts "   Command: log_bench #{log_file}"
-    else
-      puts "❌ Lograge is not enabled"
-      puts
-      puts "To fix this:"
-      puts "   1. See README.md for configuration instructions"
-      puts "   2. Configure lograge in config/environments/development.rb"
-      puts "   3. Restart your Rails server"
-      puts "   4. Make some requests"
-      puts "   5. Run: log_bench log/development.log"
-    end
-    puts "=" * 60 + "\n"
-  end
-
   desc "Show LogBench usage instructions"
   task :help do
     puts <<~HELP

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: log_bench
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Benjamín Silva
 bindir: exe
 cert_chain: []
-date: 2025-06-09 00:00:00.000000000 Z
+date: 2025-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk
@@ -139,6 +139,7 @@ files:
 - lib/log_bench/app/screen.rb
 - lib/log_bench/app/sort.rb
 - lib/log_bench/app/state.rb
+- lib/log_bench/configuration_validator.rb
 - lib/log_bench/json_formatter.rb
 - lib/log_bench/log/cache_entry.rb
 - lib/log_bench/log/call_line_entry.rb