Class: RailsErrorDashboard::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/rails_error_dashboard/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/rails_error_dashboard/configuration.rb', line 93

def initialize
  # Default values
  @dashboard_username = ENV.fetch("ERROR_DASHBOARD_USER", "gandalf")
  @dashboard_password = ENV.fetch("ERROR_DASHBOARD_PASSWORD", "youshallnotpass")
  @require_authentication = true
  @require_authentication_in_development = false

  @user_model = "User"

  # Notification settings (disabled by default - enable during installation or in initializer)
  @slack_webhook_url = ENV["SLACK_WEBHOOK_URL"]
  @notification_email_recipients = ENV.fetch("ERROR_NOTIFICATION_EMAILS", "").split(",").map(&:strip)
  @notification_email_from = ENV.fetch("ERROR_NOTIFICATION_FROM", "errors@example.com")
  @dashboard_base_url = ENV["DASHBOARD_BASE_URL"]
  @enable_slack_notifications = false
  @enable_email_notifications = false

  # Discord notification settings
  @discord_webhook_url = ENV["DISCORD_WEBHOOK_URL"]
  @enable_discord_notifications = false

  # PagerDuty notification settings (critical errors only)
  @pagerduty_integration_key = ENV["PAGERDUTY_INTEGRATION_KEY"]
  @enable_pagerduty_notifications = false

  # Generic webhook settings (array of URLs)
  @webhook_urls = ENV.fetch("WEBHOOK_URLS", "").split(",").map(&:strip).reject(&:empty?)
  @enable_webhook_notifications = false

  @use_separate_database = ENV.fetch("USE_SEPARATE_ERROR_DB", "false") == "true"

  @retention_days = 90

  @enable_middleware = true
  @enable_error_subscriber = true

  # Advanced configuration defaults
  @custom_severity_rules = {}
  @ignored_exceptions = []
  @sampling_rate = 1.0 # 100% by default
  @async_logging = false
  @async_adapter = :sidekiq # Battle-tested default
  @max_backtrace_lines = 50

  # Rate limiting defaults
  @enable_rate_limiting = false # OFF by default (opt-in)
  @rate_limit_per_minute = 100  # Requests per minute per IP for API endpoints

  # Enhanced metrics defaults
  @app_version = ENV["APP_VERSION"]
  @git_sha = ENV["GIT_SHA"]
  @total_users_for_impact = nil # Auto-detect if not set

  # Advanced error analysis features (all OFF by default - opt-in)
  @enable_similar_errors = false        # Fuzzy error matching
  @enable_co_occurring_errors = false   # Co-occurring error detection
  @enable_error_cascades = false        # Error cascade detection
  @enable_error_correlation = false     # Version/user/time correlation
  @enable_platform_comparison = false   # Platform health comparison
  @enable_occurrence_patterns = false   # Pattern detection

  # Baseline alert defaults
  @enable_baseline_alerts = false  # OFF by default (opt-in)
  @baseline_alert_threshold_std_devs = ENV.fetch("BASELINE_ALERT_THRESHOLD", "2.0").to_f
  @baseline_alert_severities = [ :critical, :high ] # Alert on critical and high severity anomalies
  @baseline_alert_cooldown_minutes = ENV.fetch("BASELINE_ALERT_COOLDOWN", "120").to_i

  # Internal logging defaults - SILENT by default
  @enable_internal_logging = false  # Opt-in for debugging
  @log_level = :silent  # Silent by default, use :debug, :info, :warn, :error, or :silent

  @notification_callbacks = {
    error_logged: [],
    critical_error: [],
    error_resolved: []
  }
end

Instance Attribute Details

#app_version ⇒ Object

Enhanced metrics



68
69
70
 
# File 'lib/rails_error_dashboard/configuration.rb', line 68

def app_version
  @app_version
end

#async_adapter ⇒ Object

:sidekiq, :solid_queue, or :async



58
59
60
 
# File 'lib/rails_error_dashboard/configuration.rb', line 58

def async_adapter
  @async_adapter
end

#async_logging ⇒ Object

Async logging configuration



57
58
59
 
# File 'lib/rails_error_dashboard/configuration.rb', line 57

def async_logging
  @async_logging
end

#baseline_alert_cooldown_minutes ⇒ Object

Minutes between alerts for same error type (default: 120)



84
85
86
 
# File 'lib/rails_error_dashboard/configuration.rb', line 84

def baseline_alert_cooldown_minutes
  @baseline_alert_cooldown_minutes
end

#baseline_alert_severities ⇒ Object

Array of severities to alert on (default: [:critical, :high])



83
84
85
 
# File 'lib/rails_error_dashboard/configuration.rb', line 83

def baseline_alert_severities
  @baseline_alert_severities
end

#baseline_alert_threshold_std_devs ⇒ Object

Number of std devs to trigger alert (default: 2.0)



82
83
84
 
# File 'lib/rails_error_dashboard/configuration.rb', line 82

def baseline_alert_threshold_std_devs
  @baseline_alert_threshold_std_devs
end

#custom_severity_rules ⇒ Object

Advanced configuration options Custom severity classification rules (hash of error_type => severity)



48
49
50
 
# File 'lib/rails_error_dashboard/configuration.rb', line 48

def custom_severity_rules
  @custom_severity_rules
end

#dashboard_base_url ⇒ Object

Returns the value of attribute dashboard_base_url.



18
19
20
 
# File 'lib/rails_error_dashboard/configuration.rb', line 18

def dashboard_base_url
  @dashboard_base_url
end

#dashboard_password ⇒ Object

Returns the value of attribute dashboard_password.



7
8
9
 
# File 'lib/rails_error_dashboard/configuration.rb', line 7

def dashboard_password
  @dashboard_password
end

#dashboard_username ⇒ Object

Dashboard authentication



6
7
8
 
# File 'lib/rails_error_dashboard/configuration.rb', line 6

def dashboard_username
  @dashboard_username
end

#discord_webhook_url ⇒ Object

Discord notifications



23
24
25
 
# File 'lib/rails_error_dashboard/configuration.rb', line 23

def discord_webhook_url
  @discord_webhook_url
end

#enable_baseline_alerts ⇒ Object

Baseline alert configuration



81
82
83
 
# File 'lib/rails_error_dashboard/configuration.rb', line 81

def enable_baseline_alerts
  @enable_baseline_alerts
end

#enable_co_occurring_errors ⇒ Object

Detect errors happening together



74
75
76
 
# File 'lib/rails_error_dashboard/configuration.rb', line 74

def enable_co_occurring_errors
  @enable_co_occurring_errors
end

#enable_discord_notifications ⇒ Object

Returns the value of attribute enable_discord_notifications.



24
25
26
 
# File 'lib/rails_error_dashboard/configuration.rb', line 24

def enable_discord_notifications
  @enable_discord_notifications
end

#enable_email_notifications ⇒ Object

Returns the value of attribute enable_email_notifications.



20
21
22
 
# File 'lib/rails_error_dashboard/configuration.rb', line 20

def enable_email_notifications
  @enable_email_notifications
end

#enable_error_cascades ⇒ Object

Parent→child error relationships



75
76
77
 
# File 'lib/rails_error_dashboard/configuration.rb', line 75

def enable_error_cascades
  @enable_error_cascades
end

#enable_error_correlation ⇒ Object

Version/user/time correlation



76
77
78
 
# File 'lib/rails_error_dashboard/configuration.rb', line 76

def enable_error_correlation
  @enable_error_correlation
end

#enable_error_subscriber ⇒ Object

Enable/disable Rails.error subscriber



44
45
46
 
# File 'lib/rails_error_dashboard/configuration.rb', line 44

def enable_error_subscriber
  @enable_error_subscriber
end

#enable_internal_logging ⇒ Object

Internal logging configuration



90
91
92
 
# File 'lib/rails_error_dashboard/configuration.rb', line 90

def enable_internal_logging
  @enable_internal_logging
end

#enable_middleware ⇒ Object

Enable/disable error catching middleware



41
42
43
 
# File 'lib/rails_error_dashboard/configuration.rb', line 41

def enable_middleware
  @enable_middleware
end

#enable_occurrence_patterns ⇒ Object

Cyclical/burst pattern detection



78
79
80
 
# File 'lib/rails_error_dashboard/configuration.rb', line 78

def enable_occurrence_patterns
  @enable_occurrence_patterns
end

#enable_pagerduty_notifications ⇒ Object

Returns the value of attribute enable_pagerduty_notifications.



28
29
30
 
# File 'lib/rails_error_dashboard/configuration.rb', line 28

def enable_pagerduty_notifications
  @enable_pagerduty_notifications
end

#enable_platform_comparison ⇒ Object

iOS vs Android analytics



77
78
79
 
# File 'lib/rails_error_dashboard/configuration.rb', line 77

def enable_platform_comparison
  @enable_platform_comparison
end

#enable_rate_limiting ⇒ Object

Rate limiting configuration



64
65
66
 
# File 'lib/rails_error_dashboard/configuration.rb', line 64

def enable_rate_limiting
  @enable_rate_limiting
end

#enable_similar_errors ⇒ Object

Advanced error analysis features



73
74
75
 
# File 'lib/rails_error_dashboard/configuration.rb', line 73

def enable_similar_errors
  @enable_similar_errors
end

#enable_slack_notifications ⇒ Object

Returns the value of attribute enable_slack_notifications.



19
20
21
 
# File 'lib/rails_error_dashboard/configuration.rb', line 19

def enable_slack_notifications
  @enable_slack_notifications
end

#enable_webhook_notifications ⇒ Object

Returns the value of attribute enable_webhook_notifications.



32
33
34
 
# File 'lib/rails_error_dashboard/configuration.rb', line 32

def enable_webhook_notifications
  @enable_webhook_notifications
end

#git_sha ⇒ Object

Returns the value of attribute git_sha.



69
70
71
 
# File 'lib/rails_error_dashboard/configuration.rb', line 69

def git_sha
  @git_sha
end

#ignored_exceptions ⇒ Object

Exceptions to ignore (array of strings, regexes, or classes)



51
52
53
 
# File 'lib/rails_error_dashboard/configuration.rb', line 51

def ignored_exceptions
  @ignored_exceptions
end

#log_level ⇒ Object

Returns the value of attribute log_level.



91
92
93
 
# File 'lib/rails_error_dashboard/configuration.rb', line 91

def log_level
  @log_level
end

#max_backtrace_lines ⇒ Object

Backtrace configuration



61
62
63
 
# File 'lib/rails_error_dashboard/configuration.rb', line 61

def max_backtrace_lines
  @max_backtrace_lines
end

#notification_callbacks ⇒ Object (readonly)

Notification callbacks (managed via helper methods, not set directly)



87
88
89
 
# File 'lib/rails_error_dashboard/configuration.rb', line 87

def notification_callbacks
  @notification_callbacks
end

#notification_email_from ⇒ Object

Returns the value of attribute notification_email_from.



17
18
19
 
# File 'lib/rails_error_dashboard/configuration.rb', line 17

def notification_email_from
  @notification_email_from
end

#notification_email_recipients ⇒ Object

Returns the value of attribute notification_email_recipients.



16
17
18
 
# File 'lib/rails_error_dashboard/configuration.rb', line 16

def notification_email_recipients
  @notification_email_recipients
end

#pagerduty_integration_key ⇒ Object

PagerDuty notifications (critical errors only)



27
28
29
 
# File 'lib/rails_error_dashboard/configuration.rb', line 27

def pagerduty_integration_key
  @pagerduty_integration_key
end

#rate_limit_per_minute ⇒ Object

Returns the value of attribute rate_limit_per_minute.



65
66
67
 
# File 'lib/rails_error_dashboard/configuration.rb', line 65

def rate_limit_per_minute
  @rate_limit_per_minute
end

#require_authentication ⇒ Object

Returns the value of attribute require_authentication.



8
9
10
 
# File 'lib/rails_error_dashboard/configuration.rb', line 8

def require_authentication
  @require_authentication
end

#require_authentication_in_development ⇒ Object

Returns the value of attribute require_authentication_in_development.



9
10
11
 
# File 'lib/rails_error_dashboard/configuration.rb', line 9

def require_authentication_in_development
  @require_authentication_in_development
end

#retention_days ⇒ Object

Retention policy (days to keep errors)



38
39
40
 
# File 'lib/rails_error_dashboard/configuration.rb', line 38

def retention_days
  @retention_days
end

#sampling_rate ⇒ Object

Sampling rate for non-critical errors (0.0 to 1.0, default 1.0 = 100%)



54
55
56
 
# File 'lib/rails_error_dashboard/configuration.rb', line 54

def sampling_rate
  @sampling_rate
end

#slack_webhook_url ⇒ Object

Notifications



15
16
17
 
# File 'lib/rails_error_dashboard/configuration.rb', line 15

def slack_webhook_url
  @slack_webhook_url
end

#total_users_for_impact ⇒ Object

For user impact % calculation



70
71
72
 
# File 'lib/rails_error_dashboard/configuration.rb', line 70

def total_users_for_impact
  @total_users_for_impact
end

#use_separate_database ⇒ Object

Separate database configuration



35
36
37
 
# File 'lib/rails_error_dashboard/configuration.rb', line 35

def use_separate_database
  @use_separate_database
end

#user_model ⇒ Object

User model (for associations)



12
13
14
 
# File 'lib/rails_error_dashboard/configuration.rb', line 12

def user_model
  @user_model
end

#webhook_urls ⇒ Object

Generic webhook notifications



31
32
33
 
# File 'lib/rails_error_dashboard/configuration.rb', line 31

def webhook_urls
  @webhook_urls
end

Instance Method Details

#reset! ⇒ Object

Reset configuration to defaults



172
173
174
 
# File 'lib/rails_error_dashboard/configuration.rb', line 172

def reset!
  initialize
end