Proposal: Add Sentry Observability to Storacha Upload Service #679
Description
Summary
Introduce Sentry-based error monitoring and performance tracing to the Storacha upload service (w3up implementation) to improve production visibility, debugging speed, and reliability.
Why This Matters
The upload service handles:
- UCAN capability validation
- Space-based authorization
- CAR ingestion and block validation
- CID verification
- IPFS / Filecoin persistence
Failures in these layers (invalid UCAN, CID mismatch, CAR parsing errors, backend storage issues, stream interruptions) are critical trust-boundary events. Structured monitoring would significantly reduce MTTR and improve operational transparency.
Proposal
Integrate Sentry in the backend service to:
- Capture structured exceptions during upload flow
- Attach contextual metadata (space DID, root CID, upload size, request ID)
- Monitor retry exhaustion and storage backend failures
- Add performance tracing for:
- UCAN verification
- CAR decoding
- Block ingestion
- Storage commit
Security Considerations
- Never log private keys or raw UCAN tokens
- Mask auth headers
- Avoid logging CAR payload data
- Use a sanitization hook before sending events
Expected Impact
- Faster debugging of ingestion issues
- Better reliability monitoring
- Clear visibility into decentralized upload health
- Improved developer trust in upload guarantees