# `PhoenixMicro.Phoenix.HealthPlug`
[🔗](https://github.com/iamkanishka/phoenix_micro/blob/v1.0.0/lib/phoenix_micro/phoenix/health_plug.ex#L1)

A Plug that exposes a JSON health endpoint for `phoenix_micro`.

Mount in your Phoenix router:

    forward "/health/microservices", PhoenixMicro.Phoenix.HealthPlug

Requires `{:plug, "~> 1.15"}` in your application's deps.

Returns 200 OK when healthy, 503 when degraded.

# `build_health`

```elixir
@spec build_health(boolean(), boolean()) :: map()
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*