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.

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

Section link for Creating SDK Debug Log Sessions

Vault Admins can create a new SDK Debug log session for an authenticated particular user via the Vault UI or the Vault Toolbox plugin.

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

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the tab.
3. Expand Developer Logs () and double-click SDK Debug ().
4. In the dialog, click 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.
   
6. Optional: Select a Log Level to narrow the results to only include certain log levels or classes. Click to add Class Filters and select the classes to include. You can include up to 10 classes.
7. Click OK to create the session.

Downloading SDK Debug Logs

Section link for Downloading SDK Debug Logs

To download SDK Debug logs:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the tab.
3. Expand Developer Logs () and double-click SDK Debug ().
   
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 create a new debug log session.
   
5. Optional: Click to refresh the list of session(s).
6. Optional: Click 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 to delete the selected debug log session(s) from Vault.
8. Click or OK to download the selected log(s).

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.

Analyzing SDK Debug Logs

Section link for Analyzing SDK Debug Logs

To analyze SDK Debug Logs:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the tab.
3. Expand Developer Logs () and double-click SDK Debug ().
4. In the dialog, previously downloaded logs are differentiated by a within the View column. To proceed with analyzing the log(s), select the checkbox for one or more downloaded logs, then click . 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 .

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.