Chapter 6
6. Logging and support
Vault logs application activity, connection events, sync results, and problems. Open Settings > Logging to control file logging.
6.1 Default logging settings
| Setting | Default |
|---|---|
| Enable logging | On |
| Use backup folder | On |
| Log folder | The logs subfolder inside your selected backup folder |
| Maximum log size (MB) | 50 |
| Previous logs to retain | 5 compressed logs, plus the active log |
| Minimum log level | Info |
One megabyte (MB) is 1,000,000 bytes. Vault starts file logging after you choose a backup folder or a custom log folder.
6.2 Change logging settings
- Open Settings > Logging.
- Leave Enable logging selected to record activity.
- Set the folder, size, retention, and level you need.
- Select Save logging settings.
- Check for Logging settings saved.
Saved changes apply without restarting Vault. If Vault cannot save the changes, it shows the problem and keeps the current settings.
Leave Use backup folder selected to keep logs in the backup folder's logs subfolder.
This location follows changes to the backup folder.
For a fixed location, clear Use backup folder. Select Browse... or enter a full path in Log folder, then save. A custom log folder stays fixed when the backup location changes. Choose a folder outside Vault's database and thumbnail storage.
Saved log folder shows the saved destination. Changing folders leaves existing logs in their previous folder.
6.3 Choose a log level
Minimum log level includes the selected level and all more severe events.
| Level | Use |
|---|---|
| Debug | Detailed investigation, including request timing and successful connection requests. Creates larger logs. |
| Info | Normal activity and problems. The default. |
| Warning | Warnings and more severe problems. |
| Error | Errors and critical problems. |
| Critical | Critical problems only. |
Use Debug when support needs more detail. Save the setting before repeating the problem. Return to Info and save after collecting the needed logs.
6.4 Files and retention
The active file is vault.log. It contains one JavaScript Object Notation (JSON) record per line.
At the size limit, Vault starts a new active file and compresses the previous file with gzip.
Archives use vault-<UTC timestamp>-<unique suffix>.log.gz.
UTC means Coordinated Universal Time.
Previous logs to retain counts compressed archives, in addition to the active file.
Set it to 0 to keep only the active file.
Retention is based on the number of archives, not their age.
Clear Enable logging and select Save logging settings to stop file output. Existing logs remain. Deleting the local backup also preserves logs.
6.5 If logging needs attention
Vault shows a warning when it cannot write logs. Backup and browsing continue while Vault retries automatically.
- Open Settings > Logging and read the status.
- Check that the drive is connected and has free space.
- Check that your account can write to Saved log folder.
- If needed, select a different writable log folder and save.
- Check that the warning clears.
Vault can omit log records while storage is unavailable or logging cannot keep up. The page reports the number omitted during the current session. After recovery, the log also reports omitted records. A gap in logs does not by itself mean a backup failed.
6.6 Collect information for support
Use the log folder shown in Settings > Logging. Vault has no support bundle export.
- Note what you did, what you expected, and what happened.
- Record the time and time zone of the problem.
- Copy Version and Build from Settings > About.
- Include the exact message shown by Vault.
- If requested, select Debug, save, and repeat the problem once.
- Copy
vault.logand any archives that cover the problem time. - Return logging to Info and save.
Review screenshots and files before sharing them. Email logs to North Shore Automation support at support@northshoreautomation.com. Do not include license codes, tokens, secrets, browser approval links, or your full backup unless support specifically arranges it. Do not send Vault's application data folder as a routine log collection.
Connection diagnostics omit tokens, client secrets, approval secrets, response bodies, account details, and signed preview links. Still review the files for information your organization does not want to share.
6.7 Connection failure evidence
Connection checks use the same folder, level, size limit, and retention as other logs. Select Debug before retrying if support needs timing or successful request details. Note the time of the failed attempt. Send the logs that cover that time to support@northshoreautomation.com. See Troubleshooting for recovery steps.