Skip to main content
Version: Next

Pprof

Pprof middleware exposes runtime profiling data for analysis with the Go pprof tool. Importing it registers handlers under /debug/pprof/.

Signatures

func New(config ...Config) fiber.Handler

Examples

Import the middleware package:

import (
"github.com/gofiber/fiber/v3"
"github.com/gofiber/fiber/v3/middleware/pprof"
)

Once your Fiber app is initialized, use the middleware as shown:

// Initialize default config
app.Use(pprof.New())

// Or customize the config

// For multi-ingress systems, add a URL prefix:
app.Use(pprof.New(pprof.Config{Prefix: "/endpoint-prefix"}))

// The resulting URL is "/endpoint-prefix/debug/pprof/"

Config

PropertyTypeDescriptionDefault
Nextfunc(fiber.Ctx) boolNext defines a function to skip this middleware when it returns true.nil
PrefixstringPrefix adds a segment before /debug/pprof; it must start with a slash and omit the trailing slash. Example: /federated-fiber""

Default Config

var ConfigDefault = Config{
Next: nil,
}