Liking cljdoc? Tell your friends :D

sayid.trace


*evict-old-calls*clj

How the workspace behaves at *record-limit* top-level calls. When false (the default) it stops recording and keeps the first *record-limit* calls. When true it keeps the most recent *record-limit* calls instead, evicting the oldest - handy when the interesting thing is what happened just before a failure at the end of a long run.

How the workspace behaves at `*record-limit*` top-level calls.  When false (the
default) it stops recording and keeps the *first* `*record-limit*` calls.  When
true it keeps the *most recent* `*record-limit*` calls instead, evicting the
oldest - handy when the interesting thing is what happened just before a
failure at the end of a long run.
sourceraw docstring

*max-trace-depth*clj

The deepest call nesting a workspace will record; nil means unbounded. Calls below this depth (and everything under them) run untraced, so a deeply recursive function or an inner trace can't explode a single call into an unbounded subtree. Root calls are depth 1.

The deepest call nesting a workspace will record; nil means unbounded.  Calls
below this depth (and everything under them) run untraced, so a deeply
recursive function or an inner trace can't explode a single call into an
unbounded subtree.  Root calls are depth 1.
sourceraw docstring

*per-fn-limit*clj

The maximum number of calls of any single traced function a workspace will record; nil means unbounded. Counts across the whole call tree, so once a hot function hits its limit, further calls of it (and everything under them) run untraced and it can't crowd out the rest of the recording.

The maximum number of calls of any single traced function a workspace will
record; nil means unbounded.  Counts across the whole call tree, so once a hot
function hits its limit, further calls of it (and everything under them) run
untraced and it can't crowd out the rest of the recording.
sourceraw docstring

*record-limit*clj

The maximum number of top-level (root) calls a single workspace will record. Once the limit is reached, further top-level calls run untraced - the program behaves normally, the calls are just not captured - so tracing a namespace under a full test suite can't grow the recording without bound. Rebind it or alter-var-root it to record more (or fewer).

The maximum number of top-level (root) calls a single workspace will record.
Once the limit is reached, further top-level calls run untraced - the program
behaves normally, the calls are just not captured - so tracing a namespace
under a full test suite can't grow the recording without bound.  Rebind it or
`alter-var-root` it to record more (or fewer).
sourceraw docstring

*sample-rate*clj

Record one in every N top-level calls; 1 (the default) records them all. Set higher to trace a hot entry point - say a request handler under load - and keep only a representative sample instead of drowning the recording.

Record one in every N top-level calls; 1 (the default) records them all.  Set
higher to trace a hot entry point - say a request handler under load - and keep
only a representative sample instead of drowning the recording.
sourceraw docstring

*suppress-recording*clj

When true, calls run untraced and nothing - outer or inner - is recorded. Bound around a call Sayid chose to skip (over a limit, sampled out, too deep), so the whole subtree under it is skipped instead of leaking in as spurious roots. This is what lets root-level bounds compose correctly.

When true, calls run untraced and nothing - outer or inner - is recorded.
Bound around a call Sayid chose to skip (over a limit, sampled out, too deep),
so the whole subtree under it is skipped instead of leaking in as spurious
roots.  This is what lets root-level bounds compose correctly.
sourceraw docstring

*trace-log-parent*clj

source

apply->vecclj

(apply->vec f)
source

apply-trace-to-varclj

(apply-trace-to-var v tracer-fn workspace)
source

audit-fnclj

(audit-fn fn-var trace-selection)
source

audit-fn-symclj

(audit-fn-sym fn-sym trace-selection)
source

audit-nsclj

(audit-ns ns-sym)
source

audit-tracesclj

(audit-traces traced)
source

check-fn-trace-typeclj

(check-fn-trace-type fn-sym)
source

end-traceclj

(end-trace trace-log idx tree)
source

mk-fn-treeclj

(mk-fn-tree & {:keys [parent name args meta]})
source

mk-treeclj

(mk-tree & {:keys [id-prefix parent]})
source

nowclj

(now)
source

record-fn-callclj

(record-fn-call parent name f args meta')
source

record-root-call-evictingclj

(record-root-call-evicting workspace name f args meta')

Record a top-level call while keeping only the most recent *record-limit* roots: append this call and drop the oldest beyond the limit. Ends by id, so the index-shifting from eviction can't corrupt an in-flight call.

Record a top-level call while keeping only the most recent `*record-limit*`
roots: append this call and drop the oldest beyond the limit.  Ends by id, so
the index-shifting from eviction can't corrupt an in-flight call.
sourceraw docstring

reset-bounds!clj

(reset-bounds!)

Reset the per-workspace bound bookkeeping - the record-limit warning flag, the sampling counter, and the per-fn call counts. Called when the log is cleared or the workspace reset.

Reset the per-workspace bound bookkeeping - the record-limit warning flag, the
sampling counter, and the per-fn call counts.  Called when the log is cleared or
the workspace reset.
sourceraw docstring

run-suppressedclj

(run-suppressed f args)

Run (apply F ARGS) with recording suppressed for it and everything under it.

Run `(apply F ARGS)` with recording suppressed for it and everything under it.
sourceraw docstring

shallow-tracerclj

(shallow-tracer {:keys [workspace qual-sym meta'] :as m} original-fn)
source

shallow-tracer-multifnclj

(shallow-tracer-multifn {:keys [workspace qual-sym meta']} original-fn)
source

StackTraceElement->mapclj

(StackTraceElement->map o)
source

start-traceclj

(start-trace trace-log tree)
source

the-ns-safeclj

(the-ns-safe ns)
source

Throwable->map**clj

(Throwable->map** o)

Constructs a data representation for a Throwable.

Constructs a data representation for a Throwable.
sourceraw docstring

trace*cljmultimethod

source

trace-fn-callclj

(trace-fn-call workspace name f args meta')
source

trace-ns*clj

(trace-ns* ns workspace)
source

trace-var*clj

(trace-var* v tracer-fn workspace & {:keys [no-overwrite]})
source

untrace*cljmultimethod

source

untrace-ns*clj

(untrace-ns* ns*)
source

untrace-var*clj

(untrace-var* v)
(untrace-var* ns s)
source

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close