Liking cljdoc? Tell your friends :D

d-core.core.health.protocol


degraded?clj

(degraded? status)

Returns true if the status is :degraded.

Returns true if the status is :degraded.
raw docstring

down?clj

(down? status)

Returns true if the status is :down.

Returns true if the status is :down.
raw docstring

HealthCheckProtocolcljprotocol

Protocol for components that can report their health status to the health system.

Expected return map: {:status - keyword in #{:up :degraded :down :unknown} :details - optional map with component-specific diagnostic info :error - optional Exception if the check encountered an error}

Protocol for components that can report their health status to the health system.

Expected return map:
  {:status  - keyword in #{:up :degraded :down :unknown}
   :details - optional map with component-specific diagnostic info
   :error   - optional Exception if the check encountered an error}

check-healthclj

(check-health this)
(check-health this opts)

Executes a health check on the component. Returns a map with at least {:status :up | :degraded | :down | :unknown}.

Executes a health check on the component.
Returns a map with at least `{:status :up | :degraded | :down | :unknown}`.
raw docstring

healthy?clj

(healthy? status)

Returns true if the status is considered healthy (:up or :degraded).

Returns true if the status is considered healthy (:up or :degraded).
raw docstring

status-severitiesclj

Numeric severity weight for statuses where higher is worse.

Numeric severity weight for statuses where higher is worse.
raw docstring

up?clj

(up? status)

Returns true if the status is :up.

Returns true if the status is :up.
raw docstring

valid-statusesclj

Set of recognized health status keywords.

Set of recognized health status keywords.
raw docstring

worst-statusclj

(worst-status statuses)

Given a collection of status keywords, returns the most severe status according to status-severities. Returns :up if the collection is empty.

Given a collection of status keywords, returns the most severe status according to `status-severities`.
Returns :up if the collection is empty.
raw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close