# `NervesHubLink.Extensions.Health`
[🔗](https://github.com/nerves-hub/nerves_hub_link/blob/v2.12.0/lib/nerves_hub_link/extensions/health/health.ex#L8)

The Health Extension.

Provides metrics, metadata and alarms to allow building an understanding of
the operational state of a device. The device's "health". This information
is reported over the extensions mechanism to NervesHub for display, alerting
and more.

# `check_health`

```elixir
@spec check_health(module()) :: NervesHubLink.Extensions.Health.DeviceStatus.t() | nil
```

# `report_sent?`

```elixir
@spec report_sent?() :: boolean()
```

Confirms if a health report has been sent.

## Examples

    iex> NervesHubLink.Extensions.Health.report_sent?()
    false

    iex> NervesHubLink.Extensions.Health.send_report()
    :ok

    iex> NervesHubLink.Extensions.Health.report_sent?()
    true

# `send_report`

```elixir
@spec send_report() :: :ok
```

Request a health report be sent asynchronously.

## Examples

    iex> NervesHubLink.Extensions.Health.send_report()
    :ok

---

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