rails_error_dashboard 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf28bf2e55b8765a3b73aa4fffc4acbd2d73f52078405934bfcbd717bf5a071
-  data.tar.gz: f3d002a763e3d7d862500744b94d1c2a051a86bf90a30750453e8bb5826484ac
+  metadata.gz: be10014454096322f4e47dd754450d2c731a836686034a9ecb13ba1de3751921
+  data.tar.gz: 02e299b47fb947d4ec046f4fe1312d82df7a96e15705431fc612e1fed1a2be04
 SHA512:
-  metadata.gz: 601f7444c2bc77ac76568fbb0980cf6fed715f5e94064e59b66f52a55f28e453c2415eebd48c39b14dbc57c9cf55c4992b245b19f4ae598e1c9de1ba8c6b4f0d
-  data.tar.gz: c5597382e1c36a2a58edea25132be844b157ea87718027b0efeb1921fefacf79025875c39d162f5fbfa33e2ffd740a16f9b14534faf716f0a4b90f0f226e767a
+  metadata.gz: 7660280bffe36717930bc5c9c10bb2c8b97d689b1c3dd44d1a8e761156183a373768e96d48698f35ac2b807485ee2eb06edd5b9f1ba0e681e7c4715f9b203e34
+  data.tar.gz: e12b4a5159144c4b870e986e8616f2466fa1330ccda9c243d6acb77c2e16e35feb03614ab6c5d919ee875d013226f110e8934041e48b90e3b835b4fbd614b3fd

data/README.md

@@ -76,28 +76,71 @@ This Rails Engine is in beta and under active development. While functional and
 
 ## ✨ Features
 
-### 🎯 Complete Error Tracking
+### Core Features (Always Enabled)
+
+#### 🎯 Complete Error Tracking
 Automatic error capture from Rails controllers, jobs, and middleware. Frontend & mobile support for React, React Native, Vue, Angular, Flutter. Platform detection (iOS/Android/Web/API), user context tracking, full stack traces.
 
-### 📊 Beautiful Dashboard
-Modern Bootstrap 5 UI with dark/light mode, responsive design, real-time statistics, search and filtering, fast pagination.
+#### 📊 Beautiful Dashboard
+Modern Bootstrap 5 UI with dark/light mode, responsive design, real-time statistics, search and filtering, fast pagination. Overview dashboard with critical alerts, error trend charts, and platform health summary.
+
+#### 📈 Analytics & Insights
+7-day trend charts, severity breakdown, spike detection, resolution rate tracking, user impact analysis. Comprehensive analytics page with hourly patterns, mobile vs API breakdowns, and top affected users.
+
+#### 🔧 Workflow Management
+Error assignment and status tracking, priority levels (critical/high/medium/low), snooze functionality, comment threads, batch operations (bulk resolve/delete), resolution tracking with references.
+
+#### 🔒 Security & Privacy
+HTTP Basic Auth, environment-based settings, optional separate database for isolation. Your data stays on your server - no third-party access.
+
+### Optional Features (Choose During Install)
+
+#### 🚨 Multi-Channel Notifications
+
+- **Slack** - Rich formatted messages with error context and direct dashboard links
+- **Email** - HTML formatted alerts with full error details
+- **Discord** - Embedded messages with severity color coding
+- **PagerDuty** - Critical error escalation with incident management
+- **Webhooks** - Custom integrations with any service (JSON payloads)
+
+#### ⚡ Performance Optimizations
+
+- **Async Logging** - Non-blocking error capture using ActiveJob (Sidekiq/SolidQueue/Async)
+- **Error Sampling** - Reduce storage by sampling high-frequency errors
+- **Backtrace Limiting** - Save 70-90% storage with smart truncation
+- **Separate Database** - Isolate error data for better performance
+- **Database Indexes** - Composite indexes and PostgreSQL GIN full-text search
+
+#### 🧠 Advanced Analytics (8 Powerful Features)
 
-### 📈 Analytics & Insights
-7-day trend charts, severity breakdown, spike detection, platform comparison, resolution rate tracking, user impact analysis.
+**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.
 
-### 🚨 Multi-Channel Alerting
-Slack, Email, Discord, PagerDuty, and custom webhooks. Beautifully formatted messages with rich context, direct links to errors, customizable per channel.
+**2. Fuzzy Error Matching** 🔍
+Find similar errors across different error hashes using Jaccard similarity (70%) and Levenshtein distance (30%). Discover related errors that share common root causes even when they manifest differently.
 
-### ⚡ Performance & Scalability
-Async error logging, backtrace limiting (70-90% storage reduction), error sampling, database optimization with composite indexes, PostgreSQL GIN indexes.
+**3. Co-occurring Errors** 🔗
+Detect errors that happen together within configurable time windows (default: 5 minutes). Identify patterns where one error frequently triggers another, helping you prioritize fixes.
 
-### 🔌 Plugin System
-Extensible architecture with event hooks. Built-in examples for Jira, metrics tracking, audit logging. Easy to create custom integrations.
+**4. Error Cascade Detection** ⛓️
+Identify error chains (A causes B causes C) with probability calculations and average delays. Visualize parent→child relationships to understand cascading failures and fix root causes.
 
-### 🔒 Security & Privacy
-HTTP Basic Auth, environment-based settings, optional separate database for isolation.
+**5. Error Correlation Analysis** 📊
+Correlate errors with app versions, git commits, and users. Find problematic releases, identify users affected by multiple error types, and detect time-based patterns.
 
-**📚 [View complete feature list →](docs/FEATURES.md)**
+**6. Platform Comparison** 📱
+Compare iOS vs Android vs Web health metrics side-by-side. Platform-specific error rates, severity distributions, resolution times, and stability scores (0-100).
+
+**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.
+
+#### 🔌 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/`.
+
+**📚 [View complete feature list with examples →](docs/FEATURES.md)**
 
 ---
 
@@ -337,7 +380,6 @@ config.webhook_urls = ['https://yourapp.com/hooks/errors']
 
 ### Development
 - **[Testing](docs/development/TESTING.md)** - Multi-version testing
-- **[CI Setup](docs/development/CI_SETUP.md)** - GitHub Actions configuration
 
 **📖 [View all documentation →](docs/README.md)**
 
@@ -373,16 +415,19 @@ We welcome contributions! Here's how to get started:
 ```bash
 git clone https://github.com/AnjanJ/rails_error_dashboard.git
 cd rails_error_dashboard
-bundle install
 
-# Run tests
-bundle exec rspec
+# Automated setup (installs deps, hooks, runs tests)
+bin/setup
 
-# Run tests for all Rails versions
-bundle exec appraisal rspec
+# Or manual setup
+bundle install
+bundle exec lefthook install  # Installs git hooks
+bundle exec rspec
 ```
 
-**🔧 [Development guide →](docs/development/TESTING.md)**
+**Git Hooks:** We use [Lefthook](https://github.com/evilmartians/lefthook) to run quality checks before commit/push. This ensures CI passes and saves GitHub Actions minutes!
+
+**🔧 [Development guide →](DEVELOPMENT.md)** | **🧪 [Testing guide →](docs/development/TESTING.md)**
 
 ---
 

data/app/assets/stylesheets/rails_error_dashboard/_catppuccin_mocha.scss

@@ -0,0 +1,107 @@
+// =============================================================================
+// Catppuccin Mocha Theme - Color Palette
+// =============================================================================
+// Official Catppuccin color palette for the Mocha flavor (dark theme)
+// https://github.com/catppuccin/catppuccin
+//
+// This file defines both SCSS variables and CSS custom properties for
+// maximum flexibility in styling components.
+// =============================================================================
+
+// -----------------------------------------------------------------------------
+// SCSS Variables - Accent Colors
+// -----------------------------------------------------------------------------
+// Use these for compile-time color calculations and SCSS functions
+
+$ctp-rosewater: #f5e0dc !default;  // Soft highlights, subtle accents
+$ctp-flamingo:  #f2cdcd !default;  // Gentle warnings, soft alerts
+$ctp-pink:      #f5c2e7 !default;  // Playful accents, decorative
+$ctp-mauve:     #cba6f7 !default;  // Primary brand color, links
+$ctp-red:       #f38ba8 !default;  // Errors, critical states
+$ctp-maroon:    #eba0ac !default;  // Secondary errors, warnings
+$ctp-peach:     #fab387 !default;  // Warnings, cautionary states
+$ctp-yellow:    #f9e2af !default;  // Highlights, important info
+$ctp-green:     #a6e3a1 !default;  // Success, positive states
+$ctp-teal:      #94e2d5 !default;  // Info, neutral positive
+$ctp-sky:       #89dceb !default;  // Links, interactive elements
+$ctp-sapphire:  #74c7ec !default;  // Accents, decorative
+$ctp-blue:      #89b4fa !default;  // Info, primary actions
+$ctp-lavender:  #b4befe !default;  // Soft accents, highlights
+
+// -----------------------------------------------------------------------------
+// SCSS Variables - Neutral Colors
+// -----------------------------------------------------------------------------
+// Background and text colors for UI structure
+
+$ctp-text:      #cdd6f4 !default;  // Primary text
+$ctp-subtext1:  #bac2de !default;  // Secondary text
+$ctp-subtext0:  #a6adc8 !default;  // Tertiary text, muted
+$ctp-overlay2:  #9399b2 !default;  // Hover states, highlights
+$ctp-overlay1:  #7f849c !default;  // Subtle backgrounds
+$ctp-overlay0:  #6c7086 !default;  // Muted elements, disabled
+$ctp-surface2:  #585b70 !default;  // Secondary surfaces
+$ctp-surface1:  #45475a !default;  // Interactive elements
+$ctp-surface0:  #313244 !default;  // Component backgrounds (cards)
+$ctp-base:      #1e1e2e !default;  // Main background
+$ctp-mantle:    #181825 !default;  // Alternate background
+$ctp-crust:     #11111b !default;  // Borders, edges
+
+// -----------------------------------------------------------------------------
+// CSS Custom Properties (CSS Variables)
+// -----------------------------------------------------------------------------
+// These can be changed at runtime and accessed from JavaScript
+// Use these for theme switching and dynamic styling
+
+:root {
+  // Accent colors as CSS variables
+  --ctp-rosewater: #{$ctp-rosewater};
+  --ctp-flamingo:  #{$ctp-flamingo};
+  --ctp-pink:      #{$ctp-pink};
+  --ctp-mauve:     #{$ctp-mauve};
+  --ctp-red:       #{$ctp-red};
+  --ctp-maroon:    #{$ctp-maroon};
+  --ctp-peach:     #{$ctp-peach};
+  --ctp-yellow:    #{$ctp-yellow};
+  --ctp-green:     #{$ctp-green};
+  --ctp-teal:      #{$ctp-teal};
+  --ctp-sky:       #{$ctp-sky};
+  --ctp-sapphire:  #{$ctp-sapphire};
+  --ctp-blue:      #{$ctp-blue};
+  --ctp-lavender:  #{$ctp-lavender};
+
+  // Neutral colors as CSS variables
+  --ctp-text:      #{$ctp-text};
+  --ctp-subtext1:  #{$ctp-subtext1};
+  --ctp-subtext0:  #{$ctp-subtext0};
+  --ctp-overlay2:  #{$ctp-overlay2};
+  --ctp-overlay1:  #{$ctp-overlay1};
+  --ctp-overlay0:  #{$ctp-overlay0};
+  --ctp-surface2:  #{$ctp-surface2};
+  --ctp-surface1:  #{$ctp-surface1};
+  --ctp-surface0:  #{$ctp-surface0};
+  --ctp-base:      #{$ctp-base};
+  --ctp-mantle:    #{$ctp-mantle};
+  --ctp-crust:     #{$ctp-crust};
+}
+
+// -----------------------------------------------------------------------------
+// Utility Functions
+// -----------------------------------------------------------------------------
+
+// Add opacity to a Catppuccin color
+// Usage: background-color: ctp-opacity($ctp-red, 0.1);
+@function ctp-opacity($color, $opacity) {
+  @return rgba($color, $opacity);
+}
+
+// Lighten a Catppuccin color (for hover states)
+// Usage: background-color: ctp-lighten($ctp-mauve, 10%);
+@function ctp-lighten($color, $amount) {
+  @return lighten($color, $amount);
+}
+
+// Darken a Catppuccin color (for active states)
+// Usage: background-color: ctp-darken($ctp-mauve, 10%);
+@function ctp-darken($color, $amount) {
+  @return darken($color, $amount);
+}