pg_peek 0.1.0

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

@@ -0,0 +1,43 @@
+<h1>Databases</h1>
+
+<%# An empty list means one of two quite different things, and the engine knows
+    which: PostgreSQL databases exist but none is mapped to a connection class,
+    or there are no PostgreSQL databases to show at all. %>
+<% if @configured_databases.empty? && @databases.any? %>
+  <article aria-label="No database connections configured">
+    <header>pg_peek has no database connections configured</header>
+    <p>
+      Found <%= pluralize(@databases.size, "PostgreSQL database") %> in
+      <code>config/database.yml</code>
+      (<%= safe_join(@databases.map { |database| content_tag(:code, database.name) }, ", ") %>),
+      but <code>config.pg_peek.connections</code> is empty, so none of them can be opened.
+    </p>
+    <p>Generate the initializer:</p>
+    <pre><code>bin/rails generate pg_peek:install</code></pre>
+    <p>Or add <code>config/initializers/pg_peek.rb</code> yourself:</p>
+    <pre><code>Rails.application.config.pg_peek.tap do |config|
+  config.connections = {
+<%= @databases.map { |database|
+      klass = database.primary ? "ApplicationRecord" : "#{database.name.camelize}Record"
+      %(    "#{database.name}" => "#{klass}")
+    }.join(",\n") %>
+  }
+end</code></pre>
+  </article>
+<% elsif @databases.empty? %>
+  <article aria-label="No PostgreSQL databases">
+    <header>No PostgreSQL databases found</header>
+    <p>
+      No entry in <code>config/database.yml</code> for the
+      <code><%= Rails.env %></code> environment uses the
+      <code>postgresql</code> adapter, so there is nothing for pg_peek to inspect.
+    </p>
+  </article>
+<% end %>
+
+<% if @configured_databases.any? %>
+  <%= render "pg_peek/reports/report",
+             report: @report,
+             link_column: :name,
+             link: ->(row) { database_path(row["database"]) } %>
+<% end %>

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

@@ -0,0 +1,169 @@
+<h1><%= @database.name %> <small class="dim">overview</small></h1>
+
+<p class="vitals dim">
+  <span>postgres <%= @database.version %></span>
+  <% if @pg_stat_statements.usable? %>
+    <span>pg_stat_statements <%= @pg_stat_statements.installed_version %></span>
+    <span><%= stats_since_link(@database, @stats_reset_at) %></span>
+    <span><%= pluralize(number_with_delimiter(@pg_stat_statements.statement_count), "statement") %></span>
+  <% end %>
+  <% if @vitals["cache_hit_ratio"] %><span>cache hit <%= @vitals["cache_hit_ratio"] %>%</span><% end %>
+  <% if @vitals["connections"] %><span><%= pluralize(@vitals["connections"].to_i, "connection") %></span><% end %>
+</p>
+
+<% if @pg_stat_statements.usable? %>
+<% elsif @pg_stat_statements.installed? %>
+  <%= render "pg_peek/pg_stat_statements/preload_instructions",
+             database: @database,
+             pg_stat_statements: @pg_stat_statements %>
+<% elsif @pg_stat_statements.available? %>
+  <article aria-label="Extension pg_stat_statements is not enabled">
+    <header>pg_stat_statements extension is not enabled</header>
+    <p>Create it with a migration, so it is tracked in your schema:</p>
+    <% if @database.primary %>
+      <pre><code>bin/rails generate migration EnablePgStatStatements</code></pre>
+    <% else %>
+      <pre><code>bin/rails generate migration EnablePgStatStatements --database <%= @database.name %></code></pre>
+    <% end %>
+    <pre><code>def change
+  enable_extension "pg_stat_statements"
+end</code></pre>
+    <p>Then <code>bin/rails db:migrate</code>.</p>
+  </article>
+<% else %>
+  <article aria-label="Extension pg_stat_statements is not available">
+    <header>pg_stat_statements extension is not available</header>
+    <p>The pg_stat_statements extension is not available on this PostgreSQL server.</p>
+    <p>To make it available, add to <code>postgresql.conf</code>:</p>
+    <pre><code>shared_preload_libraries = 'pg_stat_statements'</code></pre>
+    <footer>
+      <small>A server restart is required after this change.</small>
+    </footer>
+  </article>
+<% end %>
+
+<div class="panels">
+  <section class="wide">
+    <h2>attention</h2>
+    <ul class="attention">
+      <% if @attention.empty? %>
+        <li class="ok">nothing needs attention</li>
+      <% else %>
+        <% @attention.each do |item| %>
+          <li><%= item[:href] ? link_to(item[:text], item[:href]) : item[:text] %></li>
+        <% end %>
+      <% end %>
+    </ul>
+  </section>
+
+  <% if @pg_stat_statements.usable? %>
+    <section>
+      <h2>endpoints <%= link_to "all →", database_endpoints_path(@database) %></h2>
+      <% if @endpoints.empty? %>
+        <p class="dim">No endpoint has run a query yet.</p>
+      <% else %>
+        <%= render "pg_peek/reports/report", report: @endpoints,
+                   columns: %i[endpoint share total_exec_time_ms max_queries_per_request],
+                   limit: PgPeek::DatabasesController::OVERVIEW_ROWS %>
+      <% end %>
+    </section>
+
+    <section>
+      <h2>jobs <%= link_to "all →", database_jobs_path(@database) %></h2>
+      <% if @jobs.empty? %>
+        <p class="dim">No job has run a query yet.</p>
+      <% else %>
+        <%= render "pg_peek/reports/report", report: @jobs,
+                   columns: %i[job_class share total_exec_time_ms],
+                   limit: PgPeek::DatabasesController::OVERVIEW_ROWS %>
+      <% end %>
+    </section>
+
+    <section class="wide">
+      <h2>slowest queries <%= link_to "all →", database_queries_path(@database) %></h2>
+      <% if @queries.empty? %>
+        <p class="dim">No statements recorded yet.</p>
+      <% else %>
+        <%= render "pg_peek/reports/report", report: @queries, limit: PgPeek::DatabasesController::OVERVIEW_ROWS %>
+      <% end %>
+    </section>
+  <% end %>
+
+  <section class="wide">
+    <h2>activity <%= link_to "now →", database_activity_path(@database) %></h2>
+    <p class="vitals dim">
+      <span><%= @connection_summary["client_connections"] %> of <%= @connection_summary["max_connections"] %> server connections in use</span>
+      <span>this database: <%= @sessions.active.size %> active</span>
+      <span><%= @sessions.in_transaction.size %> idle in transaction</span>
+      <span><%= @sessions.idle.size %> idle</span>
+      <% if @sessions.blocked.any? %><span><%= @sessions.blocked.size %> blocked</span><% end %>
+    </p>
+    <% if @sessions.busy.any? %>
+      <%= render "pg_peek/reports/report", report: @sessions, rows: @sessions.busy,
+                 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",
+                  form_class: "inline",
+                  form: { data: { confirm: "Reset pg_stat_statements? This clears statement statistics for every database on this server." } } %>
+    <% 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 %>
+primary: <%= @database.primary %>
+replica: <%= @database.replica %>
+schema_format: <%= @database.schema_format %>
+version: <%= @database.version_full %></pre>
+</details>
+
+<details>
+  <summary>installed extensions</summary>
+  <pre><% @database.installed_extensions.each do |extension| %><%= extension['name'] %> <%= extension['installed_version'] %>
+<% end %></pre>
+</details>

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

@@ -0,0 +1,24 @@
+<div class="toolbar">
+  <h1>endpoints</h1>
+  <small class="dim"><%= stats_since_link(@database, @pg_stat_statements.reset_at) %></small>
+</div>
+
+<% if @report.empty? %>
+  <article aria-label="No endpoints found">
+    <header>No controller action has run a query yet</header>
+    <p>
+      Endpoints appear once requests have run database queries with
+      <code>:controller</code> (or <code>:namespaced_controller</code>) and
+      <code>:action</code> among <code>config.active_record.query_log_tags</code>.
+    </p>
+  </article>
+<% else %>
+  <%= render "pg_peek/reports/report", report: @report %>
+
+  <p class="dim">
+    <strong>q/req</strong> is an estimate: the request count is inferred from the
+    least-called query of each endpoint, so an action whose every query is
+    conditional will read low. A value above
+    <%= PgPeek::Reports::Endpoints::N_PLUS_ONE_THRESHOLD %> is the shape of an N+1.
+  </p>
+<% end %>

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

@@ -0,0 +1,31 @@
+<div class="toolbar">
+  <h1>indexes</h1>
+  <small class="dim">
+    <% if @stats_reset_at %>
+      scan counts since <%= format_time_ago(@stats_reset_at) %>
+    <% else %>
+      scan counts since statistics began &mdash; never reset
+    <% end %>
+  </small>
+</div>
+
+<% if @report.unused.any? %>
+  <article aria-label="Unused indexes">
+    <header>
+      <%= pluralize(@report.unused.size, "index") %> never scanned,
+      <%= number_to_human_size(@report.unused_bytes) %> of disk and write cost
+    </header>
+    <p>
+      Not read by any query since statistics were last reset. Primary keys and
+      unique indexes are not counted: they enforce constraints whether or not a
+      query reads them. Before dropping one, make sure the window covers your
+      rarest workloads &mdash; a month-end report is still a workload.
+    </p>
+  </article>
+<% end %>
+
+<% if @report.empty? %>
+  <p class="dim">No indexes on user tables.</p>
+<% else %>
+  <%= render "pg_peek/reports/report", report: @report %>
+<% end %>

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

@@ -0,0 +1,51 @@
+<div class="toolbar">
+  <h1>jobs</h1>
+  <small class="dim"><%= stats_since_link(@database, @stats_reset_at) %></small>
+</div>
+
+<% if @report.empty? %>
+  <% if !@job_tag_configured %>
+    <article aria-label="Job tag not configured">
+      <header>Queries are not tagged with the job that ran them</header>
+      <p>
+        <code>config.active_record.query_log_tags</code> is
+        <code><%= Rails.application.config.active_record.query_log_tags.to_a.inspect %></code>,
+        which does not include <code>:job</code>. Until it does, no query can be
+        attributed to a job and this page cannot fill, however many jobs run.
+      </p>
+      <p>In <code>config/application.rb</code>:</p>
+      <pre><code>config.active_record.query_log_tags = <%= (Rails.application.config.active_record.query_log_tags.to_a + [ :job ]).inspect %></code></pre>
+    </article>
+  <% else %>
+    <article aria-label="No jobs have run yet">
+      <header>No job has run since statistics were last collected</header>
+      <p>
+        Query log tags include <code>:job</code> and pg_stat_statements is
+        collecting, so this page is working &mdash; 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 %>
+  <input type="search"
+         placeholder="filter jobs… (press / to focus)"
+         data-filter-input
+         data-filter-noun="job"
+         autofocus
+         autocomplete="off">
+  <p class="dim" data-filter-count></p>
+
+  <%= render "pg_peek/reports/report",
+             report: @report,
+             link_column: :job_class,
+             link: ->(row) { database_job_path(@database, ERB::Util.url_encode(row["job_class"])) } %>
+
+  <p class="dim" data-filter-empty hidden>No jobs match that filter.</p>
+<% end %>

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

@@ -0,0 +1,17 @@
+<div class="toolbar">
+  <h1><%= @job_class %></h1>
+  <%= link_to "← jobs", database_jobs_path(@database) %>
+</div>
+
+<% if @report.empty? %>
+  <article aria-label="No queries found">
+    <header>No queries found for this job</header>
+    <p>This could mean:</p>
+    <ul>
+      <li>The job hasn't executed any database queries since statistics were last reset</li>
+      <li>The job's queries are not among the top outliers</li>
+    </ul>
+  </article>
+<% else %>
+  <%= render "pg_peek/reports/report", report: @report %>
+<% end %>

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

@@ -0,0 +1,17 @@
+<article aria-label="Extension pg_stat_statements is not preloaded">
+  <header>pg_stat_statements is not loaded</header>
+  <p>
+    The extension is installed on <strong><%= database.name %></strong>, but the module was not
+    loaded when the server started, so it collects no statistics and its views cannot be queried.
+  </p>
+  <p>Add it to <code>postgresql.conf</code>:</p>
+  <pre><code>shared_preload_libraries = 'pg_stat_statements'</code></pre>
+  <p>Or set it without editing the file by hand:</p>
+  <pre><code>ALTER SYSTEM SET shared_preload_libraries = 'pg_stat_statements';</code></pre>
+  <footer>
+    <small>
+      A server restart is required — this setting cannot be reloaded.
+      Currently loaded: <code><%= pg_stat_statements.shared_preload_libraries.presence || "(none)" %></code>
+    </small>
+  </footer>
+</article>

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

@@ -0,0 +1,5 @@
+<h1>pg_stat_statements</h1>
+
+<%= render "pg_peek/pg_stat_statements/preload_instructions",
+           database: @database,
+           pg_stat_statements: @pg_stat_statements %>

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

@@ -0,0 +1,10 @@
+<div class="toolbar">
+  <h1>queries</h1>
+  <small class="dim"><%= stats_since_link(@database, @pg_stat_statements.reset_at) %></small>
+</div>
+
+<% if @queries.empty? %>
+  <p class="dim">No statements recorded since the last reset.</p>
+<% else %>
+  <%= render "pg_peek/reports/report", report: @queries %>
+<% end %>

data/app/views/pg_peek/reports/_report.html.erb

@@ -0,0 +1,32 @@
+<%# Draws any report. Pass columns: [keys], rows: [subset] and/or limit: n to show a projection. %>
+<% columns = local_assigns[:columns] ? report.columns.select { |c| local_assigns[:columns].include?(c.key) } : report.columns %>
+<% rows = local_assigns[:rows] || report.rows %>
+<% rows = rows.first(local_assigns[:limit]) if local_assigns[:limit] %>
+<div class="scroll">
+  <table>
+    <thead>
+      <tr>
+        <% columns.each do |column| %>
+          <th class="<%= cell_class(column) %>" <%= "title=#{column.title.inspect}".html_safe if column.title %>>
+            <%= column.header %>
+          </th>
+        <% end %>
+      </tr>
+    </thead>
+    <tbody>
+      <% rows.each do |row| %>
+        <tr <%= "data-filter-value=#{row.value(report.columns.first).to_s.downcase.inspect}".html_safe %>>
+          <% columns.each do |column| %>
+            <td class="<%= cell_class(column) %>">
+              <% if local_assigns[:link] && column.key == local_assigns[:link_column] %>
+                <%= link_to format_cell(report, column, row), local_assigns[:link].call(row) %>
+              <% else %>
+                <%= format_cell(report, column, row) %>
+              <% end %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

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

@@ -0,0 +1,128 @@
+<div class="toolbar">
+  <h1><%= @table.name %></h1>
+  <%= link_to "← tables", database_path(@database, anchor: "tables") %>
+</div>
+
+<% seconds_elapsed = @table.seconds_since_reset %>
+
+<section>
+  <h2>cache performance</h2>
+  <table>
+    <tbody>
+      <tr>
+        <th>heap cache hit</th>
+        <td><%= format_percentage(@table.heap_cache_hit_ratio) %></td>
+      </tr>
+      <tr>
+        <th>index cache hit</th>
+        <td><%= format_percentage(@table.index_cache_hit_ratio) %></td>
+      </tr>
+      <tr>
+        <th>toast cache hit</th>
+        <td><%= format_percentage(@table.toast_cache_hit_ratio) %></td>
+      </tr>
+      <tr>
+        <th>toast index cache hit</th>
+        <td><%= format_percentage(@table.toast_index_cache_hit_ratio) %></td>
+      </tr>
+    </tbody>
+  </table>
+</section>
+
+<section>
+  <h2>row activity</h2>
+  <table>
+    <tbody>
+      <tr>
+        <th>estimated rows</th>
+        <td><%= format_number(@table.row_estimate) %></td>
+      </tr>
+      <tr>
+        <th>sequential scans</th>
+        <td>
+          <%= format_number(@table.seq_scan) %>
+          <% if @table.seq_scan_percentage %><span class="dim">(<%= @table.seq_scan_percentage %>%)</span><% end %>
+        </td>
+      </tr>
+      <tr>
+        <th>index scans</th>
+        <td>
+          <%= format_number(@table.idx_scan) %>
+          <% if @table.idx_scan_percentage %><span class="dim">(<%= @table.idx_scan_percentage %>%)</span><% end %>
+        </td>
+      </tr>
+      <tr>
+        <th>index usage</th>
+        <td><%= format_percentage(@table.index_usage_percentage) %></td>
+      </tr>
+      <tr>
+        <th>rows fetched</th>
+        <td><%= format_count_with_rate(@table.rows_fetched, seconds_elapsed) %></td>
+      </tr>
+      <tr>
+        <th>rows inserted</th>
+        <td><%= format_count_with_rate(@table.rows_inserted, seconds_elapsed) %></td>
+      </tr>
+      <tr>
+        <th>rows updated</th>
+        <td><%= format_count_with_rate(@table.rows_updated, seconds_elapsed) %></td>
+      </tr>
+      <tr>
+        <th>rows deleted</th>
+        <td><%= format_count_with_rate(@table.rows_deleted, seconds_elapsed) %></td>
+      </tr>
+      <tr>
+        <th>live tuples</th>
+        <td><%= format_number(@table.live_tuples) %></td>
+      </tr>
+      <tr>
+        <th>dead tuples</th>
+        <td>
+          <%= format_number(@table.dead_tuples) %>
+          <% if @table.dead_tuple_ratio %><span class="dim">(<%= @table.dead_tuple_ratio %>% of total)</span><% end %>
+          <% if @table.dead_tuple_warning? %><br><span class="warn">consider running VACUUM</span><% end %>
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</section>
+
+<section>
+  <h2>maintenance</h2>
+  <table>
+    <tbody>
+      <tr>
+        <th>last vacuum</th>
+        <td><%= format_time_ago(@table.last_vacuum) %></td>
+      </tr>
+      <tr>
+        <th>last autovacuum</th>
+        <td><%= format_time_ago(@table.last_autovacuum) %></td>
+      </tr>
+      <tr>
+        <th>last analyze</th>
+        <td><%= format_time_ago(@table.last_analyze) %></td>
+      </tr>
+      <tr>
+        <th>last autoanalyze</th>
+        <td><%= format_time_ago(@table.last_autoanalyze) %></td>
+      </tr>
+      <tr>
+        <th>vacuum count</th>
+        <td><%= format_number(@table.vacuum_count) %></td>
+      </tr>
+      <tr>
+        <th>autovacuum count</th>
+        <td><%= format_number(@table.autovacuum_count) %></td>
+      </tr>
+      <tr>
+        <th>analyze count</th>
+        <td><%= format_number(@table.analyze_count) %></td>
+      </tr>
+      <tr>
+        <th>autoanalyze count</th>
+        <td><%= format_number(@table.autoanalyze_count) %></td>
+      </tr>
+    </tbody>
+  </table>
+</section>

data/config/routes.rb

@@ -0,0 +1,16 @@
+PgPeek::Engine.routes.draw do
+  resources :databases, only: [ :index, :show ] do
+    resources :queries, only: [ :index ]
+    resources :tables, only: [ :show ], param: :name
+    resources :endpoints, only: [ :index ]
+    resources :indexes, only: [ :index ]
+    resource :activity, only: [ :show ], controller: "activity"
+    resources :jobs, only: [ :index, :show ], param: :job_class
+
+    resource :pg_stat_statements, only: [] do
+      delete :reset
+    end
+  end
+
+  root to: "databases#home"
+end

data/lib/generators/pg_peek/install/install_generator.rb

@@ -0,0 +1,40 @@
+module PgPeek
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates a PgPeek initializer and mounts the engine."
+
+      class_option :skip_routes, type: :boolean, default: false,
+        desc: "Don't mount the engine in config/routes.rb"
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/pg_peek.rb"
+      end
+
+      def mount_engine
+        return if options[:skip_routes]
+
+        if engine_mounted?
+          say_status :identical, "config/routes.rb (PgPeek::Engine already mounted)", :blue
+          return
+        end
+
+        route %(mount PgPeek::Engine, at: "/pg_peek")
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
+      private
+        # Rails' route action appends unconditionally, so re-running the
+        # generator would mount the engine a second time.
+        def engine_mounted?
+          routes = File.join(destination_root, "config/routes.rb")
+
+          File.exist?(routes) && File.read(routes).include?("PgPeek::Engine")
+        end
+    end
+  end
+end

data/lib/generators/pg_peek/install/templates/README

@@ -0,0 +1,31 @@
+===============================================================================
+
+PgPeek has been installed and mounted at /pg_peek.
+
+Next steps:
+
+1. Map your databases to their ActiveRecord classes in
+   config/initializers/pg_peek.rb:
+
+     config.connections = { "primary" => "ApplicationRecord" }
+
+   Every database you want to inspect needs an entry, or it will not be listed.
+
+2. Visit /pg_peek to view your PostgreSQL databases
+
+Before deploying:
+
+   pg_peek exposes your schema, every normalized query in the database, and an
+   endpoint that resets query statistics. Outside development and test it
+   refuses to serve until you say how it is protected.
+
+   Give it credentials, and it will ask for them:
+
+     PG_PEEK_USERNAME=... PG_PEEK_PASSWORD=...
+
+   Or, if you mount it behind authentication you already have, say so in
+   config/initializers/pg_peek.rb:
+
+     config.public_dashboard = true
+
+===============================================================================

data/lib/generators/pg_peek/install/templates/initializer.rb

@@ -0,0 +1,38 @@
+# PgPeek configuration
+# See https://github.com/trix/pg_peek for more information.
+
+Rails.application.config.pg_peek.tap do |config|
+  # Authentication.
+  #
+  # Outside development and test, pg_peek refuses to serve until it knows how it
+  # is protected. Give it credentials with PG_PEEK_USERNAME / PG_PEEK_PASSWORD or
+  # a pg_peek: entry in credentials.yml.enc and it asks for them over HTTP basic.
+  # Credentials, once set, apply in every environment -- including a development
+  # server exposed through a tunnel.
+  #
+  # If you mount the engine behind your own authentication instead, say so:
+  # config.public_dashboard = true
+
+  # Database connections mapping.
+  # Maps database names (from database.yml) to their ActiveRecord base class.
+  config.connections = {
+    "primary" => "ApplicationRecord"
+  }
+
+  # Tables to exclude from the tables list.
+  # Supports strings and regular expressions.
+  config.excluded_tables = %w[schema_migrations ar_internal_metadata]
+
+  # Maximum number of outlier queries to display.
+  # config.outliers_limit = 20
+
+  # Dead tuple ratio threshold (percentage) for warnings.
+  # config.dead_tuple_warning_threshold = 10
+
+  # A query running longer than this is called out on the overview.
+  # config.long_query_warning_seconds = 5
+
+  # A session idle in transaction longer than this holds locks and blocks
+  # vacuum, and is called out on the overview.
+  # config.idle_in_transaction_warning_seconds = 60
+end