rails-pg-extras 4.8.1 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acfc146396c33697f24aa0e96d251c77fd94e2a5d10a8154dcff9df02a981ac8
-  data.tar.gz: 5290474635b58a4e35afd3c075726b24e75a6194acd691e5b90b5b3289f2b5f1
+  metadata.gz: 4bd83f21b85de2b816dc334b72ad1bd0dfcb0f13ea6946fec42ebb93f47ba876
+  data.tar.gz: 4e9e5b00cc7e07cf3baa1bc3e224fe8ab50510afa909b47e753873fb1e7a11e7
 SHA512:
-  metadata.gz: 3db2562f135d7b904239f5481d5050f1404062b679fa9dc1399379bea58f66c981d7adadee8d5af34ff4e5c0ffc10f6cd1de2c3fab03923083c45fa11d24785b
-  data.tar.gz: 91b734c2c9bc9e6678d50def9cc4603e5444f35b16ec90514e14644954fa1d8d8e4b014c287dc2beb2cb9edfc3cadd29f517ad3f4fd42a37872304b91c5c553b
+  metadata.gz: 1a30823d47f9e0cab719b7ee6e750da28c751f4dc20d21756f7f3a633c07dd6390397e09502300cfcf9185184a9e00af83de40f2fd9b12a6319a6ade31ccb26f
+  data.tar.gz: f01d58920638949122f26a74857cdab232168b274aee2d28d180eed09ea60a48ace036aa3ba772dc8ce41893d6e4a4397255167bc5ccf699a181c7205438ed93

data/README.md

@@ -51,6 +51,12 @@ 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, 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"
+```
+
 ## Usage
 
 Each command can be used as a rake task, or a directly from the Ruby code.
@@ -119,7 +125,7 @@ You can enable UI using a Rails engine by adding the following code in `config/r
   mount RailsPgExtras::Web::Engine, at: 'pg_extras'
 ```
 
-You can enable HTTP basic auth by specifying `RAILS_PG_EXTRAS_USER` and `RAILS_PG_EXTRAS_PASSWORD` variables. Authentication is mandatory unless you specify `RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true`.
+You can enable HTTP basic auth by specifying `RAILS_PG_EXTRAS_USER` and `RAILS_PG_EXTRAS_PASSWORD` variables. Authentication is mandatory unless you specify `RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true` or setting `RailsPgExtras.configuration.public_dashboard` to `true`.
 
 You can configure available web actions in `config/initializers/rails_pg_extras.rb`:
 
@@ -134,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 in miliseconds. 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
+
+RailsPgExtras.measure_queries { User.limit(10).map(&:team) }
+
+{:count=>11,
+ :queries=>
+  {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>
+    {:count=>1,
+     :total_duration=>3.452000004472211,
+     :min_duration=>3.452000004472211,
+     :max_duration=>3.452000004472211,
+     :avg_duration=>3.452000004472211},
+   "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" = $1 LIMIT $2"=>
+    {:count=>10,
+     :total_duration=>14.487000000372063,
+     :min_duration=>0.778000001446344,
+     :max_duration=>1.985000002605375,
+     :avg_duration=>1.4487000000372063}},
+ :total_duration=>24.812000003294088,
+ :sql_duration=>17.939000004844274}
+
+RailsPgExtras.measure_queries { User.limit(10).includes(:team).map(&:team) }
+
+{:count=>2,
+ :queries=>
+  {"SELECT \"users\".* FROM \"users\" LIMIT $1"=>
+    {:count=>1,
+     :total_duration=>3.7079999965499155,
+     :min_duration=>3.7079999965499155,
+     :max_duration=>3.7079999965499155,
+     :avg_duration=>3.7079999965499155},
+   "SELECT \"teams\".* FROM \"teams\" WHERE \"teams\".\"id\" IN ($1, $2, $3, $4, $5, $6, $7, $8)"=>
+    {:count=>1,
+     :total_duration=>2.422000005026348,
+     :min_duration=>2.422000005026348,
+     :max_duration=>2.422000005026348,
+     :avg_duration=>2.422000005026348}},
+ :total_duration=>9.905999999318738,
+ :sql_duration=>6.1300000015762635}
+
+```
+
 ### `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.
@@ -282,7 +334,7 @@ This command provides information on the efficiency of indexes, represented as w
 ### `locks`
 
 ```ruby
-RailsPgExtras.locks
+RailsPgExtras.locks(args: { limit: 20 })
 
 $ rake pg_extras:locks
 
@@ -630,6 +682,16 @@ RailsPgExtras.kill_all
 
 This commands kills all the currently active connections to the database. It can be useful as a last resort when your database is stuck in a deadlock.
 
+### `kill_pid`
+
+```ruby
+
+RailsPgExtras.kill_pid(args: { pid: 4657 })
+
+```
+
+This commands kills currently active database connection by its `pid` number. You can use `connections` method to find the correct `pid` values.
+
 ### `pg_stat_statements_reset`
 
 ```ruby
@@ -669,6 +731,25 @@ $ rake pg_extras:extensions
 
 This command lists all the currently installed and available PostgreSQL extensions.
 
+### `connections`
+
+```ruby
+
+RailsPgExtras.connections
+
++----------------------------------------------------------------+
+|      Returns the list of all active database connections       |
++------------------+--------------------------+------------------+
+| username | pid   | client_address           | application_name |
++------------------+--------------------------+------------------+
+| postgres | 15962 | 172.31.69.166/32         | sidekiq          |
+| postgres | 16810 | 172.31.69.166/32         | bin/rails        |
++------------------+--------------------------+------------------+
+
+```
+
+This command returns the list of all active database connections.
+
 ### mandelbrot
 
 ```ruby

data/app/controllers/rails_pg_extras/web/application_controller.rb

@@ -19,7 +19,7 @@ module RailsPgExtras::Web
     end
 
     def validate_credentials!
-      if (ENV['RAILS_PG_EXTRAS_USER'].blank? || ENV['RAILS_PG_EXTRAS_PASSWORD'].blank?) && ENV["RAILS_PG_EXTRAS_PUBLIC_DASHBOARD"] != "true"
+      if (ENV['RAILS_PG_EXTRAS_USER'].blank? || ENV['RAILS_PG_EXTRAS_PASSWORD'].blank?) && !RailsPgExtras.configuration.public_dashboard
         raise "Missing credentials for rails-pg-extras dashboard! If you want to enable public dashboard please set RAILS_PG_EXTRAS_PUBLIC_DASHBOARD=true"
       end
     end

data/lib/rails-pg-extras.rb

@@ -62,6 +62,62 @@ 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)
+    (ending - starting) * 1000
+  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) * 1000
+        queries[key][:total_duration] += duration
+        sql_duration += duration
+
+        if queries[key][:min_duration] == nil || queries[key][:min_duration] > duration
+          queries[key][:min_duration] = duration.round(2)
+        end
+
+        if queries[key][:max_duration] == nil || queries[key][:max_duration] < duration
+          queries[key][:max_duration] = duration.round(2)
+        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]).round(2)
+      val[1][:total_duration] = val[1][:total_duration].round(2)
+      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.round(2),
+      sql_duration: sql_duration.round(2)
+    }
+  end
+
+
   def self.index_info(args: {}, in_format: :display_table)
     data = RailsPgExtras::IndexInfo.call(args[:table_name])
 
@@ -91,7 +147,11 @@ module RailsPgExtras
   end
 
   def self.connection
-    ActiveRecord::Base.connection
+    if (db_url = ENV['RAILS_PG_EXTRAS_DATABASE_URL'])
+      ActiveRecord::Base.establish_connection(db_url).connection
+    else
+      ActiveRecord::Base.connection
+    end
   end
 end
 

data/lib/rails_pg_extras/configuration.rb

@@ -4,12 +4,14 @@ require "rails_pg_extras/web"
 
 module RailsPgExtras
   class Configuration
-    DEFAULT_CONFIG = { enabled_web_actions: Web::ACTIONS - [:kill_all] }
+    DEFAULT_CONFIG = { enabled_web_actions: Web::ACTIONS - [:kill_all], public_dashboard: ENV["RAILS_PG_EXTRAS_PUBLIC_DASHBOARD"] == "true" }
 
     attr_reader :enabled_web_actions
+    attr_accessor :public_dashboard
 
     def initialize(attrs)
       self.enabled_web_actions = attrs[:enabled_web_actions]
+      self.public_dashboard = attrs[:public_dashboard]
     end
 
     def enabled_web_actions=(*actions)

data/lib/rails_pg_extras/version.rb

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

data/spec/smoke_spec.rb

@@ -28,4 +28,19 @@ describe RailsPgExtras do
       RailsPgExtras.table_info(in_format: :hash)
     end.not_to raise_error
   end
+
+  it "collecting queries data works" do
+    output = RailsPgExtras.measure_queries { 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']
+
+    expect do
+      RailsPgExtras.calls
+    end.not_to raise_error
+
+    ENV['RAILS_PG_EXTRAS_DATABASE_URL'] = nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 5.2.1
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2023-03-01 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.8.1
+        version: 5.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 5.2.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement