internal

Documentation

Index

• Variables
• type Config
• type CrashReport
  • func Create(c Config) (*CrashReport, error)
  • func Read(r io.Reader) (report *CrashReport, err error)
  • func (c *CrashReport) Write(w io.Writer) error
• type Profile
  • func NewProfile(name string, prof []byte) *Profile
  • func (p *Profile) Name() string
  • func (p *Profile) Profile() (*profile.Profile, error)
  • func (p *Profile) ProfileBytes() []byte
  • func (p *Profile) Register(mux *http.ServeMux) error
  • func (p *Profile) URL() string
• type Profiles
  • func (p Profiles) Add(c *Config)
• type SysInfo

Variables

var Header = `crashreport
Use github.com/yehan2002/crashreport or open this file with any zip file viewer.
`

Header the header line to be used a crash report file. This text is written before the contents of the crash report

Types

type Config

type Config struct {
	Reason []string

	NoStack   bool
	NoSysInfo bool

	Profiles map[string]struct{}
	Files    []string
}

Config a struct containing config for creating a crash report.

type CrashReport

type CrashReport struct {
	// Profiles profiles included in the crash report
	Profiles []*Profile

	// SysInfo contains information about the system the process was running in.
	// This will be nil if [Config.NoSysInfo] is true or if the system.json does
	// not exist in the crash report file.
	SysInfo *SysInfo
	// Memstats memory usage statistics of the program.
	// This will be nil if memstats.json does not exist in the crash report file.
	Memstats *runtime.MemStats
	// Build contains build info embedded in the binary of the program.
	// This will be nil if the build.json does not exist in the crash report file.
	Build *debug.BuildInfo

	// Reason the reason the program crashed.
	Reason string
	// Stack the full stack trace of the program
	Stack string

	// Files extra files included in the crash report.
	Files []string
}

CrashReport a crash report

func Create

func Create(c Config) (*CrashReport, error)

func Read

func Read(r io.Reader) (report *CrashReport, err error)

Read reads a crash report from the zip file

func (*CrashReport) Write

func (c *CrashReport) Write(w io.Writer) error

type Profile

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

Profile a profile

func NewProfile

func NewProfile(name string, prof []byte) *Profile

func (*Profile) Name

func (p *Profile) Name() string

func (*Profile) Profile

func (p *Profile) Profile() (*profile.Profile, error)

func (*Profile) ProfileBytes

func (p *Profile) ProfileBytes() []byte

func (*Profile) Register

func (p *Profile) Register(mux *http.ServeMux) error

func (*Profile) URL

func (p *Profile) URL() string

type Profiles

type Profiles uint8

Profiles the profiles to be included in the report

const (
	ProfileHeap Profiles = 1 << iota
	ProfileBlock
	ProfileMutex
	ProfileAllocs
	ProfileGoroutines
	ProfileThreadCreate

	ProfileAll = ProfileHeap | ProfileBlock | ProfileMutex | ProfileAllocs | ProfileGoroutines | ProfileThreadCreate
)

Profiles

func (Profiles) Add

func (p Profiles) Add(c *Config)

type SysInfo

type SysInfo struct {
	// Arch the running programs architecture target.
	// This is the value of [runtime.GOARCH]
	Arch string
	// OS the running programs operating system target.
	// This is the value of [runtime.OS]
	OS string
	// Compiler is the name of the compiler toolchain that built the running binary.
	Compiler string
	// GoVersion is the Go tree's version string.
	// It is either the commit hash and date at the time of the build or,
	// when possible, a release tag like "go1.3".
	GoVersion string
	// CPU is the number of logical CPUs usable by the process.
	//
	// The set of available CPUs is checked by querying the operating system
	// at process startup. Changes to operating system CPU allocation after
	// process startup are not reflected.
	CPU int
	// Goroutine the number of goroutines that existed at the time the crash report was created.
	Goroutines int
	// Thread the number of os the process was using when the crash report was created.
	Threads int
	// MaxCPU is the value of GOMAXPROCS.
	MaxCPU int

	// Time is the time when the crash report was created.
	Time time.Time
	// TimeStart is the time the program started running at.
	TimeStart time.Time
	// TimeRunning is the total amount of time the program was running.
	TimeRunning time.Duration
}

SysInfo contains information about the system the process was running in.