pg_monitor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa26f1ee15de860372c7ec2ad7304a2fe5d01fb5a934e76b192d301faef0657f
+  data.tar.gz: 2f1e2bba02213cd53e49502c2b5056963d0634e74125e342c8b1cd8e45a27a53
+SHA512:
+  metadata.gz: 40a373281b77a31c5551ea8ec7b1cfc78e26d191ffc8f6730dec67d5e0bb964c4c933ac97497f29a3b9c8ceb1b93b1761511e71c2b817e204b9f53cc48be626f
+  data.tar.gz: eb46b021df9b08fc7ff91663150173b476c9fa881a41e8a954e73617f965476b64db70d32cf1d6680abfc691fb3a4243cd24086a044b81320489bed1965e5d1e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-04
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby:3.2
+
+RUN apt-get update && apt-get install -y postgresql-client
+
+WORKDIR /app
+COPY . .
+
+RUN gem install bundler && bundle install
+
+CMD ["bash"]

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Hassan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# PgMonitor
+
+PgMonitor is a Ruby gem that provides insights into PostgreSQL database.
+It would integrate seamlessly with a Rails application in the future, and would expose statistics via a mounted route.
+
+## Features
+
+- View index usage statistics (last used, scan count, etc.)
+- Identify slow queries using `pg_stat_statements`
+- [TBD] Works with the existing Rails database configuration
+- [TBD] Provides a simple HTML interface for monitoring
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_monitor'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it manually:
+
+```sh
+gem install pg_monitor
+```
+
+## Configuration
+
+### Enable `pg_stat_statements`
+
+Ensure that `pg_stat_statements` is enabled in your **PostgreSQL configuration**.
+
+Modify `postgresql.conf`:
+
+```conf
+shared_preload_libraries = 'pg_stat_statements'
+pg_stat_statements.track = all
+track_activity_query_size = 2048
+```
+
+Restart PostgreSQL after making the changes:
+
+```sh
+sudo systemctl restart postgresql
+```
+
+## Usage
+
+Mount the engine in `config/routes.rb`:
+
+```ruby
+mount PgMonitor::Engine, at: '/pg_monitor'
+```
+
+Then, navigate to:
+
+```
+http://localhost:3000/pg_monitor
+```
+
+### Programmatic Access
+
+#### **Index Usage**
+```ruby
+PgMonitor::IndexUsage.fetch
+```
+
+#### **Slow Queries**
+```ruby
+PgMonitor::SlowQueries.fetch(limit: 10)
+```
+
+## Running Tests
+
+### **1. Start PostgreSQL in Docker**
+
+Ensure you have Docker installed, then start the database:
+
+```sh
+docker-compose up -d postgres
+```
+
+### **2. Run Tests**
+
+```sh
+docker-compose run --rm test-runner
+```
+
+Or directly using RSpec:
+
+```sh
+bundle exec rspec
+```
+
+## Contributing
+
+1. Fork the repo
+2. Create a feature branch (`git checkout -b my-feature`)
+3. Commit your changes (`git commit -m 'Add new feature'`)
+4. Push to the branch (`git push origin my-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License.
+
+## Author
+Created by [Hassan Murtaza](https://github.com/hmurtaza7).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/docker-compose.yml

@@ -0,0 +1,27 @@
+services:
+  postgres:
+    image: postgres:17
+    container_name: pg_monitor_test_db
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: pg_monitor_test
+    ports:
+      - "5432:5432"
+    volumes:
+      - ./postgresql.conf:/etc/postgresql.conf
+    command: ["postgres", "-c", "config_file=/etc/postgresql.conf"]
+
+  test-runner:
+    build: .
+    depends_on:
+      - postgres
+    environment:
+      PG_DATABASE: pg_monitor_test
+      PG_USER: postgres
+      PG_PASSWORD: password
+      PG_HOST: postgres
+      PG_PORT: 5432
+    volumes:
+      - .:/app
+    entrypoint: ["bash", "-c", "bundle exec rspec"]

data/lib/pg_monitor/db_connection.rb

@@ -0,0 +1,15 @@
+require "pg"
+
+module PgMonitor
+  class DBConnection
+    def self.connection
+      @connection ||= PG.connect(
+        dbname: ENV.fetch("PG_DATABASE", "pg_monitor_test"),
+        user: ENV.fetch("PG_USER", "postgres"),
+        password: ENV.fetch("PG_PASSWORD", "password"),
+        host: ENV.fetch("PG_HOST", "localhost"),
+        port: ENV.fetch("PG_PORT", "5432")
+      )
+    end
+  end
+end

data/lib/pg_monitor/index_usage.rb

@@ -0,0 +1,22 @@
+require_relative "db_connection"
+
+module PgMonitor
+  class IndexUsage
+    def fetch
+      query = <<~SQL
+        SELECT 
+          pg_class.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
+        ORDER BY idx_scan DESC;
+      SQL
+
+      result = DBConnection.connection.exec(query)
+      result.map { |row| row }
+    end
+  end
+end

data/lib/pg_monitor/slow_queries.rb

@@ -0,0 +1,22 @@
+require_relative "db_connection"
+
+module PgMonitor
+  class SlowQueries
+    def fetch(limit: 10)
+      query = <<~SQL
+        SELECT 
+          query, 
+          calls, 
+          total_exec_time AS total_time,
+          mean_exec_time AS mean_time,
+          max_exec_time AS max_time
+        FROM pg_stat_statements
+        ORDER BY mean_exec_time DESC
+        LIMIT $1;
+      SQL
+
+      result = DBConnection.connection.exec_params(query, [limit])
+      result.map { |row| row }
+    end
+  end
+end

data/lib/pg_monitor/version.rb

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

data/lib/pg_monitor.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "pg_monitor/version"
+
+require_relative "pg_monitor/db_connection"
+require_relative "pg_monitor/index_usage"
+require_relative "pg_monitor/slow_queries"
+
+module PgMonitor
+end

data/postgresql.conf

@@ -0,0 +1,5 @@
+# PostgreSQL Configuration for Testing
+listen_addresses = '*'
+shared_preload_libraries = 'pg_stat_statements'
+pg_stat_statements.track = all
+track_activity_query_size = 2048

data/sig/pg_monitor.rbs

@@ -0,0 +1,4 @@
+module PgMonitor
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: pg_monitor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hassan Murtaza
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Connects to PostgreSQL and retrieves few statistics such as index stats
+  and table bloats.
+email:
+- "...@gmail.com"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- Dockerfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- docker-compose.yml
+- lib/pg_monitor.rb
+- lib/pg_monitor/db_connection.rb
+- lib/pg_monitor/index_usage.rb
+- lib/pg_monitor/slow_queries.rb
+- lib/pg_monitor/version.rb
+- postgresql.conf
+- sig/pg_monitor.rbs
+homepage: https://github.com/hmurtaza7/pg_monitor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hmurtaza7/pg_monitor
+  source_code_uri: https://github.com/hmurtaza7/pg_monitor
+  changelog_uri: https://github.com/hmurtaza7/pg_monitor/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: A gem to view PostgreSQL statistics.
+test_files: []