From ac8cf39b91f7db265eb480a13db30d2479843422 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20Geisend=C3=B6rfer?= Date: Sat, 6 Mar 2021 12:32:51 +0100 Subject: [PATCH] Improve pprof docs --- pprof.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/pprof.md b/pprof.md index 289deaa..7a3439f 100644 --- a/pprof.md +++ b/pprof.md @@ -1,6 +1,8 @@ # Go's pprof tool & format -The various profilers built into Go are designed to work with the [pprof visualization tool](https://github.com/google/pprof). The upstream pprof tool is designed to work with C++, Java and Go programs, but it's recommended to access the tool via the `go tool pprof` version that's [bundled](https://github.com/golang/go/tree/master/src/cmd/pprof) with the Go core. It's largely the same except for a few tweaks. +The various profilers built into Go are designed to work with the pprof visualization tool. [pprof](https://github.com/google/pprof) itself is an inofficial Google project that is designed to analyze profiling data from C++, Java and Go programs. The project defines a protocol buffer format that is used by all Go profilers and described in this document. + +The Go project itself [bundles](https://github.com/golang/go/tree/master/src/cmd/pprof) a version of pprof that can be invoked via `go tool pprof`. It's largely the same as the upstream tool, except for a few tweaks. Go recommends to always use `go tool pprof` instead of the upstream tool for working with Go profiles. ## Features