rails-pg-extras 0.7.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 506d95562fb9dcf353e233962941de468492a429cf1f4c32aedbc12c8ad61ad8
-  data.tar.gz: a26cdce454bf3a379e2cefd6219cecb3bf12aae7b9d6014b717eec9685cc98af
+  metadata.gz: 5cf36789c8d7210dd1512d3d7ef8de0d0bcf88ca3d339e1ee5e89daf82264c32
+  data.tar.gz: 5054854e791db2e53408c53fd30d11e907b7caed8549fccaecedd98b10469ce4
 SHA512:
-  metadata.gz: a660057f6a220a65acf624754273fa62fe16459092b81ee5ba61c1b4a2a38f47c8204b233faf91f4a5ff9ab2bda48efdb784cc1d027f792497caba1c9c994727
-  data.tar.gz: d2bd6dd7bae2885b36f779063e1b59ab3c402caa630f86e5d6dca83c45454c5194e3f421a532c307b06594edba4270f86c92510ee531515b053a8682427811a0
+  metadata.gz: 3fe6766ddb5896202a408ae95e6a4fc91edf42149d15b348c731bfdda153225ae7949cbc6eab2cb266ffa0ebf4daf1eb3d497cb06807b64fe66c0fad28eb17d1
+  data.tar.gz: 3c8d26e07807c15df4af9a8fb785bc9cc78fc52f55baae6c46db0911edc2e13a7cdd0b882560ba363c9c89b46a8fb7b48d350ec63bb3b1258fd335fe8816f1ad

data/README.md

@@ -1,20 +1,43 @@
 # Rails PG Extras [![Gem Version](https://badge.fury.io/rb/rails-pg-extras.svg)](https://badge.fury.io/rb/rails-pg-extras) [![CircleCI](https://circleci.com/gh/pawurb/rails-pg-extras.svg?style=svg)](https://circleci.com/gh/pawurb/rails-pg-extras)
 
-Rails 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 on Rails apps that are not using the Heroku PostgreSQL plugin.
+Rails 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 on Rails 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.
 
-Not using Rails? Check out the core dependency [pure Ruby version](https://github.com/pawurb/ruby-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:
+
+- Core dependency - [Ruby](https://github.com/pawurb/ruby-pg-extras)
+
+- [NodeJS](https://github.com/pawurb/node-postgres-extras)
+
+- [Elixir](https://github.com/pawurb/ecto_psql_extras)
+
+- [Python](https://github.com/pawurb/ecto_psql_extras)
+
+## Installation
 
 In your Gemfile
 
 ```ruby
-gem 'rails-pg-extras'
+gem "rails-pg-extras"
 ```
 
-### Usage
+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
+RailsPGExtras.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
 
 Each command can be used as a rake task, or a directly from the Ruby code.
 
@@ -53,12 +76,13 @@ RailsPGExtras.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`
 
-```bash
+```
 $ rake pg_extras:cache_hit
+
       name      |         ratio
 ----------------+------------------------
  index hit rate | 0.99957765013541945832
@@ -68,10 +92,43 @@ $ 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.
 
-#### `index_usage`
+### `index_cache_hit`
+
+```
+
+$ rake pg_extras: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`
+
+```
+
+$ rake pg_extras: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`
 
 ```
 $ rake pg_extras:index_usage
+
        relname       | percent_of_times_index_used | rows_in_table
 ---------------------+-----------------------------+---------------
  events              |                          65 |       1217347
@@ -114,6 +171,7 @@ This command displays all the current locks, regardless of their type.
 
 ```
 $ rake pg_extras:outliers
+
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
  SELECT * FROM archivable_usage_events.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00
@@ -122,11 +180,7 @@ $ rake pg_extras:outliers
  INSERT INTO usage_events (id, retaine.. | 01:42:59.436532  | 0.8%           | 12,328,187  | 00:00:00
  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).
@@ -137,6 +191,7 @@ Typically, an efficient query will have an appropriate ratio of calls to total e
 
 ```
 $ rake pg_extras:calls
+
                    qry                   |    exec_time     | prop_exec_time |   ncalls    | sync_io_time
 -----------------------------------------+------------------+----------------+-------------+--------------
  SELECT * FROM usage_events WHERE (alp.. | 01:18:11.073333  | 0.6%           | 102,120,780 | 00:00:00
@@ -144,12 +199,7 @@ $ rake pg_extras:calls
  COMMIT                                  | 00:00:52.31724   | 0.0%           | 47,288,615  | 00:00:00
  SELECT * FROM  archivable_usage_event.. | 154:39:26.431466 | 72.2%          | 34,211,877  | 00:00:00
  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.
@@ -158,6 +208,7 @@ This command is much like `pg:outliers`, but ordered by the number of times a st
 
 ```
 $ rake pg_extras:blocking
+
  blocked_pid |    blocking_statement    | blocking_duration | blocking_pid |                                        blocked_statement                           | blocked_duration
 -------------+--------------------------+-------------------+--------------+------------------------------------------------------------------------------------+------------------
          461 | select count(*) from app | 00:00:03.838314   |        15682 | UPDATE "app" SET "updated_at" = '2013-03-04 15:07:04.746688' WHERE "id" = 12823149 | 00:00:03.821826
@@ -170,6 +221,7 @@ This command displays statements that are currently holding locks that other sta
 
 ```
 $ rake pg_extras:total_index_size
+
   size
 -------
  28194 MB
@@ -194,11 +246,6 @@ $ rake pg_extras: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)
 ```
 
@@ -208,6 +255,7 @@ This command displays the size of each each index in the database, in MB. It is
 
 ```
 $ rake pg_extras:table_size
+
                              name                              |  size
 ---------------------------------------------------------------+---------
  learning_coaches                                              |  196 MB
@@ -218,12 +266,13 @@ $ rake pg_extras: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`
 
 ```
-$ rake pg_extras:table-indexes-size
+$ rake pg_extras:table_indexes_size
+
                              table                             | indexes_size
 ---------------------------------------------------------------+--------------
  learning_coaches                                              |    153 MB
@@ -234,12 +283,13 @@ $ rake pg_extras: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`
 
 ```
 $ rake pg_extras:total_table_size
+
                              name                              |  size
 ---------------------------------------------------------------+---------
  learning_coaches                                              |  349 MB
@@ -250,12 +300,13 @@ $ rake pg_extras: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`
 
 ```
 $ rake pg_extras:unused_indexes
+
           table      |                       index                | index_size | index_scans
 ---------------------+--------------------------------------------+------------+-------------
  public.grade_levels | index_placement_attempts_on_grade_level_id | 97 MB      |           0
@@ -294,7 +345,7 @@ $ rake pg_extras:seq_scans
 
 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`
 
 ```
 $ rake pg_extras:long_running_queries
@@ -309,10 +360,11 @@ $ rake pg_extras: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`
 
 ```
 $ rake pg_extras:records_rank
+
                name                | estimated_count
 -----------------------------------+-----------------
  tastypie_apiaccess                |          568891
@@ -326,7 +378,7 @@ $ rake pg_extras: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`
 
 ```
 $ rake pg_extras:bloat
@@ -338,39 +390,51 @@ $ rake pg_extras: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`
 
 ```
 $ rake pg_extras:vacuum_stats
+
  schema |         table         | last_vacuum | last_autovacuum  |    rowcount    | dead_rowcount  | autovacuum_threshold | expect_autovacuum
 --------+-----------------------+-------------+------------------+----------------+----------------+----------------------+-------------------
  public | log_table             |             | 2013-04-26 17:37 |         18,030 |              0 |          3,656       |
  public | data_table            |             | 2013-04-26 13:09 |             79 |             28 |             66       |
  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
+
+RailsPGExtras.kill_all
 
-```
-$ rake pg_extras:mandelbrot
 ```
 
-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.
+
+### `extensions`
+
+```ruby
+
+RailsPGExtras.extensions
 
-## FAQ
+```
 
-* Does is not violate the Heroku PG Extras license?
+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
+```
+$ rake pg_extras:mandelbrot
+```
 
-This tool is in beta state.
+This command outputs the Mandelbrot set, calculated through SQL.

data/lib/rails-pg-extras/tasks/all.rake

@@ -3,9 +3,16 @@
 require 'rails-pg-extras'
 
 namespace :pg_extras do
+  desc "Establish connection"
+  task :establish_connection do
+    db_config_file = File.open('config/database.yml')
+    db_config = YAML::load(db_config_file)
+    ActiveRecord::Base.establish_connection(db_config[Rails.env])
+  end
+
   RailsPGExtras::QUERIES.each do |query_name|
     desc RubyPGExtras.description_for(query_name: query_name)
-    task query_name.to_sym => :environment do
+    task query_name.to_sym => :establish_connection do
       RailsPGExtras.public_send(query_name)
     end
   end

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-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: ruby-pg-extras
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +93,7 @@ homepage: http://github.com/pawurb/rails-pg-extras
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,8 +108,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: Rails PostgreSQL performance database insights
 test_files: