felixge / fgprof

🚀 fgprof is a sampling Go profiler that allows you to analyze On-CPU as well as Off-CPU (e.g. I/O) time together.
MIT License
2.81k stars 88 forks source link

Please mention format GET parameter in the quick start guide #1

Closed swatson314159 closed 4 years ago

swatson314159 commented 4 years ago

In my first test of fgprof I profiled my app by curling a remote host from another remote host where neither have go tools installed, copying the artifact local for analysis. I was expecting the pprof format as the default based on my reading of the quick start. It took a bit of digging through the source to find guessFormat in handler.go to figure out why I was getting text vs binary output. Your quick start guide is excellent, but a quick mention of the extra GET parameter somewhere on that first page would have saved me significant time.

felixge commented 4 years ago

@swatson314159 thanks for reporting this. PTAL at https://github.com/felixge/fgprof/pull/2 and let me know if you think that's a good solution or not. : )

swatson314159 commented 4 years ago

my full response is on your PR: https://github.com/felixge/fgprof/pull/2#pullrequestreview-440102418

Thank you for responding so soon!

felixge commented 4 years ago

Implemented in https://github.com/felixge/fgprof/pull/2 . Thanks for reporting this!