https://github.com/juliaperf/pprof.jl
Export Julia profiles to the pprof format
https://github.com/juliaperf/pprof.jl
Last synced: 3 months ago
JSON representation
Export Julia profiles to the pprof format
- Host: GitHub
- URL: https://github.com/juliaperf/pprof.jl
- Owner: JuliaPerf
- License: mit
- Created: 2019-07-04T22:50:10.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-10-03T14:34:33.000Z (3 months ago)
- Last Synced: 2025-10-09T09:23:56.788Z (3 months ago)
- Language: Julia
- Homepage:
- Size: 785 KB
- Stars: 165
- Watchers: 4
- Forks: 18
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PProf.jl
[![CI][ci-img]][ci-url]
*Sometimes I need a hammer, sometimes I need a drill, this is a hammer-drill*
```julia
using Profile
using PProf
# Collect a profile
Profile.clear()
@profile peakflops()
# Export pprof profile and open interactive profiling web interface.
pprof()
```
This prints a link to a local webserver where you can inspect the profile you've collected. It produces a file called `profile.pb.gz` in the [`pprof`](https://github.com/google/pprof) format, and then opens the `pprof` tool in interactive "web" mode.
To profile allocations instead of CPU time, simply use the equivalent functions from the `Allocs` submodule instead:
```julia
# Collect an allocation profile
Profile.Allocs.clear()
Profile.Allocs.@profile peakflops()
# Export pprof allocation profile and open interactive profiling web interface.
PProf.Allocs.pprof()
```
For more usage examples see the pprof docs: https://github.com/google/pprof/blob/master/doc/README.md
## Dependencies
- [Graphviz](https://www.graphviz.org/)
- In order to use pprof's web graph view (which is one of the best parts of pprof), you need to have graphviz installed. Click the above link to install.
## Usage
```julia
help?> pprof
pprof([data, [lidict]];
web = true, webhost = "localhost", webport = 57599,
out = "profile.pb.gz", from_c = true, full_signatures = true, drop_frames = "",
keep_frames = "", ui_relative_percentages = true, sampling_delay = nothing,
)
pprof(FlameGraphs.flamegraph(); kwargs...)
Fetches the collected `Profile` data, exports to the `pprof` format, and (optionally) opens
a `pprof` web-server for interactively viewing the results.
```
```julia
help?> @pprof
@pprof ex
Profiles the expression using @profile and starts or restarts the pprof() web UI with default arguments.
```
Calling `pprof()` or `@pprof` exports the profiling results to disk, and launches the web server in the background pointed at the results. Calling it again overwrites the results and refreshes the server, so you can reload the web-page to see your updated results. The link to the webserver is printed to your terminal, which you can then open in a browser.
If you manually modify the output profile file, you can _refresh_ the web server without overwriting the `out` file by calling `PProf.refresh()`.
## Example
```julia
julia> using PProf
julia> @pprof peakflops()
"profile.pb.gz"
Main binary filename not available.
Serving web UI on http://localhost:57599
```
## Google PProf Web View
[ci-img]: https://github.com/JuliaPerf/PProf.jl/actions/workflows/CI.yml/badge.svg?branch=master
[ci-url]: https://github.com/JuliaPerf/PProf.jl/actions/workflows/CI.yml