julia-vscode/chromeprofileformat.jl

Export Julia profile results to .cpuprofile files

Julia

This VS Code extension provides support for the Julia programming language.

Getting started

Installing Julia/VS Code/VS Code Julia extension

1. Install Julia for your platform: https://julialang.org/downloads/
2. Install VS Code for your platform: https://code.visualstudio.com/download At the end of this step you should be able to start VS Code.
3. Choose Install in the VS Code Marketplace; or paste in browser's address bar to open this direct VS Code link vscode:extension/julialang.language-julia or manually install with:
   1. Start VS Code.
   2. Inside VS Code, go to the extensions view either by executing the View: Show Extensions command (click View->Command Palette...) or by clicking on the extension icon on the left side of the VS Code window.
   3. In the extensions view, simply search for the term julia in the marketplace search box, then select the extension named Julia and click the install button. You might have to restart VS Code after this step.

Configure the Julia extension

If you have installed Julia into a standard location on Mac or Windows, or if the Julia binary is on your PATH, the Julia VS Code extension should automatically find your Julia installation and you should not need to configure anything.

If the extension does not find your Julia installation automatically, or if you want to use a different Julia installation than the default one, you can set the julia.executablePath to point to the Julia executable that the extension should use. In that case the extension will always use that version of Julia. To edit your configuration settings, execute the Preferences: Open User Settings command (you can also access it via the menu File->Preferences->Settings), and then make sure your user settings include the julia.executablePath setting. The format of the string should follow your platform specific conventions, and be aware that the backlash \ is the escape character in JSON, so you need to use \\ as the path separator character on Windows.

Features

The extension currently provides:

• syntax highlighting
• snippets: latex and user-shared snippets
• Julia specific commands
• integrated Julia REPL
• code completion
• hover help
• a linter
• code navigation
• tasks for running tests, builds, benchmarks and build documentation
• a debugger
• a plot gallery
• a grid viewer for tabular data
• integrated support for Weave.jl

Documentation

The documentation has sections that describe the features of this extension (including e.g. keyboard shortcuts). This repo also has legacy docs in the wiki.

Questions, Feature requests and contributions

1. If you face any issues, please open an issue here.
2. For some known issues and their solutions, please visit the known issues and workarounds.
3. If there is already an issue opened related to yours, please leave an upvote/downvote on the issue.
4. Contributions are always welcome! Please see our contributing guide for more details.

Data/Telemetry

The Julia extension for Visual Studio Code collects usage data and sends it to the development team to help improve the extension. Read our privacy policy to learn more and how to disable any telemetry.

chromeprofileformat.jl's Issues

Add type instability info

I just tried to use the new profiler support in the VS Code extension for real, and I'm realizing we are missing a major piece that is present in things like ProfileViewer.jl: some visual indication in the flame graph where there is a type instability. That is actually really one of the most useful pieces in ProfileViewer...

So I guess the first question is whether there is anything in the .cpuprofile format that would allow us to include that kind of info, and then whether it would show up say via a different color in the VS Code visualizer.

@vchuravy, any ideas?

Option to exclude some parts of the stack trace

It would be nice for the VS Code extension if we could exclude some parts of the stack trace in the output. In particular, say I execute @profview foo(), then it would be nice if we found a way so that anything above foo() from the stack trace is actually not inlcuded in the output. Right now we get a lot more:

In this example:

All the first entries up to and including the include_string are really part of the VS Code extension and would ideally not be shown.

@vchuravy do you think that can be done somehow?

KeyError: key 0x0000000000000001 not found on Julia 1.8

Opening an issue for tracking. On Julia 1.8, I'm seeing an error:

ODE   0%\|                                               \|  ETA: N/A
ODE   0%\|                                               \|  ETA: N/A
ERROR: LoadError: KeyError: key 0x0000000000000001 not found
--
  | Stacktrace:
  | [1] getindex
  | @ ./dict.jl:498 [inlined]
  | [2] ChromeProfileFormat.CPUProfile(data::Nothing, period::Nothing; from_c::Bool)
  | @ ChromeProfileFormat /tc/depot/cpu/packages/ChromeProfileFormat/UAHXj/src/core.jl:116
  | [3] CPUProfile
  | @ /tc/depot/cpu/packages/ChromeProfileFormat/UAHXj/src/core.jl:56 [inlined]
  | [4] #save_cpuprofile#8
  | @ /tc/depot/cpu/packages/ChromeProfileFormat/UAHXj/src/core.jl:195 [inlined]
  | [5] save_cpuprofile (repeats 2 times)
  | @ /tc/depot/cpu/packages/ChromeProfileFormat/UAHXj/src/core.jl:192 [inlined]
  | [6] top-level scope
  | @ /tc/11742/turbulenceconvection-ci/perf/flame.jl:35

in TurbulenceConvection.jl, build here

TagBot trigger issue

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

example fails on Julia 1.8.1

Try example on Julia 1.8.1

using Profile, ChromeProfileFormat

function foo()
    A = randn(1000, 1000)
    return inv(A)
end

foo()
Profile.clear()
@profile foo()
ChromeProfileFormat.save_cpuprofile("test.cpuprofile", from_c=true)

get error

ERROR: KeyError: key 0x0000000000000002 not found
Stacktrace:
 [1] getindex
   @ ./dict.jl:498 [inlined]
 [2] ChromeProfileFormat.CPUProfile(data::Nothing, period::Nothing; from_c::Bool)
   @ ChromeProfileFormat ~/.julia/packages/ChromeProfileFormat/UAHXj/src/core.jl:116
 [3] #save_cpuprofile#8
   @ ~/.julia/packages/ChromeProfileFormat/UAHXj/src/core.jl:195 [inlined]
 [4] top-level scope
   @ ~/tmp/test.jl:37