[DOC] Restructure Pyroscope documentation and share content #3798
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
knylander-grafana
added
the
type/docs
3 tasks
tacole02
approved these changes
Dec 31, 2024
docs/sources/configure-server/storage/configure-disk-storage.md
Outdated
Show resolved
Hide resolved
|
|
||
| <!-- vale Grafana.Spelling = NO --> | ||
|
|
||
| [Brendan Gregg](https://www.brendangregg.com/flamegraphs.html), the creator of flame graphs, was inspired by the inability to view, read, and understand stack traces using the regular profilers to debug performance issues. |
Comment on lines
+38
to
+40
| Horizontally, the flame graph represents 100% of the time that this application was running. | ||
| The width of each node represents the amount of time spent in that function. | ||
| The wider the node, the more time spent in that function. The narrower the node, the less time spent in that function. |
There was a problem hiding this comment.
This is such a good, succinct description ❤️
There was a problem hiding this comment.
The flame graph text was written by the team. Good stuff! :)
|
|
||
| CPU profiling measures the amount of CPU time consumed by different parts of your application code. | ||
| High CPU usage can indicate inefficient code, leading to poor performance and increased operational costs. | ||
| It's used to identify and optimize CPU-intensive functions in your application. |
There was a problem hiding this comment.
You do such a fantastic job of introducing concepts throughout all of these topics, Kim!
There was a problem hiding this comment.
Thank you! This is largely a team effort. The team has these gems tucked all over the place. so much good stuff. I just provide some structure to it. :)
Comment on lines
+18
to
+20
| Traditionally, profiling is used as a free-form debugging tool in languages like Go and Java. | ||
| You are probably used to running a benchmark tool locally and getting a `pprof` file in Go or maybe connecting into a misbehaving prod instance and pulling a flame graph from a `JFR` file in Java. | ||
| This is great for debugging but not so great for production. |
There was a problem hiding this comment.
How's this?
Suggested change
| Traditionally, profiling is used as a free-form debugging tool in languages like Go and Java. | |
| You are probably used to running a benchmark tool locally and getting a `pprof` file in Go or maybe connecting into a misbehaving prod instance and pulling a flame graph from a `JFR` file in Java. | |
| This is great for debugging but not so great for production. | |
| Traditionally, profiling is a free-form debugging tool in languages like Go and Java. | |
| For example, you can run a benchmark tool locally and get a `pprof` file in Go or connect to a misbehaving prod instance and pull a flame graph from a `JFR` file in Java. | |
| This method is good for debugging, but not robust enough for production. |
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.
Restructure Pyroscope documentation to share content to other profiles-related content.
These changes will go live with the next Pyroscope release and should not be backported.
Notes for reviewer
Part of https://github.com/grafana/pyroscope-squad/issues/223 (reference the mind map linked in the issue for the file changes)
You can check out the PR using
gh pr checkout 3798in your local tempo repo.Changes to check:
Blocks these PRs: