Liking cljdoc? Tell your friends :D

clj-async-profiler.core


async-profiler-agent-pathclj

source

attach-agentclj

(attach-agent pid command-string)
source

clear-resultsclj

(clear-results)

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

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

find-profileclj

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

generate-diffgraphclj

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

Generate a diff flamegraph from two profiles, identified either by their file paths or IDs. Options:

:title - title of the generated flamegraph (optional) :predefined-transforms - a list of maps that specify the dynamic transforms to bake into the flamegraph. For example:

... :predefined-transforms [{:type :remove :what "frame_buffer_overflow"} {:type :replace :what #"(;manifold.deferred[^;]+)+" :replacement ";manifold.deferred/..."} ...

Generate a diff flamegraph from two profiles, identified either by their file
paths or IDs. Options:

:title - title of the generated flamegraph (optional)
:predefined-transforms - a list of maps that specify the dynamic transforms to
                         bake into the flamegraph. For example:

...
:predefined-transforms [{:type :remove
                         :what "frame_buffer_overflow"}
                        {:type :replace
                         :what #"(;manifold.deferred[^;]+)+"
                         :replacement ";manifold.deferred/..."}
...
sourceraw docstring

generate-flamegraphclj

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

Generate flamegraph from a collapsed stacks file, identified either by its file path or numerical ID. Options:

:title - title of the generated flamegraph (optional) :predefined-transforms - a list of maps that specify the dynamic transforms to bake into the flamegraph. For example:

... :predefined-transforms [{:type :remove :what "frame_buffer_overflow"} {:type :replace :what #"(;manifold.deferred[^;]+)+" :replacement ";manifold.deferred/..."} ...

Generate flamegraph from a collapsed stacks file, identified either by its file
path or numerical ID. Options:

:title - title of the generated flamegraph (optional)
:predefined-transforms - a list of maps that specify the dynamic transforms to
                         bake into the flamegraph. For example:

...
:predefined-transforms [{:type :remove
                         :what "frame_buffer_overflow"}
                        {:type :replace
                         :what #"(;manifold.deferred[^;]+)+"
                         :replacement ";manifold.deferred/..."}
...
sourceraw docstring

list-event-typesclj

(list-event-types)
(list-event-types options)

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

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

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

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

(print-jvm-opt-for-startup-profiling options)

Generate a JVM option string that can be used to profile a JVM application completely from its start to finish. Prints further instructions to stdout. Options:

:event - event to profile, see list-event-types (default: :cpu) :interval - sampling interval in nanoseconds (default: 1000000 - 1ms) :threads - profile each thread separately :features - a list of extra features (or :all to enable all). Features: :vtable - show targets of vtable/itable calls :comptask - show JIT compilation task :framebuf - size of the buffer for stack frames (default: 1000000 - 1MB)

Generate a JVM option string that can be used to profile a JVM application
completely from its start to finish. Prints further instructions to stdout.
Options:

:event - event to profile, see `list-event-types` (default: :cpu)
:interval - sampling interval in nanoseconds (default: 1000000 - 1ms)
:threads - profile each thread separately
:features - a list of extra features (or `:all` to enable all). Features:
  :vtable - show targets of vtable/itable calls
  :comptask - show JIT compilation task
:framebuf - size of the buffer for stack frames (default: 1000000 - 1MB)
sourceraw docstring

profilecljmacro

(profile options? & body)

Profile the execution of body. If the first argument is a map, treat it as options. Options:

:event - event to profile, see list-event-types (default: :cpu) :interval - sampling interval in nanoseconds (default: 1000000 - 1ms) :threads - profile each thread separately :features - a list of extra features (or :all to enable all). Features: :vtable - show targets of vtable/itable calls :comptask - show JIT compilation task :framebuf - size of the buffer for stack frames (default: 1000000 - 1MB) :title - title of the generated flamegraph (optional) :predefined-transforms - a list of maps that specify the dynamic transforms to bake into the flamegraph. For example:

... :predefined-transforms [{:type :remove :what "frame_buffer_overflow"} {:type :replace :what #"(;manifold.deferred[^;]+)+" :replacement ";manifold.deferred/..."} ...

Profile the execution of `body`. If the first argument is a map, treat it as
options. Options:

:event - event to profile, see `list-event-types` (default: :cpu)
:interval - sampling interval in nanoseconds (default: 1000000 - 1ms)
:threads - profile each thread separately
:features - a list of extra features (or `:all` to enable all). Features:
  :vtable - show targets of vtable/itable calls
  :comptask - show JIT compilation task
:framebuf - size of the buffer for stack frames (default: 1000000 - 1MB)
:title - title of the generated flamegraph (optional)
:predefined-transforms - a list of maps that specify the dynamic transforms to
                         bake into the flamegraph. For example:

...
:predefined-transforms [{:type :remove
                         :what "frame_buffer_overflow"}
                        {:type :replace
                         :what #"(;manifold.deferred[^;]+)+"
                         :replacement ";manifold.deferred/..."}
...
sourceraw docstring

profile-forclj

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

Run the profiler for the specified duration. Return the generated flamegraph file. Options:

:pid - process to attach to (default: current process) :event - event to profile, see list-event-types (default: :cpu) :interval - sampling interval in nanoseconds (default: 1000000 - 1ms) :threads - profile each thread separately :features - a list of extra features (or :all to enable all). Features: :vtable - show targets of vtable/itable calls :comptask - show JIT compilation task :framebuf - size of the buffer for stack frames (default: 1000000 - 1MB) :title - title of the generated flamegraph (optional) :predefined-transforms - a list of maps that specify the dynamic transforms to bake into the flamegraph. For example:

... :predefined-transforms [{:type :remove :what "frame_buffer_overflow"} {:type :replace :what #"(;manifold.deferred[^;]+)+" :replacement ";manifold.deferred/..."} ...

Run the profiler for the specified duration. Return the generated flamegraph
file. Options:

:pid - process to attach to (default: current process)
:event - event to profile, see `list-event-types` (default: :cpu)
:interval - sampling interval in nanoseconds (default: 1000000 - 1ms)
:threads - profile each thread separately
:features - a list of extra features (or `:all` to enable all). Features:
  :vtable - show targets of vtable/itable calls
  :comptask - show JIT compilation task
:framebuf - size of the buffer for stack frames (default: 1000000 - 1MB)
:title - title of the generated flamegraph (optional)
:predefined-transforms - a list of maps that specify the dynamic transforms to
                         bake into the flamegraph. For example:

...
:predefined-transforms [{:type :remove
                         :what "frame_buffer_overflow"}
                        {:type :replace
                         :what #"(;manifold.deferred[^;]+)+"
                         :replacement ";manifold.deferred/..."}
...
sourceraw docstring

serve-uiclj

(serve-ui port)
(serve-ui host port)

Start profiler web UI on the given host (default: localhost) and port.

Start profiler web UI on the given `host` (default: localhost) and `port`.
sourceraw docstring

set-default-profiling-optionsclj

(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.

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.
sourceraw docstring

startclj

(start)
(start options)

Start the profiler. Options:

:pid - process to attach to (default: current process) :event - event to profile, see list-event-types (default: :cpu) :interval - sampling interval in nanoseconds (default: 1000000 - 1ms) :threads - profile each thread separately :features - a list of extra features (or :all to enable all). Features: :vtable - show targets of vtable/itable calls :comptask - show JIT compilation task :framebuf - size of the buffer for stack frames (default: 1000000 - 1MB)

Start the profiler. Options:

:pid - process to attach to (default: current process)
:event - event to profile, see `list-event-types` (default: :cpu)
:interval - sampling interval in nanoseconds (default: 1000000 - 1ms)
:threads - profile each thread separately
:features - a list of extra features (or `:all` to enable all). Features:
  :vtable - show targets of vtable/itable calls
  :comptask - show JIT compilation task
:framebuf - size of the buffer for stack frames (default: 1000000 - 1MB)
sourceraw docstring

statusclj

(status)
(status options)

Get profiling agent status. Options:

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

Get profiling agent status. Options:

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

stopclj

(stop)
(stop options)

Stop the currently running profiler and save the results into a text file. If flamegraph is generated next, the flamegraph file will be returned, otherwise the text file is returned. 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) :title - title of the generated flamegraph (optional) :predefined-transforms - a list of maps that specify the dynamic transforms to bake into the flamegraph. For example:

... :predefined-transforms [{:type :remove :what "frame_buffer_overflow"} {:type :replace :what #"(;manifold.deferred[^;]+)+" :replacement ";manifold.deferred/..."} ...

Stop the currently running profiler and save the results into a text file.
If flamegraph is generated next, the flamegraph file will be returned,
otherwise the text file is returned. 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)
:title - title of the generated flamegraph (optional)
:predefined-transforms - a list of maps that specify the dynamic transforms to
                         bake into the flamegraph. For example:

...
:predefined-transforms [{:type :remove
                         :what "frame_buffer_overflow"}
                        {:type :replace
                         :what #"(;manifold.deferred[^;]+)+"
                         :replacement ";manifold.deferred/..."}
...
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close