Log Files

Topics | How To | Support | Related Topics

Overview

View Log Files

• View Log Files From a CommServe, SRM Server, MediaAgent, or Client
• View the Log Files of an Active Job
• View the Log Files of a Job in a Job History Window

Send Log Files

• Send Log Files from the CommCell Console
• Send Log Files from the Command Line
• Send Log Files via FTP or HTTP
• Set the Maximum Size for Email Bundles
• Send Log Files from the Workstation Backup Agent Client Console

Customize Log Files

• Setting the Maximum Size of Log Files
• Setting the Maximum Number of Backup Log Files
• Setting the Maximum Size of Media Manager Log Files
• Setting the File Format for sending the Log Files
• Enabling Passive FTP Connection
• Setting the Timeout Value for Sending Log Files via FTP
• Changing the Location of Log Files

Overview

Log files provide the processing details of operations that have occurred on your system.

The software allows you to view and send these log files from the CommCell Console stand-alone or remote web-based applications. You can also send log files from the Command Line or upload them to an existing FTP server.

The maximum default size of the log files is 5 MB. When the maximum size is reached, the file is rolled over to <filename>_1.log. You change the maximum default size of the log files by using the NMaxLogFileSize registry key.

Note that the dates and times of the log files pertaining to CommServe and SRM Server services are not updated until these services are stopped and restarted, even if the log files are updated in the interim. These log files are:

• CVD.log
• EvMgrS.log
• JobManager.log
• MediaManager.log
• CVMA.log

In addition to log files, there are other ways you can obtain information about conditions within the CommCell, such as from configured Alerts, or by events reported in the Event Viewer.

View Log Files

The View Log Files feature allows you to view log files from the CommCell Console for any of the following:

• A CommServe, SRM Server, MediaAgent, or client.
• An active job in the Job Controller.
• A job in a job history window.

In a cluster, the log files reside on the physical computer that is the active node. If a failover has occurred, View Log Files will only show the logs of the current active node, and thus, only processing details of operations that occurred after the failover; Send Log Files will collect all cluster log files from passive nodes as well, and thus, processing details of operations that occurred before the failover.

The following sections describe the methods with which you can view log files:

View Log Files From a CommServe, SRM Server, MediaAgent, or Client

Use the View Log Files option to view the log files of a selected CommCell resource.

The log files that reside on a given computer may differ depending on the role of the computer in the CommCell (CommServe, SRM Server, MediaAgent, Client). A CommServe computer contains only the CommServe log files. A computer that is both a CommServe and a Client contains the log files of both entities.

For step-by-step instructions, see View the Log Files of a CommServe, SRM Server, MediaAgent, or Client Computer.

View the Log Files of an Active Job

You can view the log files of an active job in the Job Controller by using the View Logs option.

Once the View Logs option is selected, the log files related to the active job is displayed in the View Log File for Job n window. You can also send the log files by page to an email recipient by selecting the Send Page option in the View Log File for Job n window and entering the email recipient's SMTP Parameters.

For step-by-step instructions, see View the Log Files of an Active Job.

For more information on the Job Management feature, specifically for active jobs, see Job Management.

View the Log Files of a Job in a Job History Window

You can view the log files of a job in a Job History window by using the View Logs option. Note that the following example illustrates a Data Protection Job History window.

Once the View Logs option is selected, the log files related to the job history is displayed in the View Log File for Job n window.

For step-by-step instructions, see View the Log Files of a Job History.

For more information on the Job History feature, see Job History.

Send Log Files

The Send Log Files feature allows you to send or save log files by:

• Emailing the log files to one or more email recipients.
• Uploading the log files to an existing FTP server.
• Saving the log files to a specified location on the CommServe computer.

If a particular job spans into multiple log files, the logs will only be retrieved from the most current log file and the previously saved log file, e.g., JobManager.log and JobManager_1.log.

In a cluster, the log files reside on the physical computer that is the active node. If a failover has occurred, Send Log Files will collect all cluster log files from passive nodes as well, and thus, processing details of operations that occurred while other physical computers served as the active node. Log files can be configured to be sent via e-mail to user groups created from within the CommCell Console as well as external domain user groups.

The following sections describe the methods with which you can send or save log files:

Send Log Files from the CommCell Console

Log files can be sent or saved from the CommCell Console using the Send Log Files dialog box.

You can send or save several types of log files from one or more computer(s), including:

• CommCell Information, which can include the CommServe database logs, SRM database logs, or SQL database logs.
• Computer Information, which can include either the log files for a specific job run within the CommCell, or the log files for all jobs run on the selected CommCell computer(s).
• Machine Information, which can include file system and application state logs, as well as information on commands and system failures.
• Log files created during a specified Time Range.

By default, prior to sending or saving log files, all the selected log files are automatically bundled into a .cab file. If you want, you can save or send these logs files in the .zip file format by using the bSendLogUseZIP registry key. For setting the file format for the log files that you want to send or save, see Setting the File Format for sending the Log Files.

Before sending an email, you must set-up the email server within the CommCell Console.  See E-Mail Server Configuration for more information.

For step-by-step instructions, see the following procedures:

• Send Log Files
• Send Log Files To a Remote Computer

Send Log Files from the Command Line

Log files can be sent from the command line by using the sendLogFiles.exe utility located in the <software installation path>\Base folder. The log files are sent to the specified recipient e-mail address or stored on a local directory on the CommServe computer in a cab file (*.cab).

If you want, you can save or send these logs files in the .zip file format by using the bSendLogUseZIP registry key. For more information, see Setting the File Format for sending the Log Files.

You can choose to send log files at the command line using one of two methods:

• Manually entering each command at the command prompt. This option is useful if you wish to use a set of commands that you might not otherwise use on a frequent basis.
• Creating an input file containing all the commands in either .txt or .doc formats. This option is useful if you routinely send log files using a set of commands that differ only slightly from one send log files operation to another.

You can also create custom commands that can collect additional information during all Send Log Files operations.

For command line usage and arguments, see Command Line Interface - Send Log Files.

Send Log Files via FTP or HTTP

Log files can be sent to an existing FTP or HTTP server using either of the following methods:

• From the Command Line (FTP only) (see Command Line Interface - Send Log Files for step-by-step instructions).
• From the Send Log Files dialog box in the CommCell Console (see Send Log Files for step-by-step instructions).

To configure FTP or HTTP settings for sending log files, you can use the Troubleshooting Settings dialog box located in the CommCell Console's Control Panel. This dialog box is also accessible through the Settings button found in the Send Log Files dialog box. For step-by-step instructions, see Configure Troubleshooting Settings.

Set the Maximum Size for Email Bundles

Log file bundles may exceed the maximum allowed size for some email servers. In such cases, the software provides the capability to send the log file bundles to the designated recipient using multiple emails. If a bundle exceeds the maximum allowed size, a separate email with the remainder of the bundle will be sent to the designated recipient.

Once the recipient saves the log files to disk, the log files can be concatenated into their original form by performing the following steps:

1. From the command line, enter the following:

   copy /B <source_directory>\<log_file_01_name> + <source_directory>\<log_file_02_name> /B c:\<concatinated _log_file_name>.CAB

2. Open <concatinated _log_file_name>.CAB using WinZip.

For step-by-step instructions on setting the maximum size for email bundles, see Set the Maximum Size for Email Bundles.

Send Log Files from the Workstation Backup Agent Client Console

Workstation Backup clients send log files using the Send Logs option from the Client Console. See Send Log Files from the Workstation Backup Client Console for step-by-step instructions. By default the log files are sent to the <software Installation Path>\Log Files\WBALogs\<Client Name> folder on the CommServe computer.

The log files can also be directed to an existing FTP server. See Configure FTP Settings for Workstation Backup Clients for step-by-step instructions.

Customize Log Files

A log file can be customized to replace words of a log file with custom-defined words. The words to be replaced and their substitutes are defined in a simple text file called a dictionary file.

The ScrubLogFiles utility in the Resource Pack takes this dictionary file as input along with the input file specification and the output folder in which it is to place the modified files. For each file in the input file specification, it replaces the words defined in the dictionary file.

Setting the Maximum Size of Log Files

This registry key defines the maximum size of a specific log file. The size of the log file is measured in megabytes (MB). If the size of the file is greater than the value in the registry key, an additional log file is created with the name, <filename>_1.log.

To create this registry key:

1. From the CommCell Browser, expand Client Computers.
2. Right-click the <Client> in which you want to add the registry key, and then click Properties.
3. Click the Registry Key Settings tab.
4. Click Add.
5. On Windows in the Name box, type <logfile>_MaxLogFileSize. On UNIX in the Name box, type <logfile>_MAXLOGFILEZIE
6. In the Location list, type one of the following:
   • On a Windows computer, type HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\EventManager.
   • On a UNIX computer, type /etc/CommVaultRegistry/Galaxy/Instance<xxx>/EventManager/.properties.
7. In the Type list, select REG_DWORD.
8. In the Value box, enter a numeric value between 10 and 50, and then click OK.

   The registry key appears in the list on the Registry Key Settings tab.

9. In the Client Computer Properties dialog box, click OK.

For more information, see the entry in Registry Keys.

Setting the Maximum Number of Backup Log Files

This registry key defines the maximum number files that can be created for a specific backup log file.

1. From the CommCell Browser, expand Client Computers.
2. Right-click the <Client> in which you want to add the registry key, and then click Properties.
3. Click the Registry Key Settings tab.
4. Click Add.
5. On Windows in the Name box, type <logfile>_MaxLogFileBackups. On UNIX in the Name box, type <logfile>_MAXLOGFILEBACKUPS.
6. In the Location list, type one of the following:
   • On a Windows computer, type HKEY_LOCAL_MACHINE\Software\CommVault Systems\Galaxy\Instance<xxx>\EventManager.
   • On a UNIX computer, type /etc/CommVaultRegistry/Galaxy/Instance<xxx>/EventManager/.properties.
7. In the Type list, select REG_DWORD.
8. In the Value box, enter a numeric value between 10 and 50, and then click OK.

   The registry key appears in the list on the Registry Key Settings tab.

9. In the Client Computer Properties dialog box, click OK.

For more information, see the entry in Registry Keys.

Setting the Maximum Size of Media Manager Log Files

Use the following steps to set the maximum size of the MediaManager log file and the number of log files to retain

1. Navigate to C:\Program Files\Bull Calypso\Calypso\Base folder
2. Double-click the SetLogParamsGUI file.
3. Click the CommServe tab.
4. Under Applications, select the MediaManager checkbox and modify the following log parameters:
   • LogFileSize(MB) - to set the maximum size for Media Manager log files.
   • LogFileMaxVer - to set the maximum number of Media Manager log files to retain.

Setting the File Format for Sending the Log Files

By default, prior to sending or saving log files, all the selected log files are automatically bundled into a single .cab file. If you want, you can send or save these log files in the .zip file format.

Use the following steps for setting the file format for sending and saving log files in .zip file format.

1. From the CommCell Browser, expand Client Computers.
2. Right-click the <Client> on which the CommServe resides, and then click Properties.
3. Click the Registry Key Settings tab.
4. Click Add.
5. In the Name box, type bSendLogUseZIP.
6. In the Location list, type or select Commserve.
7. In the Type list, select REG_DWORD.
8. In the Value box, type 0.
9. The registry key appears in the list on the Registry Key Settings tab.
10. Click OK.

Enabling Passive FTP Connection

If you are using FTP server to upload the log files, by default, the client connects to the Server through port 21 of the Server. However, you can enable a passive FTP connection, wherein the client first receives the port number to be used for connection from the Server and then connects to the Server using the specific port number.

Use the following steps to enable passive FTP connection:

1. From the CommCell Browser, expand Client Computers.
2. Right-click the <Client> on which the CommServe resides, and then click Properties.
3. Click the Registry Key Settings tab.
4. Click Add.
5. In the Name box, type nFTPPASSIVEFLAG.
6. In the Location list, type or select Commserve.
7. In the Type list, select REG_DWORD.
8. In the Value box, type 1.
9. The registry key appears in the list on the Registry Key Settings tab.
10. Click OK.

Setting the Timeout Value for Sending Log Files via FTP

Because sending large log files via FTP can take a long time, the operation sometimes times out. You can set the KeepAliveTimeout registry key to specify the timeout length in milliseconds. For more information, see the entry in Registry Keys.

To set the timeout length for FTP uploads:

Open Registry Editor (Regedit.exe or Regedt32.exe). Expand HKEY_CURRENT_USER > Software > Microsoft > Windows > CurrentVersion, and then click InternetSettings. Click the Edit menu, point to New, and then select DWORD Value. Enter KeepAliveTimeout as the regisry key name, and then press ENTER.
Select the KeepAliveTimeout registry key, click the Edit menu, and then select Modify. The Edit DWORD Value dialog box appears. In the Value data box, enter the amount of time, in milliseconds, that you want to wait before the upload times out. For example, if you want the upload to time out after 2 minutes, enter 120000. Click OK to save your settings.

Changing the Location of Log Files

You can change the location in which log files are saved with the dEVLOGDIR registry key. For more information, see the entry in Registry Keys.

To change the location in which log files are saved:

1. From the CommCell Browser, expand Client Computers.
2. Right-click the <Client> on which the CommServe resides, and then click Properties.
3. Click the Registry Key Settings tab.
4. Click Add.
5. In the Name box, type dEVLOGDIR.
6. In the Location list, type or select EventManager.
7. In the Type list, select STRING.
8. In the Value box, type the location to which you want to save log files.

   For example:

   c:\log_files

9. Click OK.

   The registry key appears in the list on the Registry Key Settings tab.

10. To ensure that this change takes effect, restart client services.

Back To Top