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

async-profiler-agent-path clj

attach-agent clj

(attach-agent pid command-string)

clear-results clj

(clear-results)

Clear all results from /tmp/clj-async-profiler directory.

find-profile clj

(find-profile run-id-or-stacks-file)

flamegraph-script-path clj

generate-diffgraph clj

(generate-diffgraph profile-before profile-after options)

Generate a diff flamegraph SVG file from two profiles, identified by their IDs or filenames. For rendering-related options, see stop. Extra options:

:normalize? - normalize the numbers so that the total number of stacks in two runs are the same (default: true).

generate-flamegraph clj

(generate-flamegraph run-id-or-stacks-file options)

Generate a flamegraph SVG file from a collapsed stacks file, identified either by its filename, or numerical ID. For available options, see stop.

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)

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

:pid - process to attach to (default: current process) :silent? - if true, only return the event types, don't print them.

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 start and 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)

Run the profiler for the specified duration. Return the generated flamegraph file. For available options, see start and stop.

run-flamegraph-script clj

(run-flamegraph-script in-stacks-file
                       out-svg-file
                       {:keys [min-width reverse? icicle? width height title]
                        :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.

set-default-profiling-options clj

(set-default-profiling-options default-options-map)

Set the map of default options that will be used for all subsequent profiling runs. Defaults will be merged with explicit options with lower priority.

start clj

(start)

(start options)

Start the profiler. Available options:

:pid - process to attach to (default: current process) :interval - sampling interval in nanoseconds (default: 1000000 - 1ms) :framebuf - size of the buffer for stack frames (default: 1000000 - 1MB) :threads - profile each thread separately :event - event to profile, see list-event-types (default: :cpu)

status clj

(status)

(status options)

Get profiling agent status. Available options:

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

stop clj

(stop)

(stop options)

Stop the currently running profiler 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) :width - width of the generated flamegraph (default: 1200px, recommended to change for big screens) :height - height of the generated flamegraph :title - title of the generated flamegraph (default: "Flame Graph") :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)