rails-pg-extras 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a24a2db9fa47e0039fc8f53dfe5eebe2bedf1aad770f5806b7a5ffa55a9be04
-  data.tar.gz: 7004a3d05e7754bfd724457827c80e79c2dccfd6dc60daf59b7ca9097f94ad1a
+  metadata.gz: 2a35eb696b77eb6560026bf34ecfcd2e5418beb0c4cee6b414be24510e095d3d
+  data.tar.gz: a3db0a5917706994eba4850f267c901988bec5b1a73d2b25e3dd168bbe40d0f9
 SHA512:
-  metadata.gz: 66b274e7976f4f4bbf1e8db346ccaf7e44200d58d389ef2f2610ad9435add499fda69f1f7f6f8259d0c17f248d8ef9124e75d1d221a439a281f6be418ad25af2
-  data.tar.gz: 8d1a2c78e21df1cffdd5cd99a550e2be5b9a44c7ad8f0daed95f92e969020e01ff92fafe183d974aad3ee0d177d0fcf88957cae542a706354d685c25ab2602db
+  metadata.gz: 8f506dfeb7e73d5e708e4fbdc3748de4e014882e75c8bf87d7ea1f12910abecbb44d84658b5ab998337552a3249a4b96ea2f42bfcff653e489339cc92737000b
+  data.tar.gz: d2c54f07b4f428da96f621a8593a321dac6e87575e82d849245c2403217b14b46fa87851bd2ac5ebdf52ca526e84f2bac125aabcd5c11f81b6102b099f8e42e7

data/README.md

@@ -1,6 +1,6 @@
-# Rails PG Extras
+# Rails PG Extras [![Gem Version](https://badge.fury.io/rb/rails-pg-extras.svg)](https://badge.fury.io/rb/rails-pg-extras)
 
-Inspired by (a shameless ripoff of) [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras). The goal of this project is to provide a powerful insights into PostgreSQL database for Ruby on Rails apps that are not using the default Heroku PostgreSQL plugin.
+Rails port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras). The goal of this project is to provide a powerful insights into PostgreSQL database for Ruby on Rails apps that are not using the default 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.
 
@@ -16,6 +16,43 @@ gem 'rails-pg-extras'
 
 Each command can be used as a rake task, or a directly from the Ruby code.
 
+```bash
+rake pg_extras:cache_hit
+```
+
+```ruby
+RailsPGExtras.cache_hit
+```
+```bash
++----------------+------------------------+
+|        Index and table hit rate         |
++----------------+------------------------+
+| name           | ratio                  |
++----------------+------------------------+
+| index hit rate | 0.97796610169491525424 |
+| table hit rate | 0.96724294813466787989 |
++----------------+------------------------+
+```
+
+
+By default the ASCII table is displayed, to change to format you need to specify the `in_format` parameter (`[:display_table, :hash, :array, :raw]` options are available):
+
+```ruby
+RailsPGExtras.cache_hit(in_format: :hash) =>
+
+ [{"name"=>"index hit rate", "ratio"=>"0.97796610169491525424"}, {"name"=>"table hit rate", "ratio"=>"0.96724294813466787989"}]
+
+RailsPGExtras.cache_hit(in_format: :array) =>
+
+ [["index hit rate", "0.97796610169491525424"], ["table hit rate", "0.96724294813466787989"]]
+
+RailsPGExtras.cache_hit(in_format: :raw) =>
+
+ #<PG::Result:0x00007f75777f7328 status=PGRES_TUPLES_OK ntuples=2 nfields=2 cmd_tuples=2>
+```
+
+### Available methods
+
 #### `cache_hit`
 
 ```bash
@@ -62,7 +99,15 @@ $ rake pg_extras:locks
 
 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.
 
-### `pg:outliers`
+### `all_locks`
+
+```
+$ rake pg_extras:all_locks
+```
+
+This command displays all the current locks, regardless of their type.
+
+### `outliers`
 
 ```
 $ rake pg_extras:outliers
@@ -309,7 +354,7 @@ $ rake pg_extras:vacuum_stats
 
 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.
 
-### pg:mandelbrot
+### mandelbrot
 
 ```
 $ rake pg_extras:mandelbrot
@@ -322,3 +367,7 @@ This command outputs the Mandelbrot set, calculated through SQL.
 * Does is not violate the Heroku PG Extras license?
 
 The original plugin is [MIT based](https://github.com/heroku/heroku-pg-extras/blob/master/LICENSE) so it means that copying and redistribution in any format is permitted.
+
+## Disclaimer
+
+This tool is in beta state.

data/lib/rails-pg-extras.rb

@@ -6,7 +6,7 @@ module RailsPGExtras
   QUERIES =   %i(
     bloat blocking cache_hit
      calls extensions
-     index_size index_usage locks
+     index_size index_usage locks all_locks
      long_running_queries mandelbrot outliers
      records_rank seq_scans table_indexes_size
      table_size total_index_size total_table_size

data/lib/rails-pg-extras/queries/all_locks.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsPGExtras
+  def self.locks_description
+    "Queries with active locks"
+  end
+
+  def self.locks_sql
+    <<-EOS
+SELECT
+  pg_stat_activity.pid,
+  pg_class.relname,
+  pg_locks.transactionid,
+  pg_locks.granted,
+  pg_locks.mode,
+  pg_stat_activity.query AS query_snippet,
+  age(now(),pg_stat_activity.query_start) AS "age"
+FROM pg_stat_activity,pg_locks left
+OUTER JOIN pg_class
+  ON (pg_locks.relation = pg_class.oid)
+WHERE pg_stat_activity.query <> '<insufficient privilege>'
+  AND pg_locks.pid = pg_stat_activity.pid
+  AND pg_stat_activity.pid <> pg_backend_pid() order by query_start;
+EOS
+  end
+end

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

@@ -1,3 +1,3 @@
 module RailsPGExtras
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-pg-extras
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - pawurb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-25 00:00:00.000000000 Z
+date: 2019-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -51,10 +51,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- coverage/.last_run.json
-- coverage/.resultset.json
-- coverage/.resultset.json.lock
 - lib/rails-pg-extras.rb
+- lib/rails-pg-extras/queries/all_locks.rb
 - lib/rails-pg-extras/queries/bloat.rb
 - lib/rails-pg-extras/queries/blocking.rb
 - lib/rails-pg-extras/queries/cache_hit.rb

data/coverage/.last_run.json

@@ -1,5 +0,0 @@
-{
-  "result": {
-    "covered_percent": 95.19
-  }
-}

data/coverage/.resultset.json

@@ -1,587 +0,0 @@
-{
-  "RSpec": {
-    "coverage": {
-      "/Users/pablo/Programming/Ruby/termit/lib/termit.rb": [
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        null,
-        1,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/output_manager.rb": [
-        null,
-        1,
-        1,
-        1,
-        2,
-        2,
-        null,
-        null,
-        1,
-        1,
-        1,
-        null,
-        1,
-        null,
-        0,
-        null,
-        1,
-        null,
-        null,
-        1,
-        3,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        3,
-        null,
-        null,
-        null,
-        1,
-        2,
-        2,
-        null,
-        null,
-        1,
-        3,
-        3,
-        null,
-        null,
-        1,
-        0,
-        0,
-        null,
-        null,
-        1,
-        0,
-        0,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/can_output.rb": [
-        1,
-        1,
-        1,
-        4,
-        null,
-        null,
-        1,
-        null,
-        1,
-        8,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/user_input_parser.rb": [
-        null,
-        1,
-        1,
-        1,
-        null,
-        1,
-        null,
-        1,
-        7,
-        7,
-        4,
-        null,
-        1,
-        null,
-        null,
-        1,
-        3,
-        null,
-        null,
-        1,
-        null,
-        1,
-        null,
-        null,
-        null,
-        null,
-        null,
-        3,
-        null,
-        null,
-        1,
-        3,
-        3,
-        null,
-        null,
-        1,
-        4,
-        4,
-        4,
-        8,
-        null,
-        null,
-        null,
-        1,
-        7,
-        5,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/main.rb": [
-        null,
-        1,
-        1,
-        1,
-        2,
-        null,
-        null,
-        1,
-        2,
-        2,
-        2,
-        null,
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/sound_response_handler.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        1,
-        null,
-        null,
-        1,
-        1,
-        1,
-        1,
-        0,
-        null,
-        1,
-        null,
-        null,
-        1,
-        null,
-        1,
-        1,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/text_translator.rb": [
-        null,
-        1,
-        1,
-        1,
-        null,
-        1,
-        2,
-        2,
-        null,
-        null,
-        1,
-        2,
-        2,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/speech_synthesizer.rb": [
-        null,
-        1,
-        1,
-        1,
-        1,
-        null,
-        1,
-        2,
-        2,
-        2,
-        null,
-        null,
-        1,
-        2,
-        2,
-        null,
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/url_constructor.rb": [
-        null,
-        null,
-        1,
-        1,
-        1,
-        null,
-        1,
-        6,
-        null,
-        null,
-        1,
-        6,
-        null,
-        null,
-        1,
-        null,
-        1,
-        5,
-        null,
-        null,
-        1,
-        1,
-        null,
-        null,
-        1,
-        1,
-        0,
-        1,
-        0,
-        1,
-        0,
-        null,
-        1,
-        null,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/data_fetcher_base.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        1,
-        1,
-        null,
-        1,
-        2,
-        2,
-        null,
-        null,
-        1,
-        2,
-        null,
-        0,
-        0,
-        null,
-        0,
-        0,
-        null,
-        null,
-        1,
-        null,
-        1,
-        null,
-        1,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        1,
-        1,
-        1,
-        1,
-        null,
-        2,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/text_fetcher.rb": [
-        null,
-        null,
-        1,
-        1,
-        1,
-        null,
-        1,
-        2,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null,
-        1,
-        2,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/sound_fetcher.rb": [
-        null,
-        null,
-        1,
-        1,
-        1,
-        null,
-        1,
-        0,
-        null,
-        null,
-        null,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/lib/termit/text_response_handler.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        1,
-        null,
-        1,
-        3,
-        null,
-        null,
-        1,
-        3,
-        3,
-        3,
-        null,
-        null,
-        1,
-        null,
-        1,
-        3,
-        null,
-        null,
-        1,
-        3,
-        3,
-        3,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/spec/termit/output_manager_spec.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        2,
-        null,
-        1,
-        1,
-        1,
-        8,
-        null,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/spec/termit/sound_response_handler_spec.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        2,
-        2,
-        null,
-        1,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/spec/termit/speech_synthesizer_spec.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        2,
-        2,
-        2,
-        4,
-        4,
-        null,
-        null,
-        1,
-        1,
-        2,
-        1,
-        1,
-        null,
-        null,
-        null,
-        1,
-        1,
-        2,
-        null,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/spec/termit/text_response_handler_spec.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        1,
-        1,
-        null,
-        null,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/spec/termit/text_translator_spec.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null,
-        null,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/spec/termit/url_constructor_spec.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        1,
-        1,
-        1,
-        null,
-        1,
-        null,
-        null,
-        null,
-        1,
-        1,
-        1,
-        1,
-        1,
-        null,
-        null,
-        null,
-        null
-      ],
-      "/Users/pablo/Programming/Ruby/termit/spec/termit/user_input_parser_spec.rb": [
-        null,
-        1,
-        null,
-        1,
-        1,
-        1,
-        1,
-        2,
-        null,
-        null,
-        null,
-        1,
-        1,
-        1,
-        1,
-        null,
-        null,
-        1,
-        2,
-        null,
-        null,
-        1,
-        2,
-        null,
-        null,
-        null,
-        1,
-        1,
-        1,
-        null,
-        null,
-        1,
-        1,
-        1,
-        null,
-        null,
-        1,
-        2,
-        null,
-        null,
-        null,
-        null
-      ]
-    },
-    "timestamp": 1495699232
-  }
-}