itk_health_checkex v0.0.3 Report View Source

Health checks results report.

Link to this section Summary

Link to this section Types

Link to this type

t()

View Source
t() :: %Report{
  checks: [atom()],
  failing: [atom()],
  http_code: 200 | 503,
  passing: [atom()],
  timeout: [atom()],
  warning: [atom()]
}

Link to this section Functions

Link to this function

build(checks \\ [])

View Source
build(checks :: [atom()]) :: t()
Link to this function

generate(report)

View Source
generate(report :: t()) :: {200, map()} | {503, map()}
Link to this function

report_failing(report, check, result)

View Source
report_failing(report :: t(), check :: atom(), result :: String.t()) ::
  t()
Link to this function

report_passing(report, check, result \\ "Healthy!")

View Source
report_passing(report :: t(), check :: atom(), result :: String.t()) ::
  t()
Link to this function

report_timeout(report)

View Source
report_timeout(report :: t()) :: t()
Link to this function

report_warning(report, check, result)

View Source
report_warning(report :: t(), check :: atom(), result :: String.t()) ::
  t()