Package: internal/profile

package profile Import Path internal/profile (on go.dev) Dependency Relation imports 10 packages, and imported by 2 packages Involved Source Files encode.go filter.go d graph.go Package profile represents a pprof profile as a directed graph. This package is a simplified fork of github.com/google/pprof/internal/graph. merge.go d profile.go Package profile provides a representation of github.com/google/pprof/proto/profile.proto and methods to encode/decode/merge profiles in this format. proto.go prune.go Package-Level Type Names (total 20) /* sort by: alphabet | popularity */ type Demangler (func) Demangler maps symbol names to a human-readable form. This may include C++ demangling and additional simplification. Names that are not demangled may be missing from the resulting map. As Inputs Of (at least one exported) func (*Profile).Demangle(d Demangler) error type Edge (struct) Edge contains any attributes to be represented about edges in a graph. Fields (total 6) Dest *Node Inline bool An inline edge represents a call that was inlined into the caller. Residual bool residual edges connect nodes that were connected through a separate node, which has been removed from the report. Src *Node Weight int64 The summary weight of the edge WeightDiv int64 The summary weight of the edge Methods (only one) (*Edge) WeightValue() int64 WeightValue returns the weight value for this edge, normalizing if a divisor is available. As Outputs Of (at least 2) func EdgeMap.FindTo(n *Node) *Edge func EdgeMap.Sort() []*Edge As Inputs Of (at least 2) func (*EdgeMap).Add(e *Edge) func (*EdgeMap).Delete(e *Edge) type EdgeMap ([]) EdgeMap is used to represent the incoming/outgoing edges from a node. Methods (total 5) (*EdgeMap) Add(e *Edge) (*EdgeMap) Delete(e *Edge) ( EdgeMap) FindTo(n *Node) *Edge ( EdgeMap) Sort() []*Edge Sort returns a slice of the edges in the map, in a consistent order. The sort order is first based on the edge weight (higher-to-lower) and then by the node names to avoid flakiness. ( EdgeMap) Sum() int64 Sum returns the total weight for a set of nodes. type Function (struct) Function corresponds to Profile.Function Fields (total 5) Filename string ID uint64 Name string StartLine int64 SystemName string type Graph (struct) Graph summarizes a performance profile into a format that is suitable for visualization. Fields (only one) Nodes Nodes Methods (only one) (*Graph) String() string String returns a text representation of a graph, for debugging purposes. Implements (at least 2) *Graph : expvar.Var *Graph : fmt.Stringer As Outputs Of (at least one exported) func NewGraph(prof *Profile, o *Options) *Graph type Label (struct) Label corresponds to Profile.Label type Line (struct) Line corresponds to Profile.Line Fields (total 2) Function *Function Line int64 type Location (struct) Location corresponds to Profile.Location Fields (total 5) Address uint64 ID uint64 IsFolded bool Line []Line Mapping *Mapping type Mapping (struct) Mapping corresponds to Profile.Mapping Fields (total 10) BuildID string File string HasFilenames bool HasFunctions bool HasInlineFrames bool HasLineNumbers bool ID uint64 Limit uint64 Offset uint64 Start uint64 type Node (struct) Node is an entry on a profiling report. It represents a unique program location. Fields (total 8) Cum int64 Values associated to this node. Flat is exclusive to this node, Cum includes all descendents. CumDiv int64 Values associated to this node. Flat is exclusive to this node, Cum includes all descendents. Flat int64 Values associated to this node. Flat is exclusive to this node, Cum includes all descendents. FlatDiv int64 Values associated to this node. Flat is exclusive to this node, Cum includes all descendents. Function *Node 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. In EdgeMap In and out Contains the nodes immediately reaching or reached by this node. Info NodeInfo Info describes the source location associated to this node. Out EdgeMap In and out Contains the nodes immediately reaching or reached by this node. Methods (total 4) (*Node) AddToEdge(to *Node, v int64, residual, inline bool) AddToEdge increases the weight of an edge between two nodes. If there isn't such an edge one is created. (*Node) AddToEdgeDiv(to *Node, dv, v int64, residual, inline bool) AddToEdgeDiv increases the weight of an edge between two nodes. If there isn't such an edge one is created. (*Node) CumValue() int64 CumValue returns the inclusive value for this node, computing the mean if a divisor is available. (*Node) FlatValue() int64 FlatValue returns the exclusive value for this node, computing the mean if a divisor is available. As Outputs Of (at least one exported) func NodeMap.FindOrInsertNode(info NodeInfo, kept NodeSet) *Node As Inputs Of (at least 3) func EdgeMap.FindTo(n *Node) *Edge func (*Node).AddToEdge(to *Node, v int64, residual, inline bool) func (*Node).AddToEdgeDiv(to *Node, dv, v int64, residual, inline bool) type NodeInfo (struct) NodeInfo contains the attributes for a node. Fields (total 4) Address uint64 Lineno int Name string StartLine int Methods (total 2) (*NodeInfo) NameComponents() []string NameComponents returns the components of the printable name to be used for a node. (*NodeInfo) PrintableName() string PrintableName calls the Node's Formatter function with a single space separator. As Inputs Of (at least one exported) func NodeMap.FindOrInsertNode(info NodeInfo, kept NodeSet) *Node type NodeMap (map) NodeMap maps from a node info struct to a node. It is used to merge report entries with the same info. Methods (only one) ( NodeMap) FindOrInsertNode(info NodeInfo, kept NodeSet) *Node FindOrInsertNode takes the info for a node and either returns a matching node from 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. type NodePtrSet (map) NodePtrSet is a collection of nodes. Trimming a graph or tree requires a set of objects which uniquely identify the nodes to keep. In a graph, NodeInfo works as a unique identifier; however, in a tree multiple nodes may share identical NodeInfos. A *Node does uniquely identify a node so we can use that instead. Though a *Node also uniquely identifies a node in a graph, currently, during trimming, graphs are rebuilt from scratch using only the NodeSet, so there would not be the required context of the initial graph to allow for the use of *Node. type Nodes ([]) Nodes is an ordered collection of graph nodes. Methods (only one) ( Nodes) Sum() (flat int64, cum int64) Sum adds the flat and cum values of a set of nodes. As Outputs Of (at least one exported) func CreateNodes(prof *Profile, o *Options) (Nodes, locationMap) type NodeSet (map) NodeSet is a collection of node info structs. As Inputs Of (at least one exported) func NodeMap.FindOrInsertNode(info NodeInfo, kept NodeSet) *Node type Options (struct) Options encodes the options for constructing a graph Fields (total 4) DropNegative bool // Drop nodes with overall negative values KeptNodes NodeSet // If non-nil, only use nodes in this set SampleMeanDivisor func(s []int64) int64 // Function to compute the divisor for mean graphs, or nil SampleValue func(s []int64) int64 // Function to compute the value of a sample As Inputs Of (at least 2) func CreateNodes(prof *Profile, o *Options) (Nodes, locationMap) func NewGraph(prof *Profile, o *Options) *Graph type Profile (struct) Profile is an in-memory representation of profile.proto. Fields (total 13) Comments []string DefaultSampleType string DropFrames string DurationNanos int64 Function []*Function KeepFrames string Location []*Location Mapping []*Mapping Period int64 PeriodType *ValueType Sample []*Sample SampleType []*ValueType TimeNanos int64 Methods (total 17) (*Profile) Aggregate(inlineFrame, function, filename, linenumber, address bool) error Aggregate merges the locations in the profile into equivalence classes preserving the request attributes. It also updates the samples to point to the merged locations. (*Profile) CheckValid() error CheckValid tests whether the profile is valid. Checks include, but are not limited to: - len(Profile.Sample[n].value) == len(Profile.value_unit) - Sample.id has a corresponding Profile.Location (*Profile) Compatible(pb *Profile) error Compatible determines if two profiles can be compared/merged. returns nil if the profiles are compatible; otherwise an error with details on the incompatibility. (*Profile) Copy() *Profile Copy makes a fully independent copy of a profile. (*Profile) Demangle(d Demangler) error Demangle attempts to demangle and optionally simplify any function names referenced in the profile. It works on a best-effort basis: it will silently preserve the original names in case of any errors. (*Profile) Empty() bool Empty reports whether the profile contains no samples. (*Profile) FilterSamplesByTag(focus, ignore TagMatch) (fm, im bool) FilterSamplesByTag removes all samples from the profile, except those that match focus and do not match the ignore regular expression. (*Profile) HasFileLines() bool HasFileLines determines if all locations in this profile have symbolized file and line number information. (*Profile) HasFunctions() bool HasFunctions determines if all locations in this profile have symbolized function information. (*Profile) Merge(pb *Profile, r float64) error Merge adds profile p adjusted by ratio r into profile p. Profiles must be compatible (same Type and SampleType). TODO(rsilvera): consider normalizing the profiles based on the total samples collected. (*Profile) Normalize(pb *Profile) error Normalize normalizes the source profile by multiplying each value in profile by the ratio of the sum of the base profile's values of that sample type to the sum of the source profile's value of that sample type. (*Profile) Prune(dropRx, keepRx *regexp.Regexp) Prune removes all nodes beneath a node matching dropRx, and not matching keepRx. If the root node of a Sample matches, the sample will have an empty stack. (*Profile) RemoveUninteresting() error RemoveUninteresting prunes and elides profiles using built-in tables of uninteresting function names. (*Profile) Scale(ratio float64) Scale multiplies all sample values in a profile by a constant. (*Profile) ScaleN(ratios []float64) error ScaleN multiplies each sample values in a sample by a different amount. (*Profile) String() string Print dumps a text representation of a profile. Intended mainly for debugging purposes. (*Profile) Write(w io.Writer) error Write writes the profile as a gzip-compressed marshaled protobuf. Implements (at least 2) *Profile : expvar.Var *Profile : fmt.Stringer As Outputs Of (at least 4) func Merge(srcs []*Profile) (*Profile, error) func Parse(r io.Reader) (*Profile, error) func (*Profile).Copy() *Profile func internal/trace/traceviewer.BuildProfile(prof []traceviewer.ProfileRecord) *Profile As Inputs Of (at least 6) func CreateNodes(prof *Profile, o *Options) (Nodes, locationMap) func Merge(srcs []*Profile) (*Profile, error) func NewGraph(prof *Profile, o *Options) *Graph func (*Profile).Compatible(pb *Profile) error func (*Profile).Merge(pb *Profile, r float64) error func (*Profile).Normalize(pb *Profile) error type Sample (struct) Sample corresponds to Profile.Sample Fields (total 5) Label map[string][]string Location []*Location NumLabel map[string][]int64 NumUnit map[string][]string Value []int64 type TagMatch (func) TagMatch selects tags for filtering As Inputs Of (at least one exported) func (*Profile).FilterSamplesByTag(focus, ignore TagMatch) (fm, im bool) type ValueType (struct) ValueType corresponds to Profile.ValueType Fields (total 2) Type string // cpu, wall, inuse_space, etc Unit string // seconds, nanoseconds, bytes, etc Package-Level Functions (total 4) func CreateNodes(prof *Profile, o *Options) (Nodes, locationMap) CreateNodes creates graph nodes for all locations in a profile. It returns set of all nodes, plus a mapping of each location to the set of corresponding nodes (one per location.Line). func Merge(srcs []*Profile) (*Profile, error) Merge merges all the profiles in profs into a single Profile. Returns a new profile independent of the input profiles. The merged profile is compacted to eliminate unused samples, locations, functions and mappings. Profiles must have identical profile sample and period types or the merge will fail. profile.Period of the resulting profile will be the maximum of all profiles, and profile.TimeNanos will be the earliest nonzero one. func NewGraph(prof *Profile, o *Options) *Graph NewGraph computes a graph from a profile. func Parse(r io.Reader) (*Profile, error) Parse parses a profile and checks for its validity. The input must be an encoded pprof protobuf, which may optionally be gzip-compressed. Package-Level Variables (only one) var ErrNoData error

The pages are generated with Golds v0.7.0-preview. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.