# ExHealth 
> A health check utility for any OTP application
[](https://circleci.com/gh/Kartstig/ex_health/tree/master) [](https://codecov.io/gh/Kartstig/ex_health)
ExHealth runs a supervised GenServer that performs routine health checks which
are configurable to your application. Check out [ExHealth.Plug](lib/ex_health/plug.ex)
for integrating the result into a web endpoint which yields a JSON response like:
```javascript
{
last_check:"2018-09-18T06:43:53.773719Z",
result:{
check_results:[
[
"Database",
"ok"
],
[
"PhoenixExampleWeb_Endpoint",
"ok"
]
],
msg:"healthy"
}
}
```
## Installation
Add `ex_health` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:ex_health, "~> 0.1.1"}
]
end
```
Ensure ex_health is started alongside your application by adding this to your `mix.exs`
```elixir
def application do
[applications: [:ex_health]]
end
```
## Getting Started
Configuration for ExHealth must be present the Application environment. This
can be done by updating the `:ex_health` values in your `config/config.exs`:
```elixir
config :ex_health,
module: MyApplication.HealthChecks,
interval_ms: 1000 # Interval between checks in milliseconds
```
Then you must define a module `MyApplication.HealthChecks` with some checks:
```elixir
defmodule MyApplication.HealthChecks do
process_check(MyApplication.CacheServer)
test "Redis" do
MyRedis.ping() # This should return :ok | {:error, "Message"}
end
end
```
## Online Documentation
Please see the documentation for ExHealth at [https://hexdocs.pm/ex_health](https://hexdocs.pm/ex_health)
## Offline Documentation
You can generate documentation by running the following:
```bash
$ mix docs
```
You can find examples in [examples/](examples/)
## Contributing
Pull requests are welcome. The best way to get started is to check out [CONTRIBUTING](CONTRIBUTING.md).
Once you have the repo cloned, just run
```bash
$ mix deps.get
```
and then you can start ExHealth with CLI:
```bash
$ iex -S mix
```
## License
See [LICENSE](LICENSE) for more information.
_by Herman Singh_
