Flamegraphs in VS Code - Visualizing Profiles from the py-spy profiler
Getting started is easy. Just run the command Flamegraph: Profile active file with py-spy. That's it!
(Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac) to open the command palette, then select the command.)
Your code will be profiled using py-spy. Once finished (or interrupted via Ctrl+C), the profiling results are visualized as line annotations in the editor and shown as a flamegraph in a new tab.
This is an early version of the extension and is still under active development. Currently only py-spy generated profiles are supported but support for other formats is planned. Browse your code to identify performance bottlenecks.
Usage
The extension visualizes profiling data in two ways:
Inline Code Annotations: Shows timing information for each function scope, with colors indicating the scope level.
Interactive Flamegraph: Displays the complete call stack of your profiled code (see this article about flamegraphs). You can:
- Click any element to zoom in
- Click parent elements to zoom out
Cmd+Click (Mac) or Ctrl+Click (Windows/Linux) any element to jump directly to that code.
The inline annotations and flamegraph are linked:
When you zoom in the flamegraph, the inline annotations automatically filter to show only the timing data for the visible part of the flamegraph.
The flamegraph and inline annotations complement each other: The flamegraph shows call-stack specific data, while inline annotations show aggregated function-level profile data.
Commands
Flamegraph: Profile active file with py-spy - Profile the active file with py-spy and display the results inline.
Flamegraph: Load Profile - Load a profile from a file. Currently only py-spy profiles are supported.
Flamegraph: Toggle Inline Profile - Show or hide the inline profile bars.
Flamegraph: Show - Open a new tab showing the flamegraph.
Flamegraph: Attach py-spy to running process - Attach py-spy to a running process and display the results inline. The extension will ask for a Process ID (PID) to attach to.
Flamegraph: Attach py-spy to running process (native) - Also collects profiling data from native (e.g. C++) extensions. This is not supported on all platforms. See this blog post by Ben Frederickson.
Contributing
Development
# Install dependencies for both the extension and webview UI source code
npm run install:all
# Build webview UI source code
npm run build:webview
Then, in VS Code
- Press
F5 to open a new Extension Development Host window
- Inside the host window, open the command palette (
Ctrl+Shift+P or Cmd+Shift+P on Mac) and type Flamegraph: Profile active file with py-spy
