https://github.com/gin-contrib/pprof

gin pprof middleware
https://github.com/gin-contrib/pprof

gin-gonic gin-middleware pprof

Last synced: about 24 hours ago
JSON representation

gin pprof middleware

• Host: GitHub
• URL: https://github.com/gin-contrib/pprof
• Owner: gin-contrib
• License: mit
• Created: 2016-11-30T22:29:09.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-13T07:57:08.000Z (8 months ago)
• Last Synced: 2024-10-29T14:54:36.350Z (3 months ago)
• Topics: gin-gonic, gin-middleware, pprof
• Language: Go
• Size: 84 KB
• Stars: 641
• Watchers: 15
• Forks: 59
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-gin - gin-contrib/pprof

README

        
# pprof

[![Run Tests](https://github.com/gin-contrib/pprof/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/gin-contrib/pprof/actions/workflows/go.yml)

[![codecov](https://codecov.io/gh/gin-contrib/pprof/branch/master/graph/badge.svg)](https://codecov.io/gh/gin-contrib/pprof)

[![Go Report Card](https://goreportcard.com/badge/github.com/gin-contrib/pprof)](https://goreportcard.com/report/github.com/gin-contrib/pprof)

[![GoDoc](https://godoc.org/github.com/gin-contrib/pprof?status.svg)](https://godoc.org/github.com/gin-contrib/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:

```bash

go get github.com/gin-contrib/pprof

```

Import it in your code:

```go

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

```

### Example

```go

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

```go

func main() {

  router := gin.Default()

  // default is "debug/pprof"

  pprof.Register(router, "dev/pprof")

  router.Run(":8080")

}

```

### custom router group

```go

package main

import (

  "net/http"

  "github.com/gin-contrib/pprof"

  "github.com/gin-gonic/gin"

)

func main() {

  router := gin.Default()

  debugGroup := router.Group("/debug", func(c *gin.Context) {

    if c.Request.Header.Get("Authorization") != "foobar" {

      c.AbortWithStatus(http.StatusForbidden)

      return

    }

    c.Next()

  })

  pprof.RouteRegister(debugGroup, "pprof")

  router.Run(":8080")

}

```

### Use the pprof tool

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

```bash

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

```

Or to look at a 30-second CPU profile:

```bash

go tool pprof http://localhost:8080/debug/pprof/profile?seconds=30

```

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

```bash

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

```

Or to collect a 5-second execution trace:

```bash

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

```

Download the pprof profile data:

```bash

curl -v -H "Authorization: foobar" -o profile.pb.gz \

  http://localhost:8080/debug/pprof/profile?seconds=60

go tool pprof -http=:8099 profile.pb.gz

```