pghero 2.8.3 → 3.3.3

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

@@ -1,34 +1,34 @@
 <div class="content">
   <p id="periods">
     <% @periods.each do |name, options| %>
-      <%= link_to name, system_path(options) %>
+      <%= link_to name, system_path(params: options) %>
     <% end %>
   </p>
-  <% path_options = {duration: @duration, period: @period} %>
+  <% path_options = {params: {duration: @duration, period: @period}} %>
 
   <h1>CPU</h1>
   <div id="chart-1" class="chart" style="margin-bottom: 20px;">Loading...</div>
   <script>
-    new Chartkick.LineChart("chart-1", <%= json_escape(cpu_usage_path(path_options).to_json).html_safe %>, {max: 100, colors: ["#5bc0de"], suffix: "%", library: {plugins: {tooltip: {intersect: false, mode: "index"}}}})
+    new Chartkick.LineChart("chart-1", <%= pghero_js_value(cpu_usage_path(path_options)) %>, {max: 100, colors: ["#5bc0de"], suffix: "%", library: {plugins: {tooltip: {intersect: false, mode: "index"}}}})
   </script>
 
   <h1>Load</h1>
   <div id="chart-2" class="chart" style="margin-bottom: 20px;">Loading...</div>
   <script>
-    new Chartkick.LineChart("chart-2", <%= json_escape(load_stats_path(path_options).to_json).html_safe %>, {colors: ["#5bc0de", "#d9534f"], library: {plugins: {tooltip: {intersect: false, mode: "nearest"}}}})
+    new Chartkick.LineChart("chart-2", <%= pghero_js_value(load_stats_path(path_options)) %>, {colors: ["#5bc0de", "#d9534f"], library: {plugins: {tooltip: {intersect: false, mode: "nearest"}}}})
   </script>
 
   <h1>Connections</h1>
   <div id="chart-3" class="chart" style="margin-bottom: 20px;">Loading...</div>
   <script>
-    new Chartkick.LineChart("chart-3", <%= json_escape(connection_stats_path(path_options).to_json).html_safe %>, {colors: ["#5bc0de"], library: {plugins: {tooltip: {intersect: false, mode: "index"}}}})
+    new Chartkick.LineChart("chart-3", <%= pghero_js_value(connection_stats_path(path_options)) %>, {colors: ["#5bc0de"], library: {plugins: {tooltip: {intersect: false, mode: "index"}}}})
   </script>
 
   <% if @database.replica? %>
     <h1>Replication Lag</h1>
     <div id="chart-4" class="chart" style="margin-bottom: 20px;">Loading...</div>
     <script>
-      new Chartkick.LineChart("chart-4", <%= json_escape(replication_lag_stats_path(path_options).to_json).html_safe %>, {colors: ["#5bc0de"], library: {plugins: {tooltip: {intersect: false, mode: "index"}}}})
+      new Chartkick.LineChart("chart-4", <%= pghero_js_value(replication_lag_stats_path(path_options)) %>, {colors: ["#5bc0de"], library: {plugins: {tooltip: {intersect: false, mode: "index"}}}})
     </script>
   <% end %>
 </div>

data/lib/generators/pghero/query_stats_generator.rb

@@ -1,3 +1,4 @@
+require "rails/generators"
 require "rails/generators/active_record"
 
 module Pghero

data/lib/generators/pghero/space_stats_generator.rb

@@ -1,3 +1,4 @@
+require "rails/generators"
 require "rails/generators/active_record"
 
 module Pghero

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

@@ -24,9 +24,15 @@ 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
 
+# Visualize URL for explain
+# visualize_url: https://...
+
 # Time zone (defaults to app time zone)
 # time_zone: "Pacific Time (US & Canada)"
 

data/lib/pghero/database.rb

@@ -118,12 +118,6 @@ module PgHero
       @filter_data
     end
 
-    # TODO remove in next major version
-    alias_method :access_key_id, :aws_access_key_id
-    alias_method :secret_access_key, :aws_secret_access_key
-    alias_method :region, :aws_region
-    alias_method :db_instance_identifier, :aws_db_instance_identifier
-
     private
 
     # check adapter lazily
@@ -148,7 +142,6 @@ module PgHero
 
       # resolve spec
       if !url && config["spec"]
-        raise Error, "Spec requires Rails 6+" unless PgHero.spec_supported?
         config_options = {env_name: PgHero.env, PgHero.spec_name_key => config["spec"], PgHero.include_replicas_key => true}
         resolved = ActiveRecord::Base.configurations.configs_for(**config_options)
         raise Error, "Spec not found: #{config["spec"]}" unless resolved

data/lib/pghero/engine.rb

@@ -5,7 +5,7 @@ module PgHero
     initializer "pghero", group: :all do |app|
       # check if Rails api mode
       if app.config.respond_to?(:assets)
-        if defined?(Sprockets) && Sprockets::VERSION >= "4"
+        if defined?(Sprockets) && Sprockets::VERSION.to_i >= 4
           app.config.assets.precompile << "pghero/application.js"
           app.config.assets.precompile << "pghero/application.css"
           app.config.assets.precompile << "pghero/favicon.png"

data/lib/pghero/methods/basic.rb

@@ -45,7 +45,7 @@ module PgHero
           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)] }] }
+            result = result.map { |row| row.to_h { |col, val| [col.to_sym, result.column_types[col].send(:cast_value, val)] } }
           end
           if filter_data
             query_columns.each do |column|
@@ -112,15 +112,8 @@ module PgHero
         ::PgHero::Stats.connection
       end
 
-      def insert_stats(table, columns, values)
-        values = values.map { |v| "(#{v.map { |v2| quote(v2) }.join(",")})" }.join(",")
-        columns = columns.map { |v| quote_table_name(v) }.join(",")
-        stats_connection.execute("INSERT INTO #{quote_table_name(table)} (#{columns}) VALUES #{values}")
-      end
-
-      # from ActiveSupport
       def squish(str)
-        str.to_s.gsub(/\A[[:space:]]+/, "").gsub(/[[:space:]]+\z/, "").gsub(/[[:space:]]+/, " ")
+        str.to_s.squish
       end
 
       def add_source(sql)
@@ -135,6 +128,10 @@ module PgHero
         connection.quote_table_name(value)
       end
 
+      def quote_column_name(value)
+        connection.quote_column_name(value)
+      end
+
       def unquote(part)
         if part && part.start_with?('"')
           part[1..-2]

data/lib/pghero/methods/connections.rb

@@ -3,7 +3,7 @@ module PgHero
     module Connections
       def connections
         if server_version_num >= 90500
-          select_all <<-SQL
+          select_all <<~SQL
             SELECT
               pg_stat_activity.pid,
               datname AS database,
@@ -20,7 +20,7 @@ module PgHero
               pg_stat_activity.pid
           SQL
         else
-          select_all <<-SQL
+          select_all <<~SQL
             SELECT
               pid,
               datname AS database,
@@ -41,7 +41,7 @@ module PgHero
       end
 
       def connection_states
-        states = select_all <<-SQL
+        states = select_all <<~SQL
           SELECT
             state,
             COUNT(*) AS connections
@@ -53,11 +53,11 @@ module PgHero
             2 DESC, 1
         SQL
 
-        Hash[states.map { |s| [s[:state], s[:connections]] }]
+        states.to_h { |s| [s[:state], s[:connections]] }
       end
 
       def connection_sources
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             datname AS database,
             usename AS user,

data/lib/pghero/methods/constraints.rb

@@ -4,7 +4,7 @@ module PgHero
       # referenced fields can be nil
       # as not all constraints are foreign keys
       def invalid_constraints
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             nsp.nspname AS schema,
             rel.relname AS table,

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/indexes.rb

@@ -2,7 +2,7 @@ module PgHero
   module Methods
     module Indexes
       def index_hit_rate
-        select_one <<-SQL
+        select_one <<~SQL
           SELECT
             (sum(idx_blks_hit)) / nullif(sum(idx_blks_hit + idx_blks_read), 0) AS rate
           FROM
@@ -11,7 +11,7 @@ module PgHero
       end
 
       def index_caching
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             schemaname AS schema,
             relname AS table,
@@ -29,7 +29,7 @@ module PgHero
       end
 
       def index_usage
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             schemaname AS schema,
             relname AS table,
@@ -47,7 +47,7 @@ module PgHero
       end
 
       def missing_indexes
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             schemaname AS schema,
             relname AS table,
@@ -69,7 +69,7 @@ module PgHero
       end
 
       def unused_indexes(max_scans: 50, across: [])
-        result = select_all_size <<-SQL
+        result = select_all_size <<~SQL
           SELECT
             schemaname AS schema,
             relname AS table,
@@ -104,7 +104,7 @@ module PgHero
       end
 
       def last_stats_reset_time
-        select_one <<-SQL
+        select_one <<~SQL
           SELECT
             pg_stat_get_db_stat_reset_time(oid) AS reset_time
           FROM
@@ -126,7 +126,7 @@ module PgHero
       # TODO parse array properly
       # https://stackoverflow.com/questions/2204058/list-columns-with-indexes-in-postgresql
       def indexes
-        indexes = select_all(<<-SQL
+        indexes = select_all(<<~SQL
           SELECT
             schemaname AS schema,
             t.relname AS table,
@@ -186,7 +186,7 @@ module PgHero
       # thanks @jberkus and @mbanck
       def index_bloat(min_size: nil)
         min_size ||= index_bloat_bytes
-        select_all <<-SQL
+        select_all <<~SQL
           WITH btree_index_atts AS (
             SELECT
               nspname, relname, reltuples, relpages, indrelid, relam,

data/lib/pghero/methods/kill.rb

@@ -11,7 +11,7 @@ module PgHero
       end
 
       def kill_all
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             pg_terminate_backend(pid)
           FROM

data/lib/pghero/methods/maintenance.rb

@@ -1,7 +1,7 @@
 module PgHero
   module Methods
     module Maintenance
-      # https://www.postgresql.org/docs/9.1/static/routine-vacuuming.html#VACUUM-FOR-WRAPAROUND
+      # https://www.postgresql.org/docs/current/routine-vacuuming.html#VACUUM-FOR-WRAPAROUND
       # "the system will shut down and refuse to start any new transactions
       # once there are fewer than 1 million transactions left until wraparound"
       # warn when 10,000,000 transactions left
@@ -9,7 +9,7 @@ module PgHero
         max_value = max_value.to_i
         threshold = threshold.to_i
 
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             n.nspname AS schema,
             c.relname AS table,
@@ -35,7 +35,7 @@ module PgHero
 
       def vacuum_progress
         if server_version_num >= 90600
-          select_all <<-SQL
+          select_all <<~SQL
             SELECT
               pid,
               phase
@@ -50,7 +50,7 @@ module PgHero
       end
 
       def maintenance_info
-        select_all <<-SQL
+        select_all <<~SQL
           SELECT
             schemaname AS schema,
             relname AS table,

data/lib/pghero/methods/queries.rb

@@ -2,7 +2,7 @@ module PgHero
   module Methods
     module Queries
       def running_queries(min_duration: nil, all: false)
-        query = <<-SQL
+        query = <<~SQL
           SELECT
             pid,
             state,
@@ -36,7 +36,7 @@ module PgHero
       # from https://wiki.postgresql.org/wiki/Lock_Monitoring
       # and https://big-elephants.com/2013-09/exploring-query-locks-in-postgres/
       def blocked_queries
-        query = <<-SQL
+        query = <<~SQL
           SELECT
             COALESCE(blockingl.relation::regclass::text,blockingl.locktype) as locked_item,
             blockeda.pid AS blocked_pid,

data/lib/pghero/methods/query_stats.rb

@@ -56,10 +56,9 @@ module PgHero
         true
       end
 
-      # TODO scope by database in PgHero 3.0
-      # (add database: database_name to options)
       def reset_query_stats(**options)
-        reset_instance_query_stats(**options)
+        raise PgHero::Error, "Use reset_instance_query_stats to pass database" if options.delete(:database)
+        reset_instance_query_stats(**options, database: database_name)
       end
 
       # resets query stats for the entire instance
@@ -121,7 +120,7 @@ module PgHero
         server_version_num >= 90400
       end
 
-      # resetting query stats will reset across the entire Postgres instance
+      # resetting query stats will reset across the entire Postgres instance in Postgres < 12
       # this is problematic if multiple PgHero databases use the same Postgres instance
       #
       # to get around this, we capture queries for every Postgres database before we
@@ -147,16 +146,15 @@ module PgHero
         # nothing to do
         return if query_stats.empty?
 
-        # use mapping, not query stats here
-        # TODO add option for this, and make default in PgHero 3.0
-        if false # mapping.size == 1 && server_version_num >= 120000
+        # reset individual databases for Postgres 12+ instance
+        if server_version_num >= 120000
           query_stats.each do |db_id, db_query_stats|
-            if reset_query_stats(database: mapping[db_id], raise_errors: raise_errors)
+            if reset_instance_query_stats(database: mapping[db_id], raise_errors: raise_errors)
               insert_query_stats(db_id, db_query_stats, now)
             end
           end
         else
-          if reset_query_stats(raise_errors: raise_errors)
+          if reset_instance_query_stats(raise_errors: raise_errors)
             query_stats.each do |db_id, db_query_stats|
               insert_query_stats(db_id, db_query_stats, now)
             end
@@ -164,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)
@@ -173,10 +172,11 @@ module PgHero
         query_stats.select { |q| q[:calls].to_i >= slow_query_calls.to_i && q[:average_time].to_f >= slow_query_ms.to_f }
       end
 
+      # TODO option to include current period
       def query_hash_stats(query_hash, user: nil)
         if historical_query_stats_enabled? && supports_query_hash?
           start_at = 24.hours.ago
-          select_all_stats <<-SQL
+          select_all_stats <<~SQL
             SELECT
               captured_at,
               total_time / 1000 / 60 AS total_minutes,
@@ -206,7 +206,7 @@ module PgHero
           limit ||= 100
           sort ||= "total_minutes"
           total_time = server_version_num >= 130000 ? "(total_plan_time + total_exec_time)" : "total_time"
-          query = <<-SQL
+          query = <<~SQL
             WITH query_stats AS (
               SELECT
                 LEFT(query, 10000) AS query,
@@ -228,6 +228,7 @@ module PgHero
             )
             SELECT
               query,
+              query AS explainable_query,
               query_hash,
               query_stats.user,
               total_minutes,
@@ -238,14 +239,14 @@ module PgHero
             FROM
               query_stats
             ORDER BY
-              #{quote_table_name(sort)} DESC
+              #{quote_column_name(sort)} DESC
             LIMIT #{limit.to_i}
           SQL
 
           # 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
@@ -254,7 +255,7 @@ module PgHero
       def historical_query_stats(sort: nil, start_at: nil, end_at: nil, query_hash: nil)
         if historical_query_stats_enabled?
           sort ||= "total_minutes"
-          query = <<-SQL
+          query = <<~SQL
             WITH query_stats AS (
               SELECT
                 #{supports_query_hash? ? "query_hash" : "md5(query)"} AS query_hash,
@@ -287,7 +288,7 @@ module PgHero
             FROM
               query_stats
             ORDER BY
-              #{quote_table_name(sort)} DESC
+              #{quote_column_name(sort)} DESC
             LIMIT 100
           SQL
 
@@ -330,19 +331,17 @@ module PgHero
       def insert_query_stats(db_id, db_query_stats, now)
         values =
           db_query_stats.map do |qs|
-            [
-              db_id,
-              qs[:query],
-              qs[:total_minutes] * 60 * 1000,
-              qs[:calls],
-              now,
-              supports_query_hash? ? qs[:query_hash] : nil,
-              qs[:user]
-            ]
+            {
+              database: db_id,
+              query: qs[:query],
+              total_time: qs[:total_minutes] * 60 * 1000,
+              calls: qs[:calls],
+              captured_at: now,
+              query_hash: supports_query_hash? ? qs[:query_hash] : nil,
+              user: qs[:user]
+            }
           end
-
-        columns = %w[database query total_time calls captured_at query_hash user]
-        insert_stats("pghero_query_stats", columns, values)
+        PgHero::QueryStats.insert_all!(values)
       end
     end
   end

data/lib/pghero/methods/replication.rb

@@ -18,7 +18,7 @@ module PgHero
               "pg_last_xlog_receive_location() = pg_last_xlog_replay_location()"
             end
 
-          select_one <<-SQL
+          select_one <<~SQL
             SELECT
               CASE
                 WHEN NOT pg_is_in_recovery() OR #{lag_condition} THEN 0
@@ -32,7 +32,7 @@ module PgHero
       def replication_slots
         if server_version_num >= 90400
           with_feature_support(:replication_slots, []) do
-            select_all <<-SQL
+            select_all <<~SQL
               SELECT
                 slot_name,
                 database,

data/lib/pghero/methods/sequences.rb

@@ -7,7 +7,7 @@ module PgHero
         # it's what information_schema.columns uses
         # also, exclude temporary tables to prevent error
         # when accessing across sessions
-        sequences = select_all <<-SQL
+        sequences = select_all <<~SQL
           SELECT
             n.nspname AS table_schema,
             c.relname AS table,
@@ -84,7 +84,7 @@ module PgHero
       # also adds schema if missing
       def add_sequence_attributes(sequences)
         # fetch data
-        sequence_attributes = select_all <<-SQL
+        sequence_attributes = select_all <<~SQL
           SELECT
             n.nspname AS schema,
             c.relname AS sequence,
@@ -115,7 +115,7 @@ module PgHero
         end
 
         # then populate attributes
-        readable = Hash[sequence_attributes.map { |s| [[s[:schema], s[:sequence]], s[:readable]] }]
+        readable = sequence_attributes.to_h { |s| [[s[:schema], s[:sequence]], s[:readable]] }
         sequences.each do |sequence|
           sequence[:readable] = readable[[sequence[:schema], sequence[:sequence]]] || false
         end

data/lib/pghero/methods/settings.rb

@@ -30,7 +30,7 @@ module PgHero
       private
 
       def fetch_settings(names)
-        Hash[names.map { |name| [name, select_one("SHOW #{name}")] }]
+        names.to_h { |name| [name, select_one("SHOW #{name}")] }
       end
     end
   end

data/lib/pghero/methods/space.rb

@@ -6,7 +6,7 @@ module PgHero
       end
 
       def relation_sizes
-        select_all_size <<-SQL
+        select_all_size <<~SQL
           SELECT
             n.nspname AS schema,
             c.relname AS relation,
@@ -27,7 +27,7 @@ module PgHero
       end
 
       def table_sizes
-        select_all_size <<-SQL
+        select_all_size <<~SQL
           SELECT
             n.nspname AS schema,
             c.relname AS table,
@@ -49,10 +49,10 @@ module PgHero
       def space_growth(days: 7, relation_sizes: nil)
         if space_stats_enabled?
           relation_sizes ||= self.relation_sizes
-          sizes = Hash[ relation_sizes.map { |r| [[r[:schema], r[:relation]], r[:size_bytes]] } ]
+          sizes = relation_sizes.to_h { |r| [[r[:schema], r[:relation]], r[:size_bytes]] }
           start_at = days.days.ago
 
-          stats = select_all_stats <<-SQL
+          stats = select_all_stats <<~SQL
             WITH t AS (
               SELECT
                 schema,
@@ -92,10 +92,10 @@ module PgHero
       def relation_space_stats(relation, schema: "public")
         if space_stats_enabled?
           relation_sizes ||= self.relation_sizes
-          sizes = Hash[ relation_sizes.map { |r| [[r[:schema], r[:relation]], r[:size_bytes]] } ]
+          sizes = relation_sizes.map { |r| [[r[:schema], r[:relation]], r[:size_bytes]] }.to_h
           start_at = 30.days.ago
 
-          stats = select_all_stats <<-SQL
+          stats = select_all_stats <<~SQL
             SELECT
               captured_at,
               size AS size_bytes
@@ -121,16 +121,22 @@ module PgHero
 
       def capture_space_stats
         now = Time.now
-        columns = %w(database schema relation size captured_at)
-        values = []
-        relation_sizes.each do |rs|
-          values << [id, rs[:schema], rs[:relation], rs[:size_bytes].to_i, now]
-        end
-        insert_stats("pghero_space_stats", columns, values) if values.any?
+        values =
+          relation_sizes.map do |rs|
+            {
+              database: id,
+              schema: rs[:schema],
+              relation: rs[:relation],
+              size: rs[:size_bytes].to_i,
+              captured_at: now
+            }
+          end
+        PgHero::SpaceStats.insert_all!(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?