flow-storm.api — com.github.jpmonettas/flow-storm-inst 3.0.184

clj

This is the only namespace intended for users. Provides functionality to connect to the debugger and instrument forms.

cli-run clj

(cli-run {:keys [instrument-ns excluding-ns require-before fn-symb fn-args
                 profile verbose? styles theme]
          :as opts})

Require fn-symb ns, instrument ns-set (excluding excluding-ns) and then call (apply fn-symb fn-args).

profile (optional) should be :full (for full instrumentation) or :light for disable #{:expr :binding :anonymous-fn}

require-before (optional) should be a set of namespaces you want to require before the instrumentation.

verbose? (optional) when true show more logging.

styles (optional) a file path containing styles (css) that will override default styles

cli-run is designed to be used with clj -X like :

clj -X:dbg:inst:dev:build flow-storm.api/cli-run :instrument-set '#{"hf.depstar"}' :fn-symb 'hf.depstar/jar' :fn-args '[{:jar "flow-storm-dbg.jar" :aliases [:dbg] :paths-only false :sync-pom true :version "1.1.1" :group-id "com.github.jpmonettas" :artifact-id "flow-storm-dbg"}]'

if you want to package flow-storm-dbg with depstar traced.

debugger-main-ns clj

instrument-forms-for-namespaces clj

(instrument-forms-for-namespaces prefixes)

(instrument-forms-for-namespaces prefixes opts)

Instrument all forms, in all namespaces that matches prefixes.

(instrument-forms-for-namespaces prefixes opts)

prefixes is a set of ns prefixes like #{"cljs.compiler" "cljs.analyzer"}

opts is a map containing : - :excluding-ns a set of strings with namespaces that should be excluded - :disable a set containing any of #{:expr :binding :anonymous-fn} useful for disabling unnecesary traces in code that generate too many traces - :verbose? when true show more logging

instrument-var clj

(instrument-var var-symb)

(instrument-var var-symb config)

Instruments any var.

(instrument-var var-symb opts)

Lets say you are interested in debugging clojure.core/interpose you can do :

(instrument-var clojure.core/interpose {})

#rtrace (interpose :a [1 2 3])

Be careful instrumenting clojure.core functions or any functions that are being used by repl system code since can be called constantly and generate a lot of noise.

Use uninstrument-var to remove instrumentation.

opts is a map that support :flow-id and :disable See instrument-forms-for-namespaces for :disable

local-connect clj

(local-connect)

(local-connect config)

Start a debugger under this same JVM process and connect to it.

This is the recommended way of using the debugger for debugging code that generates a lot of data since data doesn't need to serialize/deserialize it like in a remote debugging session case.

config should be a map containing :

 - `:verbose?` to log more stuff for debugging the debugger
 - `:theme` can be one of `:light`, `:dark` or `:auto`
 - `:styles` a string path to a css file if you want to override some started debugger styles

Use flow-storm.api/stop to shutdown the system nicely.

read-ctrace-tag clj

(read-ctrace-tag form)

read-rtrace-tag clj

(read-rtrace-tag form)

read-rtrace0-tag clj

(read-rtrace0-tag form)

read-rtrace1-tag clj

(read-rtrace1-tag form)

read-rtrace2-tag clj

(read-rtrace2-tag form)

read-rtrace3-tag clj

(read-rtrace3-tag form)

read-rtrace4-tag clj

(read-rtrace4-tag form)

read-rtrace5-tag clj

(read-rtrace5-tag form)

read-tap-tag clj

(read-tap-tag form)

read-trace-tag clj

(read-trace-tag form)

remote-connect clj/s

(remote-connect config)

runi clj/s macro

(runi opts form)

Run instrumented.

(runi opts form)

Instrument form and run it for tracing.

Same as doing #rtrace form.

opts is a map that support the same keys as instrument-var.

stop clj/s

(stop)

uninstrument-forms-for-namespaces clj

(uninstrument-forms-for-namespaces prefixes)

Undo instrumentation made by flow-storm.api/instrument-forms-for-namespaces

uninstrument-var clj

(uninstrument-var var-symb)

Remove instrumentation given a var symbol.

(uninstrument-var var-symb)