File: healthchecks.rst

package info (click to toggle)
metrics-clojure 2.9.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 404 kB
  • sloc: makefile: 135; xml: 99; python: 22
file content (33 lines) | stat: -rw-r--r-- 1,047 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
HealthChecks
============

``metrics-clojure-health`` will allow you to define and run healthcheck.

Install
-------

``metrics-clojure-health`` is provided as a separate package from ``metrics.core``.
To install add the following to your ``project.clj``:

.. parsed-literal::

    [metrics-clojure-health "|release|"]


Example
-------

An example using the default HealthCheckRegistry, (which is different
from the default-registry).::

    (require '[metrics.health.core :as health])
    (defhealthcheck "second-check" (fn [] (let [now (.getSeconds (java.util.Date.))]
                                             (if (< now 30)
                                                (health/healthy "%d is less than 30!" now)
                                                (health/unhealthy "%d is more than 30!" now)))))

    (health/check second-check)
    #_ => #<Result Result{isHealthy=true, message=3 is less than 30!}>

    (health/check-all)
    #_ => {:healthy [#<UnmodifiableEntry foo=Result{isHealthy=true, message=6 is less than 30!}>]}