[extension/pprof] Improve documentation for pprof usage #28665
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
songy23
added
documentation
songy23
approved these changes
Nov 1, 2023
| After running the above command to save the profile, _pprof_ will enter the interactive mode. | ||
| From here, the profiles can be analyzed. | ||
|
|
||
| Use the command `web` to open an image of the complete call graph in your browser. |
There was a problem hiding this comment.
May want to also mention Graphviz as a prerequisite for web
|
This PR was marked stale due to lack of activity. It will be closed in 14 days. |
TylerHelmuth
added
the
ready to merge
atoulme
approved these changes
Nov 18, 2023
RoryCrispin
pushed a commit
to ClickHouse/opentelemetry-collector-contrib
that referenced
this pull request
Nov 24, 2023
…ry#28665) **Description:** Update readme with instructions on how to use pprof **Link to tracking Issue:** open-telemetry#26095 **Testing:** Not applicable since no functional code was changed. **Documentation:** The extension readme now contains information what a profile is, how it can be generated and analysed. Co-authored-by: Tyler Helmuth <[email protected]>
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: Update readme with instructions on how to use pprof
Link to tracking Issue: #26095
Testing: Not applicable since no functional code was changed.
Documentation: The extension readme now contains information what a profile is, how it can be generated and analysed.