ExHealth.health_check

You're seeing just the macro health_check, go back to ExHealth module for more information.
Link to this macro

health_check(name, list)

View Source (macro)

Defines a healthcheck function.

Takes the following arguments:

  • :name - a string for the name of the health check
  • :block - block that returns :ok | true | {:error, "Reason"}

Examples

defmodule MyApp.HealthChecks do
  health_check("Database") do
    MyDB.ping() # This should return  :ok | true | {:error, "Reason"}
  end
end