Skip to main content

Errors and Echoes

Anonymous error reporting for Foundry VTT modules to help authors improve their modules.

Overview​

Errors and Echoes is a privacy-focused error reporting system for Foundry VTT that helps module developers identify and fix issues in their modules. The system captures JavaScript errors, promise rejections, console errors, and Foundry hook errors, then reports them to configured endpoints with sophisticated module attribution and privacy controls.

🔒 Privacy First: All error reporting is opt-in only with granular privacy controls. The module never swallows errors - all errors remain visible to users in the console and dev tools.

Key Features​

  • Anonymous Error Reporting: No personally identifiable information is collected
  • Sophisticated Module Attribution: Advanced stack trace analysis to identify which module caused an error
  • Granular Privacy Controls: Three privacy levels from minimal to detailed data collection
  • Rate Limiting & Deduplication: Prevents spam and respects user bandwidth
  • Foundry-Native Integration: Built on Foundry's settings system with proper GM-only controls
  • Never Swallows Errors: All errors remain visible to users - reporting happens in addition to normal error display

Implementation Status​

FeatureStatusNotes
🔍 Error Capture✅ CompleteCaptures JavaScript errors, promise rejections, console errors, and hook errors
🏷️ Module Attribution✅ CompleteAdvanced stack trace analysis and hook context detection
🔒 Privacy Controls✅ CompleteThree privacy levels with granular consent management
⚙️ Settings UI✅ CompleteFoundry-native configuration interface with registered modules display
📊 Manual Reporting✅ CompleteDirect error reporting API for modules
🔗 Module Registration API✅ CompleteFull registration system with context providers and filters
🧪 Testing Infrastructure⚠️ BetaTest framework established (currently requires setup fixes)

Quick Start​

For module developers who want to get started quickly:

  1. Installation Guide - Get Errors and Echoes set up in your Foundry instance
  2. Module Integration - Register your module for enhanced error reporting
  3. API Reference - Complete API documentation and examples

Error reporting is completely opt-in and privacy-focused:

  • No PII Collection: Never collects usernames, email addresses, IP addresses, or other personally identifiable information
  • GM-Only Control: Only Game Masters can enable error reporting for their world
  • Granular Privacy Levels: Choose from Minimal, Standard, or Detailed data collection
  • User Transparency: All collected data is clearly documented and users have full control

For Module Authors​

Errors and Echoes provides a complete error reporting ecosystem:

Reference Implementation​

A complete reference implementation for error reporting endpoints is available at sentry-relay, demonstrating integration with Sentry for production error monitoring.

Current Status and Roadmap​

Beta Release Status​

Errors & Echoes is currently in beta with core functionality working but some areas needing refinement:

✅ Working Features:

  • Error capture and attribution system
  • Privacy controls and consent management
  • Module registration API
  • Settings UI with registered module display
  • Production infrastructure at https://errors.rayners.dev

⚠️ Known Issues:

  • Test suite requires setup fixes to run properly
  • Module registration examples need real-world validation
  • Documentation may have gaps compared to implementation

🔄 Next Priorities:

  • Fix test infrastructure for reliable quality assurance
  • Validate integration examples with popular modules
  • Improve error attribution accuracy based on real usage
  • Add comprehensive module compatibility testing

Upcoming Features​

v0.2.0 Planned:

  • Enhanced error attribution with machine learning patterns
  • Real-time error analytics and pattern detection
  • Additional context providers for common debugging scenarios
  • Improved module compatibility and integration testing

v0.3.0 Planned:

  • Advanced filtering capabilities with smart noise reduction
  • Internationalization support for multiple languages
  • Integration with Foundry package browser for seamless setup
  • Performance optimizations based on production usage data

Community and Support​

  • GitHub Repository: fvtt-errors-and-echoes
  • Issues and Feature Requests: Use GitHub Issues for bug reports and feature requests
  • Community Discussion: Join the discussion on Discord

This module complies with GDPR and other privacy regulations. See the Privacy Policy and Legal Compliance documentation for details.