profile

Documentation

Overview

profiling of your Go application.

Index

• type Config
  • func (cfg *Config) Start() error
  • func (cfg *Config) Stop()
• type Timer
  • func NewTimer() *Timer
  • func (t *Timer) Elapsed() time.Duration
  • func (t *Timer) TotalCost() time.Duration

Types

type Config

type Config struct {
	// CPUProfile is the name of cpu profile which controls if cpu profiling will be enabled.
	// It defaults to false.
	CPUProfile string

	// MemProfile is the name of memory profile which controls if cpu profiling will be enabled.
	// It defaults to false.
	MemProfile string

	// MemProfile is the name of memory profile which controls if cpu profiling will be enabled.
	// It defaults to false.
	BlockProfile string

	// NoShutdownHook controls whether the profiling package should
	// hook SIGINT to write profiles cleanly.
	// Programs with more sophisticated signal handling should set
	// this to true and ensure the Stop() function returned from Start()
	// is called during shutdown.
	NoShutdownHook bool
	// contains filtered or unexported fields
}

Config controls the operation of the profile package.

func (*Config) Start

func (cfg *Config) Start() error

Start starts a new profiling session configured using *Config. The caller should call the Stop method to cleanly stop profiling.

func (*Config) Stop

func (cfg *Config) Stop()

Stop stops all profile.

type Timer

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

Timer recoreds time cost.

func NewTimer

func NewTimer() *Timer

NewTimer creates a new timer and start it.

func (*Timer) Elapsed

func (t *Timer) Elapsed() time.Duration

Elapsed returns the time duration from the time of start or last elapsed.

func (*Timer) TotalCost

func (t *Timer) TotalCost() time.Duration

TotalCost will stop the timer and return the total cost time.