feat(studio): detect and report high listener roundtrip latency #8943
+218
−50
Conversation
This file contains 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
bjoerge
force-pushed
the
telemetry-listener-latency
branch
from
2a882bb to
d8338e8
Compare
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
|
No changes to documentation |
⚡️ Editor Performance ReportUpdated Mon, 17 Mar 2025 16:50:13 GMT
Detailed information🏠 Reference resultThe performance result of
🧪 Experiment resultThe performance result of this branch
📚 Glossary
|
svirs
reviewed
Mar 14, 2025
| shard?: string | ||
| } | ||
| export const HighListenerLatencyOccurred = defineEvent<Samples>({ | ||
| name: 'High Listener Latency Detected', |
sgulseth
previously approved these changes
Mar 14, 2025
| @@ -155,6 +156,19 @@ export function useDocumentStore(): DocumentStore { | |||
| [telemetry], | |||
| ) | |||
|
|
|||
| const handleReportLatency = useCallback( | |||
| (event: LatencyReportEvent) => { | |||
| if (event.latencyMs > 1000) { | |||
There was a problem hiding this comment.
Move into constant(Could belong with the telemetry event? 🤔) and maybe describe why and what this number is? As a reference and help for our future selves 🙃
There was a problem hiding this comment.
Good call! Extracted to a const in 5f918c7
juice49
reviewed
Mar 17, 2025
packages/sanity/src/core/store/_legacy/document/document-pair/checkoutPair.ts
Outdated
Show resolved
Hide resolved
juice49
approved these changes
Mar 17, 2025
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.
Description
We want to track e2e listener latency, this reports a telemetry event every time we detect >1s latency from after an edit action request has completed until we receive an event with a corresponding transaction id back from the listener.
What to review
I've tried to implement this as cleanly as possible to make it easy to delete the code path for tracking latency at some point in the future. The implementation follows the same pattern as the "document desynced" event in the document store takes a callback that will be called with latency, shard identifier and transaction id.
Testing
To see that the the Studio sends the event, start with
SANITY_STUDIO_DEBUG_TELEMETRY=true pnpm devwhich will log the telemetry events to the console.This, combined with network throttling should likely cause some "High Listener Latency Detected"-events to be reported
Notes for release
n/a