fettle v0.1.0 API Reference

Modules

Dynamic API for configuring health checks, and interacting with health state

A dummy check that is always healthy

The Fettle supervisor starts two servers; Fettle.ScoreBoard a GenServer which responds to queries about the current health status, and Fettle.RunnerSupervisor a supervisor which starts worker Fettle.Runner servers running the health-checks themselves, and takes care of restarting them if they exit abnormally

The behaviour to be implemented by healthcheck modules

Result struct which is returned from Fettle.Checker functions

Processes configuration for healthchecks into internal structures

A dummy check that is never healthy

Runs a health check periodically

Starts and supervises Fettle.Runner processes

Behaviour for report generators

A single FT Healthcheck V1 check result

The top-level FT Healthcheck V1 report

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

Describes health check meta-data; created from configuration and used to generate reports

Helper functions for creating and converting timestamps

Miscellaneous support functions