rails-pg-extras 1.5.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '039398a75ef2c3ce82ef8760784fc14d4d05496f590d64374a6863a4eb200b08'
-  data.tar.gz: 82d2d82c66aed09fff9276cf76a28ecb994175257ce9c0857cc5b3fd59d4b81e
+  metadata.gz: 50ec4785963ebe2582c746a07b4837bc7111057bfb968d97d55b9ffeaeba5fd5
+  data.tar.gz: c5468e40d1ffcebe54d9993a85fa5197a54c1e23fc6a103d47475571c21fb311
 SHA512:
-  metadata.gz: 25305f71d527acb17f81b8e9e9f8c2b1420f7e07d8a43924eb69043f9be63ea578482e63c68a2800f6adf8b00d53472895ee8a0897a26a7ec0ec750b5250b94e
-  data.tar.gz: 4d6f3706e52305a885da9351b5e752cffadef0a074bf1139d362622adb37baa0409e103f59458141811e875a01581560fdce6702884cfbffeda88da70f98ec35
+  metadata.gz: 1fd7ea62b34b1c9a3fcc090bcfb6f5df17223f5208b10bd848ad4bc04e0a2ef8772467edc16cff15dd070a63e5cd23466b334bec9b877efcb033ebe19dec2a77
+  data.tar.gz: 6cbf078dd0a56f9a9cdfac8bac27557b2192f29df9f491807f6e66e994e256fe710df061500198efffcb6bb1f847899a11bd166b73f643b73a55cda7b8675dac

data/.circleci/config.yml

@@ -6,6 +6,22 @@ jobs:
         environment:
           DATABASE_URL: postgresql://postgres:secret@localhost:5432/rails-pg-extras-test
       - image: circleci/postgres:11.5
+        command: postgres -c shared_preload_libraries=pg_stat_statements
+        name: postgres11
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: rails-pg-extras-test
+          POSTGRES_PASSWORD: secret
+      - image: circleci/postgres:12.7
+        command: postgres -c shared_preload_libraries=pg_stat_statements
+        name: postgres12
+        environment:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: rails-pg-extras-test
+          POSTGRES_PASSWORD: secret
+      - image: circleci/postgres:13.3
+        command: postgres -c shared_preload_libraries=pg_stat_statements
+        name: postgres13
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: rails-pg-extras-test
@@ -16,13 +32,24 @@ jobs:
       - run: gem update --system
       - run: gem install bundler
       - run: bundle install --path vendor/bundle
-      - run: sudo apt-get update
+      - run: sudo apt-get update --allow-releaseinfo-change
       - run: sudo apt install postgresql-client
-      - run: dockerize -wait tcp://localhost:5432 -timeout 1m
+      - run: dockerize -wait tcp://postgres11:5432 -timeout 1m
+      - run:
+          name: Run specs for PG 11
+          environment:
+            DATABASE_URL: postgresql://postgres:secret@postgres11:5432/rails-pg-extras-test
+          command: bundle exec rspec spec/
+      - run:
+          name: Run specs for PG 12
+          environment:
+            DATABASE_URL: postgresql://postgres:secret@postgres12:5432/rails-pg-extras-test
+          command: bundle exec rspec spec/
       - run:
-          name: Run specs
-          command: |
-            bundle exec rspec spec/
+          name: Run specs for PG 13
+          environment:
+            DATABASE_URL: postgresql://postgres:secret@postgres13:5432/rails-pg-extras-test
+          command: bundle exec rspec spec/
 workflows:
   version: 2
   test:

data/README.md

@@ -4,7 +4,13 @@ Rails port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras) wit
 
 Included rake tasks and Ruby methods can be used to obtain information about a Postgres instance, that may be useful when analyzing performance issues. This includes information about locks, index usage, buffer cache hit ratios and vacuum statistics. Ruby API enables developers to easily integrate the tool into e.g. automatic monitoring tasks.
 
-You can check out this blog post for detailed step by step tutorial on how to [optimize PostgreSQL using PG Extras library](https://pawelurbanek.com/postgresql-fix-performance).
+You can read this blog post for detailed step by step tutorial on how to [optimize PostgreSQL using PG Extras library](https://pawelurbanek.com/postgresql-fix-performance).
+
+**Shameless plug:** rails-pg-extras is one of the tools that I use when conducting Rails performance audits. [Check out my offer](https://pawelurbanek.com/#rails-performance-tuning) if you need help with fine-tuning your app.
+
+Use [rails-pg-extras-web](https://github.com/defkode/rails-pg-extras-web) if you want to see SQL metrics in the UI instead of a command line interface.
+
+![Web interface](https://github.com/pawurb/rails-pg-extras/raw/master/rails-pg-extras-web.png)
 
 Alternative versions:
 
@@ -165,6 +171,22 @@ $ rake pg_extras:db_settings
 
 This method displays values for selected PostgreSQL settings. You can compare them with settings recommended by [PGTune](https://pgtune.leopard.in.ua/#/) and tweak values to improve performance.
 
+[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
@@ -219,7 +241,7 @@ This command displays all the current locks, regardless of their type.
 ### `outliers`
 
 ```ruby
-RubyPGExtras.outliers(args: { limit: 20 })
+RailsPGExtras.outliers(args: { limit: 20 })
 
 $ rake pg_extras:outliers
 
@@ -243,7 +265,7 @@ Typically, an efficient query will have an appropriate ratio of calls to total e
 ### `calls`
 
 ```ruby
-RubyPGExtras.calls(args: { limit: 10 })
+RailsPGExtras.calls(args: { limit: 10 })
 
 $ rake pg_extras:calls
 
@@ -264,7 +286,7 @@ This command is much like `pg:outliers`, but ordered by the number of times a st
 ### `blocking`
 
 ```ruby
-RubyPGExtras.blocking
+RailsPGExtras.blocking
 
 $ rake pg_extras:blocking
 
@@ -281,7 +303,7 @@ This command displays statements that are currently holding locks that other sta
 ### `total_index_size`
 
 ```ruby
-RubyPGExtras.total_index_size
+RailsPGExtras.total_index_size
 
 $ rake pg_extras:total_index_size
 
@@ -296,7 +318,7 @@ This command displays the total size of all indexes on the database, in MB. It i
 ### `index_size`
 
 ```ruby
-RubyPGExtras.index_size
+RailsPGExtras.index_size
 
 $ rake pg_extras:index_size
                              name                              |  size
@@ -319,7 +341,7 @@ This command displays the size of each each index in the database, in MB. It is
 ### `table_size`
 
 ```ruby
-RubyPGExtras.table_size
+RailsPGExtras.table_size
 
 $ rake pg_extras:table_size
 
@@ -338,7 +360,7 @@ This command displays the size of each table and materialized view in the databa
 ### `table_indexes_size`
 
 ```ruby
-RubyPGExtras.table_indexes_size
+RailsPGExtras.table_indexes_size
 
 $ rake pg_extras:table_indexes_size
 
@@ -357,7 +379,7 @@ This command displays the total size of indexes for each table and materialized
 ### `total_table_size`
 
 ```ruby
-RubyPGExtras.total_table_size
+RailsPGExtras.total_table_size
 
 $ rake pg_extras:total_table_size
 
@@ -376,7 +398,7 @@ This command displays the total size of each table and materialized view in the
 ### `unused_indexes`
 
 ```ruby
-RubyPGExtras.unused_indexes(args: { min_scans: 20 })
+RailsPGExtras.unused_indexes(args: { min_scans: 20 })
 
 $ rake pg_extras:unused_indexes
 
@@ -392,6 +414,19 @@ This command displays indexes that have < 50 scans recorded against them, and ar
 
 [More info](https://pawelurbanek.com/postgresql-fix-performance#unused-indexes)
 
+### `duplicate_indexes`
+
+```ruby
+
+RailsPGExtras.duplicate_indexes
+
+| size       |  idx1        |  idx2          |  idx3    |  idx4     |
++------------+--------------+----------------+----------+-----------+
+| 128 k      | users_pkey   | index_users_id |          |           |
+```
+
+This command displays multiple indexes that have the same set of columns, same opclass, expression and predicate - which make them equivalent. Usually it's safe to drop one of them.
+
 ### `null_indexes`
 
 ```ruby
@@ -415,7 +450,7 @@ This command displays indexes that contain `NULL` values. A high ratio of `NULL`
 ### `seq_scans`
 
 ```ruby
-RubyPGExtras.seq_scans
+RailsPGExtras.seq_scans
 
 $ rake pg_extras:seq_scans
 
@@ -439,7 +474,7 @@ This command displays the number of sequential scans recorded against all tables
 ### `long_running_queries`
 
 ```ruby
-RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 $ rake pg_extras:long_running_queries
 
@@ -456,7 +491,7 @@ This command displays currently running queries, that have been running for long
 ### `records_rank`
 
 ```ruby
-RubyPGExtras.records_rank
+RailsPGExtras.records_rank
 
 $ rake pg_extras:records_rank
 
@@ -476,7 +511,7 @@ This command displays an estimated count of rows per table, descending by estima
 ### `bloat`
 
 ```ruby
-RubyPGExtras.bloat
+RailsPGExtras.bloat
 
 $ rake pg_extras:bloat
 
@@ -497,7 +532,7 @@ This command displays an estimation of table "bloat" – space allocated to a re
 ### `vacuum_stats`
 
 ```ruby
-RubyPGExtras.vacuum_stats
+RailsPGExtras.vacuum_stats
 
 $ rake pg_extras:vacuum_stats
 
@@ -522,6 +557,22 @@ 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.
 
+### `buffercache_stats`
+
+```ruby
+RailsPGExtras.buffercache_stats(args: { limit: 10 })
+```
+
+This command shows the relations buffered in database share buffer, ordered by percentage taken. It also shows that how much of the whole relation is buffered.
+
+### `buffercache_usage`
+
+```ruby
+RailsPGExtras.buffercache_usage(args: { limit: 20 })
+```
+
+This command calculates how many blocks from which table are currently cached.
+
 ### `extensions`
 
 ```ruby
@@ -546,3 +597,18 @@ $ rake pg_extras:mandelbrot
 ```
 
 This command outputs the Mandelbrot set, calculated through SQL.
+
+## Testing
+
+```bash
+cp docker-compose.yml.sample docker-compose.yml
+docker compose up -d
+rake test_all
+```
+
+## Query sources
+
+- [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/Rakefile

@@ -3,3 +3,8 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'Test all PG versions'
+task :test_all do
+  system("PG_VERSION=11 bundle exec rspec spec/ && PG_VERSION=12 bundle exec rspec spec/ && PG_VERSION=13 bundle exec rspec spec/")
+end
+

data/docker-compose.yml.sample

@@ -1,12 +1,30 @@
 version: '3'
 
 services:
-  postgres:
+  postgres11:
     image: postgres:11.5-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
     environment:
       POSTGRES_USER: postgres
       POSTGRES_DB: rails-pg-extras-test
       POSTGRES_PASSWORD: secret
     ports:
       - '5432:5432'
-
+  postgres12:
+    image: postgres:12.7-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: rails-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5433:5432'
+  postgres13:
+    image: postgres:13.3-alpine
+    command: postgres -c shared_preload_libraries=pg_stat_statements
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: rails-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5434:5432'

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

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

data/lib/rails-pg-extras.rb

@@ -6,6 +6,7 @@ require 'ruby-pg-extras'
 module RailsPGExtras
   QUERIES = RubyPGExtras::QUERIES
   DEFAULT_ARGS = RubyPGExtras::DEFAULT_ARGS
+  NEW_PG_STAT_STATEMENTS = RubyPGExtras::NEW_PG_STAT_STATEMENTS
 
   QUERIES.each do |query_name|
     define_singleton_method query_name do |options = {}|
@@ -18,6 +19,16 @@ module RailsPGExtras
   end
 
   def self.run_query(query_name:, in_format:, args: {})
+    if %i(calls outliers).include?(query_name)
+      pg_stat_statements_ver = RailsPGExtras.connection.execute("select installed_version from pg_available_extensions where name='pg_stat_statements'")
+        .to_a[0].fetch("installed_version", nil)
+      if pg_stat_statements_ver != nil
+        if Gem::Version.new(pg_stat_statements_ver) < Gem::Version.new(NEW_PG_STAT_STATEMENTS)
+          query_name = "#{query_name}_legacy".to_sym
+        end
+      end
+    end
+
     sql = if (custom_args = DEFAULT_ARGS[query_name].merge(args)) != {}
       RubyPGExtras.sql_for(query_name: query_name) % custom_args
     else
@@ -36,8 +47,6 @@ module RailsPGExtras
   def self.connection
     ActiveRecord::Base.connection
   end
-
-  private_class_method :connection
 end
 
 require 'rails-pg-extras/railtie' if defined?(Rails)

data/spec/smoke_spec.rb

@@ -3,9 +3,12 @@
 require 'spec_helper'
 
 describe RailsPGExtras do
-  PG_STATS_DEPENDENT_QUERIES = %i(calls outliers)
+  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 - PG_STATS_DEPENDENT_QUERIES).each do |query_name|
+  RailsPGExtras::QUERIES.each do |query_name|
     it "#{query_name} query can be executed" do
       expect do
         RailsPGExtras.run_query(

data/spec/spec_helper.rb

@@ -5,7 +5,19 @@ require 'bundler/setup'
 require 'active_record'
 require_relative '../lib/rails-pg-extras'
 
-ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:5432/rails-pg-extras-test"
+pg_version = ENV["PG_VERSION"]
+
+port = if pg_version == "11"
+  "5432"
+elsif pg_version == "12"
+  "5433"
+elsif pg_version == "13"
+  "5434"
+else
+  "5432"
+end
+
+ENV["DATABASE_URL"] ||= "postgresql://postgres:secret@localhost:#{port}/rails-pg-extras-test"
 
 RSpec.configure do |config|
   config.before :suite do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.5.3
+  version: 2.2.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-10-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: 1.5.3
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - lib/rails-pg-extras/railtie.rb
 - lib/rails-pg-extras/tasks/all.rake
 - lib/rails-pg-extras/version.rb
+- rails-pg-extras-web.png
 - rails-pg-extras.gemspec
 - spec/smoke_spec.rb
 - spec/spec_helper.rb
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Rails PostgreSQL performance database insights