trace

README

Trace

Trace is a powerful tool to visualize the execution of go programs.

It helps you understand what's your code do in depth, literally.

Example

Documentation

Index

• Constants
• func Begin() func()
• func Collect(f func())
• func Enable() func()
• func MarshalAnyJSON(v interface{}) ([]byte, error)
• func Options() *collectOpts
• func SetMarshalStack(fn func(root *Root) ([]byte, error))
• func WriteFile(name string, data []byte, perm fs.FileMode) error
• type ErrSilent
  • func (c *ErrSilent) MarshalJSON() (data []byte, err error)
• type ExportOptions
• type FuncInfoExport
  • func ExportFuncInfo(c *core.FuncInfo, opts *ExportOptions) *FuncInfoExport
• type FuncKind
• type LimitSize
  • func (c *LimitSize) MarshalJSON() ([]byte, error)
• type Root
  • func (c *Root) Export(opts *ExportOptions) *RootExport
• type RootExport
• type Stack
  • func (c *Stack) Export(opts *ExportOptions) *StackExport
• type StackExport

Constants

const DefaultAppearanceLimit = 100

default appearance limit on repeative functions

const DefaultSizeLimit = 16 * 1024

default size to shrink 16K

Functions

func Begin

func Begin() func()

func Collect

func Collect(f func())

executes f and collect its trace by default trace output will be controlled by XGO_TRACE_OUTPUT

func Enable

func Enable() func()

Enable setup the trace interceptor if called from init, the interceptor is enabled globally. Otherwise locally

func MarshalAnyJSON

func MarshalAnyJSON(v interface{}) ([]byte, error)

MarshalAnyJSON marshals aribitray go value `v` to JSON, when it encounters unmarshalable values like func, chan, it will bypass these values.

func Options

func Options() *collectOpts

func SetMarshalStack

func SetMarshalStack(fn func(root *Root) ([]byte, error))

func WriteFile

func WriteFile(name string, data []byte, perm fs.FileMode) error

Types

type ErrSilent

type ErrSilent struct {
	Data interface{}
}

make json err silent

func (*ErrSilent) MarshalJSON

func (c *ErrSilent) MarshalJSON() (data []byte, err error)

type ExportOptions

type ExportOptions struct {
	// suppress error when marshalling
	// arguments and results
	DisableErrSilent bool
	SizeLimit        int // 0: default limit 16K
	AppearanceLimit  int // 0: default limit 100

	FilterStack func(stack *StackExport) *StackExport

	FilterRoot  func(root *RootExport) *RootExport
	MarshalRoot func(root *RootExport) ([]byte, error)
	// contains filtered or unexported fields
}

allow skip some packages

for example: google.golang.org/protobuf/internal/order

type FuncInfoExport

type FuncInfoExport struct {
	// FullName string
	Kind         FuncKind
	Pkg          string
	IdentityName string
	Name         string
	RecvType     string
	RecvPtr      bool

	// interface method?
	Interface bool
	Generic   bool
	Closure   bool
	Stdlib    bool

	File string
	Line int

	RecvName string
	ArgNames []string
	ResNames []string

	// is first argument ctx
	FirstArgCtx bool
	// last last result error
	LastResultErr bool
}

func ExportFuncInfo

func ExportFuncInfo(c *core.FuncInfo, opts *ExportOptions) *FuncInfoExport

type FuncKind

type FuncKind string

const (
	FuncKind_Func   FuncKind = "func"
	FuncKind_Var    FuncKind = "var"
	FuncKind_VarPtr FuncKind = "var_ptr"
	FuncKind_Const  FuncKind = "const"
)

type LimitSize

type LimitSize struct {
	Data  interface{}
	Limit int
}

make json err silent

func (*LimitSize) MarshalJSON

func (c *LimitSize) MarshalJSON() ([]byte, error)

type Root

type Root struct {
	// current executed function
	Top      *Stack
	Begin    time.Time
	Children []*Stack
}

func (*Root) Export

func (c *Root) Export(opts *ExportOptions) *RootExport

type RootExport

type RootExport struct {
	// current executed function
	Begin    time.Time
	Children []*StackExport
}

type Stack

type Stack struct {
	FuncInfo *core.FuncInfo

	Begin int64 // us
	End   int64 // us

	Args     core.Object
	Results  core.Object
	Panic    bool
	Error    error
	Children []*Stack
}

func (*Stack) Export

func (c *Stack) Export(opts *ExportOptions) *StackExport

type StackExport

type StackExport struct {
	FuncInfo *FuncInfoExport

	Begin int64 // us
	End   int64 // us

	Args    interface{}
	Results interface{}
	Panic   bool
	Error   string

	Children []*StackExport
}