profile
packagestandard libraryThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package profile represents a pprof profile as a directed graph.
This package is a simplified fork of github.com/google/pprof/internal/graph.
Package profile provides a representation ofgithub.com/google/pprof/proto/profile.proto andmethods to encode/decode/merge profiles in this format.
Index¶
- Variables
- type Demangler
- type Edge
- type EdgeMap
- type Function
- type Graph
- type Label
- type Line
- type Location
- type Mapping
- type Node
- type NodeInfo
- type NodeMap
- type NodePtrSet
- type NodeSet
- type Nodes
- type Options
- type Profile
- func (p *Profile) Aggregate(inlineFrame, function, filename, linenumber, address bool) error
- func (p *Profile) CheckValid() error
- func (p *Profile) Compatible(pb *Profile) error
- func (p *Profile) Copy() *Profile
- func (p *Profile) Demangle(d Demangler) error
- func (p *Profile) Empty() bool
- func (p *Profile) FilterSamplesByTag(focus, ignore TagMatch) (fm, im bool)
- func (p *Profile) HasFileLines() bool
- func (p *Profile) HasFunctions() bool
- func (p *Profile) Merge(pb *Profile, r float64) error
- func (p *Profile) Normalize(pb *Profile) error
- func (p *Profile) Prune(dropRx, keepRx *regexp.Regexp)
- func (p *Profile) RemoveUninteresting() error
- func (p *Profile) Scale(ratio float64)
- func (p *Profile) ScaleN(ratios []float64) error
- func (p *Profile) String() string
- func (p *Profile) Write(w io.Writer) error
- type Sample
- type TagMatch
- type ValueType
Constants¶
This section is empty.
Variables¶
var ErrNoData =fmt.Errorf("empty input file")Functions¶
This section is empty.
Types¶
typeDemangler¶
Demangler maps symbol names to a human-readable form. This mayinclude C++ demangling and additional simplification. Names thatare not demangled may be missing from the resulting map.
typeEdge¶added ingo1.23.0
type Edge struct {Src, Dest *Node// The summary weight of the edgeWeight, WeightDivint64// residual edges connect nodes that were connected through a// separate node, which has been removed from the report.Residualbool// An inline edge represents a call that was inlined into the caller.Inlinebool}Edge contains any attributes to be represented about edges in a graph.
func (*Edge)WeightValue¶added ingo1.23.0
WeightValue returns the weight value for this edge, normalizing if adivisor is available.
typeEdgeMap¶added ingo1.23.0
type EdgeMap []*Edge
EdgeMap is used to represent the incoming/outgoing edges from a node.
typeFunction¶
type Function struct {IDuint64NamestringSystemNamestringFilenamestringStartLineint64// contains filtered or unexported fields}Function corresponds to Profile.Function
typeGraph¶added ingo1.23.0
type Graph struct {NodesNodes}Graph summarizes a performance profile into a format that issuitable for visualization.
typeLabel¶
type Label struct {// contains filtered or unexported fields}Label corresponds to Profile.Label
typeLocation¶
type Location struct {IDuint64Mapping *MappingAddressuint64Line []LineIsFoldedbool// contains filtered or unexported fields}Location corresponds to Profile.Location
typeMapping¶
type Mapping struct {IDuint64Startuint64Limituint64Offsetuint64FilestringBuildIDstringHasFunctionsboolHasFilenamesboolHasLineNumbersboolHasInlineFramesbool// contains filtered or unexported fields}Mapping corresponds to Profile.Mapping
typeNode¶added ingo1.23.0
type Node struct {// Info describes the source location associated to this node.InfoNodeInfo// Function represents the function that this node belongs to. On// graphs with sub-function resolution (eg line number or// addresses), two nodes in a NodeMap that are part of the same// function have the same value of Node.Function. If the Node// represents the whole function, it points back to itself.Function *Node// Values associated to this node. Flat is exclusive to this node,// Cum includes all descendents.Flat, FlatDiv, Cum, CumDivint64// In and out Contains the nodes immediately reaching or reached by// this node.In, OutEdgeMap}Node is an entry on a profiling report. It represents a uniqueprogram location.
func (*Node)AddToEdge¶added ingo1.23.0
AddToEdge increases the weight of an edge between two nodes. Ifthere isn't such an edge one is created.
func (*Node)AddToEdgeDiv¶added ingo1.23.0
AddToEdgeDiv increases the weight of an edge between two nodes. Ifthere isn't such an edge one is created.
typeNodeInfo¶added ingo1.23.0
NodeInfo contains the attributes for a node.
func (*NodeInfo)NameComponents¶added ingo1.23.0
NameComponents returns the components of the printable name to be used for a node.
func (*NodeInfo)PrintableName¶added ingo1.23.0
PrintableName calls the Node's Formatter function with a single space separator.
typeNodeMap¶added ingo1.23.0
NodeMap maps from a node info struct to a node. It is used to mergereport entries with the same info.
func (NodeMap)FindOrInsertNode¶added ingo1.23.0
FindOrInsertNode takes the info for a node and either returns a matching nodefrom the node map if one exists, or adds one to the map if one does not.If kept is non-nil, nodes are only added if they can be located on it.
typeNodePtrSet¶added ingo1.23.0
NodePtrSet is a collection of nodes. Trimming a graph or tree requires a setof objects which uniquely identify the nodes to keep. In a graph, NodeInfoworks as a unique identifier; however, in a tree multiple nodes may shareidentical NodeInfos. A *Node does uniquely identify a node so we can use thatinstead. Though a *Node also uniquely identifies a node in a graph,currently, during trimming, graphs are rebuilt from scratch using only theNodeSet, so there would not be the required context of the initial graph toallow for the use of *Node.
typeNodes¶added ingo1.23.0
type Nodes []*Node
Nodes is an ordered collection of graph nodes.
funcCreateNodes¶added ingo1.23.0
CreateNodes creates graph nodes for all locations in a profile. Itreturns set of all nodes, plus a mapping of each location to theset of corresponding nodes (one per location.Line).
typeOptions¶added ingo1.23.0
type Options struct {SampleValue func(s []int64)int64// Function to compute the value of a sampleSampleMeanDivisor func(s []int64)int64// Function to compute the divisor for mean graphs, or nilDropNegativebool// Drop nodes with overall negative valuesKeptNodesNodeSet// If non-nil, only use nodes in this set}Options encodes the options for constructing a graph
typeProfile¶
type Profile struct {SampleType []*ValueTypeDefaultSampleTypestringSample []*SampleMapping []*MappingLocation []*LocationFunction []*FunctionComments []stringDropFramesstringKeepFramesstringTimeNanosint64DurationNanosint64PeriodType *ValueTypePeriodint64// contains filtered or unexported fields}Profile is an in-memory representation of profile.proto.
funcMerge¶
Merge merges all the profiles in profs into a single Profile.Returns a new profile independent of the input profiles. The mergedprofile is compacted to eliminate unused samples, locations,functions and mappings. Profiles must have identical profile sampleand period types or the merge will fail. profile.Period of theresulting profile will be the maximum of all profiles, andprofile.TimeNanos will be the earliest nonzero one.
funcParse¶
Parse parses a profile and checks for its validity. The input must be anencoded pprof protobuf, which may optionally be gzip-compressed.
func (*Profile)Aggregate¶
Aggregate merges the locations in the profile into equivalenceclasses preserving the request attributes. It also updates thesamples to point to the merged locations.
func (*Profile)CheckValid¶
CheckValid tests whether the profile is valid. Checks include, but arenot limited to:
- len(Profile.Sample[n].value) == len(Profile.value_unit)
- Sample.id has a corresponding Profile.Location
func (*Profile)Compatible¶
Compatible determines if two profiles can be compared/merged.returns nil if the profiles are compatible; otherwise an error withdetails on the incompatibility.
func (*Profile)Demangle¶
Demangle attempts to demangle and optionally simplify any functionnames referenced in the profile. It works on a best-effort basis:it will silently preserve the original names in case of any errors.
func (*Profile)FilterSamplesByTag¶
FilterSamplesByTag removes all samples from the profile, exceptthose that match focus and do not match the ignore regularexpression.
func (*Profile)HasFileLines¶
HasFileLines determines if all locations in this profile havesymbolized file and line number information.
func (*Profile)HasFunctions¶
HasFunctions determines if all locations in this profile havesymbolized function information.
func (*Profile)Merge¶
Merge adds profile p adjusted by ratio r into profile p. Profilesmust be compatible (same Type and SampleType).TODO(rsilvera): consider normalizing the profiles based on thetotal samples collected.
func (*Profile)Normalize¶
Normalize normalizes the source profile by multiplying each value in profile by theratio of the sum of the base profile's values of that sample type to the sum of thesource profile's value of that sample type.
func (*Profile)Prune¶
Prune removes all nodes beneath a node matching dropRx, and notmatching keepRx. If the root node of a Sample matches, the samplewill have an empty stack.
func (*Profile)RemoveUninteresting¶
RemoveUninteresting prunes and elides profiles using built-intables of uninteresting function names.