ruby-pg-extras 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a09437b758895b5a7dcb519cd1659c5afb0ae11d9fa3e79b73ddac88cd689c8
-  data.tar.gz: addcfb85c1f3a73731cbd34670ed984d8677954563980cf4e9b3317fcc329ce8
+  metadata.gz: 5d6fbc5ab6b75d6afab360ce585c6b99da6f7c7622da5c7d41ef5c9a352cf1d0
+  data.tar.gz: d6065e2b079138d523ea47dd5855793e6c53d45d7d0f59f6035a3f0cc22e97d1
 SHA512:
-  metadata.gz: 62cdf41039cd544cc02467606282bca0ecf990b0d65eeaf51803e356b702eba719ee4f861318fef7a225834c0afa85b0ed4f5cd652e604b9c9c6f5f0057e5f7f
-  data.tar.gz: '081df083c1f33c94883eb0fff10ad32b6ca28629f39b07ca704879a45c7945b7c67706bd27107fcfff8001ba4d78924ff1f4810ff7fdab312748ef9bedbbbce1'
+  metadata.gz: 06235baa16b1433f94c6df83cdd764792ab85217ea0dae0880fedf981f84e7e4a12748e267462bc99a69096dd7706cf6893680d24f7b1e7da5fc8c502e4bc9fb
+  data.tar.gz: 0cce03aa9d5e05cc826c4d4835fc4fc8c3d50f3d062dfbdd7deec85d4b51366de68e264d3e3023f509464144ab80ae983975cecb50aaf3d333b1a8e0962df878

data/.circleci/config.yml

@@ -16,7 +16,8 @@ jobs:
       - run: gem update --system
       - run: gem install bundler
       - run: bundle install --path vendor/bundle
-      - run: sudo apt install postgresql-client
+      - run: sudo apt-get update
+      - run: sudo apt install postgresql-client-11
       - run: dockerize -wait tcp://localhost:5432 -timeout 1m
       - run:
           name: Run specs

data/README.md

@@ -4,7 +4,19 @@ Ruby port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras) with
 
 Queries 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.
 
-Are you riding on Rails? Check out the [Rails version](https://github.com/pawurb/rails-pg-extras).
+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).
+
+Alternative versions:
+
+- [Ruby on Rails](https://github.com/pawurb/rails-pg-extras)
+
+- [NodeJS](https://github.com/pawurb/node-postgres-extras)
+
+- [Elixir](https://github.com/pawurb/ecto_psql_extras)
+
+- [Python](https://github.com/pawurb/python-pg-extras)
+
+- [Haskell](https://github.com/pawurb/haskell-pg-extras)
 
 ## Installation
 
@@ -14,6 +26,19 @@ In your Gemfile
 gem "ruby-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.
+
+You can check if it is enabled in your database by running:
+
+```ruby
+RubyPGExtras.extensions
+```
+You should see the similar line in the output:
+
+```bash
+| pg_stat_statements  | 1.7  | 1.7 | track execution statistics of all SQL statements executed |
+```
+
 ## Usage
 
 Gem expects the `ENV['DATABASE_URL']` value in the following format:
@@ -91,7 +116,7 @@ RubyPGExtras.index_cache_hit
 (truncated results for brevity)
 ```
 
-The same as `cache_hit` with each table's indexes cache hit info displayed seperately.
+The same as `cache_hit` with each table's indexes cache hit info displayed separately.
 
 ### `table_cache_hit`
 
@@ -144,7 +169,7 @@ RubyPGExtras.locks
 (4 rows)
 ```
 
-This command displays queries that have taken out an exlusive 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.
+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.
 
 ### `all_locks`
 
@@ -174,7 +199,7 @@ RubyPGExtras.outliers
 (truncated results for brevity)
 ```
 
-This command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, and the amount of time that statement spent on synchronous I/O (reading/writing from the filesystem).
+This command displays statements, obtained from `pg_stat_statements`, ordered by the amount of time to execute in aggregate. This includes the statement itself, the total execution time for that statement, the proportion of total execution time for all statements that statement has taken up, the number of times that statement has been called, and the amount of time that statement spent on synchronous I/O (reading/writing from the file system).
 
 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.
 
@@ -283,7 +308,7 @@ RubyPGExtras.table_indexes_size
 (truncated results for brevity)
 ```
 
-This command displays the total size of indexes for each table, in MB. It is calcualtes by using the system administration function `pg_indexes_size()`.
+This command displays the total size of indexes for each table and materialized view, in MB. It is calculated by using the system administration function `pg_indexes_size()`.
 
 ### `total_table_size`
 
@@ -301,7 +326,7 @@ RubyPGExtras.total_table_size
 (truncated results for brevity)
 ```
 
-This command displays the total size of each table in the database, in MB. It is calculated by using the system administration function `pg_total_relation_size()`, which includes table size, total index size and TOAST data.
+This command displays the total size of each table and materialized view in the database, in MB. It is calculated by using the system administration function `pg_total_relation_size()`, which includes table size, total index size and TOAST data.
 
 ### `unused_indexes`
 
@@ -339,7 +364,7 @@ RubyPGExtras.seq_scans
 (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 underindexed, and it may be worth investigating queries that read from these tables.
+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.
 
 ### `long_running_queries`
 
@@ -412,7 +437,7 @@ RubyPGExtras.vacuum_stats
  (truncated results for brevity)
 ```
 
-This command displays statistics related to vacuum operations for each table, including an estiamtion of dead rows, last autovacuum and the current autovacuum threshold. This command can be useful when determining if current vacuum thresholds require adjustments, and to determine when the table was last vacuumed.
+This command displays statistics related to vacuum operations for each table, including an estimation of dead rows, last autovacuum and the current autovacuum threshold. This command can be useful when determining if current vacuum thresholds require adjustments, and to determine when the table was last vacuumed.
 
 ### `kill_all`
 
@@ -424,18 +449,22 @@ RubyPGExtras.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.
 
-### `mandelbrot`
+### `extensions`
 
 ```ruby
 
-RubyPGExtras.mandelbrot
+RubyPGExtras.extensions
 
 ```
 
-This command outputs the Mandelbrot set, calculated through SQL.
+This command lists all the currently installed and available PostgreSQL extensions.
+
+### `mandelbrot`
+
+```ruby
 
-## FAQ
+RubyPGExtras.mandelbrot
 
-* Does is not violate the Heroku PG Extras license?
+```
 
-The original plugin is MIT based so it means that copying and redistribution in any format is permitted.
+This command outputs the Mandelbrot set, calculated through SQL.

data/lib/ruby-pg-extras.rb

@@ -17,19 +17,30 @@ module RubyPGExtras
     unused_indexes vacuum_stats kill_all
   )
 
+  DEFAULT_ARGS = Hash.new({}).merge({
+    calls: { limit: 10 },
+    long_running_queries: { interval: '5 seconds' },
+    outliers: { limit: 10 },
+    unused_indexes: { min_scans: 50 }
+  })
+
   QUERIES.each do |query_name|
-    define_singleton_method query_name do |options = { in_format: :display_table }|
+    define_singleton_method query_name do |options = {}|
       run_query(
         query_name: query_name,
-        in_format: options.fetch(:in_format)
+        in_format: options.fetch(:in_format, :display_table),
+        args: options.fetch(:args, {})
       )
     end
   end
 
-  def self.run_query(query_name:, in_format:)
-    result = connection.exec(
+  def self.run_query(query_name:, in_format:, args: {})
+    sql = if (custom_args = DEFAULT_ARGS[query_name].merge(args)) != {}
+      sql_for(query_name: query_name) % custom_args
+    else
       sql_for(query_name: query_name)
-    )
+    end
+    result = connection.exec(sql)
 
     display_result(
       result,

data/lib/ruby-pg-extras/queries/calls.sql

@@ -1,9 +1,9 @@
-/* 10 queries that have highest frequency of execution */
+/* Queries that have highest frequency of execution */
 
 SELECT query AS qry,
 interval '1 millisecond' * total_time AS exec_time,
-to_char((total_time/sum(total_time) OVER()) * 100, 'FM90D0') || '%'  AS prop_exec_time,
+to_char((total_time/sum(total_time) OVER()) * 100, 'FM90D0') || '%%'  AS prop_exec_time,
 to_char(calls, 'FM999G999G990') AS ncalls,
 interval '1 millisecond' * (blk_read_time + blk_write_time) AS sync_io_time
 FROM pg_stat_statements WHERE userid = (SELECT usesysid FROM pg_user WHERE usename = current_user LIMIT 1)
-ORDER BY calls DESC LIMIT 10;
+ORDER BY calls DESC LIMIT %{limit};

data/lib/ruby-pg-extras/queries/long_running_queries.sql

@@ -9,6 +9,6 @@ FROM
 WHERE
   pg_stat_activity.query <> ''::text
   AND state <> 'idle'
-  AND now() - pg_stat_activity.query_start > interval '5 minutes'
+  AND now() - pg_stat_activity.query_start > interval '%{interval}'
 ORDER BY
   now() - pg_stat_activity.query_start DESC;

data/lib/ruby-pg-extras/queries/outliers.sql

@@ -1,10 +1,10 @@
-/* 10 queries that have longest execution time in aggregate */
+/* Queries that have longest execution time in aggregate */
 
 SELECT interval '1 millisecond' * total_time AS total_exec_time,
-to_char((total_time/sum(total_time) OVER()) * 100, 'FM90D0') || '%'  AS prop_exec_time,
+to_char((total_time/sum(total_time) OVER()) * 100, 'FM90D0') || '%%'  AS prop_exec_time,
 to_char(calls, 'FM999G999G999G990') AS ncalls,
 interval '1 millisecond' * (blk_read_time + blk_write_time) AS sync_io_time,
 query AS query
 FROM pg_stat_statements WHERE userid = (SELECT usesysid FROM pg_user WHERE usename = current_user LIMIT 1)
 ORDER BY total_time DESC
-LIMIT 10;
+LIMIT %{limit};

data/lib/ruby-pg-extras/queries/table_indexes_size.sql

@@ -6,5 +6,5 @@ FROM pg_class c
 LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace)
 WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
-AND c.relkind='r'
+AND c.relkind IN ('r', 'm')
 ORDER BY pg_indexes_size(c.oid) DESC;

data/lib/ruby-pg-extras/queries/table_size.sql

@@ -6,5 +6,5 @@ FROM pg_class c
 LEFT JOIN pg_namespace n ON (n.oid = c.relnamespace)
 WHERE n.nspname NOT IN ('pg_catalog', 'information_schema')
 AND n.nspname !~ '^pg_toast'
-AND c.relkind='r'
+AND c.relkind IN ('r', 'm')
 ORDER BY pg_table_size(c.oid) DESC;

data/lib/ruby-pg-extras/queries/unused_indexes.sql

@@ -11,6 +11,6 @@ SELECT
   idx_scan as index_scans
 FROM pg_stat_user_indexes ui
 JOIN pg_index i ON ui.indexrelid = i.indexrelid
-WHERE NOT indisunique AND idx_scan < 50 AND pg_relation_size(relid) > 5 * 8192
+WHERE NOT indisunique AND idx_scan < %{min_scans} AND pg_relation_size(relid) > 5 * 8192
 ORDER BY pg_relation_size(i.indexrelid) / nullif(idx_scan, 0) DESC NULLS FIRST,
 pg_relation_size(i.indexrelid) DESC;

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyPGExtras
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -114,7 +114,7 @@ homepage: http://github.com/pawurb/ruby-pg-extras
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +129,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby PostgreSQL performance database insights
 test_files: