release-22.2: debug: option to omit goroutine stacks by default from debug zip #110258
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
|
Thanks for opening a backport. Please check the backport criteria before merging:
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
Add a brief release justification to the body of your PR to justify this backport. Some other things to consider:
|
blathers-crl
bot
added
the
backport
|
This change is |
Recently, customers have complained about the performance impact of debug zip. Specifically, the `/debug/stacks/<node_id>` endpoint has been found to cause significant momentary spikes in SQL Service Latency for the node serving the request. This is because the endpoint uses `runtime.Stack()` from the go runtime to service the request, which is a "stop-the-world" operation. Naturally, this degrades performance "while the world is stopped", which larger customers have found to be unacceptable. This patch adds the `--include-goroutine-stacks` flag to debug zip, which defaults to `true`. This gives the option to avoid fetching goroutine stacks from `/debug/stacks/<node_id>`. This enables customers to reduce the performance impact of taking a debug zip bundle. Release note (ops change): The `debug zip` command now has an option to omit goroutine stack dumps by. This impacts the creation of `nodes/*/stacks.txt` and `nodes/*/stacks_with_labels.txt` within debug zip bundles. Users can opt to exclude these goroutine stacks by using the `--include-goroutine-stacks=false` flag. Note that fetching stack traces for all goroutines is a "stop-the-world" operation, which can momentarily have negative impacts on SQL service latency. Note that any periodic goroutine dumps previously taken on the node will still be included in `nodes/*/goroutines/*.txt.gz`, as these would have already been generated and don't require any stop-the-world operations.
abarganier
force-pushed
the
backport22.2-110177
branch
from
a316df9
to
ef29bc5
Compare
Santamaura
reviewed
Sep 8, 2023
There was a problem hiding this comment.
What are the line diffs that are different from the original PR, is it just testdata?
Reviewable status:
complete! 0 of 0 LGTMs obtained
abarganier
commented
Sep 8, 2023
There was a problem hiding this comment.
What are the line diffs that are different from the original PR, is it just testdata?
I usually pull up the diff of the original PR side-by-side with the diff from the backport PR to determine this.
In this instance, there were some package differences and flags present on v22.2 that aren't present anymore on master, so the code had to be tweaked to fit how things are on 22.2.
Reviewable status:
Santamaura
approved these changes
Sep 8, 2023
There was a problem hiding this comment.
Reviewed 8 of 8 files at r1, all commit messages.
Reviewable status:
|
TFTR! |
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.
Backport:
Please see individual PRs for details.
/cc @cockroachdb/release
Release justification: low-risk (CLI) change to debug zip to enable reduction of performance impact for clusters with large numbers of goroutines.