pghero 3.0.1 → 3.2.0

data/app/assets/stylesheets/pghero/application.css

@@ -187,7 +187,7 @@ hr {
 }
 
 #slider-container {
-  padding: 6px 140px 20px 140px;
+  padding: 6px 8px 14px 8px;
 }
 
 .queries-table th a, .space-table th a {
@@ -195,7 +195,7 @@ hr {
 }
 
 #slider {
-  margin-bottom: 20px;
+  margin: 0px 14px 18px 14px;
 }
 
 #range-start {

data/app/controllers/pg_hero/home_controller.rb

@@ -263,30 +263,57 @@ module PgHero
     end
 
     def explain
+      unless @explain_enabled
+        render_text "Explain not enabled", status: :bad_request
+        return
+      end
+
       @title = "Explain"
       @query = params[:query]
+      @explain_analyze_enabled = PgHero.explain_mode == "analyze"
+
       # TODO use get + token instead of post so users can share links
       # need to prevent CSRF and DoS
-      if request.post? && @query
+      if request.post? && @query.present?
         begin
-          prefix =
+          explain_options =
             case params[:commit]
             when "Analyze"
-              "ANALYZE "
+              {analyze: true}
             when "Visualize"
-              "(ANALYZE, COSTS, VERBOSE, BUFFERS, FORMAT JSON) "
+              if @explain_analyze_enabled
+                {analyze: true, costs: true, verbose: true, buffers: true, format: "json"}
+              else
+                {costs: true, verbose: true, format: "json"}
+              end
             else
-              ""
+              {}
             end
-          @explanation = @database.explain("#{prefix}#{@query}")
+
+          if explain_options[:analyze] && !@explain_analyze_enabled
+            render_text "Explain analyze not enabled", status: :bad_request
+            return
+          end
+
+          @explanation = @database.explain_v2(@query, **explain_options)
           @suggested_index = @database.suggested_indexes(queries: [@query]).first if @database.suggested_indexes_enabled?
           @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
+          message = e.message
+          @error =
+            if message == "Unsafe statement"
+              "Unsafe statement"
+            elsif message.start_with?("PG::ProtocolViolation: ERROR:  bind message supplies 0 parameters")
+              "Can't explain queries with bind parameters"
+            elsif message.start_with?("PG::SyntaxError")
+              "Syntax error with query"
+            elsif message.start_with?("PG::QueryCanceled")
+              "Query timed out"
+            else
+              # default to a generic message
+              # since data can be extracted through the Postgres error message
+              "Error explaining query"
+            end
         end
       end
     end
@@ -368,6 +395,7 @@ module PgHero
       redirect_backward alert: "The database user does not have permission to enable query stats"
     end
 
+    # TODO disable if historical query stats enabled?
     def reset_query_stats
       success =
         if @database.server_version_num >= 120000
@@ -409,6 +437,7 @@ module PgHero
       @query_stats_enabled = @database.query_stats_enabled?
       @system_stats_enabled = @database.system_stats_enabled?
       @replica = @database.replica?
+      @explain_enabled = PgHero.explain_enabled?
     end
 
     def set_suggested_indexes(min_average_time = 0, min_calls = 0)

data/app/views/layouts/pg_hero/application.html.erb

@@ -48,7 +48,9 @@
             <% unless @database.replica? %>
               <li class="<%= controller.action_name == "maintenance" ? "active" : "" %>"><%= link_to "Maintenance", maintenance_path %></li>
             <% end %>
-            <li class="<%= controller.action_name == "explain" ? "active" : "" %>"><%= link_to "Explain", explain_path %></li>
+            <% if @explain_enabled %>
+              <li class="<%= controller.action_name == "explain" ? "active" : "" %>"><%= link_to "Explain", explain_path %></li>
+            <% end %>
             <li class="<%= controller.action_name == "tune" ? "active" : "" %>"><%= link_to "Tune", tune_path %></li>
           </ul>
 

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

@@ -5,7 +5,9 @@
     <div class="field"><%= text_area_tag :query, @query, placeholder: "Enter a SQL query" %></div>
     <p>
       <%= submit_tag "Explain", class: "btn btn-info", style: "margin-right: 10px;" %>
-      <%= submit_tag "Analyze", class: "btn btn-danger", style: "margin-right: 10px;" %>
+      <% if @explain_analyze_enabled %>
+        <%= submit_tag "Analyze", class: "btn btn-danger", style: "margin-right: 10px;" %>
+      <% end %>
       <%= submit_tag "Visualize", class: "btn btn-danger" %>
     </p>
   <% end %>

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

@@ -1,9 +1,11 @@
 <div class="content">
-  <% if @query_stats_enabled %>
+  <% if @query_stats_enabled && !@historical_query_stats_enabled %>
     <%= button_to "Reset", reset_query_stats_path, class: "btn btn-danger", style: "float: right;" %>
   <% end %>
 
-  <h1 style="float: left;">Queries</h1>
+  <% if !@historical_query_stats_enabled %>
+    <h1 style="float: left;">Queries</h1>
+  <% end %>
 
   <% if @historical_query_stats_enabled %>
     <%= render partial: "query_stats_slider" %>

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

@@ -4,7 +4,7 @@
     highlightQueries()
   </script>
 
-  <% if @explainable_query %>
+  <% if @explain_enabled && @explainable_query %>
     <p>
       <%= button_to "Explain", explain_path, params: {query: @explainable_query}, form: {target: "_blank"}, class: "btn btn-info" %>
     </p>

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

@@ -24,6 +24,9 @@ databases:
 # Minimum connections for high connections warning
 # total_connections_threshold: 500
 
+# Explain functionality
+# explain: true / false / analyze
+
 # Statement timeout for explain
 # explain_timeout_sec: 10
 

data/lib/pghero/methods/explain.rb

@@ -1,6 +1,8 @@
 module PgHero
   module Methods
     module Explain
+      # TODO remove in 4.0
+      # note: this method is not affected by the explain option
       def explain(sql)
         sql = squish(sql)
         explanation = nil
@@ -16,6 +18,23 @@ module PgHero
         explanation
       end
 
+      # TODO rename to explain in 4.0
+      # note: this method is not affected by the explain option
+      def explain_v2(sql, analyze: nil, verbose: nil, costs: nil, settings: nil, buffers: nil, wal: nil, timing: nil, summary: nil, format: "text")
+        options = []
+        add_explain_option(options, "ANALYZE", analyze)
+        add_explain_option(options, "VERBOSE", verbose)
+        add_explain_option(options, "SETTINGS", settings)
+        add_explain_option(options, "COSTS", costs)
+        add_explain_option(options, "BUFFERS", buffers)
+        add_explain_option(options, "WAL", wal)
+        add_explain_option(options, "TIMING", timing)
+        add_explain_option(options, "SUMMARY", summary)
+        options << "FORMAT #{explain_format(format)}"
+
+        explain("(#{options.join(", ")}) #{sql}")
+      end
+
       private
 
       def explain_safe?
@@ -24,6 +43,21 @@ module PgHero
       rescue ActiveRecord::StatementInvalid
         true
       end
+
+      def add_explain_option(options, name, value)
+        unless value.nil?
+          options << "#{name}#{value ? "" : " FALSE"}"
+        end
+      end
+
+      # important! validate format to prevent injection
+      def explain_format(format)
+        if ["text", "xml", "json", "yaml"].include?(format)
+          format.upcase
+        else
+          raise ArgumentError, "Unknown format"
+        end
+      end
     end
   end
 end

data/lib/pghero/methods/query_stats.rb

@@ -162,8 +162,9 @@ module PgHero
         end
       end
 
-      def clean_query_stats
-        PgHero::QueryStats.where(database: id).where("captured_at < ?", 14.days.ago).delete_all
+      def clean_query_stats(before: nil)
+        before ||= 14.days.ago
+        PgHero::QueryStats.where(database: id).where("captured_at < ?", before).delete_all
       end
 
       def slow_queries(query_stats: nil, **options)
@@ -226,6 +227,7 @@ module PgHero
             )
             SELECT
               query,
+              query AS explainable_query,
               query_hash,
               query_stats.user,
               total_minutes,
@@ -243,7 +245,7 @@ module PgHero
           # we may be able to skip query_columns
           # in more recent versions of Postgres
           # as pg_stat_statements should be already normalized
-          select_all(query, query_columns: [:query])
+          select_all(query, query_columns: [:query, :explainable_query])
         else
           raise NotEnabled, "Query stats not enabled"
         end

data/lib/pghero/methods/space.rb

@@ -129,8 +129,9 @@ module PgHero
         insert_stats("pghero_space_stats", columns, values) if values.any?
       end
 
-      def clean_space_stats
-        PgHero::SpaceStats.where(database: id).where("captured_at < ?", 90.days.ago).delete_all
+      def clean_space_stats(before: nil)
+        before ||= 90.days.ago
+        PgHero::SpaceStats.where(database: id).where("captured_at < ?", before).delete_all
       end
 
       def space_stats_enabled?

data/lib/pghero/methods/suggested_indexes.rb

@@ -286,20 +286,24 @@ module PgHero
           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 aexpr && ["=", "<>", ">", ">=", "<", "<=", "~~", "~~*", "BETWEEN"].include?(aexpr.name.first.string.send(str_method))
+          [{column: aexpr.lexpr.column_ref.fields.last.string.send(str_method), op: aexpr.name.first.string.send(str_method)}]
         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}]
+          [{column: tree.null_test.arg.column_ref.fields.last.string.send(str_method), op: op}]
         else
           raise "Not Implemented"
         end
       end
 
+      def str_method
+        @str_method ||= Gem::Version.new(PgQuery::VERSION) >= Gem::Version.new("4") ? :sval : :str
+      end
+
       def parse_sort(sort_clause)
         sort_clause.map do |v|
           {
-            column: v.sort_by.node.column_ref.fields.last.string.str,
+            column: v.sort_by.node.column_ref.fields.last.string.send(str_method),
             direction: v.sort_by.sortby_dir == :SORTBY_DESC ? "desc" : "asc"
           }
         end

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "3.0.1"
+  VERSION = "3.2.0"
 end

data/lib/pghero.rb

@@ -3,27 +3,27 @@ require "active_support"
 require "forwardable"
 
 # methods
-require "pghero/methods/basic"
-require "pghero/methods/connections"
-require "pghero/methods/constraints"
-require "pghero/methods/explain"
-require "pghero/methods/indexes"
-require "pghero/methods/kill"
-require "pghero/methods/maintenance"
-require "pghero/methods/queries"
-require "pghero/methods/query_stats"
-require "pghero/methods/replication"
-require "pghero/methods/sequences"
-require "pghero/methods/settings"
-require "pghero/methods/space"
-require "pghero/methods/suggested_indexes"
-require "pghero/methods/system"
-require "pghero/methods/tables"
-require "pghero/methods/users"
-
-require "pghero/database"
-require "pghero/engine" if defined?(Rails)
-require "pghero/version"
+require_relative "pghero/methods/basic"
+require_relative "pghero/methods/connections"
+require_relative "pghero/methods/constraints"
+require_relative "pghero/methods/explain"
+require_relative "pghero/methods/indexes"
+require_relative "pghero/methods/kill"
+require_relative "pghero/methods/maintenance"
+require_relative "pghero/methods/queries"
+require_relative "pghero/methods/query_stats"
+require_relative "pghero/methods/replication"
+require_relative "pghero/methods/sequences"
+require_relative "pghero/methods/settings"
+require_relative "pghero/methods/space"
+require_relative "pghero/methods/suggested_indexes"
+require_relative "pghero/methods/system"
+require_relative "pghero/methods/tables"
+require_relative "pghero/methods/users"
+
+require_relative "pghero/database"
+require_relative "pghero/engine" if defined?(Rails)
+require_relative "pghero/version"
 
 module PgHero
   autoload :Connection, "pghero/connection"
@@ -91,6 +91,16 @@ module PgHero
       @stats_database_url ||= (file_config || {})["stats_database_url"] || ENV["PGHERO_STATS_DATABASE_URL"]
     end
 
+    # private
+    def explain_enabled?
+      explain_mode.nil? || explain_mode == true || explain_mode == "analyze"
+    end
+
+    # private
+    def explain_mode
+      @config["explain"]
+    end
+
     def visualize_url
       @visualize_url ||= config["visualize_url"] || ENV["PGHERO_VISUALIZE_URL"] || "https://tatiyants.com/pev/#/plans/new"
     end
@@ -109,7 +119,7 @@ module PgHero
 
         config_file_exists = File.exist?(path)
 
-        config = YAML.load(ERB.new(File.read(path)).result) if config_file_exists
+        config = YAML.safe_load(ERB.new(File.read(path)).result) if config_file_exists
         config ||= {}
 
         @file_config =
@@ -212,15 +222,15 @@ module PgHero
     # delete previous stats
     # go database by database to use an index
     # stats for old databases are not cleaned up since we can't use an index
-    def clean_query_stats
+    def clean_query_stats(before: nil)
       each_database do |database|
-        database.clean_query_stats
+        database.clean_query_stats(before: before)
       end
     end
 
-    def clean_space_stats
+    def clean_space_stats(before: nil)
       each_database do |database|
-        database.clean_space_stats
+        database.clean_space_stats(before: before)
       end
     end
 

data/lib/tasks/pghero.rake

@@ -22,6 +22,16 @@ namespace :pghero do
   desc "Remove old query stats"
   task clean_query_stats: :environment do
     puts "Deleting old query stats..."
-    PgHero.clean_query_stats
+    options = {}
+    options[:before] = Float(ENV["KEEP_DAYS"]).days.ago if ENV["KEEP_DAYS"].present?
+    PgHero.clean_query_stats(**options)
+  end
+
+  desc "Remove old space stats"
+  task clean_space_stats: :environment do
+    puts "Deleting old space stats..."
+    options = {}
+    options[:before] = Float(ENV["KEEP_DAYS"]).days.ago if ENV["KEEP_DAYS"].present?
+    PgHero.clean_space_stats(**options)
   end
 end

data/licenses/LICENSE-chart.js.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2021 Chart.js Contributors
+Copyright (c) 2014-2022 Chart.js Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/licenses/LICENSE-date-fns.txt

@@ -1,20 +1,21 @@
-Copyright (C) 2020 Sasha Koss and Lesha Koss
-
-# License
-
-date-fns is licensed under the [MIT license](http://kossnocorp.mit-license.org).
-Read more about MIT at [TLDRLegal](https://tldrlegal.com/license/mit-license).
-
----
-
-Text from http://kossnocorp.mit-license.org
-
-The MIT License (MIT)
-
-Copyright © 2021 Sasha Koss
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Sasha Koss and Lesha Koss https://kossnocorp.mit-license.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/licenses/LICENSE-kurkle-color.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2018-2021 Jukka Kurkela
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2023-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -103,6 +103,7 @@ files:
 - licenses/LICENSE-date-fns.txt
 - licenses/LICENSE-highlight.js.txt
 - licenses/LICENSE-jquery.txt
+- licenses/LICENSE-kurkle-color.txt
 - licenses/LICENSE-nouislider.txt
 homepage: https://github.com/ankane/pghero
 licenses:
@@ -123,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: A performance dashboard for Postgres