BugSpotter Documentation
Documentation is available in English. Перевод в процессе.
Everything you need to integrate BugSpotter into your application — from a one-line SDK install to self-hosted deployment with Docker Compose.
Getting Started
- Installation — npm, CDN, or build from source
- Quick Start — capture your first bug report in under 5 minutes
- Configuration — sampleRate, blockSelectors, replay, sanitization
Features
- PII Redaction — 9 built-in patterns, presets, custom regex
- Self-Hosted Deployment — Docker Compose setup guide
Reference
- API Reference — BugSpotter class, methods, types
- GitHub (SDK) — MIT licensed, open source
- npm — @bugspotter/sdk
SDK at a Glance
| Feature | Details |
|---|---|
| Bundle size | ~60 KB gzipped |
| Session replay | 30s rolling buffer via rrweb |
| Screenshots | CSP-safe, one-click capture |
| PII redaction | 9 patterns, client-side |
| Sampling | sampleRate: 0-1 with zero overhead |
| License | MIT |