2020-06-07 14:26:06 +02:00
// Package pprof provides native pprof support via middleware. See _examples/pprof
2017-03-05 02:36:00 +01:00
package pprof
import (
2018-04-25 12:10:27 +02:00
"html/template"
2017-03-05 02:36:00 +01:00
"net/http/pprof"
2018-04-25 12:10:27 +02:00
rpprof "runtime/pprof"
2020-08-24 20:44:29 +02:00
"sort"
2017-03-05 02:36:00 +01:00
2019-10-25 00:27:02 +02:00
"github.com/kataras/iris/v12/context"
2017-03-05 02:36:00 +01:00
)
2020-04-28 04:42:23 +02:00
func init ( ) {
2020-04-28 21:34:36 +02:00
context . SetHandlerName ( "iris/middleware/pprof.*" , "iris.profiling" )
2021-12-09 13:44:03 +01:00
/ * for our readers :
apps . OnApplicationRegistered ( func ( app * iris . Application ) {
app . Any ( "/debug/pprof/cmdline" , iris . FromStd ( pprof . Cmdline ) )
app . Any ( "/debug/pprof/profile" , iris . FromStd ( pprof . Profile ) )
app . Any ( "/debug/pprof/symbol" , iris . FromStd ( pprof . Symbol ) )
app . Any ( "/debug/pprof/trace" , iris . FromStd ( pprof . Trace ) )
app . Any ( "/debug/pprof /debug/pprof/{action:string}" , New ( ) )
} )
* /
2020-04-28 04:42:23 +02:00
}
2020-08-24 20:44:29 +02:00
// 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." ,
}
2017-03-05 02:36:00 +01:00
// New returns a new pprof (profile, cmdline, symbol, goroutine, heap, threadcreate, debug/block) Middleware.
2020-08-24 20:44:29 +02:00
// Note: Route MUST have the last named parameter wildcard named '{action:path}'.
// Example:
2022-06-17 21:03:18 +02:00
//
// app.HandleMany("GET", "/debug/pprof /debug/pprof/{action:path}", pprof.New())
Publish the new version :airplane: | Look description please!
# FAQ
### Looking for free support?
http://support.iris-go.com
https://kataras.rocket.chat/channel/iris
### Looking for previous versions?
https://github.com/kataras/iris#version
### Should I upgrade my Iris?
Developers are not forced to upgrade if they don't really need it. Upgrade whenever you feel ready.
> Iris uses the [vendor directory](https://docs.google.com/document/d/1Bz5-UB7g2uPBdOx-rw5t9MxJwkfpx90cqG9AFL0JAYo) feature, so you get truly reproducible builds, as this method guards against upstream renames and deletes.
**How to upgrade**: Open your command-line and execute this command: `go get -u github.com/kataras/iris`.
For further installation support, please click [here](http://support.iris-go.com/d/16-how-to-install-iris-web-framework).
### About our new home page
http://iris-go.com
Thanks to [Santosh Anand](https://github.com/santoshanand) the http://iris-go.com has been upgraded and it's really awesome!
[Santosh](https://github.com/santoshanand) is a freelancer, he has a great knowledge of nodejs and express js, Android, iOS, React Native, Vue.js etc, if you need a developer to find or create a solution for your problem or task, please contact with him.
The amount of the next two or three donations you'll send they will be immediately transferred to his own account balance, so be generous please!
Read more at https://github.com/kataras/iris/blob/master/HISTORY.md
Former-commit-id: eec2d71bbe011d6b48d2526eb25919e36e5ad94e
2017-06-03 22:22:52 +02:00
func New ( ) context . Handler {
2020-07-10 22:21:09 +02:00
return func ( ctx * context . Context ) {
2020-08-24 20:44:29 +02:00
if action := ctx . Params ( ) . Get ( "action" ) ; action != "" {
pprof . Handler ( action ) . ServeHTTP ( ctx . ResponseWriter ( ) , ctx . Request ( ) )
2018-04-25 12:10:27 +02:00
return
}
2020-08-24 20:44:29 +02:00
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
2018-04-25 12:10:27 +02:00
}
2020-08-24 20:44:29 +02:00
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 {
2018-04-25 12:10:27 +02:00
ctx . Application ( ) . Logger ( ) . Error ( err )
2017-03-05 02:36:00 +01:00
}
Publish the new version :airplane: | Look description please!
# FAQ
### Looking for free support?
http://support.iris-go.com
https://kataras.rocket.chat/channel/iris
### Looking for previous versions?
https://github.com/kataras/iris#version
### Should I upgrade my Iris?
Developers are not forced to upgrade if they don't really need it. Upgrade whenever you feel ready.
> Iris uses the [vendor directory](https://docs.google.com/document/d/1Bz5-UB7g2uPBdOx-rw5t9MxJwkfpx90cqG9AFL0JAYo) feature, so you get truly reproducible builds, as this method guards against upstream renames and deletes.
**How to upgrade**: Open your command-line and execute this command: `go get -u github.com/kataras/iris`.
For further installation support, please click [here](http://support.iris-go.com/d/16-how-to-install-iris-web-framework).
### About our new home page
http://iris-go.com
Thanks to [Santosh Anand](https://github.com/santoshanand) the http://iris-go.com has been upgraded and it's really awesome!
[Santosh](https://github.com/santoshanand) is a freelancer, he has a great knowledge of nodejs and express js, Android, iOS, React Native, Vue.js etc, if you need a developer to find or create a solution for your problem or task, please contact with him.
The amount of the next two or three donations you'll send they will be immediately transferred to his own account balance, so be generous please!
Read more at https://github.com/kataras/iris/blob/master/HISTORY.md
Former-commit-id: eec2d71bbe011d6b48d2526eb25919e36e5ad94e
2017-06-03 22:22:52 +02:00
}
2017-03-05 02:36:00 +01:00
}
2018-04-25 12:10:27 +02:00
var indexTmpl = template . Must ( template . New ( "index" ) . Parse ( ` < html >
2020-08-24 20:44:29 +02:00
< head >
< title > { { . Path } } < / title >
< style >
. profile - name {
display : inline - block ;
width : 6 rem ;
}
< / style >
< / head >
< body >
{ { . Path } } < br >
< br >
Types of profiles available :
< table >
< thead > < td > Count < / td > < td > Profile < / td > < / thead >
{ { $ path := . Path } }
{ { range . Profiles } }
< tr >
< td > { { . Count } } < / td > < td > < a href = { { $ path } } / { { . Href } } > { { . Name } } < / a > < / td >
< / tr >
{ { end } }
< / table >
< a href = "{{.Path}}/goroutine?debug=2" > full goroutine stack dump < / a >
< br / >
< p >
Profile Descriptions :
< ul >
{ { range . Profiles } }
< li > < div class = profile - name > { { . Name } } : < / div > { { . Desc } } < / li >
{ { end } }
< / ul >
< / p >
< / body >
< / html >
` ) )
