clj-async-profiler.core — com.clojure-goes-fast/clj-async-profiler 0.2.0

async-profiler-agent-path clj

attach-agent clj

(attach-agent pid command-string)

flamegraph-script-path clj

get-self-pid clj

(get-self-pid)

Returns the process ID of the current JVM process.

list-event-types clj

(list-event-types)

(list-event-types options)

(list-event-types pid options)

Print all event types that can be sampled by the profiler. Available options:

:pid - process to attach to (default: current process)

profile clj macro

(profile options? & body)

Profile the execution of body. If the first argument is a map, treat it as options. For available options, see clj-async-profiler.core/start and clj-async-profiler.core/stop. :pid option is ignored, current process is always profiled. Additional options:

:return-file - if true, return the generated flamegraph file, otherwise return the value returned by body (default: false - return value)

profile-for clj

(profile-for duration-in-seconds)

(profile-for duration-in-seconds options)

(profile-for pid duration-in-seconds options)

Run the profiler for the specified duration. Return a future that will deliver the file with the results. For available options, see clj-async-profiler.core/start and clj-async-profiler.core/stop.

run-flamegraph-script clj

(run-flamegraph-script in-stacks-file
                       out-svg-file
                       {:keys [min-width reverse? icicle?]
                        :or {icicle? reverse?}})

Run Flamegraph script on the provided stacks file, rendering the SVG result.

serve-files clj

(serve-files port)

Start a simple webserver of the results directory on the provided port.

start clj

(start)

(start options)

(start pid options)

Start the profiler for the specified process ID. Available options:

:pid - process to attach to (default: current process) :interval - sampling interval in nanoseconds (default: 1000000 - 1ms) :event - event to profile, see list-event-types (default: :cpu)

stop clj

(stop)

(stop options)

(stop pid options)

Stop the profiler for the specified process ID. and save the results into a temporary file. Return the file object with the results. Available options:

:pid - process to attach to (default: current process) :generate-flamegraph? - if true, generate flamegraph in the same directory as the profile (default: true) :min-width - minimum width in pixels for a frame to be shown on a flamegraph. Use this if the resulting flamegraph is too big and hangs your browser (default: nil, recommended: 1-5) :reverse? - if true, generate the reverse flamegraph which grows from callees up to callers (default: false) :icicle? - if true, invert the flamegraph upside down (default: false for regular flamegraph, true for reverse)