oppprof

Documentation

Index

• Constants
• Variables
• func CLIFlags(envPrefix string) []cli.Flag
• func CLIFlagsWithCategory(envPrefix string, category string) []cli.Flag
• type CLIConfig
  • func DefaultCLIConfig() CLIConfig
  • func ReadCLIConfig(ctx *cli.Context) CLIConfig
  • func (m CLIConfig) Check() error
• type Service
  • func New(listenEnabled bool, listenAddr string, listenPort int, profType profileType, ...) *Service
  • func (s *Service) Start() error
  • func (s *Service) Stop(ctx context.Context) error

Constants

const (
	EnabledFlagName     = "pprof.enabled"
	ListenAddrFlagName  = "pprof.addr"
	PortFlagName        = "pprof.port"
	ProfileTypeFlagName = "pprof.type"
	ProfilePathFlagName = "pprof.path"
)

Variables

var ErrInvalidPort = errors.New("invalid pprof port")

Functions

func CLIFlags

func CLIFlags(envPrefix string) []cli.Flag

func CLIFlagsWithCategory

func CLIFlagsWithCategory(envPrefix string, category string) []cli.Flag

Types

type CLIConfig

type CLIConfig struct {
	ListenEnabled bool
	ListenAddr    string
	ListenPort    int

	ProfileType     profileType
	ProfileDir      string
	ProfileFilename string
}

func DefaultCLIConfig

func DefaultCLIConfig() CLIConfig

func ReadCLIConfig

func ReadCLIConfig(ctx *cli.Context) CLIConfig

func (CLIConfig) Check

func (m CLIConfig) Check() error

type Service

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

func New

func New(listenEnabled bool, listenAddr string, listenPort int, profType profileType, profileDir, profileFilename string) *Service

func (*Service) Start

func (s *Service) Start() error

func (*Service) Stop

func (s *Service) Stop(ctx context.Context) error