Collecting Logs

There are several ways to generate log files from the Catalogic DPX environment. You can use either of the graphical interfaces or one of the built-in utilities available through SSH.

Note. The main purpose of collecting logs is to help diagnose issues, improve performance, and ensure system security. Logs provide valuable insights into the application’s behavior, allowing us to enhance user experience and maintain reliable service.

We recommend using log-collecting utilities upon request of the Catalogic Software Data Protection Technical Support team.

Take the following steps to collect job logs from Catalogic DPX:

Web interface

1. Go to the Job Monitor section.

2. In the job list, click More Actions ⋯ next to the job whose logs you want to collect and select either one of the following items:

   • Run instance log collection Download a job log of the selected job. The log file is compressed and archived in .ZIP format. The .ZIP file name is instance-log-collection_<job_name>.zip.

   • Run job log collection Download a collection of all jobs in the entire Catalogic DPX. The log file is compressed and archived in .TAR and .ZIP format. The .ZIP file name is job-collection-<job_name>.zip. Typically, this task takes a few minutes to complete.

Desktop interface

1. Open the Monitor Jobs tab or the Review Scheduled Jobs window from the task pane.

2. Right-click a job whose status is either Completed, Failed, or Canceled, and click one of the following options:

3. Collect Logs

   Collect and archive logs of the selected job in .TAR format, log-collection-<timestamp>.tar, where <timestamp> represents the start time of the last repetitive job in the UNIX time format.

4. Collect All Job Logs

   Collect and archive all job logs in .TAR format, and store this archive file: Master-job-logs-only.tar.

Ensure that you can open the log archive files in the logs directory of the Catalogic DPX Master Server.

See also. For more information, refer to the following sections and documents:

• Command-line interface tab on this page

• BEXCollect Usage in the Catalogic Software Knowledge Base.

A user can look at a log file using any file editor, either command-line or script-oriented, that opens ordinary text files.

To enable the Node-Based Logging model, you must turn on the Boolean environmental variable, SSCOMMONLOG, on each node. The Module-Based logs are generated regardless of this setting.

See also. For more information about setting variables, see Setting Environmental Variables for Logging Model and BEXCollect in the Reference Guide.

Command-line interface

DPX provides log collection utilities, such as DPX info collector and BEXcollect, for diagnostic purposes. The utilities gather informational files related to a specific job and other general information that may be required for diagnostic purposes. If you contact Catalogic Software Data Protection Technical Support, you may be asked to run the utility and send the results for analysis.

Running the DPX info collector

1. Log in to your DPX Master Server via SSH (see Connecting to DPX Master Server via SSH).

2. Navigate to /opt/catalogic/scripts/ and run ./dpx_info_collector.sh. After a while, a .ZIP archive under the name dpx-info-collection.zip will be created.

Running the BEXcollect utility

1. Log in to your DPX Master Server via SSH (see Connecting to DPX Master Server via SSH).

2. Navigate to /opt/DPX/bin/

3. Type one of the commands below.

Command	Comment
./bexcollect <job_id>	If using the older module-based logging model
./bexcollect -n <job_id>	The results will include common logs from the specified client node
./bexcollect -x <client_node_name>	The results will encompass all logs from the specified client node (Windows only)

The options are further described in Catalogic Knowledge Base article 47223 BEXCollect Usage.

Note. The 10-digit job ID can be easily found in Job Monitor in the job details.

The result of bexcollect is a set of .tar files placed in the logs directory of the product directory on the master server. The logs directory will contain two types of output files:

master-<jobid>.tar	This is the file for the master server.
<nodename>-<jobid>.tar	One file will appear for each node involved in the job.