activerecord-db-metrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a297908043fb841e5a7f8a38722644bd73143ee7160bc21c044c1383825c4564
+  data.tar.gz: 6c6b6b134bc84e2cb4446179bf685dee8c153a4afb64abf1828bf3583b8af85c
+SHA512:
+  metadata.gz: 97c52f7e25b80bf5088d3742ef16d2fac1978b5c4c7d6c58193549e1c60eeb2ffe7ca75ec0aa647519d541ca315c3087af444b1c7498a119c70deb38659ef47f
+  data.tar.gz: 2e46c1a3b9ec8d25f1bccdbe54776fafa2d76db4aeead57618b5a04043ea17080a7428be973d9549f4bba2402ad844ea9864b9b5fca02c99182a62697db2a57e

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-12-07
+
+### Added
+- Initial release
+- Track database queries per request
+- Breakdown by table and CRUD operation type
+- Support for bulk operations (insert_all, upsert_all)
+- Controller helper for easy integration
+- Manual collector for custom usage

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Masato Kato
+
+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,159 @@
+# ActiveRecord::Db::Metrics
+
+A lightweight gem to monitor and measure database queries in Rails applications. Track CRUD operations per table with support for bulk operations like `insert_all`.
+
+## Features
+
+- 📊 Track database queries per request
+- 🔍 Breakdown by table and operation type (INSERT, SELECT, UPDATE, DELETE)
+- 💪 Support for bulk operations (`insert_all`, `upsert_all`)
+- 🪶 Lightweight with minimal performance overhead
+- 🎯 Easy integration with Rails controllers
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-db-metrics'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+### Basic Setup
+
+Include the helper module in your controller and add the `around_action`:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include ActiveRecord::Db::Metrics::ControllerHelper
+  around_action :measure_db_operations
+end
+```
+
+Now, every request will log database metrics like this:
+
+```
+--- DB Metrics for Request ---
+Total DB Queries: 15
+  [USERS] I:1, S:10, U:2, D:0 (Total: 13)
+  [POSTS] I:0, S:2, U:0, D:0 (Total: 2)
+------------------------------
+```
+
+### Selective Monitoring
+
+You can apply metrics to specific controllers or actions:
+
+```ruby
+class UsersController < ApplicationController
+  include ActiveRecord::Db::Metrics::ControllerHelper
+  around_action :measure_db_operations, only: [:index, :show]
+end
+```
+
+### Custom Logging
+
+Override the `log_db_metrics` method to customize logging behavior:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include ActiveRecord::Db::Metrics::ControllerHelper
+  around_action :measure_db_operations
+
+  private
+
+  def log_db_metrics(results)
+    # Send to your monitoring service
+    StatsD.gauge('db.queries.total', results[:total_queries])
+
+    results[:crud_operations_by_table].each do |table, counts|
+      counts.each do |operation, count|
+        StatsD.gauge("db.queries.#{table}.#{operation.downcase}", count)
+      end
+    end
+  end
+end
+```
+
+### Manual Usage
+
+You can also use the collector directly without the controller helper:
+
+```ruby
+collector = ActiveRecord::Db::Metrics::Collector.new
+collector.start_monitoring
+
+# Your database operations here
+User.all
+User.create(name: "Alice")
+
+collector.stop_monitoring
+results = collector.results
+
+# => {
+#      total_queries: 2,
+#      crud_operations_by_table: {
+#        users: { SELECT: 1, INSERT: 1 }
+#      }
+#    }
+```
+
+## How It Works
+
+The gem subscribes to `ActiveSupport::Notifications` for SQL events and tracks:
+
+1. **Total query count**: How many SQL queries were executed
+2. **Operations by table**: Breakdown of INSERT, SELECT, UPDATE, DELETE per table
+3. **Accurate row counts**: Uses Rails 7.2+ `payload[:row_count]` for SELECT queries and `payload[:affected_rows]` for INSERT/UPDATE/DELETE operations
+
+### Bulk Operations
+
+This gem correctly counts the actual rows affected in bulk operations:
+
+```ruby
+User.insert_all([{name: "A"}, {name: "B"}, {name: "C"}])
+# => Counted as INSERT: 3 ✅
+```
+
+## Requirements
+
+- Ruby >= 3.4.0
+- Rails >= 7.2
+- ActiveRecord >= 7.2
+
+This gem requires Rails 7.2+ to utilize the `row_count` and `affected_rows` fields in `sql.active_record` notifications ([PR #50887](https://github.com/rails/rails/pull/50887)).
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bundle install
+```
+
+To run tests:
+
+```bash
+rake spec
+```
+
+To build the gem:
+
+```bash
+gem build activerecord-db-metrics.gemspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/activerecord/db/metrics/collector.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Db
+    module Metrics
+      # Collects and tracks database operation metrics during a request lifecycle
+      class Collector
+        CRUD_KEYWORDS = %w[INSERT UPDATE DELETE SELECT].freeze
+
+        def initialize
+          @query_count = 0
+          # Track CRUD operations per table
+          # Example: { users: { SELECT: 5, INSERT: 1 }, posts: { SELECT: 2 } }
+          @crud_counts_by_table = Hash.new { |hash, key| hash[key] = Hash.new(0) }
+        end
+
+        # Subscribe to ActiveRecord SQL notifications
+        def start_monitoring
+          @subscriber = ActiveSupport::Notifications.subscribe('sql.active_record', log_subscriber)
+        end
+
+        # Unsubscribe from ActiveRecord SQL notifications
+        def stop_monitoring
+          ActiveSupport::Notifications.unsubscribe(@subscriber) if @subscriber
+        end
+
+        # Get collected metrics
+        # @return [Hash] Hash containing :total_queries and :crud_operations_by_table
+        def results
+          {
+            total_queries: @query_count,
+            crud_operations_by_table: @crud_counts_by_table
+          }
+        end
+
+        private
+
+        def log_subscriber
+          lambda do |_name, _start, _finish, _id, payload|
+            next unless payload[:sql] && payload[:name] != 'SCHEMA'
+
+            @query_count += 1
+
+            # 1. Identify operation type (INSERT, SELECT, etc.)
+            operation = payload[:sql].strip.upcase.split.first
+
+            next unless CRUD_KEYWORDS.include?(operation)
+
+            # 2. Identify table name
+            table_name = payload[:table_name] || extract_table_name_from_sql(payload[:sql], operation)
+
+            next unless table_name
+
+            # 3. Get actual row count and record it
+            row_count = extract_row_count(payload, operation)
+            @crud_counts_by_table[table_name.to_sym][operation.to_sym] += row_count
+          end
+        end
+
+        # Extract actual row count from payload
+        # Rails 7.2+ provides:
+        # - payload[:row_count] for SELECT (number of rows returned)
+        # - payload[:affected_rows] for INSERT/UPDATE/DELETE (number of rows affected)
+        def extract_row_count(payload, operation)
+          case operation
+          when 'SELECT'
+            payload[:row_count] || 0
+          when 'INSERT', 'UPDATE', 'DELETE'
+            payload[:affected_rows] || 0
+          else
+            0
+          end
+        end
+
+        # Extract table name from SQL as fallback when payload[:table_name] is unavailable
+        def extract_table_name_from_sql(sql, operation)
+          sql_downcase = sql.downcase
+
+          case operation
+          when 'SELECT'
+            # Pattern: SELECT "users".* FROM "users"
+            match = sql_downcase.match(/from\s+["`]?(\w+)["`]?/)
+            match[1] if match
+          when 'INSERT'
+            # Pattern: INSERT INTO "users"
+            match = sql_downcase.match(/insert\s+into\s+["`]?(\w+)["`]?/)
+            match[1] if match
+          when 'UPDATE'
+            # Pattern: UPDATE "users" SET
+            match = sql_downcase.match(/update\s+["`]?(\w+)["`]?\s+set/)
+            match[1] if match
+          when 'DELETE'
+            # Pattern: DELETE FROM "users"
+            match = sql_downcase.match(/delete\s+from\s+["`]?(\w+)["`]?/)
+            match[1] if match
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/db/metrics/controller_helper.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Db
+    module Metrics
+      # Helper module to be included in Rails controllers
+      # Provides convenient methods to measure database operations
+      #
+      # @example Basic usage
+      #   class ApplicationController < ActionController::Base
+      #     include ActiveRecord::Db::Metrics::ControllerHelper
+      #     around_action :measure_db_operations
+      #   end
+      module ControllerHelper
+        extend ActiveSupport::Concern
+
+        private
+
+        # Measure database operations for the current action
+        # This method should be used as an around_action filter
+        def measure_db_operations
+          metrics = Collector.new
+          metrics.start_monitoring
+
+          yield # Execute the action
+
+          metrics.stop_monitoring
+          results = metrics.results
+
+          log_db_metrics(results)
+        end
+
+        # Log database metrics
+        # Override this method in your controller to customize logging behavior
+        #
+        # @param results [Hash] Metrics results containing :total_queries and :crud_operations_by_table
+        def log_db_metrics(results)
+          Rails.logger.info '--- DB Metrics for Request ---'
+          Rails.logger.info "Total DB Queries: #{results[:total_queries]}"
+
+          # Show breakdown by table
+          results[:crud_operations_by_table].each do |table, counts|
+            operations = %i[INSERT SELECT UPDATE DELETE].map do |op|
+              "#{op.to_s[0]}:#{counts[op]}"
+            end.join(', ')
+            total = counts.values.sum
+            Rails.logger.info "  [#{table.upcase}] #{operations} (Total: #{total})"
+          end
+
+          Rails.logger.info '------------------------------'
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/db/metrics/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Db
+    module Metrics
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/activerecord-db-metrics.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_record'
+
+require_relative 'activerecord/db/metrics/version'
+require_relative 'activerecord/db/metrics/collector'
+require_relative 'activerecord/db/metrics/controller_helper'
+
+module ActiveRecord
+  module Db
+    module Metrics
+      class Error < StandardError; end
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-db-metrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masato Kato
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description: A lightweight gem to monitor and measure database queries in Rails applications,
+  providing detailed metrics on CRUD operations per table including support for bulk
+  operations like insert_all.
+email:
+- masatokato0000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/activerecord-db-metrics.rb
+- lib/activerecord/db/metrics/collector.rb
+- lib/activerecord/db/metrics/controller_helper.rb
+- lib/activerecord/db/metrics/version.rb
+homepage: https://github.com/00Masato/activerecord-db-metrics
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/00Masato/activerecord-db-metrics
+  source_code_uri: https://github.com/00Masato/activerecord-db-metrics
+  changelog_uri: https://github.com/00Masato/activerecord-db-metrics/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Track and analyze ActiveRecord database operations per request
+test_files: []