rails_error_dashboard 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb7505fa151651854c20ca7db94e8d46a887944db7426dae5c0cc3af5c190c4
-  data.tar.gz: d3fb030d07b2981913a26a7486b693e2937bdb4cd09448a7d60fc0996b046fe6
+  metadata.gz: 1c446ee6a83da642ddc211be29ccac3f3a74a3ee3e2f8c8bdf7e93bebcb13ed1
+  data.tar.gz: fb22f5fa6db4add1eeef839ec5fa7db7d47d987af935a5035024b358f558759f
 SHA512:
-  metadata.gz: a2b3109a9c7744fcb9ef25fd1a498908fa036cfa86ddf68de7c6214ee9b500bbf9885d69e687418998db8fe0e6bfa4ddf244f28e3d138f4b315f4574113eb9e7
-  data.tar.gz: 5553318a3b2c3accab1d2bcadeb70aad586511e98435e32e9ef84f648f2b3132bf5d8215178198522c0b15a193a29c40f22aacf5acbb4dfb51f5995d975fef53
+  metadata.gz: 4a0b48f1641eec4fb33b1db76dc4b85449fc51da7a1246bf67c7fabc8f0a528b052608038a5c3b19c6c7d9e925100a1d55bf66a83fcc3de982150f21cf177de8
+  data.tar.gz: fb38035f7780b14c82ea4175b0e1a3b2102d0634137dc22ee34183e111da58008663302522df3815414657c9b9628a19c7d08472a62e21a98b989839eff7e627

data/config/initializers/rails_error_dashboard.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+RailsErrorDashboard.configure do |config|
+  # ============================================================================
+  # AUTHENTICATION (Always Required)
+  # ============================================================================
+
+  # Dashboard authentication credentials
+  # ⚠️ 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
+  config.require_authentication = true
+
+  # Require authentication even in development mode
+  config.require_authentication_in_development = false
+
+  # ============================================================================
+  # 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"
+
+  # 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.
+
+  # 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 - 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")
+
+  # 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"]
+
+  # 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"]
+
+  # 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?)
+
+  # Dashboard base URL (used in notification links)
+  config.dashboard_base_url = ENV["DASHBOARD_BASE_URL"]
+
+  # ============================================================================
+  # PERFORMANCE & SCALABILITY
+  # ============================================================================
+
+  # 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
+
+  # Backtrace size limiting (reduces storage by ~80%)
+  config.max_backtrace_lines = 50
+
+  # 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
+
+  # Ignored exceptions (skip logging these)
+  # config.ignored_exceptions = [
+  #   "ActionController::RoutingError",
+  #   "ActionController::InvalidAuthenticityToken",
+  #   /^ActiveRecord::RecordNotFound/
+  # ]
+
+  # ============================================================================
+  # DATABASE CONFIGURATION
+  # ============================================================================
+
+  # 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
+
+  # ============================================================================
+  # ADVANCED ANALYTICS
+  # ============================================================================
+
+  # 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
+
+  # Fuzzy Error Matching - DISABLED
+  # To enable: Set config.enable_similar_errors = true
+  config.enable_similar_errors = false
+
+  # Co-occurring Errors - DISABLED
+  # To enable: Set config.enable_co_occurring_errors = true
+  config.enable_co_occurring_errors = false
+
+  # Error Cascade Detection - DISABLED
+  # To enable: Set config.enable_error_cascades = true
+  config.enable_error_cascades = false
+
+  # Error Correlation Analysis - DISABLED
+  # To enable: Set config.enable_error_correlation = true
+  config.enable_error_correlation = false
+
+  # Platform Comparison - DISABLED
+  # To enable: Set config.enable_platform_comparison = true
+  config.enable_platform_comparison = false
+
+  # Occurrence Pattern Detection - DISABLED
+  # To enable: Set config.enable_occurrence_patterns = true
+  config.enable_occurrence_patterns = false
+
+  # ============================================================================
+  # 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/config/routes.rb

@@ -1,4 +1,5 @@
 RailsErrorDashboard::Engine.routes.draw do
+  mount RailsErrorDashboard::Engine => '/error_dashboard'
   root to: "errors#overview"
 
   # Dashboard overview

data/lib/generators/rails_error_dashboard/install/install_generator.rb

@@ -199,7 +199,7 @@ module RailsErrorDashboard
       end
 
       def copy_migrations
-        rake "rails_error_dashboard:install:migrations"
+        rails_command "rails_error_dashboard:install:migrations"
       end
 
       def add_route

data/lib/rails_error_dashboard/version.rb

@@ -1,3 +1,3 @@
 module RailsErrorDashboard
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_error_dashboard
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Anjan Jagirdar
@@ -311,6 +311,7 @@ files:
 - app/views/rails_error_dashboard/errors/platform_comparison.html.erb
 - app/views/rails_error_dashboard/errors/settings.html.erb
 - app/views/rails_error_dashboard/errors/show.html.erb
+- config/initializers/rails_error_dashboard.rb
 - config/routes.rb
 - db/migrate/20251224000001_create_rails_error_dashboard_error_logs.rb
 - db/migrate/20251224081522_add_better_tracking_to_error_logs.rb
@@ -377,7 +378,7 @@ metadata:
   source_code_uri: https://github.com/AnjanJ/rails_error_dashboard
   changelog_uri: https://github.com/AnjanJ/rails_error_dashboard/blob/main/CHANGELOG.md
 post_install_message: "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n
-  \ Rails Error Dashboard v0.1.8 installed successfully!\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n\U0001F4E6
+  \ Rails Error Dashboard v0.1.9 installed successfully!\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n\U0001F4E6
   Next steps to get started:\n\n  1. Run the installer:\n     rails generate rails_error_dashboard:install\n\n
   \ 2. Run migrations:\n     rails db:migrate\n\n  3. Mount the engine in config/routes.rb:\n
   \    mount RailsErrorDashboard::Engine => '/error_dashboard'\n\n  4. Start your