Enable DEBUG mode in Storware Backup and Recovery

This guide explains how to enable debug mode for troubleshooting or detailed logging. The operation involves connecting to the server via SSH and editing a configuration file.

Available log levels

LEVEL	DESCRIPTION
INFO	Provides general operational messages to confirm that the software is functioning as expected
DEBUG	Offers detailed diagnostic information to help developers troubleshoot issues
TRACE	Provides the most granular level of detail, often used to trace the execution of specific code paths

Changing log level in the Storware Backup and Recovery components

Server

1. Connect to the server host using SSH

2. Open the following file for editing /opt/vprotect/server/quarkus.properties Example:

   vi /opt/vprotect/server/quarkus.properties

3. Locate the line in the file that controls the logging mode quarkus.log.category."eu.storware".level=INFO The default value for the logging level is INFO

4. Set the value to INFO, DEBUG or TRACE

5. Save the file

6. Restart the service:

   systemctl restart vprotect-server

Node

1. Connect to the node host using SSH

2. Open the following file for editing /opt/vprotect/node/log4j2-node.xml Example:

   vi /opt/vprotect/node/log4j2-node.xml

3. Locate the line in the file that controls the logging mode <Property name="logLevel">INFO</Property> The default value for the logging level is INFO

4. Set the value to INFO, DEBUG or TRACE

5. Save the file

6. Restart the service:

   systemctl restart vprotect-node

Tape manager

1. Connect to the tape manager host using SSH

2. Open the following file for editing /opt/vprotect/tapemanager/config/application.properties Example:

   vi /opt/vprotect/tapemanager/config/application.properties

3. Locate the line in the file that controls the logging mode quarkus.log.level=INFO The default value for the logging level is INFO

4. Set the value to INFO, DEBUG or TRACE

5. Save the file

6. Restart the service:

   systemctl restart vprotect-server

Cloud agent

1. Connect to the node host using SSH

2. Open the following file for editing /opt/vprotect/cloudagent/AgentConfig.json Example:

   vi /opt/vprotect/cloudagent/AgentConfig.json

3. In the JSON file, find the logs section nested under the agent key

4. Add the following key to the logs section "level": "INFO" The default value for the logging level is INFO. Set the value to INFO, DEBUG or TRACE. After the modification, the section should look like this:

   agent": { 
       "logs": { 
           "path": "../logs/cloudagent", 
           "level": "DEBUG" 
       } 
   }

5. Save the file

6. Restart the node service:

   systemctl restart vprotect-node

OS agent

1. Connect to the client host

2. Open the following file for editing Windows system: C:\ProgramData\sbr-osagent\osagent.properties Linux system: /opt/vprotect/osagent MacOS system: /Library/Application Support/osagent

3. Locate the line in the file that controls the logging mode osagent.logs.level=INFO The default value for the logging level is INFO

4. Set the value to INFO, DEBUG or TRACE

5. Save the file

6. Restart the service:

   Windows

   sc stop sbr-osagent && sc start sbr-osagent

   Linux

   systemctl restart sbr-osagent

   MacOS

   sudo launchctl stop eu.storware.sbr.osagent
   sudo launchctl start eu.storware.sbr.osagent

Cloud server

1. Connect to the node host using SSH

2. Open the following file for editing /opt/vprotect/cloudserver/config/application.properties Example:

   vi /opt/vprotect/cloudserver/config/application.properties

3. Locate the line in the file that controls the logging mode quarkus.log.level=INFO The default value for the logging level is INFO

4. Set the value to INFO, DEBUG or TRACE

5. Save the file

6. Restart the node service:

   systemctl restart vprotect-node

OS server

1. Connect to the tape manager host using SSH

2. Open the following file for editing /opt/vprotect/tapemanager/config/application.properties Example:

   vi /opt/vprotect/osserver/config/application.properties

3. Locate the line in the file that controls the logging mode quarkus.log.level=INFO The default value for the logging level is INFO

4. Set the value to INFO, DEBUG or TRACE

5. Save the file

6. Restart the node service:

   systemctl restart vprotect-node