rails-pg-extras 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 897f027634b0313e42a13d864678eac7f0280c00a9a39ca5d668cabbba970b02
-  data.tar.gz: d23efda1f8afcbd989278b9362baacb4882796115d7e70263a812787f95de340
+  metadata.gz: c107fe728b02513bceaa617c45f5cf5bc4048fb0376ec46a13a70ba86cff4cf9
+  data.tar.gz: 07fd71c6c2a1ff119b30845f32967d4d2c49d8ae0eccfbdaf52b228b5c907541
 SHA512:
-  metadata.gz: 612408e64b97f03c70dcab7525cce2be8cafa4b9cf5eca27dd88013b5d74ffd08c5e68532599158c697d8754b9fa1ee534bbb698a9603df489d7394b1d036dab
-  data.tar.gz: f9c66eb8837a6720de96132e0941364aa3e83f627d52a04221efbbe2d361c1c9f2a24635057868c631ecee54fe42a9aa599b9a354f82341f84cd7a0ff2a524b2
+  metadata.gz: d9de7a07381f8d203e60f98b750b0791e7be932dfaf8a621106bc69bbe44eb4ce5ca0893e4d8b22905913626f28bedc77da7fad282c4171ea51e3b424c359984
+  data.tar.gz: 99872d4b0efcddf6d4a0af106068fc2a83544053c13596c2532320ac746a3ca6174d7ff1fd8e3a8c2533b49acaeaac896bbf6def5bc1f5dc083e6956b9cf52f9

data/.circleci/config.yml

@@ -6,6 +6,7 @@ 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 -c pg_stat_statements.track=all -c max_connections=200
         environment:
           POSTGRES_USER: postgres
           POSTGRES_DB: rails-pg-extras-test

data/README.md

@@ -89,7 +89,9 @@ RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
 
 ### `cache_hit`
 
-```
+```ruby
+RailsPGExtras.cache_hit
+
 $ rake pg_extras:cache_hit
 
       name      |         ratio
@@ -101,9 +103,13 @@ $ 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
 
 $ rake pg_extras:index_cache_hit
 
@@ -117,9 +123,13 @@ $ 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
 
 $ rake pg_extras:table_cache_hit
 
@@ -133,9 +143,35 @@ $ 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
 
        relname       | percent_of_times_index_used | rows_in_table
@@ -152,7 +188,9 @@ This command provides information on the efficiency of indexes, represented as w
 
 ### `locks`
 
-```
+```ruby
+RailsPGExtras.locks
+
 $ rake pg_extras:locks
 
  procpid | relname | transactionid | granted |     query_snippet     | mode             |       age
@@ -168,9 +206,13 @@ $ 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
 ```
 
@@ -178,7 +220,9 @@ This command displays all the current locks, regardless of their type.
 
 ### `outliers`
 
-```
+```ruby
+RailsPGExtras.outliers(args: { limit: 20 })
+
 $ rake pg_extras:outliers
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
@@ -196,9 +240,13 @@ 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`
 
-```
+```ruby
+RailsPGExtras.calls(args: { limit: 10 })
+
 $ rake pg_extras:calls
 
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
@@ -213,9 +261,13 @@ $ 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`
 
-```
+```ruby
+RailsPGExtras.blocking
+
 $ rake pg_extras:blocking
 
  blocked_pid |    blocking_statement    | blocking_duration | blocking_pid |                                        blocked_statement                           | blocked_duration
@@ -226,9 +278,13 @@ $ 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)
+
+### `total_index_size`
+
+```ruby
+RailsPGExtras.total_index_size
 
-```
 $ rake pg_extras:total_index_size
 
   size
@@ -241,7 +297,9 @@ This command displays the total size of all indexes on the database, in MB. It i
 
 ### `index_size`
 
-```
+```ruby
+RailsPGExtras.index_size
+
 $ rake pg_extras:index_size
                              name                              |  size
 ---------------------------------------------------------------+---------
@@ -262,7 +320,9 @@ This command displays the size of each each index in the database, in MB. It is
 
 ### `table_size`
 
-```
+```ruby
+RailsPGExtras.table_size
+
 $ rake pg_extras:table_size
 
                              name                              |  size
@@ -279,7 +339,9 @@ This command displays the size of each table and materialized view in the databa
 
 ### `table_indexes_size`
 
-```
+```ruby
+RailsPGExtras.table_indexes_size
+
 $ rake pg_extras:table_indexes_size
 
                              table                             | indexes_size
@@ -296,7 +358,9 @@ This command displays the total size of indexes for each table and materialized
 
 ### `total_table_size`
 
-```
+```ruby
+RailsPGExtras.total_table_size
+
 $ rake pg_extras:total_table_size
 
                              name                              |  size
@@ -313,7 +377,9 @@ This command displays the total size of each table and materialized view in the
 
 ### `unused_indexes`
 
-```
+```ruby
+RailsPGExtras.unused_indexes(args: { min_scans: 20 })
+
 $ rake pg_extras:unused_indexes
 
           table      |                       index                | index_size | index_scans
@@ -326,10 +392,14 @@ $ 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)
+
 ### `null_indexes`
 
 ```ruby
 
+RailsPGExtras.null_indexes(args: { min_relation_size_mb: 10 })
+
 $ rake pg_extras:null_indexes
 
    oid   |         index      | index_size | unique | indexed_column | null_frac | expected_saving
@@ -340,11 +410,15 @@ $ 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`
 
-```
+```ruby
+RailsPGExtras.seq_scans
+
 $ rake pg_extras:seq_scans
 
                name                |  count
@@ -357,22 +431,18 @@ $ 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`
 
-```
+```ruby
+RailsPGExtras.long_running_queries(args: { threshold: "200 milliseconds" })
+
 $ rake pg_extras:long_running_queries
 
   pid  |    duration     |                                      query
@@ -387,7 +457,9 @@ This command displays currently running queries, that have been running for long
 
 ### `records_rank`
 
-```
+```ruby
+RailsPGExtras.records_rank
+
 $ rake pg_extras:records_rank
 
                name                | estimated_count
@@ -405,7 +477,9 @@ This command displays an estimated count of rows per table, descending by estima
 
 ### `bloat`
 
-```
+```ruby
+RailsPGExtras.bloat
+
 $ rake pg_extras:bloat
 
  type  | schemaname |           object_name         | bloat |   waste
@@ -420,9 +494,13 @@ $ 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`
 
-```
+```ruby
+RailsPGExtras.vacuum_stats
+
 $ rake pg_extras:vacuum_stats
 
  schema |         table         | last_vacuum | last_autovacuum  |    rowcount    | dead_rowcount  | autovacuum_threshold | expect_autovacuum
@@ -446,20 +524,49 @@ 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
 
 RailsPGExtras.extensions
 
+$ rake pg_extras:extensions
+
+| pg_stat_statements | 1.7 | 1.7 | track execution statistics of all SQL statements executed
+ (truncated results for brevity)
+
 ```
 
 This command lists all the currently installed and available PostgreSQL extensions.
 
 ### mandelbrot
 
-```
+```ruby
+RailsPGExtras.mandelbrot
+
 $ rake pg_extras:mandelbrot
 ```
 
 This command outputs the Mandelbrot set, calculated through SQL.
+
+## 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/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 -c pg_stat_statements.track=all -c max_connections=200
     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 -c pg_stat_statements.track=all -c max_connections=200
+    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 -c pg_stat_statements.track=all -c max_connections=200
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: rails-pg-extras-test
+      POSTGRES_PASSWORD: secret
+    ports:
+      - '5434:5432'

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/lib/rails-pg-extras/version.rb

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

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.0
+  version: 2.0.0
 platform: ruby
 authors:
 - pawurb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-13 00:00:00.000000000 Z
+date: 2021-07-08 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.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,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