| commit | 6f57359322fd9ce2d6dabde5b733714463416b6f | [log] [tgz] |
|---|---|---|
| author | Mark Hansen <markhansen@google.com> | Tue Dec 14 16:59:06 2021 +1100 |
| committer | GitHub <noreply@github.com> | Mon Dec 13 21:59:06 2021 -0800 |
| tree | 8dfd93aff60ce91be640f181284fdc8a413207a2 | |
| parent | 2007db6d4f53c44a417ddae675d50f56b8e8c2fd [diff] |
Update d3-flame-graph from 2.0.0-alpha to 4.1.3 (#677) This pulls in a fix for an XSS vulnerability, where profiles with HTML tag frame labels would get executed by the browser: https://github.com/spiermar/d3-flame-graph/pull/200 The flamegraph still looks the same, with the same theme. d3-flame-graph's packaging method has changed between 2.0 and 4.1 (from Rollup to Webpack). Rollup no longer works to build the bundle, so I've migrated the bundling code to Webpack. I've ~halved the file size, by: - reducing the API surface of exports to just d3-flame-graph and d3-selection; these are the only functions used by pprof. - combining d3 and d3-flame-graph into one bundle, to avoid duplicating common d3 code in both bundles. Filesize before (separate): ``` $ du -sh d3/d3.go d3flamegraph/d3_flame_graph.go 136K d3/d3.go 24K d3flamegraph/d3_flame_graph.go ``` After (combined): ``` $ du -h d3_flame_graph.go 72K d3_flame_graph.go ``` I've tried to make the build more reproducible too, by checking in the `package.json` and `package-lock.json` files that npm uses to freeze dependency versions. Previously these files lived over at https://github.com/spiermar/d3-pprof. I've bumped the version in `package.json` to 2.0 as this seems like a large change to that package. A few no-op changes: - I removed an explicit setting of a transition animation in pprof's code (it's the default in d3-flame-graph, so it's redundant to set it, and increases the bundle complexity). - I replaced a commented hack to set the `warm` colourscheme with the new API method that sets the colourscheme. Co-authored-by: Alexey Alexandrov <aalexand@users.noreply.github.com>
pprof is a tool for visualization and analysis of profiling data.
pprof reads a collection of profiling samples in profile.proto format and generates reports to visualize and help analyze the data. It can generate both text and graphical reports (through the use of the dot visualization package).
profile.proto is a protocol buffer that describes a set of callstacks and symbolization information. A common usage is to represent a set of sampled callstacks from statistical profiling. The format is described on the proto/profile.proto file. For details on protocol buffers, see https://developers.google.com/protocol-buffers
Profiles can be read from a local file, or over http. Multiple profiles of the same type can be aggregated or compared.
If the profile samples contain machine addresses, pprof can symbolize them through the use of the native binutils tools (addr2line and nm).
This is not an official Google product.
Prerequisites:
Go development kit of a supported version. Follow these instructions to prepare the environment.
Graphviz: http://www.graphviz.org/ Optional, used to generate graphic visualizations of profiles
To build and install it:
go install github.com/google/pprof@latest
The binary will be installed $GOPATH/bin ($HOME/go/bin by default).
pprof can read a profile from a file or directly from a server via http. Specify the profile input(s) in the command line, and use options to indicate how to format the report.
% pprof -top [main_binary] profile.pb.gz
Where
main_binary: Local path to the main program binary, to enable symbolization
profile.pb.gz: Local path to the profile in a compressed protobuf, or
URL to the http service that serves a profile.
pprof -web [main_binary] profile.pb.gz
If no output formatting option is specified, pprof runs on interactive mode, where reads the profile and accepts interactive commands for visualization and refinement of the profile.
pprof [main_binary] profile.pb.gz This will open a simple shell that takes pprof commands to generate reports. Type 'help' for available commands/options.
If the -http flag is specified, pprof starts a web server at the specified host:port that provides an interactive web-based interface to pprof. Host is optional, and is “localhost” by default. Port is optional, and is a random available port by default. -http=":" starts a server locally at a random port.
pprof -http=[host]:[port] [main_binary] profile.pb.gz
The preceding command should automatically open your web browser at the right page; if not, you can manually visit the specified port in your web browser.
pprof can read perf.data files generated by the Linux perf tool by using the perf_to_profile program from the perf_data_converter package.
To view disassembly of profiles collected from Go programs compiled as Windows executables, the executable must be built with go build -buildmode=exe. LLVM or GCC must be installed, so required tools like addr2line and nm are available to pprof.
See doc/README.md for more detailed end-user documentation.
See CONTRIBUTING.md for contribution documentation.
See proto/README.md for a description of the profile.proto format.