**Source URL:** https://general.veevavault.dev/clinical/vault-toolbox/intellij-plugin/guides/developer-logs/sdk-debug-logs

# SDK Debug Logs

The SDK Debug log contains the execution details and Vault messages for custom Vault Java SDK code at the user level. Vault Admins are responsible for configuring a debug log session, up to one at a time for each user, for up to 20 users. By default, the *Vault Owner* and *System Admin* security profiles have permission to view the SDK Debug log and set up sessions for a particular user. Learn more about the SDK Debug log in the [Vault Java SDK documentation](/clinical/vault-sdk/troubleshooting-runtime-errors/debug-log).

You can use the Vault Toolbox plugin to create a debug log session, retrieve the SDK Debug log, as well as analyze the log itself. Debug logs expire after 30 days. At the end of 30 days, Vault deletes the debug log and all log files.

## Creating SDK Debug Log Sessions

Vault Admins can create a new SDK Debug log session for an authenticated particular user via the [Vault UI](https://platform.veevavault.help/en/gr/14341/#debug_log) or the Vault Toolbox plugin.

To create an SDK Debug log session with the Vault Toolbox plugin:

<Steps>
1.  Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2.  Select the **Actions** (<Icon name="ph:sliders-horizontal" />) tab.
3.  Expand **Developer Logs** (<Icon name="ph:brackets-curly" />) and double-click **SDK Debug** (<Icon name="ph:bug" />).
4.  In the dialog, click <Icon name="ph:plus" /> to create a session.
5.  In the dialog, provide a **Name** for the session and select the **User** for which the session should be enabled.
    
    <ThemeImage srcLight="/images/toolbox/intellij-plugin/create_sdk_debug_log_session_light.png" srcDark="/images/toolbox/intellij-plugin/create_sdk_debug_log_session_dark.png" alt="IntelliJ Plugin Create SDK Debug Log Session" />
    
6.  Optional: Select a [**Log Level**](https://platform.veevavault.help/en/gr/14341/#debug-log-data) to narrow the results to only include certain log levels or classes. Click <Icon name="ph:plus" /> to add *Class Filters* and select the classes to include. You can include up to 10 classes.
7.  Click **OK** to create the session.
</Steps>

## Downloading SDK Debug Logs

To download SDK Debug logs:

<Steps>
1.  Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2.  Select the **Actions** (<Icon name="ph:sliders-horizontal" />) tab.
3.  Expand **Developer Logs** (<Icon name="ph:brackets-curly" />) and double-click **SDK Debug** (<Icon name="ph:bug" />).
    
    <ThemeImage srcLight="/images/toolbox/intellij-plugin/sdk_debug_log_light.png" srcDark="/images/toolbox/intellij-plugin/sdk_debug_log_dark.png" alt="IntelliJ Plugin SDK Debug Log" />
    
4.  In the dialog, select the checkbox for one or more debug log session(s) or click **Select** in the header to select all sessions. If the list is empty, you must .
    
    <ThemeImage srcLight="/images/toolbox/intellij-plugin/select_sdk_debug_log_light.png" srcDark="/images/toolbox/intellij-plugin/select_sdk_debug_log_dark.png" alt="Selecting a SDK Debug Log Session" />
    
5.  Optional: Click <Icon name="ph:arrows-counter-clockwise" /> to refresh the list of session(s).
6.  Optional: Click <Icon name="ph:arrow-clockwise" /> to reset the selected session(s). This action deletes all existing log files for the selected session(s) and resets its *Expiration Date* to 30 days.
7.  Optional: Click <Icon name="ph:trash" /> to delete the selected debug log session(s) from Vault.
8.  Click <Icon name="ph:download-simple" /> or **OK** to download the selected log(s).
</Steps>

 

<ThemeImage srcLight="/images/toolbox/intellij-plugin/download_sdk_debug_log_light.png" srcDark="/images/toolbox/intellij-plugin/download_sdk_debug_log_dark.png" alt="IntelliJ Plugin Download SDK Debug Log" />

Once the operation is complete, you can access the downloaded SDK Debug log as a `.txt` file or within the `.zip` file from the `toolbox/logs/debug/{vaultid}` folder in your project directory.

## Importing SDK Debug Logs

You can also load an existing SDK Debug log into the workspace without re-downloading it from Vault. This is useful when you have an archive from a previous Vault Toolbox download, an export from Vault, or a file shared by a colleague.

To import SDK Debug logs:

<Steps>
1.  Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2.  Select the **Actions** (<Icon name="ph:sliders-horizontal" />) tab.
3.  Expand **Developer Logs** (<Icon name="ph:brackets-curly" />) and double-click **SDK Debug** (<Icon name="ph:bug" />).
4.  In the dialog toolbar, click <Icon name="ph:upload-simple" /> to open the file chooser.
5.  Select a Vault log archive (`.zip`) or a single log file (`.csv`, `.log`, or `.txt`). Vault Toolbox uses the archive's file name to determine the session folder, so an archive named `{vaultid}.{sessionName}.{sessionId}.zip` (the same convention used when Vault Toolbox downloads the log) groups the files under the matching session. If the archive name does not include a session ID, the files are placed under an `imported` session.
6.  In the *Import Log Archive* dialog, confirm or update the **Vault ID**. The plugin auto-fills this field from any leading digits in the file name. Review the preview table to see the destination for each file and whether it will be created as a **New** file or **Overwrite** an existing file.
7.  Click **OK** to import.
</Steps>

Once the operation is complete, the imported logs are available under `toolbox/logs/debug/{vaultid}/{sessionName}.{sessionId}` and the table refreshes so you can analyze them.

## Analyzing SDK Debug Logs

To analyze SDK Debug Logs:

<Steps>
1.  Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2.  Select the **Actions** (<Icon name="ph:sliders-horizontal" />) tab.
3.  Expand **Developer Logs** (<Icon name="ph:brackets-curly" />) and double-click **SDK Debug** (<Icon name="ph:bug" />).
4.  In the dialog, previously downloaded logs are differentiated by a <Icon name="ph:eye" /> within the *View* column. To proceed with analyzing the log(s), select the checkbox for one or more downloaded logs, then click <Icon name="ph:lightbulb" />. The CSV file of the analysis will then open in your preferred spreadsheet application.
5.  Optional: To clear local files from your project directory, select the checkbox for one or more downloaded logs, then click <Icon name="ph:x" />.
</Steps>

Once the operation is complete, you can access the analysis files for the debug logs from `toolbox/logs/debug/{vaultid}/analysis` in your project directory.

---

**Previous:** [API Usage Logs](/clinical/vault-toolbox/intellij-plugin/guides/developer-logs/api-usage-logs)  
**Next:** [SDK Runtime Logs](/clinical/vault-toolbox/intellij-plugin/guides/developer-logs/sdk-runtime-logs)