testutils: capture Side-Eye snapshots in SucceedsSoon #136839
+79
−8
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.
Make testutils.SucceedsSoon() capture a snapshot of the test process
with Side-Eye when the deadline expires. The idea is to help with
debugging flaky unit tests, both locally and on CI: the snapshot should
help us figure out where the operation that the test was waiting on has
gotten stuck.
The snapshot is generated if the SIDE_EYE_TOKEN environment variable is
set (it should be set to our organization's API token). The test log will
have a link to app.side-eye.io for visualizing the collected snapshot.
In the future, perhaps we can use Side-Eye to also collect execution
traces and CPU profiles for even more information.
Epic: None
Release note: None