Observability Ops
Overview
Provide operational tooling that helps diagnose issues without developer intervention.
Core areas
- Health checks and self-tests
- Diagnostics export (logs, config, environment)
- Support tools and debug views
Definition of done (DoD)
- Health check endpoint/method for each critical subsystem (DB, sync, config)
- Diagnostics export includes: app version, OS info, logs (last N days), sanitized config
- Export redacts all tokens/secrets/PII before writing
- Support tools accessible from Settings or Help menu
- Health status visible in UI (system tray icon or status bar)
Workflow
- Define health checks for core subsystems.
- Implement a diagnostics export bundle.
- Add user-triggered support tools in settings.
- Ensure sensitive data is redacted in exports.
Guidance
- Keep support tooling behind a safe UI surface.
- Avoid exposing credentials or tokens.
- Time-bound logs and exports for privacy.
References
references/health-checks.mdfor checks and reporting.references/diagnostics-export.mdfor export structure.references/support-tools.mdfor UX patterns.