Diagnostics

Overview

The Diagnostics feature in KOS Studio provides users with tools to manage and upload diagnostic information to help the customer service team troubleshoot issues efficiently. With Diagnostics, you can:

  • Enable or disable automatic upload of studio logs
  • Instantly upload recent logs, databases, and settings
  • Configure reverse proxy settings for KAB downloads

This feature ensures that customer support has the necessary information to assist you promptly and effectively.

Accessing Diagnostics

Opening the Diagnostics Modal

  1. Click on the Main Menu in KOS Studio
  2. Select Diagnostics from the menu options
  3. The Diagnostics modal will open, displaying all available diagnostic options

The Diagnostics feature is accessible from the main menu at any time during your KOS Studio session.

Automatic Upload of Logs

The automatic upload feature sends your studio logs to the cloud service provider on a scheduled basis, ensuring that diagnostic information is available when you need support.

  • Automatic upload of logs is enabled by default
  • Logs are uploaded automatically on the following schedule:
    • 5 minutes after launching KOS Studio
    • Daily at 12:00 AM (midnight)

Enabling Automatic Upload

  1. Open the Diagnostics modal from the Main Menu
  2. Locate the Automatic Upload of Logs toggle button
  3. Switch the toggle to the ON position (if not already enabled)
  4. The system will begin uploading unuploaded archived logs according to the schedule

Note: When automatic upload is enabled, the upload process runs in the background without displaying progress notifications.

Disabling Automatic Upload

  1. Open the Diagnostics modal from the Main Menu
  2. Locate the Automatic Upload of Logs toggle button
  3. Switch the toggle to the OFF position
  4. The system will stop uploading logs automatically

Important: When automatic upload is disabled, the system will not upload logs under any condition until you re-enable this feature.

Instant Upload Features

The Diagnostics tool provides three instant upload options for immediate assistance from the customer service team.

Uploading Recent Studio Logs

Use this option when you need to send the most recent log files immediately.

Steps:

  1. Open the Diagnostics tool from the Studio Menu
  2. Click the Upload Recent Logs button
  3. A progress bar will appear showing the upload status
  4. Wait for the upload to complete; the upload results are displayed on the UI.
  • Success: A confirmation message will indicate successful upload
  • Failure: An error message will display explaining why the upload failed

Uploading Studio Databases

Use this option to send your studio database files for detailed troubleshooting.

Steps:

  1. Open the Diagnostics modal
  2. Click the Upload Studio DB button
  3. Monitor the progress indicator during the upload
  4. Wait for the upload to complete; the upload results are displayed on the UI.
  • Success: A confirmation message will indicate successful upload
  • Failure: An error message will provide details about the upload failure

Uploading Studio Settings

Use this option to share your current studio configuration with customer support.

Steps:

  1. Open the Diagnostics modal
  2. Click the Upload Studio Settings button
  3. The system will automatically copy studio settings to your clipboard
  4. Monitor the progress indicator during the upload
  5. Wait for the upload to complete, ; the upload results are displayed on the UI.
  • Success: A confirmation message will indicate successful upload
  • Failure: An error message will explain the reason for the upload failure

Note: Since settings are copied to your clipboard, you can paste them into a support ticket if needed.

Settings Configuration

Reverse Proxy Settings for KAB Downloads

The reverse proxy feature helps you download KABs (Knowledge Application Bundles) when firewalls or network restrictions might otherwise block the downloads.

Enabling Reverse Proxy

  1. Open the Diagnostics modal
  2. Navigate to the Settings tab
  3. Locate the Reverse Proxy toggle button
  4. Switch the toggle to the ON position
  5. When you run an image and download a KAB, the system will use the reverse proxy

Disabling Reverse Proxy

  1. Open the Diagnostics modal
  2. Navigate to the Settings tab
  3. Switch the Reverse Proxy toggle to the OFF position
  4. KAB downloads will proceed without using the reverse proxy

When to Use Reverse Proxy:

  • You’re experiencing blocked downloads due to firewall restrictions
  • Direct KAB downloads are failing
  • Your network requires proxy configuration for external connections

Offline Behavior

When the KOS Studio server is offline, the Diagnostics feature remains accessible with limited functionality. Disabled buttons will appear grayed out, clearly indicating that these functions are unavailable until the server connection is restored.

FAQs

You can choose to have your archived Studio logs automatically uploaded to the cloud, which helps our team proactively identify bugs and significantly reduces support delays. To toggle this feature on or off:

  • Open KOS Studio.
  • Click on KOS Studio in the top-left corner.
  • Open the Diagnostics menu.
  • Locate the Diagnostics toggle switch.
    • Turn it ON to enable automatic log uploads.
    • Turn it OFF to disable automatic uploads and manage your diagnostic sharing manually.

More information on diagnostics can be found here: Diagnostics

You can securely upload your diagnostic data directly to the cloud from within the application. This provides our engineering and support teams with the data needed to analyze any issues. To do this:

  • Open KOS Studio
  • Navigate to the top left menu and click on KOS Studio
  • Select Diagnostics from the dropdown menu

Here, you can instantly upload diagnostic information to our secure cloud. The data that can be uploaded includes:

  • Diagnostics Toggle: Enabling this option allows archived logs to upload automatically in the background for continuous product improvement and proactive debugging.
  • Logs: Instantly uploads live KOS Studio logs
  • Settings: This includes Studio configurations
  • Database: Internal database containing your local system state and data.

More information on diagnostics can be found here: Diagnostics

Diagnostic information enables the KOS team to provide timely, accurate, and efficient customer support. By analyzing this data, the customer service and engineering teams can see exactly what occurred on your device leading up to an issue, allowing them to provide immediate assistance.

Beyond fixing individual troubleshooting tickets, collecting diagnostics allows us to track recurring issues and generally improve overall product quality. This data directly informs our development cycle, ensuring that bugs are permanently addressed in future software updates.