echopprof

README

echo-pprof

A fork of the original echo-pprof project, updated to support Echo v4 and utilizing go modules.

A wrapper for golang web framework echo to use net/http/pprof easily.

Install

First install echo-pprof to your GOPATH using go get:

go get -u github.com/GabhenDM/echo-pprof/v2

Usage

package main

import (
	echopprof "github.com/GabhenDM/echo-pprof/v2"
	"github.com/labstack/echo/v4"
)

func main() {
	e := echo.New()

	e.GET("/ping", func(c echo.Context) error {
		return c.String(200, "pong")
	})

	// automatically add routers for net/http/pprof
	// e.g. /debug/pprof, /debug/pprof/heap, etc.
	echopprof.Wrap(e)

	// echopprof also plays well with *echo.Group
	// prefix := "/debug/pprof"
	// group := e.Group(prefix)
	// echopprof.WrapGroup(prefix, group)

	e.Start(":8080")
}

Start this server, and then visit http://127.0.0.1:8080/debug/pprof/ and you'll see what you want.

Have Fun.

Credits to sevennt for the original wrapper.

Documentation

Index

• Variables
• func BlockHandler() echo.HandlerFunc
• func CmdlineHandler() echo.HandlerFunc
• func GoroutineHandler() echo.HandlerFunc
• func HeapHandler() echo.HandlerFunc
• func IndexHandler() echo.HandlerFunc
• func MutexHandler() echo.HandlerFunc
• func ProfileHandler() echo.HandlerFunc
• func SymbolHandler() echo.HandlerFunc
• func ThreadCreateHandler() echo.HandlerFunc
• func TraceHandler() echo.HandlerFunc
• func Wrap(e *echo.Echo)
• func WrapGroup(prefix string, g *echo.Group)

Variables

var Wrapper = Wrap

Wrapper make sure we are backward compatible.

Functions

func BlockHandler

func BlockHandler() echo.HandlerFunc

BlockHandler will pass the call from /debug/pprof/block to pprof.

func CmdlineHandler

func CmdlineHandler() echo.HandlerFunc

CmdlineHandler will pass the call from /debug/pprof/cmdline to pprof.

func GoroutineHandler

func GoroutineHandler() echo.HandlerFunc

GoroutineHandler will pass the call from /debug/pprof/goroutine to pprof.

func HeapHandler

func HeapHandler() echo.HandlerFunc

HeapHandler will pass the call from /debug/pprof/heap to pprof.

func IndexHandler

func IndexHandler() echo.HandlerFunc

IndexHandler will pass the call from /debug/pprof to pprof.

func MutexHandler

func MutexHandler() echo.HandlerFunc

MutexHandler will pass the call from /debug/pprof/mutex to pprof.

func ProfileHandler

func ProfileHandler() echo.HandlerFunc

ProfileHandler will pass the call from /debug/pprof/profile to pprof.

func SymbolHandler

func SymbolHandler() echo.HandlerFunc

SymbolHandler will pass the call from /debug/pprof/symbol to pprof.

func ThreadCreateHandler

func ThreadCreateHandler() echo.HandlerFunc

ThreadCreateHandler will pass the call from /debug/pprof/threadcreate to pprof.

func TraceHandler

func TraceHandler() echo.HandlerFunc

TraceHandler will pass the call from /debug/pprof/trace to pprof.

func Wrap

func Wrap(e *echo.Echo)

Wrap adds several routes from package `net/http/pprof` to *echo.Echo object.

func WrapGroup

func WrapGroup(prefix string, g *echo.Group)

WrapGroup adds several routes from package `net/http/pprof` to *echo.Group object.