diff options
| author | Albin Suresh <albin.suresh@softwareag.com> | 2022-04-04 22:13:16 +0530 |
|---|---|---|
| committer | Albin Suresh <albin.suresh@softwareag.com> | 2022-04-07 14:06:33 +0530 |
| commit | 7ae0eeffc51acc9500441ef5b46cf6eee1b822b3 (patch) | |
| tree | a506924c5a6ee93c48b667a2303c00f45c0e7593 /docs | |
| parent | ba619f6bacca6d9f41aa21a0aa88f290d18798db (diff) | |
Closes #862 Report mosquitto cloud bridge health status via MQTT
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/src/SUMMARY.md | 1 | ||||
| -rw-r--r-- | docs/src/howto-guides/020_monitor_tedge_health.md (renamed from docs/src/howto-guides/020_monitor_tedge_health) | 15 | ||||
| -rw-r--r-- | docs/src/howto-guides/README.md | 3 |
3 files changed, 18 insertions, 1 deletions
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 1bb4003f..98ebc877 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -34,6 +34,7 @@ - [How to use apama software management plugin](./howto-guides/017_apama_software_management_plugin.md) - [How to change temp path](./howto-guides/018_change_temp_path.md) - [How to use thin-edge.io with your preferred init system](./howto-guides/019_how_to_use_preferred_init_system.md) + - [How to monitor health of tedge daemons](./howto-guides/020_monitor_tedge_health.md) - [How to enable systemd watchdog monitoring for tedge services?](./howto-guides/021_enable_tedge_watchdog_using_systemd.md) - [Developer Documentation](dev_doc.md) diff --git a/docs/src/howto-guides/020_monitor_tedge_health b/docs/src/howto-guides/020_monitor_tedge_health.md index 3cdea621..7a56b5c2 100644 --- a/docs/src/howto-guides/020_monitor_tedge_health +++ b/docs/src/howto-guides/020_monitor_tedge_health.md @@ -31,3 +31,18 @@ The following endpoints are currently supported by various tedge daemons: * `tedge/health/tedge-mapper-collectd` All future tedge daemons will also follow the same topic naming scheme convention. + +# Mosquitto bridge health endpoints + +The mosquitto bridge clients connecting thin-edge devices to the respective cloud platforms also report their health status as retained messages to `tedge/health/<mosquitto-cloud-bridge>` topics. +The health check messages published by these clients are just numeric values `1` or `0`, indicating active and dead bridge clients respectively. + +Here are the health endpoints of curently supported clouds, bridged with mosquitto: + +| Cloud | Health topic | +| ---------- | ----------------------------------- | +| Cumulocity | `tedge/health/mosquitto-c8y-bridge` | +| Azure | `tedge/health/mosquitto-az-bridge` | + +Explicit health check requests via `tedge/health-check` topics is not supported by these bridge clients. +Since the health status messages are sent as retained messages, just subscribing to these health topics is sufficient to get the latest status. diff --git a/docs/src/howto-guides/README.md b/docs/src/howto-guides/README.md index 859cf1b7..ffbb6d78 100644 --- a/docs/src/howto-guides/README.md +++ b/docs/src/howto-guides/README.md @@ -15,4 +15,5 @@ 13. [How to access the logs on the device?](./014_thin_edge_logs.md) 14. [How to install thin-edge.io on any Linux OS (no deb support)?](./015_installation_without_deb_support.md) 16. [How to manage apama software artefatcs with apama plugin?](./017_apama_software_management_plugin.md) -17. [How to enable watchdog using systemd?](./021_enable_tedge_watchdog_using_systemd.md) +17. [How to monitor health of tedge daemons](./020_monitor_tedge_health.md) +18. [How to enable watchdog using systemd?](./021_enable_tedge_watchdog_using_systemd.md) |