This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
wiki:alerting [2024/07/30 14:45] pta |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Alerting on Wanesy Management Cockpit ====== | ||
- | ===== Documentation ===== | ||
- | |||
- | [[https://wmc.wanesy.com|Wanesy Management Cockpit]] (online) | ||
- | [[https://wmc.wanesy.com/docs|GMS API Web services documentation]] (online) | ||
- | |||
- | ===== Alerting management ===== | ||
- | The alerting mechanism is based on the notion of group. | ||
- | |||
- | When creating/updating a group, it is possible to declare it as an alerting one. | ||
- | |||
- | {{:images:group_create_alerting.jpg?400|}} | ||
- | |||
- | <note> | ||
- | A gateway can only belong to one alerting group at a time. | ||
- | </note> | ||
- | |||
- | Configuring the alerts is done at group level, it is accessible from the ''ALERTING'' menu. | ||
- | |||
- | The configuration applies to all the gateways in the alerting group. | ||
- | |||
- | {{:images:alerting_conf_menu.jpg?800|}} | ||
- | |||
- | For each alert type, it is possible to: | ||
- | * Activate/deactivate the alert | ||
- | * Use default configuration (recommended), or custom it | ||
- | |||
- | <note> | ||
- | The configuration of alerts applies to all the gateways in the alerting group. | ||
- | </note> | ||
- | |||
- | ===== Description of alert types ===== | ||
- | |||
- | ==== Disconnection ==== | ||
- | The alert for **Disconnection** is triggered when the gateway has stopped receiving telemetry messages for more than 3h. | ||
- | |||
- | The alert is automatically closed when the gateway has successfully reconnected and is receiving telemetry messages again. | ||
- | |||
- | {{:images:alerting_conf_disconnection.jpg?400|}} | ||
- | |||
- | ==== Backhaul consumption ==== | ||
- | The alert for **Backhaul consumption** is triggered when the backhaul consumption forecasted for the current month exceeds the predefined limit (configurable from 50 to 5000 Mbytes, 400 Mb by default). | ||
- | |||
- | The global consumption is estimated until the reset day (configurable from 1 to 28), independently for each type of backhaul used (Ethernet, WiFi or Cellular). | ||
- | |||
- | The alert is automatically closed when the backhaul consumption forecasted for the month comes back within the limit. | ||
- | |||
- | {{:images:alerting_conf_backhaul.jpg?400|}} | ||
- | |||
- | ==== LoRaWAN Uplink traffic ==== | ||
- | |||
- | |||
- | You have the option to select: | ||
- | * A pre-defined software update (previously declared by Kerlink) to apply a public software or configuration | ||
- | * A Custom Magic Link to apply a specific software or configuration | ||
- | |||
- | {{:images:group_update_list.jpg?400|}} | ||
- | |||
- | <note>For a Custom Magic Link, you will be asked to enter the ''Magic Link value'' (i.e. the hash) provided by Kerlink support team. \\ | ||
- | This option will work only for gateways declared in the Magic Link.</note> | ||
- | |||
- | After clicking on ''SEND'' button, you will be asked to confirm in a popup. | ||
- | |||
- | Once triggered, the udpate command will be sent to each gateway of the group when the next telemetry message is received (message expected every hour). | ||
- | |||
- | When an update command is in progress (waiting to be sent to all the gateways), an orange dot is displayed in the ''CONFIGURATION'' menu. | ||
- | |||
- | {{:images:group_update_pending.jpg?200|}} | ||
- | |||
- | You can consult the software update history of your group in the ''Last updates'' table. | ||
- | |||
- | {{:images:group_update_history.jpg?800|}} | ||
- | |||
- | Depending on its progress, the update command goes through different possible statuses: | ||
- | * **Created**: the update command has been created | ||
- | * **In progress**: the update command is ready to be sent to the gateways | ||
- | * **Sent**: the update command has been sent to all the gateways | ||
- | * **Partially sent**: the update command has been sent to some of the gateways | ||
- | * **Cancel request**: the cancellation of the update command has been requested | ||
- | * **Cancelled**: the update command has been cancelled | ||
- | |||
- | To cancel the update command, you need to click on the ''CANCEL UPDATE'' button present in the table. | ||
- | |||
- | Clicking on the eye link in the ''Last updates'' table opens a dashboard allowing you to follow the progress of the group update. | ||
- | |||
- | {{:images:group_update_dashboard.jpg?800|}} | ||
- | |||
- | Clicking on a status in the progress bar allows to only list the gateways with update specifically in this status. | ||
- | |||
- | You have the option to cancel the update individually at each gateway (by clicking on the ''CANCEL UPDATE'' button at the end of each line). | ||
- | |||
- | The dashboard is automatically refreshed and goes through the different statuses, until it is **Sent**, **Partially sent** or **Cancelled**. | ||
- | |||
- | {{:images:group_update_dashboard_sent.jpg?800|}} | ||
- | |||
- | ===== Alerting dashboard ===== | ||