pghero 3.3.4 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2332e2a4f7b9bd25d972ec1f06635dfc43676412c5be4147e3a7e3dc8effa213
-  data.tar.gz: 1a24e423a0d8749d69eb938eaa27db1beed974d1a058e6ae6331badeae9c4d59
+  metadata.gz: fe3a00850cccac8c36536d08a519790103053c9b058d61754f834c44cfb0d4eb
+  data.tar.gz: e7ae77f4353d7f27ca04f1a59aae6cf785f8e0dddac2f276e6a0973b4beb60e7
 SHA512:
-  metadata.gz: b19ca11ceee2f44bbcdec49e14f0653df6efc740e4fbd710700a03254ac8d40db84690409a731c06359d547934d401615925e88df317ccae4137eecefcfe8ddf
-  data.tar.gz: b6c0069a0e34ecd66d359aff9226fe678ccc15d55b1ad0e70f421a7fa9b9a2113d7eb31cc30d69364489fa1e10e2b5d6d0e48ada03d15e79aff5ba9dda350659
+  metadata.gz: 89d0bc08fd97968e725fea80a23d70835853acbe74648a052299b62a5e343820b36f0a76ecb3cb207d1443b47fc5d43154b40a7a0e39be518719f2c3ef589398
+  data.tar.gz: df4e987d43c13dd0d3866feefc4cfe2cf5b84c8519fb854d54e169f42ab0909b07890893498dd2e30635e36645630647db9451b2c32de737c345ac52b6ed3205

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 3.4.1 (2024-02-07)
+
+- Added current stats to query details page
+- Improved tune page for latest PgTune
+
+## 3.4.0 (2023-11-28)
+
+- Added support for explaining normalized queries with Postgres 16
+- Added Docker image for `linux/arm64`
+
 ## 3.3.4 (2023-09-05)
 
 - Fixed support for aliases in config file

data/LICENSE.txt

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

data/README.md

@@ -8,7 +8,7 @@ A performance dashboard for Postgres
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![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/r/ankane/pghero)
+[![Build Status](https://github.com/ankane/pghero/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/pghero/actions)
 
 ## Documentation
 

data/app/controllers/pg_hero/home_controller.rb

@@ -186,7 +186,7 @@ module PgHero
         @explainable_query = stats[:explainable_query]
 
         if @show_details
-          query_hash_stats = @database.query_hash_stats(@query_hash, user: @user)
+          query_hash_stats = @database.query_hash_stats(@query_hash, user: @user, current: true)
 
           @chart_data = [{name: "Value", data: query_hash_stats.map { |r| [r[:captured_at].change(sec: 0), (r[:total_minutes] * 60 * 1000).round] }, library: chart_library_options}]
           @chart2_data = [{name: "Value", data: query_hash_stats.map { |r| [r[:captured_at].change(sec: 0), r[:average_time].round(1)] }, library: chart_library_options}]
@@ -292,12 +292,14 @@ module PgHero
       # need to prevent CSRF and DoS
       if request.post? && @query.present?
         begin
+          generic_plan = @database.server_version_num >= 160000 && @query.include?("$1")
+
           explain_options =
             case params[:commit]
             when "Analyze"
               {analyze: true}
             when "Visualize"
-              if @explain_analyze_enabled
+              if @explain_analyze_enabled && !generic_plan
                 {analyze: true, costs: true, verbose: true, buffers: true, format: "json"}
               else
                 {costs: true, verbose: true, format: "json"}
@@ -306,6 +308,8 @@ module PgHero
               {}
             end
 
+          explain_options[:generic_plan] = true if generic_plan
+
           if explain_options[:analyze] && !@explain_analyze_enabled
             render_text "Explain analyze not enabled", status: :bad_request
             return
@@ -319,8 +323,10 @@ module PgHero
           @error =
             if message == "Unsafe statement"
               "Unsafe statement"
-            elsif message.start_with?("PG::ProtocolViolation: ERROR:  bind message supplies 0 parameters")
+            elsif message.start_with?("PG::UndefinedParameter")
               "Can't explain queries with bind parameters"
+            elsif message.include?("EXPLAIN options ANALYZE and GENERIC_PLAN cannot be used together")
+              "Can't analyze queries with bind parameters"
             elsif message.start_with?("PG::SyntaxError")
               "Syntax error with query"
             elsif message.start_with?("PG::QueryCanceled")

data/lib/pghero/methods/explain.rb

@@ -12,7 +12,7 @@ module PgHero
           if (sql.sub(/;\z/, "").include?(";") || sql.upcase.include?("COMMIT")) && !explain_safe?
             raise ActiveRecord::StatementInvalid, "Unsafe statement"
           end
-          explanation = select_all("EXPLAIN #{sql}").map { |v| v[:"QUERY PLAN"] }.join("\n")
+          explanation = execute("EXPLAIN #{sql}").map { |v| v["QUERY PLAN"] }.join("\n")
         end
 
         explanation
@@ -20,11 +20,12 @@ module PgHero
 
       # 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")
+      def explain_v2(sql, analyze: nil, verbose: nil, costs: nil, settings: nil, generic_plan: 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, "GENERIC_PLAN", generic_plan)
         add_explain_option(options, "COSTS", costs)
         add_explain_option(options, "BUFFERS", buffers)
         add_explain_option(options, "WAL", wal)

data/lib/pghero/methods/query_stats.rb

@@ -172,11 +172,10 @@ 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)
+      def query_hash_stats(query_hash, user: nil, current: false)
         if historical_query_stats_enabled? && supports_query_hash?
           start_at = 24.hours.ago
-          select_all_stats <<~SQL
+          stats = select_all_stats <<~SQL
             SELECT
               captured_at,
               total_time / 1000 / 60 AS total_minutes,
@@ -193,6 +192,15 @@ module PgHero
             ORDER BY
               1 ASC
           SQL
+          if current
+            captured_at = Time.current
+            current_stats = current_query_stats(query_hash: query_hash, user: user, origin: true)
+            current_stats.each do |r|
+              r[:captured_at] = captured_at
+            end
+            stats += current_stats
+          end
+          stats
         else
           raise NotEnabled, "Query hash stats not enabled"
         end
@@ -201,7 +209,7 @@ module PgHero
       private
 
       # http://www.craigkerstiens.com/2013/01/10/more-on-postgres-performance/
-      def current_query_stats(limit: nil, sort: nil, database: nil, query_hash: nil)
+      def current_query_stats(limit: nil, sort: nil, database: nil, query_hash: nil, user: nil, origin: false)
         if query_stats_enabled?
           limit ||= 100
           sort ||= "total_minutes"
@@ -225,10 +233,12 @@ module PgHero
                 calls > 0 AND
                 pg_database.datname = #{database ? quote(database) : "current_database()"}
                 #{query_hash ? "AND queryid = #{quote(query_hash)}" : nil}
+                #{user ? "AND rolname = #{quote(user)}" : nil}
             )
             SELECT
               query,
               query AS explainable_query,
+              #{origin ? "(SELECT regexp_matches(query, '.*/\\*(.+?)\\*/'))[1] AS origin," : nil}
               query_hash,
               query_stats.user,
               total_minutes,
@@ -319,7 +329,7 @@ module PgHero
       end
 
       def explainable?(query)
-        query =~ /select/i && !query.include?("?)") && !query.include?("= ?") && !query.include?("$1") && query !~ /limit \?/i
+        query =~ /select/i && (server_version_num >= 160000 || (!query.include?("?)") && !query.include?("= ?") && !query.include?("$1") && query !~ /limit \?/i))
       end
 
       # removes comments

data/lib/pghero/methods/settings.rb

@@ -3,7 +3,14 @@ module PgHero
     module Settings
       def settings
         names =
-          if server_version_num >= 90500
+          if server_version_num >= 100000
+            %i(
+              max_connections shared_buffers effective_cache_size maintenance_work_mem
+              checkpoint_completion_target wal_buffers default_statistics_target
+              random_page_cost effective_io_concurrency work_mem huge_pages
+              min_wal_size max_wal_size
+            )
+          elsif server_version_num >= 90500
             %i(
               max_connections shared_buffers effective_cache_size work_mem
               maintenance_work_mem min_wal_size max_wal_size checkpoint_completion_target

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "3.3.4"
+  VERSION = "3.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 3.3.4
+  version: 3.4.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A performance dashboard for Postgres