pghero 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f45d1e2c61994223e2835c0d8fdbefea6a9c0b36
-  data.tar.gz: 74227dbc52f80e9b1cb150f601a8ec9705ac56b3
+SHA256:
+  metadata.gz: b627e79e52bdd3c9eb7f850e4350cd286459ac3771ec94c33b527e4061cad6d6
+  data.tar.gz: 33773361eb689372f74d012e5d603c76171abc153dd3eccff3ec6ef15012de1f
 SHA512:
-  metadata.gz: f96125273c33eb6b632894c927118c2e308a62829df66128ca3a917dd578eafae7dd77308fd832142ddb54d61e748d753ee06da83f5393d3417d447223a208cd
-  data.tar.gz: 777fc575408694f43f3a8de1273341c5be02e3288a63424e5150a13c5c4403fbc547c84b5172cdb23dc9720dfc3b50b8acf3d574dad399a569c43035df435984
+  metadata.gz: 857c4d36050a5532240173faae721bf93f6219641ed005a77ff3d45fd4eda6aa78e10d2d9c2bc8cc6e93547eb97c47006802b9bfad5f02f186535d1eb219e779
+  data.tar.gz: efba82dcf9d151aee9c94adac95ca27a032da04a358b435aaa86f7255949d7bf63f1a58f39f18976eeba294a0386223ea16c752c9f1e8285d0aa6fa5c8d29921

data/.gitattributes

@@ -0,0 +1 @@
+app/assets/* linguist-vendored

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,7 @@
+Hi,
+
+Before creating an issue, please check out the Contributing Guide:
+
+https://github.com/ankane/pghero/blob/master/CONTRIBUTING.md
+
+Thanks!

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
-rvm: 2.2.4
+rvm: 2.4.4
 cache: bundler
 sudo: false
 script: TRAVIS_CI=1 bundle exec rake test
 addons:
   postgresql: "9.4"
+before_install:
+  - gem update --system
+  - gem install bundler
 before_script:
   - psql -c 'create database pghero_test;' -U postgres
 notifications:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.1.1
+
+- Added `explain_timeout_sec` option
+- Fixed error with unparsable sequences
+- Stopped throwing `Same sequence name in multiple schemas` error
+
 ## 2.1.0
 
 - Fixed issue with sequences in different schema than table

data/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+First, thanks for wanting to contribute. You’re awesome! :heart:
+
+## Questions
+
+Use [Stack Overflow](https://stackoverflow.com/) with the tag `pghero`.
+
+## Feature Requests
+
+Create an issue. Start the title with `[Idea]`.
+
+## Issues
+
+Think you’ve discovered an issue?
+
+1. Search existing issues to see if it’s been reported.
+2. Try the `master` branch to make sure it hasn’t been fixed.
+
+```rb
+gem "pghero", github: "ankane/pghero"
+```
+
+If the above steps don’t help, create an issue. Include:
+
+- Detailed steps to reproduce
+- Complete backtraces for exceptions
+
+## Pull Requests
+
+Fork the project and create a pull request. A few tips:
+
+- Keep changes to a minimum. If you have multiple features or fixes, submit multiple pull requests.
+- Follow the existing style. The code should read like it’s written by a single person.
+
+Feel free to open an issue to get feedback on your idea before spending too much time on it.
+
+---
+
+This contributing guide is released under [CCO](https://creativecommons.org/publicdomain/zero/1.0/) (public domain). Use it for your own project without attribution.

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in pghero.gemspec
 gemspec
 
-gem "activerecord", "~> 5.1.0"
+gem "activerecord", "~> 5.2.0"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Andrew Kane, 2008-2014 Heroku (initial queries)
+Copyright (c) 2014-2018 Andrew Kane, 2008-2014 Heroku (initial queries)
 
 MIT License
 

data/README.md

@@ -20,6 +20,12 @@ Select your preferred method of installation to get started.
 - [Linux](guides/Linux.md)
 - [Docker](guides/Docker.md)
 
+## Related Projects
+
+- [PgBouncerHero](https://github.com/kwent/pgbouncerhero) - A dashboard for PgBouncer
+- [pgsync](https://github.com/ankane/pgsync) - Sync Postgres data between databases
+- [pgslice](https://github.com/ankane/pgslice) - Postgres partitioning as easy as pie
+
 ## Credits
 
 A big thanks to [Craig Kerstiens](http://www.craigkerstiens.com/2013/01/10/more-on-postgres-performance/) and [Heroku](https://blog.heroku.com/archives/2013/5/10/more_insight_into_your_database_with_pgextras) for the initial queries and [Bootswatch](https://github.com/thomaspark/bootswatch) for the theme :clap:

data/app/controllers/pg_hero/home_controller.rb

@@ -196,6 +196,8 @@ module PgHero
 
       if @duration / @period > 1440
         render_text "Too many data points"
+      elsif @period % 60 != 0
+        render_text "Period must be a multiple of 60"
       end
     end
 
@@ -245,6 +247,10 @@ module PgHero
           @visualize = params[:commit] == "Visualize"
         rescue ActiveRecord::StatementInvalid => e
           @error = e.message
+
+          if @error.include?("bind message supplies 0 parameters")
+            @error = "Can't explain queries with bind parameters"
+          end
         end
       end
     end

data/app/helpers/pg_hero/base_helper.rb

@@ -3,7 +3,7 @@ module PgHero
     def pghero_pretty_ident(table, schema: nil)
       ident = table
       if schema && schema != "public"
-        indent = "#{schema}.#{table}"
+        ident = "#{schema}.#{table}"
       end
       if ident =~ /\A[a-z0-9_]+\z/
         ident

data/app/views/pg_hero/home/index.html.erb

@@ -129,9 +129,13 @@
               <% end %>
             </td>
             <td>
-              <%= sequence[:sequence] %>
-              <% if sequence[:schema] && sequence[:schema] != "public" %>
-                <span class="text-muted"><%= sequence[:schema] %></span>
+              <% if sequence[:sequence] %>
+                <%= sequence[:sequence] %>
+                <% if sequence[:schema] && sequence[:schema] != "public" %>
+                  <span class="text-muted"><%= sequence[:schema] %></span>
+                <% end %>
+              <% else %>
+                Unable to parse: <%= sequence[:default_value] %>
               <% end %>
             </td>
           </tr>

data/app/views/pg_hero/home/tune.html.erb

@@ -18,7 +18,7 @@
     </tbody>
   </table>
 
-  <p>Check out <%= link_to "PgTune", "http://pgtune.leopard.in.ua", target: "_blank" %> for recommendations. DB version is <%= @database.server_version.split(".").first(2).join(".") %>.</p>
+  <p>Check out <%= link_to "PgTune", "https://pgtune.leopard.in.ua/", target: "_blank" %> for recommendations. DB version is <%= @database.server_version.split(" ").first.split(".").first(2).join(".") %>.</p>
 </div>
 
 <% if @autovacuum_settings %>

data/guides/Heroku.md

@@ -94,3 +94,9 @@ Minimum connections for high connections warning
 ```sh
 heroku config:set PGHERO_TOTAL_CONNECTIONS_THRESHOLD=100 # default
 ```
+
+Statement timeout for explain
+
+```sh
+heroku config:set PGHERO_EXPLAIN_TIMEOUT_SEC=10 # default
+````

data/guides/Linux.md

@@ -4,6 +4,7 @@ Distributions
 
 - [Ubuntu 16.04 (Xenial)](#ubuntu-1604-xenial)
 - [Ubuntu 14.04 (Trusty)](#ubuntu-1404-trusty)
+- [Debian 9 (Stretch)](#debian-9-stretch)
 - [Debian 8 (Jesse)](#debian-8-jesse)
 - [Debian 7 (Wheezy)](#debian-7-wheezy)
 - [CentOS / RHEL 7](#centos--rhel-7)
@@ -33,6 +34,17 @@ sudo apt-get update
 sudo apt-get -y install pghero
 ```
 
+### Debian 9 (Stretch)
+
+```sh
+sudo apt-get -y install apt-transport-https
+wget -qO- https://dl.packager.io/srv/pghero/pghero/key | sudo apt-key add -
+sudo wget -O /etc/apt/sources.list.d/pghero.list \
+  https://dl.packager.io/srv/pghero/pghero/master/installer/debian/9.repo
+sudo apt-get update
+sudo apt-get -y install pghero
+```
+
 ### Debian 8 (Jesse)
 
 ```sh
@@ -248,6 +260,12 @@ Minimum connections for high connections warning
 sudo pghero config:set PGHERO_TOTAL_CONNECTIONS_THRESHOLD=100 # default
 ```
 
+Statement timeout for explain
+
+```sh
+sudo pghero config:set PGHERO_EXPLAIN_TIMEOUT_SEC=10 # default
+````
+
 ## Upgrading
 
 Ubuntu and Debian

data/guides/Query-Stats.md

@@ -1,6 +1,6 @@
 # Query Stats
 
-The [pg_stat_statements module](http://www.postgresql.org/docs/9.3/static/pgstatstatements.html) is used for query stats.
+The [pg_stat_statements module](https://www.postgresql.org/docs/current/static/pgstatstatements.html) is used for query stats.
 
 ## Installation
 

data/guides/Rails.md

@@ -172,6 +172,12 @@ Minimum connections for high connections warning
 PgHero.total_connections_threshold = 100 # default
 ```
 
+Statement timeout for explain
+
+```ruby
+PgHero.explain_timeout_sec = 10 # default
+```
+
 ## Methods
 
 Insights
@@ -329,5 +335,5 @@ CREATE EXTENSION pg_stat_statements;
 ## Bonus
 
 - See where queries come from with [Marginalia](https://github.com/basecamp/marginalia) - comments appear on the Live Queries tab.
-- Get weekly news and articles with [Postgres Weekly](http://postgresweekly.com)
-- Optimize your configuration with [PgTune](http://pgtune.leopard.in.ua) and [pgBench](http://www.postgresql.org/docs/devel/static/pgbench.html)
+- Get weekly news and articles with [Postgres Weekly](https://postgresweekly.com/)
+- Optimize your configuration with [PgTune](https://pgtune.leopard.in.ua/) and [pgBench](https://www.postgresql.org/docs/devel/static/pgbench.html)

data/guides/Suggested-Indexes.md

@@ -1,12 +1,12 @@
 # How PgHero Suggests Indexes
 
-1. Get the most time-consuming queries from [pg_stat_statements](http://www.postgresql.org/docs/current/static/pgstatstatements.html).
+1. Get the most time-consuming queries from [pg_stat_statements](https://www.postgresql.org/docs/current/static/pgstatstatements.html).
 
 2. Parse queries with [pg_query](https://github.com/lfittl/pg_query).  Look for a single table with a `WHERE` clause that consists of only `=`, `IN`, `IS NULL` or `IS NOT NULL` and/or an `ORDER BY` clause.
 
-3. Use the [pg_stats](http://www.postgresql.org/docs/current/static/view-pg-stats.html) view to get estimates about distinct rows and percent of `NULL` values for each column.
+3. Use the [pg_stats](https://www.postgresql.org/docs/current/static/view-pg-stats.html) view to get estimates about distinct rows and percent of `NULL` values for each column.
 
-4. For each column in the `WHERE` clause, sort by the highest [cardinality](https://en.wikipedia.org/wiki/Cardinality_(SQL_statements)) (most unique values). This allows the database to narrow its search the fastest. Perform [row estimation](http://www.postgresql.org/docs/current/static/row-estimation-examples.html) to get the expected number of rows as we add columns to the index.
+4. For each column in the `WHERE` clause, sort by the highest [cardinality](https://en.wikipedia.org/wiki/Cardinality_(SQL_statements)) (most unique values). This allows the database to narrow its search the fastest. Perform [row estimation](https://www.postgresql.org/docs/current/static/row-estimation-examples.html) to get the expected number of rows as we add columns to the index.
 
 5. Continue this process with columns in the `ORDER BY` clause.
 

data/lib/generators/pghero/templates/config.yml

@@ -15,6 +15,9 @@ databases:
     # Minimum connections for high connections warning
     # total_connections_threshold: 100
 
+    # Statement timeout for explain
+    # explain_timeout_sec: 10
+
   # Add more databases
   # other:
   #   url: <%= ENV["OTHER_DATABASE_URL"] %>

data/lib/pghero.rb

@@ -32,11 +32,12 @@ module PgHero
 
   # settings
   class << self
-    attr_accessor :long_running_query_sec, :slow_query_ms, :slow_query_calls, :total_connections_threshold, :cache_hit_rate_threshold, :env, :show_migrations
+    attr_accessor :long_running_query_sec, :slow_query_ms, :slow_query_calls, :explain_timeout_sec, :total_connections_threshold, :cache_hit_rate_threshold, :env, :show_migrations
   end
   self.long_running_query_sec = (ENV["PGHERO_LONG_RUNNING_QUERY_SEC"] || 60).to_i
   self.slow_query_ms = (ENV["PGHERO_SLOW_QUERY_MS"] || 20).to_i
   self.slow_query_calls = (ENV["PGHERO_SLOW_QUERY_CALLS"] || 100).to_i
+  self.explain_timeout_sec = (ENV["PGHERO_EXPLAIN_TIMEOUT_SEC"] || 10).to_i
   self.total_connections_threshold = (ENV["PGHERO_TOTAL_CONNECTIONS_THRESHOLD"] || 100).to_i
   self.cache_hit_rate_threshold = 99
   self.env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"

data/lib/pghero/database.rb

@@ -52,6 +52,10 @@ module PgHero
       (config["slow_query_calls"] || PgHero.config["slow_query_calls"] || PgHero.slow_query_calls).to_i
     end
 
+    def explain_timeout_sec
+      (config["explain_timeout_sec"] || PgHero.config["explain_timeout_sec"] || PgHero.explain_timeout_sec).to_i
+    end
+
     def long_running_query_sec
       (config["long_running_query_sec"] || PgHero.config["long_running_query_sec"] || PgHero.long_running_query_sec).to_i
     end

data/lib/pghero/methods/explain.rb

@@ -6,7 +6,7 @@ module PgHero
         explanation = nil
 
         # use transaction for safety
-        with_transaction(statement_timeout: 10000, rollback: true) do
+        with_transaction(statement_timeout: (explain_timeout_sec * 1000), rollback: true) do
           if (sql.sub(/;\z/, "").include?(";") || sql.upcase.include?("COMMIT")) && !explain_safe?
             raise ActiveRecord::StatementInvalid, "Unsafe statement"
           end

data/lib/pghero/methods/sequences.rb

@@ -28,9 +28,10 @@ module PgHero
 
         # parse out sequence
         sequences.each do |column|
-          m = /^nextval\('(.+)'\:\:regclass\)$/.match(column.delete(:default_value))
-          column[:schema], column[:sequence] = unquote_ident(m[1])
           column[:max_value] = column[:column_type] == 'integer' ? 2147483647 : 9223372036854775807
+
+          column[:schema], column[:sequence] = parse_default_value(column[:default_value])
+          column.delete(:default_value) if column[:sequence]
         end
 
         add_sequence_attributes(sequences)
@@ -49,6 +50,19 @@ module PgHero
 
       private
 
+      # can parse
+      # nextval('id_seq'::regclass)
+      # nextval(('id_seq'::text)::regclass)
+      def parse_default_value(default_value)
+        m = /^nextval\('(.+)'\:\:regclass\)$/.match(default_value)
+        m = /^nextval\(\('(.+)'\:\:text\)\:\:regclass\)$/.match(default_value) unless m
+        if m
+          unquote_ident(m[1])
+        else
+          []
+        end
+      end
+
       def unquote_ident(value)
         schema, seq = value.split(".")
         unless seq
@@ -77,22 +91,18 @@ module PgHero
         SQL
 
         # first populate missing schemas
-        missing_schema = sequences.select { |s| s[:schema].nil? }
+        missing_schema = sequences.select { |s| s[:schema].nil? && s[:sequence] }
         if missing_schema.any?
           sequence_schemas = sequence_attributes.group_by { |s| s[:sequence] }
 
           missing_schema.each do |sequence|
             schemas = sequence_schemas[sequence[:sequence]] || []
 
-            case schemas.size
-            when 0
-              # do nothing, will be marked as unreadable
-            when 1
-              # bingo
+            if schemas.size == 1
               sequence[:schema] = schemas[0][:schema]
-            else
-              raise PgHero::Error, "Same sequence name in multiple schemas: #{sequence[:sequence]}"
             end
+            # otherwise, do nothing, will be marked as unreadable
+            # TODO better message for multiple schemas
           end
         end
 

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/pghero.gemspec

@@ -9,7 +9,6 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Andrew Kane"]
   spec.email         = ["andrew@chartkick.com"]
   spec.summary       = "A performance dashboard for Postgres"
-  spec.description   = "A performance dashboard for Postgres"
   spec.homepage      = "https://github.com/ankane/pghero"
   spec.license       = "MIT"
 
@@ -18,17 +17,19 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features|guides)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.2.0"
+
   spec.add_dependency "activerecord"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
   spec.add_development_dependency "activerecord-import"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
 
   if RUBY_PLATFORM == "java"
     spec.add_development_dependency "activerecord-jdbcpostgresql-adapter"
   else
-    spec.add_development_dependency "pg"
+    spec.add_development_dependency "pg", "< 1.0.0"
     spec.add_development_dependency "pg_query"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-01 00:00:00.000000000 Z
+date: 2018-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,21 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activerecord-import
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord-import
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -84,16 +84,16 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pg_query
   requirement: !ruby/object:Gem::Requirement
@@ -108,16 +108,19 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A performance dashboard for Postgres
+description: 
 email:
 - andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -209,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -217,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A performance dashboard for Postgres