How juderozario08/faultkeeper works
Faultkeeper is a self-hosted Sentry-compatible error-monitoring product. An application sends an event envelope to the ingest edge; queued processing normalizes and groups events into issues, persists them, and publishes updates for the authenticated dashboard. Users browse issue lists and details, inspect event context and charts, manage projects, and request root-cause insights. The README documents Kafka, ClickHouse, a Rust ingest edge, and a first-party SDK as later-phase capabilities; those implementations are not present in the supplied tree. Edges reflect the excerpts, SOURCE INDEX references, or README; unsampled internals are represented only where documented.
Main entry points: models.py Issues and events · pipeline.py Event pipeline · views.py Envelope ingest · queue.py Ingest queue
Components 28
Event ingestion
- Envelope ingest
backend/ingest/views.py - DSN authentication
backend/ingest/auth.py - Ingest queue
backend/ingest/queue.py
Issue processing
- Event pipeline
backend/processing/pipeline.py - Event normalization
backend/processing/normalize.py - Fingerprint grouping
backend/processing/grouping.py - Background processing
backend/processing/tasks.py
Projects and insights
- Issues and events
backend/issues/models.py - Organizations and projects
backend/organizations/models.py - Issue API
backend/issues/views.py - Issue Insights
backend/insights/views.py - Insight providers
backend/insights/providers.py
Live delivery
- Update publisher
backend/realtime/publish.py - Project WebSocket
backend/realtime/consumers.py
Dashboard
- Dashboard routing
frontend/src/App.tsx - Issue list and charts
frontend/src/pages/IssuesPage.tsx - Issue detail
frontend/src/pages/issue/IssueDetailPage.tsx - API data hooks
frontend/src/api/hooks.ts - HTTP client
frontend/src/api/client.ts - Live stream hook
frontend/src/realtime/useProjectStream.ts
Other components
- Reporting application
- Dashboard user
- PostgreSQL
- LLM provider
- Kafka pipeline
- ClickHouse analytics
- Rust ingest edge
- Faultkeeper JS SDK
Connections 29
- Reporting application → Envelope ingest: sends envelopes
README.md - Envelope ingest → DSN authentication: authenticates keys
- Envelope ingest → Ingest queue: queues events
- Ingest queue → Background processing: dispatches events
- Background processing → Event pipeline: calls processor
backend/processing/tasks.py - Event pipeline → Event normalization: normalizes
backend/processing/pipeline.py - Event pipeline → Fingerprint grouping: fingerprints
backend/processing/pipeline.py - Event pipeline → Issues and events: saves events
backend/processing/pipeline.py - Event pipeline → Update publisher: publishes updates
backend/processing/pipeline.py - DSN authentication → Organizations and projects: checks project keys
backend/ingest/auth.py - Issues and events → Organizations and projects: references projects
backend/issues/models.py - Issue API → Issues and events: serves issue data
- Issue Insights → Insight providers: requests analysis
- Issue Insights → Issues and events: uses issue context
- Insight providers → LLM provider: queries model
- Update publisher → Project WebSocket: publishes updates
backend/realtime/publish.py - Dashboard user → Dashboard routing: uses dashboard
README.md - Dashboard routing → Issue list and charts: routes to list
frontend/src/App.tsx - Dashboard routing → Issue detail: routes to detail
frontend/src/App.tsx - Issue list and charts → API data hooks: loads issues
frontend/src/pages/IssuesPage.tsx - Issue detail → API data hooks: loads details
frontend/src/pages/issue/IssueDetailPage.tsx - API data hooks → HTTP client: makes requests
frontend/src/api/hooks.ts - Issue list and charts → Live stream hook: subscribes live
frontend/src/pages/IssuesPage.tsx - Live stream hook → Project WebSocket: receives updates
- Issues and events → PostgreSQL: persists records
README.md - Ingest queue → Kafka pipeline: future event bus
README.md - Issues and events → ClickHouse analytics: future analytics
README.md - Rust ingest edge → Envelope ingest: future ingest edge
README.md - Faultkeeper JS SDK → Envelope ingest: sends events
README.md