Enable diagnostic log uploads - Amazon WorkSpaces
Diagnostic log uploads
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Enable diagnostic log uploads

To troubleshoot WorkSpaces client issues, enable automatic diagnostic log uploads. This is currently supported for Windows, macOS, Linux, and Web Access clients.

Note

The WorkSpaces client diagnostic log uploads feature is currently unavailable in the Amazon GovCloud (US-West) Region.

Diagnostic log uploads

With Diagnostic log uploads, you can upload WorkSpaces client log files directly to WorkSpaces to troubleshoot issues without interrupting use of the WorkSpaces client. If you enable diagnostic log uploads for your users, or let your users do so themselves, the log files are sent to WorkSpaces automatically. You can enable diagnostic log uploads before or during a WorkSpaces streaming session.

To automatically upload diagnostic logs from managed devices, install a WorkSpaces client that supports diagnostic uploads. Log uploading is enabled by default. You can modify the settings in either of the following ways:

  1. Open the WorkSpaces console at https://console.amazonaws.cn/workspaces/.

  2. In the navigation pane, choose Directories.

  3. Choose the directory name that you want to enable diagnostic logging for.

  4. Scroll down to Self-service permission.

  5. Choose Edit.

  6. Choose Diagnostic log uploads.

  7. Choose Save.

You can edit the directory settings to enable or disable the WorkSpaces Windows, macOS, and Linux client to upload diagnostic logs automatically using an API call. If enabled, when a client issue occurs, the logs are sent to WorkSpaces without user interaction. For more information, see the WorkSpaces API reference.

You can also let your users choose whether to enable automatic diagnostic log uploads after client installation. For more information, see WorkSpaces Windows client application , WorkSpaces macOS client application, and WorkSpaces Linux client application.

Note

  • Diagnostic logs don't contain sensitive information. You can disable automatic diagnostic log uploads for your users at the directory level, or allow your users to disable these features themselves.

  • To access the diagnostic log uploads feature, you need to install the following versions of the WorkSpaces clients:

    • 5.4.0 or later of the Windows client

    • 5.8.0 or later of the macOS client

    • 2023.1 of the Ubuntu 22.04 client

    • 2023.1 of the Ubuntu 20.04 client

    • You can also access the diagnostic log upload feature with the Web Access client