doc: runtime/pprof documentation needs clarification #29444
Labels
Documentation
Issues describing a change to documentation.
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
The documentation is not clear regarding what exactly pprof shows. Here are a few examples.
Let's open the flamegraph. There are at least two possibilities:
Since I/O can be quite slow these are very different options. Both reports are useful depending on what bottleneck we are trying to fix (I/O or CPU).
I'm assuming the flamegraph shows places where given amount of memory was allocated. However it's not clear whether this is 1) the total amount of allocated memory (i.e. it doesn't matter if it was freed), 2) amount of allocated memory of objects that are currently alive, or 3) amount of memory of objects that are not garbage collected yet. Without proper documentation there is no way to tell which option, if any, is correct.
The time shown doesn't make much sense. On the flamegraph I see something like
18988816179 usec
i.e. 5 hours. However the program was executing only for a few minutes. I guess the time should be divided by the number of CPUs or maybe by the number of goroutines (what if it varies?).The text was updated successfully, but these errors were encountered: