barometer.protocols — com.workiva/barometer 0.1.1

Generic clojure protocols which correspond to the interfaces provided by Coda Hale (https://metrics.dropwizard.io/3.2.0/apidocs/com/codahale/metrics/package-summary.html)

Counter clj protocol

decrement clj

(decrement counter)

(decrement counter n)

Decrement a counter by 1 or by the amount specified.

increment clj

(increment counter)

(increment counter n)

Increment a counter by 1 or by the amount specified.

Counting clj protocol

count clj

(count metric)

Returns the count recorded by this metric.

ICanExplain clj protocol

explain clj

(explain this)

Prints a string containing the documentation for this thing.

explanation clj

(explanation this)

Returns a string containing the documentation for this thing.

Metered clj protocol

fifteen-minute-rate clj

(fifteen-minute-rate metric)

Gives the frequency with which this metric was triggered in the last fifteen minutes.

five-minute-rate clj

(five-minute-rate metric)

Gives the frequency with which this metric was triggered in the last five minutes.

mean-rate clj

(mean-rate metric)

Gives the mean frequency with which this metric has been triggered.

one-minute-rate clj

(one-minute-rate metric)

Gives the frequency with which this metric was triggered in the last five minutes.

MetricSet clj protocol

metrics clj

(metrics ms)

Returns a map name->metric for all metrics contained by this metric set.

Registrar clj protocol

histograms clj

(histograms reg)

(histograms reg filter)

Returns a map name->metric for all histograms registered in this registry.

names clj

(names reg)

Returns a set containing all the names registered in this registry.

remove-matching clj

(remove-matching reg filter)

Removes from this registry any metric that matches the given filter.

register-all clj

(register-all reg name->metric)

(register-all reg prefix name->metric)

Registers to the given names the corresponding metrics. If a metric is already registered under this name, it is replaced and a warning is logged.

remove-metric clj

(remove-metric reg name)

Removes from this registry any metric registered under the given name.

get-metric clj

(get-metric reg name)

Retrieves the metric registered under this name. Returns nil if none is found.

gauges clj

(gauges reg)

(gauges reg filter)

Returns a map name->metric for all gauges registered in this registry.

counters clj

(counters reg)

(counters reg filter)

Returns a map name->metric for all counters registered in this registry.

meters clj

(meters reg)

(meters reg filter)

Returns a map name->metric for all meters registered in this registry.

timers clj

(timers reg)

(timers reg filter)

Returns a map name->metric for all timers registered in this registry.

register clj

(register reg name metric)

Registers the given metric to the given name in this registry. If a metric is already registered under this name, it is replaced and a warning is logged.

Snappable clj protocol

snapshot clj

(snapshot metric)

Gives an instantaneous snapshot of the statistical properties of the metric.

Statistical clj protocol

max clj

(max o)

Gives the maximum value captured by this metric/snapshot.

mean clj

(mean o)

Gives the mean value recorded by this metric/snapshot.

median clj

(median o)

Gives the median value recorded by this metric/snapshot.

min clj

(min o)

Gives the minimum value captured by this metric/snapshot.

quantile clj

(quantile o q)

Gives the value recorded by this metric/snapshot in the specified quantile.

size clj

(size o)

Gives the number of values recorded by this metric/snapshot.

std-dev clj

(std-dev o)

Gives the standard deviation of the value recorded by this metric/snapshot.

values clj

(values o)

Gives an array of all values captured by this metric/snapshot.

Timer clj protocol

time clj

(time metric fn)

Runs the fn, returns its return value.

Updateable clj protocol

update clj

(update metric)

(update metric value)

Updates with number of occurrences, or latest value, or whatever it makes sense to tick/mark/update this metric with.

Valuable clj protocol

value clj

(value metric)

For metrics that record a single value, this returns it.