profiling

Documentation

Index

• Constants
• func Disable() nirvana.Configurer
• func Path(path string) nirvana.Configurer
• type Option
  • func NewDefaultOption() *Option
  • func (p *Option) Configure(cfg *nirvana.Config) error
  • func (p *Option) Name() string

Constants

const ExternalConfigName = "profiling"

ExternalConfigName is the external config name of profiling.

Functions

func Disable

func Disable() nirvana.Configurer

Disable returns a configurer to disable profiling.

func Path

func Path(path string) nirvana.Configurer

Path returns a configurer to set metrics path. Default path is /debug/pprof. Then these path is used:

/debug/pprof/cmdline
/debug/pprof/profile
/debug/pprof/symbol
/debug/pprof/trace
/debug/pprof/{prof}

Types

type Option

type Option struct {
	// Path is profiling path.
	Path string `desc:"Profiling path"`
}

Option contains basic configurations of profiling.

func NewDefaultOption

func NewDefaultOption() *Option

NewDefaultOption creates default option.

func (*Option) Configure

func (p *Option) Configure(cfg *nirvana.Config) error

Configure configures nirvana config via current options.

func (*Option) Name

func (p *Option) Name() string

Name returns plugin name.