prof

README

prof

Wrap the official net/http/pprof route and add the profile io wait time route.

Example of use

    import "gitee.com/the_sun_light/common_pkg/gin/prof"

	r := gin.Default()
	prof.Register(r, WithPrefix("/myServer"), WithIOWaitTime())

	httpServer := &http.Server{
		Addr:    ":8080",
		Handler: r,
	}
	
    if err := httpServer.ListenAndServe(); err != nil && err != http.ErrServerClosed {
        panic("listen and serve error: " + err.Error())
    }

Documentation

Overview

Package prof is used for gin profiling.

Index

• func Register(r *gin.Engine, opts ...Option)
• type Option
  • func WithIOWaitTime() Option
  • func WithPrefix(prefix string) Option

Functions

func Register

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

Register pprof for gin router

Types

type Option

type Option func(o *options)

Option set defaultPrefix func

func WithIOWaitTime

func WithIOWaitTime() Option

WithIOWaitTime enable IO wait time

func WithPrefix

func WithPrefix(prefix string) Option

WithPrefix set route defaultPrefix