ruby-pg-extras 0.7.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05768abc8a8d84bf67f2b5421f687044aab327521e9206cb58356d6c0905ec68'
-  data.tar.gz: 864923ef0192c664b46dce8ecc0b126a5d6699319fda1f101d9d36c5b1e73758
+  metadata.gz: 159b413f611699a0be3d00f9c15efee109a910a28fe047d9c9f2a33b477a500b
+  data.tar.gz: 9a7ff1ad3c60a82fd7396f557833c66eb536d7d7c0f0fab8eeb0db7803603a5b
 SHA512:
-  metadata.gz: 113c943c72a86772077079886dc6ea0b23b82651e00dad201921b91caa40900802a5efe832f9e3945012ba23ae17c5c8044d8e18a1325ff16df965843aeb6c15
-  data.tar.gz: 15e13d0547b587ddb7fc3fb26bfbde451b7a9e47615631cfa379bb0fc6b69dd96a95624814e4ebec1d876861685528028b467325725815cd78d8d14a06fcdd9f
+  metadata.gz: db53acf068d87f8d2947af7128acaa13ec5d4bd402626b18152d0131baafac4395dded2f4e1003272ecae9a5b6f1fd4aef8a9fb589ba96d9cafb1f3b252f832c
+  data.tar.gz: 5357e82fa106c7511f15b731899228bb2e045cf22a597f588eb6244e537104627e3b142752ffe63aa61bacab0215ebc425642b6d48c8e928593a23ef387f34f3

data/README.md

@@ -1,20 +1,43 @@
 # Ruby PG Extras [![Gem Version](https://badge.fury.io/rb/ruby-pg-extras.svg)](https://badge.fury.io/rb/ruby-pg-extras) [![CircleCI](https://circleci.com/gh/pawurb/ruby-pg-extras.svg?style=svg)](https://circleci.com/gh/pawurb/ruby-pg-extras)
 
-Ruby port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras). The goal of this project is to provide powerful insights into the PostgreSQL database for Ruby apps that are not using the Heroku PostgreSQL plugin.
+Ruby port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras) with several additions and improvements. The goal of this project is to provide powerful insights into the PostgreSQL database for Ruby apps that are not using the Heroku PostgreSQL plugin.
 
-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.
+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).
 
-### Installation
+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)
+
+## Installation
 
 In your Gemfile
 
 ```ruby
-gem 'ruby-pg-extras'
+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:
 
-### Usage
+```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:
 
@@ -60,9 +83,9 @@ RubyPGExtras.cache_hit(in_format: :raw) =>
  #<PG::Result:0x00007f75777f7328 status=PGRES_TUPLES_OK ntuples=2 nfields=2 cmd_tuples=2>
 ```
 
-### Available methods
+## Available methods
 
-#### `cache_hit`
+### `cache_hit`
 
 ```ruby
 
@@ -77,7 +100,39 @@ RubyPGExtras.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.
 
-#### `index_usage`
+### `index_cache_hit`
+
+```ruby
+
+RubyPGExtras.index_cache_hit
+
+| name                  | buffer_hits | block_reads | total_read | ratio             |
++-----------------------+-------------+-------------+------------+-------------------+
+| teams                 | 187665      | 109         | 187774     | 0.999419514948821 |
+| subscriptions         | 5160        | 6           | 5166       | 0.99883855981417  |
+| plans                 | 5718        | 9           | 5727       | 0.998428496595076 |
+(truncated results for brevity)
+```
+
+The same as `cache_hit` with each table's indexes cache hit info displayed seperately.
+
+### `table_cache_hit`
+
+```ruby
+
+RubyPGExtras.table_cache_hit
+
+| name                  | buffer_hits | block_reads | total_read | ratio             |
++-----------------------+-------------+-------------+------------+-------------------+
+| plans                 | 32123       | 2           | 32125      | 0.999937743190662 |
+| subscriptions         | 95021       | 8           | 95029      | 0.999915815172211 |
+| teams                 | 171637      | 200         | 171837     | 0.99883610631005  |
+(truncated results for brevity)
+```
+
+The same as `cache_hit` with each table's cache hit info displayed seperately.
+
+### `index_usage`
 
 ```ruby
 
@@ -139,10 +194,7 @@ RubyPGExtras.outliers
  SELECT * FROM usage_events WHERE (alp.. | 01:18:10.754354  | 0.6%           | 102,114,301 | 00:00:00
  UPDATE usage_events SET reporter_id =.. | 00:52:35.683254  | 0.4%           | 23,786,348  | 00:00:00
  INSERT INTO usage_events (id, retaine.. | 00:49:24.952561  | 0.4%           | 21,988,201  | 00:00:00
- COPY public.app_ownership_events (id,.. | 00:37:14.31082   | 0.3%           | 13          | 00:12:32.584754
- INSERT INTO app_ownership_events (id,.. | 00:26:59.808212  | 0.2%           | 383,109     | 00:00:00
- SELECT * FROM app_ownership_events   .. | 00:19:06.021846  | 0.1%           | 744,879     | 00:00:00
-(10 rows)
+(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).
@@ -164,10 +216,7 @@ RubyPGExtras.calls
  UPDATE usage_events SET reporter_id =.. | 00:52:35.986167  | 0.4%           | 23,788,388  | 00:00:00
  INSERT INTO usage_events (id, retaine.. | 00:49:25.260245  | 0.4%           | 21,990,326  | 00:00:00
  INSERT INTO usage_events (id, retaine.. | 01:42:59.436532  | 0.8%           | 12,328,187  | 00:00:00
- SELECT * FROM app_ownership_events   .. | 00:19:06.289521  | 0.1%           | 744,976     | 00:00:00
- INSERT INTO app_ownership_events(id, .. | 00:26:59.885631  | 0.2%           | 383,153     | 00:00:00
- UPDATE app_ownership_events SET app_i.. | 00:01:22.282337  | 0.0%           | 359,741     | 00:00:00
-(10 rows)
+(truncated results for brevity)
 ```
 
 This command is much like `pg:outliers`, but ordered by the number of times a statement has been called.
@@ -186,7 +235,7 @@ RubyPGExtras.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`
+### `total_index_size`
 
 ```ruby
 
@@ -218,11 +267,6 @@ RubyPGExtras.index_size
  index_attempts_on_enrollment_id                               | 1957 MB
  index_enrollment_attemptables_by_enrollment_activity_id       | 1789 MB
  enrollment_activities_pkey                                    |  458 MB
- index_enrollment_activities_by_lesson_enrollment_and_activity |  402 MB
- index_placement_attempts_on_response_id                       |  109 MB
- index_placement_attempts_on_placement_test_id                 |  108 MB
- index_placement_attempts_on_grade_level_id                    |   97 MB
- index_lesson_enrollments_on_lesson_id                         |   93 MB
 (truncated results for brevity)
 ```
 
@@ -244,7 +288,7 @@ RubyPGExtras.table_size
 (truncated results for brevity)
 ```
 
-This command displays the size of each table in the database, in MB. It is calculated by using the system administration function `pg_table_size()`, which includes the size of the main data fork, free space map, visibility map and TOAST data.
+This command displays the size of each table and materialized view in the database, in MB. It is calculated by using the system administration function `pg_table_size()`, which includes the size of the main data fork, free space map, visibility map and TOAST data.
 
 ### `table_indexes_size`
 
@@ -262,7 +306,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 calcualtes by using the system administration function `pg_indexes_size()`.
 
 ### `total_table_size`
 
@@ -280,7 +324,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`
 
@@ -315,20 +359,12 @@ RubyPGExtras.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 underindexed, and it may be worth investigating queries that read from these tables.
 
-### long_running_queries
+### `long_running_queries`
 
 ```ruby
 
@@ -345,7 +381,7 @@ RubyPGExtras.long_running_queries
 
 This command displays currently running queries, that have been running for longer than 5 minutes, descending by duration. Very long running queries can be a source of multiple issues, such as preventing DDL statements completing or vacuum being unable to update `relfrozenxid`.
 
-### records_rank
+### `records_rank`
 
 ```ruby
 
@@ -364,7 +400,7 @@ RubyPGExtras.records_rank
 
 This command displays an estimated count of rows per table, descending by estimated count. The estimated count is derived from `n_live_tup`, which is updated by vacuum operations. Due to the way `n_live_tup` is populated, sparse vs. dense pages can result in estimations that are significantly out from the real count of rows.
 
-### bloat
+### `bloat`
 
 ```ruby
 
@@ -378,11 +414,12 @@ RubyPGExtras.bloat
  index | public     | bloated_table::bloated_index  |   3.7 | 34 MB
  table | public     | clean_table                   |   0.2 | 3808 kB
  table | public     | other_clean_table             |   0.3 | 1576 kB
+ (truncated results for brevity)
 ```
 
 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.
 
-### vacuum_stats
+### `vacuum_stats`
 
 ```ruby
 
@@ -395,26 +432,37 @@ RubyPGExtras.vacuum_stats
  public | other_table           |             | 2013-04-26 11:41 |             41 |             47 |             58       |
  public | queue_table           |             | 2013-04-26 17:39 |             12 |          8,228 |             52       | yes
  public | picnic_table          |             |                  |             13 |              0 |             53       |
+ (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.
 
-### mandelbrot
+### `kill_all`
 
 ```ruby
 
-RubyPGExtras.mandelbrot
+RubyPGExtras.kill_all
 
 ```
 
-This command outputs the Mandelbrot set, calculated through SQL.
+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.
 
-## FAQ
+### `extensions`
 
-* Does is not violate the Heroku PG Extras license?
+```ruby
+
+RubyPGExtras.extensions
+
+```
+
+This command lists all the currently installed and available PostgreSQL extensions.
 
-The original plugin is MIT based so it means that copying and redistribution in any format is permitted.
+### `mandelbrot`
 
-## Disclaimer
+```ruby
 
-This tool is in beta state.
+RubyPGExtras.mandelbrot
+
+```
+
+This command outputs the Mandelbrot set, calculated through SQL.

data/lib/ruby-pg-extras.rb

@@ -14,7 +14,7 @@ module RubyPGExtras
     long_running_queries mandelbrot outliers
     records_rank seq_scans table_indexes_size
     table_size total_index_size total_table_size
-    unused_indexes vacuum_stats
+    unused_indexes vacuum_stats kill_all
   )
 
   QUERIES.each do |query_name|

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

@@ -0,0 +1,6 @@
+/* Kill all the active database connections */
+
+SELECT pg_terminate_backend(pid) FROM pg_stat_activity
+  WHERE pid <> pg_backend_pid()
+  AND query <> '<insufficient privilege>'
+  AND datname = current_database();

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/total_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_total_relation_size(c.oid) DESC;

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-pg-extras
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.2.2
 platform: ruby
 authors:
 - pawurb
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -92,6 +92,7 @@ files:
 - lib/ruby-pg-extras/queries/index_cache_hit.sql
 - lib/ruby-pg-extras/queries/index_size.sql
 - lib/ruby-pg-extras/queries/index_usage.sql
+- lib/ruby-pg-extras/queries/kill_all.sql
 - lib/ruby-pg-extras/queries/locks.sql
 - lib/ruby-pg-extras/queries/long_running_queries.sql
 - lib/ruby-pg-extras/queries/mandelbrot.sql
@@ -113,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
@@ -128,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.2
+signing_key:
 specification_version: 4
 summary: Ruby PostgreSQL performance database insights
 test_files: