rails_error_dashboard 0.1.27 → 0.1.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dfa475005d810cf2797830e0e00df4ad5b83f7e63df2b8c859ce8c1a4aa555e
-  data.tar.gz: d35282497e6f04be43816e1473e941e7e1e797ab276082643148504fc11d1806
+  metadata.gz: 5a0f4cca16260c154f28b927ad49e276376fb390da7469479879e59e3ae07884
+  data.tar.gz: d33904659ed7e1e98cf76f7bef72510f610bf2be611d1562e1bbadc06db5ed82
 SHA512:
-  metadata.gz: 03d48971cf4056b8fcf8facc6a8355484647ba725d65a56bdf93e448e5a84b2406784b9a05818a2285e89b49ae1b2eea1f798b43be4c4a273d123c411f755d57
-  data.tar.gz: e70c135a00a15f7325eb10a0c58be45ecf1b8e05f1b7eeb42e538450e07cb69a68a36816d78b49a0c3e5089b58a251bfef45d1155cf3cdc58c3a804cb9d53e20
+  metadata.gz: 2adbbee9b22e299ee55090db83aea7a48f162f519837e626a198ee1ae553e5b5c4030eee28223ad367bd55042543f3c7dea612de89dfe5f0857ac410d115c577
+  data.tar.gz: 4bb63ab6e3d16bda1c8430e35944c80b057e264bd0d87b675dd5ce0fe832af92334039e597e6708579064a3df3c537fec5aabcac715157bc47d69d8dc5e359cd

data/README.md

@@ -29,9 +29,9 @@ Experience the full dashboard with 250+ realistic Rails errors, LOTR-themed demo
 ---
 
 ### ⚠️ BETA SOFTWARE
-This Rails Engine is in beta and under active development. While functional and tested (850+ tests passing), the API may change before v1.0.0. Use in production at your own discretion.
+This Rails Engine is in beta and under active development. While functional and tested (935+ tests passing), the API may change before v1.0.0. Use in production at your own discretion.
 
-**Supports**: Rails 7.0 - 8.1 | Ruby 3.2+
+**Supports**: Rails 7.0 - 8.0 (+ edge 8.1) | Ruby 3.2 - 3.4
 
 ---
 
@@ -80,10 +80,6 @@ This Rails Engine is in beta and under active development. While functional and
 
 ---
 
-![Dashboard Screenshot](https://via.placeholder.com/800x400?text=Error+Dashboard+Screenshot)
-
----
-
 ## ✨ Features
 
 ### Core Features (Always Enabled)
@@ -121,7 +117,7 @@ HTTP Basic Auth, environment-based settings, optional separate database for isol
 - **Separate Database** - Isolate error data for better performance
 - **Database Indexes** - Composite indexes and PostgreSQL GIN full-text search
 
-#### 🧠 Advanced Analytics (8 Powerful Features)
+#### 🧠 Advanced Analytics (7 Powerful Features)
 
 **1. Baseline Anomaly Alerts** 🔔
 Automatically detect unusual error rate spikes using statistical analysis (mean + std dev). Get proactive notifications when errors exceed expected baselines with intelligent cooldown to avoid alert fatigue.
@@ -144,8 +140,8 @@ Compare iOS vs Android vs Web health metrics side-by-side. Platform-specific err
 **7. Occurrence Pattern Detection** 📈
 Detect cyclical patterns (business hours, nighttime, weekend rhythms) and error bursts (many errors in short time). Understand when and how your errors happen.
 
-**8. Developer Insights** 💡
-AI-powered insights with severity detection, platform stability scoring, actionable recommendations, and recent error activity summaries.
+**Plus: Developer Insights Dashboard** 💡
+Built-in analytics dashboard with severity detection, platform stability scoring, actionable recommendations, and recent error activity summaries (always available, no configuration needed).
 
 #### 🔌 Plugin System
 Extensible architecture with event hooks (`on_error_logged`, `on_error_resolved`, `on_threshold_exceeded`). Built-in examples for Jira integration, metrics tracking, audit logging. Easy to create custom plugins - just drop a file in `config/initializers/error_dashboard_plugins/`.
@@ -173,7 +169,7 @@ rails db:migrate
 The installer will guide you through optional feature selection:
 - **Notifications** (Slack, Email, Discord, PagerDuty, Webhooks)
 - **Performance** (Async Logging, Error Sampling, Separate Database)
-- **Advanced Analytics** (8 powerful features including baseline alerts, fuzzy matching, platform comparison)
+- **Advanced Analytics** (7 powerful features including baseline alerts, fuzzy matching, platform comparison)
 
 **All features are opt-in** - choose what you need during installation, or enable/disable them later in the initializer.
 
@@ -665,6 +661,193 @@ Rails Error Dashboard is available as open source under the terms of the [MIT Li
 
 ---
 
+## ❓ Frequently Asked Questions
+
+<details>
+<summary><strong>Is this production-ready?</strong></summary>
+
+This is currently in **beta** but actively tested with 935+ passing tests across Rails 7.0-8.0 and Ruby 3.2-3.4. Many users are running it in production. See [production requirements](docs/FEATURES.md#production-readiness).
+</details>
+
+<details>
+<summary><strong>How does this compare to Sentry/Rollbar/Honeybadger?</strong></summary>
+
+**Similar**: Error tracking, grouping, notifications, dashboards
+**Better**: 100% free, self-hosted (your data stays with you), no usage limits, Rails-optimized
+**Trade-offs**: You manage hosting/backups, fewer integrations than commercial services
+
+See [full comparison](docs/features/PLATFORM_COMPARISON.md).
+</details>
+
+<details>
+<summary><strong>What's the performance impact?</strong></summary>
+
+Minimal with async logging enabled:
+- **Synchronous**: ~10-50ms per error (blocks request)
+- **Async (recommended)**: ~1-2ms (queues to background job)
+- **Sampling**: Log only 10% of non-critical errors for high-traffic apps
+
+See [Performance Guide](docs/guides/ERROR_SAMPLING_AND_FILTERING.md).
+</details>
+
+<details>
+<summary><strong>Can I use a separate database?</strong></summary>
+
+Yes! Configure in your initializer:
+
+```ruby
+RailsErrorDashboard.configure do |config|
+  config.database = :errors  # Use separate database
+end
+```
+
+See [Database Options Guide](docs/guides/DATABASE_OPTIONS.md).
+</details>
+
+<details>
+<summary><strong>How do I migrate from Sentry/Rollbar?</strong></summary>
+
+1. Install Rails Error Dashboard
+2. Run both systems in parallel (1-2 weeks)
+3. Verify all errors are captured
+4. Remove old error tracking gem
+5. Update team documentation
+
+Historical data cannot be imported (different formats).
+</details>
+
+<details>
+<summary><strong>Does it work with API-only Rails apps?</strong></summary>
+
+Yes! The error logging works in API-only mode. The dashboard UI requires a browser but can be:
+- Mounted in a separate admin app
+- Run in a separate Rails instance pointing to the same database
+- Accessed via SSH tunnel
+
+See [API-only setup](docs/guides/MOBILE_APP_INTEGRATION.md#backend-setup-rails-api).
+</details>
+
+<details>
+<summary><strong>How do I track multiple Rails apps?</strong></summary>
+
+Automatic! Just set `APP_NAME` environment variable:
+
+```bash
+# App 1
+APP_NAME=my-api rails server
+
+# App 2
+APP_NAME=my-admin rails server
+```
+
+All apps share the same dashboard. See [Multi-App Guide](docs/MULTI_APP_PERFORMANCE.md).
+</details>
+
+<details>
+<summary><strong>Can I customize error severity levels?</strong></summary>
+
+Yes! Configure custom rules in your initializer:
+
+```ruby
+RailsErrorDashboard.configure do |config|
+  config.custom_severity_rules = {
+    /ActiveRecord::RecordNotFound/ => :low,
+    /Stripe::/ => :critical
+  }
+end
+```
+
+See [Customization Guide](docs/CUSTOMIZATION.md).
+</details>
+
+<details>
+<summary><strong>How long are errors stored?</strong></summary>
+
+Forever by default. Configure retention policy:
+
+```ruby
+RailsErrorDashboard.configure do |config|
+  config.retention_days = 90  # Auto-delete after 90 days
+end
+```
+
+Or clean up manually with rake tasks. See [Database Optimization](docs/guides/DATABASE_OPTIMIZATION.md).
+</details>
+
+<details>
+<summary><strong>Can I get Slack/Discord notifications?</strong></summary>
+
+Yes! Enable during installation or configure manually:
+
+```ruby
+RailsErrorDashboard.configure do |config|
+  config.enable_slack_notifications = true
+  config.slack_webhook_url = ENV['SLACK_WEBHOOK_URL']
+end
+```
+
+Supports Slack, Discord, Email, PagerDuty, and custom webhooks. See [Notifications Guide](docs/guides/NOTIFICATIONS.md).
+</details>
+
+<details>
+<summary><strong>Does it work with Turbo/Hotwire?</strong></summary>
+
+Yes! Includes Turbo Streams support for real-time updates. Errors appear in the dashboard instantly without page refresh.
+</details>
+
+<details>
+<summary><strong>How do I report errors from mobile apps (React Native/Flutter)?</strong></summary>
+
+Make HTTP POST requests to your Rails API:
+
+```javascript
+// React Native example
+fetch('https://api.example.com/error_dashboard/api/v1/errors', {
+  method: 'POST',
+  headers: {
+    'Content-Type': 'application/json',
+    'Authorization': 'Basic ' + btoa('admin:password')
+  },
+  body: JSON.stringify({
+    error_class: 'TypeError',
+    message: 'Cannot read property...',
+    platform: 'iOS'
+  })
+});
+```
+
+See [Mobile App Integration](docs/guides/MOBILE_APP_INTEGRATION.md).
+</details>
+
+<details>
+<summary><strong>Can I build custom integrations?</strong></summary>
+
+Yes! Use the plugin system:
+
+```ruby
+class MyCustomPlugin < RailsErrorDashboard::Plugin
+  def on_error_logged(error_log)
+    # Your custom logic
+  end
+end
+
+RailsErrorDashboard::PluginRegistry.register(MyCustomPlugin.new)
+```
+
+See [Plugin System Guide](docs/PLUGIN_SYSTEM.md).
+</details>
+
+<details>
+<summary><strong>What if I need help?</strong></summary>
+
+- **📖 Read the docs**: [docs/README.md](docs/README.md)
+- **🐛 Report bugs**: [GitHub Issues](https://github.com/AnjanJ/rails_error_dashboard/issues)
+- **💡 Ask questions**: [GitHub Discussions](https://github.com/AnjanJ/rails_error_dashboard/discussions)
+- **🔒 Security issues**: See [SECURITY.md](SECURITY.md)
+</details>
+
+---
+
 ## 💬 Support
 
 - **📖 Documentation**: [docs/](docs/README.md)
@@ -673,6 +856,6 @@ Rails Error Dashboard is available as open source under the terms of the [MIT Li
 
 ---
 
-**Made with ❤️ by Anjan for the Rails community**
+**Made with ❤️ by [Anjan](https://www.anjan.dev) for the Rails community**
 
 *One Gem to rule them all, One Gem to find them, One Gem to bring them all, and in the dashboard bind them.* 🧙‍♂️

data/lib/rails_error_dashboard/version.rb

@@ -1,3 +1,3 @@
 module RailsErrorDashboard
-  VERSION = "0.1.27"
+  VERSION = "0.1.28"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_error_dashboard
 version: !ruby/object:Gem::Version
-  version: 0.1.27
+  version: 0.1.28
 platform: ruby
 authors:
 - Anjan Jagirdar
@@ -116,7 +116,7 @@ dependencies:
         version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.3.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -126,7 +126,7 @@ dependencies:
         version: 1.3.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: 1.3.7
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -386,7 +386,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.27\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n\U0001F195
+  \ Rails Error Dashboard v0.1.28\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n\n\U0001F195
   First time? Quick start:\n   rails generate rails_error_dashboard:install\n   rails
   db:migrate\n   # Add to config/routes.rb:\n   mount RailsErrorDashboard::Engine
   => '/error_dashboard'\n\n\U0001F504 Upgrading from v0.1.x?\n   rails db:migrate\n