Liking cljdoc? Tell your friends :D

active.clojure.logger.timed-metric

Common functionality to ease logging of timed metrics.

Common functionality to ease logging of timed metrics.
raw docstring

cancel-metric-timercljmacro

(cancel-metric-timer ?timer-name-or-metric)
(cancel-metric-timer ?metric ?more)

Cancels a metric timer. It can either be identified by a timer name returned by start-metric-timer or by current namespace, metric, and (optional) addtional context map.

Cancels a metric timer.  It can either be identified by a timer name
returned by [[start-metric-timer]] or by current namespace, metric, and 
(optional) addtional context map.
sourceraw docstring

cancel-metric-timer-1clj

(cancel-metric-timer-1 timer-name)

Cancels a metric timer, identified by timer-name.

Cancels a metric timer, identified by `timer-name`.
sourceraw docstring

logging-timingcljmacro

(logging-timing ?label ?m)

A monadic command that executes m and returns its result, and also makes a debug log messages about the time it took to execute it, where the message begins with the given text.

A monadic command that executes `m` and returns its result, and
also makes a debug log messages about the time it took to execute
it, where the message begins with the given `text`.
sourceraw docstring

logging-timing*clj

(logging-timing* origin label m)
source

make-timer-nameclj

(make-timer-name namespace metric map)

Construct a TimerName record.

namespace (String): access via active.clojure.logger.timed-metric/timer-name-namespace metric (Name of the metric that will be logged.): access via active.clojure.logger.timed-metric/timer-name-metric map (Map with log context info, keywords to strings.): access via active.clojure.logger.timed-metric/timer-name-map

Construct a `TimerName` record.

`namespace` (String): access via [[active.clojure.logger.timed-metric/timer-name-namespace]]
`metric` (Name of the metric that will be logged.): access via [[active.clojure.logger.timed-metric/timer-name-metric]]
`map` (Map with log context info, keywords to strings.): access via [[active.clojure.logger.timed-metric/timer-name-map]]
sourceraw docstring

start-metric-timercljmacro

(start-metric-timer ?metric & [?more])

Starts a metric timer, identified by metric and more.

more must be a map from keywords listed in [[log/log-context-keys]] to strings.

Returns a timer-name object that can be fed to cancel-metric-timer or stop-and-log-metric-timer.

Starts a metric timer, identified by `metric` and `more`.

`more` must be a map from keywords listed in [[log/log-context-keys]] to strings.

Returns a timer-name object that can be fed to
[[cancel-metric-timer]] or [[stop-and-log-metric-timer]].
sourceraw docstring

start-metric-timer-1clj

(start-metric-timer-1 ns metric more)

Starts a metric timer, identified by ns, metric and more.

Starts a metric timer, identified by `ns`, `metric` and `more`.
sourceraw docstring

stop-and-log-metric-timercljmacro

(stop-and-log-metric-timer ?timer-name-or-metric)
(stop-and-log-metric-timer ?metric ?more)

Stops a metric timer and logs the time. The timer can either be identified by a timer name returned by start-metric-timer or by current namespace, metric, and (optional) addtional context map.

Returns the elapsed time in milliseconds.

Stops a metric timer and logs the time.  The timer can either be identified by a timer name
returned by [[start-metric-timer]] or by current namespace, metric, and 
(optional) addtional context map.

Returns the elapsed time in milliseconds.
sourceraw docstring

stop-and-log-metric-timer-1clj

(stop-and-log-metric-timer-1 timer-name)

Stops a metric timer and logs the time as a metric.

Stops a metric timer and logs the time as a metric.
sourceraw docstring

stop-metric-timerclj

(stop-metric-timer timer-name)
source

timer-name-mapclj

(timer-name-map rec__3151__auto__)
(timer-name-map data__3152__auto__ v__3153__auto__)

Lens for the map field (Map with log context info, keywords to strings.) from a TimerName record. See active.clojure.logger.timed-metric/make-timer-name.

Lens for the `map` field (Map with log context info, keywords to strings.) from a [[TimerName]] record. See [[active.clojure.logger.timed-metric/make-timer-name]].
sourceraw docstring

timer-name-metricclj

(timer-name-metric rec__3151__auto__)
(timer-name-metric data__3152__auto__ v__3153__auto__)

Lens for the metric field (Name of the metric that will be logged.) from a TimerName record. See active.clojure.logger.timed-metric/make-timer-name.

Lens for the `metric` field (Name of the metric that will be logged.) from a [[TimerName]] record. See [[active.clojure.logger.timed-metric/make-timer-name]].
sourceraw docstring

timer-name-namespaceclj

(timer-name-namespace rec__3151__auto__)
(timer-name-namespace data__3152__auto__ v__3153__auto__)

Lens for the namespace field (String) from a TimerName record. See active.clojure.logger.timed-metric/make-timer-name.

Lens for the `namespace` field (String) from a [[TimerName]] record. See [[active.clojure.logger.timed-metric/make-timer-name]].
sourceraw docstring

timer-name?clj

(timer-name? thing)

Is object a TimerName record? See active.clojure.logger.timed-metric/make-timer-name.

Is object a `TimerName` record? See [[active.clojure.logger.timed-metric/make-timer-name]].
sourceraw docstring

TimerNameclj

source

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

× close