prof

README

prof

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

Example of use

sampling profile by http

    import "github.com/go-dev-frame/sponge/pkg/prof"

    mux := http.NewServeMux()
    prof.Register(mux, prof.WithPrefix("/myServer"), prof.WithIOWaitTime())

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

sampling profile by system notification signal

import "github.com/go-dev-frame/sponge/pkg/prof"

func WaitSign() {
	p := prof.NewProfile()

	signals := make(chan os.Signal, 1)
	signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP, syscall.SIGTRAP)

	for {
		v := <-signals
		switch v {
		case syscall.SIGTRAP:
			p.StartOrStop()

		case syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP:
			os.Exit(0)
		}
	}
}

# view the program's pid
ps -aux | grep serverName

# notification of sampling profile, default 60s, in less than 60s, if the second execution will actively stop sampling profile
kill -trap pid

Documentation

Overview

Package prof is wrap the official `net/http/pprof` route and add the profile io wait time route.

Index

• func EnableTrace()
• func Register(mux *http.ServeMux, opts ...Option)
• func SetDurationSecond(d uint32)
• type Option
  • func WithIOWaitTime() Option
  • func WithPrefix(prefix string) Option
• type Profile
  • func NewProfile() *Profile
  • func (p *Profile) StartOrStop()

Functions

func EnableTrace

func EnableTrace()

EnableTrace enable sampling trace profile

func Register

func Register(mux *http.ServeMux, opts ...Option)

Register pprof server mux

func SetDurationSecond

func SetDurationSecond(d uint32)

SetDurationSecond set sampling profile duration

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

type Profile

type Profile struct {
	// contains filtered or unexported fields
}

func NewProfile

func NewProfile() *Profile

NewProfile create a new profile

func (*Profile) StartOrStop

func (p *Profile) StartOrStop()

StartOrStop start and stop sampling profile, the first call to start sampling data, the default maximum is 60 seconds, in less than 60s, if the second execution will actively stop sampling profile