Sync from docs: add sync latency diagnosis guidance (powersync-docs #420)#31
Open
bean1352 wants to merge 1 commit into
Open
Sync from docs: add sync latency diagnosis guidance (powersync-docs #420)#31bean1352 wants to merge 1 commit into
bean1352 wants to merge 1 commit into
Conversation
Mirrors the new "Diagnosing Sync Latency" section added to debugging/troubleshooting.mdx and the "Correlating Sync Sessions" subsection added to maintenance-ops/monitoring-and-alerting.mdx in powersync-docs PR #420. - Documents the two-stage downstream pipeline framework (source DB → PowerSync Service → client) and the timestamp-based end-to-end measurement technique - Adds Stage 1 and Stage 2 sub-sections with per-stage diagnostic steps - Documents the full field schemas for Sync stream started and Sync stream complete log events, including rid-based session matching - Adds a Common Causes checklist covering large initial sync, upload queue blocking, replication lag, and too many buckets Source: powersync-ja/powersync-docs#420
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.
Generated by Claude. Review carefully before merging.
Source docs PR: powersync-ja/powersync-docs#420
What changed in docs: Added a "Diagnosing Sync Latency" section to
debugging/troubleshooting.mdxcovering a two-stage pipeline framework, timestamp-based end-to-end measurement, and common causes. Added a "Correlating Sync Sessions" subsection tomaintenance-ops/monitoring-and-alerting.mdxdocumenting theSync stream startedandSync stream completelog events and their full field schemas.Skill updates in this PR:
skills/powersync/references/powersync-debug.md— added a new## Diagnosing Sync Latencysection covering:updated_at = NOW()on write, compare to client arrival time)/maintenance-ops/replication-lagdocs pageSync stream startedandSync stream completelog event field schemas (full field lists),rid-based session matching, anduser_idfilteringNotes for reviewer:
powersync-service.mdfile was intentionally left untouched. That file covers configuration rather than observability, and the log event field schemas are more useful in a debugging context where agents already havepowersync-debug.mdloaded./maintenance-ops/replication-lagpage (source-specific replication lag guidance). This page is not yet represented by a skill file. The existingpowersync-debug.mdalready references this URL in the new section and in the existing "Replication Lag Debugging (Postgres)" section. If and when that page ships in a separate docs PR, a reviewer may want to assess whether deeper coverage warrants additions topowersync-debug.mdor a new reference file.# Replication Lag Debugging (Postgres)section in the existing file uses an H1 heading inconsistently with the rest of the file (which uses H2). This PR does not fix that — it's pre-existing and out of scope.Generated by Claude Code