pghero 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1a3cb7c5c2090aa6b4dcc0fb11aca000945a5a4
-  data.tar.gz: 2304979bb7676c7a346bfbd490e697f16379f8bb
+  metadata.gz: e94afa4fd9aa4ce59b5a97d78b9d15ff48ebd669
+  data.tar.gz: 1974a3612f8eae97a888af4a25e965571a2e449e
 SHA512:
-  metadata.gz: cb6cc9c80f2ea049225b3f8d4da5eefb7d3ac754a33ba6da644fff7adbb385626f4f5967fb9e91bb3328575d42e52a064c9d7d5cef43273b8d7ac894155c4197
-  data.tar.gz: 964c90c704e2049d3d2a47cad1479146409a0ad49ffa7a1436dc913ac8cbb992dd101cf3021ba288dbfc45736bd2c3b4f687627fbd9b5373fe24bb54cb631a5e
+  metadata.gz: 6fe161c323e6916ea3fa9c19103cfb17b3403e313b6889ed7be15c2cd7a6d8ff86ab22e667a82a05f0cd2ee471f359097f9b6626e5ce94aa586cff5cf32e7042
+  data.tar.gz: 5f6db96bd7b69f7a889af3f30b24c8f2964b8b22b937426a067c78a49af5b89461a7cc2ee2be55f01f6406a756e65d5819eca478de9d13bee2b97682ac24fafa

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.0.4
+
+- Fixed `AssetNotPrecompiled` error
+- Do not silently ignore sequence danger when user does not have permissions
+
 ## 2.0.3
 
 - Added SQL to recreate invalid indexes

data/app/controllers/pg_hero/home_controller.rb

@@ -33,7 +33,16 @@ module PgHero
       @good_total_connections = @total_connections < @database.total_connections_threshold
 
       @transaction_id_danger = @database.transaction_id_danger(threshold: 1500000000)
-      @sequence_danger = @database.sequence_danger(threshold: (params[:sequence_threshold] || 0.9).to_f)
+
+      begin
+        @sequence_danger = @database.sequence_danger(threshold: (params[:sequence_threshold] || 0.9).to_f)
+      rescue ActiveRecord::StatementInvalid => e
+        if (m = /permission denied for [^:]+/.match(e.message))
+          @sequence_danger_error = m[0]
+        else
+          raise
+        end
+      end
 
       @indexes = @database.indexes
       @invalid_indexes = @indexes.select { |i| !i[:valid] }
@@ -81,7 +90,7 @@ module PgHero
       @unused_index_names = Set.new(@unused_indexes.map { |r| r[:index] })
       @show_migrations = PgHero.show_migrations
       @system_stats_enabled = @database.system_stats_enabled?
-      @index_bloat = @database.index_bloat
+      @index_bloat = [] # @database.index_bloat
     end
 
     def relation_space
@@ -226,7 +235,7 @@ module PgHero
               ""
             end
           @explanation = @database.explain("#{prefix}#{@query}")
-          @suggested_index = @database.suggested_indexes(queries: [@query]).first
+          @suggested_index = @database.suggested_indexes(queries: [@query]).first if @database.suggested_indexes_enabled?
           @visualize = params[:commit] == "Visualize"
         rescue ActiveRecord::StatementInvalid => e
           @error = e.message

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

@@ -47,8 +47,10 @@
       Vacuuming healthy
     <% end %>
   </div>
-  <div class="alert alert-<%= @sequence_danger.empty? ? "success" : "warning" %>">
-    <% if @sequence_danger.any? %>
+  <div class="alert alert-<%= @sequence_danger && @sequence_danger.empty? ? "success" : "warning" %>">
+    <% if !@sequence_danger %>
+      Error checking for columns near integer overflow: <%= @sequence_danger_error %>
+    <% elsif @sequence_danger.any? %>
       <%= pluralize(@sequence_danger.size, "columns") %> approaching overflow
     <% else %>
       No columns near integer overflow
@@ -197,7 +199,7 @@
   </div>
 <% end %>
 
-<% if @sequence_danger.any? %>
+<% if @sequence_danger && @sequence_danger.any? %>
   <div class="content">
     <h2>Columns Near Overflow</h2>
     <p>Consider changing columns to bigint to support a larger range of values.</p>

data/guides/Docker.md

@@ -72,6 +72,18 @@ databases:
     url: postgres://...
 ```
 
+## Permissions
+
+We recommend [setting up a dedicated user](Permissions.md) for PgHero.
+
+## Security
+
+And basic authentication with:
+
+```sh
+docker run -e PGHERO_USERNAME=link -e PGHERO_PASSWORD=hyrule ...
+```
+
 ## Credits
 
 Thanks to [Brian Morton](https://github.com/bmorton) for the [original Docker image](https://github.com/bmorton/pghero_solo).

data/guides/Linux.md

@@ -187,6 +187,7 @@ Schedule the task below to run once a day.
 
 ```sh
 sudo pghero run rake pghero:capture_space_stats
+```
 
 ## System Stats
 
@@ -217,6 +218,10 @@ cat pghero.yml | sudo pghero run sh -c "cat > config/pghero.yml"
 sudo service pghero restart
 ```
 
+## Permissions
+
+We recommend [setting up a dedicated user](Permissions.md) for PgHero.
+
 ## Customize
 
 Minimum time for long running queries

data/guides/Permissions.md

@@ -0,0 +1,57 @@
+# Permissions
+
+For security, Postgres doesn’t allow you to see queries from other users without being a superuser. However, you likely don’t want to run PgHero as a superuser. You can use `SECURITY DEFINER` to give non-superusers access to superuser functions.
+
+With a superuser, run:
+
+```sql
+CREATE SCHEMA pghero;
+
+-- view queries
+CREATE OR REPLACE FUNCTION pghero.pg_stat_activity() RETURNS SETOF pg_stat_activity AS
+$$
+  SELECT * FROM pg_catalog.pg_stat_activity;
+$$ LANGUAGE sql VOLATILE SECURITY DEFINER;
+
+CREATE VIEW pghero.pg_stat_activity AS SELECT * FROM pghero.pg_stat_activity();
+
+-- kill queries
+CREATE OR REPLACE FUNCTION pghero.pg_terminate_backend(pid int) RETURNS boolean AS
+$$
+  SELECT * FROM pg_catalog.pg_terminate_backend(pid);
+$$ LANGUAGE sql VOLATILE SECURITY DEFINER;
+
+-- query stats
+CREATE OR REPLACE FUNCTION pghero.pg_stat_statements() RETURNS SETOF pg_stat_statements AS
+$$
+  SELECT * FROM public.pg_stat_statements;
+$$ LANGUAGE sql VOLATILE SECURITY DEFINER;
+
+CREATE VIEW pghero.pg_stat_statements AS SELECT * FROM pghero.pg_stat_statements();
+
+-- query stats reset
+CREATE OR REPLACE FUNCTION pghero.pg_stat_statements_reset() RETURNS void AS
+$$
+  SELECT public.pg_stat_statements_reset();
+$$ LANGUAGE sql VOLATILE SECURITY DEFINER;
+
+-- suggested indexes
+CREATE OR REPLACE FUNCTION pghero.pg_stats() RETURNS
+TABLE(schemaname name, tablename name, attname name, null_frac real, avg_width integer, n_distinct real) AS
+$$
+  SELECT schemaname, tablename, attname, null_frac, avg_width, n_distinct FROM pg_catalog.pg_stats;
+$$ LANGUAGE sql VOLATILE SECURITY DEFINER;
+
+CREATE VIEW pghero.pg_stats AS SELECT * FROM pghero.pg_stats();
+
+-- create user
+CREATE ROLE pghero WITH LOGIN ENCRYPTED PASSWORD 'secret';
+GRANT CONNECT ON DATABASE <dbname> TO pghero;
+ALTER ROLE pghero SET search_path = pghero, pg_catalog, public;
+GRANT USAGE ON SCHEMA pghero TO pghero;
+GRANT SELECT ON ALL TABLES IN SCHEMA pghero TO pghero;
+```
+
+## Thanks
+
+A big thanks to [pganalyze](https://github.com/pganalyze/collector#setting-up-a-restricted-monitoring-user) for coming up with this approach for their collector.

data/guides/Rails.md

@@ -125,6 +125,10 @@ databases:
     url: <%= ENV["REPLICA_DATABASE_URL"] %>
 ```
 
+## Permissions
+
+We recommend [setting up a dedicated user](Permissions.md) for PgHero.
+
 ## Customize
 
 Minimum time for long running queries

data/lib/pghero/database.rb

@@ -68,7 +68,13 @@ module PgHero
           def self.name
             "PgHero::Connection::Database#{object_id}"
           end
-          establish_connection(url) if url
+          case url
+          when String
+            url = "#{url}#{url.include?("?") ? "&" : "?"}connect_timeout=2" unless url.include?("connect_timeout=")
+          when Hash
+            url[:connect_timeout] ||= 2
+          end
+          establish_connection url if url
         end
       end
     end

data/lib/pghero/engine.rb

@@ -8,10 +8,12 @@ module PgHero
         if defined?(Sprockets) && Sprockets::VERSION >= "4"
           app.config.assets.precompile << "pghero/application.js"
           app.config.assets.precompile << "pghero/application.css"
+          app.config.assets.precompile << "pghero/favicon.png"
         else
           # use a proc instead of a string
           app.config.assets.precompile << proc { |path| path == "pghero/application.js" }
           app.config.assets.precompile << proc { |path| path == "pghero/application.css" }
+          app.config.assets.precompile << proc { |path| path == "pghero/favicon.png" }
         end
       end
 

data/lib/pghero/methods/sequences.rb

@@ -4,21 +4,29 @@ module PgHero
       def sequences
         sequences = select_all <<-SQL
           SELECT
-            sequence_schema AS schema,
-            table_name AS table,
-            column_name AS column,
-            c.data_type AS column_type,
-            CASE WHEN c.data_type = 'integer' THEN 2147483647::bigint ELSE maximum_value::bigint END AS max_value,
-            sequence_name AS sequence
+            n.nspname AS schema,
+            c.relname AS table,
+            attname AS column,
+            format_type(a.atttypid, a.atttypmod) AS column_type,
+            CASE WHEN format_type(a.atttypid, a.atttypmod) = 'integer' THEN 2147483647::bigint ELSE (pg_sequence_parameters(s.oid)).maximum_value::bigint END AS max_value,
+            s.relname AS sequence
           FROM
-            information_schema.columns c
+            pg_catalog.pg_attribute a
           INNER JOIN
-            information_schema.sequences iss ON iss.sequence_name = regexp_replace(c.column_default, '^nextval\\(''(.*)''\\:\\:regclass\\)$', '\\1')
+            pg_catalog.pg_class c ON c.oid = a.attrelid
+          INNER JOIN
+            pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+          LEFT JOIN
+            pg_catalog.pg_attrdef d ON (a.attrelid, a.attnum) = (d.adrelid,  d.adnum)
+          INNER JOIN
+            pg_catalog.pg_class s ON s.relkind = 'S'
+            AND s.relname = regexp_replace(d.adsrc, '^nextval\\(''(.*)''\\:\\:regclass\\)$', '\\1')
           WHERE
-            column_default LIKE 'nextval%'
-            AND table_catalog = current_database()
+            NOT a.attisdropped
+            AND a.attnum > 0
+            AND d.adsrc LIKE 'nextval%'
           ORDER BY
-            sequence_name ASC
+            s.relname ASC
         SQL
 
         select_all(sequences.map { |s| "SELECT last_value FROM #{s[:sequence]}" }.join(" UNION ALL ")).each_with_index do |row, i|

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "2.0.3"
+  VERSION = "2.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-23 00:00:00.000000000 Z
+date: 2017-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -156,6 +156,7 @@ files:
 - guides/Docker.md
 - guides/Heroku.md
 - guides/Linux.md
+- guides/Permissions.md
 - guides/Query-Stats.md
 - guides/Rails.md
 - guides/Suggested-Indexes.md
@@ -222,6 +223,7 @@ test_files:
 - guides/Docker.md
 - guides/Heroku.md
 - guides/Linux.md
+- guides/Permissions.md
 - guides/Query-Stats.md
 - guides/Rails.md
 - guides/Suggested-Indexes.md