metrics.health.core — metrics-clojure-health 2.10.0

check clj

(check h)

Run a given HealthCheck.

check-all clj

(check-all)

(check-all reg)

Returns a map with the keys :healthy & :unhealthy, each containing the associated checks. Note that the items of each vector are of type java.util.Collections$UnmodifiableMap$UnmodifiableEntrySet$UnmodifiableEntry, but key & val work on it.

default-healthcheck-registry clj

Default health check registry used by public API functions when no explicit registry argument is given

defhealthcheck clj macro

(defhealthcheck title f)

(defhealthcheck reg title f)

Define a new Healthcheck metric with the given title and a function. to call to retrieve the value of the Healthcheck.

The title uses some basic desugaring to let you concisely define metrics:

; Define a healthcheck titled "default.default.foo" into var foo (defhealthcheck foo ,,,) (defhealthcheck "foo" ,,,)

; Define a healthcheck titled "a.b.c" into var c (defhealthcheck [a b c] ,,,) (defhealthcheck ["a" "b" "c"] ,,,) (defhealthcheck [a "b" c] ,,,)

healthcheck-fn clj

(healthcheck-fn title hc-fn)

(healthcheck-fn reg title hc-fn)

Create and register a new healthcheck. hc-fn must return healthy/unhealthy; any other result, (including an exception), will be considered unhealthy.

healthy clj

(healthy)

(healthy message & args)

Returns a healthy result.

new-hc clj

(new-hc hc-fn)

Wrap a fn to ensure it returns healthy/unhealthy. Any exception or non-healthy result is considered unhealthy and returned as such.

unhealthy clj

(unhealthy message & args)

Returns a unhealthy result.