🔬 A fast, interactive web-based viewer for performance profiles.
Go to file
Jamie Wong aee4534de4
Integrate jest and add first test file (#51)
This sets up the first bit of test infrastructure to write and run unit tests on every PR

Related to #14 
Fixes #7
2018-05-29 14:34:09 -07:00
import Fixes for details view (#44) 2018-05-20 14:42:16 -07:00
sample Add Synalize It! Pro grammars Instruments for safe keeping 2018-05-17 09:13:55 -07:00
.eslintrc.js Set up Prettier and run it on the whole codebase 2018-04-14 08:40:06 -07:00
.gitignore Set up Prettier and run it on the whole codebase 2018-04-14 08:40:06 -07:00
.travis.yml Set up Prettier and run it on the whole codebase 2018-04-14 08:40:06 -07:00
application.tsx Support importing time profiles from Instruments .trace files (#41) 2018-05-17 00:33:09 -07:00
canvas-context.ts Fix typo in file name 2018-04-18 21:44:39 -07:00
color.ts Add a detail view to view aggregate statistics & file details (#23) 2018-04-17 00:04:24 -07:00
demangle-cpp.ts Set up Prettier and run it on the whole codebase 2018-04-14 08:40:06 -07:00
deploy.sh Set the CNAME record in the deploy 2018-05-09 00:00:28 -07:00
favicon-16x16.png Favicon 2018-01-07 08:36:11 -08:00
favicon-32x32.png Favicon 2018-01-07 08:36:11 -08:00
favicon.ico Favicon 2018-01-07 08:36:11 -08:00
flamechart-color-pass-renderer.ts Address review comments 2018-04-14 16:19:26 -07:00
flamechart-minimap-view.tsx Fix browser zoom issues by not caching devicePixelRatio (#27) 2018-04-18 22:18:37 -07:00
flamechart-renderer.ts Address review comments 2018-04-14 16:19:26 -07:00
flamechart-style.ts Fixes for details view (#44) 2018-05-20 14:42:16 -07:00
flamechart-view.tsx Fix position of x axis labels (#50) 2018-05-29 13:46:14 -07:00
flamechart.ts Address review comments 2018-04-14 16:19:26 -07:00
hash-params.ts Add profileURL and title hash parameters (#19) 2018-04-14 20:38:04 -07:00
index.html Switch to Source Code Pro, tweak outlines (#48) 2018-05-29 13:32:39 -07:00
LICENSE Add MIT License 2018-04-08 22:35:53 -07:00
lru-cache.ts Address review comments 2018-04-14 16:19:26 -07:00
math.ts Address review comments 2018-04-14 16:19:26 -07:00
overlay-rectangle-renderer.ts Address review comments 2018-04-14 16:19:26 -07:00
package-lock.json Integrate jest and add first test file (#51) 2018-05-29 14:34:09 -07:00
package.json Integrate jest and add first test file (#51) 2018-05-29 14:34:09 -07:00
prettier.config.js Address review comments 2018-04-14 16:19:26 -07:00
profile.ts Fixes for details view (#44) 2018-05-20 14:42:16 -07:00
README.md Support importing from instruments via deep copy (#33) 2018-05-08 22:27:31 -07:00
rectangle-batch-renderer.ts Address review comments 2018-04-14 16:19:26 -07:00
regl.d.ts Address review comments 2018-04-14 16:19:26 -07:00
reloadable.tsx Address review comments 2018-04-14 16:19:26 -07:00
reset.css Minimap viewport rectangle border 2017-12-26 18:02:00 -05:00
speedscope.tsx Address review comments 2018-04-14 16:19:26 -07:00
stats.ts Set up Prettier and run it on the whole codebase 2018-04-14 08:40:06 -07:00
style.ts Switch to Source Code Pro, tweak outlines (#48) 2018-05-29 13:32:39 -07:00
texture-cached-renderer.ts Fix typo in file name 2018-04-18 21:44:39 -07:00
tsconfig.json More tweaks to release process 2018-04-05 00:53:21 -07:00
utils.test.ts Integrate jest and add first test file (#51) 2018-05-29 14:34:09 -07:00
utils.ts Integrate jest and add first test file (#51) 2018-05-29 14:34:09 -07:00

🔬speedscope

A fast, interactive web-based viewer for sampling profiles. An alternative viewer for FlameGraphs. Will happily display multi-megabyte profiles without crashing your browser.

Given raw profiling data, speedscope allows you to interactively explore the data to get insight into what's slow in your application, or allocating all the memory, or whatever data is represented in the profiling data.

Example Profile

Usage

Visit https://jlfwong.github.io/speedscope/, then either browse to find a profile file or drag-and-drop one onto the page. The profiles are not uploaded anywhere -- the application is totally in-browser.

Supported file formats

Chrome

Both the timeline format output by Chrome developers tools (https://developers.google.com/web/tools/chrome-devtools/evaluate-performance/reference#save) and the .cpuprofile format output are supported. The .cpuprofile format is useful for viewing flamecharts generated by Node.js applications: https://medium.com/@paul_irish/debugging-node-js-nightlies-with-chrome-devtools-7c4a1b95ae27

Firefox

The profile.json file format output by Firefox can be saved and import into speedscope: https://developer.mozilla.org/en-US/docs/Tools/Performance

Instruments.app

You can import call trees from OSX Instruments.app into speedscope by selecting a row in the "Profile" view and select "Edit -> Deep Copy" from the menu then pasting directly into speedscope. This data contains only aggregate statistics, so the "Time Order" view and the "Left Heavy" view will look very similar.

stackprof Ruby profiler

If the raw: true flag is set when recording a dump, the resulting json dump can be imported into speedscope.

perf and DTrace

If you process the output of perf or DTrace first with Brendan Gregg's stackcollapse-*.pl scripts (https://github.com/brendangregg/FlameGraph#2-fold-stacks), the result can be imported into speedscope.

Importing via URL

To load a specific profile by URL, you can append a hash fragment like #profileURL=[URL-encoded profile URL]&title=[URL-encoded custom title]. Note that the server hosting the profile must have CORS configured to allow AJAX requests from speedscope.

Views

Both of the main views of the applications display flame graphs.

In this view, the horizontal axis represents the "weight" of each stack (most commonly CPU time), and the vertical axis shows you the stack active at the time of the sample.

🕰Time Order

In the "Time Order" view (the default), the stacks are ordered left-to-right in the same order as the occurred in the input file, which is usually going to be the chronological order they were recorded in. This view is most helpful for understand the behavior of an application over time, e.g. "first the data is fetched from the database, then the data is prepared for serialization, then the data is serialized to JSON". This is the only flame graph order supported by Chrome developer tools.

⬅️Left Heavy

In the "Left Heavy" view, identical stacks are grouped together, regardless of whether they were recorded sequentially. Then, the stacks are sorted so that the heaviest stack for each parent is on the left -- hence "left heavy". This view is useful for understanding where all the time is going in situations where there are hundreds or thousands of function calls interleaved between other call stacks.

Navigation

Once a profile has loaded, the main view is split into two: the top area is the "minimap", and the bottom area is the "stack view".

Minimap Navigation

  • Scroll on either axis to pan around
  • Click and drag to narrow your view to a specific range

Stack View Navigation

  • Scroll on either axis to pan around
  • Pinch to zoom
  • Hold Cmd+Scroll to zoom
  • Double click on a frame to fit the viewport to it

Keyboard Navigation

  • +: zoom in
  • -: zoom out
  • 0: zoom out to see the entire profile
  • w/a/s/d or arrow keys: pan around the profile
  • 1: Switch to the "Time Order" view
  • 2: Switch to the "Left Heavy" view