rails-pg-extras 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91474e6c121e4a84110dd1b7fb9724012627696625d08ce73c38eb27b0398636
-  data.tar.gz: 50971a690cc8b350d1caf20d43776c7ff6b1927d394e55316a2203e9a00b1d72
+  metadata.gz: 72d0aaefc019490d3c298c7114d34fc55cc0f0b236f5edf8710a4bed290d96a5
+  data.tar.gz: bdcce61d6e4436aa74ca098c44d5e480c9a010aa246a375cf57be514e4c10c73
 SHA512:
-  metadata.gz: 3880fcea5eed8f047dcbfc733836b8f93f220b139a96a6b20f64e11f90de338fa0489b7644fc632df2b6947332692c4a78ec17f35124a7eb4f5a7931cfb2dab6
-  data.tar.gz: 148f28f307696d2d08acb81d4c61b8ed75bfc31823670bcd669b12a9eb37593d1081a0fe8959a6f11622426f3a4021b0226d99728f61be751915a6f7a7b57ad2
+  metadata.gz: 3004a52e1219060a9f82e7a84028a1ee042fa95b9ef3320f9f093bf1fc3909586ac1fc0f33fb75c417df1ddec6bbef6f31d2a1ebfd6fe71d99d7d8f2ff09e266
+  data.tar.gz: 48cc602df378555e04ec157afdb447d702c8dfc26efb155dba6c35da221ca38c079c226997bf0fe1ea471c819d56e4612adddf410e0cdeaf48169ac828273a1d

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,6 +193,20 @@ This method displays values for selected PostgreSQL settings. You can compare th
 
 [More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)
 
+### `ssl_used`
+
+```ruby
+
+RailsPGExtras.ssl_used
+
+| ssl_is_used                     |
++---------------------------------+
+| t                               |
+
+```
+
+Returns boolean indicating if an encrypted SSL is currently used. Connecting to the database via an unencrypted connection is a critical security risk.
+
 ### `index_usage`
 
 ```ruby
@@ -384,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
 
@@ -543,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
@@ -597,3 +639,4 @@ rake test_all
 - [https://github.com/heroku/heroku-pg-extras](https://github.com/heroku/heroku-pg-extras)
 - [https://hakibenita.com/postgresql-unused-index-size](https://hakibenita.com/postgresql-unused-index-size)
 - [https://sites.google.com/site/itmyshare/database-tips-and-examples/postgres/useful-sqls-to-check-contents-of-postgresql-shared_buffer](https://sites.google.com/site/itmyshare/database-tips-and-examples/postgres/useful-sqls-to-check-contents-of-postgresql-shared_buffer)
+- [https://wiki.postgresql.org/wiki/Index_Maintenance](https://wiki.postgresql.org/wiki/Index_Maintenance)

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/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.1.0"
+  VERSION = "3.1.0"
 end

data/lib/rails-pg-extras.rb

@@ -2,6 +2,8 @@
 
 require 'terminal-table'
 require 'ruby-pg-extras'
+require 'rails-pg-extras/diagnose_data'
+require 'rails-pg-extras/diagnose_print'
 
 module RailsPGExtras
   QUERIES = RubyPGExtras::QUERIES
@@ -44,6 +46,18 @@ 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.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

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.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-29 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.1.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -83,9 +83,12 @@ 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/railtie.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