rails-pg-extras 4.13.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8b00ae8cb079824ce1de1284ccf30cca423e27d361a1e70a05066688f0ee094
-  data.tar.gz: e76d91e64b1949a0a92c6255390de16e6e0ce7345835c03d8166db1092173c0f
+  metadata.gz: 1f7109cdaf06d94ed2a1707fffcd477a471c84ece3e648e4279f602f27e89b67
+  data.tar.gz: 583b204cfad10e9c3602946d5e00d0c10eaf1a7407e7234fc1f22db154e22bab
 SHA512:
-  metadata.gz: 8288bd8a17c6a44f179595c7b82efc4c4384b55cbfaebd679a73f37dda8e68fcf80a8f02868f93b82c45382be66c0f8fa81a4d83e72765dc18abf67929f1454b
-  data.tar.gz: 378693843abc170d78cab4c0da0a2108a7f831f7c48805cb78ec020b1dfc1ded2458d50b04deb884675313a13d1178e7d942c778386109ba9148c2e169869b78
+  metadata.gz: a3f334dcdf081777134219ab9f3c6ca0a0e95ca36495d71447690526c71bf893960219bda40d12c82973a2779131ff6977e99a141829f3a4121378b65d8e1659
+  data.tar.gz: 8eb2229994c72de036a4cf5e865b2503efcb831dd12c1182e4b45d43956cc89ffecb44f2bb1b7fe7a5ab50b82f4a662ddf2f7bee3756cac054d75639c8c5a6e2

data/README.md

@@ -51,7 +51,7 @@ You should see the similar line in the output:
 RailsPgExtras.add_extensions
 ```
 
-By deafult a primary ActiveRecord database connection is used for running metadata queries. To connect to a different database you can specify an `ENV['RAILS_PG_EXTRAS_DATABASE_URL']` value in the following format:
+By deafult a primary ActiveRecord database connection is used for running metadata queries, rake tasks and web UI. To connect to a different database you can specify an `ENV['RAILS_PG_EXTRAS_DATABASE_URL']` value in the following format:
 
 ```ruby
 ENV["RAILS_PG_EXTRAS_DATABASE_URL"] = "postgresql://postgres:secret@localhost:5432/database_name"
@@ -140,6 +140,52 @@ end
 
 ## Available methods
 
+### `measure_queries`
+
+This method displays query types executed when running a provided Ruby snippet, with their avg., min., max., and total duration. It also outputs info about the snippet execution duration and the portion spent running SQL queries (`total_duration`/`sql_duration`). It can help debug N+1 issues and review the impact of configuring eager loading:
+
+```ruby
+
+User.measure_queries { User.limit(10).map(&:team) }
+
+# {:count=>11,
+#  :queries=>
+#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>
+#     {:count=>1,
+#      :total_duration=>0.003183000022545457,
+#      :min_duration=>0.003183000022545457,
+#      :max_duration=>0.003183000022545457,
+#      :avg_duration=>0.003183000022545457},
+#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" = $1 LIMIT $2"=>
+#     {:count=>10,
+#      :total_duration=>0.011682000011205673,
+#      :min_duration=>0.0007209999894257635,
+#      :max_duration=>0.0024030000204220414,
+#      :avg_duration=>0.0011682000011205673}},
+#  :total_duration=>0.15247199998702854,
+#  :sql_duration=>0.01486500003375113}
+
+User.measure_queries { User.limit(10).includes(:team).map(&:team) }
+
+# {:count=>2,
+#  :queries=>
+#   {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>
+#     {:count=>1,
+#      :total_duration=>0.0036189999955240637,
+#      :min_duration=>0.0036189999955240637,
+#      :max_duration=>0.0036189999955240637,
+#      :avg_duration=>0.0036189999955240637},
+#    "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" IN ($1, $2, $3, $4, $5, $6, $7, $8)"=>
+#     {:count=>1,
+#      :total_duration=>0.003714999998919666,
+#      :min_duration=>0.003714999998919666,
+#      :max_duration=>0.003714999998919666,
+#      :avg_duration=>0.003714999998919666}},
+#  :total_duration=>0.023814999993192032,
+#  :sql_duration=>0.0073339999944437295}
+
+```
+
 ### `table_info`
 
 This method displays metadata metrics for all or a selected table. You can use it to check the table's size, its cache hit metrics, and whether it is correctly indexed. Many sequential scans or no index scans are potential indicators of misconfigured indexes. This method aggregates data provided by other methods in an easy to analyze summary format.

data/lib/rails-pg-extras.rb

@@ -62,6 +62,61 @@ module RailsPgExtras
     end
   end
 
+  def self.measure_duration(&block)
+    starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    block.call
+    ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    elapsed = ending - starting
+    elapsed
+  end
+
+  def self.measure_queries(&block)
+    queries = {}
+    sql_duration = 0
+
+    method_name = if ActiveSupport::Notifications.respond_to?(:monotonic_subscribe)
+      :monotonic_subscribe
+    else
+      :subscribe
+    end
+
+    subscriber = ActiveSupport::Notifications.public_send(method_name, "sql.active_record") do |_name, start, finish, _id, payload|
+      unless payload[:name] =~ /SCHEMA/
+        key = payload[:sql]
+        queries[key] ||= { count: 0, total_duration: 0, min_duration: nil, max_duration: nil }
+        queries[key][:count] += 1
+        duration = finish - start
+        queries[key][:total_duration] += duration
+        sql_duration += duration
+
+        if queries[key][:min_duration] == nil || queries[key][:min_duration] > duration
+          queries[key][:min_duration] = duration
+        end
+
+        if queries[key][:max_duration] == nil || queries[key][:max_duration] < duration
+          queries[key][:max_duration] = duration
+        end
+      end
+    end
+
+    total_duration = measure_duration do
+      block.call
+    end
+
+    queries = queries.reduce({}) do |agg, val|
+      val[1][:avg_duration] = val[1][:total_duration] / val[1][:count]
+      agg.merge(val[0] => val[1])
+    end
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+    {
+      count: queries.reduce(0) { |agg, val| agg + val[1].fetch(:count) },
+      queries: queries,
+      total_duration: total_duration,
+      sql_duration: sql_duration
+    }
+  end
+
   def self.index_info(args: {}, in_format: :display_table)
     data = RailsPgExtras::IndexInfo.call(args[:table_name])
 

data/lib/rails_pg_extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPgExtras
-  VERSION = "4.13.0"
+  VERSION = "5.1.0"
 end

data/spec/smoke_spec.rb

@@ -29,6 +29,11 @@ describe RailsPgExtras do
     end.not_to raise_error
   end
 
+  it "collecting queries data works" do
+    output = RailsPgExtras.queries_data { RailsPgExtras.diagnose(in_format: :hash) }
+    expect(output.fetch(:count)).to eq 10
+  end
+
   it "supports custom RAILS_PG_EXTRAS_DATABASE_URL" do
     ENV['RAILS_PG_EXTRAS_DATABASE_URL'] = ENV['DATABASE_URL']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.13.0
+  version: 5.1.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.13.0
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.13.0
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement