-
Notifications
You must be signed in to change notification settings - Fork 367
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(general): correct spelling #3463
Merged
Merged
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
…to pprof_extensions-B
…to pprof_extensions-B
Co-authored-by: Shikhar Mall <mall.shikhar.in@gmail.com>
Co-authored-by: Shikhar Mall <mall.shikhar.in@gmail.com>
Co-authored-by: Shikhar Mall <mall.shikhar.in@gmail.com>
…to pprof_extensions-A
…to pprof_extensions-B
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3463 +/- ##
==========================================
- Coverage 75.84% 75.82% -0.03%
==========================================
Files 465 465
Lines 37166 37166
==========================================
- Hits 28189 28181 -8
- Misses 7048 7055 +7
- Partials 1929 1930 +1 ☔ View full report in Codecov by Sentry. |
…to pprof_extensions-B
…to pprof_extensions-B
julio-lopez
approved these changes
Nov 28, 2023
@aaron-kasten it makes sense to update the description in this PR for clarity and to avoid confusion |
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.
Side effect of "feat(cli): Add ability to dump pprof data to logs .." train (#3454).
This PR adds the ability to dump pprof data to logs for debugging.
This is one of 4 PRs in a PR train:
aaron-kasten/kopia:pprof-extensions-A
aaron-kasten/kopia:pprof-extensions-B
aaron-kasten/kopia:pprof-extensions-C
aaron-kasten/kopia:pprof-extensions-D
Usage
pprof dumps are configured using the
KOPIA_DEBUG_PPROF
environment variable. The variable is a list of pprof profile names (seepprof.Lookup
) separated by,
. Optional parameters can be set with '=', delimited by ':'.example:
export KOPIA_DEBUG_PPROF=cpu,heap=debug=1,mutex=debug=1:rate=1000
The above setting will produce CPU, heap and mutex profiles. The block profile will have its debug parameter set to 1 and its sample rate set to 1000
Once run, profile data will be output in the Kopia logs on termination. Profile dumps are generated as base64 output (PEM) to the log on termination.
You should consider captureing logs to a file when running the Kopia command:
Once the logs are captured, a dump can created by terminating the command:
The following signals (on Linux and macos) can be used to dump profiles: SIGTERM, SIGINT, and SIGUSR1.
Captured standard-output should look similar to:
The captured output can then be converted to a pprof binary by using
kats
. The Kopiakats
tool can be used to convert the PEM file into a binary:When successful, kats will output the file found in the capture file.
kats expects that there is a well formed PEM record in the capture file.
Once successful, the binary can be used in PPROF:
Configuration Options
TBD