pg_monitor 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c4c7d58e46ed8ee3d95495bb02fc8476bbc38b6f58e00f372b685b69691f37c
-  data.tar.gz: f59c2029bb6a99e861c65702ab590fdc6980e9b46eca30186629165da1b43e94
+  metadata.gz: b6771bf4e358737710bbdfc1618a2c249a1c62f20dde4b245bd12a55156ef65f
+  data.tar.gz: a80e060c2b717966d0b873c144e56b12bdb97f27f47953bdd237e6263e151495
 SHA512:
-  metadata.gz: e5480cd130a99bd63468032c7cfbb45ce012b89fabbaba67495eaa418a723b08eec1b0ee67765447b84bad37211f1185d78b10244fb5f78bd46d05baaa937f34
-  data.tar.gz: d2a72a77da40a346dee9edc1e573c9c668dce9a291e7edb043a2e4c13e05db1518aa3dc70ec65b0868a8e20bb6f12f4b0d0a700b5b60f86b78ce86cf6f712f8c
+  metadata.gz: acfd32102a43294fe20a7971a608f19227a34790caab53bc2b54b8f36c4cc08f31cee5436ca26f1a27b2e493309e18aca73c7a6031e6967bb403229b11b9ceac
+  data.tar.gz: 3fe3429f7c64b0503863acba9d590cc69935bf3e39ff4bf49947662931d95e6258b3fda56117fe77d28bbbd965470c1754fabf87f08e8f6b224a803d422154e6

data/README.md

@@ -7,8 +7,8 @@ It would integrate seamlessly with a Rails application in the future, and would
 
 - View index usage statistics (last used, scan count, etc.)
 - Identify slow queries using `pg_stat_statements`
-- Works with the existing Rails database configuration
-- [TBD] Provides a simple HTML interface for monitoring
+- Works with existing Rails database configuration, if present
+- Provides a simple HTML interface for monitoring
 
 ## Installation
 
@@ -59,17 +59,19 @@ Execute the above SQL query by connecting to your database using `psql` or any o
 
 ## Usage
 
-Mount the engine in `config/routes.rb`:
+To run the PgMonitor, follow these steps:
 
-```ruby
-mount PgMonitor::Engine, at: '/pg_monitor'
-```
+1. Ensure you have all the dependencies installed:
+    ```sh
+    bundle install
+    ```
 
-Then, navigate to:
+2. Run the server using the Rake task:
+    ```sh
+    rake server
+    ```
 
-```
-http://localhost:3000/pg_monitor
-```
+3. The application should now be running. You can access it in your web browser at `http://localhost:4567`.
 
 ### Programmatic Access
 
@@ -83,6 +85,16 @@ PgMonitor::IndexUsage.fetch
 PgMonitor::SlowQueries.fetch(limit: 10)
 ```
 
+### **User Table Stats**
+```ruby
+PgMonitor::UserTables.fetch
+```
+
+### **Pg Locks**
+```ruby
+PgMonitor::PgLocks.fetch
+```
+
 ## Running Tests
 
 ### **1. Start PostgreSQL in Docker**

data/Rakefile

@@ -8,3 +8,10 @@ RSpec::Core::RakeTask.new(:spec)
 require "standard/rake"
 
 task default: %i[spec standard]
+
+require_relative "lib/pg_monitor/web_app"
+
+desc "Start the PgMonitor web application"
+task :server do
+  PgMonitorApp.run!
+end

data/lib/pg_monitor/index_usage.rb

@@ -7,13 +7,15 @@ module PgMonitor
     def fetch
       query = <<~SQL
         SELECT 
-          pg_class.relname AS table_name,
+          relname AS table_name,
           indexrelname AS index_name,
           idx_scan AS index_scan_count,
           idx_tup_read AS tuples_read,
-          idx_tup_fetch AS tuples_fetched
-        FROM pg_stat_all_indexes
-        JOIN pg_class ON pg_stat_all_indexes.relid = pg_class.oid
+          idx_tup_fetch AS tuples_fetched,
+          last_idx_scan AS last_index_scan,
+          pg_size_pretty(pg_relation_size(indexrelid)) AS index_size,
+          pg_size_pretty(pg_total_relation_size(indexrelid)) AS total_index_size
+        FROM pg_stat_user_indexes
         ORDER BY idx_scan DESC;
       SQL
 

data/lib/pg_monitor/pg_locks.rb

@@ -0,0 +1,33 @@
+require_relative "db_connection"
+
+module PgMonitor
+  module PGLocks
+    module_function
+
+    def fetch
+      query = <<~SQL
+        SELECT 
+          locktype,
+          database,
+          relation,
+          page,
+          tuple,
+          virtualxid,
+          transactionid,
+          classid,
+          objid,
+          objsubid,
+          virtualtransaction,
+          pid,
+          mode,
+          granted,
+          fastpath,
+          waitstart
+        FROM pg_locks;
+      SQL
+
+      result = DBConnection.connection.exec(query)
+      result.map { |row| row }
+    end
+  end
+end

data/lib/pg_monitor/user_tables.rb

@@ -0,0 +1,38 @@
+require_relative "db_connection"
+
+module PgMonitor
+  module UserTables
+    module_function
+
+    def fetch
+      query = <<~SQL
+        SELECT 
+          relname AS table_name,
+          seq_scan,
+          last_seq_scan,
+          seq_tup_read,
+          idx_scan,
+          last_idx_scan,
+          idx_tup_fetch,
+          n_tup_ins,
+          n_tup_upd,
+          n_tup_del,
+          n_live_tup,
+          n_dead_tup,
+          last_vacuum,
+          last_autovacuum,
+          last_analyze,
+          last_autoanalyze,
+          vacuum_count,
+          autovacuum_count,
+          analyze_count,
+          autoanalyze_count
+        FROM pg_stat_user_tables
+        ORDER BY relname;
+      SQL
+
+      result = DBConnection.connection.exec(query)
+      result.map { |row| row }
+    end
+  end
+end

data/lib/pg_monitor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgMonitor
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/pg_monitor/views/index.erb

@@ -0,0 +1,56 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PgMonitor</title>
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css">
+  <script>
+    function showTab(tabId) {
+      document.querySelectorAll('.tab').forEach(tab => {
+        tab.classList.remove('active');
+      });
+      document.getElementById(tabId).classList.add('active');
+    }
+  </script>
+  <style>
+    .tab {
+      display: none;
+    }
+    .tab.active {
+      display: block;
+    }
+    body {
+      padding: 10px;
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <div class="btn-group tab-buttons" role="group">
+      <button type="button" class="btn btn-primary" onclick="showTab('index-usage')">Index Usage</button>
+      <button type="button" class="btn btn-secondary" onclick="showTab('slow-queries')">Slow Queries</button>
+      <button type="button" class="btn btn-secondary" onclick="showTab('user-tables')">User Tables</button>
+      <button type="button" class="btn btn-secondary" onclick="showTab('locks')">Locks</button>
+    </div>
+
+    <div id="index-usage" class="tab active">
+      <h1>Index Usage Statistics</h1>
+      <%= erb :index_usage_table, layout: false, locals: { index_usage: @index_usage } %>
+    </div>
+
+    <div id="slow-queries" class="tab">
+      <h1>Slow Queries</h1>
+      <%= erb :slow_queries_table, layout: false, locals: { slow_queries: @slow_queries } %>
+    </div>
+
+    <div id="user-tables" class="tab">
+      <h1>User Tables Statistics</h1>
+      <%= erb :user_tables_table, layout: false, locals: { user_tables: @user_tables } %>
+    </div>
+
+    <div id="locks" class="tab">
+      <h1>Locks</h1>
+      <%= erb :locks_table, layout: false, locals: { locks: @locks } %>
+    </div>
+  </div>
+</body>
+</html>

data/lib/pg_monitor/views/index_usage_table.erb

@@ -0,0 +1,28 @@
+<table class="table table-striped">
+  <thead class="thead-light">
+    <tr>
+      <th>Table Name</th>
+      <th>Index Name</th>
+      <th>Index Scan Count</th>
+      <th>Tuples Read</th>
+      <th>Tuples Fetched</th>
+      <th>Last Index Scan</th>
+      <th>Index Size</th>
+      <th>Total Index Size</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% index_usage.each do |row| %>
+      <tr>
+        <td><%= row["table_name"] %></td>
+        <td><%= row["index_name"] %></td>
+        <td><%= row["index_scan_count"] %></td>
+        <td><%= row["tuples_read"] %></td>
+        <td><%= row["tuples_fetched"] %></td>
+        <td><%= row["last_index_scan"] %></td>
+        <td><%= row["index_size"] %></td>
+        <td><%= row["total_index_size"] %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/pg_monitor/views/locks_table.erb

@@ -0,0 +1,44 @@
+<table class="table table-striped">
+  <thead class="thead-light">
+    <tr>
+      <th>Lock Type</th>
+      <th>Database</th>
+      <th>Relation</th>
+      <th>Page</th>
+      <th>Tuple</th>
+      <th>Virtual XID</th>
+      <th>Transaction ID</th>
+      <th>Class ID</th>
+      <th>Object ID</th>
+      <th>Object Sub ID</th>
+      <th>Virtual Transaction</th>
+      <th>PID</th>
+      <th>Mode</th>
+      <th>Granted</th>
+      <th>Fast Path</th>
+      <th>Wait Start</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @locks.each do |row| %>
+      <tr>
+        <td><%= row["locktype"] %></td>
+        <td><%= row["database"] %></td>
+        <td><%= row["relation"] %></td>
+        <td><%= row["page"] %></td>
+        <td><%= row["tuple"] %></td>
+        <td><%= row["virtualxid"] %></td>
+        <td><%= row["transactionid"] %></td>
+        <td><%= row["classid"] %></td>
+        <td><%= row["objid"] %></td>
+        <td><%= row["objsubid"] %></td>
+        <td><%= row["virtualtransaction"] %></td>
+        <td><%= row["pid"] %></td>
+        <td><%= row["mode"] %></td>
+        <td><%= row["granted"] %></td>
+        <td><%= row["fastpath"] %></td>
+        <td><%= row["waitstart"] %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/pg_monitor/views/slow_queries_table.erb

@@ -0,0 +1,35 @@
+<table class="table table-striped">
+  <thead class="thead-light">
+    <tr>
+      <th>Query</th>
+      <th>Calls</th>
+      <th>Total Time</th>
+      <th>Mean Time</th>
+      <th>Max Time</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% slow_queries.each do |row| %>
+      <tr>
+        <td>
+          <% full_query = row["query"] %>
+          <% if full_query.length > 100 %>
+            <span class="query-short" data-full-query="<%= ERB::Util.html_escape full_query %>">
+              <%= full_query[0, 100] %>...
+            </span>
+            <a href="#" class="show-more"
+               onclick="var el = this.previousElementSibling; el.textContent = el.getAttribute('data-full-query'); this.style.display='none'; return false;">
+              show more
+            </a>
+          <% else %>
+            <%= full_query %>
+          <% end %>
+        </td>
+        <td><%= row["calls"] %></td>
+        <td><%= row["total_time"] %></td>
+        <td><%= row["mean_time"] %></td>
+        <td><%= row["max_time"] %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/pg_monitor/views/user_tables_table.erb

@@ -0,0 +1,52 @@
+<table class="table table-striped">
+  <thead class="thead-light">
+    <tr>
+      <th>Table Name</th>
+      <th>Seq Scan</th>
+      <th>Last Seq Scan</th>
+      <th>Seq Tup Read</th>
+      <th>Idx Scan</th>
+      <th>Last Idx Scan</th>
+      <th>Idx Tup Fetch</th>
+      <th>Tuples Inserted</th>
+      <th>Tuples Updated</th>
+      <th>Tuples Deleted</th>
+      <th>Live Tuples</th>
+      <th>Dead Tuples</th>
+      <th>Last Vacuum</th>
+      <th>Last Autovacuum</th>
+      <th>Last Analyze</th>
+      <th>Last Autoanalyze</th>
+      <th>Vacuum Count</th>
+      <th>Autovacuum Count</th>
+      <th>Analyze Count</th>
+      <th>Autoanalyze Count</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% user_tables.each do |row| %>
+      <tr>
+        <td><%= row["table_name"] %></td>
+        <td><%= row["seq_scan"] %></td>
+        <td><%= row["last_seq_scan"] %></td>
+        <td><%= row["seq_tup_read"] %></td>
+        <td><%= row["idx_scan"] %></td>
+        <td><%= row["last_idx_scan"] %></td>
+        <td><%= row["idx_tup_fetch"] %></td>
+        <td><%= row["n_tup_ins"] %></td>
+        <td><%= row["n_tup_upd"] %></td>
+        <td><%= row["n_tup_del"] %></td>
+        <td><%= row["n_live_tup"] %></td>
+        <td><%= row["n_dead_tup"] %></td>
+        <td><%= row["last_vacuum"] %></td>
+        <td><%= row["last_autovacuum"] %></td>
+        <td><%= row["last_analyze"] %></td>
+        <td><%= row["last_autoanalyze"] %></td>
+        <td><%= row["vacuum_count"] %></td>
+        <td><%= row["autovacuum_count"] %></td>
+        <td><%= row["analyze_count"] %></td>
+        <td><%= row["autoanalyze_count"] %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/pg_monitor/web_app.rb

@@ -0,0 +1,17 @@
+require "sinatra"
+require_relative "db_connection"
+require_relative "index_usage"
+require_relative "slow_queries"
+require_relative "user_tables"
+require_relative "pg_locks"
+
+class PgMonitorApp < Sinatra::Base
+  get "/" do
+    @index_usage = PgMonitor::IndexUsage.fetch
+    @slow_queries = PgMonitor::SlowQueries.fetch(limit: 10)
+    @user_tables = PgMonitor::UserTables.fetch
+    @locks = PgMonitor::PGLocks.fetch
+
+    erb :index
+  end
+end

data/lib/pg_monitor.rb

@@ -5,6 +5,8 @@ require_relative "pg_monitor/version"
 require_relative "pg_monitor/db_connection"
 require_relative "pg_monitor/index_usage"
 require_relative "pg_monitor/slow_queries"
+require_relative "pg_monitor/user_tables"
+require_relative "pg_monitor/pg_locks"
 
 module PgMonitor
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Hassan Murtaza
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-08 00:00:00.000000000 Z
+date: 2025-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -43,8 +43,16 @@ files:
 - lib/pg_monitor.rb
 - lib/pg_monitor/db_connection.rb
 - lib/pg_monitor/index_usage.rb
+- lib/pg_monitor/pg_locks.rb
 - lib/pg_monitor/slow_queries.rb
+- lib/pg_monitor/user_tables.rb
 - lib/pg_monitor/version.rb
+- lib/pg_monitor/views/index.erb
+- lib/pg_monitor/views/index_usage_table.erb
+- lib/pg_monitor/views/locks_table.erb
+- lib/pg_monitor/views/slow_queries_table.erb
+- lib/pg_monitor/views/user_tables_table.erb
+- lib/pg_monitor/web_app.rb
 - postgresql.conf
 - sig/pg_monitor.rbs
 homepage: https://github.com/hmurtaza7/pg_monitor