Log Files - Advanced

Table of Contents

Viewing Log Files of a Job

In addition to viewing the log files of a selected CommCell component, you can also view the logs of a specific job. You can view log files for active jobs, completed jobs, and failed jobs. You can also find and view log files based on a specific job ID. This is useful in situations when you know the Job ID number but not aware of the client from where the job was run or the time when the job was run. If the job spans into multiple log files, the logs will be retrieved from the most current log file and the previously saved log file. For eg., jobmanager.log and jobmanager_1.log.

Jobs performed on SAP for Oracle clients also include the SAPBACKUP directory in a compressed format .

Active Jobs

  1. In the Job Controller tab, right-click the job and select View Logs.

    The log file for the selected job appears in the Log File dialog box.

  2. To close the log file, click Cancel.

Completed or Failed Jobs

  1. From the CommCell Browser, right-click client, point to View, and then click Job History.

    The Job History Filter dialog box appears.

  2. Click OK.

    The Data Management Job History tab appears.

  3. Right-click a job, and then select View Logs.

    The log file for the selected job appears in the Log File dialog box.

Based on Job ID

  1. From the CommCell Browser, right-click the CommServe, point to View and then select Logs by Job ID.

    The Logs by Job ID dialog box appears.

  2. In the Enter Job ID box, type the job ID number, and then click OK.

    The log file for the specified job ID appears in the Log File dialog box.

Scheduling a Send Log Files Job

Use the following steps to schedule a send log files operation for a job:

  1. From the CommCell Console ribbon, on the Home tab, click Job Controller.
  2. From the Job Controller window, right-click the desired job and then click Send Log Files.

    The Send Log Files dialog box is displayed.

  3. On the Job Initiation tab, select Schedule and then click Configure.

    The Schedule Details dialog box appears.

  4. Select the appropriate scheduling options.

    For information on the scheduling options, see Schedule Pattern.

  5. Click OK.

You can track the progress of the job from the Job Controller window of the CommCell Console.

Uploading Log Files to an FTP Location

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. On the Computers tab, select the name of the client computer for which you need the logs.
  3. On the CommCell Information tab, select the CommCell logs to be uploaded from the following list:
    • CommServe Database
    • Get Latest Database(s)
    • Database Logs
  4. On the Machine Information tab, select the client logs to be uploaded from the following list:
    • Logs
    • Machine Configuration
    • OS Logs
    • Process Dump
    • Job Results
    • Index
  5. On the Output tab, select Output to and browse to a local folder where the logs can be collected.

    Ensure that the Upload Logs and Email checkboxes are not selected.

  6. Click OK.
  7. When the operation is complete, upload the log files to http://upload.netapp.com (see NetApp KB article 1010090).

Enabling Passive FTP Connection

If you are using an 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, where 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. In the CommCell Console, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. On the Computers tab, select the name of the client computer for which you need the logs.
  3. On the Output tab, select the Use Passive FTP Connection check box.
  4. Click OK.

Upload Log Files to a Website

You can upload the log files to an HTTP web site that is defined in the Control Panel.

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. On the Computers tab, select the name of the client computer for which you need the logs.
  3. On the CommCell Information tab, select the CommCell logs to be uploaded from the following list:
    • CommServe Database
    • Get Latest Database(s)
    • Database Logs
  4. On the Machine Information tab, select the client logs to be uploaded from the following list:
    • Logs
    • Machine Configuration
    • OS Logs
    • Process Dump
    • Job Results
    • Index
  5. On the Output tab, select Upload, and then select Upload to HTTP Server.
  6. Click OK.

Change the Default HTTP Location

Use the following steps to change the default HTTP location.

  1. On the CommCell Console ribbon, click Home | Control Panel.
  2. Click Troubleshooting Settings.
  3. In the HTTP Location box, type the new HTTP location.
  4. In the HTTP User Name box, type the user account to access the HTTP location.
  5. In the Password box, type the password for the HTTP user account.
  6. In the Confirm Password box, type the password again.
  7. Click OK.

Use a Proxy Server

If the CommCell computer uses another computer to connect to the Internet, you must use that other computer as an HTTP proxy server for sending log files to an HTTP location. In the Control Panel, specify which computer to use as an HTTP proxy server.

  1. On the CommCell Console ribbon, click Control Panel.
  2.  Under Monitoring, click E-mail & Web Server Configuration.
  3. Click the Internet Gateway tab.
  4. Click Use HTTP Proxy Server.
  5. In the Proxy Server box, type the IP address of the proxy server.
  6. In the Proxy Port box, type the port number to be used for connection.
  7. If you need to configure user authentication for the proxy server, click Use Authentication.
    1. In the User Name box, type your user name for the proxy server.
    2. In the Password, box, type the password for your user on the proxy server.
    3. In the Confirm Password box, type the password again.
  8. Click OK.

Sending Log Files Using Email

To send log files immediately, you can send them to one or more email recipients. The email recipients can be user groups created within the CommCell Console as well as external domain user groups.

Caution: Log files can be large files, and emails with large file attachments are often rejected by email servers. To send an email notification instead of sending the log files by using email, see Setting Up Email Notifications.

Before You Begin

A mail server must be configured in the CommCell Console. For information on configuring an email server, see E-Mail Server Configuration.

Procedure

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. On the Computers tab, select the name of the client computer for which you need the logs.
  3. On the CommCell Information tab, select the CommCell logs to be uploaded from the following list:
    • CommServe Database
    • Get Latest Database(s)
    • Database Logs
  4. On the Machine Information tab, select the client logs to be uploaded from the following list:
    • Logs
    • Machine Configuration
    • OS Logs
    • Process Dump
    • Job Results
    • Index
  5. On the Output tab, select Attach logs to E-mails.

    Caution: Log files can be large files, and emails with large file attachments are often rejected by email servers.

  6. On the Notification tab, select the Email check box.
  7. In the Available Users and User Groups list, select the users who should receive the log files, and then click the right arrow button (>).
  8. In the Additional Recipients box, type the email addresses for additional users who are not part of the CommCell Group.
  9. In the Subject (Ticket Number) box, type the subject for the email notification.
  10. Optional: In the Problem Description box, type a description of the problem that requires troubleshooting.
  11. Click OK.

Configuring the Maximum Log Bundle Size for E-Mails

In some cases, when a log file bundle exceeds the maximum allowed size, a separate e-mail 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:\<concatenated _log_file_name>.CAB
  2. Open concatenated _log_file_name.CAB using the WinZip application.

Use the following steps to change the maximum bundle size for e-mails:

  1. From CommCell Console ribbon, click Control Panel.
  2. Click Email and IIS Configuration.

    The E-mail & IIS Configuration dialog box appears.

  3. In the Mail Server Size Limit (MB) box, type the maximum log bundle size for the e-mails.
  4. Click OK.

Saving Log Files to a Disk

You can save the selected logs to your local disk or to any network path using the following steps:

Saving Log Files to a Local Disk

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. On the Computers tab, select the name of the client computer for which you need the logs.
  3. On the CommCell Information tab and select the CommCell logs to be saved.
  4. On the Machine Information tab and select the client logs to be saved.
  5. On the Output tab, select the Output To check box.
  6. Select Local Path, and then in the box, type the path where the log files need to be saved.
  7. Click OK.

Saving Log Files to a Network Location

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. Select the name of the client computer for which you need the logs.
  3. Click the CommCell Information tab and select the CommCell logs to be saved.
  4. Click the Machine Information tab and select the client logs to be saved.
  5. Click the Output tab, and then click the Save tab.
  6. Select Output To, and then select Network Path.
  7. Click Impersonal User.

    The Change User Account dialog box appears.

  8. Select Use This Account.
  9. Type the user name and password that will be used to access the network location, and then click OK.
  10. In the box, type the network path where the log files are saved.

    Alternatively, you can click Browse to select the location.

  11. Click OK.

Sending Log Files for a Job

You can upload, save, or email the log files of a specific job based on the Job ID. Alternatively, you can email the log page of the job to an email recipient as described in Sending a Log File Page.

Use the following steps to send the log files of a specific job:

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. Click Job ID and type the job ID number in the box.
  3. Click the CommCell Information tab and select the CommCell logs to be saved.
    • CommServe Database
    • SRM Database
    • Get Latest Database(s)
    • Database Logs
  4. Click the Machine Information tab and select the client logs to be saved.
    • Logs
    • Machine Configuration
    • OS Logs
    • Process Dump
    • Job Results

      The Job Results option includes backup.out/restore.out files.

    • Index
  5. Click the Output tab and then select the output method to be used.
  6. Optional: To send an email notification concerning the send log files job, click the Notification tab. For information on log file notifications, see Setting Up E-Mail Notifications.
  7. Click OK.

You can also configure the send log files operation to include the output package of the cvsnapcore utility. The cvsnapcore utility collects the executable file and shared libraries from a core dump file. For more information, see FAQ - Collect the executable file and shared libraries from a core dump file.

Sending a Log File Page

Once you view the log file for a CommCell component or a job, you can send the existing log file contents to an email recipient using the following steps:

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to View and then select Log Files.
  2. In the Select the log file to open dialog box, select the log file, and then click Open.

    The selected log file appears in the Log File dialog box.

  3. Click File, and then select Send Page.

    The SMTP Parameters dialog box appears.

  4. In the SMTP Host box, type the SMTP host server address.

    If you are viewing the log files from a client other than the CommServe, make sure the SMTP host is same as the one configured on the CommServe.

  5. In the To box, type the e-mail address of the user to whom you want to send the log page.
  6. In the From box, type the e-mail address of the sender.
  7. In the Subject box, type the e-mail subject for the log page.
  8. Click OK.

Setting Up Email Notifications

When uploading log files to an FTP or HTTP location or saving the log files to a local or network location, you can configure a notification email to be sent to users when the upload or save operation completes or fails.

Use the following steps to set up e-mail notifications:

  1. From the CommCell Browser, right-click the CommServe, MediaAgent, or client, point to All Tasks, and then select Send Log Files.
  2. After making your log file selections, click the Notification tab.
  3. Select the Email check box.
  4. Select the users to notify from the Available User and User Groups list, and then use the right arrow button (>) to add them to the Users to be Notified list.
  5. In the Additional Recipients box, type the email address for additional users who are not part of the CommCell Group.
  6. In the Subject (Ticket Number) box, type the subject for the email notification.
  7. Optional: In the Problem Description box, type a description of the problem that requires troubleshooting.
  8. Click OK.

Setting the Debug Level

You can limit the type of log entries that are displayed in the log file with the additional setting, <logfilename>_DebugLevel.

The events in the log file are categorized from 1 to 5, where 5 is the highest level of detail in the log. If the information in the log files is not sufficient enough to determine the reason for failure, increase the debug level. Increasing the value increases the level of detail in the log.

Note: By default, when you change this setting, it resets to the default after 7 days.

Procedure

  1. From the CommCell Browser, right-click CommServe and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings on Windows Client dialog box appears.

  3. In the Name box, type <LogFileName>_DEBUGLEVEL. The Category and Type details will be automatically populated.

    Alternatively you can click Lookup and search for the additional setting using the Find box.

  4. In the Value box, type a number between 1 and 5.
  5. Click OK to save the additional setting configuration.
  6. Click OK to close the CommCell Properties dialog box.

Setting the Maximum Size of Log Files

The maximum default size of the log files is 5 MB. When the maximum size is reached, the file is rolled over to an additional file, <filename>_1.log.

You can also set the maximum number of versions of the log files that can be created when the log file reaches the maximum size. For more details on log file versions, see Setting the Default Maximum Number for Log File Versions.

For All Log Files

  1. From the CommCell Browser, right-click the CommServe computer, and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings dialog box appears.

  3. In the Name box, type NMaxLogFileSize.

    Alternatively you can click Lookup and search for the additional setting using the Find box.

  4. In the Category box, select EventManager.
  5. In the Type box, select Integer.
  6. In the Value box, type the log file size value between 5 and 10 MB.
  7. Click OK to save the additional setting configuration.

For a Specific Log File

You can set the maximum size of a specific log file using the following steps. If the file size reaches the specified limit, an additional log file is created with the name, <filename>_1.log.

  1. From the CommCell Browser, right-click the CommServe computer, and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings dialog box appears.

  3. In the Name box, type <LogFileName>_MAXLOGFILESIZE.
  4. In the Category box, select EventManager.
  5. In the Type box, select Integer.
  6. In the Value box, type a log file size value between 10 and 50 MB,  and then click OK.
  7. Click OK to save the additional setting configuration.

Setting the Default Maximum Number for Log File Versions

When the log file reaches its maximum size (5 MB), it is renamed as <filename>_1.log and a new log file, <filename>.log, is created. You can set the maximum number of versions to be created for the log files.

For example, when the size of the Evmgrs.log reaches 5 MB, it is renamed as Evmgrs_1.log and a new Evmgrs.log is created. If you have set the default maximum log file version for the Evmgrs.log to 5, then up to 5 versions of Evmgrs.log can be created.

Procedure

  1. Click the Start menu, and navigate to Commvault > Process Manager.
  2. Click the Logging tab.
  3. Under Module, to set the default maximum number of log file versions for a particular module, double-click the File Versions cell and set the value.

The following table lists the default maximum number of log file versions.

Note: For all the other log files, the maximum number of versions is 1.

Log Name Default maximum number of versions
archiveIndex.log 5
Auxcopy.log 5
AuxCopyMgr.log 5
CIReader.log 5
clBackup.log 5
CreateIndex.log 5
CVD.log 10
CVJobReplicator.log 5
CVMA.log 3
DataAging.log 3
DataVerf.log 5
DDBRecovery.log 5
FileScan.log 2
IndexCacheCleanup.log 5
IndexCacheServer.log 3
IndexingService.log 5
JobManager.log 3
LibraryServer.log 3
MediaManager.log 3
MediaManagerPrune.log 10
PSTMigrator.log 5
SnapManager.log 10
UpdateIndex.log 5
Vsbkp.log 5
Vsdiscovery.log 5
Vsvrst.log 5

Setting the Maximum Number of Backup Log Files

When a backup log file reaches the maximum size limit, it is rolled over to an additional file, <filename>_1.log. You can also set the maximum number of backup log files that can be created with an additional setting.

  1. From the CommCell Browser, right-click the CommServe computer, and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings dialog box appears.

  3. In the Name box, type <LogFileName>_MAXLOGFILEBACKUPS.
  4. In the Category box, select EventManager.
  5. In the Type box, select Integer.
  6. In the Value box, type a number between 1 and 5, and then click OK.

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

  7. Click OK to save the additional setting configuration.

Setting Timeout Period for Uploading Log Files

When uploading log files to an FTP location takes a long time, by default, the upload operation will timeout after 60000 milliseconds. You can change this default timeout period using the following steps:

  1. Open Registry Editor (Regedit.exe or Regedt32.exe).
  2. Expand HKEY_CURRENT_USER > Software > Microsoft > Windows > CurrentVersion, and then click InternetSettings.
  3. Click the Edit menu, point to New, and then select DWORD Value.
  4. Type KeepAliveTimeout as the registry key name, and then press ENTER.

  5. Select the KeepAliveTimeout registry key, click the Edit menu, and then select Modify.

    The Edit DWORD Value dialog box appears.

  6. 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.

  7. Click OK to save your settings.

Enabling Performance Counters for Log Files

You can enable logging of performance details in the log files for the File System iDataAgent, to monitor performance during backup or restore jobs. Logging of performance details can be enabled for a specific job, or for each file in a job.

For a Specific Job

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the client and click Properties.
  3. Click Advanced and then click Additional Settings tab.
  4. Click Add.
  5. In the Name field, type <LogFileName>_PERF. The Category and Type details will be automatically populated.
  6. In the Value field, type Y.
  7. Click OK to save the additional setting configuration.

For Each File

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the client and click Properties.
  3. Click Advanced and then click Additional Settings tab.
  4. Click Add.
  5. In the Name field, type <LogFileName>_PERF_FILE. The Category and Type details will be automatically populated.
  6. In the Value field type 'Y'.
  7. Click OK to save the additional setting configuration.

Customizing Log File Contents

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.

Changing Log File Location

You can change the location in which log files are saved with an additional setting.

To change the location in which log files are saved:

  1. From the CommCell Browser, right-click the CommServe, and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings on Windows Client dialog box appears.

  3. In the Name box, type dEVLOGDIR. The Category and Type details will be automatically populated.

    Alternatively you can click Lookup and search for the additional setting using the Find box

  4. In the Value box, type the location in which you want log files to be saved.
  5. Click OK to save the additional setting configuration.
  6. To ensure that this change takes effect, restart client services.

Manage Compression Settings

By default, log files are compressed into the 7ZIP format during the Send Log Files operation. You can further configure the 7ZIP compression process by specifying a compression level, protecting log files with a password, or create a log of the compression process.

Set the Compression Level

Set the level of file compression for the 7ZIP format by specifying a numeric value. The higher the value, the higher the compression rate, and the slower the compression speed. The higher the compression level, the more resources required to run the compression.

  1. From the CommCell Browser, right-click the CommServe, and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings dialog box appears.

  3. In the Name box, type nLogCompLevel.
  4. In the Category box, select or type EventManager.
  5. In the Type box, select or type INTEGER.
  6. In the Value box, type the number for the compression level that you want:
    Compression Level Description
    0 Store
    1 Fastest
    3 Fast
    5 Normal
    7 Maximum
    9 Ultra

    Note: If you type any other number, the value defaults to 9.

  7. Click OK.

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

  8. Click OK.

Enable Password Protection

Create a password that users must enter to open the compressed log file.

  1. From the CommCell Browser, right-click the CommServe, and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings dialog box appears.

  3. In the Name box, type sLogPassPhrase.
  4. In the Category box, select or type EventManager.
  5. In the Type box, select or type STRING.
  6. In the Value box, type the password that you want to use for opening the compressed log file.
  7. Click OK.

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

  8. Click OK.

Create a Log of the Compression Process

  1. From the CommCell Browser, right-click the CommServe, and then click Properties.
  2. On the Additional Settings tab, click Add.

    The Add Additional Settings dialog box appears.

  3. In the Name box, type b7ZipDebug.
  4. In the Category box, select or type EventManager.
  5. In the Type box, select or type STRING.
  6. In the Value box, type 1.
  7. Click OK.

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

  8. Click OK.

Command Line Operations

You can run the Send Log Files operation from the command line with a custom script that you create.

Creating a Custom Send Log Files Script

It is recommended that you use this method to send log files from the command line.

You can customize the send log files operation, and then run the script that you create from the command line. According to the options that you select, the log files are sent to the specified recipient e-mail address or stored on a local directory on the CommServe computer.

To create a custom Send Log Files operation:

  1. From the CommCell Browser, right-click the CommServe, point to All Tasks, and then select Send Log Files.
  2. On the Computers tab, select the computers for which you want to send log files, and then click Save As Script.

    The  Save As Script dialog box appears.

  3. In the File Path box, enter the location and file name for the send log files script, and then click OK.

    The script is saved in the location that you specified.

  4. To send log files, run the script from the command line.

Related Reports

Job Summary

Each time you send a log file, the operation is logged as an administrative job and can be seen in the Job Summary Report.

The Job Summary Report displays all data management, data recovery, and administrative jobs that ran in the CommCell during a specified period of time. The report also includes information about all media options. For more information, see Job Summary Report.