pg_peek 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52d233ab8cafc3dae1e3386c44b9244549344b3b4bf97bc9f053cfdb843bd223
-  data.tar.gz: 3abf5a72e79b3ffff19323bb6fc7812c479bfd23c8bbee8667aff5a52732cb1f
+  metadata.gz: abc82aa27c9e7fcebbe27a38cc17ff102ae578afdd11d0be75908874ee5058e8
+  data.tar.gz: 7bc328de015861d67c0250ad0373c4639fe1a45c15426c084939d56409b74d5a
 SHA512:
-  metadata.gz: 93640cabe15c0afecb89784c94623a77ccb118a1679a9fe821b58e4fb9f04f68de2e28b88222f475a5930f1daff722f577c65149159c498aece5b19e1fe20f9f
-  data.tar.gz: 37074ace65e4e13d9953f4d342a8b4011a0fa7903b7141e29b8961d3db44ea680273c78b4835157605275f4578878b23d04e28df1287a99ce3505703b33b11ab
+  metadata.gz: 72349c589551ec7dd8b5875f1ccbd579a7bbeaba94588fd29251cec72f041f4610077963efdfdd47683f7741469f9ac0cc7f912453770698e5e68e346ea1a7a3
+  data.tar.gz: 8c336b095487533a4862016ee4ffd1d332f3dad19f2134a03716375df017809fa123b1cfa37c286a0d833efeffbc4104c126c2df5a50ae74dce5b7e9eb6ee5d3

data/app/assets/javascripts/pg_peek/application.js

@@ -1,4 +1,4 @@
-// pg_peek — no framework, no CDN, no import map. Three small behaviours.
+// pg_peek — no framework, no CDN, no import map. A few small behaviours.
 (function () {
   "use strict";
 
@@ -112,6 +112,29 @@
     });
   }
 
+  // Long queries --------------------------------------------------------------
+  // Clamped to their first lines by CSS. Measured here, so only a query that
+  // is actually longer gets the toggle.
+  function initClamp() {
+    document.querySelectorAll("[data-clamp]").forEach(function (code) {
+      code.classList.add("clamped");
+      if (code.scrollHeight <= code.clientHeight) {
+        code.classList.remove("clamped");
+        return;
+      }
+
+      var button = document.createElement("button");
+      button.type = "button";
+      button.className = "clamp-toggle";
+      button.textContent = "show all";
+      button.addEventListener("click", function () {
+        var expanded = code.classList.toggle("expanded");
+        button.textContent = expanded ? "show less" : "show all";
+      });
+      code.insertAdjacentElement("afterend", button);
+    });
+  }
+
   // Database switcher -------------------------------------------------------
   function initSwitcher() {
     document.querySelectorAll("[data-switcher]").forEach(function (select) {
@@ -135,6 +158,7 @@
     initTheme();
     initFilter();
     initConfirm();
+    initClamp();
     initSwitcher();
     initReload();
   }

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

@@ -226,7 +226,30 @@ tbody th + td { text-align: right; }
 }
 .qualified .namespace > span { direction: ltr; unicode-bidi: embed; }
 .qualified .leaf { flex-shrink: 0; max-width: 100%; overflow: hidden; text-overflow: ellipsis; }
-.sql { word-break: break-all; white-space: pre-wrap; background: none; border: 0; padding: 0; }
+/* Formatted one clause per line (SqlFormat); a line longer than the cell
+   wraps at spaces and breaks inside a word only when nothing else fits. */
+.sql { display: block; overflow-wrap: anywhere; white-space: pre-wrap; background: none; border: 0; padding: 0; }
+
+/* A long query shows its first lines, with a toggle for the rest. The script
+   adds the class only where the query is longer, so short ones stay as they
+   are, and without it every query shows in full. */
+.sql.clamped:not(.expanded) {
+  display: -webkit-box;
+  -webkit-box-orient: vertical;
+  -webkit-line-clamp: 3;
+  line-clamp: 3;
+  overflow: hidden;
+}
+
+button.clamp-toggle {
+  background: none;
+  border: 0;
+  padding: 0;
+  color: var(--dim);
+  font-size: inherit;
+}
+
+button.clamp-toggle:hover { color: var(--fg); }
 
 /* What issued a query, from its SQLcommenter tags: a link line under the SQL,
    plus every raw tag behind a disclosure. The page-level details/summary

data/app/controllers/pg_peek/databases_controller.rb

@@ -21,7 +21,6 @@ class PgPeek::DatabasesController < PgPeek::ApplicationController
   def show
     @database = PgPeek::Database.find(params[:id]) or raise ActiveRecord::RecordNotFound, "Database not found"
     @pg_stat_statements = PgPeek::PgStatStatements.new(database: @database)
-    @tables = PgPeek::Reports::Tables.new(database: @database)
     @vitals = @database.vitals
     @stats_reset_at = @pg_stat_statements.reset_at
     @sessions = PgPeek::Reports::Sessions.new(database: @database)

data/app/controllers/pg_peek/pg_stat_statements_controller.rb

@@ -1,17 +1,28 @@
 # Manages the extension itself. What it records is read by QueriesController,
 # EndpointsController and JobsController.
 class PgPeek::PgStatStatementsController < PgPeek::ApplicationController
-  def reset
-    @database = PgPeek::Database.find(params[:database_id]) or raise ActiveRecord::RecordNotFound, "Database not found"
-    pg_stat_statements = PgPeek::PgStatStatements.new(database: @database)
+  before_action :set_database
+
+  def show
+    return render "pg_peek/pg_stat_statements/not_preloaded" unless @pg_stat_statements.usable?
+
+    @connection_summary = @database.connection_summary
+  end
 
-    if pg_stat_statements.resettable?
-      pg_stat_statements.reset!
+  def reset
+    if @pg_stat_statements.resettable?
+      @pg_stat_statements.reset!
       flash[:notice] = "pg_stat_statements has been reset."
     else
       flash[:alert] = "This role may not reset pg_stat_statements; the statistics were left as they are."
     end
 
-    redirect_to database_path(@database, anchor: "pg_stat_statements")
+    redirect_to database_pg_stat_statements_path(@database)
   end
+
+  private
+    def set_database
+      @database = PgPeek::Database.find(params[:database_id]) or raise ActiveRecord::RecordNotFound, "Database not found"
+      @pg_stat_statements = PgPeek::PgStatStatements.new(database: @database)
+    end
 end

data/app/controllers/pg_peek/tables_controller.rb

@@ -1,6 +1,16 @@
 class PgPeek::TablesController < PgPeek::ApplicationController
+  before_action :set_database
+
+  def index
+    @tables = PgPeek::Reports::Tables.new(database: @database)
+  end
+
   def show
-    @database = PgPeek::Database.find(params[:database_id]) or raise ActiveRecord::RecordNotFound, "Database not found"
     @table = @database.find_table(params[:name]) or raise ActiveRecord::RecordNotFound, "Table '#{params[:name]}' not found"
   end
+
+  private
+    def set_database
+      @database = PgPeek::Database.find(params[:database_id]) or raise ActiveRecord::RecordNotFound, "Database not found"
+    end
 end

data/app/helpers/pg_peek/application_helper.rb

@@ -102,14 +102,15 @@ module PgPeek::ApplicationHelper
   end
 
   # Every pg_stat_statements figure is cumulative since the last reset. Each
-  # page says so in its header and links to the overview block that resets it.
+  # page says so in its header and links to the extension's page, which
+  # resets it.
   # Within the first hour the figures cover too little to go by, and the link
   # is marked provisional.
   def stats_since_link(database, reset_at)
     provisional = reset_at && reset_at > 1.hour.ago
 
     link_to "stats since #{format_time_ago(reset_at)}",
-            database_path(database, anchor: "pg_stat_statements"),
+            database_pg_stat_statements_path(database),
             class: ("provisional" if provisional),
             title: provisional ? "figures may not be representative yet" : "figures are cumulative since the last pg_stat_statements reset"
   end

data/app/helpers/pg_peek/report_helper.rb

@@ -50,7 +50,7 @@ module PgPeek::ReportHelper
   # link into the page that already aggregates this exact query across every
   # call site) and every raw tag behind a disclosure, for the rest.
   def sql_cell(report, sql)
-    code = tag.code(strip_sqlcommenter(sql).squish, class: "sql")
+    code = tag.code(PgPeek::SqlFormat.format(strip_sqlcommenter(sql)), class: "sql", data: { clamp: true })
     tags = PgPeek::SqlComment.tags(sql)
     return code if tags.empty?
 

data/app/models/pg_peek/pg_stat_statements.rb

@@ -93,6 +93,37 @@ class PgPeek::PgStatStatements
     Time.zone.parse(value.to_s) if value.present?
   end
 
+  # How many statements the server dropped since the last reset because the
+  # table was full (pg_stat_statements.max). Above zero, every total is an
+  # undercount: whatever was dropped took its calls and time with it.
+  def dealloc
+    return unless usable?
+
+    connection.select_value(PgPeek::QueryLoader.mark(<<~SQL)).to_i
+      SELECT dealloc FROM pg_stat_statements_info
+    SQL
+  end
+
+  # The table is shared by every database on the server, so max is measured
+  # against all of them, not just this one.
+  def server_statement_count
+    return unless usable?
+
+    connection.select_value(PgPeek::QueryLoader.mark(<<~SQL)).to_i
+      SELECT count(*) FROM pg_stat_statements
+    SQL
+  end
+
+  # pg_stat_statements.* settings, by name without the prefix.
+  def settings
+    return {} unless usable?
+
+    connection.select_rows(PgPeek::QueryLoader.mark(<<~SQL)).to_h
+      SELECT substr(name, length('pg_stat_statements.') + 1), setting
+      FROM pg_settings WHERE name LIKE 'pg_stat_statements.%' ORDER BY name
+    SQL
+  end
+
   def outliers
     return unless usable?
 

data/app/models/pg_peek/sql_format.rb

@@ -0,0 +1,74 @@
+# Lays a query out one clause per line, so the first lines of a long query say
+# what it reads and from where, and its joins and conditions read as a list.
+# Only line breaks and spacing change. Breaks go in at the top level only --
+# never inside parentheses, quotes or a CASE -- so subqueries and function
+# calls stay on one line, and a query this does not understand comes out with
+# an odd break at worst.
+class PgPeek::SqlFormat
+  TOKEN = /'(?:[^']|'')*'|"(?:[^"]|"")*"|[(),;]|[^\s'"(),;]+|\s+/
+  CLAUSES = %w[SELECT FROM WHERE GROUP HAVING WINDOW ORDER LIMIT OFFSET FETCH FOR
+               UNION INTERSECT EXCEPT RETURNING SET VALUES].freeze
+  JOIN_PREFIXES = %w[INNER LEFT RIGHT FULL CROSS NATURAL].freeze
+  CONDITIONS = %w[WHERE HAVING].freeze
+
+  def self.format(sql)
+    tokens = []
+    space = false
+    sql.to_s.strip.scan(TOKEN) do |token|
+      if token.match?(/\A\s/)
+        space = true
+      else
+        tokens << [ token, space ]
+        space = false
+      end
+    end
+
+    out = +""
+    depth = case_depth = 0
+    clause = nil
+    between = false
+
+    tokens.each_with_index do |(token, space_before), index|
+      word = token.upcase
+      top = index.positive? && depth.zero? && case_depth.zero?
+      previous = tokens[index - 1]&.first&.upcase if index.positive?
+      following = tokens[index + 1]&.first&.upcase
+
+      line_break = nil
+      if top
+        if CLAUSES.include?(word)
+          line_break = "\n"
+          clause = word
+        elsif JOIN_PREFIXES.include?(word) && %w[JOIN OUTER].include?(following)
+          line_break = "\n"
+          clause = "JOIN"
+        elsif word == "JOIN" && !(JOIN_PREFIXES + %w[OUTER]).include?(previous)
+          line_break = "\n"
+          clause = "JOIN"
+        elsif word == "BETWEEN"
+          between = true
+        elsif word == "AND" && between
+          between = false
+        elsif %w[AND OR].include?(word) && CONDITIONS.include?(clause)
+          line_break = "\n  "
+        end
+      end
+
+      if line_break
+        out << line_break
+      elsif space_before && !out.empty?
+        out << " "
+      end
+      out << token
+
+      case word
+      when "(" then depth += 1
+      when ")" then depth -= 1 if depth.positive?
+      when "CASE" then case_depth += 1
+      when "END" then case_depth -= 1 if case_depth.positive?
+      end
+    end
+
+    out
+  end
+end

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

@@ -26,6 +26,7 @@
             <li><%= link_to "queries", database_queries_path(@database) %></li>
             <li><%= link_to "endpoints", database_endpoints_path(@database) %></li>
             <li><%= link_to "jobs", database_jobs_path(@database) %></li>
+            <li><%= link_to "tables", database_tables_path(@database) %></li>
             <li><%= link_to "indexes", database_indexes_path(@database) %></li>
             <li><%= link_to "activity", database_activity_path(@database) %></li>
             <li class="current-database">

data/app/views/pg_peek/databases/show.html.erb

@@ -107,64 +107,8 @@ end</code></pre>
                  limit: PgPeek::DatabasesController::OVERVIEW_ROWS %>
     <% end %>
   </section>
-
-  <section class="wide" id="tables" data-filter>
-    <h2>tables (<%= @tables.rows.size %>)</h2>
-    <input type="search"
-           placeholder="filter tables… (press / to focus)"
-           data-filter-input
-           data-filter-noun="table"
-           autocomplete="off">
-    <p class="dim" data-filter-count></p>
-
-    <%= render "pg_peek/reports/report",
-               report: @tables,
-               link_column: :name,
-               link: ->(row) { database_table_path(@database, row["name"]) } %>
-
-    <p class="dim" data-filter-empty hidden>No tables match that filter.</p>
-  </section>
 </div>
 
-<% if @pg_stat_statements.usable? %>
-  <section id="pg_stat_statements">
-    <h2>pg_stat_statements <%= @pg_stat_statements.installed_version %></h2>
-    <p class="dim">
-      Queries, endpoints and jobs are cumulative since
-      <%= @stats_reset_at.strftime("%Y-%m-%d %H:%M:%S %Z") %> (<%= format_time_ago(@stats_reset_at) %>),
-      <%= pluralize(number_with_delimiter(@pg_stat_statements.statement_count), "statement") %> tracked.
-      A reset starts a fresh window: exact counts and attribution, at the
-      price of the history so far.
-      <% peers = @database.server_peers %>
-      <% if peers.any? %>
-        It also clears <%= peers.map(&:name).to_sentence %>, which
-        <%= peers.one? ? "shares" : "share" %> this server: PostgreSQL keeps
-        one reset time for all of them.
-      <% end %>
-    </p>
-    <%= button_to "reset statistics",
-                  reset_database_pg_stat_statements_path(@database),
-                  method: :delete,
-                  class: "danger",
-                  disabled: !@pg_stat_statements.resettable?,
-                  form_class: "inline",
-                  form: { data: { confirm: "Reset pg_stat_statements? This clears statement statistics for every database on this server." } } %>
-    <% unless @pg_stat_statements.resettable? %>
-      <p class="dim">
-        <%= @connection_summary["username"] %> may not reset the statistics: the extension
-        allows it only to superusers and roles granted it. To allow it:
-      </p>
-      <pre><code>GRANT EXECUTE ON FUNCTION pg_stat_statements_reset TO <%= @connection_summary["username"] %>;</code></pre>
-    <% end %>
-    <% if @pg_stat_statements.outdated? %>
-      <p class="dim">
-        Version <%= @pg_stat_statements.default_version %> is available:
-        <code>ALTER EXTENSION pg_stat_statements UPDATE;</code>
-      </p>
-    <% end %>
-  </section>
-<% end %>
-
 <details>
   <summary>database details</summary>
   <pre>name: <%= @database.name %>

data/app/views/pg_peek/endpoints/show.html.erb

@@ -1,5 +1,6 @@
 <div class="toolbar">
   <h1><code class="name"><%= @endpoint %></code></h1>
+  <small class="dim"><%= stats_since_link(@database, @pg_stat_statements.reset_at) %></small>
   <%= link_to "← endpoints", database_endpoints_path(@database) %>
 </div>
 

data/app/views/pg_peek/jobs/index.html.erb

@@ -24,13 +24,6 @@
         collecting, so this page is working — there is simply nothing in it
         yet. Jobs appear as they execute their first database query.
       </p>
-      <% if @stats_reset_at %>
-        <p>
-          Statistics were last reset <strong><%= format_time_ago(@stats_reset_at) %></strong>
-          (<%= @stats_reset_at %>), so anything that ran before then is gone.
-          Restarting PostgreSQL clears them too.
-        </p>
-      <% end %>
     </article>
   <% end %>
 <% else %>

data/app/views/pg_peek/jobs/show.html.erb

@@ -1,5 +1,6 @@
 <div class="toolbar">
   <h1><code class="name"><%= @job_class %></code></h1>
+  <small class="dim"><%= stats_since_link(@database, @pg_stat_statements.reset_at) %></small>
   <%= link_to "← jobs", database_jobs_path(@database) %>
 </div>
 

data/app/views/pg_peek/pg_stat_statements/show.html.erb

@@ -0,0 +1,87 @@
+<% reset_at = @pg_stat_statements.reset_at %>
+<% settings = @pg_stat_statements.settings %>
+<% dealloc = @pg_stat_statements.dealloc %>
+
+<div class="toolbar">
+  <h1>pg_stat_statements <small class="dim"><%= @pg_stat_statements.installed_version %></small></h1>
+</div>
+
+<section>
+  <h2>collection</h2>
+  <table>
+    <tbody>
+      <tr>
+        <th>stats since</th>
+        <td><%= reset_at.strftime("%Y-%m-%d %H:%M:%S %Z") %> (<%= format_time_ago(reset_at) %>)</td>
+      </tr>
+      <tr>
+        <th>statements tracked</th>
+        <td>
+          <%= number_with_delimiter(@pg_stat_statements.server_statement_count) %>
+          <% if settings["max"] %>of <%= number_with_delimiter(settings["max"].to_i) %><% end %>
+          <span class="dim">(this database: <%= number_with_delimiter(@pg_stat_statements.statement_count) %>)</span>
+        </td>
+      </tr>
+      <tr>
+        <th>dropped when full</th>
+        <td><%= number_with_delimiter(dealloc) %></td>
+      </tr>
+    </tbody>
+  </table>
+  <% if dealloc.positive? %>
+    <p class="dim">
+      The server dropped statements to make room since the last reset, so every
+      total here undercounts. Raise <code>pg_stat_statements.max</code>
+      (needs a server restart) or reset more often.
+    </p>
+  <% end %>
+</section>
+
+<section>
+  <h2>settings</h2>
+  <table>
+    <tbody>
+      <% settings.each do |name, value| %>
+        <tr>
+          <th><code>pg_stat_statements.<%= name %></code></th>
+          <td><%= value %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+  <% if @pg_stat_statements.outdated? %>
+    <p class="dim">
+      Version <%= @pg_stat_statements.default_version %> is available:
+      <code>ALTER EXTENSION pg_stat_statements UPDATE;</code>
+    </p>
+  <% end %>
+</section>
+
+<section id="reset">
+  <h2>reset</h2>
+  <p class="dim">
+    Queries, endpoints and jobs are cumulative since the last reset. A reset
+    starts a fresh window: exact counts and attribution, at the price of the
+    history so far. Restarting PostgreSQL clears them too.
+    <% peers = @database.server_peers %>
+    <% if peers.any? %>
+      It also clears <%= peers.map(&:name).to_sentence %>, which
+      <%= peers.one? ? "shares" : "share" %> this server: PostgreSQL keeps
+      one reset time for all of them.
+    <% end %>
+  </p>
+  <%= button_to "reset statistics",
+                reset_database_pg_stat_statements_path(@database),
+                method: :delete,
+                class: "danger",
+                disabled: !@pg_stat_statements.resettable?,
+                form_class: "inline",
+                form: { data: { confirm: "Reset pg_stat_statements? This clears statement statistics for every database on this server." } } %>
+  <% unless @pg_stat_statements.resettable? %>
+    <p class="dim">
+      <%= @connection_summary["username"] %> may not reset the statistics: the extension
+      allows it only to superusers and roles granted it. To allow it:
+    </p>
+    <pre><code>GRANT EXECUTE ON FUNCTION pg_stat_statements_reset TO <%= @connection_summary["username"] %>;</code></pre>
+  <% end %>
+</section>

data/app/views/pg_peek/tables/index.html.erb

@@ -0,0 +1,18 @@
+<div class="toolbar">
+  <h1>tables</h1>
+</div>
+
+<input type="search"
+       placeholder="filter tables… (press / to focus)"
+       data-filter-input
+       data-filter-noun="table"
+       autofocus
+       autocomplete="off">
+<p class="dim" data-filter-count></p>
+
+<%= render "pg_peek/reports/report",
+           report: @tables,
+           link_column: :name,
+           link: ->(row) { database_table_path(@database, row["name"]) } %>
+
+<p class="dim" data-filter-empty hidden>No tables match that filter.</p>

data/app/views/pg_peek/tables/show.html.erb

@@ -1,6 +1,6 @@
 <div class="toolbar">
   <h1><code class="name"><%= @table.name %></code></h1>
-  <%= link_to "← tables", database_path(@database, anchor: "tables") %>
+  <%= link_to "← tables", database_tables_path(@database) %>
 </div>
 
 <% seconds_elapsed = @table.seconds_since_reset %>

data/config/routes.rb

@@ -1,7 +1,7 @@
 PgPeek::Engine.routes.draw do
   resources :databases, only: [ :index, :show ] do
     resources :queries, only: [ :index ]
-    resources :tables, only: [ :show ], param: :name
+    resources :tables, only: [ :index, :show ], param: :name
     resources :endpoints, only: [ :index ]
     # admin/posts#index lives at endpoints/admin/posts/index: the slashes of a
     # namespace stay as they are, and no # needs encoding.
@@ -10,7 +10,7 @@ PgPeek::Engine.routes.draw do
     resource :activity, only: [ :show ], controller: "activity"
     resources :jobs, only: [ :index, :show ], param: :job_class
 
-    resource :pg_stat_statements, only: [] do
+    resource :pg_stat_statements, only: [ :show ] do
       delete :reset
     end
   end

data/lib/pg_peek/version.rb

@@ -1,3 +1,3 @@
 module PgPeek
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_peek
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tomasz Mazur
@@ -69,6 +69,7 @@ files:
 - app/models/pg_peek/database.rb
 - app/models/pg_peek/pg_stat_statements.rb
 - app/models/pg_peek/sql_comment.rb
+- app/models/pg_peek/sql_format.rb
 - app/models/pg_peek/table.rb
 - app/queries/pg_peek/pg14/activity/sessions.sql
 - app/queries/pg_peek/pg14/activity/summary.sql
@@ -159,8 +160,10 @@ files:
 - app/views/pg_peek/jobs/show.html.erb
 - app/views/pg_peek/pg_stat_statements/_preload_instructions.html.erb
 - app/views/pg_peek/pg_stat_statements/not_preloaded.html.erb
+- app/views/pg_peek/pg_stat_statements/show.html.erb
 - app/views/pg_peek/queries/index.html.erb
 - app/views/pg_peek/reports/_report.html.erb
+- app/views/pg_peek/tables/index.html.erb
 - app/views/pg_peek/tables/show.html.erb
 - config/routes.rb
 - lib/generators/pg_peek/install/install_generator.rb
@@ -194,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.21
 specification_version: 4
 summary: PostgreSQL query performance monitoring for Rails applications
 test_files: []