tiny-pilot / tiny-pilot/tinypilot
Design: Include JS errors in TinyPilot debug logs
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 291
- PR merge metrics
- No merged PRs in 30d
Description
The current TinyPilot debug logs are all from logs on the device itself, so we don't see errors that occurred in the client's browser.
In some cases, it would be helpful for diagnosing a customer's issue if we could see the contents of their JS console error log.
This is nontrivial, as there are a few issues to solve:
- Where do we store JS logs to ensure they get properly logrotated?
- What does the backend endpoint look like for receiving JS errors?
- How do we trigger the web app to send JS errors to the backend?
- I don't know how to do it, but there are a ton of JS error monitoring platforms (e.g., Sentry) that seem to hook into the browser's error handler, so I'm pretty sure there's some way of grabbing JS errors.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are identified. Start by resolving the storage and log-rotation approach, the backend endpoint, and browser error capture; done means client-side JavaScript errors are received by the backend and included in rotated TinyPilot debug logs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, python
- Domain
- api, backend, observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100