Skip to main content

Twingate Client Logs

Aaron
  • Updated
In this article:
    Applicable to:
    • Twingate Component: Client
    • Platform: Android, iOS, Linux, macOS, Windows

    Overview

    This article will provide guidance for how to collect the Twingate Client logs across the various supported operating systems.

     

    Windows

    Prior to uploading logs, ensure Collect Detailed Logs is enabled. If it isn't follow the below process to enable detailed logging. Once the issue is reproduced again thereafter proceed to log upload or manual log collection.

    To do so, click on the Twingate icon in the system tray, and select More > Troubleshoot. Verify there is a check mark next to Collect Detailed Logs.
    2022-12-13_13-59.png

    Method 1 (preferred): Client Log Upload

    1. Via the Twingate Client, click More > Troubleshoot > Report an issue...
      2022-12-13_13-59_1.png
    2. At the prompt Upload diagnostic logs, click Create ticket to approve of diagnostic logs being uploaded from the device.
    3. A browser window will appear for you to input information. If you are working with our Technical Support Engineering team, simply reference the support request number.

    Method 2: Manual Log Retrieval

    1. Click on the Twingate icon in the taskbar, and select More > Troubleshoot > View Logs
      2022-12-13_14-20.png
    2. Two Windows Explorer windows will open, %LOCALAPPDATA%\Twingate\logs\ and %PROGRAMDATA%\Twingate\logs\ 
      2022-12-13_14-21.png
    3. For each directory, select all files (Control + A) > Right-Click on the select files >
      1. Windows 11: select Compress to ZIP file
        mceclip1.png
      2. Windows 10: Send to > Compressed (zipped) folder
        mceclip3.png
      3. Provide Twingate Technical Support the newly created *.zip files for each ProgramData and AppData.

    macOS

    Prior to uploading logs, ensure Collect Detailed Logs is enabled. If it isn't follow the below process to enable detailed logging. Once the issue is reproduced again thereafter proceed to log upload or manual log collection.

    To do so, click on the Twingate icon in the system tray, and select More > Troubleshoot. Verify there is a check mark next to Collect Detailed Logs.

    2022-12-13_14-57.png

    Method 1 (preferred): Client Log Upload

    1. Via the Twingate Client, click More > Troubleshoot > Report an issue...
      2022-12-13_15-33.png
    2. At the prompt Upload diagnostic logs, click Create ticket to approve of diagnostic logs being uploaded from the device.
    3. A browser window will appear for you to input information. If you are working with our Technical Support Engineering team, simply reference the support request number.

    Method 2: Manual Log Retrieval

    1. Click on the Twingate icon in the menu bar, and select More > Troubleshoot > View Logs > Finder.
      2022-12-13_15-37.png
    2. This opens the log directory (~/Library/Group Containers/group.com.twingate/Logs/) in Finder.
    3. Select all files (command + A) > Control-Click (Right-Click) on the selected files > select Compress.
      mceclip0.png
    4. Provide Twingate Technical Support with the Archive.zip newly created file. 

    Linux

    Prior to retrieving logs, ensure debug logging is enabled. To check and set debug level logging, follow the below steps. Once the issue is reproduced again thereafter proceed generate the log bundle.

    To see what the logging level is, run sudo twingate config. If log-level: is not debug, configure debug logging with the command sudo twingate config log-level debug. Thereafter run the commands twingate stop and twingate start to restart the Client with debug logging.  

    • From the terminal run sudo twingate report. This will generate a ZIP file with diagnostic information in the working directory.
    • For live review of logs, the Linux Client runs as a systemd service with logs retrievable via journalctl. Below is an example command: 
      sudo journalctl -u twingate --since "1 hour ago"
    • If journalctl is not installed, the logs will be stored under /var/log/twingated.log. This occasionally is seen when running the Linux Client on a container in headless mode.

    iOS

    • Within the Twingate app, tap on the Settings gear icon at top right and tap Share Diagnostics.

    Android & ChromeOS

    • Within the Twingate app, top of the Settings "burger" icon at top left, and under Advanced, tap Share Logs with developer.

    Related articles