From a0016be2399b7dd6c14563c04fb6f9ca3d56dca0 Mon Sep 17 00:00:00 2001 From: chrisjlin <36452239+chrisjlin@users.noreply.github.com> Date: Mon, 2 Dec 2024 17:16:34 -0800 Subject: [PATCH] Added desc of other WSL logs, support bundle generation instructions --- .../deployment/do/mcc-ent-troubleshooting.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/windows/deployment/do/mcc-ent-troubleshooting.md b/windows/deployment/do/mcc-ent-troubleshooting.md index 0f5b02bc00..7acb2a1a51 100644 --- a/windows/deployment/do/mcc-ent-troubleshooting.md +++ b/windows/deployment/do/mcc-ent-troubleshooting.md @@ -60,6 +60,16 @@ There are three types of installation log files: The Registered Task Transcript is usually the most useful for diagnosing the installation issue. +### Collecting other Windows-hosted logs + +Once the cache node has been successfully installed on the Windows host machine, it will periodically write log files to the installation directory (`C:\mccwsl01\` by default). + +You can expect to see the following types of log files: + +1. **WSL_Mcc_Monitor_FromRegisteredTask_Transcript**: This log file records the output of the "MCC_Monitor_Task" scheduled task that is responsible for ensuring that the Connected Cache continues running. +1. **WSL_Mcc_UserUninstall_Transcript**: This log file records the ouput of the "uninstallmcconwsl.ps1" script that the user can run to uninstall MCC software from the host machine. +1. **WSL_Mcc_Uninstall_FromRegisteredTask_Transcript**: This log file records the output of the "MCC_Uninstall_Task" scheduled task that is responsible for uninstalling the MCC software from the host machine when called by the "uninstallmcconwsl.ps1" script. + ### WSL2 fails to install with message "A specified logon session does not exist" If you are encountering this failure message when attempting to run the PowerShell command `wsl.exe --install --no-distribution` on your Windows host machine, verify that you are logged on as a local administrator and running the command from an elevated PowerShell window. @@ -106,6 +116,23 @@ If it shows the **edgeAgent** and **edgeHub** containers but doesn't show **MCC* You can also reboot the IoT Edge runtime using `sudo systemctl restart iotedge`. +## Generating cache node diagnostic support bundle + +You can generate a support bundle with detailed diagnostic information by running the `collectMccDiagnostics.sh` script found in the MCC diagnostics folder. + +For Windows host machines, you will need to do the following: + +1. Launch a PowerShell process as the account specified as the runtime account during the Connected Cache install +1. Run `wsl -d Ubuntu-22.04-Mcc-Base` to access the Linux distribution that hosts the Connected Cache container +1. Change directory to `path/to/collectMccDiagnostics.sh` +1. Run the script +1. Extract the generated support bundle from `path/to/support/bundle` to `path/to/windows/host` + +For Linux host machines, you will need to do the following: + +1. Change directory to `path/to/collectMccDiagnostics.sh` +1. Run the script + ## Troubleshooting cache node monitoring Connected Cache node status and performance can be [monitored using the Azure portal user interface](mcc-ent-monitoring.md).