Rails Error Dashboard Documentation
Welcome to the Rails Error Dashboard documentation! This guide will help you get started, customize your setup, and make the most of the advanced features.
Documentation Structure
Getting Started
- Quickstart Guide - Get up and running in 5 minutes
- Installation - Detailed installation instructions
- Configuration - Complete configuration reference
- Migration & Upgrade Strategy - Squashed migrations and v0.2.0 upgrade guide
- Uninstall Guide - Complete removal instructions (manual + automated)
- FAQ - Common questions answered
Core Features
- Error Tracking & Capture - Understanding the main dashboard
- Workflow Management - Managing and resolving errors
- Notifications - Setting up alerts (Slack, Email, Discord, PagerDuty)
Monitoring & Health (v0.3)
- System Health Snapshots - GC stats, threads, connection pool, memory, RubyVM cache, YJIT stats
- N+1 Query Detection - Detect N+1 queries from breadcrumbs
- Job Health - Background job queue stats (Sidekiq, SolidQueue, GoodJob)
- Database Health - PgHero-style connection pool and table stats
- Cache Health - Cache hit rates and miss patterns
- Deprecation Tracking - Track Rails deprecation warnings
Deep Debugging (v0.4)
- Local Variable Capture - Capture local variables at the point of exception via TracePoint
- Instance Variable Capture - Capture instance variables from the raising object
- Swallowed Exception Detection - Detect silently rescued exceptions (Ruby 3.3+)
- On-Demand Diagnostic Dump - Snapshot system state on demand
- Rack Attack Event Tracking - Track throttle/blocklist events as breadcrumbs
- Process Crash Capture - Capture crashes via at_exit hook
Advanced Analytics
- Source Code Integration - View source code, git blame, and repository links in errors
- Advanced Error Grouping - Fuzzy matching, co-occurring errors, cascades
- Baseline Monitoring - Statistical anomaly detection and alerts
- Platform Comparison - iOS vs Android vs API health analysis
- Occurrence Patterns - Cyclical patterns and burst detection
- Error Correlation - Release and user correlation analysis
Customization
- Multi-App Support - Track multiple applications from one dashboard
- Customization Guide - Customize views, severity rules, and behavior
- Settings Dashboard - View current configuration and verify feature status
- Plugin System - Build custom plugins and integrations
- Database Options - Using a separate database
Integration
- Mobile App Integration - Integrate with React Native, Flutter, etc.
- Batch Operations - Bulk error management
- API Reference - Complete API documentation
- Real-Time Updates - Turbo Streams and live updates
- Solid Queue Setup - Configure Solid Queue for async logging
Performance & Optimization
- Database Optimization - Query performance and indexing
- Backtrace Limiting - Reduce storage size
- Error Sampling & Filtering - High-volume error handling
- Error Trend Visualizations - Analytics and charting
Development
- Changelog - Version history and updates
- Testing - Running and writing tests
- Troubleshooting - Common problems and solutions
- Security Policy - Report vulnerabilities and security best practices
Quick Links
For New Users
- Quickstart Guide - 5-minute setup
- Configuration - Basic configuration
- Notifications - Set up Slack alerts
For Advanced Users
- Local Variable Capture - Debug with exact variable values
- Swallowed Exception Detection - Find silently rescued exceptions
- Diagnostic Dumps - Snapshot system state on demand
- Plugin System - Custom integrations
For Developers
- API Reference - Complete API docs
- Plugin Development - Build plugins
- Testing Guide - Test your setup
Documentation by Use Case
“I want to get started quickly”
“I need to customize error severity levels”
“I want Slack notifications for critical errors”
“I need to track errors by app version”
“I want to build a custom integration”
“I need to understand platform stability”
“I want proactive alerting for anomalies”
“I want to see exact variable values when an exception occurs”
→ Local Variable Capture (enable enable_local_variables and/or enable_instance_variables)
“I want to find exceptions that are silently rescued”
→ Swallowed Exception Detection (requires Ruby 3.3+)
“I want to snapshot my app’s system state on demand”
→ On-Demand Diagnostic Dump (dashboard button or rake task)
“I want to capture errors from process crashes”
→ Process Crash Capture (at_exit hook writes to disk, imported on next boot)
“I want to see source code directly in error details”
“I want to find N+1 queries or cache issues across all errors”
→ Breadcrumbs (enable breadcrumbs, then visit N+1 Queries or Cache Health pages)
“I need to track multiple Rails applications”
“I need to uninstall Rails Error Dashboard”
Searching the Documentation
- Configuration options: See Configuration Guide
- API methods: See API Reference
- Term definitions: See Glossary
- Code examples: Most guides include code examples
- Troubleshooting: Each guide has a troubleshooting section
Getting Help
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Security: Security Policy - Report security vulnerabilities
- Stack Overflow: Tag your questions with
rails-error-dashboard
Documentation Versions
This documentation is for Rails Error Dashboard v0.4.0 (Latest).
For version history, see the Changelog.
Need help? Check the guides above or open an issue.