Submitting Issues Collecting Logs - openziti/desktop-edge-win GitHub Wiki
There are an almost endless amount of problems that seem to occur with Windows and Windows networking. There are many different configurations, many different user options, different hardware, the list goes on. When submitting an issue - collecting as much information as possible is vital. If you are going to submit an issue here is what is most helpful to get the issue solved.
Steps to reproduce
If you can reliably recreate the issue fantastic! If not - try to get screen shots, record a video, look at the Windows Event logs, anything and everything you can do to provide information is very helpful.
Gather ALL the logs!
NOTE: By default the installation will be installed into %ProgramFiles(x86)%\NetFoundry, Inc\Ziti Desktop Edge. This is referred to below as "${InstallDirectory}"
Step One - TRY TO RUN the collect-logs.ps1 scripts! The script may fail due to a bug or the user running the script might not have access to the proper folders. If that's the situation keep reading on. Depending on where the bug is and what your access level is you might have some issues doing that until issue #201 is complete. Once this issue is complete - you will be able to get all these logs using the user space UI application.
If there's a problem with the script - you might need to set the execution policy temporarily. Run these commands to set the policy, run the script, then set it back to the previous policy level:
$currentPolicy=$(Get-ExecutionPolicy)
Set-ExecutionPolicy RemoteSigned -Force
powershell -file "${env:ProgramFiles(x86)}\NetFoundry, Inc\Ziti Desktop Edge\collect-logs.ps1"
Set-ExecutionPolicy $currentPolicy -Force
Here's a rundown of the various pieces of the Ziti Desktop Edge for Windows and where the logs are.
The Installer
If the installer fails it's pretty hard to know why at this time. Please look in the event viewer for any hints. If you are having issues with the installer please try to submit any details that might be helpful, a video of the process, etc.
Services Startup
The "Data" Service - ziti
As stated above, the Ziti Desktop Edge for Windows solution contains a powershell script named collect-logs.ps1 that tries to collect and zip all the relevant log files. If the service does not start and the script is not able to find the corect logs the primary place to look for more information is the Windows Event Viewer. The "Application" log will have some information that is helpful. There will be a message telling you where the logs are logging to which is USUALLY %WINDIR%\System32\config\systemprofile\AppData\Roaming\NetFoundry however there has been one user that had this folder be in their own APPDATA folder. Make sure all these logs are included with your submission.
The "Monitor" Service - ziti-monitor
The monitor service will watches the "data" service to verify the network is working properly and it also provides the automatic update functionality. If the automatic update functionality is not working the ziti-monitor logs are vital. Depending on how old the Ziti Desktop Edge for Windows is there are two locations to check for logs.
- ${InstallDirectory}\ziti-monitorlog
- ${InstallDirectory}\logs\ZitiMonitorService*
The UI
The UI has logs too now which are found in ${InstallDirectory}\logs\UI with versions of Ziti Desktop Edge for Windows 1.5.+
Please provide ALL these logs with any submission and when not possible to get them all, please ensure you get as many of these logs as possible.