Log and Runtime Files#

NVIDIA AI Workbench creates log and runtime files that you can use to debug issues, and to understand the state of your applications. There are log files for the AI Workbench desktop application, service, CLI, and for applications that you use with AI Workbench. Some log file content appears in the desktop application, so that you can monitor your projects and apps while they are running.

Use this documentation to perform the following tasks:

Access Log Files From the Desktop Application#

To access server and app log files from the AI Workbench desktop application, do the following:

  1. In the status bar, click Output. The output pane opens.

  2. In the drop-down, select Service or the name of an app, such as JupyterLab. The log file appears in the output pane.

Manually Access Log Files#

For local locations, all log files are on the local computer. For remote locations, the server and app log files are on the remote computer, and the desktop application and CLI log files are on your local machine. SSH into the remote computer to view the server and app log files.

To access log files manually, find them in the following locations.

Important

When you install AI Workbench on Windows, a folder named Linux\NVIDIA-Workbench (\\wsl.localhost\NVIDIA-Workbench) is added to your File Explorer.

Desktop application log files

C:\Users\<username>\AppData\Local\NVIDIA Corporation\AI Workbench\logs\main.log

Server log files

Linux\NVIDIA-Workbench\home\workbench\.nvwb\logs\workbench.log

CLI log files

Linux\NVIDIA-Workbench\home\workbench\.nvwb\logs\nvwb.log

Application log files

Linux\NVIDIA-Workbench\home\workbench\.nvwb\project-runtime-info\<project-name-and-hash>\<app name>-start.log

Desktop application log files

/home/<username>/.config/NVIDIA/AI Workbench/logs/main.log

Server log files

/home/<username>/.nvwb/logs/workbench.log

CLI log files

/home/<username>/.nvwb/logs/nvwb.log

Application log files

/home/<username>/.nvwb/project-runtime-info/<project-name-and-hash>/<app name>-start.log

Desktop application log files

/Users/<username>/Library/Application Support/NVIDIA/AI Workbench/logs/main.log

Server log files

/Users/<username>/.nvwb/logs/workbench.log

CLI log files

/Users/<username>/.nvwb/logs/nvwb.log

Application log files

/Users/<username>/.nvwb/project-runtime-info/<project-name-and-hash>/<app name>-start.log

Create a Support Bundle for Troubleshooting#

In some cases, you might need to create a support bundle. A support bundle is a zip file that contains log files, configuration information, and system state for your AI Workbench installation. We attempt to automatically exclude sensitive or identifiable information. However, always review the contents of a support bundle before you share it with anyone.

You always create a support bundle for your local location. If the currently active location is a remote location, or if you specify a remote location when you create the support bundle, a support bundle is created for the remote location first, and included in the support bundle for your local location.

Use the following procedure to create a support bundle.

  1. Access the AI Workbench CLI. For instructions, see Basic Quickstart (CLI).

  2. Run the support create-bundle command.

    1nvwb support create-bundle
2
3— or —
4
5nvwb support create-bundle --context <location name>

    When the command completes, the message Support bundle created appears with the location of the file.

  3. Find the support bundle file in the following location.

    Important

    When you install AI Workbench on Windows, a folder named Linux\NVIDIA-Workbench (\\wsl.localhost\NVIDIA-Workbench) is added to your File Explorer.

    Linux\NVIDIA-Workbench\home\workbench\.nvwb\ai-workbench-support-bundle.zip

    ~/.nvwb/ai-workbench-support-bundle.zip

    — or —

    ~/.nvwb/remote-ai-workbench-support-bundle.zip

    ~/.nvwb/ai-workbench-support-bundle.zip

AI Workbench Project Runtime Files#

AI Workbench creates files to track progress while building, configuring, and running each project. These files are essential for managing a project’s runtime operation. You should not commit these files to your Git repository accidentally.

The project runtime files are created in the following location.

Important

When you install AI Workbench on Windows, a folder named Linux\NVIDIA-Workbench (\\wsl.localhost\NVIDIA-Workbench) is added to your File Explorer.

Linux\NVIDIA-Workbench\home\workbench\.nvwb\project-runtime-info\<project-name-and-hash>

/home/<username>/.nvwb/project-runtime-info/<project-name-and-hash>

/Users/<username>/.nvwb/project-runtime-info/<project-name-and-hash>

The files stored in this directory are the following:

  • Containerfile — Generated on demand during the project build (can also be called a Dockerfile).

  • build-output.success — Build logs from the last build that was successful.

    • build-output.error — Build logs from the last build that failed and resulted in an error.

    • build-output.building — Build logs from the build that is currently in progress.

  • cache/ — The directory that acts as the build context for the container build.

  • edit.cache — The cache value of the last edit of the container image made by the library.

  • mount/ — The directory stores the mount definitions for the project’s configured mounts, as well as mount directories and unmount scripts for each mount. For more information, see AI Workbench Mounts.

  • rebuild.cache — The cache value of the last build of the container image.

  • runtime-flags.json — Flags used by AI Workbench.

  • secrets.env — The project’s secret environment variables and their values. For more information, see Environment Variables.

There are also one or more application files, depending on the applications in the project:

  • <app name>-start.log — Application start logs for debugging issues.