pg_insights 0.1.0 → 0.2.0

data/config/routes.rb

@@ -1,14 +1,11 @@
 PgInsights::Engine.routes.draw do
   root "insights#index"
 
-  # For running queries and loading the main UI
   post "/", to: "insights#index"
-
-  # For the table name dropdown
   get :table_names, to: "insights#table_names"
 
-  # For managing user-saved queries
-  resources :queries, only: [ :create, :update, :destroy ]  # For the health dashboard
+  resources :queries, only: [ :create, :update, :destroy ]
+
   get :health, to: "health#index"
   namespace :health do
     get :unused_indexes
@@ -19,4 +16,11 @@ PgInsights::Engine.routes.draw do
     get :parameter_settings
     post :refresh
   end
+
+  get :timeline, to: "timeline#index"
+  get "timeline/compare", to: "timeline#compare", as: :timeline_compare
+  get "timeline/export", to: "timeline#export", as: :timeline_export
+  get "timeline/status", to: "timeline#status", as: :timeline_status
+  post "timeline/refresh", to: "timeline#refresh", as: :timeline_refresh
+  get "timeline/:id", to: "timeline#show", as: :timeline_show
 end

data/lib/generators/pg_insights/install_generator.rb

@@ -47,11 +47,28 @@ module PgInsights
         puts "Next steps:"
         puts "1. Run 'rails db:migrate' to create the necessary tables"
         puts "2. Review and customize 'config/initializers/pg_insights.rb'"
-        puts "3. Configure background jobs (optional, see initializer comments)"
-        puts "4. Visit '/pg_insights' in your browser to start using the dashboard"
+        puts "3. Test your setup: rails pg_insights:status"
+        puts "4. Configure background jobs (optional, see initializer comments)"
+        puts "5. Visit '/pg_insights' in your browser to start using the dashboard"
         puts ""
-        puts "For background job integration, see: config/initializers/pg_insights.rb"
-        puts "To check status: rails pg_insights:status"
+        puts "Features available:"
+        puts "• Health Dashboard: '/pg_insights/health' - Monitor database health"
+        puts "• Query Runner: '/pg_insights' - Run SQL queries with charts"
+        puts "• Timeline: '/pg_insights/timeline' - Track parameter changes over time"
+        puts ""
+        puts "Useful commands:"
+        puts "• Status check: rails pg_insights:status"
+        puts "• Test setup: rails pg_insights:test_jobs"
+        puts "• Collect snapshot: rails pg_insights:collect_snapshot"
+        puts "• Start snapshots: rails pg_insights:start_snapshots"
+        puts "• Snapshot status: rails pg_insights:snapshot_status"
+        puts ""
+        puts "For development/testing:"
+        puts "• Generate test data: rails pg_insights:seed_timeline"
+        puts "• View all commands: rails -T pg_insights"
+        puts ""
+        puts "Configuration: config/initializers/pg_insights.rb"
+        puts "Documentation: https://github.com/mezbahalam/pg_insights"
         puts "To uninstall: rails generate pg_insights:clean"
       end
 
@@ -81,7 +98,6 @@ module PgInsights
             config.background_job_queue = :pg_insights_health
 
             # === Cache and Timeout Settings ===
-          #{'  '}
             # How long to cache health check results before considering them stale
             # Stale results will trigger background refresh when accessed
             #
@@ -91,40 +107,75 @@ module PgInsights
             # Timeout for individual health check queries to prevent long-running queries
             # from blocking the application
             #
-            # Default: 10.seconds#{'  '}
+            # Default: 10.seconds
             config.health_check_timeout = 10.seconds
 
             # Maximum execution time for user queries in the insights interface
             #
             # Default: 30.seconds
             config.max_query_execution_time = 30.seconds
+
+            # === Timeline & Snapshot Settings ===
+            #
+            # The timeline feature captures daily snapshots of your database's
+            # performance metrics and configuration parameters.
+
+            # Enable or disable the timeline feature entirely.
+            # Disabling this will hide the timeline UI and stop snapshot collection.
+            #
+            # Default: true
+            config.enable_snapshots = true
+
+            # How often to collect a new database snapshot.
+            # This setting is used by the recurring snapshot job.
+            #
+            # Default: 1.day
+            config.snapshot_frequency = 1.day
+
+            # How long to keep snapshots before they are automatically deleted.
+            # Older snapshots will be pruned to save database space.
+            #
+            # Default: 90 (days)
+            config.snapshot_retention_days = 90
+
+            # A master switch to enable or disable the snapshot collection job.
+            # This is useful if you want to temporarily pause snapshot collection
+            # without disabling the entire feature.
+            #
+            # Default: true
+            config.snapshot_collection_enabled = true
           end
 
           # === Background Job Integration ===
           #
-          # If you want automatic recurring health checks, add one of these to your job scheduler:
+          # PgInsights works with or without background jobs:
+          # - WITH background jobs: Health checks run asynchronously (recommended)
+          # - WITHOUT background jobs: Health checks run synchronously (slower but works)
           #
-          # ** Whenever (crontab) **
-          # Add to config/schedule.rb:
+          # ** Test Your Setup **
+          # Check if background jobs are working:
+          #   rails pg_insights:status
+          #   rails pg_insights:test_jobs
+          #
+          # ** Automatic Recurring Health Checks (Optional) **
+          # If you want health checks to run automatically, add one of these to your job scheduler:
+          #
+          # Whenever (crontab) - Add to config/schedule.rb:
           #   every 1.hour do
           #     runner "PgInsights::RecurringHealthChecksJob.perform_later"
           #   end
           #
-          # ** Sidekiq-Cron **
-          # Add to config/initializers/sidekiq.rb:
+          # Sidekiq-Cron - Add to config/initializers/sidekiq.rb:
           #   Sidekiq::Cron::Job.create(
           #     name: 'PgInsights Health Checks',
           #     cron: '0 * * * *',
           #     class: 'PgInsights::RecurringHealthChecksJob'
           #   )
           #
-          # ** Manual Trigger **
-          # You can also trigger health checks manually:
-          #   PgInsights::HealthCheckService.refresh_all!
-          #
-          # ** Check Status **
-          # To verify your configuration:
-          #   rails pg_insights:status
+          # ** Manual Commands **
+          # Run health checks manually: rails pg_insights:health_check
+          # Collect snapshot now: rails pg_insights:collect_snapshot
+          # Start recurring snapshots: rails pg_insights:start_snapshots
 
           # === Environment-Specific Settings ===
           #

data/lib/pg_insights/version.rb

@@ -1,3 +1,3 @@
 module PgInsights
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/pg_insights.rb

@@ -2,25 +2,27 @@ require "pg_insights/version"
 require "pg_insights/engine"
 
 module PgInsights
-  # Configuration options
   mattr_accessor :enable_background_jobs, default: true
   mattr_accessor :health_cache_expiry, default: 5.minutes
   mattr_accessor :background_job_queue, default: :pg_insights_health
   mattr_accessor :max_query_execution_time, default: 30.seconds
   mattr_accessor :health_check_timeout, default: 10.seconds
 
+  mattr_accessor :enable_snapshots, default: true
+  mattr_accessor :snapshot_frequency, default: 1.day
+  mattr_accessor :snapshot_retention_days, default: 90
+  mattr_accessor :snapshot_collection_enabled, default: true
+
   def self.configure
     yield self
   end
 
-  # Check if background jobs are available and properly configured
   def self.background_jobs_available?
     return false unless enable_background_jobs
     return false unless defined?(ActiveJob::Base)
     return false if ActiveJob::Base.queue_adapter.is_a?(ActiveJob::QueueAdapters::InlineAdapter)
     return false unless defined?(PgInsights::HealthCheckJob)
 
-    # Verify the queue adapter can handle our jobs
     begin
       ActiveJob::Base.queue_adapter.respond_to?(:enqueue) ||
       ActiveJob::Base.queue_adapter.respond_to?(:enqueue_at)
@@ -30,7 +32,6 @@ module PgInsights
     end
   end
 
-  # Safely execute background jobs with fallback
   def self.execute_with_fallback(job_class, method_name, *args, &fallback_block)
     if background_jobs_available?
       begin
@@ -41,14 +42,30 @@ module PgInsights
       end
     end
 
-    # Execute fallback if provided
     fallback_block.call if fallback_block
     false
   end
 
-  # Integration helpers for host applications
+  def self.snapshots_available?
+    return false unless enable_snapshots
+    return false unless snapshot_collection_enabled
+    return false unless defined?(PgInsights::HealthCheckResult)
+
+    true
+  end
+
+  def self.snapshot_interval_seconds
+    case snapshot_frequency
+    when ActiveSupport::Duration
+      snapshot_frequency.to_i
+    when Integer
+      snapshot_frequency
+    else
+      1.day.to_i
+    end
+  end
+
   module Integration
-    # Helper for host apps to check if they need to configure anything
     def self.status
       {
         background_jobs_available: PgInsights.background_jobs_available?,
@@ -61,15 +78,12 @@ module PgInsights
       }
     end
 
-    # Helper for host apps to test job functionality
     def self.test_background_jobs
       return { success: false, error: "Background jobs disabled" } unless PgInsights.enable_background_jobs
       return { success: false, error: "ActiveJob not available" } unless defined?(ActiveJob::Base)
 
       begin
-        # Try to enqueue a simple test
         if defined?(PgInsights::HealthCheckJob)
-          # Don't actually run the job, just test enqueueing
           Rails.logger.info "PgInsights: Testing background job capability..."
           { success: true, message: "Background jobs appear to be working" }
         else