Skip to content

Add IO output #107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vchuravy wants to merge 9 commits into
base: vc/linear_func_id
Choose a base branch
from
Open

Add IO output #107

Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c4f833b
Add IO output
vchuravy Sep 30, 2025
ae53430
must call close on CompressorStream
vchuravy Sep 30, 2025
114699f
inner function return profile object
vchuravy Sep 30, 2025
81e7592
move docstring
vchuravy Sep 30, 2025
dd6df09
fixup! move docstring
vchuravy Oct 1, 2025
054a5e6
fixup! fixup! move docstring
vchuravy Oct 1, 2025
5703077
handle compression
vchuravy Oct 1, 2025
0499e96
add lidict back
vchuravy Oct 3, 2025
97367d6
add type to io argument
vchuravy Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 38 additions & 24 deletions src/PProf.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ using Base.StackTraces: StackFrame
# - Mappings

"""
pprof([data, [lidict]];
pprof([[io], 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,
Expand Down Expand Up @@ -85,18 +85,50 @@ You can also use `PProf.refresh(file="...")` to open a new file in the server.
- `ui_relative_percentages`: Passes `-relative_percentages` to pprof. Causes nodes
ignored/hidden through the web UI to be ignored from totals when computing percentages.
"""
function pprof(data::Union{Nothing, Vector{UInt}} = nothing,
lidict::Union{Nothing, Dict} = nothing;
sampling_delay::Union{Nothing, UInt64} = nothing,
function pprof end

function pprof(io, data::Union{Nothing, Vector{UInt}} = nothing)
prof = __pprof(data; kwargs...)
ProtoBuf.encode(ProtoBuf.ProtoEncoder(io), prof)
Copy link
Member Author

@vchuravy vchuravy Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NHDaly one question if we should leave compression up to the user, or if we should handle it here.

For the user it is a fair bit annoying to handle JuliaPerf/ProfileEndpoints.jl#51

end

function pprof(data::Union{Nothing, Vector{UInt}} = nothing;
web::Bool = true,
webhost::AbstractString = "localhost",
webport::Integer = 57599,
out::AbstractString = "profile.pb.gz",
ui_relative_percentages::Bool = true,
kwargs...)
@assert !isempty(basename(out)) "`out=` must specify a file path to write to. Got unexpected: '$out'"
if !endswith(out, ".pb.gz")
out = "$out.pb.gz"
@info "Writing output to $out"
end

prof = __pprof(data; kwargs...)
# Write to disk
io = GzipCompressorStream(open(out, "w"))
try
ProtoBuf.encode(ProtoBuf.ProtoEncoder(io), prof)
finally
close(io)
end

if web
refresh(webhost = webhost, webport = webport, file = out,
ui_relative_percentages = ui_relative_percentages)
end

return out
end

function __pprof(data::Union{Nothing, Vector{UInt}} = nothing,
lidict::Union{Nothing, Dict} = nothing;
sampling_delay::Union{Nothing, UInt64} = nothing,
from_c::Bool = true,
full_signatures::Bool = true,
drop_frames::Union{Nothing, AbstractString} = nothing,
keep_frames::Union{Nothing, AbstractString} = nothing,
ui_relative_percentages::Bool = true,
)
has_meta = false
if data === nothing
Expand All @@ -116,11 +148,6 @@ function pprof(data::Union{Nothing, Vector{UInt}} = nothing,
if sampling_delay === nothing
sampling_delay = ccall(:jl_profile_delay_nsec, UInt64, ())
end
@assert !isempty(basename(out)) "`out=` must specify a file path to write to. Got unexpected: '$out'"
if !endswith(out, ".pb.gz")
out = "$out.pb.gz"
@info "Writing output to $out"
end

string_table = OrderedDict{AbstractString, Int64}()
enter!(string) = _enter!(string_table, string)
Expand Down Expand Up @@ -323,20 +350,7 @@ function pprof(data::Union{Nothing, Vector{UInt}} = nothing,
default_sample_type = 1, # events
)

# Write to disk
io = GzipCompressorStream(open(out, "w"))
try
ProtoBuf.encode(ProtoBuf.ProtoEncoder(io), prof)
finally
close(io)
end

if web
refresh(webhost = webhost, webport = webport, file = out,
ui_relative_percentages = ui_relative_percentages)
end

out
return prof
end

function _escape_name_for_pprof(name)
Expand Down
Loading