rails-pg-extras 2.2.0 → 3.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50ec4785963ebe2582c746a07b4837bc7111057bfb968d97d55b9ffeaeba5fd5
-  data.tar.gz: c5468e40d1ffcebe54d9993a85fa5197a54c1e23fc6a103d47475571c21fb311
+  metadata.gz: e274fc39b73b8bdaf1b0f0f2a92fed8024e99b2796b208967f87d796ae9edbd2
+  data.tar.gz: 34cdb4362d0fd7240c4eac857cfd24d342a4e99eed7cda2eb20791bd8bce6c86
 SHA512:
-  metadata.gz: 1fd7ea62b34b1c9a3fcc090bcfb6f5df17223f5208b10bd848ad4bc04e0a2ef8772467edc16cff15dd070a63e5cd23466b334bec9b877efcb033ebe19dec2a77
-  data.tar.gz: 6cbf078dd0a56f9a9cdfac8bac27557b2192f29df9f491807f6e66e994e256fe710df061500198efffcb6bb1f847899a11bd166b73f643b73a55cda7b8675dac
+  metadata.gz: d9045c9281c65bb9648898102d534e0cecc05a675949cd394900e8b7c821fb46b69e93e4fbb6243d470a77568858ce3295f61c95ce86737e604f7b687cbf05bd
+  data.tar.gz: fa66c8f4f06f233a2a2a8288d69c5e4fb257c1c2801f4c7f8c90bac722a4d82cce439759c2fe893986043ba3a30816ccd31e155ed6ab8e1666717d34a549cb5f

data/.circleci/config.yml

@@ -31,7 +31,8 @@ jobs:
       - checkout
       - run: gem update --system
       - run: gem install bundler
-      - run: bundle install --path vendor/bundle
+      - run: bundle config set --local path 'vendor/bundle'
+      - run: bundle install
       - run: sudo apt-get update --allow-releaseinfo-change
       - run: sudo apt install postgresql-client
       - run: dockerize -wait tcp://postgres11:5432 -timeout 1m

data/README.md

@@ -32,7 +32,7 @@ In your Gemfile
 gem "rails-pg-extras"
 ```
 
-Some of the queries (e.g., `calls` and `outliers`) require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension enabled.
+`calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension.
 
 You can check if it is enabled in your database by running:
 
@@ -45,6 +45,12 @@ You should see the similar line in the output:
 | pg_stat_statements  | 1.7  | 1.7 | track execution statistics of all SQL statements executed |
 ```
 
+`ssl_used` requires `sslinfo` extension, and `buffercache_usage`/`buffercache_usage` queries need `pg_buffercache`. You can enable them all by running:
+
+```ruby
+RailsPGExtras.add_extensions
+```
+
 ## Usage
 
 Each command can be used as a rake task, or a directly from the Ruby code.
@@ -91,6 +97,20 @@ RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 ```
 
+## Diagnose report
+
+The simplest way to start using pg-extras is to execute a `diagnose` method. It runs a set of checks and prints out a report highlighting areas that may require additional investigation:
+
+```ruby
+RailsPGExtras.diagnose
+
+$ rake pg_extras:diagnose
+```
+
+![Diagnose report](https://github.com/pawurb/rails-pg-extras/raw/master/rails-pg-extras-diagnose.png)
+
+Keep reading to learn about methods that `diagnose` uses under the hood.
+
 ## Available methods
 
 ### `cache_hit`
@@ -173,7 +193,7 @@ This method displays values for selected PostgreSQL settings. You can compare th
 
 [More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)
 
-### 'ssl_used'
+### `ssl_used`
 
 ```ruby
 
@@ -398,7 +418,7 @@ This command displays the total size of each table and materialized view in the
 ### `unused_indexes`
 
 ```ruby
-RailsPGExtras.unused_indexes(args: { min_scans: 20 })
+RailsPGExtras.unused_indexes(args: { max_scans: 20 })
 
 $ rake pg_extras:unused_indexes
 
@@ -557,6 +577,14 @@ 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.
 
+### `pg_stat_statements_reset`
+
+```ruby
+RailsPGExtras.pg_stat_statements_reset
+```
+
+This command discards all statistics gathered so far by pg_stat_statements.
+
 ### `buffercache_stats`
 
 ```ruby

data/lib/rails-pg-extras/diagnose_data.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class DiagnoseData < RubyPGExtras::DiagnoseData
+
+    private
+
+    def query_module
+      RailsPGExtras
+    end
+  end
+end

data/lib/rails-pg-extras/diagnose_print.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class DiagnosePrint < RubyPGExtras::DiagnosePrint
+
+    private
+
+    def title
+      "rails-pg-extras - diagnose report"
+    end
+  end
+end

data/lib/rails-pg-extras/index_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class IndexInfo < RubyPGExtras::IndexInfo
+    private
+
+    def query_module
+      RailsPGExtras
+    end
+  end
+end

data/lib/rails-pg-extras/index_info_print.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class IndexInfoPrint < RubyPGExtras::IndexInfoPrint
+  end
+end

data/lib/rails-pg-extras/table_info.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class TableInfo < RubyPGExtras::TableInfo
+    private
+
+    def query_module
+      RailsPGExtras
+    end
+  end
+end

data/lib/rails-pg-extras/table_info_print.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  class TableInfoPrint < RubyPGExtras::TableInfoPrint
+  end
+end

data/lib/rails-pg-extras/tasks/all.rake

@@ -19,4 +19,9 @@ namespace :pg_extras do
       RailsPGExtras.public_send(query_name)
     end
   end
+
+  desc "Generate a PostgreSQL healthcheck report"
+  task diagnose: :establish_connection do
+    RailsPGExtras.diagnose
+  end
 end

data/lib/rails-pg-extras/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsPGExtras
-  VERSION = "2.2.0"
+  VERSION = "3.2.2"
 end

data/lib/rails-pg-extras.rb

@@ -2,6 +2,12 @@
 
 require 'terminal-table'
 require 'ruby-pg-extras'
+require 'rails-pg-extras/diagnose_data'
+require 'rails-pg-extras/diagnose_print'
+require 'rails-pg-extras/index_info'
+require 'rails-pg-extras/index_info_print'
+require 'rails-pg-extras/table_info'
+require 'rails-pg-extras/table_info_print'
 
 module RailsPGExtras
   QUERIES = RubyPGExtras::QUERIES
@@ -44,6 +50,46 @@ module RailsPGExtras
     )
   end
 
+  def self.diagnose(in_format: :display_table)
+    data = RailsPGExtras::DiagnoseData.call
+
+    if in_format == :display_table
+      RailsPGExtras::DiagnosePrint.call(data)
+    elsif in_format == :hash
+      data
+    else
+      raise "Invalid 'in_format' argument!"
+    end
+  end
+
+  def self.index_info(args: {}, in_format: :display_table)
+    data = RailsPGExtras::IndexInfo.call(args[:table_name])
+
+    if in_format == :display_table
+      RailsPGExtras::IndexInfoPrint.call(data)
+    elsif in_format == :hash
+      data
+    elsif in_format == :array
+      data.map(&:values)
+    else
+      raise "Invalid 'in_format' argument!"
+    end
+  end
+
+  def self.table_info(args: {}, in_format: :display_table)
+    data = RailsPGExtras::TableInfo.call(args[:table_name])
+
+    if in_format == :display_table
+      RailsPGExtras::TableInfoPrint.call(data)
+    elsif in_format == :hash
+      data
+    elsif in_format == :array
+      data.map(&:values)
+    else
+      raise "Invalid 'in_format' argument!"
+    end
+  end
+
   def self.connection
     ActiveRecord::Base.connection
   end

data/spec/smoke_spec.rb

@@ -3,11 +3,6 @@
 require 'spec_helper'
 
 describe RailsPGExtras do
-  before(:all) do
-    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
-    RubyPGExtras.connection.exec("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
-  end
-
   RailsPGExtras::QUERIES.each do |query_name|
     it "#{query_name} query can be executed" do
       expect do
@@ -18,4 +13,18 @@ describe RailsPGExtras do
       end.not_to raise_error
     end
   end
+
+  it "runs the custom methods" do
+    expect do
+      RailsPGExtras.diagnose(in_format: :hash)
+    end.not_to raise_error
+
+    expect do
+      RailsPGExtras.index_info(in_format: :hash)
+    end.not_to raise_error
+
+    expect do
+      RailsPGExtras.table_info(in_format: :hash)
+    end.not_to raise_error
+  end
 end

data/spec/spec_helper.rb

@@ -24,6 +24,9 @@ RSpec.configure do |config|
     ActiveRecord::Base.establish_connection(
       ENV.fetch("DATABASE_URL")
     )
+    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_stat_statements;")
+    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_buffercache;")
+    RailsPGExtras.connection.execute("CREATE EXTENSION IF NOT EXISTS sslinfo;")
   end
 
   config.after :suite do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.2.2
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-26 00:00:00.000000000 Z
+date: 2021-12-18 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: 2.2.0
+        version: 3.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.2.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -83,9 +83,16 @@ files:
 - Rakefile
 - docker-compose.yml.sample
 - lib/rails-pg-extras.rb
+- lib/rails-pg-extras/diagnose_data.rb
+- lib/rails-pg-extras/diagnose_print.rb
+- lib/rails-pg-extras/index_info.rb
+- lib/rails-pg-extras/index_info_print.rb
 - lib/rails-pg-extras/railtie.rb
+- lib/rails-pg-extras/table_info.rb
+- lib/rails-pg-extras/table_info_print.rb
 - lib/rails-pg-extras/tasks/all.rake
 - lib/rails-pg-extras/version.rb
+- rails-pg-extras-diagnose.png
 - rails-pg-extras-web.png
 - rails-pg-extras.gemspec
 - spec/smoke_spec.rb
@@ -109,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Rails PostgreSQL performance database insights