How to run/debug pyroscope server on local machine

grafana / pyroscope

Continuous Profiling Platform. Debug performance issues down to a single line of code

https://grafana.com/oss/pyroscope/

GNU Affero General Public License v3.0

9.79k stars 583 forks source link

How to run/debug pyroscope server on local machine #1225

Closed Jun10ng closed 2 years ago

Jun10ng commented 2 years ago

Hi team, I want to debug pyroscope server on my PC. Is there any "IDE configuration" or "bash script" to run it? I only found the way of running on docker at the website.

Thanks.

eh-am commented 2 years ago

Hey! Depends what you mean by "debug":

If you want to be able to modify code, we recommend the following flow https://pyroscope.io/docs/developer-guide/
- Notice that you can run make build instead of make dev, which will build a binary.
If you just want to just run the binary (without setting up a local dev stack), you can download it here https://pyroscope.io/downloads/ (notice that you have to check "Standalone Binaries")

All that being said, is there any specific problem you are having that is making you have to run locally? If possible let us know!

Jun10ng commented 2 years ago

Thank for your reply @eh-am

I mean "debug" is setting some breakpoints to figure out how pyroscope server is running.

Any way I have "debug" it successfully with Goland IDE, can I add my way on this page , under VS code selection?

eh-am commented 2 years ago

@Jun10ng Oh of course, sorry for my brain fart!

can I add my way on this page , under VS code selection?

Definitely! We store docs in a different repository, though: https://github.com/pyroscope-io/docs/blob/main/docs/developer-guide.mdx