pghero 2.7.1 → 2.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 911330cefafafbbb8773eea03c1857144019d7c0c496f37e7114f0584ea0d87b
-  data.tar.gz: 741121519dec2b6cf37a919053a12ecd09237911deea31ae28f6c5535c193301
+  metadata.gz: 3b4a596a016b5c33a99013818181ef967c26dcec092ee787b6629eac091ad121
+  data.tar.gz: 63fc2a949a62828a4537e54fb087c5a5b143bc88ab2753b4d777d4f793fb34ab
 SHA512:
-  metadata.gz: f784263eb1f47916a996755115ab4a59ae9335bf8bdd692f654db2d82a75e1f3b2887364580f9abb033a2c900d41bc24cd1a2cbfdfe4ab9bb1189146605bda57
-  data.tar.gz: 215258014b6dd25f1d58df31a725611a34f236be66811238551930e927871ebe5f271a7c74e67ae477b0a8a43d4d379b9947185e8b6c7c08f502234ecbca5132
+  metadata.gz: beda0eb3c89c9a3928b9d998e7e9ae8858adda77873c9dc0d03836498a765c219815c6441b814d3b23da78f02f759d71737eb51236135cfb72c6372358043c37
+  data.tar.gz: 020de38d5b406ede495f44ad16ce6a5bde8ebb59c49027af4dc49afb88cf768bc20f3c064fe72070f2739eb2979d2b95d0f7cdbdd106851252e6c81f646d3e82

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## 2.8.1 (2021-03-25)
+
+- Added support for pg_query 2
+
+## 2.8.0 (2021-03-14)
+
+- No longer show walsender in long running queries
+- Show relative time on maintenance page
+- Added support for `PGHERO_TZ` for Docker and Linux
+
+## 2.7.4 (2021-02-01)
+
+- Fixed error on redirect with Ruby 3
+- Fixed error with unparsable sequences
+
+## 2.7.3 (2020-11-23)
+
+- Improved index suggestions when hash, GiST, GIN, or BRIN index present
+
+## 2.7.2 (2020-09-10)
+
+- Fixed error with historical query stats
+
 ## 2.7.1 (2020-09-07)
 
 - Added `/health` endpoint to Docker image and Linux packages

data/LICENSE.txt

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

data/README.md

@@ -4,11 +4,11 @@ A performance dashboard for Postgres
 
 [See it in action](https://pghero.dokkuapp.com/)
 
-[![Screenshot](https://pghero.dokkuapp.com/assets/pghero-a09d6c90d3d5cbf90f437b792a9b0c89751054c5e10be57af4efb79feab2458b.png)](https://pghero.dokkuapp.com/)
+[![Screenshot](https://pghero.dokkuapp.com/assets/pghero-ebb9c8e11434fd0e4ead81db88fe255b29cbbc845ec315b79e6c5e25015bc921.png)](https://pghero.dokkuapp.com/)
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://travis-ci.org/ankane/pghero.svg?branch=master)](https://travis-ci.org/ankane/pghero) [![Docker Pulls](https://img.shields.io/docker/pulls/ankane/pghero)](https://hub.docker.com/repository/docker/ankane/pghero)
+[![Build Status](https://github.com/ankane/pghero/workflows/build/badge.svg?branch=master)](https://github.com/ankane/pghero/actions) [![Docker Pulls](https://img.shields.io/docker/pulls/ankane/pghero)](https://hub.docker.com/repository/docker/ankane/pghero)
 
 ## Installation
 

data/app/controllers/pg_hero/home_controller.rb

@@ -34,7 +34,8 @@ module PgHero
         @inactive_replication_slots = @database.replication_slots.select { |r| !r[:active] }
       end
 
-      @autovacuum_queries, @long_running_queries = @database.long_running_queries.partition { |q| q[:query].starts_with?("autovacuum:") }
+      @walsender_queries, long_running_queries = @database.long_running_queries.partition { |q| q[:backend_type] == "walsender" }
+      @autovacuum_queries, @long_running_queries = long_running_queries.partition { |q| q[:query].starts_with?("autovacuum:") }
 
       connection_states = @database.connection_states
       @total_connections = connection_states.values.sum
@@ -373,11 +374,7 @@ module PgHero
     protected
 
     def redirect_backward(options = {})
-      if Rails.version >= "5.1"
-        redirect_back options.merge(fallback_location: root_path)
-      else
-        redirect_to :back, options
-      end
+      redirect_back fallback_location: root_path, **options
     end
 
     def set_database

data/app/helpers/pg_hero/home_helper.rb

@@ -26,5 +26,15 @@ module PgHero
       ret << ", column: #{columns.inspect}" if columns
       ret
     end
+
+    def pghero_formatted_vacuum_times(time)
+      content_tag(:span, title: pghero_formatted_date_time(time)) do
+        "#{time_ago_in_words(time, include_seconds: true).sub(/(over|about|almost) /, "").sub("less than", "<")} ago"
+      end
+    end
+
+    def pghero_formatted_date_time(time)
+      l time.in_time_zone(@time_zone), format: :long
+    end
   end
 end

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

@@ -26,6 +26,9 @@
     <% if @autovacuum_queries.any? %>
       <span class="tiny"><%= @autovacuum_queries.size %> autovacuum</span>
     <% end %>
+    <% if @walsender_queries.any? %>
+      <span class="tiny"><%= @walsender_queries.size %> walsender</span>
+    <% end %>
   </div>
   <% if @extended %>
     <div class="alert alert-<%= @good_cache_rate ? "success" : "warning" %>">

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

@@ -24,7 +24,7 @@
           <td>
             <% time = [table[:last_autovacuum], table[:last_vacuum]].compact.max %>
             <% if time %>
-              <%= l time.in_time_zone(@time_zone), format: :short %>
+              <%= pghero_formatted_vacuum_times(time) %>
             <% else %>
               <span class="text-muted">Unknown</span>
             <% end %>
@@ -32,7 +32,7 @@
           <td>
             <% time = [table[:last_autoanalyze], table[:last_analyze]].compact.max %>
             <% if time %>
-              <%= l time.in_time_zone(@time_zone), format: :short %>
+              <%= pghero_formatted_vacuum_times(time) %>
             <% else %>
               <span class="text-muted">Unknown</span>
             <% end %>

data/lib/pghero.rb

@@ -113,13 +113,13 @@ module PgHero
 
           if !ENV["PGHERO_DATABASE_URL"] && spec_supported?
             ActiveRecord::Base.configurations.configs_for(env_name: env, include_replicas: true).each do |db|
-              databases[db.spec_name] = {"spec" => db.spec_name}
+              databases[db.send(spec_name_key)] = {"spec" => db.send(spec_name_key)}
             end
           end
 
           if databases.empty?
             databases["primary"] = {
-              "url" => ENV["PGHERO_DATABASE_URL"] || ActiveRecord::Base.connection_config
+              "url" => ENV["PGHERO_DATABASE_URL"] || connection_config(ActiveRecord::Base)
             }
           end
 
@@ -211,6 +211,18 @@ module PgHero
       ActiveRecord::VERSION::MAJOR >= 6
     end
 
+    # private
+    def connection_config(model)
+      ActiveRecord::VERSION::STRING.to_f >= 6.1 ? model.connection_db_config.configuration_hash : model.connection_config
+    end
+
+    # private
+    # Rails 6.1 deprecate `spec_name` and use `name` for configurations
+    # https://github.com/rails/rails/pull/38536
+    def spec_name_key
+      ActiveRecord::VERSION::STRING.to_f >= 6.1 ? :name : :spec_name
+    end
+
     private
 
     def each_database

data/lib/pghero/database.rb

@@ -149,11 +149,14 @@ module PgHero
       # resolve spec
       if !url && config["spec"]
         raise Error, "Spec requires Rails 6+" unless PgHero.spec_supported?
-        resolved = ActiveRecord::Base.configurations.configs_for(env_name: PgHero.env, spec_name: config["spec"], include_replicas: true)
+        config_options = {env_name: PgHero.env, PgHero.spec_name_key => config["spec"], include_replicas: true}
+        resolved = ActiveRecord::Base.configurations.configs_for(**config_options)
         raise Error, "Spec not found: #{config["spec"]}" unless resolved
-        url = resolved.config
+        url = ActiveRecord::VERSION::STRING.to_f >= 6.1 ? resolved.configuration_hash : resolved.config
       end
 
+      url = url.dup
+
       Class.new(PgHero::Connection) do
         def self.name
           "PgHero::Connection::Database#{object_id}"

data/lib/pghero/methods/basic.rb

@@ -42,7 +42,7 @@ module PgHero
         retries = 0
         begin
           result = conn.select_all(add_source(squish(sql)))
-          if ActiveRecord::VERSION::MAJOR >= 6
+          if ActiveRecord::VERSION::STRING.to_f >= 6.1
             result = result.map(&:symbolize_keys)
           else
             result = result.map { |row| Hash[row.map { |col, val| [col.to_sym, result.column_types[col].send(:cast_value, val)] }] }

data/lib/pghero/methods/queries.rb

@@ -12,7 +12,8 @@ module PgHero
             query,
             COALESCE(query_start, xact_start) AS started_at,
             EXTRACT(EPOCH FROM NOW() - COALESCE(query_start, xact_start)) * 1000.0 AS duration_ms,
-            usename AS user
+            usename AS user,
+            #{server_version_num >= 100000 ? "backend_type" : "NULL AS backend_type"}
           FROM
             pg_stat_activity
           WHERE

data/lib/pghero/methods/sequences.rb

@@ -47,7 +47,8 @@ module PgHero
           end
         end
 
-        sequences.sort_by { |s| s[:sequence] }
+        # use to_s for unparsable sequences
+        sequences.sort_by { |s| s[:sequence].to_s }
       end
 
       def sequence_danger(threshold: 0.9, sequences: nil)

data/lib/pghero/methods/suggested_indexes.rb

@@ -30,7 +30,23 @@ module PgHero
               if best_index[:found]
                 index = best_index[:index]
                 best_index[:table_indexes] = indexes_by_table[index[:table]].to_a
-                covering_index = existing_columns[index[:using] || "btree"][index[:table]].find { |e| index_covers?(e, index[:columns]) }
+
+                # indexes of same type
+                indexes = existing_columns[index[:using] || "btree"][index[:table]]
+
+                if best_index[:structure][:sort].empty?
+                  # gist indexes without an opclass
+                  # (opclass is part of column name, so columns won't match if opclass present)
+                  indexes += existing_columns["gist"][index[:table]]
+
+                  # hash indexes work for equality
+                  indexes += existing_columns["hash"][index[:table]] if best_index[:structure][:where].all? { |v| v[:op] == "=" }
+
+                  # brin indexes work for all
+                  indexes += existing_columns["brin"][index[:table]]
+                end
+
+                covering_index = indexes.find { |e| index_covers?(e.map { |v| v.sub(/ inet_ops\z/, "") }, index[:columns]) }
                 if covering_index
                   best_index[:covering_index] = covering_index
                   best_index[:explanation] = "Covered by index on (#{covering_index.join(", ")})"
@@ -86,7 +102,7 @@ module PgHero
         # get stats about columns for relevant tables
         tables = parts.values.map { |t| t[:table] }.uniq
         # TODO get schema from query structure, then try search path
-        schema = connection_model.connection_config[:schema] || "public"
+        schema = PgHero.connection_config(connection_model)[:schema] || "public"
         if tables.any?
           row_stats = Hash[table_stats(table: tables, schema: schema).map { |i| [i[:table], i[:estimated_rows]] }]
           col_stats = column_stats(table: tables, schema: schema).group_by { |i| i[:table] }
@@ -185,36 +201,69 @@ module PgHero
         rescue PgQuery::ParseError
           return {error: "Parse error"}
         end
-        return {error: "Unknown structure"} unless tree.size == 1
-
-        tree = tree.first
-
-        # pg_query 1.0.0
-        tree = tree["RawStmt"]["stmt"] if tree["RawStmt"]
-
-        table = parse_table(tree) rescue nil
-        unless table
-          error =
-            case tree.keys.first
-            when "InsertStmt"
-              "INSERT statement"
-            when "VariableSetStmt"
-              "SET statement"
-            when "SelectStmt"
-              if (tree["SelectStmt"]["fromClause"].first["JoinExpr"] rescue false)
-                "JOIN not supported yet"
+
+        if PgQuery::VERSION.to_i >= 2
+          return {error: "Unknown structure"} unless tree.stmts.size == 1
+
+          tree = tree.stmts.first.stmt
+
+          table = parse_table_v2(tree) rescue nil
+          unless table
+            error =
+              case tree.node
+              when :insert_stmt
+                "INSERT statement"
+              when :variable_set_stmt
+                "SET statement"
+              when :select_stmt
+                if (tree.select_stmt.from_clause.first.join_expr rescue false)
+                  "JOIN not supported yet"
+                end
               end
-            end
-          return {error: error || "Unknown structure"}
-        end
+            return {error: error || "Unknown structure"}
+          end
 
-        select = tree.values.first
-        where = (select["whereClause"] ? parse_where(select["whereClause"]) : []) rescue nil
-        return {error: "Unknown structure"} unless where
+          select = tree[tree.node.to_s]
+          where = (select.where_clause ? parse_where_v2(select.where_clause) : []) rescue nil
+          return {error: "Unknown structure"} unless where
 
-        sort = (select["sortClause"] ? parse_sort(select["sortClause"]) : []) rescue []
+          sort = (select.sort_clause ? parse_sort_v2(select.sort_clause) : []) rescue []
 
-        {table: table, where: where, sort: sort}
+          {table: table, where: where, sort: sort}
+        else
+          # TODO remove support for pg_query < 2 in PgHero 3.0
+
+          return {error: "Unknown structure"} unless tree.size == 1
+
+          tree = tree.first
+
+          # pg_query 1.0.0
+          tree = tree["RawStmt"]["stmt"] if tree["RawStmt"]
+
+          table = parse_table(tree) rescue nil
+          unless table
+            error =
+              case tree.keys.first
+              when "InsertStmt"
+                "INSERT statement"
+              when "VariableSetStmt"
+                "SET statement"
+              when "SelectStmt"
+                if (tree["SelectStmt"]["fromClause"].first["JoinExpr"] rescue false)
+                  "JOIN not supported yet"
+                end
+              end
+            return {error: error || "Unknown structure"}
+          end
+
+          select = tree.values.first
+          where = (select["whereClause"] ? parse_where(select["whereClause"]) : []) rescue nil
+          return {error: "Unknown structure"} unless where
+
+          sort = (select["sortClause"] ? parse_sort(select["sortClause"]) : []) rescue []
+
+          {table: table, where: where, sort: sort}
+        end
       end
 
       # TODO better row estimation
@@ -251,6 +300,17 @@ module PgHero
         end
       end
 
+      def parse_table_v2(tree)
+        case tree.node
+        when :select_stmt
+          tree.select_stmt.from_clause.first.range_var.relname
+        when :delete_stmt
+          tree.delete_stmt.relation.relname
+        when :update_stmt
+          tree.update_stmt.relation.relname
+        end
+      end
+
       def parse_table(tree)
         case tree.keys.first
         when "SelectStmt"
@@ -262,6 +322,26 @@ module PgHero
         end
       end
 
+      # TODO capture values
+      def parse_where_v2(tree)
+        aexpr = tree.a_expr
+
+        if tree.bool_expr
+          if tree.bool_expr.boolop == :AND_EXPR
+            tree.bool_expr.args.flat_map { |v| parse_where_v2(v) }
+          else
+            raise "Not Implemented"
+          end
+        elsif aexpr && ["=", "<>", ">", ">=", "<", "<=", "~~", "~~*", "BETWEEN"].include?(aexpr.name.first.string.str)
+          [{column: aexpr.lexpr.column_ref.fields.last.string.str, op: aexpr.name.first.string.str}]
+        elsif tree.null_test
+          op = tree.null_test.nulltesttype == :IS_NOT_NULL ? "not_null" : "null"
+          [{column: tree.null_test.arg.column_ref.fields.last.string.str, op: op}]
+        else
+          raise "Not Implemented"
+        end
+      end
+
       # TODO capture values
       def parse_where(tree)
         aexpr = tree["A_Expr"]
@@ -282,6 +362,15 @@ module PgHero
         end
       end
 
+      def parse_sort_v2(sort_clause)
+        sort_clause.map do |v|
+          {
+            column: v.sort_by.node.column_ref.fields.last.string.str,
+            direction: v.sort_by.sortby_dir == :SORTBY_DESC ? "desc" : "asc"
+          }
+        end
+      end
+
       def parse_sort(sort_clause)
         sort_clause.map do |v|
           {

data/lib/pghero/methods/system.rb

@@ -144,7 +144,7 @@ module PgHero
 
         # validate input since we need to interpolate below
         raise Error, "Invalid metric name" unless metric_name =~ /\A[a-z\/_]+\z/i
-        raise Error, "Invalid database id" unless gcp_database_id =~ /\A[a-z\-:]+\z/i
+        raise Error, "Invalid database id" unless gcp_database_id =~ /\A[a-z0-9\-:]+\z/i
 
         # we handle three situations:
         # 1. google-cloud-monitoring-v3
@@ -276,7 +276,6 @@ module PgHero
 
       def add_missing_data(data, start_time, end_time, period)
         time = start_time
-        end_time = end_time
         while time < end_time
           data[time] ||= nil
           time += period

data/lib/pghero/methods/users.rb

@@ -5,7 +5,7 @@ module PgHero
       # TODO quote in 3.0, but still not officially supported
       def create_user(user, password: nil, schema: "public", database: nil, readonly: false, tables: nil)
         password ||= random_password
-        database ||= connection_model.connection_config[:database]
+        database ||= PgHero.connection_config(connection_model)[:database]
 
         commands =
           [
@@ -44,7 +44,7 @@ module PgHero
       # documented as unsafe to pass user input
       # TODO quote in 3.0, but still not officially supported
       def drop_user(user, schema: "public", database: nil)
-        database ||= connection_model.connection_config[:database]
+        database ||= PgHero.connection_config(connection_model)[:database]
 
         # thanks shiftb
         commands =

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "2.7.1"
+  VERSION = "2.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,91 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-- !ruby/object:Gem::Dependency
-  name: activerecord-import
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pg_query
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
+description:
 email: andrew@chartkick.com
 executables: []
 extensions: []
@@ -191,7 +107,7 @@ homepage: https://github.com/ankane/pghero
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -206,8 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A performance dashboard for Postgres
 test_files: []