rails-pg-extras 1.5.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec78b739d900e56a89e3a2afd0f714538175d7ea7a816cd00115982ead78f0ed
-  data.tar.gz: ee936f6c5b7d6f48643d1dbe9a3e8245d36cb2369ec8675b3018b5ea9dad8c2a
+  metadata.gz: 91474e6c121e4a84110dd1b7fb9724012627696625d08ce73c38eb27b0398636
+  data.tar.gz: 50971a690cc8b350d1caf20d43776c7ff6b1927d394e55316a2203e9a00b1d72
 SHA512:
-  metadata.gz: 98dae06049bf799eca77dfa53b7eb93ce9393c8fdd57e33bf70f993aba6067a507e3e6bb87b8cefee17868453337ca377ad315d9ef356b8980ecf14c4314f1a5
-  data.tar.gz: c34522f7495a1782e215fe07ccfcb0d8bdad630f1ba456e2e8609398137f2dd8cf869c64f0a823a689c814a84eec87bae8dda280150ce1260f4ae2213dd49520
+  metadata.gz: 3880fcea5eed8f047dcbfc733836b8f93f220b139a96a6b20f64e11f90de338fa0489b7644fc632df2b6947332692c4a78ec17f35124a7eb4f5a7931cfb2dab6
+  data.tar.gz: 148f28f307696d2d08acb81d4c61b8ed75bfc31823670bcd669b12a9eb37593d1081a0fe8959a6f11622426f3a4021b0226d99728f61be751915a6f7a7b57ad2

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:
 
@@ -89,7 +95,7 @@ RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 ### `cache_hit`
 
-```
+```ruby
 RailsPGExtras.cache_hit
 
 $ rake pg_extras:cache_hit
@@ -103,9 +109,11 @@ $ rake pg_extras:cache_hit
 
 This command provides information on the efficiency of the buffer cache, for both index reads (`index hit rate`) as well as table reads (`table hit rate`). A low buffer cache hit ratio can be a sign that the Postgres instance is too small for the workload.
 
+[More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)
+
 ### `index_cache_hit`
 
-```
+```ruby
 
 RailsPGExtras.index_cache_hit
 
@@ -121,9 +129,11 @@ $ rake pg_extras:index_cache_hit
 
 The same as `cache_hit` with each table's indexes cache hit info displayed separately.
 
+[More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)
+
 ### `table_cache_hit`
 
-```
+```ruby
 
 RailsPGExtras.table_cache_hit
 
@@ -139,9 +149,33 @@ $ rake pg_extras:table_cache_hit
 
 The same as `cache_hit` with each table's cache hit info displayed seperately.
 
-### `index_usage`
+[More info](https://pawelurbanek.com/postgresql-fix-performance#cache-hit)
+
+### `db_settings`
+
+```ruby
+
+RailsPGExtras.db_settings
+
+$ rake pg_extras:db_settings
+
+             name             | setting | unit |
+------------------------------+---------+------+
+ checkpoint_completion_target | 0.7     |      |
+ default_statistics_target    | 100     |      |
+ effective_cache_size         | 1350000 | 8kB  |
+ effective_io_concurrency     | 1       |      |
+(truncated results for brevity)
 
 ```
+
+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)
+
+### `index_usage`
+
+```ruby
 RailsPGExtras.index_usage
 
 $ rake pg_extras:index_usage
@@ -160,7 +194,7 @@ This command provides information on the efficiency of indexes, represented as w
 
 ### `locks`
 
-```
+```ruby
 RailsPGExtras.locks
 
 $ rake pg_extras:locks
@@ -178,9 +212,11 @@ $ rake pg_extras:locks
 
 This command displays queries that have taken out an exclusive lock on a relation. Exclusive locks typically prevent other operations on that relation from taking place, and can be a cause of "hung" queries that are waiting for a lock to be granted.
 
+[More info](https://pawelurbanek.com/postgresql-fix-performance#deadlocks)
+
 ### `all_locks`
 
-```
+```ruby
 RailsPGExtras.all_locks
 
 $ rake pg_extras:all_locks
@@ -190,8 +226,8 @@ This command displays all the current locks, regardless of their type.
 
 ### `outliers`
 
-```
-RubyPGExtras.outliers(args: { limit: 20 })
+```ruby
+RailsPGExtras.outliers(args: { limit: 20 })
 
 $ rake pg_extras:outliers
 
@@ -210,10 +246,12 @@ This command displays statements, obtained from `pg_stat_statements`, ordered by
 
 Typically, an efficient query will have an appropriate ratio of calls to total execution time, with as little time spent on I/O as possible. Queries that have a high total execution time but low call count should be investigated to improve their performance. Queries that have a high proportion of execution time being spent on synchronous I/O should also be investigated.
 
+[More info](https://pawelurbanek.com/postgresql-fix-performance#missing-indexes)
+
 ### `calls`
 
-```
-RubyPGExtras.calls(args: { limit: 10 })
+```ruby
+RailsPGExtras.calls(args: { limit: 10 })
 
 $ rake pg_extras:calls
 
@@ -229,10 +267,12 @@ $ rake pg_extras:calls
 
 This command is much like `pg:outliers`, but ordered by the number of times a statement has been called.
 
+[More info](https://pawelurbanek.com/postgresql-fix-performance#missing-indexes)
+
 ### `blocking`
 
-```
-RubyPGExtras.blocking
+```ruby
+RailsPGExtras.blocking
 
 $ rake pg_extras:blocking
 
@@ -244,10 +284,12 @@ $ rake pg_extras:blocking
 
 This command displays statements that are currently holding locks that other statements are waiting to be released. This can be used in conjunction with `pg:locks` to determine which statements need to be terminated in order to resolve lock contention.
 
-#### `total_index_size`
+[More info](https://pawelurbanek.com/postgresql-fix-performance#deadlocks)
 
-```
-RubyPGExtras.total_index_size
+### `total_index_size`
+
+```ruby
+RailsPGExtras.total_index_size
 
 $ rake pg_extras:total_index_size
 
@@ -261,8 +303,8 @@ This command displays the total size of all indexes on the database, in MB. It i
 
 ### `index_size`
 
-```
-RubyPGExtras.index_size
+```ruby
+RailsPGExtras.index_size
 
 $ rake pg_extras:index_size
                              name                              |  size
@@ -284,8 +326,8 @@ This command displays the size of each each index in the database, in MB. It is
 
 ### `table_size`
 
-```
-RubyPGExtras.table_size
+```ruby
+RailsPGExtras.table_size
 
 $ rake pg_extras:table_size
 
@@ -303,8 +345,8 @@ This command displays the size of each table and materialized view in the databa
 
 ### `table_indexes_size`
 
-```
-RubyPGExtras.table_indexes_size
+```ruby
+RailsPGExtras.table_indexes_size
 
 $ rake pg_extras:table_indexes_size
 
@@ -322,8 +364,8 @@ This command displays the total size of indexes for each table and materialized
 
 ### `total_table_size`
 
-```
-RubyPGExtras.total_table_size
+```ruby
+RailsPGExtras.total_table_size
 
 $ rake pg_extras:total_table_size
 
@@ -341,8 +383,8 @@ This command displays the total size of each table and materialized view in the
 
 ### `unused_indexes`
 
-```
-RubyPGExtras.unused_indexes(args: { min_scans: 20 })
+```ruby
+RailsPGExtras.unused_indexes(args: { min_scans: 20 })
 
 $ rake pg_extras:unused_indexes
 
@@ -356,6 +398,21 @@ $ rake pg_extras:unused_indexes
 
 This command displays indexes that have < 50 scans recorded against them, and are greater than 5 pages in size, ordered by size relative to the number of index scans. This command is generally useful for eliminating indexes that are unused, which can impact write performance, as well as read performance should they occupy space in memory.
 
+[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
@@ -372,12 +429,14 @@ $ rake pg_extras:null_indexes
 
 ```
 
-This commands displays indexes that contain `NULL` values. A high ratio of `NULL` values means that using a partial index excluding them will be beneficial in case they are not used for searching. [Source and more info](https://hakibenita.com/postgresql-unused-index-size).
+This command displays indexes that contain `NULL` values. A high ratio of `NULL` values means that using a partial index excluding them will be beneficial in case they are not used for searching.
+
+[More info](https://pawelurbanek.com/postgresql-fix-performance#null-indexes)
 
 ### `seq_scans`
 
-```
-RubyPGExtras.seq_scans
+```ruby
+RailsPGExtras.seq_scans
 
 $ rake pg_extras:seq_scans
 
@@ -391,23 +450,17 @@ $ rake pg_extras:seq_scans
  messages                          |  3922247
  contests_customers                |  2915972
  classroom_goals                   |  2142014
- contests                          |  1370267
- goals                             |  1112659
- districts                         |   158995
- rollup_reports                    |   115942
- customers                         |    93847
- schools                           |    92984
- classrooms                        |    92982
- customer_settings                 |    91226
 (truncated results for brevity)
 ```
 
 This command displays the number of sequential scans recorded against all tables, descending by count of sequential scans. Tables that have very high numbers of sequential scans may be under-indexed, and it may be worth investigating queries that read from these tables.
 
+[More info](https://pawelurbanek.com/postgresql-fix-performance#missing-indexes)
+
 ### `long_running_queries`
 
-```
-RubyPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+```ruby
+RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 $ rake pg_extras:long_running_queries
 
@@ -423,8 +476,8 @@ This command displays currently running queries, that have been running for long
 
 ### `records_rank`
 
-```
-RubyPGExtras.records_rank
+```ruby
+RailsPGExtras.records_rank
 
 $ rake pg_extras:records_rank
 
@@ -443,8 +496,8 @@ This command displays an estimated count of rows per table, descending by estima
 
 ### `bloat`
 
-```
-RubyPGExtras.bloat
+```ruby
+RailsPGExtras.bloat
 
 $ rake pg_extras:bloat
 
@@ -460,10 +513,12 @@ $ rake pg_extras:bloat
 
 This command displays an estimation of table "bloat" – space allocated to a relation that is full of dead tuples, that has yet to be reclaimed. Tables that have a high bloat ratio, typically 10 or greater, should be investigated to see if vacuuming is aggressive enough, and can be a sign of high table churn.
 
+[More info](https://pawelurbanek.com/postgresql-fix-performance#bloat)
+
 ### `vacuum_stats`
 
-```
-RubyPGExtras.vacuum_stats
+```ruby
+RailsPGExtras.vacuum_stats
 
 $ rake pg_extras:vacuum_stats
 
@@ -488,10 +543,26 @@ 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.
 
-### `extensions`
+### `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
+
 RailsPGExtras.extensions
 
 $ rake pg_extras:extensions
@@ -505,10 +576,24 @@ This command lists all the currently installed and available PostgreSQL extensio
 
 ### mandelbrot
 
-```
+```ruby
 RailsPGExtras.mandelbrot
 
 $ 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)

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.2"
+  VERSION = "2.1.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.2
+  version: 2.1.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
+date: 2021-10-15 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.2
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 2.1.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