fettle v0.1.0 Fettle.ScoreBoard View Source

Keeps track of the results of health checks, as reported to it, and makes them available in the configured schema format.

The scoreboard requires that healthchecks are first registered with the process before it receives results; this is normally taken care of by the start-up configuration process and the run-time API.

Link to this section Summary

Functions

Return the number of checks currently configured

Configure a new health check on the score board

Check if all tests are in a healthy (:ok) state

Produces a health report in a desired schema format

Report a new health check result

Start the scoreboard with a list of the checks it will keep results for

Link to this section Types

Link to this section Functions

Return the number of checks currently configured.

Link to this function new(spec) View Source
new(spec :: Fettle.Spec.t) :: {:ok, id :: String.t}

Configure a new health check on the score board.

Check if all tests are in a healthy (:ok) state.

Link to this function report(schema \\ nil) View Source
report(schema :: atom) :: Fettle.Schema.report

Produces a health report in a desired schema format.

Report a new health check result.

Link to this function start_link(config, checks) View Source
start_link(config :: Fettle.Config.t, checks :: [Fettle.Config.spec_and_mod]) :: GenServer.on_start

Start the scoreboard with a list of the checks it will keep results for.