clojure-miniprofiler.core — org.clojars.asolovyov/clojure-miniprofiler 0.5.0-7

*current-miniprofiler* clj

add-child clj

(add-child section-name)

add-client-results clj

(add-client-results req stored-results)

adds incoming client results to a stored set of results

add-custom-timing clj

(add-custom-timing current-miniprofiler
                   call-type
                   custom-timing
                   duration
                   stacktrace-info)

assets-request? clj

(assets-request? req)

denotes if a request is for assets

build-miniprofiler-response-html clj

(build-miniprofiler-response-html response duration-ms profiler-id options)

inserts the miniprofiler javascript tag into an html response.

build-miniprofiler-response-json clj

(build-miniprofiler-response-json response duration-ms profiler-id options)

inserts the miniprofiler details into a json response.

build-miniprofiler-script-tag clj

(build-miniprofiler-script-tag duration-ms profiler-id options)

create-custom-timing clj

(create-custom-timing execute-type command-string stacktrace-info)

create-miniprofiler clj

(create-miniprofiler req initial-opts)

current-ms clj

(current-ms)

custom-timing clj macro

(custom-timing call-type execute-type command-string & body)

wraps some of your code with a timing, so that it will show up in the miniprofiler results. takes 3 other arguments: call-type: the type of timed call this is. Examples might be "sql" or "redis"

execute-type: within the call-type, what kind of request this is. Examples might be "get" or "query" or "execute"

command-string: a pretty printed string of what this is executing. For SQL, this would be the query, for datomic the query or transaction data, for redis the key you're getting etc.

default-options clj

(default-options opts)

distance-of-ns-time clj

(distance-of-ns-time ns0 ns1)

get-id-from-req clj

(get-id-from-req req)

get-stacktrace-info clj

(get-stacktrace-info duration)

html-pprint clj

(html-pprint x)

pretty prints a string and returns it. Much faster than clojure.pprint, uses fipp

in-memory-store clj

(in-memory-store)

creates an in-memory miniprofiler results store

miniprofiler-resource-path clj

(miniprofiler-resource-path req options)

miniprofiler-results-request? clj

(miniprofiler-results-request? req options)

miniprofiler-results-response clj

(miniprofiler-results-response req options)

builds a ring response that returns miniprofiler results as json in the :body.

miniprofiler-script-tag clj

ms-since-start clj

(ms-since-start)

parse-json clj

(parse-json value)

profile-request? clj

(profile-request? req options)

dictates whether this request should be profiled (after it's been authenticated). By default removes profiling of assets.

reconstruct-profile clj

(reconstruct-profile profiler duration)

render-share clj

(render-share id options)

returns a ring response for sharing the miniprofiler result

respond-with-asset clj

(respond-with-asset req miniprofiler-resource-path)

returns a miniprofiler asset as a ring response

run-handler-profiled clj

(run-handler-profiled req handler options)

runs a handler in profiled mode, potentially adding the profiler into the content, stores traces etc.

trace clj macro

(trace section-name & body)

trace lets you wrap sections of your code, so they show up in the miniprofiler UI. traces are nested (based on the call structure they wrap). A trace should be a section of your code, e.g. rendering a specific view, loading the required data out of the database, etc.

This macro just takes a name for the section you're wrapping in it.

uuid clj

(uuid)

generates an uuid

with-recording clj macro

(with-recording options req & body)

wrap-miniprofiler clj

(wrap-miniprofiler handler opts)

Ring middleware for using miniprofiler. Takes an options map with the following options:

:store (optional, something that implements clojure-miniprofiler.store/Storage) Implementation of a store for miniprofiler results. By default uses an in-memory store, which means that profiling won't work properly in a multi-machine environment. See the documentation on the Storage protocol for more.

:authorized? (a function, optional): the most important option - this specifies which requests will be profiled. By default only requests from localhost will be, but in production you probably want to turn this on for admins/etc.

:base-path (a string, optional): a string that denotes the paths miniprofiler will interact on. By default set to /miniprofiler.

:trivial-ms (an integer, measured in milliseconds): traces that take below this amount of time are hidden by default in the web ui.

:profile-request? (a function) a function that dictates whether we should profile the current request. By default asset requests aren't profiled, just html/json ones.