About the analysis utilities for NetBackup debug logs
The debug log analysis utilities enhance NetBackup's existing debug capabilities by providing a consolidated view of a job debug log.
NetBackup jobs span multiple processes that are distributed across servers.
To trace a NetBackup job you must view and correlate messages in multiple log files on multiple hosts. The log analysis utilities provide a consolidated view of the job debug logs. The utilities scan the logs for all processes that are traversed or run for the job. The utilities can consolidate job information by client, job ID, start time for the job, and policy that is associated with the job.
Table: Analysis utilities for NetBackup debug logs describes the log analysis utilities. To see the parameters, limitations, and examples of use for each utility, use the command with the -help option. All the commands require administrative privileges. The log analysis utilities are available for all platforms that are supported for NetBackup servers.
Note:
The utilities must be initiated on supported platforms. However, the utilities can analyze debug log files from most NetBackup client and server platforms for UNIX and Windows.
Table: Analysis utilities for NetBackup debug logs
Utility | Description |
|---|---|
Consolidates the debug log messages for specified NetBackup database backup jobs and writes them to standard output. It sorts the messages by time. backupdbtrace attempts to compensate for time zone changes and clock drift between remote servers and clients. At a minimum, you must enable debug logging for admin on the primary server, and for bptm and bpbkar on the media server. For best results, set the verbose logging level to 5 and enable debug logging for the following: bpdbm on the primary server and bpcd on all servers in addition to the processes already identified. A complete description of backupdbtrace is in the NetBackup Commands Reference Guide. | |
backuptrace | Copies to standard output the debug log lines relevant to the specified backup jobs, including online (hot) catalog backups. The backuptrace utility can be used for regular file system, database extension, and alternate backup method backup jobs. It consolidates the debug logs for specified NetBackup jobs. The utility writes the relevant debug log messages to standard output and sorts the messages by time. backuptrace attempts to compensate for time zone changes and clock drift between remote servers and clients. The format of the output makes it relatively easy to sort or grep by timestamp, program name, and server or client name. The backuptrace utility works with the nbpem, nbjm, and nbrb logs on the primary server. You should enable debug logging for bpbrm and bptm or bpdm on the media server and for bpbkar on the client. For best results, set the verbose logging level to 5. Enable debug logging for the following: bpdbm and bprd on the primary server and for bpcd on all servers and clients in addition to the processes already identified. A complete description of backuptrace is in the NetBackup Commands Reference Guide. |
bpgetdebuglog | A helper program for backuptrace and restoretrace. It can also be useful as a standalone program and is available for all NetBackup server platforms. bpgetdebuglog prints to standard output the contents of a specified debug log file. If only the remote machine parameter is specified, bpgetdebuglog prints the following to standard output: the number of seconds of clock drift between the local computer and the remote computer. A complete description of bpgetdebuglog is in the NetBackup Commands Reference Guide. |
duplicatetrace | Consolidates the debug logs for the specified NetBackup duplicate jobs and writes them to standard output. It sorts the messages by time. duplicatetrace attempts to compensate for time zone changes and clock drift between remote servers and clients. At a minimum, you must enable debug logging for admin on the primary server and for bptm or bpdm on the media server. For best results, set the verbose logging level to 5 and enable debug logging for the following: bpdbm on the primary server and bpcd on all servers and clients in addition to the processes already identified. A complete description of duplicatetrace is in the NetBackup Commands Reference Guide. |
importtrace | Consolidates the debug log messages for the specified NetBackup import jobs and writes them to standard output. It sorts the messages by time. importtrace attempts to compensate for time zone changes and clock drift between remote servers and clients. At a minimum, you must enable debug logging for admin on the primary server. And for bpbrm, you must enable debug logging for bptm and tar on the media server. For best results, set the verbose logging level to 5 and enable debug logging for the following: bpdbm on the primary server and bpcd on all servers and clients in addition to the processes already identified. A complete description of importtrace is in the NetBackup Commands Reference Guide. |
restoretrace | Copies to standard output the debug log lines relevant to the specified restore jobs. The restoretrace utility consolidates the debug logs for specified NetBackup restore jobs. The utility writes debug log messages relevant to the specified jobs to standard output and sorts the messages by time. restoretrace attempts to compensate for time zone changes and clock drift between remote servers and clients. The format of the output makes it relatively easy to sort or grep by timestamp, program name, and server or client name. At a minimum, you must enable debug logging for bprd on the primary server. Enable debug logging for bpbrm and bptm or bpdm on the media server and tar on the client. For best results, set the verbose logging level to 5. Enable debug logging for bpdbm on the primary server and for bpcd on all servers and clients. A complete description of restoretrace is in the NetBackup Commands Reference Guide. |
verifytrace | Consolidates the debug log messages for the specified verify jobs and writes them to standard output. It sorts the messages by time. The verifytrace command attempts to compensate for time zone changes and clock drift between remote servers and clients. At a minimum, you must enable debug logging as follows: for admin on the primary server and for bpbrm, bptm (or bpdm) and tar on the media server. For best results, set the verbose logging level to 5 and enable debug logging for the following: bpdbm on the primary server and bpcd on all servers and clients in addition to the processes already identified. A complete description of verifytrace is in the NetBackup Commands Reference Guide. |
The analysis utilities have the following limitations:
Media and device management logs are not analyzed.
The legacy debug log files must be in standard locations on the servers and clients.
UNIX
/usr/openv/netbackup/logs/<PROGRAM_NAME>/log.mmddyy
Windows
install_path\NetBackup\Logs\<PROGRAM_NAME>\mmddyy.log
An option may be added later that allows the analyzed log files to reside on alternate paths.
Note:
For the processes that use unified logging, log directories are automatically created.
The consolidated debug log may contain messages from unrelated processes. You can ignore messages with timestamps outside the duration of the job from the following: bprd, nbpem, nbjm, nbrb, bpdbm, bpbrm, bptm, bpdm, and bpcd.
An output line from the log analysis utilities uses the following format:
daystamp.millisecs.program.sequence machine log_line
daystamp | The date of the log that is in the format yyyymmdd. |
millisecs | The number of milliseconds since midnight on the local computer. |
program | The name of program (BPCD, BPRD, etc.) being logged. |
sequence | Line number within the debug log file. |
machine | The name of the NetBackup server or client. |
log_line | The line that appears in the debug log file. |
For more information, see the NetBackup Commands Reference Guide.