active_record_query_stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7616eb499befdd021733555a3d398dac7b92e97d10ff68428e99f8d82f313cee
+  data.tar.gz: 9a2e50b46a3eb1fc891a73ed2389a5a78f6de22fbdaa63a5b3c792a6728e8f91
+SHA512:
+  metadata.gz: 5757368a32479b2d53f131df441524656142cc4e311b422a32f70c1a703e6983cb3107f76de17b046fc45615834996295b8b93d0424ff96ae4c1a6cc379ff4d8
+  data.tar.gz: e857808cd7cc2d5834a0d96c16033a33e72de951908ab516ef68ace4d3ce18fd6eca6e455f4bfeba7ec0c2ec47c52a59929a836d46e2d6dc899cfc3650b802dc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Tianwen (Tian) Chen
+
+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,82 @@
+# [ActiveRecordQueryStats](https://github.com/tian-im/active_record_query_stats)
+
+[![Gem Version](https://badge.fury.io/rb/active_record_query_stats.svg)](https://badge.fury.io/rb/active_record_query_stats)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9ba0a610043a2e1a9e74/maintainability)](https://codeclimate.com/github/tian-im/active_record_query_stats/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/9ba0a610043a2e1a9e74/test_coverage)](https://codeclimate.com/github/tian-im/active_record_query_stats/test_coverage)
+
+ActiveRecordQueryStats produces simple ActiveRecord query stats at the end of each request in the following format:
+
+```shell
+Query Stats
+-----------
+total: 6, real: 5, cached: 1
+select: 4, insert: 0, update: 1, delete: 0
+transaction: 0, savepoint: 0, lock: 0, rollback: 0, other: 0
+```
+
+- **total:** total queries occurred during the request.
+- **real:** queries having run against the database.
+- **cached:** queries that Rails encounters again and returns the cached result instead of hitting the database (see [SQL Caching](https://guides.rubyonrails.org/caching_with_rails.html#sql-caching)).
+- **select:** SELECT queries.
+- **insert:** INSERT queries.
+- **update:** UPDATE queries.
+- **delete:** DELETE queries.
+- **transaction:** TRANSACTION related queries.
+- **savepoint:** SAVEPOINT related queries.
+- **lock:** LOCK related queries.
+- **rollback:** ROLLBACK related queries.
+- **other:** the rest queries go here.
+
+## Install
+
+Add the following line to file `Gemfile`.
+
+```ruby
+gem 'active_record_query_stats', group: :development
+```
+
+And run re-bundle in terminal.
+
+```shell
+bundle install
+```
+
+That's it. Start the Rails server and see the stats!
+
+## Configuration
+
+The query stats template can be customized by overwriting the translation for `active_record_query_stats.stats_template`, e.g.:
+
+```yml
+# config/locales/en.yml
+en:
+  # ...
+  active_record_query_stats:
+    stats_template: |
+      Query Stats
+      -----------
+      total: %{total}, real: %{real}, cached: %{cached}
+      select: %{select}, insert: %{insert}, update: %{update}, delete: %{delete}
+      transaction: %{transaction}, savepoint: %{savepoint}, lock: %{lock}, rollback: %{rollback}, other: %{other}
+```
+
+## Implementation
+
+ActiveRecordQueryStats is based on the [Active Support Instrumentation](https://guides.rubyonrails.org/active_support_instrumentation.html) to implement the features by subscribing the following Rails events:
+
+- `sql.active_record`: collect and analyze the query executed by ActiveRecord from this event.
+- `process_action.action_controller`: display the stats when a request is finished.
+
+## Documentation
+
+- [API Reference](https://www.rubydoc.info/gems/active_record_query_stats)
+- [Change Logs](https://github.com/tian-im/active_record_query_stats/blob/master/CHANGELOG.md)
+
+## Want to contribute?
+
+Raise an [issue](https://github.com/tian-im/active_record_query_stats/issues/new), discuss and resolve!
+
+## License
+
+This project uses [MIT License](https://github.com/tian-im/active_record_query_stats/blob/master/LICENSE).

data/lib/active_record_query_stats/process_action_subscriber.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveRecordQueryStats
+  # NOTE: by inheriting from `ActionController::LogSubscriber`,
+  # it ensures to display the stats after the tranditional Rails stats
+  # e.g. `Completed 204 No Content in 170ms (ActiveRecord: 80.1ms | Allocations: 72539)`
+  class ProcessActionSubscriber < ActionController::LogSubscriber
+    def process_action(_event)
+      debug color(stats_display, MAGENTA)
+    end
+
+    private
+
+    def stats_display
+      I18n.t 'active_record_query_stats.stats_template', **summary.to_payload
+    end
+
+    def summary
+      Summary.call
+    end
+  end
+end

data/lib/active_record_query_stats/sql_event_analyzer.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'active_record_query_stats/summary'
+
+module ActiveRecordQueryStats
+  class SqlEventAnalyzer
+    def initialize(event)
+      @event = event
+    end
+
+    def call
+      return if skipping?
+
+      increase_total
+      return increase_cached if cached_query?
+
+      increase_real
+      increase_transaction_related || increase_statements || increase_other
+    end
+
+    private
+
+    delegate :payload, to: :@event
+    delegate(*Summary.instance_methods(false), to: :summary)
+
+    def increase_transaction_related
+      case payload[:sql]
+      when /\A\s*rollback/mi then increase_rollback
+      when /select .*for update/mi, /\A\s*lock/mi then increase_lock
+      when /transaction\s*\Z/i then increase_transaction
+      when /\A\s*(release )?savepoint/i then increase_savepoint
+      end
+    end
+
+    def increase_statements
+      case payload[:sql]
+      when /\A\s*select/i then increase_select
+      when /\A\s*insert/i then increase_insert
+      when /\A\s*update/i then increase_update
+      when /\A\s*delete/i then increase_delete
+      end
+    end
+
+    def summary
+      Summary.call
+    end
+
+    def skipping?
+      schema_query? || schema_migration_query? || explain_query?
+    end
+
+    def schema_query?
+      /SCHEMA/i =~ payload[:name]
+    end
+
+    def schema_migration_query?
+      /schema_migrations/i =~ payload[:sql]
+    end
+
+    def explain_query?
+      /EXPLAIN/i =~ payload[:name]
+    end
+
+    def cached_query?
+      /CACHE/i =~ payload[:name] || payload[:cached]
+    end
+  end
+end

data/lib/active_record_query_stats/sql_subscriber.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_record_query_stats/sql_event_analyzer'
+
+module ActiveRecordQueryStats
+  class SqlSubscriber < ActiveRecord::LogSubscriber
+    def sql(event)
+      SqlEventAnalyzer.new(event).call
+    end
+  end
+end

data/lib/active_record_query_stats/summary.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ActiveRecordQueryStats
+  class Summary
+    STATS = %i[
+      total real cached
+      select insert update delete
+      transaction savepoint lock rollback other
+    ].freeze
+
+    def self.call
+      RequestStore[:active_record_query_stats] ||= new
+    end
+
+    STATS.each do |field|
+      define_method field do
+        instance_variable_get(:"@#{field}") || 0
+      end
+
+      define_method :"increase_#{field}" do
+        instance_variable_set :"@#{field}", try(field) + 1
+      end
+    end
+
+    def to_payload
+      STATS.each_with_object({}) do |field, memo|
+        memo[field] = try field
+      end
+    end
+  end
+end

data/lib/active_record_query_stats/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordQueryStats
+  VERSION = '0.1.0'
+end

data/lib/active_record_query_stats.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'i18n'
+require 'request_store'
+require 'active_support'
+require 'active_record/log_subscriber'
+require 'action_controller'
+require 'action_controller/log_subscriber'
+
+require 'active_record_query_stats/sql_subscriber'
+require 'active_record_query_stats/process_action_subscriber'
+
+# This lib utilizes the Active Support Instrumentation system
+# @see https://guides.rubyonrails.org/active_support_instrumentation.html
+module ActiveRecordQueryStats
+  # Setup I18n
+  I18n.load_path += Dir[File.join(__dir__, 'locales', 'active_record_query_stats.en.yml')]
+  I18n.reload! if I18n.backend.initialized?
+
+  # @see https://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record
+  SqlSubscriber.attach_to :active_record
+
+  # @see https://guides.rubyonrails.org/active_support_instrumentation.html#process-action-action-controller
+  ProcessActionSubscriber.attach_to :action_controller
+end

data/lib/locales/active_record_query_stats.en.yml

@@ -0,0 +1,8 @@
+en:
+  active_record_query_stats:
+    stats_template: |
+      Query Stats
+      -----------
+      total: %{total}, real: %{real}, cached: %{cached}
+      select: %{select}, insert: %{insert}, update: %{update}, delete: %{delete}
+      transaction: %{transaction}, savepoint: %{savepoint}, lock: %{lock}, rollback: %{rollback}, other: %{other}

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: active_record_query_stats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tian Chen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Query Stats logging for ActiveRecord
+email:
+- me@tian.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/active_record_query_stats.rb
+- lib/active_record_query_stats/process_action_subscriber.rb
+- lib/active_record_query_stats/sql_event_analyzer.rb
+- lib/active_record_query_stats/sql_subscriber.rb
+- lib/active_record_query_stats/summary.rb
+- lib/active_record_query_stats/version.rb
+- lib/locales/active_record_query_stats.en.yml
+homepage: https://github.com/tian-im/active_record_query_stats
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tian-im/active_record_query_stats
+  source_code_uri: https://github.com/tian-im/active_record_query_stats
+  changelog_uri: https://github.com/tian-im/active_record_query_stats/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Query Stats logging for ActiveRecord
+test_files: []