docs: add evidence-driven RTDS troubleshooting guide - #48
Open
osr21 wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an evidence-driven RTDS troubleshooting guide organized around:
The guide:
No runtime behavior is changed.
Why
Issue reports are substantially easier to act on when they include exact subscription frames, UTC timelines, raw data-frame evidence, topic-level last-payload timestamps, and a tested workaround. The current client reconnects on socket close/error, but production users also need guidance for cases where a socket remains open while subscribed data stops.
Related: #26, #31, #32, #38.
Note
Low Risk
Documentation-only: a troubleshooting guide and README link with no client or server behavior changes.
Overview
Adds a production troubleshooting guide so RTDS issues can be reported as symptom → evidence → workaround → requested platform fix, and links it from the README.
The new
TROUBLESHOOTING.mdcovers a report template (subscription frames, UTC timelines, last valid payload vs ping/pong), how to tell transport liveness from data-plane stalls (including issue #26), and a minimal payload-staleness watchdog that hard-reconnects instead of re-subscribing on a frozen socket. No runtime code changes.Reviewed by Cursor Bugbot for commit 3c09318. Bugbot is set up for automated code reviews on this repo. Configure here.