Skip to content

Enable net/http/pprof handlers in pprof web UI. #943

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enable net/http/pprof handlers in pprof web UI. #943

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions internal/driver/webui.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,9 @@ func defaultWebServer(args *plugin.HTTPServerArgs) error {
mux := http.NewServeMux()
mux.Handle("/ui/", http.StripPrefix("/ui", handler))
mux.Handle("/", redirectWithQuery("/ui", http.StatusTemporaryRedirect))
// Enable self-profiling handlers if net/http/pprof is imported by the main
// program.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there going to be users who are unhappy about having this access point opened?

mux.HandleFunc("/debug/pprof/", http.DefaultServeMux.ServeHTTP)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we apply the same auth checks (localhost etc.) that we apply to other handlers?

s := &http.Server{Handler: mux}
return s.Serve(ln)
}
Expand Down
2 changes: 2 additions & 0 deletions pprof.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import (

"github.com/chzyer/readline"
"github.com/google/pprof/driver"

_ "net/http/pprof" // Enable profiling pprof itself in the web UI mode.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the past I have wanted to profile startup performance itself. This approach does not allow profiling startup time. An alternative would be flags (separate ones will be needed for cpu and memory profiling).

Not sure how we exit cleanly though to allow the profile to be saved if we are using flags.

)

func main() {
Expand Down
Loading