rails_error_dashboard 0.1.0 → 0.1.3

data/lib/generators/rails_error_dashboard/install/templates/initializer.rb

@@ -1,64 +1,299 @@
 # frozen_string_literal: true
 
 RailsErrorDashboard.configure do |config|
+  # ============================================================================
+  # AUTHENTICATION (Always Required)
+  # ============================================================================
+
   # Dashboard authentication credentials
-  # Change these in production or use environment variables
-  config.dashboard_username = ENV.fetch("ERROR_DASHBOARD_USER", "admin")
-  config.dashboard_password = ENV.fetch("ERROR_DASHBOARD_PASSWORD", "password")
+  # ⚠️ CHANGE THESE BEFORE PRODUCTION! ⚠️
+  config.dashboard_username = ENV.fetch("ERROR_DASHBOARD_USER", "gandalf")
+  config.dashboard_password = ENV.fetch("ERROR_DASHBOARD_PASSWORD", "youshallnotpass")
 
   # Require authentication for dashboard access
-  # Set to false to disable authentication (not recommended in production)
   config.require_authentication = true
 
   # Require authentication even in development mode
-  # Set to true if you want to test authentication in development
   config.require_authentication_in_development = false
 
-  # User model for associations (defaults to 'User')
-  # Change this if your user model has a different name
+  # ============================================================================
+  # CORE FEATURES (Always Enabled)
+  # ============================================================================
+
+  # Error capture via middleware and Rails.error subscriber
+  config.enable_middleware = true
+  config.enable_error_subscriber = true
+
+  # User model for error associations
   config.user_model = "User"
 
-  # === NOTIFICATION SETTINGS ===
-  #
-  # Notifications are sent asynchronously via the :error_notifications queue
-  # Works with: Solid Queue (Rails 8.1+), Sidekiq, Delayed Job, Resque, etc.
-  #
-  # For Sidekiq, add to config/sidekiq.yml:
-  #   :queues:
-  #     - error_notifications
-  #     - default
-  #
-  # For Solid Queue (Rails 8.1+), add to config/queue.yml:
-  #   workers:
-  #     - queues: error_notifications
-  #       threads: 3
-
-  # Slack notifications
+  # Error retention policy (days to keep errors before auto-deletion)
+  config.retention_days = 90
+
+  # ============================================================================
+  # NOTIFICATION SETTINGS
+  # ============================================================================
+  # Configure which notification channels you want to use.
+  # You can enable/disable any of these at any time by changing true/false.
+
+<% if @enable_slack -%>
+  # Slack Notifications - ENABLED
   config.enable_slack_notifications = true
   config.slack_webhook_url = ENV["SLACK_WEBHOOK_URL"]
+  # To disable: Set config.enable_slack_notifications = false
+
+<% else -%>
+  # Slack Notifications - DISABLED
+  # To enable: Set config.enable_slack_notifications = true and configure webhook URL
+  config.enable_slack_notifications = false
+  # config.slack_webhook_url = ENV["SLACK_WEBHOOK_URL"]
 
-  # Email notifications
+<% end -%>
+<% if @enable_email -%>
+  # Email Notifications - ENABLED
   config.enable_email_notifications = true
   config.notification_email_recipients = ENV.fetch("ERROR_NOTIFICATION_EMAILS", "").split(",").map(&:strip)
   config.notification_email_from = ENV.fetch("ERROR_NOTIFICATION_FROM", "errors@example.com")
+  # To disable: Set config.enable_email_notifications = false
+
+<% else -%>
+  # Email Notifications - DISABLED
+  # To enable: Set config.enable_email_notifications = true and configure recipients
+  config.enable_email_notifications = false
+  # config.notification_email_recipients = ENV.fetch("ERROR_NOTIFICATION_EMAILS", "").split(",").map(&:strip)
+  # config.notification_email_from = ENV.fetch("ERROR_NOTIFICATION_FROM", "errors@example.com")
+
+<% end -%>
+<% if @enable_discord -%>
+  # Discord Notifications - ENABLED
+  config.enable_discord_notifications = true
+  config.discord_webhook_url = ENV["DISCORD_WEBHOOK_URL"]
+  # To disable: Set config.enable_discord_notifications = false
+
+<% else -%>
+  # Discord Notifications - DISABLED
+  # To enable: Set config.enable_discord_notifications = true and configure webhook URL
+  config.enable_discord_notifications = false
+  # config.discord_webhook_url = ENV["DISCORD_WEBHOOK_URL"]
 
+<% end -%>
+<% if @enable_pagerduty -%>
+  # PagerDuty Integration - ENABLED (critical errors only)
+  config.enable_pagerduty_notifications = true
+  config.pagerduty_integration_key = ENV["PAGERDUTY_INTEGRATION_KEY"]
+  # To disable: Set config.enable_pagerduty_notifications = false
+
+<% else -%>
+  # PagerDuty Integration - DISABLED
+  # To enable: Set config.enable_pagerduty_notifications = true and configure integration key
+  config.enable_pagerduty_notifications = false
+  # config.pagerduty_integration_key = ENV["PAGERDUTY_INTEGRATION_KEY"]
+
+<% end -%>
+<% if @enable_webhooks -%>
+  # Generic Webhook Notifications - ENABLED
+  config.enable_webhook_notifications = true
+  config.webhook_urls = ENV.fetch("WEBHOOK_URLS", "").split(",").map(&:strip).reject(&:empty?)
+  # To disable: Set config.enable_webhook_notifications = false
+
+<% else -%>
+  # Generic Webhook Notifications - DISABLED
+  # To enable: Set config.enable_webhook_notifications = true and configure webhook URLs
+  config.enable_webhook_notifications = false
+  # config.webhook_urls = ENV.fetch("WEBHOOK_URLS", "").split(",").map(&:strip).reject(&:empty?)
+
+<% end -%>
   # Dashboard base URL (used in notification links)
-  # Example: 'https://myapp.com' or 'http://localhost:3000'
   config.dashboard_base_url = ENV["DASHBOARD_BASE_URL"]
 
-  # Use a separate database for error logs (optional)
-  # See documentation for setup instructions: docs/SEPARATE_ERROR_DATABASE.md
-  config.use_separate_database = ENV.fetch("USE_SEPARATE_ERROR_DB", "false") == "true"
+  # ============================================================================
+  # PERFORMANCE & SCALABILITY
+  # ============================================================================
 
-  # Retention policy - number of days to keep error logs
-  # Old errors will be automatically deleted after this many days
-  config.retention_days = 90
+<% if @enable_async_logging -%>
+  # Async Error Logging - ENABLED
+  # Errors will be logged in background jobs for better performance
+  config.async_logging = true
+  config.async_adapter = :sidekiq  # Options: :sidekiq, :solid_queue, :async
+  # To disable: Set config.async_logging = false
 
-  # Enable/disable error catching middleware
-  # Set to false if you want to handle errors differently
-  config.enable_middleware = true
+<% else -%>
+  # Async Error Logging - DISABLED
+  # Errors are logged synchronously (blocking)
+  # To enable: Set config.async_logging = true and configure adapter
+  config.async_logging = false
+  # config.async_adapter = :sidekiq  # Options: :sidekiq, :solid_queue, :async
 
-  # Enable/disable Rails.error subscriber
-  # Set to false if you don't want to use Rails error reporting
-  config.enable_error_subscriber = true
+<% end -%>
+  # Backtrace size limiting (reduces storage by ~80%)
+  config.max_backtrace_lines = 50
+
+<% if @enable_error_sampling -%>
+  # Error Sampling - ENABLED
+  # Reduce volume by logging only a percentage of non-critical errors
+  # Critical errors are ALWAYS logged regardless of sampling rate
+  config.sampling_rate = 0.1  # 10% - Adjust as needed (0.0 to 1.0)
+  # To disable: Set config.sampling_rate = 1.0 (100%)
+
+<% else -%>
+  # Error Sampling - DISABLED
+  # All errors are logged (100% sampling rate)
+  # To enable: Set config.sampling_rate < 1.0 (e.g., 0.1 for 10%)
+  config.sampling_rate = 1.0
+
+<% end -%>
+  # Ignored exceptions (skip logging these)
+  # config.ignored_exceptions = [
+  #   "ActionController::RoutingError",
+  #   "ActionController::InvalidAuthenticityToken",
+  #   /^ActiveRecord::RecordNotFound/
+  # ]
+
+  # ============================================================================
+  # DATABASE CONFIGURATION
+  # ============================================================================
+
+<% if @enable_separate_database -%>
+  # Separate Error Database - ENABLED
+  # Errors will be stored in a dedicated database
+  # See docs/guides/DATABASE_OPTIONS.md for setup instructions
+  config.use_separate_database = true
+  # To disable: Set config.use_separate_database = false
+
+<% else -%>
+  # Separate Error Database - DISABLED
+  # Errors are stored in your main application database
+  # To enable: Set config.use_separate_database = true and configure database.yml
+  config.use_separate_database = false
+
+<% end -%>
+  # ============================================================================
+  # ADVANCED ANALYTICS
+  # ============================================================================
+
+<% if @enable_baseline_alerts -%>
+  # Baseline Anomaly Alerts - ENABLED
+  # Automatically detect when error rates exceed normal patterns
+  config.enable_baseline_alerts = true
+  config.baseline_alert_threshold_std_devs = 2.0  # Alert when > 2 std devs above baseline
+  config.baseline_alert_severities = [ :critical, :high ]
+  config.baseline_alert_cooldown_minutes = 120  # 2 hours between alerts
+  # To disable: Set config.enable_baseline_alerts = false
+
+<% else -%>
+  # Baseline Anomaly Alerts - DISABLED
+  # To enable: Set config.enable_baseline_alerts = true
+  config.enable_baseline_alerts = false
+  # config.baseline_alert_threshold_std_devs = 2.0
+  # config.baseline_alert_severities = [ :critical, :high ]
+  # config.baseline_alert_cooldown_minutes = 120
+
+<% end -%>
+<% if @enable_similar_errors -%>
+  # Fuzzy Error Matching - ENABLED
+  # Find similar errors even with different error_hashes
+  config.enable_similar_errors = true
+  # To disable: Set config.enable_similar_errors = false
+
+<% else -%>
+  # Fuzzy Error Matching - DISABLED
+  # To enable: Set config.enable_similar_errors = true
+  config.enable_similar_errors = false
+
+<% end -%>
+<% if @enable_co_occurring_errors -%>
+  # Co-occurring Errors - ENABLED
+  # Detect errors that happen together in time
+  config.enable_co_occurring_errors = true
+  # To disable: Set config.enable_co_occurring_errors = false
+
+<% else -%>
+  # Co-occurring Errors - DISABLED
+  # To enable: Set config.enable_co_occurring_errors = true
+  config.enable_co_occurring_errors = false
+
+<% end -%>
+<% if @enable_error_cascades -%>
+  # Error Cascade Detection - ENABLED
+  # Identify error chains (A causes B causes C)
+  config.enable_error_cascades = true
+  # To disable: Set config.enable_error_cascades = false
+
+<% else -%>
+  # Error Cascade Detection - DISABLED
+  # To enable: Set config.enable_error_cascades = true
+  config.enable_error_cascades = false
+
+<% end -%>
+<% if @enable_error_correlation -%>
+  # Error Correlation Analysis - ENABLED
+  # Correlate errors with versions, users, and time
+  config.enable_error_correlation = true
+  # To disable: Set config.enable_error_correlation = false
+
+<% else -%>
+  # Error Correlation Analysis - DISABLED
+  # To enable: Set config.enable_error_correlation = true
+  config.enable_error_correlation = false
+
+<% end -%>
+<% if @enable_platform_comparison -%>
+  # Platform Comparison - ENABLED
+  # Compare iOS vs Android vs Web health metrics
+  config.enable_platform_comparison = true
+  # To disable: Set config.enable_platform_comparison = false
+
+<% else -%>
+  # Platform Comparison - DISABLED
+  # To enable: Set config.enable_platform_comparison = true
+  config.enable_platform_comparison = false
+
+<% end -%>
+<% if @enable_occurrence_patterns -%>
+  # Occurrence Pattern Detection - ENABLED
+  # Detect cyclical patterns and error bursts
+  config.enable_occurrence_patterns = true
+  # To disable: Set config.enable_occurrence_patterns = false
+
+<% else -%>
+  # Occurrence Pattern Detection - DISABLED
+  # To enable: Set config.enable_occurrence_patterns = true
+  config.enable_occurrence_patterns = false
+
+<% end -%>
+  # ============================================================================
+  # INTERNAL LOGGING (Silent by Default)
+  # ============================================================================
+  # Rails Error Dashboard logging is SILENT by default to keep your logs clean.
+  # Enable only for debugging gem issues or troubleshooting setup.
+
+  # Enable internal logging (default: false - silent)
+  config.enable_internal_logging = false
+
+  # Log level (default: :silent)
+  # Options: :debug, :info, :warn, :error, :silent
+  config.log_level = :silent
+
+  # Example: Enable verbose logging for debugging
+  # config.enable_internal_logging = true
+  # config.log_level = :debug
+
+  # Example: Log only errors (troubleshooting)
+  # config.enable_internal_logging = true
+  # config.log_level = :error
+
+  # ============================================================================
+  # ADDITIONAL CONFIGURATION
+  # ============================================================================
+
+  # Custom severity rules (override automatic severity classification)
+  # config.custom_severity_rules = {
+  #   "PaymentError" => :critical,
+  #   "ValidationError" => :low
+  # }
+
+  # Enhanced metrics (optional)
+  config.app_version = ENV["APP_VERSION"]
+  config.git_sha = ENV["GIT_SHA"]
+  # config.total_users_for_impact = 10000  # For user impact % calculation
 end

data/lib/generators/rails_error_dashboard/solid_queue/solid_queue_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RailsErrorDashboard
+  module Generators
+    # Generator for Solid Queue configuration
+    # Usage: rails generate rails_error_dashboard:solid_queue
+    class SolidQueueGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates Solid Queue configuration for RailsErrorDashboard"
+
+      def create_queue_config
+        template "queue.yml", "config/queue.yml"
+      end
+
+      def show_instructions
+        say "\n" + "=" * 80, :green
+        say "Solid Queue configuration created!", :green
+        say "=" * 80, :green
+        say "\nNext steps:", :yellow
+        say "  1. Install Solid Queue gem (if not already):", :cyan
+        say "     bundle add solid_queue", :white
+        say "\n  2. Run Solid Queue migrations:", :cyan
+        say "     bin/rails solid_queue:install", :white
+        say "\n  3. Set ActiveJob adapter in config/application.rb:", :cyan
+        say "     config.active_job.queue_adapter = :solid_queue", :white
+        say "\n  4. Start Solid Queue worker:", :cyan
+        say "     bin/jobs", :white
+        say "\n  5. Enable async logging in config/initializers/rails_error_dashboard.rb:", :cyan
+        say "     config.async_logging = true", :white
+        say "     config.async_adapter = :solid_queue", :white
+        say "\n" + "=" * 80, :green
+      end
+    end
+  end
+end

data/lib/generators/rails_error_dashboard/solid_queue/templates/queue.yml

@@ -0,0 +1,55 @@
+# Solid Queue configuration for RailsErrorDashboard
+#
+# This file configures workers for error logging and notifications.
+# Adjust threads and processes based on your application's needs.
+
+# Development environment - optimized for low resource usage
+development:
+  workers:
+    # Error notifications (Slack, Email, Discord, PagerDuty, Webhooks)
+    - queues: error_notifications
+      threads: 2
+      processes: 1
+      polling_interval: 1
+
+    # Default queue (includes async error logging)
+    - queues: default
+      threads: 3
+      processes: 1
+      polling_interval: 1
+
+# Test environment - minimal configuration
+test:
+  workers:
+    - queues: "*"
+      threads: 1
+      processes: 1
+      polling_interval: 0.1
+
+# Production environment - optimized for throughput
+production:
+  workers:
+    # Error notifications - lower concurrency (external API calls)
+    - queues: error_notifications
+      threads: 3
+      processes: 1
+      polling_interval: 0.5
+
+    # Default queue - higher concurrency (database operations)
+    - queues: default
+      threads: 5
+      processes: 2
+      polling_interval: 0.5
+
+# Staging environment - similar to production but scaled down
+staging:
+  workers:
+    - queues: error_notifications
+      threads: 2
+      processes: 1
+      polling_interval: 0.5
+
+    - queues: default
+      threads: 3
+      processes: 1
+      polling_interval: 0.5

data/lib/rails_error_dashboard/commands/batch_delete_errors.rb

@@ -32,7 +32,7 @@ module RailsErrorDashboard
           errors: []
         }
       rescue => e
-        Rails.logger.error("Batch delete failed: #{e.message}")
+        RailsErrorDashboard::Logger.error("Batch delete failed: #{e.message}")
         { success: false, count: 0, total: @error_ids.size, errors: [ e.message ] }
       end
     end

data/lib/rails_error_dashboard/commands/batch_resolve_errors.rb

@@ -37,7 +37,7 @@ module RailsErrorDashboard
             resolved_errors << error
           rescue => e
             failed_ids << error.id
-            Rails.logger.error("Failed to resolve error #{error.id}: #{e.message}")
+            RailsErrorDashboard::Logger.error("Failed to resolve error #{error.id}: #{e.message}")
           end
         end
 
@@ -52,7 +52,7 @@ module RailsErrorDashboard
           errors: failed_ids.empty? ? [] : [ "Failed to resolve #{failed_ids.size} error(s)" ]
         }
       rescue => e
-        Rails.logger.error("Batch resolve failed: #{e.message}")
+        RailsErrorDashboard::Logger.error("Batch resolve failed: #{e.message}")
         { success: false, count: 0, total: @error_ids.size, errors: [ e.message ] }
       end
     end