// Package pprof provides native pprof support via middleware. See _examples/pprof
package pprof
import (
"html/template"
"net/http/pprof"
rpprof "runtime/pprof"
"sort"
"github.com/kataras/iris/v12/context"
)
func init() {
context.SetHandlerName("iris/middleware/pprof.*", "iris.profiling")
}
// net/http/pprof copy:
var profileDescriptions = map[string]string{
"allocs": "A sampling of all past memory allocations",
"block": "Stack traces that led to blocking on synchronization primitives",
"cmdline": "The command line invocation of the current program",
"goroutine": "Stack traces of all current goroutines",
"heap": "A sampling of memory allocations of live objects. You can specify the gc GET parameter to run GC before taking the heap sample.",
"mutex": "Stack traces of holders of contended mutexes",
"profile": "CPU profile. You can specify the duration in the seconds GET parameter. After you get the profile file, use the go tool pprof command to investigate the profile.",
"threadcreate": "Stack traces that led to the creation of new OS threads",
"trace": "A trace of execution of the current program. You can specify the duration in the seconds GET parameter. After you get the trace file, use the go tool trace command to investigate the trace.",
}
// New returns a new pprof (profile, cmdline, symbol, goroutine, heap, threadcreate, debug/block) Middleware.
// Note: Route MUST have the last named parameter wildcard named '{action:path}'.
// Example:
// app.HandleMany("GET", "/debug/pprof /debug/pprof/{action:path}", pprof.New())
func New() context.Handler {
return func(ctx *context.Context) {
if action := ctx.Params().Get("action"); action != "" {
pprof.Handler(action).ServeHTTP(ctx.ResponseWriter(), ctx.Request())
return
}
ctx.Header("X-Content-Type-Options", "nosniff")
ctx.Header("Content-Type", "text/html; charset=utf-8")
type profile struct {
Name string
Href string
Desc string
Count int
}
type page struct {
Path string
Profiles []profile
}
var profiles []profile
for _, p := range rpprof.Profiles() {
profiles = append(profiles, profile{
Name: p.Name(),
Href: p.Name() + "?debug=1",
Desc: profileDescriptions[p.Name()],
Count: p.Count(),
})
}
// Adding other profiles exposed from within this package
for _, p := range []string{"cmdline", "profile", "trace"} {
profiles = append(profiles, profile{
Name: p,
Href: p,
Desc: profileDescriptions[p],
})
}
sort.Slice(profiles, func(i, j int) bool {
return profiles[i].Name < profiles[j].Name
})
if err := indexTmpl.Execute(ctx, page{
Path: ctx.Path(),
Profiles: profiles,
}); err != nil {
ctx.Application().Logger().Error(err)
}
}
}
var indexTmpl = template.Must(template.New("index").Parse(`
{{.Path}}
{{.Path}}
Types of profiles available:
| Count | Profile |
{{ $path := .Path}}
{{range .Profiles}}
| {{.Count}} | {{.Name}} |
{{end}}
full goroutine stack dump
Profile Descriptions:
{{range .Profiles}}
{{.Name}}:
{{.Desc}}
`))