Health checks

Health checks let a device continuously verify that it — or something running on it — is healthy, and report the result to the platform. You define health checks from the dashboard (or the API).

Types of checks

You can define host-level checks of several types:

Type Verifies
HTTP An HTTP endpoint responds as expected.
TCP A TCP port accepts a connection.
gRPC A gRPC service reports healthy.
ICMP A host responds to ping.
Command A command on the device exits successfully.
Device file An expected device file or path is present.

How results are used

Each check’s result contributes to the device’s reported conditions, which you can see on the device overview page. Use health checks to detect problems such as a dependent service being unreachable, a required peripheral missing, or a local endpoint failing — and to surface them centrally instead of discovering them per device.

Recommendations

  • Check the things that matter for the device’s role (for example, the local application endpoint, or a sensor’s device file).
  • Keep checks lightweight and give them sensible intervals so they reflect real health without adding load.