pprof

README

pprof

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 gopkg.in/gin-contrib/pprof.v1

Import it in your code:

import "gopkg.in/gin-contrib/pprof.v1"

Example:

package main

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

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

change default path prefix:

func main() {
	router := gin.Default()
	pprof.Register(router, &pprof.Options{
		// default is "debug/pprof"
		RoutePrefix: "debug/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

Documentation

Index

• func Register(r *gin.Engine, opts *Options)
• type Options

Functions

func Register

func Register(r *gin.Engine, opts *Options)

Register the standard HandlerFuncs from the net/http/pprof package with the provided gin.Engine. opts is a optional. If a `nil` value is passed, the default path prefix is used.

Types

type Options

type Options struct {
	// RoutePrefix is an optional path prefix. If left unspecified, `/debug/pprof`
	// is used as the default path prefix.
	RoutePrefix string
}

Options provides potential route registration configuration options