report

Documentation

Overview

Package report summarizes a performance profile into a human-readable report.

Index

• Constants
• func Generate(w io.Writer, rpt *Report, obj plugin.ObjTool) error
• func ScaleValue(value int64, fromUnit, toUnit string) (sv float64, su string)
• type Options
• type Report
  • func New(prof *profile.Profile, options Options, value func(s *profile.Sample) int64, ...) *Report
  • func NewDefault(prof *profile.Profile, options Options) *Report

Constants

const (
	Proto = iota
	Dot
	Tags
	Tree
	Text
	Raw
	Dis
	List
	WebList
	Callgrind
)

Output formats.

Functions

func Generate

func Generate(w io.Writer, rpt *Report, obj plugin.ObjTool) error

Generate generates a report as directed by the Report.

func ScaleValue

func ScaleValue(value int64, fromUnit, toUnit string) (sv float64, su string)

ScaleValue reformats a value from a unit to a different unit.

Types

type Options

type Options struct {
	OutputFormat int

	CumSort        bool
	CallTree       bool
	PrintAddresses bool
	DropNegative   bool
	Ratio          float64

	NodeCount    int
	NodeFraction float64
	EdgeFraction float64

	SampleType string
	SampleUnit string // Unit for the sample data from the profile.
	OutputUnit string // Units for data formatting in report.

	Symbol *regexp.Regexp // Symbols to include on disassembly report.
}

Options are the formatting and filtering options used to generate a profile.

type Report

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

Report contains the data and associated routines to extract a report from a profile.

func New

func New(prof *profile.Profile, options Options, value func(s *profile.Sample) int64, unit string) *Report

New builds a new report indexing the sample values interpreting the samples with the provided function.

func NewDefault

func NewDefault(prof *profile.Profile, options Options) *Report

NewDefault builds a new report indexing the sample values with the last value available.