SDK Profiler Logs

Developers can troubleshoot and improve their custom SDK code by creating SDK request profiling sessions. When the session is active, it captures all SDK requests that occur during that period. Vault Admins can configure profiling sessions for a specific user or all users. Learn more about the Profiler log in the Vault Java SDK documentation.

You can use the Vault Toolbox plugin to create, download, and analyze Profiler logs. Profiler logs expire after 30 days. At the end of 30 days, Vault deletes the log and all log files.

Creating Profiler Sessions

Section link for Creating Profiler Sessions

Vault Admins can create a new Profiler session via the Vault UI, Vault API, or the Vault Toolbox plugin. SDK profiling sessions run for either 20 minutes or up to 10,000 SDK requests, whichever comes first. You can also use the Vault Toolbox plugin to end a session early.

Note

Only one SDK profiling session can be active at a time. A session with any Status other than Complete is considered an active session. For example, sessions which have ended but are still Processing are considered active sessions.

To create a Profiler session:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the Actions () tab.
3. Expand Developer Logs () and double-click SDK Profiler ().
4. In the dialog, click to create a session.
5. In the dialog, provide a Label and Description for the session, then select the User for which the session should be enabled.
   
6. Click OK to create the session.

Ending Profiler Sessions

Section link for Ending Profiler Sessions

Vault Admins can end a Profiler session via the Vault UI, Vault API, or the Vault Toolbox plugin.

To end Profiler sessions:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the Actions () tab.
3. Expand Developer Logs () and double-click SDK Profiler ().
4. In the dialog, select the checkbox for one or more profiler log session(s) or click Select in the header to select all sessions.
   
5. Click to end the selected session(s).

Once a session has ended, it has a Status of Processing while Vault prepares the data, which may take up to 15 minutes. Once the Status is Complete, the data is available for download.

Downloading Profiler Logs

Section link for Downloading Profiler Logs

Vault Admins can download the Profiler log via the Vault UI, Vault API, or the Vault Toolbox plugin. Your Vault can save up to 10 SDK Profiler Logs at once. After reaching the limit, you must delete an existing log or wait for one to expire.

To download Profiler logs:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the Actions () tab.
3. Expand Developer Logs () and double-click SDK Profiler ().
4. In the dialog, select the checkbox for one or more profiler log session(s) or click Select in the header to select all sessions.
   
5. Optional: Click to refresh the list of session(s).
6. Optional: Click to delete the selected profiler session(s) from Vault.
7. Click to download the selected logs. If this option is disabled, you must ensure the sessions you selected have ended and have a Status of Complete.

Vault Toolbox generates the Profiler logs for the selected sessions. Once the operation is complete, you can access the downloaded Profiler logs from the toolbox/logs/profiler/{vaultid} folder in your project directory. The CSV file contains the Profiler log data for that session.

Importing Profiler Logs

Section link for Importing Profiler Logs

You can also load an existing Profiler 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 the Vault UI, or a file shared by a colleague.

To import Profiler logs:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the Actions () tab.
3. Expand Developer Logs () and double-click SDK Profiler ().
4. In the dialog toolbar, click 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.

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

Analyzing Profiler Logs

Section link for Analyzing Profiler Logs

To analyze Profiler logs:

1. Within IntelliJ IDEA, open the Vault Toolbox plugin from the righthand sidebar.
2. Select the Actions () tab.
3. Expand Developer Logs () and double-click SDK Profiler ().
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 .
5. In the dialog, you can apply filters to Profiler log data such as Start Time and End Time, and select tabs to view visualized data such as the SDK Count and SDK CPU Time.
   
6. Optional: To clear local files from your project directory, select the checkbox for one or more downloaded logs, then click .