Type
  • Best Practice
Description
  • This article explains how to enable debug for the Hardware, Storage, Backup, and High-Availability Monitoring solutions in TrueSight/BPPM and PATROL Classic consoles.
Additional Keywords
  • Debug

Related Topics

Knowledge Base

Enabling Debug for Sentry's KMs in the TrueSight/BPPM and PATROL Classic Consoles

KB1212 - Jan 26, 2018 - Last reviewed on Jul 17, 2018

Description

When you encounter an issue with the Sentry's monitoring solutions and wish to report it to Sentry Software, you will be asked to enable the Debug Mode and provide the debug output to the Support Team. This article explains how to enable debug.

Procedures for the Hardware Monitoring Solution

Depending on your version of Hardware Sentry and your BMC environment, the procedure will differ.

For TrueSight/BPPM Environments

When Using Hardware Sentry v1.9.60 and Older

  1. Configure the Monitor Settings.
  2. In the Global Advanced Settings section, click Debug.

    Enabling the Debug Mode for Hardware Sentry KM v1.9.60

  3. Check the Enable Debug Mode option. The solution will store debug information in a log file. By default debug files are stored in the %PATROL_HOME%\log folder

  4. In the Debug End Time field, enter the date and time at which the system must stop logging debug information. The required format is: yyyy/mm/dd hh:mm:ss based on a 24 hour-day

    For the debug mode to be enabled, the Enable Debug Mode must be checked and the Debug End Time must be properly set to a date and time in the future.
  5. Click Close to save your settings.

  6. In the Add Monitor Types dialog box, click Add.

When Using Hardware Sentry v10.x.xx and Higher

The Debug mode must be enabled by running a query through the TrueSight built-in Agent Query Tool.

  1. In the navigation pane of the TrueSight OM console, click Configuration and select Managed Devices.
  2. Click a PATROL Agent inline menu and select Query PATROL Agent. The Agent Query Tool opens in a new browser window.
  3. In the Command box, enter the MS_HW_q; setDebug command and click Execute.

    Command
    requires MS_HW_q; setDebug(mode, numberOfMinutes, listOfHosts);
    

    This command allows you to enable/disable the debug mode at a specific time for all hosts or for a list of specific hosts. It requires the following arguments:

    • mode: '1' to turn on the debug mode (or "on"), '0' to turn off the debug mode (or "off"). The debug mode is enabled or disabled on all the hosts associated to the PATROL Agent unless a host name or a list of host is provided.
    • (Optional) numberOfMinutes: number of minutes the debug mode should be enabled. Default: 60
    • (Optional) listOfHosts: PATROL ID of a host or a list of comma-separated hosts for which you specifically wish to enable the debug mode. Hardware Sentry creates the debugHostList configuration variable that is saved under /SENTRY/HARDWARE. This configuration variable is automatically deleted when the debug mode is turned off (0).

Host IDs can be obtained by running the "requires MS_HW_q; hostsInfo();" query.

When enabling the debug mode for hosts listed using the listOfHosts argument, the debug mode will be automatically disabled for all unlisted hosts. If you wish to enable the debug mode for all hosts related to an Agent, only set the mode argument to 1 and set the numberOfMinutes (optional).

Enabling the Debug Mode for Hardware Sentry v10.x.xx and Higher

Examples

To Execute the following command
Enable the debug mode for all hosts (for 20 minutes) requires MS_HW_q; setDebug(1, 20);
Enable the debug mode for specific hosts (for 20 minutes) requires MS_HW_q; setDebug(1, 20, "HostID_1, HostID_2, HostID_3");
Disable the debug mode for all the hosts (with immediate effect) requires MS_HW_q; setDebug(0);

The solution stores debug information in log files. By default, debug files (MS_HW_*.log) are stored in the %PATROL_HOME%\log or $PATROL_HOME/log folder.

For PATROL Classic Environments

To enable debug:

  1. Right-click the main KM icon > KM Commands > KM Settings > Debug...

    Enabling the Debug Mode for the Hardware Monitoring Solution Using the PATROL Wizard

  2. Check the Enable Debug Mode option.

  3. Indicate the time when the debug mode will be disabled. The required format is: yyyy/mm/dd hh:mm:ss, based on a 24 hour-day. By default, the debug mode is set to stop automatically after one hour.
  4. Check the Reinitialize Hardware Sentry option (optional).
  5. Click OK. The debug files will automatically be saved in $PATROL_HOME/log.

Procedures for the Storage Monitoring Solutions

For TrueSight/BPPM Environments

  1. Edit your storage monitoring policy (in our example, Dell EMC Unity):

    Editing the Storage Monitoring Policy

    • Log on to the TrueSight console.
    • In the navigation pane, expand Configuration and select Infrastructure Policies.
    • In the Infrastructure Policies page, locate the monitoring policy you wish to modify, click its action button inline and click Edit.
    • In the Edit Monitoring Policy page, locate the Storage Configuration you wish to modify and click its action button inline to access the monitoring options panel.
  2. Locate the Advanced Settings section

    Enabling the Debug Mode for the Storage Monitoring Solution

  3. Select the Enable Debug Mode option. The solution will store debug information in a log file. By default, debug files are stored in the %PATROL_HOME%\log folder.

  4. In the Debug End Time field, enter the date and time at which the system must stop logging debug information. Required format: yyyy/mm/dd hh:mm:ss.
  5. Click OK
  6. Click Save.

For PATROL Classic Environments

To enable the debug mode:

  1. Right-click the KM main icon > KM Commands > KM Settings > Debug…

    Enabling the Debug Mode for the Storage Monitoring Solutions using the PATROL Wizard

  2. Check the Enable Debug Mode option

  3. Indicate the date and time at which the system must stop logging debug information. The required format is: YYYY/mm/dd HH:MM:SS
  4. Check the Reinitialize KM option (optional).
  5. Click OK. The debug files will automatically be saved in $PATROL_HOME/log

Procedures for the Backup Monitoring Solutions

For TrueSight/BPPM Environments

  1. Edit your monitoring policy
  2. Click the action button inline of the system for which you wish to enable the Debug Mode and click Edit
  3. In the Monitoring Settings panel, scroll down to the Debug section
  4. Select all the elements for which you want to obtain debug information

    Selecting in TrueSight the NetWorker Elements for Which Debug Information is Required

  5. In the Options section, indicate:

    • when the system must stop logging debug information. The required format is: YYYY/MM/DD HH:MM:SS
    • where the debug file will be stored. The default path is: <PATROL_HOME>/lib/<ProductCode>/debug

    Enabling the Debug Mode for the Backup Monitoring Solution

  6. Click OK twice

  7. Click Save.

When the debug end time is reached, a tar/zip file is automatically created under <PATROL_HOME>/lib/<ProductCode>/ and can be sent to the Support Team for help. It is also recommended to check the <ProductCode>_<port>.log file, where <port> is the PATROL Agent port number, for any error. This file is stored in <PATROL_HOME>/log.

For PATROL Classic Environments

  1. In the PATROL Console, right-click the System instance > KM Commands > Configuration > Debug.
  2. Select On for the debug switch(es) you want to enable

    Selecting in PATROL the NetWorker Elements for Which Debug Information is Required

  3. Set the Debug Options:

    • In the Debug End Time field, indicate the date and time after which debug information will no longer be logged.
    • In the Debug Path field, indicate where the debug file will be stored (by default: <PATROL_HOME>/lib/<ProductCode>/debug on UNIX systems; %PATROL_HOME%\lib\<ProductCode>/\debug on Microsoft Windows systems). The debug folder must have at least 10MB of available disk space and read, write and execute permissions for both PATROL Agent user and the KM login user.
    • Select Send to File(s) to write all debug messages in a file or set of files.
    • Select Send to Task Window to view the debug messages as they occur in the Debug Output window. Before selecting this option, make sure the PATROL Console is connected to the PATROL Agent.
    • Select Both (Recommended) to send the debug messages both to a file and task window.
  4. Click OK first to start the KM debugging
  5. Click Yes to reload KM and capture debug from the initial collection cycle.

When the debug end time is reached, a tar/zip file is automatically created under <PATROL_HOME>/lib/<ProductCode>/ and can be sent to the Support Team for help. It is also recommended to check the <ProductCode>_<port>.log file, where <port> is the PATROL Agent port number, for any error. This file is stored in <PATROL_HOME>/log.

Procedures for the High-Availability Monitoring Solutions

For TrueSight/BPPM Environments

  1. Edit your monitoring policy
  2. Click the action button inline of the system for which you wish to enable the Debug Mode and click Edit
  3. In the Monitoring Settings panel, scroll down to the Debug section
  4. Select all the elements for which you want to obtain debug information

    Selecting in TrueSight the VCS Elements for Which Debug Information is Required

  5. In the Options section, indicate:

    • when the system must stop logging debug information. The required format is: YYYY/MM/DD HH:MM:SS
    • where the debug file will be stored. The default path is: <PATROL_HOME>/lib/<ProductCode>/debug

    Enabling the Debug Mode for the High-Availability Monitoring Solution

  6. Click OK twice

  7. Click Save.

When the debug end time is reached, a tar/zip file is automatically created under <PATROL_HOME>/lib/<ProductCode>/ and can be sent to the Support Team for help. It is also recommended to check the <ProductCode>_<port>.log file, where <port> is the PATROL Agent port number, for any error. This file is stored in <PATROL_HOME>/log.

For PATROL Classic Environments

  1. In the PATROL Console, right-click the System instance > KM Commands > Configuration > Debug.
  2. Select On for the debug switch(es) you want to enable

    Selecting in PATROL the VCS Elements for Which Debug Information is Required

  3. Set the Debug Options:

    • In the Debug End Time field, indicate the date and time after which debug information will no longer be logged.
    • In the Debug Path field, indicate where the debug file will be stored (by default: <PATROL_HOME>/lib/<ProductCode>/debug on UNIX systems; %PATROL_HOME%\lib\<ProductCode>\debug on Microsoft Windows systems). The debug folder must have at least 10MB of available disk space and read, write and execute permissions for both PATROL Agent user and the KM login user.
    • Select Send to File(s) to write all debug messages in a file or set of files.
    • Select Send to Task Window to view the debug messages as they occur in the Debug Output window. Before selecting this option, make sure the PATROL Console is connected to the PATROL Agent.
    • Select Both (Recommended) to send the debug messages both to a file and task window.
  4. Click OK first to start the KM debugging
  5. Click Yes to reload KM and capture debug from the initial collection cycle.

When the debug end time is reached, a tar/zip file is automatically created under <PATROL_HOME>/lib/<ProductCode>/ and can be sent to the Support Team for help. It is also recommended to check the <ProductCode>_<port>.log file, where <port> is the PATROL Agent port number, for any error. This file is stored in <PATROL_HOME>/log.