debug

Documentation

Overview

Package debug interfaces Go runtime debugging facilities. This package is mostly glue code making these facilities available through the CLI and RPC subsystem. If you want to use them from Go code, use package runtime instead.

Index

• Variables
• func Exit()
• func LoudPanic(x interface{})
• func Setup(ctx *cli.Context) error
• type HandlerT
  • func (*HandlerT) BacktraceAt(location string) error
  • func (*HandlerT) BlockProfile(file string, nsec uint) error
  • func (h *HandlerT) CpuProfile(file string, nsec uint) error
  • func (*HandlerT) GcStats() *debug.GCStats
  • func (h *HandlerT) GoTrace(file string, nsec uint) error
  • func (*HandlerT) MemStats() *runtime.MemStats
  • func (*HandlerT) SetBlockProfileRate(rate int)
  • func (*HandlerT) Stacks() string
  • func (h *HandlerT) StartCPUProfile(file string) error
  • func (h *HandlerT) StartGoTrace(file string) error
  • func (h *HandlerT) StopCPUProfile() error
  • func (h *HandlerT) StopGoTrace() error
  • func (*HandlerT) Verbosity(level int)
  • func (*HandlerT) Vmodule(pattern string) error
  • func (*HandlerT) WriteBlockProfile(file string) error
  • func (*HandlerT) WriteMemProfile(file string) error

Variables

var Flags = []cli.Flag{
	verbosityFlag, vmoduleFlag, backtraceAtFlag,
	pprofFlag, pprofPortFlag,
	memprofilerateFlag, blockprofilerateFlag, cpuprofileFlag, traceFlag,
}

Flags holds all command-line flags required for debugging.

var Handler = new(HandlerT)

Handler is the global debugging handler.

Functions

func Exit

func Exit()

Exit stops all running profiles, flushing their output to the respective file.

func LoudPanic

func LoudPanic(x interface{})

LoudPanic panics in a way that gets all goroutine stacks printed on stderr.

func Setup

func Setup(ctx *cli.Context) error

Setup initializes profiling and logging based on the CLI flags. It should be called as early as possible in the program.

Types

type HandlerT

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

HandlerT implements the debugging API. Do not create values of this type, use the one in the Handler variable instead.

func (*HandlerT) BacktraceAt

func (*HandlerT) BacktraceAt(location string) error

BacktraceAt sets the glog backtrace location. See package glog for details on pattern syntax.

func (*HandlerT) BlockProfile

func (*HandlerT) BlockProfile(file string, nsec uint) error

BlockProfile turns on CPU profiling for nsec seconds and writes profile data to file. It uses a profile rate of 1 for most accurate information. If a different rate is desired, set the rate and write the profile manually.

func (*HandlerT) CpuProfile

func (h *HandlerT) CpuProfile(file string, nsec uint) error

CpuProfile turns on CPU profiling for nsec seconds and writes profile data to file.

func (*HandlerT) GcStats

func (*HandlerT) GcStats() *debug.GCStats

GcStats returns GC statistics.

func (*HandlerT) GoTrace

func (h *HandlerT) GoTrace(file string, nsec uint) error

GoTrace turns on tracing for nsec seconds and writes trace data to file.

func (*HandlerT) MemStats

func (*HandlerT) MemStats() *runtime.MemStats

MemStats returns detailed runtime memory statistics.

func (*HandlerT) SetBlockProfileRate

func (*HandlerT) SetBlockProfileRate(rate int)

SetBlockProfileRate sets the rate of goroutine block profile data collection. rate 0 disables block profiling.

func (*HandlerT) Stacks

func (*HandlerT) Stacks() string

Stacks returns a printed representation of the stacks of all goroutines.

func (*HandlerT) StartCPUProfile

func (h *HandlerT) StartCPUProfile(file string) error

StartCPUProfile turns on CPU profiling, writing to the given file.

func (*HandlerT) StartGoTrace

func (h *HandlerT) StartGoTrace(file string) error

StartGoTrace turns on tracing, writing to the given file.

func (*HandlerT) StopCPUProfile

func (h *HandlerT) StopCPUProfile() error

StopCPUProfile stops an ongoing CPU profile.

func (*HandlerT) StopGoTrace

func (h *HandlerT) StopGoTrace() error

StopTrace stops an ongoing trace.

func (*HandlerT) Verbosity

func (*HandlerT) Verbosity(level int)

Verbosity sets the glog verbosity ceiling. The verbosity of individual packages and source files can be raised using Vmodule.

func (*HandlerT) Vmodule

func (*HandlerT) Vmodule(pattern string) error

Vmodule sets the glog verbosity pattern. See package glog for details on pattern syntax.

func (*HandlerT) WriteBlockProfile

func (*HandlerT) WriteBlockProfile(file string) error

WriteBlockProfile writes a goroutine blocking profile to the given file.

func (*HandlerT) WriteMemProfile

func (*HandlerT) WriteMemProfile(file string) error

WriteMemProfile writes an allocation profile to the given file. Note that the profiling rate cannot be set through the API, it must be set on the command line.