Proto file info/health.proto
Service: Health
Describe the health of a device.
| Method | Request Type | Response Type | Description |
|---|---|---|---|
| GetHealthState | GetHealthStateRequest | HealthState | |
| PullHealthStates | PullHealthStatesRequest | PullHealthStatesResponse stream |
HealthState
| Field Name | Type | Description |
|---|---|---|
| connection | ConnectionHealth | Health of the connection to the physical device |
| comm | CommHealth | Health of communication with the device |
ConnectionHealth
Describes the health of a connection
| Field Name | Type | Description |
|---|---|---|
| status | smartcore.types.Connectivity | are we currently connected |
| connect_time | google.protobuf.Timestamp | When was the last time a successful connection was established |
| disconnect_time | google.protobuf.Timestamp | When was the last time a connection was closed/ended |
CommHealth
Describes the health of communication.
| Field Name | Type | Description |
|---|---|---|
| status | smartcore.types.CommStatus | |
| failure_time | google.protobuf.Timestamp | The most recent time the status changed to COMM_FAILURE |
| success_time | google.protobuf.Timestamp | The most recent time the status changed to COMM_SUCCESS |
GetHealthStateRequest
| Field Name | Type | Description |
|---|---|---|
| name | string | Name of the device to query the health state for |
PullHealthStatesRequest
| Field Name | Type | Description |
|---|---|---|
| name | string | Name of the device to subscribe to the health state for |
PullHealthStatesResponse
| Field Name | Type | Description |
|---|---|---|
| changes | repeated HealthStateChange |
HealthStateChange
| Field Name | Type | Description |
|---|---|---|
| name | string | The name of the device that is the source of the change |
| change_time | google.protobuf.Timestamp | When the change was applied |
| health | HealthState | The new state for the change |