pg_peek 0.1.0

data/lib/pg_peek/configuration.rb

@@ -0,0 +1,59 @@
+module PgPeek
+  class Configuration
+    DEFAULT_EXCLUDED_TABLES = %w[schema_migrations ar_internal_metadata].freeze
+    DEFAULT_DEAD_TUPLE_WARNING_THRESHOLD = 10 # percentage
+    DEFAULT_OUTLIERS_LIMIT = 20
+    DEFAULT_CACHE_HIT_WARNING_THRESHOLD = 99 # percentage
+    DEFAULT_LONG_QUERY_WARNING_SECONDS = 5
+    DEFAULT_IDLE_IN_TRANSACTION_WARNING_SECONDS = 60
+
+    attr_accessor :connections, :excluded_tables, :dead_tuple_warning_threshold, :outliers_limit,
+                  :cache_hit_warning_threshold, :long_query_warning_seconds,
+                  :idle_in_transaction_warning_seconds, :public_dashboard
+    attr_writer :username, :password
+
+    def initialize
+      @connections = {}
+      @excluded_tables = DEFAULT_EXCLUDED_TABLES.dup
+      @dead_tuple_warning_threshold = DEFAULT_DEAD_TUPLE_WARNING_THRESHOLD
+      @outliers_limit = DEFAULT_OUTLIERS_LIMIT
+      @cache_hit_warning_threshold = DEFAULT_CACHE_HIT_WARNING_THRESHOLD
+      @long_query_warning_seconds = DEFAULT_LONG_QUERY_WARNING_SECONDS
+      @idle_in_transaction_warning_seconds = DEFAULT_IDLE_IN_TRANSACTION_WARNING_SECONDS
+      @public_dashboard = false
+    end
+
+    def username
+      @username.presence || credential(:username) || ENV["PG_PEEK_USERNAME"].presence
+    end
+
+    def password
+      @password.presence || credential(:password) || ENV["PG_PEEK_PASSWORD"].presence
+    end
+
+    def credentials?
+      username.present? && password.present?
+    end
+
+    # Reading credentials raises when the application has none set up at all,
+    # which is not a configuration error for anyone using the ENV variables.
+    def credential(key)
+      Rails.application.try(:credentials)&.dig(:pg_peek, key).presence
+    rescue StandardError
+      nil
+    end
+
+    def connection_class_for(database_name)
+      class_name = @connections[database_name]
+      unless class_name
+        Rails.logger.warn "[PgPeek] No connection configured for database '#{database_name}'. " \
+                          "Add it to config.pg_peek.connections"
+        return nil
+      end
+      class_name.constantize
+    rescue NameError => e
+      Rails.logger.warn "[PgPeek] Could not find connection class '#{class_name}': #{e.message}"
+      nil
+    end
+  end
+end

data/lib/pg_peek/engine.rb

@@ -0,0 +1,7 @@
+module PgPeek
+  class Engine < ::Rails::Engine
+    isolate_namespace PgPeek
+
+    config.pg_peek = Configuration.new
+  end
+end

data/lib/pg_peek/query_loader.rb

@@ -0,0 +1,59 @@
+module PgPeek
+  class QueryLoader
+    # Every statement pg_peek issues ends with this, so the statistics queries
+    # can leave the engine's own cost out of what they report. It has to be a
+    # trailing comment: pg_stat_statements stores a statement from its first
+    # token, so a leading comment is dropped, while trailing text is kept --
+    # which is also why Rails' SQLcommenter tags survive.
+    MARKER = "/* pg_peek */".freeze
+
+    class << self
+      def load(path, pg_version:, **variables)
+        sql = read_file(path, pg_version)
+        mark(interpolate(sql, variables))
+      end
+
+      def mark(sql)
+        # Only a marker at the end counts: the statistics queries mention the
+        # marker inside their own exclusion filter.
+        return sql if sql.rstrip.end_with?(MARKER)
+
+        # A trailing semicolon would end the statement before the comment.
+        "#{sql.rstrip.chomp(";")} #{MARKER}"
+      end
+
+      private
+
+      def read_file(path, pg_version)
+        full_path = Engine.root.join("app/queries/pg_peek", "pg#{pg_version}", "#{path}.sql")
+
+        if Rails.env.production?
+          cache[full_path] ||= File.read(full_path)
+        else
+          File.read(full_path)
+        end
+      end
+
+      def cache
+        @cache ||= {}
+      end
+
+      def interpolate(sql, variables)
+        result = sql.dup
+
+        # Handle {{placeholders:key}} - expands to $1, $2, ..., $n
+        result = result.gsub(/\{\{placeholders:(\w+)\}\}/) do
+          count = variables[::Regexp.last_match(1).to_sym].to_i
+          (1..count).map { |i| "$#{i}" }.join(", ")
+        end
+
+        # Handle simple {{key}} replacements
+        variables.each do |key, value|
+          result = result.gsub("{{#{key}}}", value.to_s)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/pg_peek/version.rb

@@ -0,0 +1,3 @@
+module PgPeek
+  VERSION = "0.1.0"
+end

data/lib/pg_peek.rb

@@ -0,0 +1,10 @@
+require "pg_peek/version"
+require "pg_peek/configuration"
+require "pg_peek/query_loader"
+require "pg_peek/engine"
+
+module PgPeek
+  def self.config
+    Rails.application.config.pg_peek
+  end
+end

data/lib/tasks/pg_peek_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pg_peek do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: pg_peek
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomasz Mazur
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Rails Engine that provides a web UI for monitoring and analyzing PostgreSQL
+  query performance. Mount pg_peek into your Rails application to introspect database
+  queries, analyze pg_stat_statements data, track Active Job queries, and parse SQLcommenter
+  tags for performance optimization.
+email:
+- tomasz.mazur@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/pg_peek/application.js
+- app/assets/stylesheets/pg_peek/application.css
+- app/controllers/pg_peek/activity_controller.rb
+- app/controllers/pg_peek/application_controller.rb
+- app/controllers/pg_peek/databases_controller.rb
+- app/controllers/pg_peek/endpoints_controller.rb
+- app/controllers/pg_peek/indexes_controller.rb
+- app/controllers/pg_peek/jobs_controller.rb
+- app/controllers/pg_peek/pg_stat_statements_controller.rb
+- app/controllers/pg_peek/queries_controller.rb
+- app/controllers/pg_peek/tables_controller.rb
+- app/helpers/pg_peek/application_helper.rb
+- app/helpers/pg_peek/report_helper.rb
+- app/jobs/pg_peek/application_job.rb
+- app/mailers/pg_peek/application_mailer.rb
+- app/models/pg_peek/application_record.rb
+- 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/table.rb
+- app/queries/pg_peek/pg14/activity/sessions.sql
+- app/queries/pg_peek/pg14/activity/summary.sql
+- app/queries/pg_peek/pg14/activity/waiting_locks.sql
+- app/queries/pg_peek/pg14/database/vitals.sql
+- app/queries/pg_peek/pg14/indexes/all.sql
+- app/queries/pg_peek/pg14/pg_stat_statements/endpoints.sql
+- app/queries/pg_peek/pg14/pg_stat_statements/jobs.sql
+- app/queries/pg_peek/pg14/pg_stat_statements/outliers.sql
+- app/queries/pg_peek/pg14/pg_stat_statements/outliers_by_job.sql
+- app/queries/pg_peek/pg14/tables/dead_tuples.sql
+- app/queries/pg_peek/pg14/tables/inline_stats.sql
+- app/queries/pg_peek/pg14/tables/stats.sql
+- app/queries/pg_peek/pg15/activity/sessions.sql
+- app/queries/pg_peek/pg15/activity/summary.sql
+- app/queries/pg_peek/pg15/activity/waiting_locks.sql
+- app/queries/pg_peek/pg15/database/vitals.sql
+- app/queries/pg_peek/pg15/indexes/all.sql
+- app/queries/pg_peek/pg15/pg_stat_statements/endpoints.sql
+- app/queries/pg_peek/pg15/pg_stat_statements/jobs.sql
+- app/queries/pg_peek/pg15/pg_stat_statements/outliers.sql
+- app/queries/pg_peek/pg15/pg_stat_statements/outliers_by_job.sql
+- app/queries/pg_peek/pg15/tables/dead_tuples.sql
+- app/queries/pg_peek/pg15/tables/inline_stats.sql
+- app/queries/pg_peek/pg15/tables/stats.sql
+- app/queries/pg_peek/pg16/activity/sessions.sql
+- app/queries/pg_peek/pg16/activity/summary.sql
+- app/queries/pg_peek/pg16/activity/waiting_locks.sql
+- app/queries/pg_peek/pg16/database/vitals.sql
+- app/queries/pg_peek/pg16/indexes/all.sql
+- app/queries/pg_peek/pg16/pg_stat_statements/endpoints.sql
+- app/queries/pg_peek/pg16/pg_stat_statements/jobs.sql
+- app/queries/pg_peek/pg16/pg_stat_statements/outliers.sql
+- app/queries/pg_peek/pg16/pg_stat_statements/outliers_by_job.sql
+- app/queries/pg_peek/pg16/tables/dead_tuples.sql
+- app/queries/pg_peek/pg16/tables/inline_stats.sql
+- app/queries/pg_peek/pg16/tables/stats.sql
+- app/queries/pg_peek/pg17/activity/sessions.sql
+- app/queries/pg_peek/pg17/activity/summary.sql
+- app/queries/pg_peek/pg17/activity/waiting_locks.sql
+- app/queries/pg_peek/pg17/database/vitals.sql
+- app/queries/pg_peek/pg17/indexes/all.sql
+- app/queries/pg_peek/pg17/pg_stat_statements/endpoints.sql
+- app/queries/pg_peek/pg17/pg_stat_statements/jobs.sql
+- app/queries/pg_peek/pg17/pg_stat_statements/outliers.sql
+- app/queries/pg_peek/pg17/pg_stat_statements/outliers_by_job.sql
+- app/queries/pg_peek/pg17/tables/dead_tuples.sql
+- app/queries/pg_peek/pg17/tables/inline_stats.sql
+- app/queries/pg_peek/pg17/tables/stats.sql
+- app/queries/pg_peek/pg18/activity/sessions.sql
+- app/queries/pg_peek/pg18/activity/summary.sql
+- app/queries/pg_peek/pg18/activity/waiting_locks.sql
+- app/queries/pg_peek/pg18/database/vitals.sql
+- app/queries/pg_peek/pg18/indexes/all.sql
+- app/queries/pg_peek/pg18/pg_stat_statements/endpoints.sql
+- app/queries/pg_peek/pg18/pg_stat_statements/jobs.sql
+- app/queries/pg_peek/pg18/pg_stat_statements/outliers.sql
+- app/queries/pg_peek/pg18/pg_stat_statements/outliers_by_job.sql
+- app/queries/pg_peek/pg18/tables/dead_tuples.sql
+- app/queries/pg_peek/pg18/tables/inline_stats.sql
+- app/queries/pg_peek/pg18/tables/stats.sql
+- app/reports/pg_peek/column.rb
+- app/reports/pg_peek/report.rb
+- app/reports/pg_peek/reports/blocked.rb
+- app/reports/pg_peek/reports/databases.rb
+- app/reports/pg_peek/reports/endpoints.rb
+- app/reports/pg_peek/reports/indexes.rb
+- app/reports/pg_peek/reports/job_queries.rb
+- app/reports/pg_peek/reports/jobs.rb
+- app/reports/pg_peek/reports/queries.rb
+- app/reports/pg_peek/reports/sessions.rb
+- app/reports/pg_peek/reports/tables.rb
+- app/views/layouts/pg_peek/application.html.erb
+- app/views/pg_peek/activity/show.html.erb
+- app/views/pg_peek/authentication_required.html.erb
+- app/views/pg_peek/databases/index.html.erb
+- app/views/pg_peek/databases/show.html.erb
+- app/views/pg_peek/endpoints/index.html.erb
+- app/views/pg_peek/indexes/index.html.erb
+- app/views/pg_peek/jobs/index.html.erb
+- 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/queries/index.html.erb
+- app/views/pg_peek/reports/_report.html.erb
+- app/views/pg_peek/tables/show.html.erb
+- config/routes.rb
+- lib/generators/pg_peek/install/install_generator.rb
+- lib/generators/pg_peek/install/templates/README
+- lib/generators/pg_peek/install/templates/initializer.rb
+- lib/pg_peek.rb
+- lib/pg_peek/configuration.rb
+- lib/pg_peek/engine.rb
+- lib/pg_peek/query_loader.rb
+- lib/pg_peek/version.rb
+- lib/tasks/pg_peek_tasks.rake
+homepage: https://github.com/trix/pg_peek
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/trix/pg_peek
+  source_code_uri: https://github.com/trix/pg_peek
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: PostgreSQL query performance monitoring for Rails applications
+test_files: []