gin pprof middleware
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
.gitignore add pprof testing. Dec 3, 2016
.travis.yml feat: add GO111MODULE=on Dec 23, 2018
LICENSE fix example. Dec 1, 2016
README.md Update README.md Mar 2, 2018
go.mod
go.sum
pprof.go
pprof_test.go

README.md

pprof

Build Status codecov Go Report Card GoDoc Join the chat at https://gitter.im/gin-gonic/gin

gin pprof middleware

Package pprof serves via its HTTP server runtime profiling data in the format expected by the pprof visualization tool.

Usage

Start using it

Download and install it:

$ go get github.com/gin-contrib/pprof

Import it in your code:

import "github.com/gin-contrib/pprof"

Example:

package main

import (
	"github.com/gin-contrib/pprof"
	"github.com/gin-gonic/gin"
)

func main() {
  router := gin.Default()
  pprof.Register(router)
  router.Run(":8080")
}

change default path prefix:

func main() {
	router := gin.Default()
	// default is "debug/pprof"
	pprof.Register(router, "dev/pprof")
	router.Run(":8080")
}

Use the pprof tool

Then use the pprof tool to look at the heap profile:

go tool pprof http://localhost:8080/debug/pprof/heap

Or to look at a 30-second CPU profile:

go tool pprof http://localhost:8080/debug/pprof/profile

Or to look at the goroutine blocking profile, after calling runtime.SetBlockProfileRate in your program:

go tool pprof http://localhost:8080/debug/pprof/block

Or to collect a 5-second execution trace:

wget http://localhost:8080/debug/pprof/trace?seconds=5