log_bench 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e097c5b1822d427d807fe466addf85d9036141cad8922b37c0db0ae79dee994d
+  data.tar.gz: 4f207f350da8fc94ae2fcbfff2a0b4bfd8021bc477e9093e87c4bb2fb0371c45
+SHA512:
+  metadata.gz: c732968d82ef380e7cff012fef5d71ad0996a3b075143226a949881a26e918f72da5776d1fb5b34cf23c346afc3bd4a84dfbc780c93abcb2a2da745801e82d00
+  data.tar.gz: c543a20c55ed6270612d9ad369c4fe527b94520d0c9d5d7feb9df3c811416476ea9d6b9d08aa4519adc39a4886cb4eb59738aa02e389abdcb4786ca44ba54e21

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-05
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Benjamín Silva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,230 @@
+# LogBench
+
+A powerful TUI (Terminal User Interface) for analyzing Rails application logs in real-time. LogBench provides an intuitive interface to view HTTP requests, SQL queries, and performance metrics from your Rails logs.
+
+![LogBench Preview](logbench-preview.png)
+
+## Features
+
+- 🚀 **Real-time log analysis** with auto-scroll
+- 📊 **Request correlation** - groups SQL queries with HTTP requests
+- 🔍 **Advanced filtering** by method, path, status, controller, and more
+- 📈 **Performance insights** - duration, allocations, query analysis
+- 🎨 **Beautiful TUI** with syntax highlighting and ANSI color support
+- ⚡ **Fast parsing** of JSON-formatted logs
+- 🔧 **Custom logging** support for background jobs and events
+
+## Installation
+
+Add LogBench to your Rails application's Gemfile:
+
+```ruby
+# Gemfile
+group :development do
+  gem 'log_bench'
+end
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Configuration
+
+### 1. Configure Rails Logging
+
+Add this configuration to your `config/environments/development.rb`:
+
+```ruby
+# config/environments/development.rb
+require "lograge"
+
+Rails.application.configure do
+  # ... other configuration ...
+
+  # LogBench: Configure structured logging
+  config.lograge.enabled = true
+  config.lograge.formatter = Lograge::Formatters::Json.new
+  config.logger ||= ActiveSupport::Logger.new(config.default_log_file)
+  config.logger.formatter = LogBench::JsonFormatter.new
+end
+```
+
+### 2. Set Up Request ID Tracking
+
+Create or update your `Current` model to track request IDs:
+
+```ruby
+# app/models/current.rb
+# frozen_string_literal: true
+
+class Current < ActiveSupport::CurrentAttributes
+  attribute :request_id
+end
+```
+
+Add request ID tracking to your ApplicationController:
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  before_action :set_current_request_identifier
+
+  protected
+
+  def set_current_request_identifier
+    Current.request_id = request.request_id
+  end
+end
+```
+
+### 3. Restart Your Rails Server
+
+After configuration, restart your Rails development server:
+
+## Usage
+
+### Basic Usage
+
+View your development logs:
+
+```bash
+log_bench
+# or explicitly for a specific log file
+log_bench log/development.log
+```
+
+### TUI Controls
+
+- **Navigation**: `↑↓` or `jk` to navigate requests
+- **Pane switching**: `←→` or `hl` to switch between request list and details
+- **Filtering**: `f` to open filter dialog
+- **Sorting**: `s` to cycle through sort options (timestamp, duration, status)
+- **Auto-scroll**: `a` to toggle auto-scroll mode
+- **Clear**: `c` to clear current logs
+- **Quit**: `q` to exit
+
+### Filtering
+
+Press `f` to open the filter dialog. You can filter by:
+
+- **Method**: GET, POST, PUT, DELETE, etc.
+- **Path**: URL path patterns
+- **Status**: HTTP status codes (200, 404, 500, etc.)
+- **Controller**: Controller name
+- **Action**: Action name
+- **Duration**: Minimum request duration in ms
+
+Examples:
+- Filter by method: `GET`
+- Filter by path: `/api/users`
+- Filter by status: `500`
+- Filter by slow requests: duration `>100`
+
+## Log Format
+
+LogBench works with JSON-formatted logs. Each log entry should include:
+
+**Required fields for HTTP requests:**
+- `method`: HTTP method (GET, POST, etc.)
+- `path`: Request path
+- `status`: HTTP status code
+- `request_id`: Unique request identifier
+- `duration`: Request duration in milliseconds
+
+**Optional fields:**
+- `controller`: Controller name
+- `action`: Action name
+- `allocations`: Memory allocations
+- `view`: View rendering time
+- `db`: Database query time
+
+**Other query logs:**
+- `message`: SQL query with timing information
+- `request_id`: Links query to HTTP request
+
+## Testing
+
+LogBench includes a comprehensive test suite to ensure reliability and correctness.
+
+### Running Tests
+
+```bash
+# Run all tests
+bundle exec rake test
+
+# Run specific test files
+bundle exec ruby test/test_log_entry.rb
+bundle exec ruby test/test_request.rb
+bundle exec ruby test/test_json_formatter.rb
+
+# Run tests with verbose output
+bundle exec rake test TESTOPTS="-v"
+```
+
+### Test Coverage
+
+The test suite covers:
+
+- **Log parsing**: JSON format detection and parsing
+- **Request correlation**: Grouping SQL queries with HTTP requests
+- **Filtering**: Method, path, status, and duration filters
+- **JsonFormatter**: Custom logging format handling
+- **TUI components**: Screen rendering and user interactions
+- **Edge cases**: Malformed logs, missing fields, performance scenarios
+
+### Writing Tests
+
+When contributing, please include tests for new features:
+
+```ruby
+# test/test_new_feature.rb
+require "test_helper"
+
+class TestNewFeature < Minitest::Test
+  def test_feature_works
+    # Your test code here
+    assert_equal expected, actual
+  end
+end
+```
+
+## Troubleshooting
+
+### No requests found
+
+1. **Check log file exists**: Ensure the log file path is correct
+2. **Verify lograge configuration**: Make sure lograge is enabled and configured
+3. **Check log format**: LogBench requires JSON-formatted logs
+4. **Generate some requests**: Make HTTP requests to your Rails app to generate logs
+
+### SQL queries not showing
+
+1. **Check request_id correlation**: Ensure SQL queries and HTTP requests share the same `request_id`
+2. **Verify Current model**: Make sure `Current.request_id` is being set properly
+3. **Check JsonFormatter**: Ensure the JsonFormatter is configured for your Rails logger
+
+### Performance issues
+
+1. **Large log files**: LogBench loads the entire log file into memory. For very large files, consider rotating logs more frequently
+2. **Real-time parsing**: Use auto-scroll mode (`a`) for better performance with actively growing log files
+
+## Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This gem is available as open source under the terms of the [MIT License](LICENSE).
+
+## Support
+
+- 🐛 **Bug reports**: [GitHub Issues](https://github.com/silva96/log_bench/issues)
+- 💡 **Feature requests**: [GitHub Discussions](https://github.com/silva96/log_bench/discussions)
+- 📖 **Documentation**: [GitHub Wiki](https://github.com/silva96/log_bench/wiki)

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/exe/log_bench

@@ -0,0 +1,87 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/log_bench"
+
+def show_help
+  puts <<~HELP
+    LogBench - Rails Log Viewer
+
+    Usage:
+      bundle exec log_bench [log_file]
+      bundle exec log_bench --help
+      bundle exec log_bench --version
+
+    Examples:
+      bundle exec log_bench                           # View log/development.log
+      bundle exec log_bench log/production.log        # View specific log file
+      bundle exec log_bench /path/to/app/log/test.log  # View log from another app
+
+    Setup (for Rails apps):
+      See README.md for complete configuration instructions:
+      https://github.com/silva96/log_bench#installation
+
+    Custom Logging:
+      # Create JSON loggers for background jobs, events, etc.
+      logger = Logger.new('log/jobs.log')
+      logger.formatter = LogBench::JsonFormatter.new
+      logger.info({ message: "Job completed", job_id: 123 })
+
+      # Then view with LogBench
+      bundle exec log_bench log/jobs.log
+
+    Requirements:
+      - Lograge gem with JSON formatter
+      - Rails application logs in lograge format
+
+    For more info: https://github.com/silva96/log_bench
+  HELP
+end
+
+def show_version
+  puts "LogBench #{LogBench::VERSION}"
+end
+
+# Handle command line arguments
+case ARGV[0]
+when "--help", "-h"
+  show_help
+  exit 0
+when "--version", "-v"
+  show_version
+  exit 0
+end
+
+begin
+  log_file = ARGV[0] || "log/development.log"
+
+  # Check if log file exists
+  unless File.exist?(log_file)
+    puts "❌ Log file not found: #{log_file}"
+    puts
+    puts "Make sure:"
+    puts "  1. You're in a Rails application directory"
+    puts "  2. The log file exists and has content"
+    puts "  3. Lograge is configured (see README.md for setup)"
+    puts
+    puts "For help: bundle exec log_bench --help"
+    exit 1
+  end
+
+  LogBench::App::Main.new(log_file).run
+rescue Interrupt
+  Curses.close_screen if defined?(Curses)
+  puts "\nGoodbye! 👋"
+  exit 0
+rescue => e
+  Curses.close_screen if defined?(Curses)
+  puts "❌ Error: #{e.message}"
+  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
+  puts "For help: bundle exec log_bench --help"
+  exit 1
+end

data/lib/log_bench/app/filter.rb

@@ -0,0 +1,60 @@
+module LogBench
+  module App
+    class Filter
+      def initialize
+        self.text = ""
+        self.mode = false
+      end
+
+      def enter_mode
+        self.mode = true
+      end
+
+      def exit_mode
+        self.mode = false
+      end
+
+      def active?
+        mode
+      end
+
+      def present?
+        !text.empty?
+      end
+
+      def add_character(char)
+        self.text += char
+      end
+
+      def remove_character
+        self.text = text[0...-1] if text.length > 0
+      end
+
+      def clear
+        self.text = ""
+      end
+
+      def clear_and_exit
+        clear
+        exit_mode
+      end
+
+      def matches?(content)
+        return true if text.empty?
+        content.to_s.downcase.include?(text.downcase)
+      end
+
+      def display_text
+        text
+      end
+
+      def cursor_display
+        active? ? "#{text}█" : text
+      end
+
+      private
+
+      attr_accessor :text, :mode
+    end
+  end
+end