Article Number: 000022610
NetWorker VMware Protection (NVP)-vProxy: How to Enable Debug Logging
Summary: Changing the log level to 'debug' may be necessary in order to troubleshoot an issue with the NetWorker VMware Protection with the vProxy Appliance solution (NVP-vProxy). This article explains how to change the log level. ...
Article Content
Instructions
Video: How to Enable vProxy Debug Logging
Watch on YouTube
Usually, it is sufficient to analyze the policy logs in the NetWorker server in .../nsr/logs/policy/[policy name], but occasionally it may be necessary to analyze the logs on the vProxy appliance itself and, furthermore, to increase the logging level to 'debug' in order to get a clearer idea of the reason for a failure. This is typically only a requirement once NetWorker support has been engaged and the support engineer has requested to debug set to troubleshoot as specific process.NVP-vProxy log files on the vProxy appliance are in the following directory:
/opt/emc/vproxy/runtime/logs
There is a subdirectory for each of the principal processes which are used for NetWorker operations on the vProxy appliance:
- vbackupd
- vflrd
- vrapid
- vrecoverd
[session-uuid].log Processing details for a session
vbackupd-engine.log Requests and problem events including error and panic messages from the session log.
vbackupd-boost.log DD Boost logging.
vbackupd-snapmgr.log Snapshot logging
vbackupd-vddk.log VDDK logging - VMware Virtual Disk Development Kit
vbackupd-engine.log Requests and problem events including error and panic messages from the session log.
vbackupd-boost.log DD Boost logging.
vbackupd-snapmgr.log Snapshot logging
vbackupd-vddk.log VDDK logging - VMware Virtual Disk Development Kit
Additional information on vProxy logging and collection can be found in: NVP-vProxy Triage Guide: NetWorker VMware Protection vProxy Triage and Log Collection Guide
Applying Service Debug Method 1:
This method applies to vProxy's version 4.3.x and later. It can be used to enable debug on vProxy services (vbackupd, vflrd, vrapid, vrecoverd). Additional debugging can be enabled for DD Boost traffic, VDDK, and snapshot messaging (where applicable).
1. Connect to the vProxy over SSH using the vProxy admin account.
2. Switch to root: sudo su -
3. Change to the vProxy agent bin directory: cd /opt/emc/vproxy/bin
4. For the service you want to debug run the following command:
Backup Engine: vbackupd
1. Connect to the vProxy over SSH using the vProxy admin account.
2. Switch to root: sudo su -
3. Change to the vProxy agent bin directory: cd /opt/emc/vproxy/bin
4. For the service you want to debug run the following command:
Backup Engine: vbackupd
| Daemon | Logging Entity | Command Usage Example | Log Locations |
| vbackupd | program (main engine) | ./vProxy_debug.sh -s -d vbackupd -p program -l debug | /opt/emc/vrproxy/runtime/logs/vbackupd/vbackupd-engine.log Individual Backup Session Logs: |
| DD Boost | ./vProxy_debug.sh -s -d vbackupd -p ddboost -l all | /opt/emc/vrproxy/runtime/logs/vbackupd/vbackupd-boost.log | |
| VDDK | ./vProxy_debug.sh -s -d vbackupd -p vddk -l 4 | /opt/emc/vrproxy/runtime/logs/vbackupd/vbackupd-vddk.log The VDDK also maintains private logs in the directory /tmp/vmware-root |
|
| Snapshot Manager | ./vProxy_debug.sh -s -d vbackupd -p snapshotmgr -l debug | /opt/emc/vrproxy/runtime/logs/vbackupd/vbackupd-snapmgr.log |
Recover Engine: vrecoverd
| Daemon | Logging Entity | Command Usage Example | Log Locations |
| vrecoverd | program (main entity) | ./vProxy_debug.sh -s -d vrecoverd -p program -l debug | /opt/emc/vrproxy/runtime/logs/vrecoverd/vrecoverd-engine.log Individual Recover Session Logs: |
| DD Boost | ./vProxy_debug.sh -s -d vrecoverd -p ddboost -l all | /opt/emc/vrproxy/runtime/logs/vrecoverd/vrecoverd-boost.log | |
| VDDK | ./vProxy_debug.sh -s -d vrecoverd -p vddk -l 4 | /opt/emc/vrproxy/runtime/logs/vrecoverd/vrecoverd-vddk.log The VDDK also maintains private logs in directory /tmp/vmware-root |
FLR Engine: vflrd
REST Server: vrapid
| Daemon | Logging Entity | Command Usage Example | Log Location |
| vflrd | program (Main Engine) | ./vProxy_debug.sh -s -d vflrd -p program -l debug | /opt/emc/vrproxy/runtime/logs/vflrd/vflrd-engine.log Individual FLR Mount Session Logs: /opt/emc/vrproxy/runtime/logs/vflr/FlrMountSession-<session-id>.log Individual FLR Browse Session Logs: /opt/emc/vrproxy/runtime/logs/vflr/FlrBrowseSession-<session-id>.log Individual FLR Recover Session Logs: /opt/emc/vrproxy/runtime/logs/vflr/FlrRecoverSession-<session-id>.log Completed logs are moved to /opt/emc/vrproxy/runtime/logs/recycle/vflrd |
| DD Boost | ./vProxy_debug.sh -s -d vflrd -p ddboost -l all | /opt/emc/vrproxy/runtime/logs/vflrd/vflrd-boost.log | |
| VDDK | ./vProxy_debug.sh -s -d vflrd -p vddk -l 4 | /opt/emc/vrproxy/runtime/logs/vrecoverd/vrecoverd-vddk.log The VDDK also maintains private logs in directory /tmp/vmware-root |
REST Server: vrapid
| Daemon | Logging Entity | Command Usage Example | Log Location |
| vrapid | program (Main Engine) | ./vProxy_debug.sh -s -d vrapid -p program -l debug | /opt/emc/vrproxy/runtime/logs/vrapid/vrapid-engine.log |
The above commands show enabling debug, these commands can be rerun changing the -l option to reset to default:
Options:
For Program Log: warn | info | trace (default) | debug
For DD Boost Log: none | error | warn | info | debug | trace (default) | all
For VDDK Log:
0 = No logging
1 = Errors only
2 = Warnings and Errors
3 = Important information messages, errors and warnings (default)
4 = Debug data plus everything else
For Snapshot Manager Log: warn | info | trace (default) | debug
Applying Service Debug Method 2:
The available logging levels are: none,error,warn,info,trace,debug
In order to set the vbackupd process into logging level 'debug':
In order to set the vbackupd process into logging level 'debug':
1. Log in to the vProxy Appliance as admin over ssh or console and switch to root: sudo su -
2. Go to the systemd directory: cd /usr/lib/systemd/system/
2. Go to the systemd directory: cd /usr/lib/systemd/system/
NOTE: Each of the service files are found here: vbackupd.service, vfrld.service, vrapid.service, vrecoverd.service, so on
3. Open the service file that you want to apply debug on, e.g: vi vbackupd.service
4. Locate the line with ExecStart= and append --program-log-level=debug
4. Locate the line with ExecStart= and append --program-log-level=debug
Other parameters:
--engine-log-level=string
vProxy 2.x engine log level: { debug, trace, info, warn }.
--program-log-level=string (vbackupd)
vProxy 3.x and later engine level: { debug, trace, info, warn } (default "trace")
--version
Display version
NOTE: The NVP-vProxy version is shown in the 'Configuration' tab of the vProxy properties in the NetWorker Management Console:
NMC -> Devices -> VMware Proxies -> Right Click on the vProxy appliance -> Properties -> Configuration Tab -> VM proxy version
NMC -> Devices -> VMware Proxies -> Right Click on the vProxy appliance -> Properties -> Configuration Tab -> VM proxy version
5. Save the changes to the file
6. Reload the unit configuration file by typing the command:
systemctl daemon-reload
7. Confirm in the NetWorker Management Console that no backups are currently running and then restart the vbackupd service:
systemctl restart vbackupd.service
The above process is applicable for the services: vrapid, vrecoverd, vbackupd, and vflrd.
Applying VDDK Debug:
1. Log in to the vProxy appliance using SSH or console as admin and switch to root: sudu su -
2. Edit the VixDiskLib.config file to contain the following line: vi /opt/emc/vproxy/conf/VixDiskLib.config
2. Edit the VixDiskLib.config file to contain the following line: vi /opt/emc/vproxy/conf/VixDiskLib.config
vixDiskLib.transport.LogLevel=4
0 = No logging
1 = Errors only
2 = Warnings, and Errors
3 = Important information messages, errors, and warnings
4 = Debug data plus everything else
3. Restart the relevant service:
systemctl restart [service-name].service
For example: systemctl restart vrecoverd.service
systemctl restart [service-name].service
For example: systemctl restart vrecoverd.service
Once you have set the debug logging level, you can confirm that there are messages in the relevant log file which start with the word 'Debug'
After completing the debugging process, you can reset the log level using the same procedure, using the word 'trace' after the equal sign instead of 'debug'. In order for this to immediately applicable, the daemon reload and restart will be needed as outlined above.
DDBoost Precert Debugging:
This process can be done with other debugging methods outlined above.
1. Log in to the vProxy appliance using SSH or console as admin and switch to root: sudu su -
2. Create file ddboost_precert.ini under /: touch /ddboost_precert.ini
3. Create the DDLog directory: mkdir /DDLog
4. Enable DD Boost debug for the service (vbackupd, vflrd, vrecoverd) you want to debug:
vbackupd: /opt/emc/vproxy/bin/vProxy_debug.sh -s -d vbackupd -p ddboost -l debug
vflrd: /opt/emc/vproxy/bin/vProxy_debug.sh -s -d vflrd -p ddboost -l debug
vrecoverd: /opt/emc/vproxy/bin/vProxy_debug.sh -s -d vrecoverd -p ddboost -l debug
5. Confirm that the ddboost_precert.log log is generated: ls -l /DDLog
When debug operations are no longer required, rerun the vProxy_debug.sh command again with -l trace
Additional Information
Article Properties
Affected Product
NetWorker
Product
NetWorker, NetWorker Series
Last Published Date
16 Apr 2024
Version
9
Article Type
How To