This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
wiki:get_logs [2024/02/13 12:16] ehe created |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Get logs of a gateway on Wanesy Management Cockpit ====== | ||
- | ===== Documentation ===== | ||
- | |||
- | [[https://wmc.wanesy.com|Wanesy Management Cockpit]] (online) | ||
- | [[https://wmc.wanesy.com/docs|GMS API Web services documentation]] (online) | ||
- | |||
- | ===== Get logs of a gateway ===== | ||
- | <note> | ||
- | The constraints associated to the get logs command are as follows: | ||
- | * The get logs command is only accessible to users with **SERVICE_ADMINISTRATOR** and **CHANNEL_ ADMINISTRATOR** roles | ||
- | * It is not possible to send a new get logs command if another one is already pending for the same gateway | ||
- | * It is possible to cancel a get logs command only if it has not yet been sent to the gateway | ||
- | </note> | ||
- | |||
- | To get the logs of a gateway, you need to go to the gateway overview page and select ''Get logs'' from the ''ACTIONS'' menu. | ||
- | |||
- | {{:images:get_logs_menu.jpg?800|}} | ||
- | |||
- | After clicking on ''Get logs'', you will be redirected to the ''Gateway logs'' page. | ||
- | |||
- | {{:images:gateway_logs_page.jpg?800|}} | ||
- | |||
- | In case of backhaul restriction on speed or data, you have the option to enable the minimal mode to limit the size of the log file. | ||
- | |||
- | {{:images:get_logs_mode.jpg?400|}} | ||
- | |||
- | <note> | ||
- | The minimal mode is enabled by default if the current backhaul used is cellular (or if it is unknown), in all other cases the normal mode is enabled by default. | ||
- | </note> | ||
- | <note important> | ||
- | The constraints associated to the minimal mode are as follows: | ||
- | * The minimal mode is not supported for gateways with FW < KerOS 5.6 | ||
- | * The minimal mode is not yet available for gateways with FW = KerOS 6 | ||
- | </note> | ||
- | |||
- | Once triggered after clicking on ''GET LOGS'' button, the get logs command will be sent to the gateway when the next telemetry message is received (message expected every hour). | ||
- | |||
- | When a get logs command is pending (waiting to be sent to the gateway), it appears in the ''Get logs command'' block and an orange dot is displayed in the ''ACTIONS'' menu. | ||
- | |||
- | {{:images:get_logs_pending.jpg?800|}} | ||
- | |||
- | To cancel the get logs command, you need to click on the ''CANCEL GET LOGS'' button present in the ''Get logs command'' block. | ||
- | |||
- | Then a confirmation popup is displayed. | ||
- | |||
- | {{:images:get_logs_cancel.jpg?400|}} | ||
- | |||
- | The available log files are listed in the ''Available log files'' block, a link allows to download each of them. | ||
- | |||
- | {{:images:get_logs_list.jpg?800|}} | ||
- | |||
- | <note> | ||
- | The retention period for the log files is 30 days. | ||
- | </note> | ||
- | |||