Type
  • Best Practice
Description
  • This article explains how to enable the debug mode for the different versions of Monitoring Studio.
Additional Keywords
  • Debug

Related Topics

Knowledge Base

Enabling the Debug Mode for Monitoring Studio

KB1174 - Sep 18, 2015 - Last reviewed on Aug 08, 2018

Introduction

When you encounter an issue with Monitoring Studio and wish to report it to Sentry Software, you will be asked to enable the Debug Mode and provide the following debug files which are generated in the %PATROL_HOME%\log or $PATROL_HOME/log folder:

  • SEN_MS_debug_km_<PatrolAgent_Port>_<YYYY-mm-dd-HH-MM>.log: debug output of the KM
  • SEN_MS_CollectionHub_debug_psl_<PatrolAgent_Port>_<YYYY-mm-dd-HH-MM>.log: PSL debug output of the Collection Hub
  • SEN_MS_CollectionHub_debug_java_<PatrolAgent_Port>_<YYYY-mm-dd-HH-MM>.log: Java debug output of the Collection Hub.

Procedure

When Using Monitoring Studio 8.x.xx

  1. In the PATROL Console, right-click the main Monitoring Studio icon > KM commands> Options > Debug...

    Enabling Debug Mode for Monitoring Studio 8.x.xx

  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, based on a 24 hour-day.
  4. Click OK.

When Using Monitoring Studio 9.0.00

In a PATROL Console

The procedure is similar to the one described for Monitoring Studio 8.x.xx

In TrueSight

  1. Edit your Monitoring Studio policy

    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.
  2. Select the Configuration Variables tab and click Add Configuration Variables

    Setting configuration variables for Monitoring Studio 9.0.00

  3. Fill in the available fields as follows:

Variable Operation Value
/SENTRY/STUDIO/debugFile REPLACE File path for the debug output. Example: c:\\ mydebugfile_3185.txt
/SENTRY/STUDIO/debugMode REPLACE Set to 1 to enable the debug mode.
/SENTRY/STUDIO/debugSize REPLACE Maximum size of the debug file in Megabytes. Example: 50
  1. Click OK.
  2. Resume the procedure to add the three required configuration variables.

    Debug configuration variables for Monitoring Studio v9.0.00

  3. Click Save to confirm your changes. The debug file will be stored on the machine where the PATROL agent is installed.

When Using Monitoring Studio 9.1.00 and Higher

In a PATROL Console

The procedure is similar to the one described for Monitoring Studio 8.x.xx

In TrueSight

  1. Edit your Monitoring Studio policy

    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 Monitoring Studio Configuration you wish to modify and click its action button inline to access the monitoring options panel.
  2. Locate the Global Advanced Settings > Debug section

    Enabling the Debug Mode for the Monitoring Studio Solution

  3. Select the Enable Debug Mode option.

  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. The debug file will be stored on the machine where the PATROL agent is installed.

When Using Monitoring Studio X and Higher

  1. Access the Monitoring Studio X Web Interface at the following URL: https://<patrol-agent>:<patrol-agent-port+262>/ where

    • <patrol-agent> is the name of the host on which the PATROL Agent runs
    • <patrol-agent-port+262> is the number you obtain when you add 262 to the PATROL Agent port number.
  2. In the TOOLS menu, select Debug .

    Accessing the Debug Menu

  3. Enable the Debug Mode and indicate the time after which the system will stop logging debug information.

    Enabling Debug

  4. In the Debug Files section, click Refresh.

    Debug Files

Monitoring Studio X creates 3 log files that record all the KM actions until the time you have set:

  • X_CollectionHub_debug_psl_{port-and-timestamp}.log: log file of the Collection Hub, the interface between PSL and the Java engine
  • X_debug_km_{port-and-timestamp}.log: log file of the discovery and collect operations of the KM
  • X_CollectionHub_debug_java_{port-and-timestamp}.log: log file of the Java engine of the Collection Hub

These files are saved to the $PATROL_HOME/log directory.