rails_pulse 0.1.1 → 0.1.3

data/db/migrate/20241222000001_create_rails_pulse_summaries.rb

@@ -0,0 +1,54 @@
+class CreateRailsPulseSummaries < ActiveRecord::Migration[7.1]
+  def change
+    create_table :rails_pulse_summaries do |t|
+      # Time fields
+      t.datetime :period_start, null: false
+      t.datetime :period_end, null: false
+      t.string :period_type, null: false # 'hour', 'day', 'week', 'month'
+
+      # Polymorphic association to handle both routes and queries
+      t.references :summarizable, polymorphic: true, null: false, index: true
+      # This creates summarizable_type (e.g., 'RailsPulse::Route', 'RailsPulse::Query')
+      # and summarizable_id (route_id or query_id)
+
+      # Universal metrics
+      t.integer :count, default: 0, null: false
+      t.float :avg_duration
+      t.float :min_duration
+      t.float :max_duration
+      t.float :p50_duration
+      t.float :p95_duration
+      t.float :p99_duration
+      t.float :total_duration
+      t.float :stddev_duration
+
+      # Request/Route specific metrics
+      t.integer :error_count, default: 0
+      t.integer :success_count, default: 0
+      t.integer :status_2xx, default: 0
+      t.integer :status_3xx, default: 0
+      t.integer :status_4xx, default: 0
+      t.integer :status_5xx, default: 0
+
+      t.timestamps
+
+      # Unique constraint and indexes
+      t.index [ :summarizable_type, :summarizable_id, :period_type, :period_start ],
+              unique: true,
+              name: 'idx_pulse_summaries_unique'
+      t.index [ :period_type, :period_start ]
+      t.index :created_at
+    end
+
+    # Add indexes to existing tables for efficient aggregation
+    add_index :rails_pulse_requests, [ :created_at, :route_id ],
+              name: 'idx_requests_for_aggregation'
+    add_index :rails_pulse_requests, :created_at,
+              name: 'idx_requests_created_at'
+
+    add_index :rails_pulse_operations, [ :created_at, :query_id ],
+              name: 'idx_operations_for_aggregation'
+    add_index :rails_pulse_operations, :created_at,
+              name: 'idx_operations_created_at'
+  end
+end

data/db/migrate/20250916031656_add_analysis_to_rails_pulse_queries.rb

@@ -0,0 +1,13 @@
+class AddAnalysisToRailsPulseQueries < ActiveRecord::Migration[8.0]
+  def change
+    add_column :rails_pulse_queries, :analyzed_at, :datetime, comment: "When query analysis was last performed"
+    add_column :rails_pulse_queries, :explain_plan, :text, comment: "EXPLAIN output from actual SQL execution"
+    add_column :rails_pulse_queries, :issues, :text, comment: "JSON array of detected performance issues"
+    add_column :rails_pulse_queries, :metadata, :text, comment: "JSON object containing query complexity metrics"
+    add_column :rails_pulse_queries, :query_stats, :text, comment: "JSON object with query characteristics analysis"
+    add_column :rails_pulse_queries, :backtrace_analysis, :text, comment: "JSON object with call chain and N+1 detection"
+    add_column :rails_pulse_queries, :suggestions, :text, comment: "JSON array of optimization recommendations"
+    add_column :rails_pulse_queries, :index_recommendations, :text, comment: "JSON array of database index recommendations"
+    add_column :rails_pulse_queries, :n_plus_one_analysis, :text, comment: "JSON object with enhanced N+1 query detection results"
+  end
+end

data/db/rails_pulse_schema.rb

@@ -0,0 +1,130 @@
+# Rails Pulse Database Schema
+# This file contains the complete schema for Rails Pulse tables
+# Load with: rails db:schema:load:rails_pulse or db:prepare
+
+RailsPulse::Schema = lambda do |connection|
+  # Skip if all tables already exist to prevent conflicts
+  required_tables = [:rails_pulse_routes, :rails_pulse_queries, :rails_pulse_requests, :rails_pulse_operations, :rails_pulse_summaries]
+
+  if ENV["CI"] == "true"
+    existing_tables = required_tables.select { |table| connection.table_exists?(table) }
+    missing_tables = required_tables - existing_tables
+    puts "[RailsPulse::Schema] Existing tables: #{existing_tables.join(', ')}" if existing_tables.any?
+    puts "[RailsPulse::Schema] Missing tables: #{missing_tables.join(', ')}" if missing_tables.any?
+  end
+
+  return if required_tables.all? { |table| connection.table_exists?(table) }
+
+  connection.create_table :rails_pulse_routes do |t|
+    t.string :method, null: false, comment: "HTTP method (e.g., GET, POST)"
+    t.string :path, null: false, comment: "Request path (e.g., /posts/index)"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_routes, [ :method, :path ], unique: true, name: "index_rails_pulse_routes_on_method_and_path"
+
+  connection.create_table :rails_pulse_queries do |t|
+    t.string :normalized_sql, limit: 1000, null: false, comment: "Normalized SQL query string (e.g., SELECT * FROM users WHERE id = ?)"
+    t.datetime :analyzed_at, comment: "When query analysis was last performed"
+    t.text :explain_plan, comment: "EXPLAIN output from actual SQL execution"
+    t.text :issues, comment: "JSON array of detected performance issues"
+    t.text :metadata, comment: "JSON object containing query complexity metrics"
+    t.text :query_stats, comment: "JSON object with query characteristics analysis"
+    t.text :backtrace_analysis, comment: "JSON object with call chain and N+1 detection"
+    t.text :index_recommendations, comment: "JSON array of database index recommendations"
+    t.text :n_plus_one_analysis, comment: "JSON object with enhanced N+1 query detection results"
+    t.text :suggestions, comment: "JSON array of optimization recommendations"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_queries, :normalized_sql, unique: true, name: "index_rails_pulse_queries_on_normalized_sql", length: 191
+
+  connection.create_table :rails_pulse_requests do |t|
+    t.references :route, null: false, foreign_key: { to_table: :rails_pulse_routes }, comment: "Link to the route"
+    t.decimal :duration, precision: 15, scale: 6, null: false, comment: "Total request duration in milliseconds"
+    t.integer :status, null: false, comment: "HTTP status code (e.g., 200, 500)"
+    t.boolean :is_error, null: false, default: false, comment: "True if status >= 500"
+    t.string :request_uuid, null: false, comment: "Unique identifier for the request (e.g., UUID)"
+    t.string :controller_action, comment: "Controller and action handling the request (e.g., PostsController#show)"
+    t.timestamp :occurred_at, null: false, comment: "When the request started"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_requests, :occurred_at, name: "index_rails_pulse_requests_on_occurred_at"
+  connection.add_index :rails_pulse_requests, :request_uuid, unique: true, name: "index_rails_pulse_requests_on_request_uuid"
+  connection.add_index :rails_pulse_requests, [ :route_id, :occurred_at ], name: "index_rails_pulse_requests_on_route_id_and_occurred_at"
+
+  connection.create_table :rails_pulse_operations do |t|
+    t.references :request, null: false, foreign_key: { to_table: :rails_pulse_requests }, comment: "Link to the request"
+    t.references :query, foreign_key: { to_table: :rails_pulse_queries }, index: true, comment: "Link to the normalized SQL query"
+    t.string :operation_type, null: false, comment: "Type of operation (e.g., database, view, gem_call)"
+    t.string :label, null: false, comment: "Descriptive name (e.g., SELECT FROM users WHERE id = 1, render layout)"
+    t.decimal :duration, precision: 15, scale: 6, null: false, comment: "Operation duration in milliseconds"
+    t.string :codebase_location, comment: "File and line number (e.g., app/models/user.rb:25)"
+    t.float :start_time, null: false, default: 0.0, comment: "Operation start time in milliseconds"
+    t.timestamp :occurred_at, null: false, comment: "When the request started"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_operations, :operation_type, name: "index_rails_pulse_operations_on_operation_type"
+  connection.add_index :rails_pulse_operations, :occurred_at, name: "index_rails_pulse_operations_on_occurred_at"
+  connection.add_index :rails_pulse_operations, [ :query_id, :occurred_at ], name: "index_rails_pulse_operations_on_query_and_time"
+  connection.add_index :rails_pulse_operations, [ :query_id, :duration, :occurred_at ], name: "index_rails_pulse_operations_query_performance"
+  connection.add_index :rails_pulse_operations, [ :occurred_at, :duration, :operation_type ], name: "index_rails_pulse_operations_on_time_duration_type"
+
+  connection.create_table :rails_pulse_summaries do |t|
+    # Time fields
+    t.datetime :period_start, null: false, comment: "Start of the aggregation period"
+    t.datetime :period_end, null: false, comment: "End of the aggregation period"
+    t.string :period_type, null: false, comment: "Aggregation period type: hour, day, week, month"
+
+    # Polymorphic association to handle both routes and queries
+    t.references :summarizable, polymorphic: true, null: false, index: true, comment: "Link to Route or Query"
+    # This creates summarizable_type (e.g., 'RailsPulse::Route', 'RailsPulse::Query')
+    # and summarizable_id (route_id or query_id)
+
+    # Universal metrics
+    t.integer :count, default: 0, null: false, comment: "Total number of requests/operations"
+    t.float :avg_duration, comment: "Average duration in milliseconds"
+    t.float :min_duration, comment: "Minimum duration in milliseconds"
+    t.float :max_duration, comment: "Maximum duration in milliseconds"
+    t.float :p50_duration, comment: "50th percentile duration"
+    t.float :p95_duration, comment: "95th percentile duration"
+    t.float :p99_duration, comment: "99th percentile duration"
+    t.float :total_duration, comment: "Total duration in milliseconds"
+    t.float :stddev_duration, comment: "Standard deviation of duration"
+
+    # Request/Route specific metrics
+    t.integer :error_count, default: 0, comment: "Number of error responses (5xx)"
+    t.integer :success_count, default: 0, comment: "Number of successful responses"
+    t.integer :status_2xx, default: 0, comment: "Number of 2xx responses"
+    t.integer :status_3xx, default: 0, comment: "Number of 3xx responses"
+    t.integer :status_4xx, default: 0, comment: "Number of 4xx responses"
+    t.integer :status_5xx, default: 0, comment: "Number of 5xx responses"
+
+    t.timestamps
+  end
+
+  # Unique constraint and indexes for summaries
+  connection.add_index :rails_pulse_summaries, [ :summarizable_type, :summarizable_id, :period_type, :period_start ],
+          unique: true,
+          name: "idx_pulse_summaries_unique"
+  connection.add_index :rails_pulse_summaries, [ :period_type, :period_start ], name: "index_rails_pulse_summaries_on_period"
+  connection.add_index :rails_pulse_summaries, :created_at, name: "index_rails_pulse_summaries_on_created_at"
+
+  # Add indexes to existing tables for efficient aggregation
+  connection.add_index :rails_pulse_requests, [ :created_at, :route_id ], name: "idx_requests_for_aggregation"
+  connection.add_index :rails_pulse_requests, :created_at, name: "idx_requests_created_at"
+
+  connection.add_index :rails_pulse_operations, [ :created_at, :query_id ], name: "idx_operations_for_aggregation"
+  connection.add_index :rails_pulse_operations, :created_at, name: "idx_operations_created_at"
+
+  if ENV["CI"] == "true"
+    created_tables = required_tables.select { |table| connection.table_exists?(table) }
+    puts "[RailsPulse::Schema] Successfully created tables: #{created_tables.join(', ')}"
+  end
+end
+
+if defined?(RailsPulse::ApplicationRecord)
+  RailsPulse::Schema.call(RailsPulse::ApplicationRecord.connection)
+end

data/lib/generators/rails_pulse/convert_to_migrations_generator.rb

@@ -0,0 +1,65 @@
+module RailsPulse
+  module Generators
+    class ConvertToMigrationsGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Convert Rails Pulse schema file to migrations for single database setup"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def check_schema_file
+        unless File.exist?("db/rails_pulse_schema.rb")
+          say "No db/rails_pulse_schema.rb file found. Run 'rails generate rails_pulse:install' first.", :red
+          exit 1
+        end
+
+        if rails_pulse_tables_exist?
+          say "Rails Pulse tables already exist. No conversion needed.", :yellow
+          say "Use 'rails generate rails_pulse:upgrade' to update existing installation.", :blue
+          exit 0
+        end
+      end
+
+      def create_conversion_migration
+        say "Converting db/rails_pulse_schema.rb to migration...", :green
+
+        migration_template(
+          "migrations/install_rails_pulse_tables.rb",
+          "db/migrate/install_rails_pulse_tables.rb"
+        )
+      end
+
+      def display_completion_message
+        say <<~MESSAGE
+
+          Conversion complete!
+
+          Next steps:
+          1. Run: rails db:migrate
+          2. Delete: db/rails_pulse_schema.rb (no longer needed)
+          3. Remove db/rails_pulse_migrate/ directory if it exists
+          4. Restart your Rails server
+
+          Future Rails Pulse updates will come as regular migrations.
+
+        MESSAGE
+      end
+
+      private
+
+      def rails_pulse_tables_exist?
+        return false unless defined?(ActiveRecord::Base)
+
+        connection = ActiveRecord::Base.connection
+        %w[rails_pulse_routes rails_pulse_queries rails_pulse_requests rails_pulse_operations rails_pulse_summaries]
+          .all? { |table| connection.table_exists?(table) }
+      rescue
+        false
+      end
+    end
+  end
+end

data/lib/generators/rails_pulse/install_generator.rb

@@ -1,17 +1,107 @@
 module RailsPulse
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
       source_root File.expand_path("templates", __dir__)
 
-      desc "Copies Rails Pulse migrations to the application."
-      def copy_migrations
-        rake "rails_pulse:install:migrations"
+      desc "Install Rails Pulse with flexible database setup options"
+
+      class_option :database, type: :string, default: "single",
+                   desc: "Database setup: 'single' (default) or 'separate'"
+
+      def self.next_migration_number(path)
+        next_migration_number = current_migration_number(path) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      def copy_schema
+        copy_file "db/rails_pulse_schema.rb", "db/rails_pulse_schema.rb"
       end
 
-      desc "Copies Rails Pulse example configuration file to the application."
       def copy_initializer
         copy_file "rails_pulse.rb", "config/initializers/rails_pulse.rb"
       end
+
+      def setup_database_configuration
+        if separate_database?
+          create_separate_database_setup
+        else
+          create_single_database_setup
+        end
+      end
+
+      def display_post_install_message
+        if separate_database?
+          display_separate_database_message
+        else
+          display_single_database_message
+        end
+      end
+
+      private
+
+      def separate_database?
+        options[:database] == "separate"
+      end
+
+      def create_separate_database_setup
+        create_file "db/rails_pulse_migrate/.keep"
+
+        say "Setting up separate database configuration...", :green
+
+        # Could add database.yml configuration here if needed
+        # For now, users will configure manually
+      end
+
+      def create_single_database_setup
+        say "Setting up single database configuration...", :green
+
+        # Create a migration that loads the schema
+        migration_template(
+          "migrations/install_rails_pulse_tables.rb",
+          "db/migrate/install_rails_pulse_tables.rb"
+        )
+      end
+
+      def display_separate_database_message
+        say <<~MESSAGE
+
+          Rails Pulse installation complete! (Separate Database Setup)
+
+          Next steps:
+          1. Add Rails Pulse database configuration to config/database.yml:
+
+             #{Rails.env}:
+               rails_pulse:
+                 <<: *default
+                 database: storage/#{Rails.env}_rails_pulse.sqlite3
+                 migrations_paths: db/rails_pulse_migrate
+
+          2. Run: rails db:prepare (creates database and loads schema)
+          3. Restart your Rails server
+
+          Future schema changes will come as regular migrations in db/rails_pulse_migrate/
+
+        MESSAGE
+      end
+
+      def display_single_database_message
+        say <<~MESSAGE
+
+          Rails Pulse installation complete! (Single Database Setup)
+
+          Next steps:
+          1. Run: rails db:migrate (creates Rails Pulse tables in your main database)
+          2. Delete: db/rails_pulse_schema.rb (no longer needed)
+          3. Restart your Rails server
+
+          Future schema changes will come as regular migrations in db/migrate/
+
+          Note: The installation migration was created from db/rails_pulse_schema.rb
+          and includes all current Rails Pulse tables and columns.
+
+        MESSAGE
+      end
     end
   end
 end

data/lib/generators/rails_pulse/templates/db/rails_pulse_schema.rb

@@ -0,0 +1,60 @@
+# Rails Pulse Database Schema
+# This file contains the complete schema for Rails Pulse tables
+# Load with: rails db:schema:load:rails_pulse or db:prepare
+
+RailsPulse::Schema = lambda do |connection|
+  # Skip if tables already exist to prevent conflicts
+  return if connection.table_exists?(:rails_pulse_routes)
+
+  connection.create_table :rails_pulse_routes do |t|
+    t.string :method, null: false, comment: "HTTP method (e.g., GET, POST)"
+    t.string :path, null: false, comment: "Request path (e.g., /posts/index)"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_routes, [ :method, :path ], unique: true, name: "index_rails_pulse_routes_on_method_and_path"
+
+  connection.create_table :rails_pulse_queries do |t|
+    t.string :normalized_sql, limit: 1000, null: false, comment: "Normalized SQL query string (e.g., SELECT * FROM users WHERE id = ?)"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_queries, :normalized_sql, unique: true, name: "index_rails_pulse_queries_on_normalized_sql", length: 191
+
+  connection.create_table :rails_pulse_requests do |t|
+    t.references :route, null: false, foreign_key: { to_table: :rails_pulse_routes }, comment: "Link to the route"
+    t.decimal :duration, precision: 15, scale: 6, null: false, comment: "Total request duration in milliseconds"
+    t.integer :status, null: false, comment: "HTTP status code (e.g., 200, 500)"
+    t.boolean :is_error, null: false, default: false, comment: "True if status >= 500"
+    t.string :request_uuid, null: false, comment: "Unique identifier for the request (e.g., UUID)"
+    t.string :controller_action, comment: "Controller and action handling the request (e.g., PostsController#show)"
+    t.timestamp :occurred_at, null: false, comment: "When the request started"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_requests, :occurred_at, name: "index_rails_pulse_requests_on_occurred_at"
+  connection.add_index :rails_pulse_requests, :request_uuid, unique: true, name: "index_rails_pulse_requests_on_request_uuid"
+  connection.add_index :rails_pulse_requests, [ :route_id, :occurred_at ], name: "index_rails_pulse_requests_on_route_id_and_occurred_at"
+
+  connection.create_table :rails_pulse_operations do |t|
+    t.references :request, null: false, foreign_key: { to_table: :rails_pulse_requests }, comment: "Link to the request"
+    t.references :query, foreign_key: { to_table: :rails_pulse_queries }, index: true, comment: "Link to the normalized SQL query"
+    t.string :operation_type, null: false, comment: "Type of operation (e.g., database, view, gem_call)"
+    t.string :label, null: false, comment: "Descriptive name (e.g., SELECT FROM users WHERE id = 1, render layout)"
+    t.decimal :duration, precision: 15, scale: 6, null: false, comment: "Operation duration in milliseconds"
+    t.string :codebase_location, comment: "File and line number (e.g., app/models/user.rb:25)"
+    t.float :start_time, null: false, default: 0.0, comment: "Operation start time in milliseconds"
+    t.timestamp :occurred_at, null: false, comment: "When the request started"
+    t.timestamps
+  end
+
+  connection.add_index :rails_pulse_operations, :operation_type, name: "index_rails_pulse_operations_on_operation_type"
+  connection.add_index :rails_pulse_operations, :occurred_at, name: "index_rails_pulse_operations_on_occurred_at"
+  connection.add_index :rails_pulse_operations, [ :query_id, :occurred_at ], name: "index_rails_pulse_operations_on_query_and_time"
+  connection.add_index :rails_pulse_operations, [ :query_id, :duration, :occurred_at ], name: "index_rails_pulse_operations_query_performance"
+  connection.add_index :rails_pulse_operations, [ :occurred_at, :duration, :operation_type ], name: "index_rails_pulse_operations_on_time_duration_type"
+end
+
+if defined?(RailsPulse::ApplicationRecord)
+  RailsPulse::Schema.call(RailsPulse::ApplicationRecord.connection)
+end

data/lib/generators/rails_pulse/templates/migrations/install_rails_pulse_tables.rb

@@ -0,0 +1,22 @@
+# Generated from Rails Pulse schema - automatically loads current schema definition
+class InstallRailsPulseTables < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
+    # Load and execute the Rails Pulse schema directly
+    # This ensures the migration is always in sync with the schema file
+    schema_file = File.join(::Rails.root.to_s, "db/rails_pulse_schema.rb")
+
+    if File.exist?(schema_file)
+      say "Loading Rails Pulse schema from db/rails_pulse_schema.rb"
+
+      # Load the schema file to define RailsPulse::Schema
+      load schema_file
+
+      # Execute the schema in the context of this migration
+      RailsPulse::Schema.call(connection)
+
+      say "Rails Pulse tables created successfully"
+    else
+      raise "Rails Pulse schema file not found at db/rails_pulse_schema.rb"
+    end
+  end
+end

data/lib/generators/rails_pulse/templates/migrations/upgrade_rails_pulse_tables.rb

@@ -0,0 +1,19 @@
+# Upgrade Rails Pulse tables with new features
+class UpgradeRailsPulseTables < ActiveRecord::Migration[<%= @migration_version %>]
+  def change
+    <% @missing_columns.each do |table_name, columns| %>
+      <% columns.each do |column_name, definition| %>
+    # Add <%= column_name %> column to <%= table_name %>
+    add_column :<%= table_name %>, :<%= column_name %>, :<%= definition[:type] %><% if definition[:comment] %>, comment: "<%= definition[:comment] %>"<% end %>
+      <% end %>
+    <% end %>
+  end
+
+  def down
+    <% @missing_columns.each do |table_name, columns| %>
+      <% columns.each do |column_name, _definition| %>
+    remove_column :<%= table_name %>, :<%= column_name %>
+      <% end %>
+    <% end %>
+  end
+end

data/lib/generators/rails_pulse/templates/rails_pulse.rb

@@ -71,18 +71,6 @@ RailsPulse.configure do |config|
   config.ignored_requests = []
   config.ignored_queries  = []
 
-  # ====================================================================================================
-  #                                               CACHING
-  # ====================================================================================================
-  # Configure metric card caching to improve performance of the Rails Pulse dashboard.
-  # Caching reduces database load for expensive metric calculations.
-
-  # Enable/disable metric card caching
-  config.component_cache_enabled = true
-
-  # How long to cache metric card results
-  config.component_cache_duration = 1.hour
-
   # ====================================================================================================
   #                                            DATABASE CONFIGURATION
   # ====================================================================================================