Configuration Guide

config.async_logging = false          # Sync for easier debugging
config.sampling_rate = 1.0             # Log all errors
config.enable_internal_logging = true  # See what's happening
config.log_level = :debug             # Verbose logging

config.async_logging = true           # Background jobs
config.async_adapter = :sidekiq       # Battle-tested
config.sampling_rate = 1.0            # Log all errors
config.retention_days = 90            # 3 months
config.max_backtrace_lines = 50       # Full context

config.async_logging = true           # REQUIRED
config.async_adapter = :sidekiq       # Recommended
config.sampling_rate = 0.1            # 10% (critical always logged)
config.retention_days = 30            # 1 month
config.max_backtrace_lines = 20       # Reduce storage
config.use_separate_database = true   # Isolate errors

RailsErrorDashboard.configure do |config|
  # Dashboard authentication (always required)
  config.dashboard_username = "admin"
  config.dashboard_password = ENV.fetch("ERROR_DASHBOARD_PASSWORD", "changeme")

  # Data retention (days)
  config.retention_days = 90

  # User model for error association
  config.user_model = "User"

  # Enable/disable middleware and error subscriber
  config.enable_middleware = true
  config.enable_error_subscriber = true
end

RailsErrorDashboard.configure do |config|
  # Devise/Warden — use warden directly (recommended)
  config.authenticate_with = -> {
    if warden.authenticated?
      true
    else
      redirect_to main_app.new_user_session_path, allow_other_host: true
    end
  }

  # Warden with admin scope
  config.authenticate_with = -> { warden.authenticated?(:admin) }

  # Session-based
  config.authenticate_with = -> { session[:dashboard_admin] == true }
end

RailsErrorDashboard.configure do |config|
  config.enable_slack_notifications = true
  config.slack_webhook_url = ENV['SLACK_WEBHOOK_URL']
end

RailsErrorDashboard.configure do |config|
  config.enable_email_notifications = true
  config.notification_email_recipients = ["dev@yourapp.com", "team@yourapp.com"]
  config.notification_email_from = "errors@yourapp.com"
end

RailsErrorDashboard.configure do |config|
  config.enable_discord_notifications = true
  config.discord_webhook_url = ENV['DISCORD_WEBHOOK_URL']
end

RailsErrorDashboard.configure do |config|
  config.enable_pagerduty_notifications = true
  config.pagerduty_integration_key = ENV['PAGERDUTY_INTEGRATION_KEY']
end

RailsErrorDashboard.configure do |config|
  config.enable_webhook_notifications = true
  config.webhook_urls = [
    'https://yourapp.com/hooks/errors',
    'https://zapier.com/hooks/catch/123456/abcdef'
  ]
end

config.dashboard_base_url = ENV['DASHBOARD_BASE_URL']  # e.g., "https://yourapp.com"

RailsErrorDashboard.configure do |config|
  config.async_logging = true
  config.async_adapter = :sidekiq  # Options: :sidekiq, :solid_queue, :async
end

RailsErrorDashboard.configure do |config|
  config.sampling_rate = 0.1  # Log 10% of non-critical errors
end

RailsErrorDashboard.configure do |config|
  config.use_separate_database = true
end

RailsErrorDashboard.configure do |config|
  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]  # Alert on these severities only
  config.baseline_alert_cooldown_minutes = 120  # 2 hours between alerts for same error
end

RailsErrorDashboard.configure do |config|
  config.enable_similar_errors = true
end

RailsErrorDashboard.configure do |config|
  config.enable_co_occurring_errors = true
end

RailsErrorDashboard.configure do |config|
  config.enable_error_cascades = true
end

RailsErrorDashboard.configure do |config|
  config.enable_error_correlation = true
end

RailsErrorDashboard.configure do |config|
  config.enable_platform_comparison = true
end

RailsErrorDashboard.configure do |config|
  config.enable_occurrence_patterns = true
end

RailsErrorDashboard.configure do |config|
  # Enable source code viewer
  config.enable_source_code_integration = true

  # Optional: Enable git blame integration
  config.enable_git_blame = true
end

RailsErrorDashboard.configure do |config|
  # Enable source code viewer
  config.enable_source_code_integration = true

  # Enable git blame
  config.enable_git_blame = true

  # Context lines (±N lines around error)
  config.source_code_context_lines = 5  # Default: 5

  # Cache TTL in seconds
  config.source_code_cache_ttl = 3600  # Default: 1 hour

  # Security: only show app code (hide gems/vendor)
  config.only_show_app_code_source = true  # Default: true

  # Branch strategy for repository links
  config.git_branch_strategy = :commit_sha  # Options: :commit_sha, :current_branch, :main
end

# Development: Full visibility
config.enable_source_code_integration = true
config.enable_git_blame = true

# Production: Source code only (no git blame for performance)
config.enable_source_code_integration = true
config.enable_git_blame = false

# Staging: Enable both for debugging
if Rails.env.staging?
  config.enable_source_code_integration = true
  config.enable_git_blame = true
end

RailsErrorDashboard.configure do |config|
  # Enable breadcrumbs
  config.enable_breadcrumbs = true
end

RailsErrorDashboard.configure do |config|
  config.enable_breadcrumbs = true

  # Max events per request (default: 40, ring buffer drops oldest when full)
  config.breadcrumb_buffer_size = 40

  # Limit which categories are captured (default: nil = all)
  # Options: :sql, :controller, :cache, :job, :mailer, :deprecation, :custom
  config.breadcrumb_categories = [ :sql, :controller ]  # Only SQL and controller events

  # N+1 query detection (analyzes SQL breadcrumbs at display time)
  config.enable_n_plus_one_detection = true  # Default: true
  config.n_plus_one_threshold = 3            # Min repetitions to flag (default: 3, min: 2)
end

RailsErrorDashboard.add_breadcrumb("checkout started", { cart_id: 123 })
RailsErrorDashboard.add_breadcrumb("payment processed", { provider: "stripe", amount: 99.99 })

config.enable_n_plus_one_detection = true  # ON by default
config.n_plus_one_threshold = 3            # Flag when same pattern appears 3+ times

# Development: Full breadcrumb visibility
config.enable_breadcrumbs = true

# Production: Enable with conservative buffer
config.enable_breadcrumbs = true
config.breadcrumb_buffer_size = 25

# High-traffic: Only capture SQL and controller events
config.enable_breadcrumbs = true
config.breadcrumb_categories = [ :sql, :controller ]

RailsErrorDashboard.configure do |config|
  config.enable_system_health = true
end

RailsErrorDashboard.configure do |config|
  config.enable_local_variables = true

  # Serialization limits (all have sensible defaults)
  config.local_variable_max_count = 15          # Max variables per exception
  config.local_variable_max_depth = 3           # Max object nesting depth
  config.local_variable_max_string_length = 200 # Truncate strings beyond this
  config.local_variable_max_array_items = 10    # Max array items
  config.local_variable_max_hash_items = 20     # Max hash entries

  # Additional sensitive patterns (beyond Rails filter_parameters)
  config.local_variable_filter_patterns = [ /secret/, /token/ ]
end

RailsErrorDashboard.configure do |config|
  config.enable_instance_variables = true
  config.instance_variable_max_count = 20          # Max variables (default: 20)
  config.instance_variable_filter_patterns = []    # Additional sensitive patterns
end

RailsErrorDashboard.configure do |config|
  config.detect_swallowed_exceptions = true

  config.swallowed_exception_max_cache_size = 1000  # Thread-local cache size
  config.swallowed_exception_flush_interval = 60    # Seconds between DB flushes
  config.swallowed_exception_threshold = 0.95       # 95% rescue ratio = "swallowed"
  config.swallowed_exception_ignore_classes = []    # Exception classes to skip
end

RailsErrorDashboard.configure do |config|
  config.enable_diagnostic_dump = true
end

RailsErrorDashboard.configure do |config|
  config.enable_breadcrumbs = true              # Required dependency
  config.enable_rack_attack_tracking = true
end

RailsErrorDashboard.configure do |config|
  config.enable_crash_capture = true
  config.crash_capture_path = nil    # nil = Dir.tmpdir; custom path must exist
end

RailsErrorDashboard.configure do |config|
  config.custom_severity_rules = {
    # Treat payment errors as critical
    "Stripe::CardError" => :critical,
    "PaymentProcessingError" => :critical,

    # Downgrade validation errors to low
    "ActiveRecord::RecordInvalid" => :low,

    # Custom application errors
    "MyApp::BusinessLogicError" => :medium
  }
end

RailsErrorDashboard.configure do |config|
  config.ignored_exceptions = [
    # Exact class names
    "ActionController::RoutingError",
    "ActiveRecord::RecordNotFound",

    # Regex patterns for flexible matching
    /Rack::Timeout/,
    /ActionController::InvalidAuthenticityToken/,

    # All errors from a specific namespace
    /ThirdPartyGem::.*/
  ]
end

# Production: Ignore bot-related errors
config.ignored_exceptions = [
  "ActionController::RoutingError",  # Bots scanning for vulnerabilities
  /ActionController::InvalidAuthenticityToken/  # CSRF from legitimate crawlers
]

# Development: Ignore known third-party issues
config.ignored_exceptions = [
  /Geocoder::.*/,  # Geocoding API rate limits
  "Redis::CannotConnectError"  # Redis disconnects during development
]

RailsErrorDashboard.configure do |config|
  # Log 100% of errors (default)
  config.sampling_rate = 1.0

  # Log only 10% of non-critical errors (critical errors always logged)
  config.sampling_rate = 0.1

  # Disable logging of non-critical errors entirely
  config.sampling_rate = 0.0
end

# High-traffic production: Reduce database writes
config.sampling_rate = 0.1  # 10% sampling

# Load testing: Only log critical issues
config.sampling_rate = 0.0  # Skip non-critical

# Monitoring phase: Full visibility
config.sampling_rate = 1.0  # Log everything

RailsErrorDashboard.on_error_logged do |error_log|
  # Called for every NEW error (not recurrences)

  # Send to custom logging service
  CustomLogger.log(
    level: error_log.severity,
    message: error_log.message,
    metadata: {
      error_type: error_log.error_type,
      platform: error_log.platform,
      environment: error_log.environment
    }
  )
end

RailsErrorDashboard.on_critical_error do |error_log|
  # Called ONLY for critical errors (in addition to on_error_logged)

  # Trigger PagerDuty incident
  PagerDuty.trigger(
    summary: "Critical: #{error_log.error_type}",
    severity: "critical",
    source: error_log.platform,
    custom_details: {
      message: error_log.message,
      backtrace: error_log.backtrace&.lines&.first(5)
    }
  )
end

RailsErrorDashboard.on_error_resolved do |error_log|
  # Called when error is marked as resolved

  # Notify team
  Slack.post_message(
    channel: "#engineering",
    text: "✅ Error resolved: #{error_log.error_type}",
    attachments: [{
      fields: [
        { title: "Resolved By", value: error_log.resolved_by_name },
        { title: "Occurrences", value: error_log.occurrence_count },
        { title: "Resolution", value: error_log.resolution_comment }
      ]
    }]
  )
end

# Callback 1: Log to external service
RailsErrorDashboard.on_error_logged do |error_log|
  Datadog.increment("errors.logged", tags: ["type:#{error_log.error_type}"])
end

# Callback 2: Send to analytics
RailsErrorDashboard.on_error_logged do |error_log|
  Analytics.track_error(error_log)
end

# Both callbacks will execute

RailsErrorDashboard.on_error_logged do |error_log|
  raise "Callback error"  # Logged as warning, other callbacks still run
end

RailsErrorDashboard.on_error_logged do |error_log|
  puts "This still executes"  # ✓ Runs even if previous callback failed
end

RailsErrorDashboard.on_error_logged do |error_log|
  Datadog::Statsd.increment("errors.logged",
    tags: [
      "severity:#{error_log.severity}",
      "platform:#{error_log.platform}",
      "environment:#{error_log.environment}"
    ]
  )
end

RailsErrorDashboard.on_critical_error do |error_log|
  Sentry.capture_message(
    "Critical Error: #{error_log.error_type}",
    level: :fatal,
    extra: {
      error_id: error_log.id,
      message: error_log.message,
      platform: error_log.platform
    }
  )
end

RailsErrorDashboard.on_error_logged do |error_log|
  Prometheus.error_counter.increment(
    labels: {
      type: error_log.error_type,
      severity: error_log.severity,
      platform: error_log.platform
    }
  )
end

ActiveSupport::Notifications.subscribe("error_logged.rails_error_dashboard") do |name, start, finish, id, payload|
  # Payload contains:
  # - error_log: Full ErrorLog record
  # - error_id: Error ID
  # - error_type: Exception class name
  # - message: Error message
  # - severity: Error severity (:critical, :high, :medium, :low)
  # - platform: Platform (iOS, Android, API)
  # - environment: Rails environment
  # - occurred_at: Timestamp

  duration = finish - start
  StatsD.timing("error_logging.duration", duration)
  StatsD.increment("errors.logged", tags: ["type:#{payload[:error_type]}"])
end

ActiveSupport::Notifications.subscribe("critical_error.rails_error_dashboard") do |name, start, finish, id, payload|
  # Same payload as error_logged

  # Trigger immediate alert
  PagerDuty.trigger_incident(
    title: "Critical Error: #{payload[:error_type]}",
    severity: "critical",
    details: payload[:message]
  )
end

ActiveSupport::Notifications.subscribe("error_resolved.rails_error_dashboard") do |name, start, finish, id, payload|
  # Payload contains:
  # - error_log: Full ErrorLog record
  # - error_id: Error ID
  # - error_type: Exception class name
  # - resolved_by: Name of person who resolved it
  # - resolved_at: Timestamp

  Analytics.track_resolution(
    error_id: payload[:error_id],
    resolved_by: payload[:resolved_by],
    resolution_time: payload[:resolved_at] - payload[:error_log].occurred_at
  )
end

ActiveSupport::Notifications.subscribe("error_logged.rails_error_dashboard") do |*args|
  event = ActiveSupport::Notifications::Event.new(*args)

  puts "Event: #{event.name}"
  puts "Duration: #{event.duration}ms"
  puts "Error Type: #{event.payload[:error_type]}"
  puts "Severity: #{event.payload[:severity]}"
end

# Subscribe to all Rails Error Dashboard events
ActiveSupport::Notifications.subscribe(/rails_error_dashboard/) do |event|
  Rails.logger.info "Error Dashboard Event: #{event.name}"
end

ActiveSupport::Notifications.subscribe("critical_error.rails_error_dashboard") do |*args|
  event = ActiveSupport::Notifications::Event.new(*args)
  NewRelic::Agent.notice_error(
    StandardError.new(event.payload[:message]),
    custom_params: {
      error_id: event.payload[:error_id],
      platform: event.payload[:platform]
    }
  )
end

error_counter = Prometheus::Client::Counter.new(
  :rails_errors_total,
  docstring: "Total number of Rails errors",
  labels: [:type, :severity, :platform]
)

ActiveSupport::Notifications.subscribe("error_logged.rails_error_dashboard") do |*args|
  event = ActiveSupport::Notifications::Event.new(*args)
  error_counter.increment(
    labels: {
      type: event.payload[:error_type],
      severity: event.payload[:severity],
      platform: event.payload[:platform]
    }
  )
end

ActiveSupport::Notifications.subscribe("error_logged.rails_error_dashboard") do |*args|
  event = ActiveSupport::Notifications::Event.new(*args)

  Elasticsearch::Client.new.index(
    index: "rails-errors",
    body: {
      timestamp: event.payload[:occurred_at],
      error_type: event.payload[:error_type],
      message: event.payload[:message],
      severity: event.payload[:severity],
      platform: event.payload[:platform],
      environment: event.payload[:environment]
    }
  )
end

RailsErrorDashboard.configure do |config|
  # Enable async logging
  config.async_logging = true

  # Choose adapter: :sidekiq (default), :solid_queue, or :async
  config.async_adapter = :sidekiq
end

RailsErrorDashboard.configure do |config|
  # Limit backtrace to 50 lines (default)
  config.max_backtrace_lines = 50

  # Store more for detailed debugging
  config.max_backtrace_lines = 100

  # Minimal storage (just the first line)
  config.max_backtrace_lines = 1
end

# config/initializers/rails_error_dashboard.rb

RailsErrorDashboard.configure do |config|
  # ============================================================================
  # AUTHENTICATION (Always Required)
  # ============================================================================
  # Authentication is always required in all environments
  config.dashboard_username = ENV.fetch("ERROR_DASHBOARD_USER", "gandalf")
  config.dashboard_password = ENV.fetch("ERROR_DASHBOARD_PASSWORD", "youshallnotpass")

  # ============================================================================
  # CORE FEATURES (Always Enabled)
  # ============================================================================
  config.enable_middleware = true
  config.enable_error_subscriber = true
  config.user_model = "User"
  config.retention_days = 90

  # ============================================================================
  # NOTIFICATION SETTINGS
  # ============================================================================

  # Slack Notifications
  config.enable_slack_notifications = true
  config.slack_webhook_url = ENV["SLACK_WEBHOOK_URL"]

  # Email Notifications
  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")

  # Discord Notifications
  config.enable_discord_notifications = true
  config.discord_webhook_url = ENV["DISCORD_WEBHOOK_URL"]

  # PagerDuty Integration (critical errors only)
  config.enable_pagerduty_notifications = true
  config.pagerduty_integration_key = ENV["PAGERDUTY_INTEGRATION_KEY"]

  # Generic Webhook Notifications
  config.enable_webhook_notifications = true
  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
  config.async_logging = true
  config.async_adapter = :sidekiq  # Options: :sidekiq, :solid_queue, :async

  # Backtrace size limiting
  config.max_backtrace_lines = 50

  # Error Sampling (10% - critical errors ALWAYS logged)
  config.sampling_rate = 0.1

  # Ignored exceptions
  config.ignored_exceptions = [
    "ActionController::RoutingError",
    "ActionController::InvalidAuthenticityToken",
    /^ActiveRecord::RecordNotFound/
  ]

  # ============================================================================
  # DATABASE CONFIGURATION
  # ============================================================================
  config.use_separate_database = false

  # ============================================================================
  # ADVANCED ANALYTICS
  # ============================================================================

  # Baseline Anomaly Alerts
  config.enable_baseline_alerts = true
  config.baseline_alert_threshold_std_devs = 2.0
  config.baseline_alert_severities = [:critical, :high]
  config.baseline_alert_cooldown_minutes = 120

  # Fuzzy Error Matching
  config.enable_similar_errors = true

  # Co-occurring Errors
  config.enable_co_occurring_errors = true

  # Error Cascade Detection
  config.enable_error_cascades = true

  # Error Correlation Analysis
  config.enable_error_correlation = true

  # Platform Comparison
  config.enable_platform_comparison = true

  # Occurrence Pattern Detection
  config.enable_occurrence_patterns = true

  # ============================================================================
  # SOURCE CODE INTEGRATION (NEW!)
  # ============================================================================

  # Enable source code viewer
  config.enable_source_code_integration = true

  # Context lines around error (default: 5)
  config.source_code_context_lines = 5

  # Enable git blame integration
  config.enable_git_blame = true

  # Cache TTL in seconds (default: 3600 = 1 hour)
  config.source_code_cache_ttl = 3600

  # Security: only show app code (default: true)
  config.only_show_app_code_source = true

  # Branch strategy for repository links (default: :commit_sha)
  config.git_branch_strategy = :commit_sha

  # ============================================================================
  # BREADCRUMBS (NEW!)
  # ============================================================================

  # Enable breadcrumbs (request activity trail)
  config.enable_breadcrumbs = true

  # Max events per request (default: 40)
  config.breadcrumb_buffer_size = 40

  # Capture all categories (default: nil = all)
  # config.breadcrumb_categories = [:sql, :controller, :cache, :job, :mailer, :custom]

  # ============================================================================
  # SYSTEM HEALTH SNAPSHOT (NEW!)
  # ============================================================================

  # Capture GC, memory, threads, connection pool, RubyVM, YJIT at error time
  config.enable_system_health = true

  # ============================================================================
  # DEEP DEBUGGING (v0.4.0)
  # ============================================================================

  # Local variable capture via TracePoint(:raise)
  config.enable_local_variables = true
  config.local_variable_max_count = 15
  config.local_variable_max_depth = 3
  config.local_variable_max_string_length = 200

  # Instance variable capture from raising object
  config.enable_instance_variables = true
  config.instance_variable_max_count = 20

  # Swallowed exception detection (Ruby 3.3+ required)
  config.detect_swallowed_exceptions = true
  config.swallowed_exception_threshold = 0.95

  # On-demand diagnostic dump
  config.enable_diagnostic_dump = true

  # Rack Attack event tracking (requires breadcrumbs)
  config.enable_rack_attack_tracking = true

  # Process crash capture via at_exit hook
  config.enable_crash_capture = true
  # config.crash_capture_path = "/var/log/myapp/crashes"  # default: Dir.tmpdir

  # ============================================================================
  # ADDITIONAL CONFIGURATION
  # ============================================================================

  # Custom severity rules
  config.custom_severity_rules = {
    "PaymentError" => :critical,
    "ValidationError" => :low
  }

  # Enhanced metrics
  config.app_version = ENV["APP_VERSION"]
  config.git_sha = ENV["GIT_SHA"]
  # config.total_users_for_impact = 10000  # For user impact % calculation
end

# ============================================================================
# NOTIFICATION CALLBACKS
# ============================================================================

# Alert on critical errors
RailsErrorDashboard.on_critical_error do |error_log|
  PagerDuty.trigger(
    summary: "Critical: #{error_log.error_type}",
    severity: "critical",
    source: error_log.platform
  )
end

# Track metrics
RailsErrorDashboard.on_error_logged do |error_log|
  StatsD.increment("errors.logged",
    tags: [
      "type:#{error_log.error_type}",
      "severity:#{error_log.severity}",
      "platform:#{error_log.platform}"
    ]
  )
end

# Notify on resolution
RailsErrorDashboard.on_error_resolved do |error_log|
  Slack.post_message(
    channel: "#engineering",
    text: "✅ #{error_log.error_type} resolved by #{error_log.resolved_by_name}"
  )
end

# ============================================================================
# ACTIVESUPPORT NOTIFICATIONS
# ============================================================================

# Send to external logging service
ActiveSupport::Notifications.subscribe("error_logged.rails_error_dashboard") do |*args|
  event = ActiveSupport::Notifications::Event.new(*args)

  Elasticsearch::Client.new.index(
    index: "rails-errors",
    body: {
      timestamp: event.payload[:occurred_at],
      error_type: event.payload[:error_type],
      message: event.payload[:message],
      severity: event.payload[:severity],
      platform: event.payload[:platform]
    }
  )
end

RailsErrorDashboard.configure do |config|
  # Common configuration
  config.user_model = "User"
  config.max_backtrace_lines = 50

  if Rails.env.production?
    # Production: Aggressive sampling, strict filtering
    config.sampling_rate = 0.1
    config.ignored_exceptions = [
      "ActionController::RoutingError",
      /ActionController::InvalidAuthenticityToken/
    ]

  elsif Rails.env.staging?
    # Staging: Moderate sampling
    config.sampling_rate = 0.5

  else
    # Development/Test: Log everything
    config.sampling_rate = 1.0
    config.ignored_exceptions = []
  end
end

# Reset to defaults
RailsErrorDashboard.reset_configuration!

# Reconfigure
RailsErrorDashboard.configure do |config|
  config.sampling_rate = 1.0
end