Monitoring Studio KM For PATROL 8.6.53

Monitoring Studio KM for PATROL
Version 8.6.53
User Documentation
May 2011

Version 8.6.53
Contacting BMC Software

You can access the BMC Software Web site at http://www.bmc.com/. From this Web site, you can obtain information about the company, its products, corporate offices, special events, and career opportunities. United States and Canada Outside United States and Canada
Address
BMC Software, Inc. 2101 CityWest Blvd. Houston TX 770422827 713 918 8800 or 800 841 2031 713 918 8000
Telephone
(01) 713 918 8800
Telephone Fax
Fax
(01) 713 918 8000
Copyright 2006 BMC Software, Inc. or licensors, as an unpublished work. All rights reserved. BMC Software, the BMC Software logos, and all other BMC Software product or service names are registered trademarks or trademarks of BMC Software, Inc. IBM is a registered trademark of International Business Machines Corporation. DB2 is a registered trademark of International Business Machines Corporation. Oracle is a registered trademark, and the Oracle product names are registered trademarks or trademarks of Oracle Corporation. All other trademarks belong to their respective companies. BMC Software considers information included in this documentation to be proprietary and confidential. Your use of this information is subject to the terms and conditions of the applicable End User License Agreement for the product and the proprietary and restricted rights notices included in this documentation.
Restricted Rights Legend

U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC Software, Inc., 2101 CityWest Blvd., Houston, TX 77042-2827, USA. Any contract notices should be sent to this address.

Version 8.6.53
You can obtain technical support by using the Support page on the BMC Software Web site or by contacting Customer Support by telephone or e-mail. To expedite your inquiry, please see "Before Contacting BMC Software."
Support Web Site

You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc. com/support_home. From this Web site, you can Read overviews about support services and programs that BMC Software offers: Find the most current information about BMC Software products Search a database for problems similar to yours and possible solutions Order or download product documentation Report a problem or ask a question Subscribe to receive e-mail notices when new product versions are released Find worldwide BMC Software support center locations and contact information, including e-mail addresses, fax numbers, and telephone numbers
Support by Telephone or E-mail

In the United States and Canada, if you need technical support and do not have access to the Web, call 800 537 1813. Outside the United States and Canada, please contact your local support center for assistance. To find telephone and email contact information for the BMC Software support center that services your location, refer to the Contact Customer Support section of the Support page on the BMC Software Web site at http://www.bmc.com/support_home.
Before Contacting BMC Software

Before you contact BMC Software, have the following information available so that Customer Support can begin working on your problem immediately: Product information product name product version (release number) license number and password (trial or permanent) Operating system and environment information machine type operating system type, version, and service pack or other maintenance level such as: PUT or PTF system hardware configuration serial numbers related software (database, application, and communication) including type, version, and service pack or maintenance level Sequence of events leading to the problem Commands and options that you used Messages received (and the time and date that you received them) product error messages messages from the operating system, such as "file system full"

Version 8.6.53
Table of Contents
Targeted Computers ...........................................................................................................................1 1 Migrating from Previous Versions of Monitoring Studio ...........................................................................................................................1 1 Requirements ...........................................................................................................................1 2 Installation Packages ...........................................................................................................................1 3 Installing Monitoring Studio KM for PATROL ...........................................................................................................................1 4 ...........................................................................................................................1 4 Getting the BMC Software Installation utility ...........................................................................................................................1 4 Installation Procedure ..................................................................................................................23 Extracting the Setup Files ..................................................................................................................24 Loading Monitoring Studio KM for PATROL ..................................................................................................................25 Preloading Monitoring Studio Uninstalling BMC...........................................................................................................................26 Performance Manager Monitoring Studio Creating and Importing an Adapter for a BMC PATROL KM ...........................................................................................................................36 Updating an Adapter for a BMC PATROL KM ...........................................................................................................................44 Importing and Customizing Thresholds ...........................................................................................................................45 Monitoring with Monitoring Studio ...........................................................................................................................48 Configuring Monitoring Studio to Monitor your Application ...........................................................................................................................50 Day-to-day monitoring with Monitoring Studio ...........................................................................................................................51 Monitoring Features ...........................................................................................................................53 ...........................................................................................................................53 Application/Container Icons ...........................................................................................................................61 Command Line Analysis Database Query ...........................................................................................................................7 1 Analysis ..................................................................................................................7 6 Setting connection to Microsoft SQL Server Databases ..................................................................................................................80 Setting connection to MySQL Server Databases ..................................................................................................................83 Setting connection to Oracle Database Server ..................................................................................................................87 Setting connection to Other Databases (ODBC only) ...........................................................................................................................88 Dynamic Object Builder ...........................................................................................................................93 File Monitoring and Analysis ...........................................................................................................................98 File System Monitoring ...........................................................................................................................1 01 File Security Check ...........................................................................................................................1 09 Folder Monitoring ...........................................................................................................................1 1 3 Multi-Parameter Formula ...........................................................................................................................1 1 8 Numeric Value Extraction
Table of Contents

Version 8.6.53
...........................................................................................................................1 25 Process Monitoring SNMP Polling ...........................................................................................................................1 32
...........................................................................................................................1 38 SNMP Trap Listening String Search ...........................................................................................................................1 43 ...........................................................................................................................1 49 Text Pre-Processing ...........................................................................................................................1 61 WMI Query Analysis ...........................................................................................................................1 65 WBEM Query Analysis ...........................................................................................................................1 69 Web-farm Monitoring ...........................................................................................................................1 7 7 Web Request Analysis Windows Event ...........................................................................................................................1 83 Monitoring ...........................................................................................................................1 88 Windows Performance Monitoring ...........................................................................................................................1 92 Windows Service Monitoring JMX ...........................................................................................................................1 96 ..................................................................................................................1 96 Java MBean Polling (JMX) ..................................................................................................................1 99 Generic JMX Client ..................................................................................................................205 Input variables for JMX polling Wizards JBoss WebSphere JOnAS WebLogic ..................................................................................................................207 ..................................................................................................................21 4 ..................................................................................................................221 ..................................................................................................................228
Thresholds and...........................................................................................................................234 Alert Actions ...........................................................................................................................234 Managing Thresholds ...........................................................................................................................236 Setting or Modifying Alert Thresholds ...........................................................................................................................240 Setting Thresholds on Dynamic Numeric Value Extractions ...........................................................................................................................242 Alert Actions Description ...........................................................................................................................246 Alert Actions Capabilities ...........................................................................................................................254 Alert Action Macros Administration ...........................................................................................................................258 Features ...........................................................................................................................258 Exporting Configuration to a File ...........................................................................................................................261 Importing Configuration Process Viewer...........................................................................................................................266 Tool ...........................................................................................................................267 Modifying Object Name and/or ID ...........................................................................................................................269 Process Command Credentials SNMP Browser ...........................................................................................................................27 0 Tool ...........................................................................................................................27 1 SNMP Trap Listener Tool ...........................................................................................................................27 1 Setting Polling Interval
Table of Contents

Version 8.6.53
Java Settings ...........................................................................................................................27 3 ...........................................................................................................................27 6 Windows EventLog Reader Tool ...........................................................................................................................27 7 Setting the Discovery Interval ...........................................................................................................................27 7 Trigger a KM Discovery ...........................................................................................................................27 8 Monitoring Studio Configuration Reports ..................................................................................................................27 8 Instant Configuration Reports ..................................................................................................................280 Scheduling Configuration Reports Operator Day-to-Day Tasks ...........................................................................................................................285 ...........................................................................................................................285 Acknowledge and Update ...........................................................................................................................285 Acknowledge all and Reset ...........................................................................................................................285 Acknowledge Alerts ...........................................................................................................................286 Copy, Cut and Paste ...........................................................................................................................287 Delete a Monitored Object ...........................................................................................................................288 Pause the Monitoring of an Object ...........................................................................................................................288 Rename an Object ...........................................................................................................................289 Restart Scan from the Beginning of the File ...........................................................................................................................290 Restart an Application ...........................................................................................................................290 Stop an Application ...........................................................................................................................291 View the Content of a File Alert Actions Example ...........................................................................................................................294 XML LOG File Parsing ...........................................................................................................................297 Enabling the Debug Mode ...........................................................................................................................307 About Processes ...........................................................................................................................31 0 About WMI ...........................................................................................................................31 1
Alert Actions Macros ...........................................................................................................................31 4 Format Symbols for %{ASCTIME:} Macros ...........................................................................................................................31 8 Regular Expressions ...........................................................................................................................320 Application Classes ...........................................................................................................................321 ...........................................................................................................................321 List of Application Classes ...........................................................................................................................323 SW_APPLICATIONS ...........................................................................................................................326 SW_DB_QUERIES SW_DYNAMIC ...........................................................................................................................328 ...........................................................................................................................329 SW_DYNAMIC_CONTAINER ...........................................................................................................................330 SW_DYNAMIC_DISCOVERY ...........................................................................................................................331 SW_DYNAMIC_NUMBERS ...........................................................................................................................332 SW_DYNAMIC_STRINGS
Table of Contents

Version 8.6.53
SW_FILES
...........................................................................................................................333
...........................................................................................................................335 SW_FILE_SECURITY ...........................................................................................................................337 SW_FILESYSTEMS SW_FOLDERS ...........................................................................................................................339 ...........................................................................................................................341 SW_HTTP_REQUESTS ...........................................................................................................................343 SW_HTTP_WEBFARM SW_JMX ...........................................................................................................................345
...........................................................................................................................347 SW_KMWATCH SW_NTEVENTS...........................................................................................................................348 ...........................................................................................................................350 SW_NTPERFORMANCE ...........................................................................................................................352 SW_NTSERVICES SW_NT_WMI ...........................................................................................................................353 SW_WBEM ...........................................................................................................................355
SW_NUMBERS ...........................................................................................................................357 ...........................................................................................................................359 SW_OSCOMMANDS ...........................................................................................................................361 SW_PROCESSES SW_SENTRY ...........................................................................................................................363
...........................................................................................................................366 SW_SNMP_POLLING ...........................................................................................................................368 SW_SNMP_TRAPS SW_STRINGS ...........................................................................................................................37 0 ...........................................................................................................................37 2 SW_TRANSFORM
Table of Contents
Release Notes for v8.6.53

Version 8.6.53
This section describes changes and updates that have occurred since the release 8.6.52 of Monitoring Studio KM for PATROL.
What's New
Full support for BMC ProactiveNet Performance Management (BPPM 8.5): Monitoring Studio KM for PATROL now fully and natively integrates with the latest iteration of BMC's monitoring framework. It includes the required metadata that describe the classes and parameters for accurate interpretation, correlation and trending in ProactiveNet.
Changes and Improvements

Window Service Monitoring: It is now possible to manually enter the name of a service to monitor allowing the possibility to configure a Service monitoring even if the service is not currently installed on the server (for deployed configurations). Process Monitoring: The KM commands now retrieves the entire process command-line and is no longer limited to the first 2048 characters.
Fixed Issues
Monitoring Studio would show invalid service display names in the New Windows Service Wizard on Windows 7 and Windows 2008 servers. The ASCII filter used by Monitoring Studio did not take Asian characters into account preventing PATROL IDs to be properly displayed. Dynamic Numbers or Dynamics Strings: A problem occurred when two or more dynamic containers with dynamic string/number templates were configured. Every time a dynamic discovery was performed, the dynamic string/number instances were updated. Instead of simply destroying all missing instances related to one dynamic container, the running discovery also destroyed any instances that were not related to the current container running the discovery thus resulting in dynamic string/number instances clipping. The product could not perform SQL queries to an Oracle database on Windows anymore (invalid username/password message) The new Java polling method introduced in v.8.6.50 for optimization purposes was not compatible with special characters. Monitoring Studio would show the Exit Status in the ReturnOuput parameter of the OS if the command output was empty.
Known Issue
Oracle Database: Space characters are not supported for passwords in Windows, thus, when working with this operation system, you must enter a space-free password to access an Oracle Database.
Installation Guide

Version 8.6.53
Introduction
This section provides detailed information about the pre-requisites for the installation of Monitoring Studio. It helps you understand what you need to install and where (on which components of your IT infrastructure) and guides you through the step-by-step installation procedure.
Targeted Computers
Like most Knowledge Modules for PATROL, you need to install Monitoring Studio on the following components of your PATROL architecture: Every managed system with a PATROL Agent Every PATROL Console (Classic) The Console Server PATROL Central Web Edition
Migrating from Previous Versions of Monitoring Studio

Monitoring Studio is the new name assigned to Application Sentry KM for PATROL. Previous versions of Monitoring Studio were formerly known as Application Sentry.
On PATROL Agents
As only one version of Monitoring Studio can be installed on a PATROL Agent, a previous installation of Monitoring Studio will be overwritten by the latest version. No specific migration operation is required (you do not need to uninstall the previous version of Monitoring Studio). Upon startup, Monitoring Studio will take the action necessary to complete the migration (migrating configuration variables if needed).
A utomatic migration is only supported from 8. x v ersions of Monitoring Studio. Earlier v ersions are no longer supported.
On PATROL Consoles (Classic)

As for PATROL Agents, only one version of Monitoring Studio can be installed on a PATROL Console (Classic). The difficulty lies in the fact that a PATROL Console may need to connect to several PATROL Agents, each with different versions of Monitoring Studio. This version of Monitoring Studio supersedes previous versions. It means that with the latest version of Monitoring Studio on the PATROL Console, you will be able to seamlessly connect to Agents with previous versions of Monitoring Studio.
11

Version 8.6.53
However, you do need to update the console profiles to include the new Monitoring Studio classes. To achieve this, all you need to do is: Load the SW_SENTRY8.kml file in the PATROL Console. This will add the new file security-related class. If you do not load the new class in the console, Monitoring Studio will not work properly, that is, you will not be able to monitor the security settings of a file.
A v oid the use of the "Dev eloper" connection ty pe in the PA TR O L C onsole. It is ev en more important that y ou nev er use the "C ommit KMs" feature of the PA TR O L C onsole, especially when y ou deal with sev eral v ersions of the same KM in y our env ironment.
Version 8.5.00 of Monitoring Studio added various new Menu Commands in the PATROL Console. Therefore, ever since, although the new Menu Commands may seem available on all agents, previous versions of Monitoring Studio (formerly known as Application Sentry) will not be able to execute these new Menu Commands. In such case, an error message will be displayed in the System Output Window of the Agent. This problem will not occur on PATROL Central consoles.
On Console Server, PATROL Central Web Edition

As Console Server and PATROL Central are able to manage several versions of the same KM, you can install the current version of Monitoring Studio and earlier versions side-by-side on the same Console Server. Console Server will automatically use the appropriate version of the KM depending on what is running on the displayed agent. However, you still need to update the console profiles to include the new Monitoring Studio classes. To do so, you only need to: Load the SW_SENTRY8.kml file in the profile. If you do not load the new classes in the profile, Monitoring Studio will work but you will not be able to use the features of the new classes.
Requirements
Requirements for managed systems
The operating system must be one the following: Windows (any Windows-based version, including Windows NT4, 2000, 2003, 2008 and Vista) UNIX or Linux-based (including Solaris, HP-UX, IBM AIX, HP Tru64, RedHat Linux, SUSE Linux, VMWare ESX Host) OpenVMS The BMC Software PATROL Agent must be installed, and its version should be at least 3.4.11.
Migrating from Previous Versions of Monitoring Studio
12

Version 8.6.53
Requirements for console systems

BMC Software PATROL Console PATROL Central Operator PATROL Console Web-edition
Monitoring Studio Installation Packages

To install the product, you require:
The BMC Installation Utility (formerly known as Thorium)

For Windows-based systems: ins_WINDOWS_<version number>.exe (agent, console, Console Server, etc.) For UNIX and Linux systems: ins_ALL_<version number>.tar (agent, console, Console Server, etc.) Place the Installation Utility package in the same folder as the Monitoring Studio packages. The Installation Utility is available on the Sentry Software website and on the BMC FTP site.
The Monitoring Studio packages

There are two packages, each of which can be used to install the KM on every PATROL component (Agent, Console, etc.) according to the platform you are using. However, depending on the package download source, the files name may differ:
Downloading from BMC Web site

For Windows systems: LYV39_KM_WINDOWS_1710.exe For UNIX and Linux systems: LYV39_KM_UNIX_1710.tar
Downloading from Sentry Software Web site

For Windows-based systems: swsy_WINDOWS_8653.exe For UNIX and Linux systems: swsy_UNIX_8653.tar Each package can be used to install Monitoring Studio on every PATROL component (Agent, Console, etc.). The Monitoring Studio packages are available on the BMC Software EPD site as well as on Monitoring Studio KM for PATROL product page on the Sentry Software Web site at www.sentrysoftware.net.
Requirements
13

Version 8.6.53
Installing Monitoring Studio KM for PATROL

This section describes the installation procedure of Monitoring Studio on any PATROL component (Agents, Consoles, Console Server, etc.). The procedure applies to all operating systems supported by Monitoring Studio. Although not covered by this section, installation through the Distribution Server is fully supported as well. Please refer to the Distribution Server documentation on the BMC website for a detailed description of the procedure.
See Also
Installation Basics Installing Monitoring Studio KM for PATROL Targeted Computers
Getting the BMC Software Installation Utility

In order to install Monitoring Studio, you need the latest version of the BMC Software Installation Utility. You can download the latest version of the Installation Utility from the BMC Software FTP site at: ftp:// ftp.bmc.com/pub/patrol/patches/. 1. Choose the appropriate package depending on the platform on which you plan to install Monitoring Studio: For UNIX/Linux systems: ins_ALL_<version number>.tar For Windows systems: ins_WINDOWS_<version number>.exe The packages are valid for installation on Agents, Consoles and Console Servers Place the Installation Utility package in the same folder as the Monitoring Studio package
2.
Installation Procedure
Essential
It is essential to install the KM on the following components of the PATROL framework: Managed systems with a PATROL Agent PATROL Console (Classic) PATROL Console Servers (PATROL 7 framework only) PATROL Central Web Edition Installing Monitoring is an automated process managed by a wizard. The wizard goes through the necessary steps to properly install Monitoring Studio and all files associated with it. You are simply prompt for the product's folder location and the product/components to install. Browse to the
14

Version 8.6.53
bmc_products folder where the files have been extracted (both Monitoring Studio and the Common Installer). On Windows: Launch the setup.exe program. On UNIX: Launch the setup.sh script On the more recent versions of Windows XP and Windows 2003, you may get this security alert dialog: Windows detected that the BMC Software Installation Utility is listening on the 50001 port.
To install Monitoring Studio KM for PATROL

1. The welcome screen of the installer appears. Click Next to continue.
Ins ta lla tio n W iza rd - Ste p 1: W e lco m e
15

Version 8.6.53
2.
Read the license agreement, click the Accept option and then click Next to continue.
Ins ta lla tio n W iza rd - Ste p 2: R e v ie wing Lice nce A g re e m e nt
3.
Select Install the products on this computer now and click Next to continue.
Ins ta lla tio n W iza rd - Ste p 3: Se le cting Ins ta lla tio n Op tio ns
16

Version 8.6.53
The activ e part of Monitoring Studio resides on the PA TR O L A gent, therefore: A PA TR O L A gent must be installed on each serv er that needs monitoring; Monitoring Studio KM for PA TR O L must be installed on each PA TR O L A gent. Please refer to the Monitoring Studio KM for PA TR O L Installation Guide for further details on the installation procedure.
4.
Specify the BMC Software products folder. See the BMC Software documentation for more information about the BMC Software products folder. Click Next to continue.
Ins ta lla tio n W iza rd - Ste p 4: Se le cting the Ins ta lla tio n Dire cto ry
17

Version 8.6.53
5.
Select Default. Installing Monitoring Studio does not require any customization. Click Next to continue.
Ins ta lla tio n W iza rd - Ste p 5: Se le cting a n Ins ta lla tio n T y p e
18

Version 8.6.53
6.
Select Managed System to install Monitoring Studio on a PATROL Agent. Select the Console Systems role to install Monitoring Studio on a PATROL Classic Console. Select Common services to install Monitoring Studio on the Console Server or on PATROL Central Web Edition. Click Next to continue.
Ins ta lla tio n W iza rd - Ste p 6: Se le cting R o le s
Select as many options at required.
19

Version 8.6.53
7.
Check the Monitoring Sentry KM for PATROL box to install the KM (it should be selected by default). Click Next to continue.
Ins ta lla tio n W iza rd - Ste p 7: Se le cting Pro d ucts a nd Co m p o ne nts
8.
Review the installation parameters and click Start Install to launch the installation procedure.
20

Version 8.6.53
Ins ta lla tio n W iza rd - Ste p 8: R e v ie wing Ins ta lla tio n Op tio ns
9.
The setup program displays the actions performed and indicated the percentage of completion. Once the installation complete, click Next the view the installation results.
Ins ta lla tio n W iza rd - Ste p 9 Ins ta lla tio n Sta tus
21

Version 8.6.53
10. The wizard displays the installation results. Click View Log to display a detailed log of the installation procedure. Click Next and then Finish to exit the setup program.
Ins ta lla tio n W iza rd - Ste p 10: Ins ta lla tio n R e s ults
11. Click the Finish button to quit the installation wizard.
22

Version 8.6.53
Ins ta lla tio n W iza rd - Ste p 11: Co m p le ting a nd clo s ing the Ins ta lla tio n W iza rd
A Help button in av ailable at each step of the procedure. C lick to display the installation online help. The Ex it button allows y ou to stop the installation procedure.
Extracting the Setup Files

On Windows
The packages for Windows can simply be extracted by double-clicking the following files in a consecutive order: 1. 2. BMC Installation Utililty: ins_WINDOWS_<version number>.exe Monitoring Studio KM for PATROL: swsy_WINDOWS_8653.exe
The packages are extracted in a subfolder named bmc_products.
On UNIX/Linux
The packages for UNIX/Linux need to be extracted with the tar utility: 1. 2. BMC Installation Utililty: tar xf ins_ALL_<version number>.tar Monitoring Studio for PATROL: tar xf swsy_UNIX_8653.tar
The files are extracted in a sub-directory named bmc_products.
23

Version 8.6.53
Loading the Monitoring Studio KM

Prior to using Monitoring Studio KM for PATROL you must load the Knowledge Modules (KMs) on the PATROL Console. Follow the steps below to load Monitoring Studio KM for PATROL:
Loading the KM on PATROL Console for Windows or on PATROL Console for UNIX
1. 2. Select File > Load KM in the PATROL Console menu In the dialog box, select SW_SENTRY8.kml and click Open
Loading the KM on PATROL Central Operator

1. Select Action > Common Tasks > Load Knowledge Modules 2. In the dialog box, check the box next to the managed systems for which you wish to load Monitoring Studio KM for PATROL and click Next 3. Click the Knowledge Module lists tab, check the box near SW_SENTRY8.kml and click Next. 4. Click the Finish button.
Loading the KM on PATROL Central Web Edition

1. In the General Tasks panel, click Load Knowledge Modules 2. In the dialog box, click on the managed systems for which you wish to load Monitoring Studio KM for PATROL and click Next 3. Select SW_SENTRY8.kml from the list and click Next 4. Click the Finish button.
Application classes on the Monitored systems and Console

If the KM is properly loaded, the following 22 classes should be loaded on the Monitored System and Console:
Classes
SW_APPLICATIONS SW_DB_QUERIES SW_FILES SW_FILE_SECURITY SW_ FILESYSTEMS SW_FOLDERS SW_HTTP_REQUESTS SW_HTTP_WEBFARM SW_JMX
Description
Monitors application/container icons Executes and monitors database queries Monitors files and file content Monitors file security Monitors file-systems Monitors folders Monitors web-based applications, executes HTTP requests Monitors web farms Polls and monitors JMX-enabled application servers
24

Version 8.6.53
Classes
SW_KMWATCH SW_NTEVENTS SW_ NTPERFORMANCE SW_ NTSERVICES SW_NT_WMI SW_NUMBERS SW_OSCOMMANDS SW_PROCESSES SW_SENTRY SW_SNMP_POLLING SW_SNMP_TRAPS SW_STRINGS SW_TRANSFORM
Description
Monitors parameters of other KMs Monitors Windows Event Logs Monitors Windows Performance Monitors Windows Services Executes and monitors WMI queries Enables extracting numeric values Executes, monitors and parses command lines and scripts Monitors Processes Main application class Polls and monitors SNMP agents Monitors and listens for SNMP traps Executes string searches Transforms complex (multi-line, HTML, XML) text to enable string/numeric value searches
Preloading Monitoring Studio

For optimal operation of Monitoring Studio, it is strongly recommended that you configure the PATROL Agent to pre-load the KM. This means that the PATROL Agent will automatically load Monitoring Studio upon startup and will not wait for a console requesting the KM. This can be done by setting the /AgentSetup/preloadedKMs configuration variable of each PATROL Agent where Monitoring Studio has been installed. To set a configuration variable, you need to use: PATROL Configuration Manager (PCM) WPCONFIG.EXE (Windows) xpconfig (UNIX/Linux). For more information about these tools, please refer to the BMC Software PATROL documentation. The /AgentSetup/preloadedKMs is a comma-separated list of KM files or KM lists that have to be loaded by the agent upon startup. Basically, it looks like the following: EVENT_MANAGEMENT.kml,Windows_PERFMON_WIZARD.kml,Windows_BASE.kml,AS_EVENTSPRING.kml Add SW_SENTRY8.kml to this list as shown below and then apply the configuration: EVENT_MANAGEMENT.kml,Windows_PERFMON_WIZARD.kml,Windows_BASE.kml,AS_EVENTSPRING.
25

Version 8.6.53
kml,SW_SENTRY8.kml
Uninstalling BMC Performance Manager Monitoring Studio

Uninstalling Monitoring Studio is an automated process managed by a wizard. The wizard goes through the necessary steps to remove Monitoring Studio and all files associated with it. You are simply prompt for the product's folder location and the product/components to uninstall. 1. Locate the Uninstall folder under the BMC products directory (typically under C:\Program Files\BMC Software, or /opt/bmc): On Windows systems, launch uninstall.exe On UNIX, launch uninstall.sh
Un-ins ta lla tio n W iza rd W e lco m e Ste p
Ensure that the uninstall program is up-to-date. You may need to use the installation program from a fresh Installation Utility package.
2. Specify the BMC Software products folder. See the BMC Software documentation for more information about the BMC Software products folder.
26

Version 8.6.53
Un-ins ta lla tio n W iza rd Sp e cify ing fo ld e r
3. To uninstall the KM, select Monitoring Studio KM for PATROL.
Un-ins ta lla tio n W iza rd Se le cting Pro d ucts a nd Co m p o ne nts Dire cto ry
4. Review your selection and click Start Uninstall to run the un-installation.
27

Version 8.6.53
Un-ins ta lla tio n W iza rd R e v ie wing Se le cte d Pro d ucts & co m p o ne nts a nd s ta rt unins ta lling
5. A page displays the list of products/components processed and the percentage of completion. Click Next to continue.
Un-ins ta lla tio n W iza rd Sta tus
28

Version 8.6.53
6. A page displaying SUCCESS indicates that Monitoring Studio KM for PATROL is now uninstalled. Click Finish to quit the wizard.
Un-ins ta lla tio n W iza rd Unins ta ll R e s ults
29
Integrating with BMC Portal

Version 8.6.53
Since v8.5.00, an additional component called BMC-PM-PATROL-Monitoring-Studio-8.5.xx.par.zip is released with the KM. This is an integration component for the BMC Portal environment in the form of a PAR file. It enables visualizing, on the Portal, the parameter data of objects monitored by the KM. The details on this integration component are stated in the document Monitoring Studio KM 8.5.xx Portal Integration available on the Monitoring Studio product page of the Sentry Software website. The integration component provided with this release is the same as the one provided with v8.5.00, and is valid on versions: v8.5.00, v8.5.01and v8.5.02.
Overview of BMC Performance Manager Integration

BMC Performance Manager Integration with Monitoring Studio KM for PATROL mines data from the PATROL Agent for integration into the BMC Performance Manager Portal, so that you can use the Portal to monitor your infrastructure from within a single console using PATROL parameter data. Using the Host Name or IP Address option in the BMC Portal to specify one or more managed systems as monitored elements, you can select the parameter threshold values that can be used by the integration component. After you perform the initial import of threshold values into the Portal, you can update the threshold settings from within the Portal and not impact the values set in the BMC Performance Manager Consoles, PATROL Configuration Manager, or PATROL KM for Event Management. During the data process, the Portal matches the application classes and parameters in its BMC Performance Manager Integration with PATROL component with those in the KM on the agent, and it obtains only the data for which it identifies a match.
Integrated application classes and parameters

The application classes and parameters in the integrated component for the Portal are exactly the same as those in the KM for PATROL. Please refer to the Reference section of this online help for details on the same.
31

Version 8.6.53
Open issues and workarounds

The following general issues impact each BMC Performance Manager Integration component: The Portal is unable to dynamically remove application instances that are no longer active. To remove an inactive instance, remove the infrastructure element and add it back to the Portal. However, in Portal v2.4, removing an instance is possible by clicking on the instance > Configure > Delete The Portal does not dynamically activate or inactivate parameters based on the environment. Parameter data with values larger than 7 digits may be represented in the Portal in scientific notation It is not possible to have border thresholds in the Portal as opposed to in the KM. The Portal will translate border thresholds from the KM into its own system of "greater than"/"lesser than".
How to obtain BMC Performance Manager Integration with Monitoring Studio KM for PATROL
The integration component is available at the Sentry Software website: www.sentrysoftware.net/link. asp?topic=28
Installation information
Place the BMC-PM-PATROL-Monitoring-Studio-8.5.x.par file that you downloaded from the EPD page in a known location on your file system. To install BMC Performance Manager Integration with Monitoring Studio KM for PATROL: 1. 2. 3. 4. 5. 6. Log on to the Portal with administrator credentials, and select the Portal tab. Under Tasks in the navigation pane, select Performance Managers. Click the Import tab. Click Browse to open a file selection dialog box, and select the PAR file. Click Upload. The portal uploads the PAR file to the application server. On the PAR Files page, the PAR file name and Performance Manager properties appear as Published under PAR Files Currently Loaded. Add Elements and then add the application class to them or add this application class to existing elements, just as you would do for any PM on the Portal. Once the application class has been added to the Elements: Click on Configure > Elements > Refresh PATROL Integration to collect the threshold values from the PATROL Agent and reflect them in the Portal.
32

Version 8.6.53
Updating threshold values in Portal

If threshold values are modified in the PATROL Agent, you need to manually update them in the Portal, by clicking on Configure > Elements > Refresh PATROL Integration. However, please note that although you are able to change the threshold values in the Portal these will not in any way impact the values set in the PATROL Agent. Also, clicking the Refresh PATROL Integration will always update the values in the Portal to reflect those in the PATROL Agent.
Levels of support
BMC Software provides the same support for BMC Performance Manager Integration with Monitoring Studio KM for PATROL as it does for the corresponding BMC Performance Manager Monitoring Studio KM for PATROL. For more information about the latest Support policies and guidelines, see the Customer Support page of the BMC Software website at http://www.bmc.com/support_home.
Where to view the latest product information

To view the latest BMC Software books and release notes, visit the Customer Support Web page at http://www.bmc.com/support_home or visit the BMC Performance Manager Monitoring Studio page on the Sentry Software website, from where you can download updates as well as all the support documents in PDF format and refer to the online version of the support documents available in the online technical library.
33
Integrating with BMC Atrium Orche

Version 8.6.53
Overview
To integrate a BMC PATROL KM into BMC ProactiveNet , you need to create a specific adapter. An adapter for BMC PATROL facilitates pulling of performance data from existing BMC PATROL solutions into BMC ProactiveNet. Using an Adapter, you can import BMC PATROL application classes (provided in a Knowledge Module KM) into BMC ProactiveNet. The Adapter periodically synchronizes the performance data collected by these application classes into BMC ProactiveNet.
A d a p te r fo r BM C PA T R OL A rchite cture
35

Version 8.6.53
Creating and Importing an Adapter for a BMC PATROL KM

Creating an Adapter for a BMC PATROL KM
1. Open the BMC ProactiveNet Administration Console. The BMC ProactiveNet Administration Console is displayed as shown in the following figure:
A cce s s ing the A d m inis tra tio n ta b in the A d m inis tra tio n Co ns o le
36

Version 8.6.53
2.
Right-click the Adapters folder and select Import Monitor Type and Add Adapter > BMC PATROL.
Im p o rting M o nito r T y p e s a nd A d d ing A d a p te r
37

Version 8.6.53
3.
In the Configuration tab, enter the required information:
Se tting the co nne ctio n p a ra m e te rs
In the Instance Name field, enter a name for this instance of the Adapter that will perform the integration of the targeted KM into BMC ProactiveNet. Select the Agent where this instance of the Adapter will be executed Enter the Integration Service Agent hostname or IP address Enter the Integration Service Agent Port. The default port is 3182. Enter the required credential to connect to the Integration Service Agent
38

Version 8.6.53
4.
Click Next to continue
R e v ie wing the Inte g ra tio n Se rv ice co nfig ura tio n
39

Version 8.6.53
5.
Click Next to let the system load the BMC PATROL application classes.
Se le cting A p p lica tio n Cla s s e s to im p o rt
6.
Select the application classes to import
Unselecting will delete the application classes that hav e already been imported during a prev ious operation. A pplication classes ready to be deleted are marked with a red x .
40

Version 8.6.53
7. 8.
Click Next to start the import process. The system displays a summary of the application class import, click Next to continue. Select the application classes you wish to auto-synchronize with the Integration Service Agent.
Se le cting A p p lica tio n Cla s s e s fo r A uto -s y nc
41

Version 8.6.53
9. Click Next to continue 10. Set the Filter details if need.
Se tting filte r d e ta ils
42

Version 8.6.53
11. Click Next to continue. 12. Set the Auto-sync poll scheduling, if needed.
Sche d uling A uto -s y nc p o lls
13. Click Next to continue. The system displays a summary of your settings, click Finish to confirm. The Adapter has been added to the Adapters folder of the Administration Console. 14. To see the class instances that have been imported by the Adapter, expand the Adapters folder, right-click the Adapter and select Details.
W e strongly recommend that y ou create a specific adapter for each KM y ou need to integrate into BMC Proactiv eNet to enable the update of a single KM independently .
43

Version 8.6.53
Updating an Adapter for a BMC PATROL KM

Updating an Adapter
1. 2. 3. 4. Delete the Adapter instance Go through the Add an Adapter wizard to actually delete the monitor types that had been created based on the previous version of the KM Close Resume the entire Creating an Adapter for a BMC PATROL KM procedure
F or complete and detailed information on these procedures, please refer to the BMC Proactiv eNet documentation av ailable from BMC W eb site.
Updating an Adapter for a BMC PATROL KM
44

Version 8.6.53
Importing and Customizing Thresholds

1. Launch the BMC ProactiveNet PW Commands. On Windows 2008, you need to run the PW Commands as Administrator.
2. Execute the following command line:

where
pw adapter -type patrol -get_thresholds <file name> -pproxy_host <hostname|ipaddress> [-pproxy_p
-get_thresholds <file name> = File name with absolute path at which thresholds will be i -pproxy_host <hostname|ipaddress> = Host name or IP Address of Patrol Proxy Server -pproxy_port <port_number> = Port at which Patrol Proxy Agent communicates with Patrol P -pproxy_user <username> = User name of Patrol Proxy user -pproxy_passwd <password> = Password to authenticate Patrol Proxy user -i = import Instance level thresholds -v = run in "verbose" mode, producing extra lines of output during extraction and conver
The command has produced a text file with all the parameter threshold settings.
45

Version 8.6.53
3. 4. 5.
Open the file in a text editor. Check that the global thresholds have been properly interpreted. Then go to the # INSTANCE LEVEL THRESHOLDS section of the file. Uncomment all instance level thresholds for the _PATROL__SW_ prefixed instances.
Search the file for the 'NO T_IMPLEMENTED' occurrences to detect thresholds that were not properly conv erted by the PA TR O L A dapter.
6.
Save the file.
7.
Execute the following command:
pw threshold loadpatrolthreshold [<thresholdfilename> [-v]] where: <thresholdfilename> is a thresholds file name. If no file path is specified then the de -v enables the Verbose mode
Class-level thresholds can be displayed using the Absolute Global Thresholds panel in the BMC ProactiveNet Operator Console, while instance-level thresholds are displayed in the Absolute Instance Thresholds panel:
Thresholds have been successfully imported into BMC ProactiveNet.
46
Getting Started

Version 8.6.53
Introduction
While out-of-the-box BMC Software monitoring solutions are available for the most common applications, companies often also need to use various custom or in-house applications. Until recently, monitoring these custom applications, often critical, as they are intrinsically linked to the business, was feasible only through a custom PATROL KM. Developing a PATROL KM, although not an impossible task, inevitably involves a lot of programming, project management, release and maintenance management skills, all of which are time and resource-intensive. Monitoring Studio KM for PATROL allows you to set up the monitoring, without any coding, of almost any application, device or IT component for which there is no out-of-the-box monitoring solution available. It also enables you to consolidate diverse monitoring needs through a single solution. In a few clicks, and thanks to intuitive wizards, you can cover up to 100% of your critical applications within your BMC Software monitoring environment. This chapter helps you understand how Monitoring Studio KM for PATROL works and what you can do with it. It gives you a quick glimpse of the installation and integration process, and a basic guideline on how to set-up the monitoring of your applications with Monitoring Studio. Please note that although this section briefly gives goes over the installation procedure, it remains essential to refer to the Installation Guide to ensure a correct installation of the product.
Monitoring with Monitoring Studio

Monitoring Studio is a module that allows PATROL administrators to set up the monitoring of custom applications and other applications, devices or IT components for which there are no standard KMs. Once installed, Monitoring Studio provides a graphical user interface through which the administrators can use diverse monitoring tools with great flexibility to monitor their applications/devices/technologies. The user - friendly wizards enable the administrators to decide what should be monitored and how it is to be monitored. Once Monitoring Studio is properly configured, the application/device or IT component appears on the PATROL Console and operators are alerted when a failure or anomaly occurs (depending on the settings).
An easy-to-use GUI to setup the monitoring of an application or IT component

Monitoring Studio provides a graphical user interface that allows PATROL administrators to set up the monitoring of an application or any other IT component. The administrator can create icons for the applications in the PATROL Console and specify in a highly
48

Version 8.6.53
detailed way what must be monitored for this IT component.
What you can do with Monitoring Studio

Monitor processes of the application Monitor and analyze files Parse complex log files (xml, multi-line or large files) Run string searches Extract numeric values Monitor file systems used by the application Launch commands or scripts Send requests to a web front-end of the application Send queries to the database back-end of the application Poll SNMP agents and listen for SNMP traps Poll JMX-enabled application servers Execute and analyze WMI queries Monitor Windows Performance Monitor Windows Events Monitor Windows Services Monitor other KM's parameters and integrate them within your application/component monitoring
The entire configuration of Monitoring Studio is stored in the agent configuration tree (under /MA SA I/SENTR Y8).
Monitoring with Monitoring Studio
49

Version 8.6.53
Configuring Monitoring Studio to Monitor your Application

Configuring Monitoring Studio to monitor your application strongly depends on the application itself. Nevertheless, certain basic guidelines can be followed:
1. Specify the resources used by your application:

Processes or Windows services File systems (or logical disks) used by your application Directories (folders) where your application runs (where transactional data is stored, where queries are queued, etc.) Files that are critical to your application (to check their presence, size, growth, etc.) as well as their security settings Other middleware information provided by other KMs if your application relies on some middleware software that can be monitored by specific KMs (Oracle, Tuxedo, MSMQ, etc.) Other middleware information provided by Windows performance counters if your application relies on middleware software under Windows and provides perfmon data
2. Specify the information sources (where or how can you get information about the application):
Flat files that contain useful information about your application LOG files in which your application writes data (traces of the operations) Web pages (your application provides a web front-end that should be tested) Database queries (your application relies on a database server and some tables contain useful data or procedures that should be tested) SNMP agents (your application provides information through an SNMP agent that can be polled or that sends SNMP traps) Commands or scripts that test the application, giving its status or other useful information JMX-enabled servers that you want to poll and monitor
3. Specify what should be searched for in these information sources:

Strings (regular expressions) that are to be found or not to be found Numeric values that will be used to build a graph in the console (with alert thresholds)
4. Specify what Monitoring Studio should do when an application failure has been detected:
Decide what kind of Alert Actions are to be taken when an error is detected.
Configuring Monitoring Studio to Monitor your Application
50

Version 8.6.53
Day-to-day Monitoring with BMC Performance Manager Monitoring Studio

Once configured, the application or IT component is monitored and displayed in the PATROL Console. This IT component is now monitored just like any other standard component of the system (hardware, OS, middleware, etc.).
M o nito ring Stud io T re e Vie w Ele m e nts
Operators use Monitoring Studio to monitor the applications just like any other KM to: Get information about the application/component Trigger various tests Refresh values Get histories Get alerts and notifications
Day-to-day Monitoring with BMC Performance Manager Monitoring Studio
51
User Guide

Version 8.6.53
Introduction
This chapter helps you understand how Monitoring Studio KM for PATROL works and what you can do with it. It also provides detailed information on the product tools and operations: Monitoring Features Thresholds and Alerts Actions Configuration Reports Daily Task Two sections are respectively dedicated to examples and troubleshooting information.
Monitoring Features
This section describes all the monitoring tools offered by this version of Monitoring Studio, and it provides step-by-step illustrated details mon how to use each monitoring tool.
Application/Container Icons
Objective
The aim of the application/container tool is to group several monitoring objects related to the same monitored application, IT component or device. It greatly facilitates the monitoring management of applications/components and permits you to have a clean and well-structured hierarchy of the monitored objects.
Method (summary)
Create a new application or container icon (when created, it appears at the same level as the main Monitoring Studio icon).
You can create sub-containers within y our application/container which is v ery useful to ensure that the monitoring matches y our actual applications as closely as possible.
Specify an application name (or container name) and enter properties that will be useful to operators such as: Description of the application Name of contact in case of an application failure, etc. In addition, it is possible to specify up to three advanced options that facilitate the monitoring management of applications:
53

Version 8.6.53
You can set command lines that allow starting or stopping of the application from the menu command. You can specify signature files whose existence means that the managed application is currently present on the system and consequently should be monitored (great for clustered applications). And the third option consists of setting application constants which are very useful for monitoring an application whose properties may change from one system to another.
Result
The application/container icon appears in the PATROL console and you can create or add other monitored objects belonging to the application under it. This way they are all grouped together. This is useful, for instance, if you wish to apply global Alert Actions to all monitored objects belonging to one application. The application containers enable you to have a clean and structured hierarchy of your monitored objects.
Create and edit application/container icons

To create a new application/container icon, right-click the Monitoring Studio icon in the PATROL Console and select KM Commands > New > Application icon (container)
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd W e lco m e Pa g e
To edit an existing application/container icon, right-click the icon in the PATROL Console > select KM Commands > Edit. To create sub-containers, right-click the application/container icon under which you want to create a sub-container > select KM Commands > New > Sub-container
Monitoring Features
54

Version 8.6.53
Step 1: Identifying the application to monitor (naming a container)
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd Co nta ine r Na m e Pa g e
Container name: Enter the name of the container or application to monitor. This builds the label of the icon in the PATROL Console. Description (optional): Description of the application or IT component being monitored. Contact (optional): Enter the name of the person to be alerted or who can provide support in case of an application failure. Let me setup advanced options: Selection enables setting advanced options.
Monitoring Features
55

Version 8.6.53
Step 2: Advanced options (optional)

If you decide to set advanced options in the previous panel shown, the next dialog panel gives you access to three options start--stop; signature files; applications constants:
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd A d v a nce d Op tio ns Pa g e
Click on the desired button to show the panel for the corresponding option.
Start -- Stop
This option enables the starting and stopping of an application through a Monitoring Studio KM command. To activate this feature, you need to specify two command lines: One to start the application, and the other to stop it, and then enter user credentials to run these commands. On clicking the Start--Stop button in the panel shown above, the following panel pops-up:
Monitoring Features
56

Version 8.6.53
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd A d v a nce d Op tio ns (Sta rt/Sto p Op tio ns ) Pa g e
<Application name> can be started with the following command line: Set a command line to start the application. <Application name> can be stopped with the following command line: Set a command line to stop the application. Run these commands as this user with password: Enter a login and password to execute the start and stop command lines. If you enter the word "PASSWORD" as a Command name, the corresponding value will automatically encrypted once you click the Finish button at the last step of the wizard. The Password field will then show instead of the actual password characters.
Make sure y ou click the A ccept button before y ou go to the nex t step. If y ou click the C ancel button, the newly applied settings will be disregarded!
You can start or stop this application by right-clicking on the application/container icon > KM commands > Manage > Start the application/Stop the application.
Monitoring Features
57

Version 8.6.53
Signature files
This is a feature for managing the monitoring of clustered applications. The presence of signature files indicates that the managed application is currently available on the system and should be monitored. When none of these signature files are present, it means that the application is not actually present on the system and consequently should not be monitored. In such case, Monitoring Studio will disable the entire monitoring of this application. This can be extremely useful when the application is hosted by a "fail-over" cluster. When you click the Signature files button in the first panel of "Advanced options", the following panel is displayed:
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd A d v a nce d Op tio ns (Sig na ture File ) Pa g e
Paths to the signature files: Up to four signature file paths can be entered in these fields. The application monitoring will be performed only if a minimum of one of these four files is found. The presence of a signature file means that the application is currently present and should be monitored. If none of the required files can be found, the application monitoring will be turned offline.
These file names do not accept wildcards.
Make sure y ou click the A ccept button before y ou go to the nex t step. If y ou click the C ancel button, the freshly applied settings will be disregarded!
Monitoring Features
58

Version 8.6.53
Application Constants
Application constants are defined at the level of an application/container and can be reused in the various objects underneath. They facilitate the monitoring across various systems of an application whose properties may change from one system to another.
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd A d v a nce d Op tio ns (A p p lica tio n Co ns ta nts ) Pa g e
Example 1 When creating the application/container icon for "MyApplication", you define the APP_PATH constant with the /opt/MyApp value. Then, when creating a "LOG File Analysis" object in Monitoring Studio, you can specify %{APP_PATH}/log/MyApp.log as the path to the LOG file. If you plan to monitor the same application on another system, and this application is located under another directory (/usr/local/MyApp for example), you will be able to use the same configuration of Monitoring Studio (export and import) and just modify the APP_PATH constant on the new system.
Example 2 You specify the monitoring of a remote device using SNMP polling and SNMP trap listening objects in Monitoring Studio. Instead of specifying the IP address of the remote device directly in these SNMP objects, you can define a DEVICE_IPADDRESS Application Constant at the level of the application/container and use % {DEVICE_IPADDRESS} in the SNMP polling and SNMP listening objects. If the IP address changes later, you will only need to modify the value of the DEVICE_IPADDRESS constant, instead of editing every SNMP polling and trap listening object.
Monitoring Features
59

Version 8.6.53
Constant name: Enter the name of the constant. Example: APPLICATION_PATH Value: Set a value for the constant. Example: /opt/MyApp. If you enter the word "PASSWORD" as a Constant name, the corresponding value will automatically encrypted once you click the Finish button at the last step of the wizard. The Value field will then show instead of the actual password characters. Required: Check the box to activate this newly-set application constant.
W hen y ou check the R equired box , the monitoring of the application container and all its dependent objects are taken offline if the v alue of the application constant is not set. This ensures that no monitoring operation is performed until the required application constants are properly set.
This feature is particularly useful if you create an application monitoring template where all the defined application constants are empty in this case, you first: 1. 2. 3. Import the configuration template Enter values to all required application constants before the monitoring actually starts Click Accept. The application constant/s will be taken into consideration by Monitoring Studio.
Step 3: Monitoring Studio settings
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd Obje ct ID Pa g e
Container/Application name: Label that will be displayed in the PATROL Console for this application/container monitoring object. Object ID: PATROL internal identifier of this application/container. Click Finish and the application/container icon will appear in the PATROL console.
Monitoring Features
60

Version 8.6.53
Removing an application icon/container

You can remove an application icon or container from the PATROL Console simply by right-clicking the application icon and selecting KM commands > Delete. After confirmation, the application icon and all its dependent objects will be removed from the PATROL Console and from the agent configuration.
Deletion of an application icon or container cannot be undone.
Application icons/container objects are instances of the SW_APPLICATIONS class.
Command Line Analysis

Objective
The aim of this tool is to execute a command line and parse the output of this command, and in addition, verify the status of the execution by searching for a string, to run an infinite background command or to stop a command execution if the timeout elapses. Although Monitoring Studio offers a variety of tools with extensive capabilities, you may have an inhouse script or command that you need to run and analyze at regular intervals in order to monitor your application. You can configure Monitoring Studio to execute any command line and parse the output of this command. In addition, the command line execution feature allows you to: Stop the command execution once a given timeout is reached Verify the status of the execution by searching for a string Run a background command that never ends Thus, the command line execution feature gives you the options you need to properly execute, analyze and monitor the script or command line.
The program or script being ex ecuted should not need any user interaction and should not create any window. Monitoring Studio will analy ze its output, i. e. what has been written to the stdout and stderr streams.
The command line analy sis features prov ides a "do-it-y ourself" kind of tool allowing y ou to ex ecute any shell script or VBScript and search for Strings and Numeric v alues in the returned output.
Monitoring Features
61

Version 8.6.53
Create or edit a command line analysis

To create a new Command Line analysis, right-click the application/container icon in the PATROL Console and select KM Commands > New > Command Line analysis...
Ne w Co m m a nd Line Ex e cutio n W iza rd W e lco m e Pa g e
To edit an existing Command Line analysis, right-click the Command Line icon in the PATROL Console and select KM Commands > Edit.
Monitoring Features
62

Version 8.6.53
Classic command execution

Step 1: Entering the command line to execute
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd Co m m a nd Line Pa g e
Command line to execute: Enter the OS command line or the path to the script that Monitoring Studio will execute. Execute this command line as Username/Password: Enter a username and password if the command line needs to be run with a user account different from the default PATROL Agent account.
You can use the % {TIME: } and % {LA STTIME: } macros in the command line that will be ex ecuted. They will be replaced respectiv ely by the current time and by the last ex ecution time. See F ormat sy mbols for more details on the macros.
Monitoring Features
63

Version 8.6.53
Examples The following command line runs the diagnose.sh shell script and parses its output: /opt/myApp/bin/diag/diagnose.sh The following command executes a VBS script: CSCRIPT.EXE //NoLogo C:\MyApplication\bin\diag\diagnose.vbs The following command dumps the errpt log on IBM AIX and does only take into account the new lines that have been logged since the last polling: errpt a s %{LASTTIME:%m%d%H%M%S}
Step 2: Execution period, and execution timeout

As the option This command needs to be launched only once and runs continuously is not selected in step 1, the following dialog box is displayed.
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd Co m m a nd Ex e cutio n Pe rio d Pa g e
Stop the command if it takes longer than seconds: The time after which the command will be stopped.
If the timeout is reached, the v alue of the Ex ecutionStatus parameter will be set to 1, indicating that the command failed to ex ecute properly . No further analy sis will be performed (String and Numeric Value searches).
Monitoring Features
64

Version 8.6.53
Command to execute if the timeout above is reached: A command similar to a recovery/cleaning action that will be executed when the timeout is reached.
The {% PID} macro can be used to indicate the PID of command line process being interrupted.
Step 3: Command execution validation (optional)

This option is useful to avoid basic execution errors like File not found because the command line was mistyped. The following panel will pop up:
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd Co m m a nd Ex e cutio n Va lid a tio n Pa g e
Command Exit Status: States if the command line has been properly executed: Select an execution option (succeeded/failed). This option qualifies the exit code returned at the end of the command line execution. Enter one or several exit codes separated by commas. When one of the exit codes is found or not depending on the execution option selected, Monitoring Studio triggers an alarm on the ExitStatus parameter to indicate that the execution failed. Command execution validation: The regular expression entered here will be searched in the output of the command. If it is not found, the value of the ExecutionStatus parameter will be set to 1, indicating that the command failed to execute properly.
Monitoring Features
65

Version 8.6.53
Ne w A p p lica tio n/Co nta ine r Ico n W iza rd Se tting s Pa g e
Object display name: Label that will be displayed in the PATROL Console for this command line monitoring object. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
If y ou select Use default thresholds and customize them; on clicking F inish, the Set Thresholds panel will appear, certain parameters for the instance may appear with an asterisk sy mbol - indicating that they already hav e thresholds. You can then customize (any /all) the thresholds of the parameters as per y our specific needs.
Monitoring Features
66

Version 8.6.53
Do not set any thresholds for now: No thresholds will be set on any parameter of the instance, and as a result no alerts will be triggered. Monitoring Studio will poll the object and return the output of the polling but will not raise any alerts until you set thresholds.
Thresholds can be set or modified at any time by right-clicking on the instance > KM commands > Set Thresholds.
Never-ending Command Execution

Step 1: Entering the command line to execute
Ne v e r-e nd ing Co m m a nd Ex e cutio n Co m m a nd Line
Command line to execute: Enter the OS command line or the path to the script that Monitoring Studio will execute. Execute this command line as Username/Password: Enter a username and password if the command line needs to be run with a user account different from the default PATROL Agent account. This command needs to be launched only once and runs continuously: A so-called "neverending" command is a program or script that runs continuously. It is not actually polled but instead executed just once and the returned value of the command is displayed in the ReturnOutput parameter as it runs. In addition, String and Numeric value searches are performed as new output is received.
You can use the % {TIME: } and % {LA STTIME: } macros in the command line that will be ex ecuted to display the current time and the last ex ecution time. See F ormat sy mbols for more information on how to format the % {TIME: } and % {LA STTIME: } macros.
Monitoring Features
67

Version 8.6.53
Example The following command line runs the diagnose.sh shell script and parses its output: /opt/myApp/bin/diag/diagnose.sh The following command executes a VBS script: CSCRIPT.EXE //NoLogo C:\MyApplication\bin\diag\diagnose.vbs The following command dumps the errpt log on IBM AIX and does only take into account the new lines logged since the last polling: errpt a s %{LASTTIME:%m%d%H%M%S}
Step 2: Confirm never-ending command and additional command to execute to stop the never-ending command
If you select the option This command needs to be launched only once and runs continuously in step 1, the following pop-up asks you to confirm your choice:
Ne v e r-e nd ing Co m m a nd Ex e cutio n Co nfirm a tio n M e s s a g e
Once the "never-ending" option is confirmed, the following dialog box confirming that the command line will be executed just once and will run continuously is shown:
Monitoring Features
68

Version 8.6.53
Ne v e r-e nd ing Co m m a nd Ex e cutio n Co m m a nd Ex e cutio n
Additional command to execute in such a case: Enter a specific command to execute in order to stop the execution of the previous launched never-ending Command. This command runs when the command analysis is deleted from the PATROL configuration. It is required to properly end the execution of the command. Abort any previous execution of this command upon a PATROL Agent restart: Select this option if you wish the system to automatically stop the execution of the previous launched never-ending Command upon the next PATROL Agent restart. Click Next.
Monitoring Features
69

Version 8.6.53
Ne v e r-e nd ing Co m m a nd Ex e cutio n Se tting s
Object display name: Label displayed in the PATROL Console Object internal identifier (ID): PATROL internal identifier What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
70

Version 8.6.53
Thresholds can be set or modified at any time by right-clicking on the instance > KM co m m a nd s > Se t T hre s ho ld s .
Command line analysis objects are instances of the SW_OSCOMMANDS class.
Database Query Analysis

Objective
The aim of this tool is to execute SQL queries on most of the database servers currently available on the market (Microsoft SQL, MySQL and Oracle for instance) and monitor their return output within your PATROL environment. You can then run string or numeric value searches on the return output to get/monitor the result in myriad ways. You need no longer run separate SQL queries.
Method (Summary)
If the application you wish to monitor uses a database server, you can test this database by sending applicative queries to the database server, or by testing the content of some critical application tables. Once you specify an SQL query, you can search for strings in the result set and build graphs using the numerical values returned. Queries can be set up to perform complex tasks with just the click of a button, and they can be saved for future use. As query results are stored by Monitoring Studio in a pipe-separated table format, it is easy to specify strings to be searched or numeric values to be extracted from a database query. Please refer to the string search and numeric value extraction sections for more information.
Example How the database query result is formatted and then searched for strings and numeric values:
Monitoring Features
71

Version 8.6.53
Create or edit a database query analysis

To create a new database query analysis, right-click the Application/Container icon in the PATROL Console and select KM Commands > New > Database Query analysis To edit an existing Database query analysis, right-click the Database Query analysis icon in the PATROL Console and select KM Commands > Edit.
Step 1: Selecting the database type
Da ta ba s e Que ry A na ly s is W iza rd W e lco m e Pa g e
Select a database type: Specify here whether the database used by your application is an Oracle Database Server, MySQL Server, a Microsoft SQL Server, or any Other database (supporting only ODBC connections). Let me set up the database connection method: Check this option to select the connection method you wish to use to access the database. A list of available connection methods will be displayed in next wizard's panel. Click Next to continue.
Step 2: Selecting the connection method

Monitoring Studio searches for an existing Database Query Analysis in the configuration for the selected database type. If a Database Query Analysis is found, Monitoring Studio uses these settings to access the database. If no Database Query Analysis is found, the following panel is displayed whether the Let me set up the database connection method is selected or not.
Monitoring Features
72

Version 8.6.53
Da ta ba s e Que ry A na ly s is W iza rd Da ta ba s e Co nne ctio n M e tho d Se le ctio n
Command line utility: Select this option to use the command line tool developed by the database provider to manage access to a database. This method is by far the fastest but requires the command line tools to be installed on the local server and properly set. These command line tools are: Microsoft SQL Server: OSQL MySQL Server: MySQL Oracle Database Server: Oracle SQL*Plus Java Database Connectivity (JDBC): Select this option to use JDBC to perform the query to the database. This method is the slowest and requires Java to be installed on your local server. Open Database Connectivity (ODBC): Select this option to use ODBC to perform the query to the database. This method is known as the most flexible. However, it requires the proper driver to be installed on the local server as well as Java for UNIX/Linux servers.
A dditional information: SQ L queries on O racle Database running on W indows serv ers can only be performed locally with the O DBC connection method; for UNIX, SQ L queries are not limited to the local host but a specific driv er must be installed on the serv er where the agent is running. Performing an SQ L Q uery on a Microsoft SQ L database installed on a UNIX Serv er is only possible with JDBC and O DBC connection methods since Microsoft does not prov ide O SQ L for UNIX.
The next steps depend on the database server and the connection method selected:
Step 3: Connection Information

MS SQL Server: 3.1a: Setting Command line connection to Microsoft SQL database servers 3.2a: Setting JDBC connection to Microsoft SQL database servers 3.3a: Setting ODBC connection to Microsoft SQL database servers) MySQL Server: 3.1b: Setting Command line connection to MySQL database servers 3.2b: Setting JDBC connection to MySQLSQL database servers 3.3b: Setting ODBC connection to MySQLSQL database servers)
Monitoring Features
73

Version 8.6.53
Oracle Database Server: 3.1c: Setting Command line connection to Oracle database servers 3.2c: Setting JDBC connection to Oracle database servers 3.3c: Setting ODBC connection to Oracle database servers) Other (ODBC only): 3.1d: Setting ODBC connection to Other database servers The two following steps of he Database Query Analysis wizard are common to all database queries and connection methods. They follow Step 3 that depends on the database server and the connection methods you have selected (see above).
Step 4 - Defining the query to be executed
Da ta ba s e Que ry A na ly s is W iza rd Que ry De finitio n Pa g e
SQL Query to execute: Single line SQL statement to be executed by the Oracle server. This can be also the path to an existing SQL script file.
Use the following sy ntax if y ou want to ex ecute the SQ L query from a file: "@ @ < file name> ". O nly supported with C ommand Line connection method.
Query timeout: When the execution exceeds the given timeout (in seconds), the ConnectionStatus parameter goes into alert. Clicking Next brings you to the last step of the wizard with the Monitoring Studio settings.
Example Oracle service name: BACKENDDB Username: sysApp
Monitoring Features
74

Version 8.6.53
Password: ****** SQL query: SELECT COUNT(*) FROM PendingCustomers Behavior: Will connect to the BACKENDDB Oracle server instance using the sysApp database account and ask the server to return the number of rows in the Pending Customers table. This query should give a number representing the number of waiting customers for the application.
Step 5 -Monitoring Studio settings

The final step of the wizard allows you to enter information related to the query labeling and the threshold settings.
Da ta ba s e Que ry A na ly s is W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console Object internal identifier (ID): PATROL internal identifier of this monitored object What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
75

Version 8.6.53
Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Database query analysis objects are instances of the SW_DB_QUERIES class.
Setting connection to Microsoft SQL Server Databases

This section details the various connection settings available for performing queries on Microsoft SQL database server. Step 1 and 2 are common to all database queries and connection methods. They are documented in the Database Query Analysis section.
Step 3.1a - Setting Command line connection to Microsoft SQL database servers
If you have selected Command Line Utility as the connection method at Step 2 of the Database Query Analysis wizard, the following panel is displayed:
Monitoring Features
76

Version 8.6.53
Da ta ba s e Que ry A na ly s is W iza rd M icro s o ft SQL Se rv e r Co m m a nd Line Co nne ctio n Se tting s
Hostname: Name of the server where SQL Server is running (host name or IP address) SQL Server instance name: Specify the SQL server instance name if there are several SQL Server instances installed. Leave "default" if there is a single instance Database name: Name of the database Authentication mode (SQL Server/Windows): Select Windows if you wish to connect to the database through your Windows user account. Select SQL Server if you wish to connect the database with a specified login name and password from a non-trusted connection. In that case, SQL Server performs the authentication itself by checking to see if a SQL Server login account has been set up and if the specified password matches the one previously recorded. If SQL Server does not have a login account set, authentication fails and you get an error message. Username: Account used to connect to the database Password: Password associated with the specified username Click Next to access the query definition panel.
Monitoring Features
77

Version 8.6.53
Step 3.2a - Setting JDBC connection to Microsoft SQL database servers

If you have selected Java Database Connectivity (JDBC) as the connection method at Step 2 of the Database Query Analysis wizard, the following panel is displayed:
Da ta ba s e Que ry A na ly s is W iza rd M S SQL Se rv e r J DBC Co nne ctio n Se tting s
Host name: Name of the server where SQL Server is running (host name or IP address) SQL Server instance name: Specify the SQL server instance name if there are several SQL Server instances installed. Leave "default" if there is a single instance Database name: Name of the database Authentication mode (SQL Server/Windows): Select Windows if you wish to connect to the database through your Windows user account. Select SQL Server if you wish to connect the database with a specified login name and password from a non-trusted connection. In that case, SQL Server performs the authentication itself by checking to see if a SQL Server login account has been set up and if the specified password matches the one previously recorded. If SQL Server does not have a login account set, authentication fails and you get an error message. Port: Specify the Microsoft SQL port number Username: Account used to connect to the database Password: Password associated with the specified username Click Next to access the query definition panel
Monitoring Features
78

Version 8.6.53
Step 3.3a - Setting ODBC connection to Microsoft SQL database servers

If you have selected Open Database Connectivity (ODBC) as the connection method at Step 2 of the Database Query Analysis wizard, the following panel is displayed:
Da ta ba s e Que ry A na ly s is W iza rd M S SQL Se rv e r ODBC Co nne ctio n Se tting s
Click Next to open the query definition panel. ODBC Driver (for ODBC Connection only): Select the appropriate ODBC driver. The ODBC driver must be installed on the PATROL Agent Host name: Name of the server where SQL Server is running (host name or IP address) Database name: Name of the database Username: SQL Server account used to connect to the database Password: Password associated with the specified username
Monitoring Studio prov ides two driv ers for W indows: SQ L Serv er and SQ L Serv er 2005; and one driv er for UNIX: Easy soft O DBC -SQ L
Click Next to access the query definition panel.
Monitoring Features
79

Version 8.6.53
Setting connection to MySQL Server Databases

This section details the various connection settings available for performing queries on MySQL database server. Step 1 and 2 are common to all database queries and connection methods. They are documented in the Database Query Analysis section.
Step 3.1b - Setting Command line connection for MySQL database servers
Da ta ba s e Que ry A na ly s is W iza rd M y SQL Da ta ba s e Se rv e r Co m m a nd Line Co nne ctio n Se tting s
Hostname: Name of the server where MySQL Server is running (host name or IP address) Database name: Name of the database Port: Specify the MySQL port number Path to mysql command-line tool: Enter the path to the mysql tool Username: MySQL Server account used to connect to the database Password: Password associated with the specified username Click Next to access the query definition panel.
Monitoring Features
80

Version 8.6.53
Monitoring Studio connects to My SQ L databases using the my sql command-line tool. This client can be downloaded from the My SQ L website and is installed by default when installing a My SQ L database. This command-line tool, called my sql on Linux /UNIX and my sql. ex e on W indows needs to be installed on the sy stem that will perform the SQ L queries. Monitoring Studio uses the following optional my sql parameters to connect to the database and ex ecute the SQ L query : connect_timeout: The number of seconds before connection timeout (as entered in the Monitoring Studio interface). quick: Do not cache each query result; print each row as it is receiv ed. This may slow down the serv er if the output is suspended. W ith this option, my sql does not use the history file. It forces my sql to retriev e results from the serv er a row at a time rather than retriev ing the entire result set and buffering it in memory before display ing it. This is done to av oid problems due to insufficient memory for large result sets. safe_updates: A llow only those UPDA TE and DELETE statements that specify which rows to modify by using key v alues. no_beep: Do not beep when errors occur. silent: Silent mode. Produce less output. skip_column_names: Do not write column names in results.
Step 3.2b - Setting JDBC connection to MySQL database servers

Da ta ba s e Que ry A na ly s is W iza rd M y SQL Da ta ba s e Se rv e r J DBC Co nne ctio n Se tting s
Hostname: Name of the server where MySQL Server is running (host name or IP address) Database name: Name of the database Port: Specify the MySQL port number Username: Account used to connect to the database
Monitoring Features
81

Version 8.6.53
Password: Password associated with the specified username Click Next to access the query definition panel.
Step 3.3b - Setting ODBC connection to MySQL database servers

Da ta ba s e Que ry A na ly s is W iza rd M y SQL Da ta ba s e Se rv e r OCBC Co nne ctio n Se tting s
ODBC Driver (for ODBC Connection only): Select the appropriate ODBC driver. The ODBC driver must be installed on the PATROL Agent Hostname: Name of the server where MySQL Server is running (host name or IP address) Database name: Name of the database Username: Account used to connect to the database Password: Password associated with the specified username
Monitoring Studio prov ides two driv ers (W indows and UNIX): My SQ L C onnector 3. 5 and My SQ L C onnector 3. 51.
Monitoring Features
82

Version 8.6.53
Setting connection to Oracle Database Server

This section details the various connection settings available for performing queries on Oracle database server. Step 1 and 2 are common to all database queries and connection methods. They are documented at the beginning of this section. .
Step 3.1c: Setting Command line connection to Oracle database servers

Da ta ba s e Que ry A na ly s is W iza rd Ora cle Da ta ba s e Se rv e r Co m m a nd Line Co nne ctio n Se tting s
System identifier (Oracle SID) or connection string: Specify the Oracle SID of the database server you want to connect to.
If the O racle Instant C lient is installed, y ou can use the sy ntax ://hostname:1521/oracleSID. O therwise, this must match one of the tnsnames. ora entries.
Monitoring Features
83

Version 8.6.53
Oracle location: Path to the Oracle client. This can be either ORACLE_HOME if the Oracle Database Server or Full Client is installed (example: c:\Oracle\ora92, or the path to Oracle Instant Client (example: /opt/oracle_instant_client). Optional alternate TNS_ADMIN path: If the Oracle Database Server or Full Client is installed and the tnsnames.ora file is not located in the default directory, you can specify the path to the directory which contains tnsnames.ora that will allow SQL*Plus to resolve the Oracle SID that you entered in the first field. Username: Database account to use to connect to the server Password: Password associated with the specified username.
Note that space characters are not supported for passwords in W indows, thus y ou need to enter a space-free password if y ou are working with this operating sy stem.
SQ L*Plus: Monitoring Studio uses O racle SQ L*Plus to connect to an O racle Database Serv er. Therefore, SQ L*Plus needs to be installed on the computer where Monitoring Studio and the PA TR O L A gent are running. SQ L*Plus is installed by default with O racle Database Serv er (from v ersion 7. x to 10g). If y ou are configuring local queries, y ou need to enter the current O R A C LE_HO ME as the O racle location. SQ L*Plus is also installed by default with the O racle Database C lient (from v ersion 7. x to 10g). If the O racle Database C lient has been installed on the computer where the PA TR O L A gent is running, y ou need to enter the current O R A C LE_HO ME as the O racle location. Starting with v ersion 10g, O racle now prov ides a new lightweight client: O racle Instant C lient. This new client is made of sev eral packages. In order to make O racle queries with Monitoring Studio, y ou need to install the "Instant C lient Basic" (or "Instant C lient Basic Lite") as well as "Instant C lient SQ L*Plus". Specify the directory where y ou unzipped the O racle packages as the O racle location. O n W indows, Monitoring Studio will try to detect by itself the SQ L*Plus settings. O n Linux and UNIX, Monitoring Studio will detect the proper SQ L*Plus settings only if the PA TH env ironment v ariable contains the directory of the SQ L*Plus binary .
O racle sy stem identifier (O racle SID): If O racle Database Serv er of the full O racle Database C lient is installed on the computer where the PA TR O L A gent and Monitoring Studio are running, SQ L*Plus will be using the classic name resolution sy stem. In this case, the O racle sy stem identifier (O racle SID) that y ou enter in the first field will be resolv ed by using the tnsnames. ora file. In most cases, the tnsnames. ora file is located in the $O R A C LE_HO ME/network/admin directory . If it is located in another specific directory , y ou must specify the optional alternate TNS_A DMIN path (only enter the path to the directory ). The tnsnames. ora needs to be maintained by an O racle administrator. Please consult y our database administrator if the O racle sy stem identifier of the database y ou want to connect to is not registered in the tnsnames. ora file. If the O racle Instant C lient is installed on the computer where the PA TR O L A gent and Monitoring Studio are running, y ou do not need the tnsnames. ora file. Instead, y ou can use the following sy ntax for the O racle sy stem identifier: //serv er_hostname:1521/database_sid
Monitoring Features
84

Version 8.6.53
Step 3.2c - Setting JDBC connection to Oracle database servers

Da ta ba s e Que ry A na ly s is W iza rd Ora cle Da ta ba s e Se rv e r J DBC Co nne ctio n Se tting s
Hostname: Name of the server where Oracle Server is running (host name or IP address) Database name: Name of the database Port: Specify the Oracle port number Username: Database account to use to connect to the server Password: Password associated with the specified username Click Next to access the query definition panel.
Monitoring Features
85

Version 8.6.53
Step 3.3c - Setting ODBC connection to Oracle database servers

Da ta ba s e Que ry A na ly s is W iza rd Ora cle Da ta ba s e Se rv e r ODBC Co nne ctio n Se tting s
ODBC Driver (for ODBC Connection only): Select the appropriate ODBC driver. The ODBC driver must be installed on the PATROL Agent Hostname: Name of the server where Oracle Server is running (host name or IP address) Database name: Name of the database Username: Database account to use to connect to the server Password: Password associated with the specified username
Monitoring Studio prov ides an O racle driv er for W indows and the Easy soft O racle O DBC driv er for UNIX serv ers. O n W indows, only queries to a local O racle database are supported.
Monitoring Features
86

Version 8.6.53
Setting connection to Other Databases (ODBC only)

This section details the various connection settings available for performing queries on database servers other than MS SQL, MySQL or Oracle. Step 1 and 2 are common to all database queries and connection methods. They are documented in the Database Query Analysis section.
Step 3.1d - Setting Command line connection to Other database servers (ODBC only)
Connection settings for databases other than MS SQL, MySQL or Oracle is only supported through ODBC connection. You can set the connection parameters with the following panel:
Da ta ba s e Que ry A na ly s is W iza rd Othe r (ODBC o nly ) co nne ctio n s e tting s Pa g e
Monitoring Features
87

Version 8.6.53
Connection String: Enter the connection string that includes attributes such as the name of the driver, server, database and security information (user name and password). In computing, a connection string is a string that specifies information about a data source and the means of connecting to it. It is passed in code to an underlying driver or provider in order to initiate the connection.The connection string may include attributes such as the name of the driver, server and database, as well as security information such as user name and password.Whilst commonly used for a database connection, the data source could also be a spreadsheet or text file. Password: Passwords are sensible information that should not be displayed without being encrypted. When a password is included in the string you need to execute, you must use the % {PASSWORD} macro in the string and enter the corresponding password in the Password field (encrypted display). Example String = Driver={MySQL ODBC 3.51 Driver};Server=myserver;Database=mydatabase; User=user;Password=%{SW_PASSWORD};Option=3; Password = *********
Note that space characters are not supported for passwords in W indows, thus y ou need to enter a space-free password if y ou are working with this operating sy stem.
Click Next to open the query definition panel.
Dynamic Object Builder

Objective
The aim of the Dynamic Object Builder is to monitor objects whose return output is dynamic by applying a set of user-defined rules this return output data. The monitoring features supporting Dynamic Object Builders are: Command Line Analysis Database Query Analysis File Monitoring and Analysis Java MBean Polling SNMP Polling Text Pre-Processing WBEM Query Analysis Web Request Analysis WMI Query Analysis
Method (Summary)
What the PATROL administrator does:
Monitoring Features
88

Version 8.6.53
Creates a set of rules to apply to output data Creates String Search/Numeric Value Extraction templates to apply to dynamic items What the Dynamic Object Builder does: Applies the user-defined set of rules to the output data Extracts each matching line and creates a dynamic object for each of them in the PATROL console according to the user-defined naming Groups all dynamic objects under a dynamic container to facilitate the management of all the dynamic objects What analyzing and/or processing commands may be applied to the data: You can analyze the dynamic objects with String Search and Numeric Value Extraction. If you have selected the Trigger an alarm when objects are missing option, a parameter named Status is automatically added to the PATROL Console for Dynamic Items. It informs you of the Dynamic Item presence or absence upon each collect.
Create or edit a dynamic object

To create a Dynamic Object Builder, right-click one of the monitoring features supporting Dynamic Object Builders and select KM Commands > New > Dynamic Object Builder... To edit a Dynamic Object Builder, right-click the Dynamic Object Builder icon in the PATROL Console and select KM Commands > Edit.
Dy na m ic Obje ct Build e r W iza rd W e lco m e Pa g e
Monitoring Features
89

Version 8.6.53
1. Defining the rules to apply to the output data
Dy na m ic Obje ct Build e r W iza rd R ule s De finitio n Pa g e
View Parameter Output: Displays the output data to which the Dynamic Object Builder rules will be applied. Keep only lines matching the regular expression below: Specify the regular expression you wish the Dynamic Object Builder to search for in the output data. Each matching lines is displayed in a separated Dynamic Item automatically added in the PATROL Console under the Dynamic Container icon. Exclude lines matching the regular expression below: Specify the regular expression you wish the Dynamic Object Builder to search for in the output data. Each matching lines will be ignored. Trigger an alarm when objects are missing: This option allows you to define if and how Monitoring Studio must trigger an alert when the Dynamic Item, containing the extracted line, is missing from one collect to another: Do not trigger any alert: Select this option if you do not wish Monitoring Studio to trigger any alert when objects are missing Trigger an INFORMATION: Select this option if you wish Monitoring Studio to trigger an Information alert when objects are missing Trigger a WARNING: Select this option if you wish Monitoring Studio to trigger a Warning alert when objects are missing Trigger an ALARM: Select this option if you wish Monitoring Studio to trigger an Alarm alert when objects are missing
Monitoring Features
90

Version 8.6.53
I you have chosen to trigger an alert, a Status parameter will automatically be activated and displayed under the Dynamic Item in the PATROL Console to indicate that the Dynamic Item is missing. Click the Status parameter to open a graph pane displaying the status history of the Dynamic Item. Delete missing objects: Set this option according to how you want Monitoring Studio to display missing objects in the console. The available options are: Never: Monitoring Studio never deletes missing objects in the console. They will always be present. As soon as they are missing: Monitoring Studio deletes missing objects from the console as soon as their absence is discovered. If an alarm is configured, Monitoring Studio will trigger the alarm before deleting the object. When they are missing .... in a row: Monitoring Studio deletes missing objects after they have been missing a specific number of times in a row Column separators: Define the way the Dynamic Object Builder detects columns of output data. Column contents are used to generate the Dynamic Items display name and ID in the PATROL Console.
Dy na m ic Obje ct Build e r W iza rd Co lum n s e p a ra to r d e finitio n
Monitoring Features
91

Version 8.6.53
2. Define Dynamic Objects, Instance Names and Internal identifier
Dy na m ic Obje ct Build e r W iza rd Dy na m ic Obje ct Na m e s a nd ID d e finitio n Pa g e
Object Display Name: Name of the Dynamic Object Builder as it will appear in the PATROL Console Object Internal Identifier (ID): Name used by the PATROL Console to internally identify the Dynamic Object Builder Object Display Name: Name of the Dynamic item that contains the data retrieved from the output data. This name will be used as a label to identify the Dynamic item in the PATROL Console Object Internal Identifier (ID): Name used by the PATROL Console to internally identify the Dynamic item More Information: Provides information on the objects creation and labeling Click Finish to apply the Dynamic Object Builder rules to the KM command output file. Dynamic Objects are instances of the SW_DYNAMIC class.
Using String Search and Numeric Value Extraction Templates

Features such as String Search and Numeric Value Extraction can help you analyze the Dynamic Items output. In order to apply these features to all the Dynamic Items in a single operation, the Dynamic Object Builder creates Templates instances of these features. While standard String Search and Numeric Value Extraction features apply to a single return output, Templates apply to all the Dynamic Items' output within the Dynamic Container (see step in the example below). When you modify a Template, the changes will apply to all the Dynamic Items upon the next data collection.
Monitoring Features
92

Version 8.6.53
Example How a Dynamic Object Builder elements are managed and displayed in the PATROL Console
File Monitoring and Analysis

Objective
The aim of this powerful File Monitoring tool is to instantly detect and alert if any files go missing, if a file is growing at a steady speed, if it is being regularly updated, if its security settings have changed, etc. The File Analysis tool is one of the most important monitoring tools as most applications deal with files and many of them are critical. Monitoring Studio allows you: To monitor the main characteristics of these files such as: presence, size, growth & security Parse file content to retrieve useful data (including strings that should be present or not and numeric values to build graphs). The most typical usage of file monitoring is parsing a LOG file. Most applications use LOG files to trace their operations and notify operators when failures occur.
Monitoring Features
93

Version 8.6.53
The difference between flat files and LO G files: A s opposed to the LO G files, so-called "flat files" are alway s entirely parsed when y ou specify strings or numeric v alues to search in the file. In LO G files, only the new lines will be scanned when searching for strings or numeric v alues.
Method (summary)
In order to monitor a file, you must first: 1. 2. Specify whether it is a flat file or a LOG file (Flat files are entirely updated and therefore need to be parsed entirely as opposed to LOG files where new lines are appended at the end of the file and therefore only these new lines need to be analyzed). Indicate the path to the file Select the characteristics to be monitored. If required, create string search and numeric value extraction objects If you have large multi-line records, or XML files or complex LOG files, you can first transform the content with the text pre-processing tool, and then run string and numeric value searches on it.
3. 4. 5. 6.
Result
Once the file monitoring is set up and string searches/numeric value searches/text preprocessing, and file security objects are set up for the monitored file, the objects hierarchy in the PATROL Console will be as illustrated in the image below:
Hie ra rchy in the PA T R OL Co ns o le
Create or edit a file monitoring

To create a new file monitoring and analysis, right-click the Application/Container icon in the PATROL Console > KM Commands > New > File monitoring and analysis...
Monitoring Features
94

Version 8.6.53
Step 1: Selecting the type of file to monitor
File M o nito ring a nd A na ly s is W iza rd W e lco m e Pa g e
To edit an existing file monitoring, right-click the file icon in the PATROL Console > KM Commands > Edit. To monitor the security settings of this file, right-click the file icon (once it has been created) in the PATROL Console > KM Commands > New > File Security check See section on "File security monitoring" for more information about this feature.
To specify strings to search in this file:

1. 2. Right-click the file icon (once it has been created) in the PATROL Console Select KM Commands > New > String search...
See section on "Searching for strings" for more information about this feature.
To specify numeric values to extract from this file:

1. 2. Right-click the file icon (once it has been created) in the PATROL Console Select KM Commands > New > Numeric Value extraction
See chapter "Searching for numeric values" for more information about this feature.
Monitoring Features
95

Version 8.6.53
Step 2: Identifying the file to monitor

Identify the file you wish to monitor
File M o nito ring a nd A na ly s is W iza rd File Na m e a nd Pa ra m e te rs Pa g e
File name and path: Path and name of the file to be monitored.
W ildcards can be used in the path or file name. In this case, the most recently modified or created file matching the criteria will be monitored. The wildcard characters that can be used are: '?': replaces one character, '*': replaces one or more characters. It is also possible to use a format Menu C ommand to dy namically assign the current date or time in the file name or path. Simply insert the following string in the "F ile name and path" field, replacing the three dots by date format sy mbols: % {A SC TIME: }. F or the complete list of format sy mbols, meaning and some ex amples, please see F ormat Sy mbols in the R eference section.
Example Monitor: /opt/myApplication/log/myApp*.log Behavior: Monitoring Studio will look for the most recent file that matches the mask (/opt/ myApplication/log/myApp_20030807_1711 e.g.) and start the monitoring of this file. When the application stops writing in this LOG file and creates a new one (/opt/myApplication/log/ myApp_20030808_0512 e.g.), Monitoring Studio analyses the current file for changes and searches for strings and numbers, and then switch to this new file. This way, no information is lost when switching from the previous file to the new one.
Monitoring Features
96

Version 8.6.53
Select the parameters you want to monitor: Select only those relevant to this file monitoring and deselect the others. See SW_FILES for parameter details.
W hen y ou set or edit thresholds, the thresholds dialogue box display s only those parameters selected at this stage. A t a later stage, if y ou wish to monitor more parameters of this file (or less), click on the instance > KM commands > Edit and select or de-select the parameters.
Click Next. You arrive at the last panel of the file monitoring set-up process.
A warning panel will appear if the file does not actually ex ist/if the path entered is incorrect.
File M o nito ring a nd A na ly s is W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console Object internal identifier (ID): PATROL internal identifier of this monitored object. Although modifiable, it is strongly recommended not to change the default ID. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
97

Version 8.6.53
If y ou select Use default thresholds and customize them; on clicking F inish, the Set Thresholds panel will appear, and certain parameters for the instance may appear with an asterisk sy mbol - indicating that they already hav e thresholds. You can then customize (any /all) the thresholds of the parameters as per y our specific needs.
File monitoring objects are instances of the SW_FILES class.
File System Monitoring

Objective
The aim of the File System monitoring tool is to enable operators to rapidly identify impacted applications by distinguishing and specifying what applications rely on which file systems. File systems (or Windows logical disks) are often a critical resource for applications. Although file systems are already monitored by BMC Performance Manager for Servers, operators often do not know which application is impacted when a file system is full.
Monitoring Features
98

Version 8.6.53
Create or edit a file system monitoring

To create a new file system monitoring, right-click the Application/Container icon in the PATROL Console and select KM Commands > New > File System monitoring... To edit an existing file system monitoring, right-click the File System icon in the PATROL Console and select KM Commands > Edit.
Step 1: Identifying the file system to monitor
File Sy s te m M o nito ring W iza rd o n W ind o ws W e lco m e Pa g e
Select a File System: This drop-list box contains the list of file systems on the computer. Select the file system you wish to monitor. UNIX/Linux with more than 30 file systems: On UNIX/Linux servers with more than 30 file systems, PSL limitations render the correct functioning of a long drop-down list difficult, hence these systems will display the dialogue box. By clicking Existing File Systems a small box showing current file systems will appear. Again, owing to PSL limitation, selection of the drive/file system with the cursor is not possible you are required to enter the drive manually. The panel that shows all the drives is for display/information purpose only. Click Accept/Cancel. The parameters you can monitor on a file system are:
Monitoring Features
99

Version 8.6.53
FreeMegabytes: Free space left in megabytes. It is possible to trigger an alert when the free space in MB is lower than a given value. FreeSpacePercent: Displays the free space in percentage. You can configure Monitoring Studio to trigger an alert when the percentage of free space on the file system is lower than a given threshold. UsedSpaceGrowthPercentage: Shows how fast the file system is filled up, in percentage of its size (in percentage per hour - %/hour). Note that the UsedSpaceGrowthPercent parameter may have negative values. UsedSpaceGrowthSpeed: Shows how fast the file system is filled-up (in megabytes per hour MB/hour). Note that the UsedSpaceGrowthSpeed parameter may have negative values.
File Sy s te m M o nito ring W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
100

Version 8.6.53
If y ou select Use default thresholds and customize them; on clicking Finis h, the Set Thresholds panel will appear, certain parameters for the instance may appear with an asterisk sy mbol - indicating that they already hav e thresholds. You can then customize (any /all) the thresholds of the parameters as per y our specific needs.
File system monitoring objects are instances of the SW_FILESYSTEMS class.
File security check

Objective
The aim of this tool is to offer you a complete coverage of file monitoring by allowing you to ensure that file security is respected. With a few clicks, you can monitor the access and rights of groups and users and define who should be alerted if the file content is changed or if security is breached.
Create or edit a File security monitoring

To create a new File Security monitoring, right-click the File monitoring icon in the PATROL Console and select KM Commands > New > File security check.... To edit an existing File Security monitoring, right-click the File security icon in the PATROL Console and select KM Commands > Edit.
Step 1: Selecting the security parameters to monitor

The first panel of the File Security wizard allows you to select different file security options.
Monitoring Features
101

Version 8.6.53
File Se curity Che ck W iza rd W e lco m e Pa g e
Granted file access rights User that owns the file Group that may have access to the file File integrity. Check the options and click Next to proceed.
By default, Monitoring Studio will use the current file attributes and owners in the nex t steps. If the current file configuration is the correct one, simply click on Nex t until the end of the wizard.
Step 2: Files access rights

This panel helps you select the type of alert to be triggered if the files access rights do not match the criteria entered. Depending on the operating system the PATROL agent is running on, you may get different options. On UNIX and Linux systems
Monitoring Features
102

Version 8.6.53
W ind o ws Se rv ice M o nito ring W iza rd File A cce s s R ig hts o n UNIX/Linux Sy s te m s
Choose type of alert: The first dropdown list enables you to choose the type of alert to trigger if the current file mode does not match the "expected" file mode. File access rights: These are the classic file access rights that can be looked up by executing an "ls l" command. The mode consists of 10 characters, for example, -rwxr-xr-x. The first character indicates the entry type: b: block special file c: character special file d: directory l: symbolic link n: network special file p: fifo (also called a \"named pipe\") special file s: socket -: ordinary file The next 9 characters are interpreted as three sets of three characters each which identify access and execution permissions for the owner, group, and others categories. The" "indicates that permission is not granted. Various permission combinations are possible, except that the x, s, S, t, and T characters are mutually exclusive. The access right characters are interpreted as follows:
Monitoring Features
103

Version 8.6.53
-: Deny all permissions in the corresponding position. r: Grant read permission to the corresponding user class. w: Grant write permission to the corresponding user class. x: Grant execute (or search in directory) permission to the corresponding user class. s: Grant execute (search) permission to the corresponding user class. Execute the file as if by the owner (set user ID, SUID) or group (set group ID, SGID), as indicated by position. S: Deny execute (search) permission to the corresponding user class. Execute the file as if by the owner (set user ID, SUID) or group (set group ID, SGID), as indicated by position. t: Grant execute (search) permission to others. The "sticky" (save text image) bit is set. T: Deny execute (search directory) permission to others. The "sticky" (save text image) bit is set. On Windows systems The file access rights depend on the Access Control List (ACL) on Windows systems. An ACL is a table that tells a computer operating system the access rights each user has to a particular system object, such as a file directory or individual file. Each object has a security attribute that identifies its access control list. The list has an entry for each system user with access privileges. The most common privileges include the ability to:
Monitoring Features
104

Version 8.6.53
Read a file (or all the files in a directory) Write to the file or files Execute the file (if it is an executable file, or program).
W ind o ws Se rv ice M o nito ring W iza rd File A cce s s R ig hts o n W ind o ws Sy s te m s
In Windows, an access control list is associated with each system object. Each ACL has one or more access control entries (ACEs) consisting of the name of a user or group of users. The user can also be a role name, such as "programmer," or "tester." For each of these users, groups, or roles, the access privileges are stated in a string of bits called an access mask. Generally, the system administrator or the object owner creates the access control list for an object.
Monitoring Features
105

Version 8.6.53
In this panel, you can: Enter up to 8 users or groups Indicate the access criteria: read, write or execute Specify the type of alert to be triggered if the files access rights differ from the specified criteria.
Step 3: Ownership
Monitoring Studio can check if the files owner is approved.
W ind o ws Se rv ice M o nito ring W iza rd File Owne rs hip Pa g e
Select the type of alert: Do nothing; Trigger an ALARM; Trigger a WARNING; Trigger an INFORMATION Specify whether the file owner is or is not: Specify whether or not the files owner should or should not match the specified names.
Step 4: Files group

Monitoring Studio checks if a group differs from the specified criteria.
Monitoring Features
106

Version 8.6.53
W ind o ws Se rv ice M o nito ring W iza rd File Gro up Pa g e
Select the type of alert: Do nothing; Trigger an ALARM; Trigger a WARNING; Trigger an INFORMATION Specify whether the files group is or is not: Specify whether or not the files group matches the specified criteria.
Step 5: Files integrity

In this panel, you are simply asked to select the type of alert to trigger when the files content is modified.
W ind o ws Se rv ice M o nito ring W iza rd File Inte g rity Pa g e
Select the type of alert: Do nothing; Trigger an ALARM; Trigger a WARNING; Trigger an INFORMATION
Monitoring Features
107

Version 8.6.53
W ind o ws Se rv ice M o nito ring W iza rd Se tting s Pa g e
PATROL Object Label: Label displayed in the PATROL Console. PATROL Object ID: PATROL internal identifier of this File security monitoring. Although modifiable, it is strongly recommended not to change the default ID. Poll every "x" minutes: Set the polling interval for this monitored object. The default polling interval is 2 minutes.
File security check objects are instances of the SW_FILE_SECURITY class.
Monitoring Features
108

Version 8.6.53
Folder Monitoring
Objective
The aim of the tool is to monitor folders (directories) that store files processed by the application: measure their size, growth and flow (including how many files move in, how many out, etc.). Folders/directories are often critical elements for an application and checking their content is a good way to monitor the application's health.
Method (summary)
Identify the folder to monitor Specify the parameters Monitoring Studio tests and measures the content of this folder every two minutes (total size, number of files) and compute the file flows (how many new files, how many removed files) etc depending on the options selected.
Result
This allows you to: Ensure that your application is not overloaded (number of files to be processed, e.g.) Measure the application activity (how many removed files, that is, how many have been processed) Check the age of the newest file (whether the data is coming in properly) Check the age of the oldest file (whether the application late in processing queued files).
F older monitoring may be time-consuming for large size folders. Therefore, Monitoring Studio will automatically reduce its monitoring features when the monitored folder contains more than 1000 files. If y ou want to av oid the use of this limit, y ou can set the configuration v ariable "/MA SA I/SENTR Y8/folderLimit" to a v alue greater than 1000.
Create or edit a folder monitoring

To create a new folder monitoring, right-click the application/container icon in the PATROL Console and select KM Commands > New > Folder monitoring...
Monitoring Features
109

Version 8.6.53
Fo ld e r M o nito ring W iza rd W e lco m e Pa g e
To edit an existing folder monitoring, right-click the folder icon in the PATROL Console and select KM Commands > Edit.
Step 1: Identifying the folder
Ne w Co m m a nd Line Ex e cutio n W iza rd Fo ld e r Id e ntifica tio n Pa g e
Folder name and path: Enter the name and path of the folder (directory) to be monitored.
Monitoring Features
110

Version 8.6.53
Include sub-folders: Check this box to monitor all the sub-folders of the above-specified folder. Monitor only files matching the mask below (optional): Specify the file types or enter masks, and only these files will be monitored.
You can use wildcards such as "*" to replace any number of characters, or "?" to replace just one character. You may also use sev eral masks separated by ";". Monitoring Studio will only take into account the files matching the masks entered.
Example You can enter:.txt;myFiles?.log;file.*, and all files matching these masks will be monitored
Step 2: Select the parameters
M o nito ring Fo ld e r W iza rd Pa ra m e te rs Pa g e
What the parameters signify: Folder Disk Usage: FolderSize: Total size of all files in the folder (and sub-folders if asked). GrowthPercentage: Growth of the folder since the last polling. This is the last recorded size divided by the polling interval. Unit: percent per minute. This parameter can also be negative. GrowthSpeed: Growth speed of the folder since the last polling, divided by the polling interval. Unit: kilobytes per minute.
Monitoring Features
111

Version 8.6.53
Folders File Flow: FileCount: Current number of files in the folder DeletedFileCount: Number of files deleted from this folder since the last polling, divided by the polling interval. Unit: files per minute NewFileCount: Number of new files added to this folder since the last polling, divided by the polling interval. Unit: files per minute Files Modified: ModifiedFileCount: Number of files modified since the last polling, divided by the polling interval. Unit: files per minute LastModifiedFileElapsedTime: Time elapsed since the last modification/creation of a file in this folder. Unit: minutes OldestModifiedFileElapsedTime: Time lapsed since the last modification/creation of the oldest file in this folder. Unit: minutes
Fo ld e r M o nito ring W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
112

Version 8.6.53
Folder monitoring objects are instances of the SW_FOLDERS class.
Multi-Parameter Formula
Objective
The aim of this Multi-Parameter Formula tool is to monitor parameters of any KMs loaded in your console and to apply a mathematic formula to the collected values in order to obtain a meaningful result.
Method (summary)
The Multi-Parameter Formula option has been specifically designed to apply mathematical formulas to monitored Knowledge Modules parameters. All you need to do is: Create a Multi-Parameter Formula Select the parameter(s) of the KM that you wish to monitor Define the formula you wish to apply to the collected value(s) Enter a name and an identifier for the object, representing the formula results, that will be created in the console Set the threshold conditions
Result
You can then receive alerts for any malfunction in the KM(s) that could in turn affect the functioning of your application.
Monitoring Features
113

Version 8.6.53
Create or edit a Multi-Parameter Formula

To create a new Multi-Parameter Formula, right-click the application/container icon in the PATROL Console and select KM Commands > New > Multi-Parameter Formula...
M ulti-Pa ra m e te r Fo rm ula W iza rd W e lco m e Pa g e
To edit an existing Multi-Parameter Formula, right-click the Multi-Parameter Formula icon in the PATROL Console and select KM Commands > Edit.
Monitoring Features
114

Version 8.6.53
Step 1: Selecting the parameter(s) you wish to use in the formula
M ulti-Pa ra m e te r Fo rm ula W iza rd Pa ra m e te r(s ) Se le ctio n Pa g e
Select the parameter(s) you wish to use in the formula: Click as many parameters as you need to select. The list displays all the KMs and their respective parameters currently available on the Agent. Click Next to continue. If needed, check the Use the objects display name to dynamically determine the PATROL IDs option to allow the use of label instances instead of PATROL IDs to determine a parameter's path. This option may be particularly useful when an object ID is unknown; in that case, upon each collect, Monitoring Studio will determine the parameter's path according to the parameter's class and the selected instance label. Monitoring Studio will list the objects actually present at the time of the collect and will only consider and monitor the first instance that matches the label selected in the MultiParameter Formula wizard.
Monitoring Features
115

Version 8.6.53
Step 2: Define the formula to apply to the monitored parameter(s)
M ulti-Pa ra m e te r Fo rm ula W iza rd De fining a fo rm ula to a p p ly to the s e le cte d p a ra m e te r(s )
The parameter(s) you have selected at the previous step are listed and labeled alphabetically: A, for the first parameter, B for the second, C for the third, and so on. Use these letters to represent the parameters in the formula. Formula: Enter the formula you wish to apply to the parameter(s). Use the standard mathematical symbols to do so, such as: + - / * ( ). Do not collect if one or more parameter has no value: Select this option if you do not wish to collect data for parameter(s) not returning any value.
O ff-line parameters and parameters with no v alues (like collectors) are display ed as "O F F LINE" in the list. It is recommended not to select these parameters.
Monitoring Features
116

Version 8.6.53
Step 3: Defining a name for the formula result
M ulti-Pa ra m e te r Fo rm ula W iza rd De fining a Na m e fo r the Fo rm ula R e s ult
Object display name: Label that will be displayed in the PATROL Console for this Multi-Parameter Formula. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Do not set any thresholds for now: No thresholds will be set on any parameter of the instance, and as a result no alerts will be triggered. Monitoring Studio will poll the object and return the output of the polling, but will not raise any alerts until you set thresholds.
Monitoring Features
117

Version 8.6.53
Click Finish to start monitoring the selected parameters. A new object labeled with the name you have entered at Step 3, is automatically created under the application/container icon in the PATROL console.
M ulti-Pa ra m e te r Fo rm ula Obje ct in the PA T R OL Co ns o le
Multi-Parameter Formula objects are instances of the SW_KMWATCH class.
Numeric Value Extraction

Objective
The aim of this tool is to enable you to fine-tune your monitoring by searching for and extracting actual values from a source of information (the output of a command, a web page, the result of a SQL query, or WBEM query etc.), and build graphs with these values. Problems with an application are not always as simple as a sentence explaining that an "error has occurred." Sometimes, an application reports its health by providing critical numbers, like a queue length, a processing time, a utilization percentage, etc. These numbers may be reported by the application through its files, in the output of commands, in a database, in a Web page, etc. Monitoring Studio extracts these values and reports them as graphs in the Console. This feature is called "Numeric Value extraction" as its purpose is to extract numeric values from a text input (the output of a command, a web page, the result of a SQL query, or WBEM query etc.).
Method (summary)
All you need to do is indicate how to find the numeric value(s) within the information source. The basic mechanism is: 1. 2. 3. 4. Specify an information source Specify with a regular expression the location of the numeric value within the searched lines Indicate the numeric values position in these lines i.e. before/after the string; column number etc. Indicate which numbers are to be considered if several lines contain the searched numeric value: first value, last value, calculate average; highest value; lowest value.
The numeric value searching function works a bit differently on "running sources" (LOG files and neverending command lines) than on flat sources (flat files, command lines, Web requests, etc.): On "running sources" (LOG files and never-ending command lines); the numeric values are searched only in new lines since the last polling. On "flat sources" (flat files, command lines, Web requests, database queries), the numeric values are searched in the entire source (the whole file, the whole standard output, the whole HTTP response, the whole data-set). If several values are found, it is possible to select which value should be kept: the last value found, the
Monitoring Features
118

Version 8.6.53
average of all values, the minimum or maximum or a total of all values. A graph is then built with these values.
Create or edit a numeric value search

To create a new numeric value search, right-click the information source icon (file, Web request, etc.) in the PATROL Console and select KM Commands > New > Numeric Value Extraction...
Num e ric Va lue Ex tra ctio n W iza rd W e lco m e Pa g e
To edit an existing numeric value search, right-click the Numeric Value Extraction icon in the PATROL Console and select KM Commands > Edit.
Step 1: Lines to be taken into account

Provide information about the line(s) in which the numeric value will be searched for:
Monitoring Features
119

Version 8.6.53
Num e ric Va lue Ex tra ctio n W iza rd Line s Id e ntifica tio n Pa g e
Lines to be taken into account: Specify which lines are to be searched for the numeric value. The information to enter subsequently depends on this first choice. There are three modes to choose from: All lines: All lines of the text will be scanned for the Numeric value search. There is no need to enter anything. Line numbers (fill in below): Only specific line numbers will be scanned. If this mode is selected, the line numbers must be specified in the text field below. Line numbers are specified as follows: x, y: line x and line y x-y: all lines from x to y inclusive x: all lines from 1 to x inclusive x-: all lines from x to the end of the file inclusive If the "Skip blank lines" option is selected, empty lines will be ignored in the line-count. Lines matching the regular expression below: The lines scanned will be lines matching the regular expression specified in the field.
Step 2: Location of the numeric value within the selected lines

Indicate the position of the numeric value to be found:
Monitoring Features
120

Version 8.6.53
Num e ric Va lue Ex tra ctio n W iza rd Lo ca tio n Pa g e
The numeric value is located: There are four different modes to choose from and the information to enter depends on this choice. After/before the string: Indicate if the numeric value is located after or before the string to be entered in the text field. At the character offset: The value should be at a specific character offset in the line. Enter the offset number in the box. Monitoring Studio will look for the numeric value at that exact character offset in the line. If no numeric data is found, no value will be collected.
A character offset is nothing but the character "number", for ex ample: y ou want to search for a v alue that starts from the 7th character in the line. . . so y ou will enter "7" as the character offset.
In the column number: The previously selected lines contain several columns identified by a separator character. Enter the column number that should contain the value and click the "Column separators" button to specify how columns are separated.
Monitoring Features
121

Version 8.6.53
Num e ric Va lue Ex tra ctio n W iza rd Co lum n Se p a ra to r De finitio n
The panel shows the available default separators: Blank space, semicolon, tabulation, comma, pipe. Check or uncheck separators as you need. You can also add a list of custom separators in the "Other" text box. Simply type the separators one after the other. Consecutive separators must be treated as a single one: Typically, it indicates that consecutive separators must be treated as a single separator. Consecutive separators mean empty columns: Each separator is treated as an individual column separator and the column is considered empty. The above two options are especially useful for data separated by blanks. Expected format: Select how the numeric values are formatted. This option allows you to extract numeric values that use blank, comma or points as decimal and thousand separators. The value can be negative: Specify if the numeric values that you are looking for can be negative.
If Monitoring Studio does not find a number at the specified location, no numeric v alue will be ex tracted and the PA TR O L graph will not be refreshed (space characters are ignored).
Step 3: Value selection from multiple matches
Num e ric Va lue Ex tra ctio n W iza rd A d d itio na l Op tio ns Pa g e
If several values are found in the searched text, it is necessary to identify which one should be used to set the parameter value and build the graph in the PATROL Console. The possible choices are: Keep the first value found Keep the last value found (default)
Monitoring Features
122

Version 8.6.53
Calculate the average Keep the lowest value Keep the greatest value Add up all values
Step 4: Parameter Selection

Select the parameters you wish to collect.
Num e ric Va lue Ex tra ctio n W iza rd Pa ra m e te rs Se le ctio n Pa g e
Value: Reports the actual value collected upon data polling Delta: Calculates the difference between values collected during two consecutive polling. DeltaPerSecond: Reports the value resulting of the division of the Delta by the number of seconds elapsed between the collection times Select the option "Discard negative Delta values" if you do not want negative values to be reported on the graph. Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extracted in order to have a more readable graph in the PATROL Console. The available rescaling options are: No rescaling Divide the value by a value that then gives you the reading in terms best suited to you Multiply the extracted value by a constant factor
Monitoring Features
123

Version 8.6.53
This can be useful if you extract numeric values in bytes but prefer to show a graph in megabytes. In such a case, you would divide the values by 1048576 (1024*1024).
Num e ric Va lue Ex tra ctio n W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
124

Version 8.6.53
Numeric value search objects are instances of the SW_NUMBERS class.
Process Monitoring
Objective
The aim of the Process Monitoring tool is to ensure that an application is functioning properly by checking if the processes of an application are running. Monitoring Studio provides an application-oriented mechanism to test the presence of such processes.
What is a process
In practice, a process is basically a binary code being executed by processors. Processes are launched by the operating system and have several properties: PID (unique identifier of a process); Name; User ID; Command line that was used to launch the process (arguments passed to the binary); Environment; CPU and memory usage; Other various OS-specific properties. For further details on the concepts related to processes, please refer to About processes in the Reference section.
Method to monitor a process (summary)

On Windows, UNIX and Linux systems, Monitoring Studio allows you to check the presence of these processes by specifying one or more of the following criteria: Name of the process (as it appears in ps or in the Windows Task Manager) Command line that was used to spawn the process Username the process is run as PID (process ID) Once you have entered the criteria to detect the processes of your application, you can select which parameters should be monitored. When several processes match the entered criteria, the selected parameters will be valued in the PATROL Console (under the single process icon) by summing up the value of the parameters for each matching process. Advanced privileges are sometimes required to collect process information. In that case, you will be prompt to enter process command credentials that will be used for running OS commands. See section Process Command Credentials for more information.
Result
All processes that match the entered criteria will be monitored and identified as one icon in the PATROL Console.
Monitoring Features
125

Version 8.6.53
Example If the criterion entered to detect the processes is "ORA," then all the Oracle processes will be monitored within a single icon in the PATROL Console. The ProcessorTime parameter under this icon will represent the sum of the processor time of all Oracle processes.
Creating and editing a process monitoring

To create a new process monitoring, right-click the Application/Container icon within the PATROL Console and select KM Commands > New > Process monitoring....
Step 1 Select the action you wish to perform
Pro ce s s M o nito ring W iza rd W e lco m e Pa g e
To edit an existing process monitoring, right-click the Process icon within the PATROL Console and select KM Commands > Edit.
Step 2 a: Pick the process to monitor from a list

The aim of this option is to let users select a process from a list with a simple click. Monitoring Studio builds the list of processes currently running on the monitored server with all the details of each process: PID, process name, user name and command line.
Monitoring Features
126

Version 8.6.53
Pro ce s s M o nito ring W iza rd Pick the p ro ce s s to m o nito r fro m a lis t
Click the process you wish to monitor and click the Next button. This will bring up the process criteria panel (see step 1-b) with all information already filled. You may remove or modify any information you do not wish to monitor from this panel and proceed with the wizard.
Processes with long command lines may take more than one line to display all the arguments. You can click on any of the process lines to select the process from the list.
If y ou proceed to the nex t panel and come back to this one, the process y ou chose will not be pre-selected from the list. This is due to some PSL limitation. You hav e to re-select the process before clicking on Nex t > . You may , of course, select any other process.
It may take a few seconds for the panel to be display ed. Monitoring Studio has to retriev e the list of currently running processes which may a moment depending on the serv er ty pe and the number of processes running.
Step 2 - b: Criteria the monitored process must match with

If you choose to specify criteria that the monitored process must match with, the following dialog box is shown:
Monitoring Features
127

Version 8.6.53
Pro ce s s M o nito ring W iza rd Ente r crite ria to id e ntify a nd m o nito r p ro ce s s e s
The name of the process must be exactly/must contain: Choose the appropriate option and enter the name of the process to monitor. Under Windows, do not forget the ".exe" extension at the end of the name. Must be exactly: Signifies that Monitoring Studio will search for a process whose name is exactly as stated in the text you enter.
The tex t entered in the fields is case-sensitiv e on UNIX and Linux , but not on W indows.
AND the command line that launched the process must match the regular expression below/must contain: Enter a regular expression. Only processes that have been launched by a command-line that matches this regular expression will be monitored. AND the process must be running as this user: Enter the user name the monitored process is running as. View processes: Click this button to view the currently running processes. Here are a few examples:
Criteria
Example 1 Process name MUST BE EXACTLY patrolagent.exe Command-line = <nothing>
Processes that match the criteria
PatrolAgent.Exe C:\Patrol\PatrolAgent.exe -p 3181
Monitoring Features
128

Version 8.6.53
Criteria
User Identity = <nothing> Example 2 Process name MUST BE EXACTLY patrolagent.exe Command-line MUST MATCH THE REGULAR EXPRESSION -[pP] 3181 User Identity = <nothing> Example 3 Process name MUST CONTAIN pat Command-line = <nothing> User Identity = <nothing>
Processes that match the criteria

C:\Patrol\PatrolAgent.exe
C:\Patrol\PatrolAgent.exe -p 13181
PatrolAgent.exe PatProcess.exe PatrolPerf.exe
Step 2 - c: PID files

If you choose to specify a PID file, the following dialog box is shown:
Pro ce s s M o nito ring W iza rd Pro v id e a PID file p a th
Path to the file containing the Process PID: Enter the path for the file with the process PID. At each polling, Monitoring Studio reads this file, retrieves the PID number and checks whether this process PID exists or not. Normally, the process PID is dynamically allocated. The process PID number should be at the very beginning of the files content.
Monitoring Features
129

Version 8.6.53
Step 3: Select parameters
Pro ce s s M o nito ring W iza rd Pro ce s s PID: Pa ra m e te r Se le ctio n
Heres a table that describes the parameters available for process monitoring:
Name
Count ChildCount ProcessorTime HandleCount (Windows only) PageFaultsPerSec (Windows only) PageFileBytes (Windows only) PrivateBytes (Windows only) ThreadCount (Windows only) VirtualBytes WorkingSet (Windows only)
Description
Displays the number of processes that match the criteria. Unit: Processes Displays the number of children of the matching process(es). Unit: Processes Displays the processor time percent used by the matching process(es). Unit: Percentage (%) Displays the number of handles opened by the matching process(es). Unit: Handles Displays the number of page faults per second caused by the matching process(es). Unit: Page fault/sec Displays the page file used by the matching process(es). Unit: Megabytes Displays the processor time percent used by the matching process(es). On multiprocessor computers, this parameter may go over 100%. Unit: Percentage (%) Displays the number of threads of the matching process(es). Unit: Threads Displays the virtual memory used by the matching process(es). Unit: Megabytes Displays the working set size of the matching process(es). Unit: Megabytes
Monitoring Features
130

Version 8.6.53
Pro ce s s M o nito ring W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console. Object internal identifier (ID): PATROL internal identifier of this process monitoring. What thresholds do you want to set for the newly created object? The drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
131

Version 8.6.53
Process monitoring objects are instances of the SW_PROCESSES class.
SNMP Polling
Objective
The aim of this tool is to poll the SNMP agent and retrieve the values of a given OID (object identifier), or the values of an SNMP table, thereby enabling the operator to easily identify the source of the problem or just be informed of the status of the monitored device/parameter. Many applications rely on middleware instrumented with SNMP (Simple Network Management Protocol) agents, which contain managed objects that provide information related to the current state of its operation. These objects are arranged in a Management Information Base (MIB). SNMP is an Application Layer protocol that allows external tools to communicate with the agent and read the values of the objects.
Method (summary)
The SNMP agent collects critical information about the middleware, and Monitoring Studio, directly polls the agent and retrieves the value of a given OID (object identifier). All the operator has to do is interrogate the MIB and interpret the value of the OID retrieved by Monitoring Studio. The 3 basic steps to poll the SNMP agent are: Launch the SNMP polling wizard Identify the host (SNMP agent), port and community string Specify the OID to be polled or values from an SNMP Table
Result
Monitoring Studio will get the value and allow you to store it in a graph, or search for strings in the OID content
Create or edit a SNMP polling

To create a new SNMP polling: Right-click the Application/Container icon in the PATROL Console and select KM Commands > New > SNMP polling. To edit an existing SNMP polling: Right-click the SNMP polling icon in the PATROL Console and select
Monitoring Features
132

Version 8.6.53
KM Commands > Edit.
Step 1: Select the type of value you want to poll: Single OID value or SNMP table values
SNM P Po lling W iza rd W e lco m e Pa g e
A single value from one OID: Select this option to poll a value from one OID Multiple values from rows of an SNMP table: Select this option to poll several values from an SNMP table Click Next to launch the corresponding set-up wizard.
Monitoring Features
133

Version 8.6.53
Single value from one OID

Step 2: Identifying the SNMP agent and the OID to poll
SNM P Po lling W iza rd SNM P a g e nt a nd OID s e le ctio n Pa g e
Host: Enter the IP of the computer running the SNMP agent that will be polled. If it is the same server as the one the PATROL agent runs on, it is possible to use the following IP: 127.0.0.1 Port: Enter the port used by the SNMP agent to communicate Community: Enter the name of the community used by the SNMP agent OID to poll: Enter the OID (object identifier) to poll, as given by the Management Information Base (MIB) After clicking Next, the wizard will try to poll the OID to identify its type. If, for some reason, the OID cannot be polled, a warning message is displayed. The user must select an OID type, either String or Integer, to let Monitoring Studio know what kind of value is expected. If you are not sure about the OID type, it is recommended to select The OID returns a string.
If y ou are unsure about the ex act O ID to poll, y ou should use a SNMP MIB Browser tool to identify which O ID corresponds to which v ariable. You can also use the Monitoring Studio built-in SNMP Browser tool to list the av ailable O ID v ariables and their v alues. R ight-click the main Monitoring Studio icon > KM C ommands > Tools > SNMP Browser.
Monitoring Features
134

Version 8.6.53
Select the parameter you wish to collect:
SNM P Po lling W iza rd Pa ra m e te r Se le ctio n Pa g e
Value: Reports the actual value collected upon data polling Delta: Calculates the difference between values collected during two consecutive polling. DeltaPerSecond: Reports the value resulting of the division of the Delta by the number of seconds elapsed between the collection times Select the option "Discard negative Delta values" if you do not want negative values to be reported on the graph. Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extracted in order to have a more readable graph in the PATROL Console. The available rescaling options are: No rescaling Divide the value by a value that then gives you the reading in terms best suited to you Multiply the extracted value by a constant factor This can be useful if you extract numeric values in bytes but prefer to show a graph in megabytes. In such a case, you would divide the values by 1048576 (1024*1024). Click Next to display the last panel of the wizard.
Monitoring Features
135

Version 8.6.53
SNM P Po lling W iza rd Se tting s Pa g e
Multiple values from an SNMP Table

Step 2: Identifying the SNMP agent and the list of columns from the SNMP table to poll
Monitoring Features
136

Version 8.6.53
SNM P Po lling W iza rd SNM P a g e nt id e ntifica tio n Pa g e
Host: Enter the IP of the computer running the SNMP agent that will be polled. If it is the same server as the one the PATROL agent runs on, it is possible to use the following IP: 127.0.0.1 Port: Enter the port used by the SNMP agent to communicate Community: Enter the name of the community string used by the SNMP agent SNMP Table OID: Enter the Table OID (object identifier) to poll, as given by the Management Information Base (MIB) List of table columns to poll: Enter the column numbers whose values should be retrieved. Enter ID to retrieve the row identifier. Leave the field blank to retrieve all values; or enter the column numbers separated by commas. Example: 4,8,9.
If for some reason, the O ID cannot be polled, a message is display ed stating that the table seems to be empty . In such a case, v erify that y ou hav e entered the right O ID and/or that the table really ex ists and has v alues.
SNM P Po lling W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this SNMP polling object Object internal identifier (ID): PATROL internal identifier of this SNMP polling monitoring What thresholds do you want to set for the newly created object? The drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
137

Version 8.6.53
If y ou select Use default thresholds and customize them; on clicking F inish, the Set Thresholds panel will appear, and certain parameters for the instance will appear with an asterisk sy mbol - indicating that they already hav e thresholds. You can then customize (any /all) the thresholds of the parameters as per y our specific needs.
Do not set any thresholds: No thresholds will be set on any parameter of the instance, and as a result no alerts will be triggered. Monitoring Studio will poll the object and return the output of the polling, but will not raise any alerts until you set thresholds.
For details on the parameters discovered, please refer to the Reference Guide. SNMP Polling objects are instances of the SW_SNMP_POLLING class.
SNMP Trap Listening

Objective
The aim of this tool is to monitor and listen for SNMP traps and enable rapid recovery actions depending on the traps received, thereby ensuring optimal functioning of applications or devices that use SNMP traps. SNMP Traps are network packets containing data about a component of the system. They are generated by an SNMP agent when certain conditions are met and then sent to an SNMP Trap listener. Many applications use SNMP traps to communicate information about their state.
Method (summary)
Listening for these SNMP traps is an essential way of ensuring the proper functioning of such applications. Launch the SNMP trap listening wizard Identify the SNMP agent Specify which trap to listen to by giving its Enterprise OID or trap number Set automatic acknowledgements of the traps and alert thresholds.
Result
Once an SNMP trap containing the right information is received, it is possible to run recovery actions to quickly take care of the problem. You can:
Monitoring Features
138

Version 8.6.53
Wait for a specific SNMP trap matching up to two "varbinds" OIDs containing specific strings Acknowledge a previously received SNMP trap with another trap
Create or edit a SNMP Trap listening

To create a new SNMP trap listening, right-click the Application/Container icon in the PATROL Console and select KM Commands > New > SNMP Trap listening....
SNM P T ra p Lis te ning W iza rd W e lco m e Pa g e
To edit an existing SNMP Trap listening, right-click the SNMP Trap listening icon in the PATROL Console and select KM Commands > Edit.
Monitoring Features
139

Version 8.6.53
Step 1: Identifying the agent and the traps to listen to
SNM P T ra p Lis te ning W iza rd A g e nt id e ntifica tio n Pa g e
IP address: IP address of the computer or device where the SNMP agent is running and that will send the SNMP traps. You can leave this field empty to listen to SNMP traps from multiple computers or devices. Community: Specifies the SNMP community name in which the Agent will be listening. Public is usually the default community used. Enterprise ID: Enterprise ID of the SNMP Trap. You may use wildcards. Trap number: Trap number contained in the SNMP Trap (optional). OID 1 & 2: First and second attached variables OID that should be contained within the SNMP trap (optional). It is also possible to enter the text that should be found (or not) within the OID content. Case sensitive: Indicates whether or not the search for the content that should be found within the attached variable content will be case sensitive. All these pieces of information define the SNMP Trap that is expected. Monitoring Studio will react to the SNMP Trap received only if this information is found within the SNMP Trap. All other SNMP Traps will be ignored.
If y ou are unsure about the characteristics of the SNMP trap y ou want to detect, y ou will need to use a SNMP MIB Browser tool to understand the ex act meaning of each trap. You can also use the Monitoring Studio built-in SNMP trap listener tool to v iew in real time the SNMP traps and their characteristics that are receiv ed by the PA TR O L A gent. R ight-click on the main Monitoring Studio icon > KM commands > Tools > R eal-time SNMP Trap Listener.
The SNMP trap listening port is actually a Patrol A gent configuration v ariable: /snmp/trap_port= 162. You can set this v ariable to whatev er port y ou want Monitoring Studio to listen on.
Monitoring Features
140

Version 8.6.53
The SNMP A gent emitting the traps should be configured to send them to the PA TR O L A gent where Monitoring Studio is installed and running. If the SNMP agent is not properly configured, Monitoring Studio will not receiv e any SNMP trap.
Step 2: Automatic acknowledgement
SNM P T ra p Lis te ning W iza rd A uto m a tic a ck no wle d g e m e nt Pa g e
Acknowledge alert(s) if the following SNMP Trap is received: Check the box if you wish to acknowledge an alert thanks to an SNMP trap received that matches the criteria set. Trap number: Enter the trap number that will acknowledge the alerts triggered by the specified trap. OID1 & 2: Definition of the attached variables OID that should be contained within the SNMP trap to acknowledge a matching trap received. Acknowledge alert(s) if the following timeout is reached: Check the box if you wish to acknowledge a matching SNMP trap after a certain time has been reached. Timeout value: Time, in minutes, after which the matching SNMP Trap received, will be acknowledged. This value is only applicable if you have checked the "Acknowledge alert(s) if the following timeout is reached" box. Action to be taken when the condition above is reached: Reset the MatchingTrapCount parameter to zero, i.e. clear all previous alerts Decrease the MatchingTrapCount by one; i.e. clear the previous alert
Monitoring Features
141

Version 8.6.53
SNM P T ra p Lis te ning W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
SNMP Trap listening objects are instances of the SW_SNMP_TRAPS class.
Monitoring Features
142

Version 8.6.53
String search
Objective
The aim of this tool is to enable you to run fast and powerful searches for strings. This is one of Monitoring Studios key features. A "must be found" string search looks through the specified file and triggers an alert if the specified string is not found. A "must not be found" string search triggers an alert when the specified string is found.
It is possible to run string searches on multi-line records, XML or HTML content. This is feasible owing to the Tex t Preprocessing tool. You use the Tex t Pre-processing tool to transform "complex " content, after which y ou can run string searches on it or ex tract numeric v alues from it. See Tex t Pre-processing for details.
LOG file analysis

The most commonly used method to monitor an application is still LOG files analysis. Applications log problems in a file as they occur. Monitoring this information helps in understanding the behavior and performance of the application. Most log monitoring tools do not offer acknowledgement/recovery actions. This is where the string search feature makes a difference: it not only allows you to search the LOG file for specified strings, but it is also enable automatic or manual acknowledgement of these errors.
Method (summary)
First specify an information source (a flat or LOG file, a Web request, a database query, a SNMP agent, a script to be executed) and then search for strings that must be found or not be found in the information source. Once you have defined the information source, you can specify a string search in a very detailed way, with the following options: A combination of two regular expressions with and/or/not Where to search in the line (which column, character offset etc.)
The string search engine parses the information source line-by -line. Therefore, the criteria y ou specify should apply to one line; ex cept if y ou hav e already pre-processed this tex t and hav e conv erted multi-line records to single lines. See topic Tex t pre-processing for more details.
The string searching function works a bit differently on "running sources" (LO G files and nev er-ending O S commands) than on flat sources (flat files, O S commands, W eb requests, etc. ): O n "running sources" (LO G files and nev er ending O S commands), the strings are searched only in new lines since the last polling. F or a string search in a running source, two graphs are built: Number of matches since the last acknowledgement and Number of matches per minute since the last polling. In addition, for LO G files and "nev er-ending" O S commands, y ou can specify auto-acknowledging strings that will automatically reset the graph to the "number of matches".
Monitoring Features
143

Version 8.6.53
O n "flat sources" (flat files, O S commands, W eb requests, database queries), the strings are searched in the entire source ev ery time (the whole file, the whole standard output, the whole HTTP response, the whole dataset). F or a string search in a flat source, one graph is built: Number of matches at the current polling.
You cannot use auto-acknowledging strings in flat sources (it is not applicable because the parameter restarts from 0 at each polling), but y ou can specify : Location/area of the source in which to search: n lines, pre-filter, etc.
Create or edit a string search

To create a new string search, right-click the information source icon (file, Web request, etc.) in the PATROL Console and select KM Commands > New > String Search... To edit an existing string search, right-click the String Search icon in the PATROL Console and select KM Commands > Edit.
Step 1: Specifying what to search for
String Se a rch W iza rd Se a rch d e finitio n Pa g e
Search for lines that: Contain/do not contain: You can enter up to two strings (regular expressions) to look for, and decide whether or not those strings should be contained in the line. It is also possible to specify if the two strings should be found together (AND), or if only one of the two strings is sufficient (OR). The string search is case sensitive: Check the box or leave it unchecked as per your need Select where to search: For each entered string, you can specify where in the line to search for the string
Monitoring Features
144

Version 8.6.53
Anywhere in the line (default) At the following character offset: if you choose to search for the string from a character offset in the line, you must specify the offset in this field. Character offset is nothing but the character number. For example, to search for a string that starts from the seventh character in the line, you enter the digit 7 as the character offset. In the following column number: Enter the column number Specify column separators if applicable: If you choose to search for the string from a specific column in the line, you must specify how to identify that column by entering the column number and specifying the separator. Click the column separator tab in order to select the appropriate field separator. The following panel shows the available default separators: blank space, semicolon, tabulation, comma, and pipe.
String Se a rch W iza rd Co lum n s e p a ra to r d e finitio n
Select or de-select applicable separators. For custom separators, enter the character in the field for Other. Consecutive separators must be treated as a single one: Typically, it indicates that consecutive separators must be treated as a single separator. Consecutive separators mean empty columns: Each separator is treated as an individual column separator and the column is considered empty. The above two options are especially useful for data separated by blanks.
Monitoring Features
145

Version 8.6.53
Step 2: Line selection (flat source only)
String Se a rch W iza rd Line s e le ctio n (fo r fla t s o urce o nly )
This window is only displayed when a string search in a flat source (flat file, command line, Web request, etc.) is added. Select which lines of the source should be scanned Search for the String(s) in all lines: The string(s) will be searched for in all the lines of the specified source. Search for the String(s) only in the following line numbers: Enter the list of line numbers you wish to scan separated by ;. Lines are specified as follows: x, y: line x and line y x-y: all lines from x to y inclusive x: all lines from 1 to x inclusive x-: all lines from x to the end of the file inclusive
Monitoring Features
146

Version 8.6.53
Step 2: Automatic acknowledgement of alerts (LOG files and "neverending" command lines only)
String Se a rch W iza rd A uto m a tic a ck no wle d g e m e nt
This dialog-box is displayed only for a string search on a "running source" (LOG file and never-ending OS commands). In such a case, each time the specified strings are found, the MatchingLineCount parameter increases and triggers an alert. The automatic acknowledgement feature allows you to reset MatchingLineCount value to zero and status to 'normal'. Acknowledge alert(s) if the string below is found: Check the box to acknowledge the alert. Specify the string Indicate whether or not it is case-sensitive Select where to search: specify the location of the string, enter the column separators if any Acknowledge alert(s) if a timeout of "x" minutes is reached: Check the box to enable alert acknowledgement. A timeout expires since the last matching line found; enter the value (default is set to 120 minutes). You can select both the above options. When the above condition is reached: When this occurs, you can either specify if all alerts previously triggered by this string search should be acknowledged at one time (the MatchingLineCount parameter goes back to zero), or if only one alert should be acknowledged (the MatchingLineCount parameter is decreased by one)
Monitoring Features
147

Version 8.6.53
Reset the MatchingLineCount parameter to zero (clear all previous alerts) Decrease the MatchingLineCount by one (clear the previous alert)
String Se a rch W iza rd Se tting s Pa g e
Object display name: Label that will be displayed in the PATROL Console for this string search object. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
148

Version 8.6.53
String search objects are instances of the SW_STRINGS class.
Text Pre-processing
Objective
The aim of this tool is to process multi-line, XML or HTML content and convert it to "line-by-line" text in order to be able to run string searches and/or numeric value searches on this content and then analyze and monitor the result. Most often, it is not possible to run string or numeric value searches in multi-line, XML or HTML content. For instance, the output of commands is in paragraph form, and as it is not possible to perform normal string or numeric value searches on paragraphs, it limits the monitoring and analyzing capabilities of such content. Monitoring Studio allows you to transform the paragraphs of the text into single lines for easy parsing with the String Search and Numeric Values Extraction tools. String Search and Numeric Value Extraction objects are then created from the Text Transform object (and not from the original parent object.
A brief example to illustrate the usefulness of this tool

Example of converting multi-line records to single lines The "ipconfig /all" command under Windows reports various information about each network card, and each "paragraph" is about one network card:
Monitoring Features
149

Version 8.6.53
The aim here is to detect any disconnected cards. So we add a monitoring instance for the OS command ipconfig/all. But as the text is in paragraphs, a direct string search will not get the desired result in this case which is why we run the Text pre-processing tool to convert the multi-line text to single lines. In the screenshot below, the "ipconfig /all" command is executed and its output is pre-processed to transform its paragraphs into single lines, which in turn enables an efficient parsing with a String search that looks for "disconnected" network cards.
Method (summary)
Right-click on the object whose content you require to preprocess in order to run string or numeric value searches on the output. Select the type of pre-processing you wish to perform: Convert multi-line records to single records Convert XML to CSV i.e. comma separated values Extraction of text from HTML Text processing through an external command
Result
The text is transformed as per your selection. Text Transform objects have only one text parameter, TransformResult, which is the result of the text transformation done on the original content (a file, the output of a command, an Web request, etc.). You can run string and/or numeric value searches on this "pre-processed" output.
Create or edit a Text Preprocessing object

To create a new Text Pre-Processing object, right-click the Application/Container icon in the PATROL Console and select KM Commands > New > Text Preprocessing....
Monitoring Features
150

Version 8.6.53
T e x t Pre -Pro ce s s ing W iza rd W e lco m e Pa g e
To edit an existing Text preprocessing object, right-click the Text Preprocessing icon in the PATROL Console and select KM Commands > Edit.
A - Convert Multi-line records to single lines

Once you have defined the text source containing paragraphs that you need to parse (a LOG file, a Command Line analysis, etc.), right-click this object > KM Commands > New > Text PreProcessing. The example of the OS command shown above is taken here. In the output of the "ipconfig /all" command, we identify the paragraphs corresponding to a network interface.
Monitoring Features
151

Version 8.6.53
Step 1: Select the "Convert multi-line records into single lines" option
T e x t Pre -Pro ce s s ing W iza rd : Co nv e rt m ulti-line re co rd s into s ing le line s Co nv e rs io n T y p e Se le ctio n
Click Next.
Step 2: Define the first and/or last lines of the paragraphs.

In our example each network card paragraph starts with "NEW" and ends with "END".
Monitoring Features
152

Version 8.6.53
T e x t Pre -Pro ce s s ing W iza rd : Co nv e rt m ulti-line re co rd s into s ing le line s Sta rt/End o f line d e finitio n
This RegExp marks the beginning of a new record: Enter the word/regular expression or string that marks the beginning of a new record. Include the first line in the result: Check the case to include the first line in the result.
Use the first field if y ou can prov ide a regular ex pression that identifies the first line of each paragraph. Please note that this regular ex pression can match with any part of the first line of each paragraph.
This RegExp marks the end of a new record: Enter the word/regular expression or string that marks the end of a new record Include the first line in the result: Check the case to include the last line in the result.
Use the second tex t field if y ou can prov ide a regular ex pression that identifies the last line of each paragraph. A gain, this regular ex pression can match with any part of the last line of each paragraph.
Concatenation of multiple lines into a single line using this separator: Leave the semicolon to separate each record or enter the character you wish as a separator. Click Next.
You can specify only a regular ex pression that identifies the beginning of a new paragraph (record). In this case, Monitoring Studio skips the content until it finds a line matching with the specified criteria. The tex t that follows this line (and optionally including this first line) is concatenated in a single line by using the specified separator, until Monitoring Studio finds another line that matches with the specified regular ex pression. Each line in the original content that matches with this regular ex pression produces a new line in the result content. The same is true for the regular ex pression that marks the end of a paragraph (or record).
If y ou specify both regular ex pressions to identify the beginning and the end of a record, Monitoring Studio will only take into account the tex t content that is in between lines that matches these regular ex pressions (i. e. between the start line and the end line). Lines in the original tex t between a line matching the end marker and the nex t line matching the beginning marker will be skipped and not integrated in the tex t result.

You arrive at the last dialogue box with the newly-created object display name and internal identifier. You can change the label as well as the ID.
Monitoring Features
153

Version 8.6.53
T e x t Pre -Pro ce s s ing W iza rd : Co nv e rt m ulti-line re co rd s into s ing le line s Obje ct Id e ntifica tio n
Click Finish and at the next discovery, the parameter TransformResult will have the output.
Step 4: Run a string search on the "transformed" output and/or extract numeric values from it.
B - Convert XML to CSV (comma separated values) ( see example)

Right-click the file object > KM Commands > New > Text Pre-Processing.
Monitoring Features
154

Version 8.6.53
Step 1: Select "Convert XML to CSV"
T e x t Pre -Pro ce s s ing W iza rd : Co nv e rt XM L to CSV Co nv e rs io n T y p e Se le ctio n
Click Next.
Step 2: Define the record, the sub-objects and properties
T e x t Pre -Pro ce s s ing W iza rd : Co nv e rt XM L to CSV Obje ct De finitio n
Monitoring Features
155

Version 8.6.53
This XML tag defines a record: Enter the XML tag that defines the record Include sub-objects and properties defined for the XML tag: Enter its sub-objects and properties Concatenation of sub-objects and properties into a single line: Enter a separator to concatenate Click Next.

You arrive at the last dialogue box with the newly-created object display name and internal identifier. You can change the label as well as the ID.
T e x t Pre -Pro ce s s ing W iza rd : Co nv e rt XM L to CSV Obje ct Id e ntifica tio n
Click Finish and at the next discovery, the parameter TransformResult will have the output.
C - Extract text from HTML

This allows you to extract text from an HTML source and then run string or numeric value searches on the output. Right-click on a an instance with an HTML source/file (HTML file monitoring or web request, web farm
Monitoring Features
156

Version 8.6.53
etc) > New > Text pre-processing.
Step 1: Select "Extract text from HTML"
T e x t Pre -Pro ce s s ing W iza rd : Ex tra ct te x t fro m HT M L Co nv e rs io n T y p e Se le ctio n
Click Next.
Step 2: Panel confirms extraction of text from HTML source
Monitoring Features
157

Version 8.6.53
T e x t Pre -Pro ce s s ing W iza rd : Ex tra ct te x t fro m HT M L Ex tra ctio n Co nfirm a tio n
There are no options to select here, as Monitoring Studio is simply going to transform the HTML source by removing the HTML tags. It then displays the output in the parameter TransformResult. Click Next.
T e x t Pre -Pro ce s s ing W iza rd : Ex tra ct te x t fro m HT M L Obje ct Id e ntifica tio n
You arrive at the last dialogue box with the newly-created object display name and internal identifier. You can change the label as well as the ID. Click Finish and at the next discovery, the parameter TransformResult displays the output.
D - Text processing through an external command

Some text inputs (files, output of commands, Web requests, etc.) may need to be transformed in a special way in order to be parsed with Monitoring Studios String Searches and Numeric Value Extractions. If the built-in text transformation features of Monitoring Studio cannot handle such "specially formatted" text, you then have the possibility to process the content through a custom script or utility that performs the required transformation (i.e. it simplifies to process the content and makes it "string search-ready"). The main advantage of processing the text through an external command feature is that it enables you to customize the processing of almost any source of information important to your application.
Monitoring Features
158

Version 8.6.53
Right click the File/Command Line/Web request/etc. object > New > KM commands > Text Pre-processing
Step 1: Select " Text processing through an external command "
T e x t Pre -Pro ce s s ing W iza rd : T e x t p ro ce s s ing thro ug h a n e x te rna l co m m a nd Co nv e rs io n T y p e Se le ctio n
Click Next.
Step 2: Specify OS command to be executed to transform the text
Monitoring Features
159

Version 8.6.53
T e x t Pre -Pro ce s s ing W iza rd : T e x t p ro ce s s ing thro ug h a n e x te rna l co m m a nd Co m m a nd De finitio n
Command to be executed: Enter the command
The principle is v ery similar to the "pipe" mechanism of the UNIX shell ex cept that the content is not passed directly but is stored in a temporary file and then the result needs to be stored in another temporary file.
Hence the command line y ou specify needs to take the % {INPUTF ILE} macro as an argument (the % {INPUTF ILE} macro is replaced by the real temporary input file location at run time) as well as % {O UTPUTF ILE}.
The output of the command must match this RegExp to be considered as successful: Enter a RegExp to avoid typical path problems such as getting ""... not found" error messages instead of the properly transformed text
If y our command line redirects its output to % {O UTPUTF ILE}, the v alidation regular ex pression is likely to fail because the standard output is empty and thus matches with nothing. Use a v alidation regular ex pression only if y our command line is able to produce both the % {O UTPUTF ILE} and some tex t to its standard output.
T e x t Pre -Pro ce s s ing W iza rd : T e x t p ro ce s s ing thro ug h a n e x te rna l co m m a nd Obje ct Id e ntifica tio n
You arrive at the last dialogue box with the newly-created object display name and internal identifier. You can change the label as well as the ID. Click Finish and at the next discovery, the parameter TransformResult displays the output.
Monitoring Features
160

Version 8.6.53
All text preprocessing objects are instances of the SW_Transform class.
WMI Query Analysis

Objective
The aim of this tool is to execute WMI queries on your system and consolidate these queries within your PATROL environment along with the application monitoring under a single icon. It has the ability to query the WMI repository for class and instance information. For example, you can request that WMI return all the objects representing shut-down events from your desktop system. You can also retrieve class, instance, or schema data. Monitoring Studio enables you to run WMI queries remotely and you can also search for regular expressions and numeric values in the query output.
Definition
Windows Management Instrumentation (WMI) is a set of specifications from Microsoft for consolidating the management of devices and applications in a network from Windows computing systems. WMI is the Microsoft implementation of Web Based Enterprise Management (WBEM), which is built on the Common Information Model (CIM), a computer industry standard for defining device and application characteristics so that system administrators and management programs can control devices and applications from multiple manufacturers or sources in the same way.
What does WMI do?

WMI provides users with information about the status of local or remote computer systems. It also supports such actions as the configuration of security settings, setting and changing system properties, setting and changing permissions for authorized users and user groups, assigning and changing drive labels, scheduling processes to run at specific times, backing up the object repository, and enabling or disabling error logging. You can use WMI to manage both local and remote computers. The word "Instrumentation" in WMI refers to the fact that WMI can get information about the internal state of computer systems, much like the dashboard instruments of cars can retrieve and display information about the state of the engine. WMI "instruments" by modeling objects such as disks, processes, or other objects found in Windows systems. For more information on WMI, please refer to About WMI in the Reference section.
Monitoring Features
161

Version 8.6.53
Method (summary)
Launch the WMI query wizard Identify the host of the remote element, enter a namespace Enter the WMI query and user credentials
Result
An icon representing the WMI query appears in the console with two parameters: ReturnOutput and QueryStatus under it. You can now run String Searches and Extract Numeric Values from this output.
Create or edit a WMI query analysis

To setup WMI query analysis, right-click the main Monitoring Studio icon > KM Commands > New > WMI Query analysis
W M I Que ry A na ly s is W iza rd W e lco m e Pa g e
To edit a WMI query analysis, right-click the WMI query icon > KM Commands > Edit.
Monitoring Features
162

Version 8.6.53
Step 1: After launching the WMI wizard, identify the host
W M I Que ry A na ly s is W iza rd De finitio n Pa g e
Hostname: Enter the host name or IP address. Name space: Enter the WMI namespace. A namespace is a logical group of related classes representing a specific technology or area of management. Example: root\cimv2 WMI Query: Enter your query. Example: SELECT * FROM Win32 process. In case you need help to build your WMI query, you could download WMI CIM Studio, which is one of the WMI Administrative tools on the Microsoft site. Username and Password: Enter your credentials: username and password Click Next.
Monitoring Features
163

Version 8.6.53
W M I Que ry A na ly s is W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this WMI query object Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
164

Version 8.6.53
Click Finish. You can then add a string or numeric value search if you wish. An icon labeled WMI: [object name] will appear, with icons under it for QueryStatus, ReturnOutput. You can add numeric value extraction or string searches on this object. WMI query analysis objects are instances of the SW_NT_WMI class.
WBEM Query Analysis

Objective
The aim of this tool is to execute WBEM queries on your system and consolidate these queries within your PATROL environment along with the application monitoring under a single icon. It has the ability to query the WBEM repository for class and instance information.
Definition
Web-Based Enterprise Management (WBEM) is a set of systems management technologies developed to unify the management of distributed computing environments. WBEM is based on Internet standards and Distributed Management Task Force (DMTF) open standards: Common Information Model (CIM) infrastructure and schema, CIM-XML, CIM operations over HTTP, and WS-Management. Although the name refers to WBEM as being "Web-Based", it is not necessarily tied in any way to a particular user interface (see below). Other systems management approaches are remote shells, proprietary solutions and network management architectures like SNMP.
What does WBEM do?

WBEM provides users with information about the status of local or remote computer systems. It also supports such actions as the configuration of security settings, setting and changing system properties, setting and changing permissions for authorized users and user groups, assigning and changing drive labels, scheduling processes to run at specific times, backing up the object repository, and enabling or disabling error logging.
Monitoring Features
165

Version 8.6.53
Method (summary)
Launch the WBEM Query Wizard Identify the host of the remote element, enter a namespace Enter the WBEM query and user credentials
Result
An icon representing the WBEM query appears in the console with two parameters: ReturnOutput and QueryStatus under it. You can now run String Searches and Extract Numeric Values from this output.
Create or edit a WBEM query analysis

To setup WBEM query analysis, right-click the Application/Container icon > KM Commands > New > WBEM Query analysis
W BEM Que ry A na ly s is W iza rd W e lco m e Pa g e
To edit a WBEM query analysis, right-click the WBEM query icon > KM Commands > Edit.
Monitoring Features
166

Version 8.6.53
Step 1: After launching the WBEM wizard, identify the host
W BEM Que ry A na ly s is W iza rd Ho s t Id e ntifica tio n Pa g e
Hostname: Enter the host name or IP address Connect through port: Enter the port number you wish to use for the connection. By default, in standard environments, the port 5988 is used for non-encrypted data, while port 5989 is used for0 encrypted data. Name space: Enter the WBEM namespace. A namespace is a logical group of related classes representing a specific technology or area of management (Ex: root\cimv2) Encrypt data using the HTTPS protocol: Select this option to encrypt the query with the HTTPS protocol. Hyper Text Transfer Protocol Secure (HTTPS) is a secure version of the Hyper Text Transfer Protocol (http) based on the SSL (Secure Sockets Layer) protocol. SSL creates a secure connection between a client and a server, over which any amount of data can be sent securely. WBEM Query: Enter your WBEM query Username and Password: Enter your credentials: username and password
The v ariable used to specify the path to the jar file used to perform W BEM queries is: /MA SA I/SENTR Y8/ wbemJarPath
Click Next.
Monitoring Features
167

Version 8.6.53
W BEM Que ry A na ly s is W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this WBEM query object Object internal identifier (ID): PATROL internal identifier What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
168

Version 8.6.53
Click Finish. You can then add a string or numeric value search if you wish. An icon labeled WBEM: [object name] will appear, with icons under it for QueryStatus, ReturnOutput. You can add numeric value extraction or string searches on this object. WBEM query analysis objects are instances of the SW_WBEM class.
Web-farm Monitoring
Objective
The aim of the Web farm tool is to ensure availability of your web farms by letting you know how many of your servers are responding with the correct web content. One of the main goals of web farms is to assure availability of the web site. The biggest challenge is to successfully measure and monitor the web farms overall availability to determine its success, and drive its improvement. Monitoring Studio essentially groups HTTP requests all together, allowing you to use all the tools of the SW_HTTP_REQUESTS class to monitor your web-farms.
Create a web farm monitoring

To create a new web farm monitoring, right-click the application icon in the PATROL Console and select KM Commands > New > Web farm monitoring
Monitoring Features
169

Version 8.6.53
W e b-Fa rm M o nito ring W iza rd W e lco m e Pa g e
Editing the webfarm instance is not feasible; but y ou can edit indiv idual hosts (web requests) under this web farm. You can add, edit and delete the hosts grouped under the webfarm icon at any time.
Step 1: Enter the URL, select the type of HTTP request and specify desired output
After the welcome panel of the Web farm monitoring wizard, you are asked to enter the URL to query and the type of HTTP request.
Monitoring Features
170

Version 8.6.53
W e b R e q ue s t A na ly s is W iza rd De finitio n Pa g e
URL to query: Enter the URL of the web site that needs to be monitored. From a Windows agent, it is possible to poll a secure web site by using the "https" method. HTTP Request type: Enter the HTTP request, there are two different modes: "GET" and "POST". The "GET" mode (HTTP GET method) is the standard way to query a Web page from a Web server. The "POST" mode (HTTP POST method) is classically used to post a form to a Web server and obtain the result of the processing of the form data. If you choose this mode, you must specify the variables and values to be transmitted to the Web server.
Some W eb forms can be passed to the serv er with the HTTP GET method. In such case, the form data is passed through the UR L (http://serv er/form. php?v arA = v alueA &v arB= v alueB& ). You must check the W eb form HTML source to know which method needs to be used (GET or PO ST).
W hen posting a form to a W eb serv er, y ou hav e to enter the UR L of the script/C GI/page that will actually process the data, which may be different from the W eb page UR L that shows the form itself. A gain, y ou need to check the W eb form HTML source to identify the UR L to query .
A W eb form HTML source should contain a statement like the following one: < F O R M METHO D= "PO ST" A C TIO N= "/ urlToQ uery . php">
Timeout after: Enter the connection timeout period. The default is set to 30 seconds. When this timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on the ServerConnectionState parameter.
Monitoring Features
171

Version 8.6.53
Proxy settings (optional): If your environment uses a proxy server, click to enter the proxy settings required to execute the HTTP request. Proxy server: Enter proxy server details. Port: Select the port number Web Server Authentication (optional): See section below on HTTP authentication for details. Authenticate as: Enter the user name as required by the HTTP server (see note below for more information) Password: Enter the password. Specify what should be shown in the ReturnOutput parameter: Select what you would like to retrieve from the Web page returned by the Web server: the entire HTTP response; only the Web page (with HTML tags) or only the content text (no HTMP tags).
HTTP Authentication
Some Web applications request a user name and password in order to access resources available on the Web server. Starting with version 8.5.00, Monitoring Studio supports HTTP authentication. The HTTP authentication is a login/password-based mechanism implemented in the HTTP protocol itself.
HTTP authentication has nothing to do with an authentication sy stem of a W eb page with a form asking for user credentials like on Hotmail or Yahoo mail or any public webmail serv ice.
A Web server that requires an HTTP authentication will result in the following dialog box in Internet Explorer:
Monitoring Features
172

Version 8.6.53
HT T P a uthe ntica tio n
There are 3 different HTTP authentication schemes: Basic (Windows, UNIX, Linux) Digest (Windows) NTLM (Windows)
Please note that this depends on where Monitoring Studio is running, and not on the platform the W eb serv er is running on.
On a Windows machine, Monitoring Studio supports Basic, Digest and NTLM authentication schemes. On UNIX or Linux, Monitoring Studio only supports Basic HTTP authentication (password is sent in a base 64-encoded form, i.e. very easily decoded). If you need to test a Web page or retrieve information from a Web server that requires HTTP Digest or NTLM authentication, we recommend that you install Monitoring Studio on a Windows system and set up the Web requests from this machine (Web requests can be sent to remote systems).
Step 2-a: GET method - entering Host information

If the "GET" method is selected in the first panel, the following panel comes up:
W e b R e q ue s t A na ly s is W iza rd GET M e tho d Info rm a tio n Pa g e
Since a web-farm is composed of several servers, in this panel, you can enter up to 10 hosts that makeup the web-farm.
Monitoring Features
173

Version 8.6.53
To add a host later, right-click the web farm icon > KM commands > Add host. To edit or delete a host, right-click the host icon > KM commands > Edit host or Delete as the case may be.
Step 2-b: POST method - entering the variables to post

If the "POST" method is selected in the first panel, the following panel comes up:
W e b R e q ue s t A na ly s is W iza rd POST Va ria ble s De finitio n Pa g e
Here, up to eight variables to post can be entered. For each variable, enter its name in the first box and its value in the second one.
Step 3-b: POST method -entering Host information

This is the same as for the GET method:
Monitoring Features
174

Version 8.6.53
W e b R e q ue s t A na ly s is W iza rd POST M e tho d Info rm a tio n Pa g e
Since a web-farm is composed of several servers, in this panel, you can enter up to 10 hosts that makeup the web-farm. To add a host later, right-click the web farm icon > KM commands > Add host. To edit or delete a host, right-click the host icon > KM commands > Edit host or Delete as the case may be.
Monitoring Features
175

Version 8.6.53
Last Step for GET & POST methods: Monitoring Studio settings
W e b R e q ue s t A na ly s is W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this web-farm monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Web-farm monitoring objects are instances of the SW_HTTP_WEBFARM class.
Monitoring Features
176

Version 8.6.53
Web Request Analysis

Objective
The aim of this HTTP request tool is to monitor your web-based applications - send HTTP requests, post forms, parse the HTML page that is returned, etc. Monitoring Studio enables you to ensure that endusers actually see what they should see on their browser!
Create or edit a Web Request analysis

To create a new Web Request analysis, right-click the Application/Container icon in the PATROL Console and select KM Commands > New > Web Request analysis
W e b R e q ue s t A na ly s is W iza rd W e lco m e Pa g e
To edit an existing Web Request analysis, right-click the Web Request analysis icon in the PATROL Console and select KM Commands > Edit.
Step 1: enter the URL, select the HTTP request type and specify desired output
After the welcome panel of the wizard, the next panel (shown below) asks you to enter the URL to query and the method to be used.
Monitoring Features
177

Version 8.6.53
W e b R e q ue s t A na ly s is W iza rd De finitio n Pa g e
URL to query: Enter the URL of the web site that needs to be monitored. From a Windows agent, it is possible to poll a secure web site by using the "https" method. HTTP Request type: There are two different modes: "GET" and "POST", select your mode.
The "GET" mode (HTTP GET method) is the standard way to query a W eb page from a W eb serv er. The "PO ST" mode (HTTP PO ST method) is classically used to post a form to a W eb serv er and obtain the result of the processing of the form data. If y ou choose this mode y ou need to specify which v ariables with what v alues must be passed to the W eb serv er.
Some W eb forms can be passed to the serv er with the HTTP GET method. In this case, the form data goes through the UR L (http://serv er/form. php?v arA = v alueA &v arB= v alueB& ).
You must check the Web form HTML source to know which method needs to be used (GET or POST).
To post a form to a W eb serv er, y ou need to enter the UR L of the script/C GI/page that will actually process the data, which may be different from the W eb page UR L that shows the form itself. A gain, y ou need to check the W eb form HTML source to identify the UR L to query .
A W eb form HTML source should contain a statement like the following one: < F O R M METHO D= "PO ST" A C TIO N= "/ urlToQ uery . php">
Timeout after: Enter the timeout period. The default is set to 30 seconds. When this timeout is
Monitoring Features
178

Version 8.6.53
reached, Monitor Studio considers the host to be unreachable and triggers an alert on the ServerConnectionState parameter. Proxy settings (optional): If your environment uses a proxy server, click to enter the proxy settings required to execute the HTTP request. Proxy server: Enter proxy server details. Port: Select the port number Web Server Authentication: (optional) See section below on HTTP authentication for details. Authenticate as: enter the user name as required by the HTTP server (see note below for more information) Password: Enter the password. C:\Documents and Settings\veronique\Local Settings\Application Data\Microsoft\Outlook\archive. pstSelect what you would like to retrieve from the Web page returned by the Web server: the entire HTTP response; only the Web page (with HTML tags) or only the content text (no HTML tags). Click Next and you arrive at the last step of Monitoring Studio settings for this web request object.
HTTP Authentication
Some Web applications request a user name and password in order to access resources available on the Web server. Starting with version 8.5.00, Monitoring Studio supports HTTP authentication. The HTTP authentication is a login/password-based mechanism implemented in the HTTP protocol itself.
HTTP authentication has nothing to do with an authentication sy stem of a W eb page with a form asking for user credentials like on www. hotmail. com or www. y ahoo. com or any public W ebmail serv ice.
A Web server that requires an HTTP authentication results in the following dialog box in Internet Explorer:
Monitoring Features
179

Version 8.6.53
There are 3 different HTTP authentication schemes: Basic (Windows, UNIX, Linux) Digest (Windows) NTLM (Windows)
Please note that this depends on where Monitoring Studio is running, and not on the platform the W eb serv er is running on.
When running on a Windows machine, Monitoring Studio supports Basic, Digest and NTLM authentication schemes. When running on UNIX or Linux, Monitoring Studio only supports Basic HTTP authentication (password is sent in a base64-encoded form, i.e. very easily decoded). If you need to test a Web page or retrieve information from a Web server that requires HTTP Digest or NTLM authentication, we recommend that you install Monitoring Studio on a Windows system and set up the Web requests from this machine (Web requests can be sent to remote systems).
Step 2: Entering the variables to post (POST method only)

If the "POST" method is selected in the first panel, the following panel comes up:
Monitoring Features
180

Version 8.6.53
W e b R e q ue s t A na ly s is W iza rd Va ria ble s De finitio n Pa g e
Here, up to eight variables to post can be entered. For each variable, enter its name in the first box and its value in the second one.
The v ariable used to specify the path to the VB script used to perform web requests on W indows serv ers is: /MA SA I/ SENTR Y8/windowsW ebR equestScriptPath
Click Next and you arrive at the last step of Monitoring Studio settings for this web request object
Monitoring Features
181

Version 8.6.53
Last Step GET and POST methods: Monitoring Studio settings
W e b R e q ue s t A na ly s is W iza rd Se tting s Pa g e
Object display name: Label that will be displayed in the PATROL Console for this web request monitoring. Object internal identifier (ID): PATROL internal identifier of this monitored object. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
182

Version 8.6.53
Web Request analysis objects are instances of the SW_HTTP_REQUESTS class.
Windows Event Monitoring

Objective
The aim of the Windows Events tool is to monitor events posted by your application with a view to consolidating the application monitoring under just one icon (and not have to additionally look up Windows EventLog). It also enables you to define automatic acknowledgment of previously triggered alerts by specifying the Windows event that will acknowledge the alert.
Method (summary)
Select the category of events you wish to monitor (ACEEventLog/application/internet explorer/ security/system) Identify the event Configure automatic acknowledgement and then set alert thresholds
Result
An icon representing the Windows event appears in the console under which are displayed the parameters MatchingEventRate and MatchingEventCount. You can set alert thresholds and automatic acknowledgements for the events found.
Create or edit a Windows Create or edit a Windows event monitoring

To create a new NT event, right-click the Application/Container icon in the PATROL Console and select KM Commands > New > NT event monitoring... To edit an existing NT Event monitoring, right-click the Windows Event icon in the PATROL Console and select KM Commands > Edit.
Monitoring Features
183

Version 8.6.53
Step 1: Selecting the Windows Event log to monitor
W ind o ws Ev e nt M o nito ring W iza rd W e lco m e Pa g e
Select the Windows Event log to monitor: Application: Any event related to an application Security: Security events that are specified in the audit policy System: Any event related to the operating system Apart from the above three categories, the events shown in the dropdown list will depend on each system.
Step 2: Identifying the Windows Event to monitor

This panel is used to identify the Windows Event to monitor.
Monitoring Features
184

Version 8.6.53
W ind o ws Ev e nt M o nito ring W iza rd Ev e nt Id e ntifica tio n Pa g e
Source: The software that logged the event, which can be either a program name such as "SQL Server," or a component of the system or of a large program such as a driver name. For example, "Elnkii" indicates an EtherLink II driver. Windows Event Types to monitor: A classification of the event severity: Error, Information, or Warning in the system and application logs; Success Audit or Failure Audit in the security log. In the Event Viewer normal list view, these are represented by a symbol. Enter the searched Windows Event ID: A number identifying the particular event type. The first line of the description usually contains the name of the event type.
Example 6005 is the ID of the event that occurs when the Event log service is started. The first line of the description of such an event is "The Event log service was started." The Event ID and the Source can be used by product support representatives to troubleshoot system problems. Optional information: Arguments (insertion strings) that create a description of the NT Event. See the documentation of the NT Event you are monitoring for more information about these arguments. The argument number specifies where in the description the information should be found. Up to two
Monitoring Features
185

Version 8.6.53
arguments can be chosen and it is possible to indicate whether the information entered in the text bound is to be found within the argument ("must contain") or actually indicates the entire argument ("must exactly be"). Case sensitive: Indicates whether or not the search for the Argument that is to be found within the Windows Event description will be case sensitive.
If y ou are unsure about the characteristics of the W indows ev ent y ou want to detect, y ou will need to use the Monitoring Studio built-in W indows Ev entLog R eader tool to v iew content of the Ev entLogs and the characteristics of the ev ents, including their arguments (insertion strings). right-click on the main Monitoring Studio icon > KM commands > Tools > W indows Ev entLog R eader.
Step 3: Automatic acknowledgement configuration

The automatic acknowledging feature allows you to reset the MatchingEventCount parameter to zero and its status to 'normal' thereby, acknowledging the alert.. This can be done in the following two cases: Acknowledge alert(s)if the following timeout is reached: A timeout since the last found matching Event Acknowledge alert(s)if the following NT Event is found: Specify the Windows Event
Monitoring Features
186

Version 8.6.53
W ind o ws Ev e nt M o nito ring W iza rd A le rt A ck no wle d g e m e nt De finitio n Pa g e
When this occurs, you can specify whether to: Acknowledge all alerts, previously triggered by this Windows Event monitoring: All the previous alerts are acknowledged in one action and the MatchingEventCount parameter is reset. Acknowledge only one alert triggered by this NT Event search: Just one alert should be acknowledged (the MatchingEventCount parameter is thus decreased by one). Click Next and you arrive at the last panel with the Monitoring Studio settings.
W ind o ws Ev e nt M o nito ring W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this Windows Event monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
187

Version 8.6.53
Windows Event monitoring objects are instances of the SW_NTEVENTS class.
Windows Performance Monitoring

Objective
The aim of this tool is to incorporate Windows performance data, important to the proper functioning of your applications, within your PATROL environment. Alerts can be set to provide immediate notification in case one of the parameters you are monitoring is above or below a given range. Performance monitor collects information about objects on your Windows NT/2000/2003 computer and measures them. Theses objects can be processors, threads, processes, memory, etc., with each one having an associate set of counters and possibly instances. The data gathered by the Windows performances about specific components can be used to identify problems and bottlenecks within your application and plan ahead for your future needs. A Windows performance is defined by a performance object name and a counter name, as well as anything from none to several instances. Furthermore, each performance counter contains a unique set of counters and instances. Some objects are built into the system, typically corresponding to the major hardware components, but others will only be accessible if the associated software has been installed. Here are some definitions of the items as described by Microsoft:
Monitoring Features
188

Version 8.6.53
Performance object: A logical collection of counters that is associated with a resource or service that can be monitored. The objects that are typically installed on a system are: cache, memory, objects, paging file, physical disk, process, processor, server, system and thread. Counter: A value corresponding to a particular aspect of the performance defined for the performance object. Instance: A term used to distinguish between multiple performance objects of the same type on a computer. If an object has several instances, it is possible to monitor them either individually or all at once. In the latter case, you can choose to monitor the minimum, maximum, average or total value of the instances.
Create or edit a Windows Performance monitoring

To create a Windows Performance monitoring, right-click the Application/Container icon in the PATROL Console and select KM Commands > New > Windows Performance monitoring... To edit an existing Windows Performance monitoring, right-click the Windows Performance monitoring icon in the PATROL Console and select KM Commands > Edit.
Step 1: Selecting the Windows Performance object

As explained above, a Windows performance counter is composed of two or three items: A performance object A counter Anywhere from none to several instances Since counters and instances are specific to a Windows performance object, the first thing you have to do is select an object from the list of available performances on your system.
Monitoring Features
189

Version 8.6.53
W ind o ws Pe rfo rm a nce M o nito ring W iza rd W e lco m e Pa g e
Step 2: Counter and instances
W ind o ws Pe rfo rm a nce M o nito ring W iza rd De finitio n Pa g e
This panel is displayed if one or more instances of the selected Windows Performance is found. Otherwise, a much simpler panel is shown displaying only the list of counters and the scale. Select one or more instances: This list displays the selected Windows Performance object instances. Select which one(s) you wish to monitor from the list. Select a counter: The counters available for the selected Windows Performance object are listed here. Select the one you wish to monitor Scale: A scale can be used to divide the Windows performance value by this number. To do so, enter the number you wish the value to be divided by (e.g.: the committed memory is expressed in bytes, so, to obtain the value in mega-bytes (MB), type "1024" in the field for scale. By default, the scale value is 1 (no scale). PATROL object creation and type of value obtained: This is only relevant if more than one instance is selected. The radio buttons at the bottom of the panel can be used to select the creation mode of the Windows performance PATROL object instance:
Monitoring Features
190

Version 8.6.53
Create one PATROL object per instance: All selected instances will have their own PATROL object and will be monitored separately. Group all selected instances into one PATROL object: All selected instances are grouped into one PATROL object and are monitored all together. If you select this option, you must choose one of the following: Calculate average of all selected instances for selected counter: Each value will be added then divided by the number of instances. So the average value of all the selected instances will be monitored. Use minimum value of all selected instances for selected counter: The minimum value of the different selected instances will be monitored. Use maximum value of all selected instances for selected counter: The maximum value of the different selected instances will be monitored. Calculate total value of all selected instances for selected counter: The value of each selected instance is added so the total value of all selected instances will be monitored.
W ind o ws Pe rfo rm a nce M o nito ring W iza rd Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this Windows Performance monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
191

Version 8.6.53
Windows Performance counter monitoring objects are instances of the SW_NTPERFORMANCE class.
Windows Service Monitoring

Objective
The aim of this tool is to consolidate the monitoring of the Windows services needed by your application under a single icon. This function is only available for agents running on Windows systems.
Create or edit a Windows service monitoring

To create a new windows service monitoring, right-click the application icon in the PATROL Console and select KM Commands > New > Windows Service Monitoring...
Monitoring Features
192

Version 8.6.53
W ind o ws Se rv ice M o nito ring W iza rd W e lco m e Pa g e
Monitoring Studio allows you to select a service from a list or to enter a service name manually. Select one of the two available options: Select a service from the existing list of services: To display a list of services currently installed services from which you can select the service you wish to monitor Enter manually the short name of a service: To enter manually the short name of a Windows service that is not currently installed on the managed system. To edit an existing Windows service monitoring, right-click the Windows service icon in the PATROL Console and select KM Commands > Edit.
Step 1a: Selecting the Windows Service to monitor

If you have selected the Select a service from the existing list of service option at the previous step, Monitoring Studio builds and displays a list of services currently installed on the server. Select the Windows Service you wish to monitor and click Next.
Monitoring Features
193

Version 8.6.53
W ind o ws Se rv ice M o nito ring W iza rd Se rv ice Se le ctio n Pa g e
Step 1b: Entering Manually the Windows Service Name to monitor

If you have selected the Enter manually the short name of a service option at the previous step, Monitoring Studio lets you type the service name. Make sure to use the Service Short Name which is one of the two names that can identify a service and which is how the service configuration is stored in the registry.
Monitoring Features
194

Version 8.6.53
Click Next to continue.
W ind o ws Se rv ice M o nito ring W iza rd Se tting s Pa g e
Monitoring Features
195

Version 8.6.53
Object display name: Label displayed in the PATROL Console for this Windows Services monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Windows Service monitoring objects are instances of the SW_NTSERVICES class.
JMX
Java MBean Polling (JMX)
Objective
The aim of the JavaMBean Polling (JMX) tool is to enable JMX polling to access and monitor the following MBean application servers: JBoss JOnAS BEA WebLogic IBM WebSphere Generic JMX client Java Management Extensions (JMX) a trademark of Sun Microsystems, is a Java technology that supplies tools for managing and monitoring applications, system objects, devices (e.g. printers) and service oriented networks. Those resources are represented by objects called MBeans (for Managed Bean).
Monitoring Features
196

Version 8.6.53
JMX Architecture
Java Management Extensions (JMX) technology provides the tools for building distributed, Web-based, modular and dynamic solutions for managing and monitoring devices, applications, and service-driven networks. Starting with J2SE 5.0, JMX technology is included in Java SE. JMX is based on 3-level architecture: The Probe level: contains the probes (called MBeans) instrumenting the resources. It is also known as the instrumentation level. The Agent level: the MBeanServer is the core of JMX. It is an intermediary between the MBean and the applications. The Remote Management level: enables remote applications to access the MBeanServer through Connectors and Adaptors. A connector provides full remote access to the MBeanServer API using various communication frameworks such as RMI, IIOP, JMS, WS-*; while an adaptor adapts the API to another protocol (SNMP) or to Web-based GUI (HTML/HTTP, WML/HTTP) Applications can be generic consoles (such as JConsole and MC4J), or domain-specific (monitoring) applications.
MBeans and Platform MBean Servers

An MBean server is a repository of MBeans that provides management applications access to MBeans. An MBean is nothing but a java object that represents a manageable resource, such as an application, a service, a component, or a device. For example you could represent your laptop as an MBean and then "monitor" it. Applications do not access MBeans directly, but instead access them through the MBean server with their unique ObjectName. An MBean server implements the interface javax.management. MBeanServer
Monitoring Studio and MBeans

With the JMX polling feature of Monitoring Studio, you can easily monitor the above-mentioned application servers and consolidate the monitoring of these MBeanServers along with the application monitoring under a single icon. You need no longer interrogate the various application servers through their respective interfaces just to view the status of the MBeans. A management application can access platform MBeans in different ways: Using ManagementFactory Using and MXBean Proxy Using MBean ServerConnection Monitoring Studio uses the MBeanServerConnection method, connecting to the platform MBeanServer of a running JVM. In this method, you use the getAttribute () method of MBeanServerConnection to get an attribute of a platform MBean, providing the MBean's ObjectName and the attribute name as parameters.
Monitoring Features
197

Version 8.6.53
Monitoring Studio can only poll the application serv ers and display the MBeans attributes and v alues. To create and register new MBeans or modify ex isting ones, y ou are required to do so using the specific application serv er interface.
Method (summary)
To setup the monitoring and consolidate the querying of resources represented by Mbeans within your PATROL environment, all you need to do is go through the JMX wizard of Monitoring Studio. The wizard panels differ for each type of JMX application server, the following is just a summary of the overall method. 1. Right-click the main Monitoring Studio icon > KM Commands > New > Java MBean polling (JMX) 2. From the drop-down list, select the environment: JBoss/WebLogic/WebSphere/generic JMX client. 3. Enter the server connection information: host name and the port number 4. Enter the additional information: initial context factory and JNDI name 5. Enter the connection account credentials: principle(username) and credentials (password) 6. Click Next; ensure that all the settings are accurate. 7. If the credentials entered are correct, Monitoring Studio connects to the application server and presents a list of domains for you to select from. 8. Select the domain to monitor and click Next. 9. Select the key property to monitor from this domain and click Next. 10. Select the attribute from the list and click Next. You can only select one attribute a time. To monitor several attributes of the same key property, you are required to go through the wizard each time. 11. Click Finish. You can add a string or numeric value search if you wish.
O nce a JMX polling is configured, Monitoring Studio uses that JMX Polling configuration by default whenev er y ou add a new Jav a MBean Polling. This way , y ou do not hav e to re-enter the configuration settings each time.
The abov e-mentioned instructions giv e an ov erv iew of the procedure to poll a JMX serv er. Please refer to the section on a specific application serv er for ex act details and procedure. You can also consult the Input v ariables for JMX polling wizards section to know what input is required for which ty pe of application serv er.
Monitoring Features
198

Version 8.6.53
Generic JMX client using RMI or IIOP Protocols

To set-up the monitoring of a generic JMX client, right-click the main Monitoring Studio icon > KM Commands > New > Java MBean polling (JMX) and select the environment Generic from the dropdown list:
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) W e lco m e Pa g e
The application serv er should be started with the option: -Dcom. sun. management. jmx remote. port= portNumber Using the abov e option starts a dedicated JMX agent for this particular application. The Monitoring Studio generic JMX client needs to use this port number to establish a connection.
Monitoring Features
199

Version 8.6.53
Step 1: Enter the generic environment connection information
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) Co nne ctio n Info rm a tio n Pa g e
Host: Name of host server where the generic JMX application server is installed. Port: Enter the port number. Server name: Enter the server name Protocol: Select the relevant protocol: RMI / IIOP
The Monitoring Studio generic client connects to the JMX agent using the protocol R MI or IIO P. If y ou use the protocol R MI the default serv er name is jmx rmi and if y ou use the IIO P protocol then the default serv er name is jmx iiop.
Monitoring Features
200

Version 8.6.53
Step 2: Enter the connection account credentials:
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) Co nne ctio n A cco unt Cre d e ntia ls Pa g e
Principle: Enter the username Credentials: Enter the password Path to Java on the local server: Enter your java home path and ensure that all the settings are correct. Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When this timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on the ExecutionStatus parameter. Click Next.
Step 3: Select domain

If the credentials entered are correct, Monitoring Studio connects to the application server and presents a list of domains for you to select from. Select the domain to monitor and click Next.
Monitoring Features
201

Version 8.6.53
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) Do m a in Se le ctio n Pa g e
Step 4: Select the key property
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) Ke y Pro p e rty Pa g e
Select the key property to monitor in this domain and click Next.
Monitoring Features
202

Version 8.6.53
Step 5: Select the attribute
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) A ttribute Se le ctio n Pa g e
Select the attribute to monitor and click Next. You can only select one attribute at a time. To monitor several attributes of the same key property, you are required to go through the wizard each time.
Step 5a: Select parameters to collect

When you select a numeric attribute (boolean, integer, number) at the previous step, an additional panel is displayed to allow you to select the parameters to collect.
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) Pa ra m e te rs Se le ctio n Pa g e
Value: Reports the actual value collected upon data polling Delta: Calculates the difference between values collected during two consecutive polling. DeltaPerSecond: Reports the value resulting of the division of the Delta by the number of seconds elapsed between the collection times
Monitoring Features
203

Version 8.6.53
Select the option "Discard negative Delta values" if you do not want negative values to be reported on the graph. Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extracted in order to have a more readable graph in the PATROL Console. The available rescaling options are: No rescaling Divide the value by a value that then gives you the reading in terms best suited to you Multiply the extracted value by a constant factor This can be useful if you extract numeric values in bytes but prefer to show a graph in megabytes. In such a case, you would divide the values by 1048576 (1024*1024).

You arrive at the final step of the wizard that displays the object display name, ID and threshold options.
J a v a M Be a n Po lling W iza rd (Ge ne ric Env iro nm e nt) Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this generic JMX application monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
204

Version 8.6.53
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio icon bearing the name entered/displayed in the PATROL Label field; and at the next collect you will see values for the newly monitored object. You can add a string or numeric value search if you wish. Generic JMX application objects are instances of the SW_JMX class.
Input variables for JMX polling Wizards

Here is a recapitulative table with the input variables required to connect to the various JMX application servers.
JMX Application Server
JBoss by Redhat
Input Variables
Connection Information Host: Name of host server where the JBoss application server is installed Port: JBoss port number. (1099 by default). Can be modified Additional information Initial context factory: org.jnp.interfaces.NamingContextFactory by default. Can be modified URL package prefixes: org.jboss.naming:org.jnp.interfaces (by default). Can be modified Connection Account Principle: Username Credentials: Password Path to Java on the local server: java home path
JOnAS
Connection Information Host: Name of host server where the JOnAs application server is installed Port: Port number. (By default: 1099). This is linked to the protocol used. Can be modified Additional information
Monitoring Features
205

Version 8.6.53
Input Variables
Server name: Name given to the JOnAS application server Initial context factory: com.sun.jndi.rmi.registry.RegistryContextFactory (by default). Can be modified URL package prefixes: org.objectweb.jonas.naming (by default) Can be modified Connection Account Principle: Username Credentials: Password Path to Java on the local server: java home path
BEA WebLogic
Connection Information Host: Name of host server where the WebLogic application server is installed Port: Port number. (By default: 7001). Can be modified Additional information Initial context factory: weblogic.jndi.WLInitialContextFactory (by default) Can be modified For WebLogic 9.x JNDI: weblogic.management.mbeanservers.domainruntime (by default). Can be modified For WebLogic 8.x Server name: Name given to WebLogic application server Connection Account Principle: Username Credentials: Password Path to Java on the local server: java home path
IBM WebSphere
Connection Information Host: Name of host server where the WebSphere application server is installed SOAP port: Enter port number. The first profile created on WebSphere is by default given the number 8880 and every profile created on WebSphere is allotted a new SOAP port number by increasing the count from 8880. This can be modified.
To connect to the W ebSphere A S, it is essential to connect to certain credential files: C lientKey F ile. jks and C lientTrustF ile. jks. These files are profile-specific and are created and stored by W ebSphere under % IBM_HO ME% \profile\profilename\etc. Depending on the security of y our env ironment, either giv e the path to these files to where the W ebSphere A S resides, or, copy them from there to y our local file-sy stem. TrustStoreFile path: Enter the path to the file ClientTrustFile.jks.
TrustStore password: Enter the password created on WebSphere for your profile (default WebAS) KeyStoreFile path: Enter the path to the file ClientKeyFile.jks KeyStore password: Enter the password created on WebSphere for your profile (default WebAS) Server name: Name of the WebSphere application server. Node name: Enter node name allotted to your profile. By default WebSphere assigns a unique node name to each profile created. Connection Account Principle: Username Credentials: Password Path to Java on the local server: java home path
Monitoring Features
206

Version 8.6.53

Generic JMX applications
Input Variables
Connection Information Host: Name of host server where the generic JMX application server is installed Port: Enter port number Generic environment additional information Server name: Name of generic server
Protocol: Name of protocol

The Monitoring Studio generic client connects to the JMX agent using the protocol R MI or IIO P. If y ou use the protocol R MI the default serv er name is jmx rmi and if y ou use the IIO P protocol then the default serv er name is jmx iiop. Connection Account Principle: Username
Credentials: Password Path to Java on the local server: java home path The application server should be started with the option: Dcom.sun.management.jmxremote.port=portNumber Using this option starts a dedicated JMX agent for this particular application. The Monitoring Studio generic JMX client needs to use this port number to establish a connection.
JBoss
JBoss is an open source Java EE-based application server implemented in Java. As the JBoss Application Server is 100% pure Java, it is interoperable with most operating systems that are capable of running a Java Virtual Machine (JVM); including Red Hat Enterprise Linux, SUSE Linux, Microsoft Windows, Sun Solaris, HP-UX, and others. To monitor your JBoss AS within your PATROL environment, right-click the main Monitoring Studio icon > KM Commands > New > Java MBean polling (JMX) and from the drop-down list, select the environment: JBoss 3.2.x or 4.x.
Monitoring Features
207

Version 8.6.53
J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) W e lco m e Pa g e
Step 1: Enter the server connection information and the additional information
J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) Co nne ctio n Info rm a tio n Pa g e
JBoss connection information: Host: Name of host server where the JBoss application server is installed Port: JBoss port number. (1099 by default). Can be modified JBoss additional information:
Monitoring Features
208

Version 8.6.53
Initial context factory: org.jnp.interfaces.NamingContextFactory (by default). Can be modified URL package prefixes: org.jboss.naming:org.jnp.interfaces (by default) Can be modified
Step 2: Enter the connection account credentials
J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) Co nne ctio n A cco unt Cre d e ntia ls Pa g e
Connection account: Principle: Enter the username Credentials: Enter the password Path to Java on the local server: Enter your java home path and ensure that all the settings are correct. You can choose to execute additional JAR files by clicking the External JAR files button and enter the JAR files names and locations. Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When this timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on the ExecutionStatus parameter. Click Next. If the credentials entered are correct, Monitoring Studio connects to the application server and presents a list of domains for you to select from.
Monitoring Features
209

Version 8.6.53
Step 3: Select the domain
J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) Do m a in Se le ctio n Pa g e
Select the domain to monitor and click Next.
Monitoring Features
210

Version 8.6.53
J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) Ke y Pro p e rty Pa g e
Select the key property to monitor from this domain and click Next.
J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) A ttribute Se le ctio n Pa g e
Monitoring Features
211

Version 8.6.53
Select the attribute from the list and click Next. You can only select one attribute at a time. To monitor several attributes of the same key property, you are required to go through the wizard for each attribute.

J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) Pa ra m e te rs Se le ctio n Pa g e
Monitoring Features
212

Version 8.6.53
J a v a M Be a n Po lling W iza rd (J Bo s s Env iro nm e nt) Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this JBoss monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
213

Version 8.6.53
Click Finish. An icon for the monitored instance will appear in the Console bearing the name entered/ displayed in the PATROL Label field; and at the next collect you will see values for the newly monitored object. You can add a string or numeric value search if you wish. JBoss objects are instances of the SW_JMX class.
WebSphere
IBM WebSphere Application Server is the foundation of the IBM WebSphere software platform, and a key building block for a Service Oriented Architecture (SOA). As the premier Java 2 Enterprise Edition (J2EE) and Web services application platform, WebSphere Application Server delivers a high performance transaction engine that can help you build, run, integrate and manage dynamic On Demand Business applications. To monitor a WebSphere application server within your PATROL environment:
Before setting-up the monitoring of a W ebSphere A S, y ou need to download the W ebSphere. jar files created to work with Monitoring Studio from the Sentry Software website and store them in (% Patrol_Home% \bin). These files are essential in order to connect to y our W ebSphere A S through Monitoring Studio. The files for W ebSphere 5. x are different from those for W ebSphere 6. x , so please ensure y ou download the correct files from the Sentry Software website.
After ensuring that the required files are present on the local host, right-click the main Monitoring Studio icon > KM Commands > New > Java MBean polling (JMX) and from the drop-down list, select the environment: WebSphere 5.x, 6.x or 7.x.
Monitoring Features
214

Version 8.6.53
J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) W e lco m e Pa g e
Difference in connecting to 5. x v ersus 6. x : The main difference between the 5. x and 6. x v ersions is that W ebSphere 5. x requires IBM JVM whereas W ebSphere 6. x requires Sun JVM 1. 5 and abov e. Please ensure y ou hav e the right jav a v irtual machine depending on the v ersion of y our W ebSphere application serv ers.
Monitoring Features
215

Version 8.6.53
Step 1: Enter the environment connection information and the additional information
J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) Co nne ctio n Info rm a tio n Pa g e
Host: Name of host server where the WebSphere application server is installed SOAP Port: Enter port number. The first profile created on WebSphere is by default given the number 8880 and every profile created on WebSphere is allotted a new SOAP port number by increasing the count from 8880. This can be modified.
To connect to the W ebSphere A S, it is essential to connect to certain credential files: C lientKey F ile. jks and C lientTrustF ile. jks. These files are profile-specific and are created and stored by W ebSphere under % IBM_HO ME% \profile\profilename\etc. Depending on the security of y our env ironment, y ou can either giv e the path to these files on where the W ebSphere A S resides, or, just copy them from there to y our local file-sy stem.
TrustStoreFile path: Enter the path to the file ClientTrustFile.jks. TrustStore password: Enter the password created on WebSphere for your profile (default WebAS) KeyStoreFile path: Enter the path to the file ClientKeyFile.jks KeyStore password: Enter the password created on WebSphere for your profile (default WebAS)
Monitoring Features
216

Version 8.6.53
Server name: Name of the WebSphere application server. Node name: Enter node name allotted to your profile. By default WebSphere assigns a unique node name to each profile created. Click Next.
J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) Co nne ctio n A cco unt Cre d e ntia ls Pa g e
Principle: Enter the username Credentials: Enter the password Path to Java on the local server: Enter your java home path and ensure that all the settings are correct. Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When this timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on the ExecutionStatus parameter. Click Next. Ensure that all the settings are correct. If the credentials entered are correct, Monitoring
Monitoring Features
217

Version 8.6.53
Studio connects to the application server and presents a list of domains for you to select from.
J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) Do m a in Se le ctio n Pa g e
J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) Ke y Pro p e rty Pa g e
Monitoring Features
218

Version 8.6.53
J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) A ttribute Se le ctio n Pa g e
Select the attribute from the list and click Next. You can only select one attribute at a time. To monitor several attributes of the same key property, you are required to go through the wizard each time.

J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) Pa ra m e te rs Se le ctio n Pa g e
Value: Reports the actual value collected upon data polling
Monitoring Features
219

Version 8.6.53
Delta: Calculates the difference between values collected during two consecutive polling. DeltaPerSecond: Reports the value resulting of the division of the Delta by the number of seconds elapsed between the collection times Select the option "Discard negative Delta values" if you do not want negative values to be reported on the graph. Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extracted in order to have a more readable graph in the PATROL Console. The available rescaling options are: No rescaling Divide the value by a value that then gives you the reading in terms best suited to you Multiply the extracted value by a constant factor This can be useful if you extract numeric values in bytes but prefer to show a graph in megabytes. In such a case, you would divide the values by 1048576 (1024*1024).
J a v a M Be a n Po lling W iza rd (W e bSp he re Env iro nm e nt) Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this WebSphere monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
220

Version 8.6.53
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio icon bearing the name entered/displayed in the Object display name field; and at the next collect you will see values for the newly monitored object. You can add a string or numeric value search if you wish. WebSphere objects are instances of the SW_JMX class.
JOnAs
JOnAS is a leading edge Open Source implementation by OW2 of the Java EE specification.
Monitoring Studio KM for PA TR O L requires applications classes av ailable only with JVM 1. 5. Prev ious v ersions of JVM are not supported.
To monitor your JOnAs application server within your PATROL environment, right-click the main Monitoring Studio icon > KM Commands > New > Java MBean polling (JMX). From the dropdown list, select the environment: JOnAs 4.x.
Monitoring Features
221

Version 8.6.53
J a v a M Be a n Po lling W iza rd (J OnA s Env iro nm e nt) W e lco m e Pa g e
J a v a M Be a n Po lling W iza rd (J OnA s Env iro nm e nt) Co nne ctio n Info rm a tio n Pa g e
Host: Name of host server where the JOnAS application server is installed
Monitoring Features
222

Version 8.6.53
Port: Port number. (By default: 1099). This is linked to the protocol used. Can be modified Server name: Name given to Jonas application server Protocol: JRMP or IIOP. The protocol & the port number to be used is defined in the "carol.properties" file that can be found in %jonas_home%/conf Initial context factory: com.sun.jndi.rmi.registry.RegistryContextFactory (by default. Can be modified URL package prefixes: org.objectweb.jonas.naming (by default). Can be modified.
J a v a M Be a n Po lling W iza rd (J OnA s Env iro nm e nt) Co nne ctio n A cco unt Cre d e ntia ls Pa g e
Principle: Enter the username Credentials: Enter the password Path to Java on the local server: Enter your java home path and ensure that all the settings are correct. Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When this
Monitoring Features
223

Version 8.6.53
timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on the ExecutionStatus parameter. Click Next. If the credentials entered are correct, Monitoring Studio connects to the application server and presents a list of domains for you to select from.
J a v a M Be a n Po lling W iza rd (J OnA s Env iro nm e nt) Do m a in Se le ctio n Pa g e
Monitoring Features
224

Version 8.6.53
J a v a M Be a n Po lling W iza rd (J OnA s Env iro nm e nt) Ke y Pro p e rty Pa g e
J a v a M Be a n Po lling W iza rd (J OnA s Env iro nm e nt) A ttribute Se le ctio n Pa g e
Monitoring Features
225

Version 8.6.53

J a v a M Be a n Po lling W iza rd (J OnA S Env iro nm e nt) Pa ra m e te rs Se le ctio n Pa g e
Monitoring Features
226

Version 8.6.53
J a v a M Be a n Po lling W iza rd (J OnA s Env iro nm e nt) Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this JonAS monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds: Use default thresholds: Uses the default thresholds set by Monitoring Studio Set custom thresholds: Allows you to customize the thresholds for all parameters of the instance Use default thresholds and customize them: Sets the default Monitoring Studio thresholds on certain parameters (see list of parameters with default thresholds) and then allows you to customize any/all of them. This is mainly intended to help save time if you wish to customize the thresholds of just one of many parameters for the instance, and leave the default settings for the others.
Monitoring Features
227

Version 8.6.53
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio icon bearing the name entered/displayed in the Object display name field; and at the next collect you will see values for the newly monitored object. You can add a string or numeric value search if you wish. JOnAS client objects are instances of the SW_JMX class.
WebLogic
BEA WebLogic is a J2EE Platform product family that includes a J2EE application server- WebLogic Server, an Enterprise Portal - WebLogic Portal, an Enterprise Application Integration platform, a Transaction Server and Infrastructure - WebLogic Tuxedo, a Telecommunication Platform - WebLogic Communication Platform and also an HTTP web server for Unix, Linux, Microsoft Windows, and more. To monitor your WebLogic application server within your PATROL environment, you first need to download certain WebLogic JAR files/zipped files from the Sentry Software download page and place them into: %PATROL_home%/bin.
The files required by W ebLogic9. x are different from those required for W ebLogic 8. x . Please ensure y ou download the correct files corresponding to y our W ebLogic serv er v ersion.
W ebLogic v 8. x was created using JDK v 1. 4; therefore to run and poll W ebLogic 8. x , y ou need to run JVM v 1. 4. No other JVM v ersion will be able to run W ebLogic 8. x . W ebLogic v 9. x was created using the JDK v 1. 5, y ou need JVM v 1. 5 and abov e to connect to this serv er.
Right-click the main Monitoring Studio icon > KM Commands > New > Java MBean polling (JMX) From the drop-down list, select the environment: WebLogic "x"
Monitoring Features
228

Version 8.6.53
J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) W e lco m e Pa g e
J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) Co nne ctio n Info rm a tio n Pa g e
Host: Name of host server where the WebLogic application server is installed. Port: Port number. (By default: 7001). Can be modified
Monitoring Features
229

Version 8.6.53
F or W ebLogic 9. x : Initial contex t factory : weblogic. jndi. W LInitialC ontex tF actory (by default). C an be modified JNDI: weblogic. management. mbeanserv ers. domainruntime (by default). C an be modified
F or W ebLogic 8. x Initial contex t factory : weblogic. jndi. W LInitialC ontex tF actory (by default). C an be modified Serv er name (optional): Enter the serv er name
J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) Co nne ctio n A cco unt Cre d e ntia ls Pa g e
Principle: Enter the username Credentials: Enter the password Path to Java on the local server: Enter your java home path and ensure that all the settings are correct. Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When this timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on the ExecutionStatus parameter.
Monitoring Features
230

Version 8.6.53
Click Next. If the credentials entered are correct, Monitoring Studio connects to the application server and presents a list of domains for you to select from.
J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) Do m a in Se le ctio n Pa g e
J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) Ke y Pro p e rty Pa g e
Monitoring Features
231

Version 8.6.53
J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) A ttribute Se le ctio n Pa g e

J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) Pa ra m e te rs Se le ctio n Pa g e
Value: Reports the actual value collected upon data polling Delta: Calculates the difference between values collected during two consecutive polling. DeltaPerSecond: Reports the value resulting of the division of the Delta by the number of
Monitoring Features
232

Version 8.6.53
seconds elapsed between the collection times Select the option "Discard negative Delta values" if you do not want negative values to be reported on the graph. Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extracted in order to have a more readable graph in the PATROL Console. The available rescaling options are: No rescaling Divide the value by a value that then gives you the reading in terms best suited to you Multiply the extracted value by a constant factor This can be useful if you extract numeric values in bytes but prefer to show a graph in megabytes. In such a case, you would divide the values by 1048576 (1024*1024).
J a v a M Be a n Po lling W iza rd (W e bLo g ic Env iro nm e nt) Se tting s Pa g e
Object display name: Label displayed in the PATROL Console for this WebLogic monitoring. Object internal identifier (ID): PATROL internal identifier. What thresholds do you want to set for the newly created instance? A drop-down list allows you to select the mode of setting alert thresholds:
Monitoring Features
233

Version 8.6.53
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio icon bearing the name entered/displayed in the Object display name field; and at the next collect you will see values for the newly monitored object. You can add a string or numeric value search if you wish. WebLogic objects are instances of the SW_JMX class.
Thresholds and Alert Actions

Managing Thresholds
Choosing the thresholds mechanism mode
When you set up the monitoring of your environment with Monitoring Studio, you can set alert thresholds on various parameters. These alert thresholds typically depend on the application or devices you want to monitor. Monitoring Studio uses a standard internal PATROL mechanism, often known as the Override parameters feature. It sets the alarm and warning thresholds you entered by setting a specially formatted variable under the /___tuning___ tree in the PATROL Agent configuration. This is the standard method to set thresholds and is supported by BMC Software since version 3.4.11 of the PATROL Agent. With the 3.5 release of the PATROL Agent, BMC Software started to push another way to set thresholds, which is becoming the new thresholds standard in PATROL. This new method is known as PATROL for Event Management (formerly known as EventSpring) or PATROL Configuration Manager (PCM, formerly known as AgentSpring). Monitoring Studio fully supports PATROL for Event Management and is able to manage its thresholds through this new mechanism.
Monitoring Features
234

Version 8.6.53
By default, Monitoring Studio uses the Automatic method. This thresholds mode detects the type of thresholds used by the PATROL Agent and sets the thresholds accordingly.
To choose the mode of Threshold Mechanism:

Right-click the main Monitoring Studio icon > KM Commands > Options > Thresholds Mechanism Selection.... The following dialog box appears:
T hre s ho ld M e cha nis m Se le ctio n De fa ult o p tio n
Select one of the three following options: Automatic: Monitoring Studio automatically detects the way thresholds are managed by the PATROL Agent and uses the correct mode, either Tuning or PCM, accordingly. This is recommended if you are unsure of the way thresholds are managed.
W hen the A utomatic mode is used, Monitoring Studio will select PC M/Ev ent Management to manage thresholds if the "A S_EVENTSPR ING" class is statically loaded or preloaded on the PA TR O L agent. O therwise, Monitoring Studio will use the Tuning thresholds management mode.
Tuning: Monitoring Studio manages its thresholds through the standard Override parameters mechanism. Thresholds are stored in the PATROL Agent configuration under the /___tuning___ tree. This option is set by default and does not require any additional software. If you do not use PATROL for Event Management, it is recommended that you use this option. Event Management: Monitoring Studio manages its thresholds through the Event Management mechanism. Monitoring Studio is fully compatible with this mechanism. All classes are provided without any pre-set thresholds.
O nce y ou select the Ev ent Management threshold management method, y ou can modify and manage y our thresholds either through the Monitoring Studio interface, or through Ev ent Management. Thresholds are stored in the PA TR O L A gent configuration under the /A S tree. This option requires that y ou set up the PA TR O L for Ev ent Management KM on y our PA TR O L A gent. PA TR O L for Ev ent Management has to be enabled and preloaded. If y ou use PA TR O L for Ev ent Management in order to modify or customize y our thresholds, it is recommended that y ou use this option.
235

Version 8.6.53
In order to av oid side effects and unpredictable behav ior, if y ou change the thresholds management option, Monitoring Studio will automatically migrate the thresholds set through the prev ious method to the new method (only for its monitored objects). That is: if y ou select the Ev ent Management option, Monitoring Studio will automatically remov e all the thresholds (set for its monitored objects) stored in the /___tuning___ tree in the PA TR O L A gent configuration, and set the same under in the Ev ent Management database, under the /A S tree in the A gent configuration.
You may import a PA TR O L agent configuration (". cfg") with any ty pe of thresholds. If necessary , Monitoring Studio will conv ert the thresholds to the ty pe of thresholds currently used at the nex t discov ery (within an hour).
To Set or Modify Alert Thresholds

Monitoring Studio offers you full flexibility to set and modify the alert thresholds on each parameter.
Method (summary):
1. 2. 3. 4. Thresholds are set and modified through the Threshold wizard accessible by right-clicking the instance > KM commands > Set Thresholds. Select the parameter on which you wish to set/modify thresholds Select the threshold "type": Simple (2 alerts can be triggered) or Advanced (3 alerts can be triggered) Select the type of Alert Action you wish to trigger when an alert is raised.
For details, please refer to Setting or Modifying Alert Thresholds.
Setting or Modifying Alert Thresholds

Monitoring Studio enables you to set alert thresholds for each parameter through the command menu. To set or modify alert thresholds, right-click the Application/Container icon > KM commands > Set thresholds and the threshold management wizard appears.
The Threshold Management wizard can also be prompted immediately following the setup of a new monitoring object. The last panel of the wizard offers y ou the option of either accepting default thresholds, modify ing them right away , or setting them later.
236

Version 8.6.53
T hre s ho ld M a na g e m e nt W iza rd W e lco m e Pa g e
A drop down list displays the parameters available for the instance.
A n asterisk sy mbol "*" display ed nex t to the parameter name signifies that the parameter already has thresholds. You can then choose to either keep the same thresholds or just v iew them or modify them as per the requirement.
The Reference Guide lists all the classes with details on the menu commands and the parameters available for each class.
Threshold Type and Alert actions

BMC Performance Manager Monitoring Studio has two "types" of thresholds: Simple (2 alerts maximum) and Advanced (3 alerts maximum). Depending on the users selection, both types of thresholds can raise the following alerts: Do not trigger any alert Trigger an INFORMATION Trigger a WARNING Trigger an ALARM In addition, you can set Alert Actions to be triggered when an alert is raised on a parameter. Please see the section: Alert Actions capabilities for more details on the same.
237

Version 8.6.53
Simple Thresholds
Sim p le T hre s ho ld s Se tting s
This type of threshold is easy and very user-friendly: the threshold values are expressed in terms of "greater than/lower than". All the user has to do is to enter actual "limits" as per the specific requirement, and the frequency of occurrence. This type of threshold can raise a maximum of two alerts. Certain parameters have "pre-defined" values. Basically these parameters are the ones with boolean values, so the choice you can make can only be only one or the other depending on the parameter itself.
Advanced thresholds
T hre s ho ld M a na g e r W iza rd Pa ra m e te r Se le ctio n
238

Version 8.6.53
To access the advanced threshold options, check the box for Use advanced thresholds when you select the parameter > click Next. The advanced thresholds mode allows you to set up to a maximum of 3 alerts.
T hre s ho ld M a na g e r W iza rd T hre s ho ld s Se tting
This type of threshold setting is a little more complex as it requires the user to enter specific ranges of values as thresholds. This setting is like that of PATROL thresholds, where you have the possibility of raising three alerts: Border Alert: An alert can be triggered when the value polled is not between "x" and "x" and occurs "x" times in a row. Alert 1: An alert will be triggered if the value is between "x" and "x" and occurs "x" times in a row. Alert 2: An alert will be triggered if the value is between "x" and "x" and occurs "x" times in a row.
Note applicable to both Simple and A dv anced Thresholds: In general, A lert A ctions are triggered only when a parameter breaches its thresholds. Howev er for certain parameters, such as MatchingTrapC ount, MatchingLineC ount and MatchingEv entC ount, it is possible to trigger A lert A ctions not just when thresholds are breached, but also each time an SNMP trap is receiv ed or a matching line/ev ent is found. This option Ex ecute the A lert A ctions appears in the thresholds wizard for the parameters to which this feature is applicable under the section for A larms.
Example Lets say you are setting thresholds on a string search. In this wizard you will find the option Execute the Alert Action as string search has the parameter MatchingLineCount. If you select Execute the Alert Actions every time a matching line is found on the MatchingLineCount parameter, Monitoring Studio will run the Alert Actions every time a line matching the string search is found.
239

Version 8.6.53
Setting Thresholds on Dynamic Numeric Value Extractions

Monitoring Studio enables you to set thresholds on Dynamic Numeric Value Extractions, that is Numeric Value Extractions performed on instances of a Dynamic Object. Extracting numeric values can help you analyze the Dynamic Items output (the output of a command, a web page, the result of a SQL query, or WBEM query etc.). In order to apply this feature to all the Dynamic Items in a single operation, the Dynamic Object Builder creates Templates instances of the feature. While the standard Numeric Value Extraction feature apply to a single return output, Templates apply to all the Dynamic Items' output within the Dynamic Container. To set or modify alert thresholds on Dynamic Numeric Value Extractions, right-click the Numeric Value Extraction (Template) > KM commands > Set thresholds and the threshold management wizard appears.

Select the parameter on which you wish to apply the parameter and click Next.
Se t T hre s ho ld W iza rd Pa ra m e te r Se le ctio n Pa g e
A n asterisk (*) display ed nex t to the parameter name signifies that the parameter already has thresholds.
The R eference Guide lists all the classes with details on the menu commands and the parameters av ailable for each class.
240

Version 8.6.53
Step 2: Dynamic Threshold Setting

Set the dynamic thresholds for the parameter previously selected. The available alert options are: Do not trigger any alert Trigger an INFORMATION Trigger a WARNING Trigger an ALARM
Se t T hre s ho ld W iza rd Dy na m ic T hre s ho ld Se tting Pa g e
As for standard static thresholds, the following options are available: Border Alert: An alert can be triggered when the value polled is not between "x" and "y" and occurs "z" times in a row. Alert 1: An alert will be triggered if the value is between "x" and "y" and occurs "z" times in a row. Alert 2: An alert will be triggered if the value is between "x" and "y" and occurs "z" times in a row. For each alert option, "x" and "y" may be the column number where the dynamic thresholds should be found use the %{<Column Number>} syntax, or a regular static numeric threshold. Both dynamic and static thresholds can be mixed.
Since Monitoring Studio applies thresholds as defined in the Threshold wizard and to av oid inconsistent alarms, make sure the Static and the Dy namic thresholds are in concordance with the v alues/columns of the ex tracted output.
Dy namic Numeric Value Ex tractions can only be defined when the location of the numeric v alue in the Template is set to "in the column number "n""
Click Set thresholds to apply the thresholds to the parameter.
241

Version 8.6.53
Alert Actions Description

Alert Actions enables the PATROL administrator to choose/configure the execution of certain actions when an application goes into a state of alert, this is also referred to as recovery actions. With the Alert Actions functionality, it is possible to do one of the following: Customize notifications Specify recovery actions
Global vs Specific Alert Actions

Alert Actions can be set at two different levels: Global Alert Actions are set for the overall application/root container. They specify the way in which the notification of a problem is done for all instances in the application/root container. This means that any parameter within this application/root container that trigger an alert will perform the Alert Actions set at the global level. Specific Alert Actions are set individual parameters and generally indicate the actions to perform in order to recover from a particular problem (e.g.: when this parameter goes into alarm - execute this recovery script). Therefore, specific Alert Actions need to be set for each parameter as the need may be. If a specific Alert Action is set on a parameter belonging to a root container already set to trigger Global Alert Actions, both settings will be taken into account for that particular parameter instance.
If y ou setup monitoring objects under the main Monitoring Studio icon without creating an application or container icon, y ou cannot set global A lert A ctions on them. Global A lert A ctions can only be set on an application container and will apply to agent-less objects under it.
Set Global Alert Actions

Right-click on an Application/Container icon > KM commands > Set global actions Select the Alert Actions you want to trigger each time the parameter(s) enter(s) a state of alert and click Next.
242

Version 8.6.53
Glo ba l A le rt A ctio n W iza rd A le rt A ctio n Se le ctio n Pa g e
The next panel depends on your selection; if the selection requires further input (as for PATROL Event command lines, or write a line to a LOG file etc.), enter the relevant text with the help of Alert Action macros, as in the example shown below:
Glo ba l A le rt A ctio n W iza rd Inp ut De finitio n Pa g e
Global Alert Actions have been set. Click Finish.
243

Version 8.6.53
Glo ba l A le rt A ctio n W iza rd A le rt Ex e cutio n Co nfirm a tio n Pa g e
You can set additional A lert A ctions on any /all of the monitored parameters by using "Specific A lert A ctions".
Example Lets take the case of the "My Custom Application" application container. Two global Alert Actions: Trigger a PATROL Event and Annotate the parameters graph are set on this container. These Alert Actions will be triggered each time any parameter held under this application container goes into alert state. Specific Alert Actions set on parameters under this application container on which global Alert Actions have been set, are triggered in addition to those set on the global level. This helps customize the alerts as per the specific requirements of the corresponding monitored object.
Set Specific Alert Actions

Right-click on a Monitored Instance > KM commands > Set Alert Actions Select the parameters for which you wish to set specific Alert Actions. Click Next.
244

Version 8.6.53
Sp e cific A le rt A ctio n W iza rd Pa ra m e te r Se le ctio n Pa g e
The panel lists all the available specific Alert Actions. Make your selection and click Next.
Sp e cific A le rt A ctio n W iza rd A le rt A ctio n Se le ctio n Pa g e
245

Version 8.6.53
The nex t panel depends on the selection. If the selection requires further input (as for command lines, or write a line to a LO G file etc. ), enter the relev ant tex t, with the help of A lert A ction macros as in the ex ample shown.
Enter the required input. Click Next.
Sp e cific A le rt A ctio n W iza rd Inp ut De finitio n Pa g e
The next panel will confirm the selected Alert Action specific to the chosen parameter. Click Finish.
Sp e cific A le rt A ctio n W iza rd A le rt Ex e cutio n Co nfirm a tio n Pa g e
If/when the selected parameter goes into alert, it will trigger the specific Alert Action as configured.
Alert Actions Capabilities

Alert Actions offers a large choice of actions in order to notify the administrator of a problem with the application or to recover from a particular problem. Monitoring Studio can be configured to run one or several types of actions when an alert is triggered by PATROL. The following types of Alert Actions can be performed by Monitoring Studio:
246

Version 8.6.53
Trigger a PATROL event

If you select the Trigger a PATROL Event action, you need to enter the string that will be displayed with the event
A le rt A ctio ns : T rig g e r a PA T R OL Ev e nt
A PATROL Event can be viewed from: Standard PATROL Consoles (Classic Console, PATROL Central) PATROL Enterprise Manager BMC Impact Manager Other third-party products that interface with PATROL.
Annotate the parameter's graph

If you select the Annotate the parameters graph action, you need to enter the string that will be displayed within the annotation point.
247

Version 8.6.53
A le rt A ctio ns : A nno ta te the p a ra m e te r's g ra p h
Execute an OS command
If you select the Execute an OS command action, you need ton complete the following panel:
A le rt A ctio ns : Ex e cute a n OS co m m a nd
Enter a command line to be executed Enter the username and password used to run the command. The command can be a program utility or a script shell, and can have arguments.
The command must be non-interactiv e (no window, no user input)
248

Version 8.6.53
Execute a PSL command

If you select the Execute a PSL command action, you need to enter the PSL statement to be executed by the PATROL Agent. Although only a single line is permitted, it can have several PSL instructions.
A le rt A ctio ns : Ex e cute a PSL s ta te m e nt
The PSL command is recommended for adv anced user of PA TR O L.
Send a pop-up to the PATROL consoles

If you select the Send a pop-up to the PATROL Consoles action, you need to enter the message that will be displayed in the pop-up as well as the in title of the pop-up window.
249

Version 8.6.53
A le rt A ctio ns : Se nd a p o p -up to the PA T R OL Co ns o le s
Too many pop-ups could may the operators.
Write a line to a LOG file

If you select the Write a line to a LOG file action, you need to enter the LOG file path and the content of the line.
A le rt A ctio ns : W rite a line to a LOG file
250

Version 8.6.53
Send a basic SNMP trap (using the PATROL MIB)

If you select the Send a basic SNMP trap action, you need to complete the following panel:
A le rt A ctio ns : Se nd a ba s ic SNM P tra p
IP address or hostname of the SNMP trap destination SNMP port and community string Text that will be sent in the SNMP trap
Send a custom SNMP trap

If you select the Send a custom SNMP trap action, you need to complete the following panel:
251

Version 8.6.53
A le rt A ctio ns : Se nd a cus to m SNM P tra p
IP address or hostname of the SNMP trap destination SNMP port and community string All the characteristics of the trap: Enterprise ID, trap number and up to 4 varbinds.
Send an E-mail
If you select the Send an E-mail action, you need to complete the following panel:
252

Version 8.6.53
A le rt A ctio ns : Se nd a n E-m a il
Enter the sender and the recipient email address in the From an To field. To send the email to multiple recipients, use the comma (,) or the semi-column (;) to separate the recipients' email addresses (ex: RecipientAddress1;RecipientAddress2;RecipientAddress2 OR ReciptientAddress1, RecipientAddress2,RecipientAddress2) Enter the SMTP server name Type the email subject and the message you wish to send
Customizing an Alert Action

Alert Actions are highly customizable, you can: Customize the string sent through SNMP Set the username/password used to execute the OS Command Define the content of the PATROL event sent by Monitoring Studio, etc. In addition, some information regarding the alert, such as the parameter name or its value, is available through Alert Action macros. This information can be used to further customize the Alert Action triggered by Monitoring Studio and provide more details about the problems that occur.
253

Version 8.6.53
Alert Action Macros

A macro is a variable whose value is replaced when an Alert Action is triggered. Macros can be used to customize the content of each Alert Action. For example: %{VALUE} is replaced by the actual current value of the parameter that triggered the alert. When used in the text field for a PATROL event Alert Action, the percentage value is replaced by the actual current value of the parameter that triggered the alert. Each macro listed in the tables below contains information about what triggered the PATROL alert. Some macros are "general" or "common" - these can be used for any object, and some are "objectspecific" macros that are specific to the object, such as databases or files or JMX applications etc.
General Macros
The macros given in the table below can be used on any object:
General Macros
%{PARAMETER_NAME} %{VALUE} %{ALARM_TYPE} %{OBJECT_ID} %{OBJECT_LABEL} %{OBJECT_CLASS} %{OBJECT_TYPE} %{PARENT_<PARENT MACRO>}
Description
Name of the parameter that triggered the alert Value of the parameter that triggered the alert Type of the alert triggered (ALARM, WARN or INFORMATION) PATROL ID of the object triggering the alert Display name of the object triggering the alert Class (".KM") of the object triggering the alert Type of the object triggering the alert ("Process", "String", etc.) Gets the parent's object of a macro. Example: In the case of String Search performed in Command Line, use the following macro to get complete command line return output: %{PARENT_OSCOMMAND_RETURN_OUTPUT} ID of the objects parent triggering the alert (the parent of a String object could be a LOG file, e.g.) Display name of the objects parent triggering the alert Class (".KM") of the objects parent triggering the alert Type of the objects parent triggering the alert ("File", "OSCommand", etc.) PATROL ID of the application triggering the alert Display name of the application triggering the alert Class (".KM") of the application triggering the alert Type of the application triggering the alert ("Application") Contact information in case of an application failure Description of the application
%{PARENT_ID} %{PARENT_LABEL} %{PARENT_CLASS} %{PARENT_TYPE} %{APPLICATION_ID} %{APPLICATION_LABEL} %{APPLICATION_CLASS} %{APPLICATION_TYPE} %{APPLICATION_CONTACT} % {APPLICATION_DESCRIPTION}
254

Version 8.6.53
General Macros
% {APPLICATION_EXISTENCEFILE S} %{ASCTIME:}
Description
List of files that identify the application as present
Current time when the Alert Action is performed. Specify a formatting as described under Format Symbols in the Reference section. Example: %{TIME:%H:%M:%S} will be replaced by 09:45:17 at run time Inserts carriage return Recommended for advanced users only Provides an internal instance variable name to be inserted. The path is relative to the object triggering the alert. Example: %{/worstParam} will be contain the name of the worst parameter on this instance, which is an application instance built-in variable (see the "PATROL Script Language Reference" document).
%{NEWLINE} %{/...}
Object Specific Macros

Database Macros
%{DATABASE_TYPE} %{DATABASE_QUERY} %{DATABASE_NAME}
Description
Type of the database. SQL Server or Oracle SQL statement sent for execution Name of the database the SQL query is sent to. May be the database name for SQL Server, or the Oracle SID for Oracle.
Dynamic Object Macros

%{DYNAMIC_RETUNR_OUTPUT}
Description
Returns the output of the dynamic object
File Macros
%{FILE_CURRENT_NAME} %{FILE_NAME}
Description
Current file being monitored when monitoring a file whose name changes over time) Name of the monitored file as entered in the GUI
File System Macro

%{FILESYSTEM_NAME}
Description
Name of the monitored file system
Folder Macro
%{FOLDER_PATH} %{FOLDER_OLDEST_REMAINING_FILE}
Description
Folder being monitored Folder with the oldest remaining file
HTTP Macros
%{HTTP_RETURN_OUTPUT} %{HTTP_METHOD} %{HTTP_URL}
Description
Result of the HTTP request GET or POST depending on what was selected in the GUI URL being tested
255

Version 8.6.53
JMX Macros
%{JMXPOLLING_SERVER_TYPE} %{JMXPOLLING_HOST} %{JMXPOLLING_PORT} %{JMXPOLLING_DOMAIN} %{JMXPOLLING_KEY_PROPERTY} %{JMXPOLLING_ATTRIBUTE} %{JMXPOLLING_CONTENT}
Description
Type of JMX server being polled Host name of JMX server polled Port number of the JMX server polled Domain of the JMX server polled Key property of the JMX server polled Attribute of the JMX server polled Content of the result output of the JMX server polled
KM Watch Macros
%{KMWATCH_CLASS} %{KMWATCH_ID} %{KMWATCH_PARAMETER}
Description
Class of the PATROL object being monitored Instance ID of the PATROL object being monitored Parameter name of the PATROL object being monitored
MPF Macros
%{MPF_CLASS} %{MPF_ID} %{MPF_FORMULA}
Description
Class of the PATROL object being monitored Instance ID of the PATROL object being monitored User-defined formula used to rescale the parameter value
OS Command Macro
%{OSCOMMAND_OSCOMMAND} %{OSCOMMAND_RETURN_OUTPUT}
Description
Command line being executed and analyzed Return output of the OS command
Process Macros
%{PROCESS_NAME} %{PROCESS_COMMAND_LINE} %{PROCESS_USER_ID} %{PROCESS_PID_FILE}
Description
Process name being searched for, as entered in the GUI Process command line being searched for, as entered in the GUI Process user ID being searched for, as entered in the GUI Path to the PID file whose corresponding process is being monitored
SNMP Polling Macros

%{SNMPPOLLING_OID} %{SNMPPOLLING_HOST} %{SNMPPOLLING_COMMUNITY} %{SNMPPOLLING_PORT} %{SNMPPOLLING_CONTENT}
Description
SNMP OID being polled SNMP Agents host name being polled SNMP community string being used to query the SNMP agent UDP port being used to poll the SNMP agent. 161 by default Value of the OID being polled
256

Version 8.6.53
SNMP Trap Macros

%{SNMPTRAP_IP} %{SNMPTRAP_FOUNDIP} %{SNMPTRAP_COMMUNITY} %{SNMPTRAP_ENTERPRISEID} %{SNMPTRAP_TRAPNUMBER} %{SNMPTRAP_FOUNDTRAPNUMBER} %{SNMPTRAP_CONTENT}
Description
Originating IP Address of the SNMP traps being looked for Actual originating IP address of the trap that has been received SNMP community string of the SNMP traps being looked for Enterprise ID (OID) of the SNMP traps being looked for SNMP Trap numbers (specific numbers) being looked for Actual SNMP trap number that has been received and matches the entered criteria Content of the found trap
String search Macros

%{STRING_SEARCHED_1} %{STRING_SEARCHED_2} %{STRING_LAST_MATCHING_LINE}
Description
First regular expression being searched for Second regular expressions being searched for Last line that match with the String search criteria
WMI Macros
%{WMI_HOST} %{WMI_NAME_SPACE} %{WMI_QUERY} %{WMI_USERNAME} %{WMI_RETURN_OUTPUT}
Description
Name of host where the WMI query is being run Namespace of the WMI query WMI statement sent for execution WMI execution username Content of the result output of the WMI query
WBEM Macros
%{WBEM_HOST} %{WBEM_NAME_SPACE} %{WBEM_QUERY} %{WBEM_USERNAME} %{WBEM_RETURN_OUTPUT}
Description
Name of host where the WBEM query is being run Namespace of the WBEM query WBEM statement sent for execution WBEM execution username Content of the result output of the WBEM query
Windows Event Macros

%{NTEVENT_LOG} %{NTEVENT_SOURCE} %{NTEVENT_ID} %{NTEVENT_LAST_MATCHING} %{NTEVENT_LAST_MATCHING_CONTENT}
Description
Name of the Windows event log being monitored Windows Event source whose new entries are monitored ID of the Windows events being searched for Last matching event found Content of the NT event
257

Version 8.6.53
Windows Performance Macros

%{PERFORMANCE_INSTANCELIST} %{PERFORMANCE_COUNTER} %{PERFORMANCE_PERFORMANCE}
Description
Windows performance object instances being monitored Windows performance counter being monitored Windows performance object name being monitored
Windows Service Macros

%{SERVICE_NAME}
Description
Name of the service of an NT service class
Administration Features
This section deals with common administrative features such as setting thresholds or alert actions, exporting/importing the monitoring configuration. It also describes tools like the Process Viewer, Windows EventLog Reader, SNMP Browse and SNMP Trap Listener. Also described in this section are a few useful features of Monitoring Studio such as cut/copy/paste and how to temporarily suspend the monitoring of an object.
Exporting Configuration to a File

This feature provides a simple way to save the configuration of a PATROL Agent by exporting it to a file for reuse later. The configuration saved in a file can then be loaded onto a different PATROL Agent through the PATROL interface. The main benefits are that it: Eliminates the trouble of manually configuring Monitoring Studio on another PATROL Agent all over again Ensures both configurations are identical Monitoring Studio offers you two options: To export the entire Monitoring Studio configuration To export an application monitoring configuration
Exporting the entire Monitoring Studio configuration

This option allows you to export the entire Monitoring Studio configuration to one or more configuration files. Right-click the main Monitoring Studio icon > KM commands > Configuration > Export Configuration
258

Version 8.6.53
Co nfig ura tio n Ex p o rt W iza rd A p p lica tio n/Co nta ine r Se le ctio n Pa g e
If you select the option "Include Monitoring Studio global settings", you will arrive at this panel:
Select the settings you wish to export and click Next. Enter the path and file name of the file that will contain the PATROL Agents configuration:
259

Version 8.6.53
Co nfig ura tio n Ex p o rt W iza rd Co nfig ura tio n File Lo ca tio n Pa g e
Export configuration to: Enter the path and file name for the configuration file. Split the file in smaller parts if necessary: Select this option if you feel that your pconfig version may not support large files. Click Finish. A successful export of the configuration will bring-up this panel:
Co nfig ura tio n Ex p o rt W iza rd Ex p o rt Co nfirm a tio n M e s s a g e
By default, the configuration file is created in the "% PA TR O L_HO ME% \config" directory and named "Ex port_SW _Sentry . cfg".
Exporting an application monitoring configuration

Exporting one or several application monitoring configurations works exactly the same way as exporting the entire application. The main difference is that only the information relevant to the application monitoring will be saved.
260

Version 8.6.53
Right-click the main Monitoring Studio icon > KM commands > Configuration > Export Configuration and select the application-monitoring to export from the drop down list:
Or right-click an application or sub-application container > KM commands > Export Configuration. Go through the same procedure of entering the destination file path and file name etc. as displayed above for exporting the entire configuration. A confirmation message will pop-up once the configuration has been successfully exported.
Importing Configuration
This feature provides a simple way configure a PATROL Agent by importing a configuration already in use on another PATROL agent. It: Eliminates the trouble of manually configuring Monitoring Studio on another PATROL Agent all over again Ensures both configurations are identical Basically, you import a configuration file that has been "exported" from another Agent and saved. Monitoring Studio offers you two options: To import the entire Monitoring Studio configuration To import an application monitoring configuration The options displayed by the import configuration wizard will depend on the file type exported and saved (entire Monitoring Studio configuration and/or application monitoring).
261

Version 8.6.53
Step 1: Import Configuration

To access the import configuration wizard, right-click the Monitoring Studio icon > KM commands > Import and Export > Import configuration.
Im p o rting Co nfig ura tio n W iza rd W e lco m e Pa g e
Step 2: Select config file to import
Im p o rting Co nfig ura tio n W iza rd File Se le ctio n Pa g e
Select the configuration file and click Next. Monitoring Studio will detect the configuration files stored in
262

Version 8.6.53
the entered path.
Step 3: Confirm import of global settings
Im p o rting Co nfig ura tio n W iza rd Glo ba l Se tting Im p o rt Pa g e
Click Yes if you wish to import the global settings as well.
Importing global settings will impact the global settings on y our ex isting objects. It will ov erwrite the old global settings. These global v ariables would hav e been specified and selected/or not, during the ex port of this configuration. F or instance, take the case of the global v ariable for License. If the imported configuration has License4, and y ou accept the global settings during the import, this is the license key that will now be assigned to the host which is importing the configuration.
Or click No if you do not wish to import global settings The next window will show if there are similar existing objects and will ask you to whether you wish to overwrite the existing objects or make a copy.
263

Version 8.6.53
Im p o rting Co nfig ura tio n W iza rd Ex is ting Obje cts Pa g e
Clicking Overwrite will overwrite existing objects and then on clicking Finish the summary of the imported objects will pop up:
Im p o rting Co nfig ura tio n W iza rd Ov e rrid e Co nfirm a tio n Pa g e
Or
264

Version 8.6.53
Im p o rting Co nfig ura tio n W iza rd Im p o rt Co nfirm a tio n Pa g e (Ov e rrid e Op tio n)
Selecting Make a copy instead of Overwrite will make a copy of the configuration in your console without overwriting current existing objects. A panel will ask you to assign prefixes to these copied objects:
Im p o rting Co nfig ura tio n W iza rd Pre fix De finitio n Pa g e
Enter the prefix. The new panel will show a summary.
265

Version 8.6.53
Im p o rting Co nfig ura tio n W iza rd Im p o rt Co nfirm a tio n Pa g e (Co p y with Pre fix )
Click Finish, and a panel confirming the import will pop-up
Im p o rting Co nfig ura tio n W iza rd Co m p le te d Im p o rt Co nfirm a tio n Pa g e
On completion of the discovery process, you will see all the objects of the imported configuration in your console.
Process Viewer Tool

The Process Viewer built-in tool helps the Monitoring Studio administrator identify the characteristics of the currently running processes and therefore monitor them in the most efficient way. To access the Process Viewer tool: Right-click on the main Monitoring Studio icon > KM commands > Tools > Process Viewer.
266

Version 8.6.53
Pro ce s s Vie we r
This window shows you how processes are currently seen by Monitoring Studio. It helps you enter the criteria to identify the process you want to monitor (name, running as and command line). To refresh the process list, click the Update button, and click Close to close the Process Viewer tool.
Modifying Object Name and/or ID

Once you have configured one or several monitoring tools, you may need to rename/modify some display names or IDs them. The Rename feature allows you to: Rename the Object display name Modify the Object internal identifier (ID) To rename an object, right-click the desired object > KM commands > Rename.
267

Version 8.6.53
M o d ify ing a n Obje ct Na m e a nd /o r ID
The Rename feature allows you to edit the object display name as well as the object ID. Make the changes and click OK. You will get a pop-up asking you to confirm the change of the object ID:
M o d ifica tio n o f a n Obje ct Na m e a nd /o r ID W a rning
If you are certain that the new ID will not cause any problems, click Yes, and the PATROL console will display the new label and will update the ID as well.
268

Version 8.6.53
Process Command Credentials

Monitoring Studio KM for PATROL runs OS commands to collect process information. In order to gather all process information, advanced privileges are sometimes required.
On Windows Systems
1. Right-click the Monitoring Studio icon > Options > Process Command Credentials...
Se tting Pro ce s s Co m m a nd Cre d e ntia ls o n W ind o ws Sy s te m s
Monitoring Studio allows you to set or modify the process command credentials that will be used for running OS commands. Enter a username and password or leave the fields blank if you want Monitoring Studio to automatically use the default Patrol Agent account. 2. Click OK to save your settings.
On Unix/Linux Systems
Depending on the targeted platform, Monitoring Studio may use some external system utilities to gather information. Sometimes the PATROL Agent default account does not have sufficient privileges to execute these commands and it is not possible in your environment to give super-user rights to the PATROL Agent. In such case Monitoring Studio can use the "sudo" utility to execute external commands as "root". The "sudo" utility helps UNIX system administrators secure their environment by authorizing some users to execute only certain commands specified as another user account (typically root). If this applies to you, the "sudo" options feature could be a good workaround.
269

Version 8.6.53
1. Right-click the Monitoring Studio icon > Options > Process Command Credentials...
Se tting Pro ce s s Co m m a nd Cre d e ntia ls a nd Co m m a nd Line o n Unix /Linux Sy s te m s
2. Enter the user credentials to execute external "ps" command, or leave blank to use the default PATROL account 3. Enter the command line to execute the sudo utility
Ensure that the sudo utility is installed on the sy stem, and that the "/etc/sudoers" file is configured to allow the PA TR O L A gent to ex ecute the selected commands as root.
SNMP Browser Tool

The SNMP Browser built-in tool allows the Monitoring Studio administrator to easily visualize the variables (OID and values) available in an SNMP agent. This tool is very useful to identify which OID you need to poll in the SNMP Polling wizard. To set the SNMP Browser tool:
270

Version 8.6.53
1. 2. 3. 4. 5.
Right-click the main Monitoring Studio icon > KM commands > Tools > SNMP Browser Enter the hostname or IP address of the computer where the SNMP agent is running Enter its port (by default: 161) and its community Specify the root OID from which you want to perform a "SNMP walk" (sort of SNMP dump) Click the Update button. If the information entered is correct, the result of the SNMP walk is shown a few seconds later, if not, an error message is displayed with some details about the failure. You can use the same settings when you setup a new SNMP Polling object in Monitoring Studio.
Performing an SNMP walk on a remote SNMP agent that has thousands of v ariables may take a long time.
6.
Click the Close button to quit the SNMP Browser tool.
SNMP Trap Listener Tool

The Real-time SNMP Trap Listener built-in tool allows you to visualize all of the SNMP traps and their characteristics received by the PATROL Agent and Monitoring Studio. This tool is pretty helpful when you want to setup a SNMP Trap listening object in Monitoring Studio, but you ignore the characteristics of the traps you want to detect. To access the SNMP Trap Listener tool: 1. Right-click the main Monitoring Studio icon > KM commands > Tools > Real-time SNMP Trap Listener. The incoming SNMP traps are shown in real time in this window as soon as they arrive. You can view their main characteristics (originating IP address, community, Enterprise OID and trap specific number) as well as their attached "varBinds" (attached variables). This will help you specify the search criteria in the SNMP Trap Listening wizard. The newest (or latest arrived) trap is shown first in the list. Pause if you wish to stop the reception of traps and have more time to analyze the characteristics of the previously arrived traps. Resume to resume the listening. Close to quit the tool window.
2. 3. 4.
Due to an SNMP protocol limitation, it is not possible to hav e more than one program on one computer listening to SNMP traps (handling the UDP/162 port). If another program is listening to SNMP traps, Monitoring Studio is not able to listen to SNMP traps and an error message is shown. F or the same reason, it is not possible to use this tool and listen for SNMP traps from a Monitoring Studio object in the PA TR O L C onsole. It may just be one or the other.
Setting Polling Interval

A polling interval defines how often new data is collected. A new collect can be performed from once every second, to once in a day. Monitoring Studio allows you to set/modify the polling interval of each monitored object through the menu command: Set Polling Interval. Polling intervals can be set for objects created by Monitoring Studio that collect data (files, processes, OS commands, SNMP polling etc.). By default, the polling interval is set to 2 minutes on all objects, which can be modified at any time.
271

Version 8.6.53
To access this feature, right-click the Application/Container icon > KM commands > Set Polling Interval.
Se tting a n A p p lica tio n Po lling Inte rv a ls
The options available are either to: Collect every: X hour; X minutes; X seconds: Set the polling interval in hours/minutes/seconds. Or Collect once a day at: x hour (24 hours); x minutes; x seconds: Here the values selected indicate the time of day. Example: 14; 30; 0 would mean that the polling is done only once a day at 2:30pm (14:30 hrs) Collect once a week on <weekday> at: X hour; X minutes; X seconds: Here the values selected indicate the time of the selected weekday. Example: 14; 30; 0 would mean that the polling is done only once a week on <selected weekday> at 2:30pm (14:30 hrs)
The option to set polling interv als is not av ailable for string searches, numeric v alues, tex t pre-processing, application/containers and SNMP trap instances, since either they do not hav e collectors, or as in the case of SNMP traps hav e collectors that react to ev ents.
Behavior of polling interval for common collectors:

Common collectors
Certain collectors are "common collectors". A common collector fetches data for all the objects of its class at the same time. For instance, for Processes, the collector fetches data from all processes at the same time. The collection would be very resource-intensive (especially on UNIX) if the collector were to look for data one-by-one for each running process. This is why certain classes/objects have "common collectors". These objects are: Process, Windows Events, Windows Systems and File Systems. The common collectors are listed under the SW_SENTRY class.
272

Version 8.6.53
Polling interval for common collectors

If you set/modify the polling interval for an object that has a common collector (Process, Windows Events, Windows Services and File Systems) the polling interval will be applicable to all objects of that particular class. Therefore, if you set the polling interval to "collect every 5 minutes" for a winlog.exe process that you are monitoring; all the process objects you are monitoring will also be polled every 5 minutes, since the SW_Process class has a common collector.
Java Settings
The Java Settings wizard enables you to define which Java instance is to be used by Monitoring Studio. You can either use the automatic detection, select a pre-detected java path or enter manually the path leading to the Java executable directory to be used. To access the Java Settings wizard, right-click the main Monitoring Studio icon > KM commands > Options > Java Settings.
J a v a Se tting s W iza rd W e lco m e Pa g e
Select the Java executable detection method: Select one of the three following options:
273

Version 8.6.53
Let Monitoring Studio automatically detect the Java path: Select this option if you wish Monitoring Studio to detect the Java executable directory by itself upon each discovery. Select a Java path detected by Monitoring Studio: Select this option if you wish to select a Java executable directory within a list of pre-detected executables. Enter manually the Java path to be used by Monitoring Studio: Select this option if you wish to manually enter the Java executable directory path. Click Next to continue.
Automatic Detection
If you have selected the automatic detection at the previous step of the wizard, Monitoring Studio displays the path of the Java executable directory that will be used when performing commands requiring Java features.
J a v a Se tting s W iza rd A uto m a tic De te ctio n
Click Finish to save your settings.
User Selection
If you have selected the user selection option at the previous step of the wizard, Monitoring Studio displays a list of all the Java executable directory found on your machine.
274

Version 8.6.53
J a v a Se tting s W iza rd Us e r Se le ctio n
Select the Java executable directory you wish Monitoring Studio to use when performing commands requiring Java features and click Finish to save your settings.
Manual
J a v a Se tting s W iza rd M a nua l Se tting s
If you have selected the Manual option at the previous step of the wizard, Monitoring Studio let you enter the path to the Java executable directory you wish Monitoring Studio to use when performing commands requiring Java features. Click Finish to save your settings.
275

Version 8.6.53
Windows EventLog Reader Tool

The Windows EventLog Reader built-in tool shows the events registered in a specific Windows EventLog. What is interesting with this feature is that it shows how each event is actually registered: its source, its ID and its arguments (or "insertion strings"), the criteria required for monitoring EventLogs.
A s opposed to other common Ev entLog R eader tools av ailable, this one shows neither the whole ev ent description string nor the username that has logged the ev en, because these operations are resource-intensiv e. By doing so, Monitoring Studio allows y ou to monitor really heav y Ev entLogs with no negativ e impact on performance.
To access the Windows EventLog Reader tool: 1. Right-click the main Monitoring Studio icon > KM commands > Tools > Windows EventLog Reader.
W ind o ws Ev e ntLo g R e a d e r
2. 3. 4.
5. 6.
Select the EventLog you wish to view and click the Update button to refresh the window. This may take a few seconds to complete. The latest event is shown first in this list. The last column in this window shows the arguments registered in each event. There is one line per argument: the first argument line corresponds to the "Argument 1" field in the Windows Event monitoring wizard, the second argument line corresponds to the "Argument 2" field, etc. To refresh the window, click the Update button. To close the window, click the Close button.
276

Version 8.6.53
Setting the Discovery Interval

By default, Monitoring Studio performs a discovery every hour to create, modify and update monitored objects, if necessary. However, you can easily change the default discovery interval to meet your specific needs. 1. Right-click the Monitoring Studio icon > Options > Discovery Interval...
Se tting Dis co v e ry Inte rv a l
2. Use the arrows to customize the discovery interval from once every 5 minutes to once every 24 hours. 3. Click OK to save your settings.
Trigger a KM Discovery
Monitoring Studio automatically executes a discovery every hour of all objects for the monitored system. This enables discovering and then monitoring any new objects added or removed etc. You can also force a discovery manually by right-clicking on the Monitoring Studio icon > KM Commands > Trigger a KM Discovery.
277

Version 8.6.53
Monitoring Studio Configuration Reports

Instant Configuration Reports
Monitoring Studio enables you to generate a report on the configuration of all monitored objects:
To generate an Configuration Report

Right-click the Monitoring Studio icon > KM Commands > Configuration > Report > Now...
A cce s s ing Co nfig ura tio n R e p o rt Co m m a nd
278

Version 8.6.53
Se tting the Co nfig ura tio n R e p o rt Pa ra m e te rs
The report is generated in the selected format and saved in the defined location.
Ex a m p le o f a XM L Co nfig ura tio n R e p o rt
Object Configuration Reports

The Object Configuration menu command generates an instant report on the configuration of all objects
279

Version 8.6.53
under the selected object icon. There are two types of Object Configuration reports: 1. Configuration reports on all monitored objects under the Monitoring Studio icon or any container icon: Monitoring Studio/Container icon > KM Commands > Configuration > Display Object Configuration. The report is generated and displayed instantly. Configuration reports on individual objects: Object icon > KM Commands > Display Object Configuration. The report is generated and displayed instantly.
2.
Entire Configuration Reports

The Entire Configuration Report command enables you to generate an instant report of the configuration of all the monitored objects: Monitoring Studio icon > KM Commands > Configuration > Display Entire Configuration. The report is generated and displayed instantly.
Scheduling Configuration Reports

Monitoring Studio enables you to schedule the generation of configuration reports for: All objects under the Monitoring Studio icon Containers All (includes both options above)
To schedule a report
Right-click the Monitoring Studio icon > KM Commands > Display Configuration > Report Scheduler. The scheduling wizard appears.
280

Version 8.6.53
R e p o rt Sche d ule r W iza rd W e lco m e Pa g e
Click Next. The next panel enables you select the report output format and to configure the scheduling options.
R e p o rt Sche d ule r W iza rd Sche d uling Op tio ns Pa g e
The configuration report will include the entire configuration of all monitored objects under the Monitoring Studio icon. Report Output formats: Select one of the three available formats in the list: CSV (Comma Separated Values) to create delimited text files reports which use a comma to separate values. Monitoring Studio will create a report per class Plain English to create a report where data is displayed in an unformatted style. XML (Extensible Markup Language) to create a report formatted as a standard XML file Scheduling options: allows you to select the frequency: Never Every hour Every day at a specific time Every week at a specific time and day Every month at a specific time and day Click Next. The following panels depend on the option selected:
Never
This option enables you to cancel a previously set schedule. Click Next to validate and access the confirmation panel wizard.
281

Version 8.6.53
Every hour
R e p o rt Sche d ule r W iza rd Ev e ry Ho ur Op tio n
Save the report in the following folder: Enter the path and name of the folder. Use this filename template: Indicate the path and folder where the report is to be saved and its filename. Available macros are listed under Macros of the Reference section. Using the given macros will enable you to have reports that are properly named with the hostname and time the reports are generated. Click Next to continue. The last step of the Configuration Report Scheduling Wizard confirms the specified settings. Click Finish to close the wizard.
Every day at a specific time

Indicate the time at which the report is to be generated.
282

Version 8.6.53
R e p o rt Sche d ule r W iza rd Ev e ry Da y a t a Sp e cific T im e Op tio n
Click Next. The Settings Panel is displayed to allow you to define the folder in which the file must be saved, the filename template you wish to use. Proceed with the appropriate settings and click Next to continue. The last step of the Configuration Report Scheduling Wizard confirms the specified settings. Click Finish to close the wizard.
Every week at a specific time and day

Select the time and the day(s) of the week on which the report is to be generated.
283

Version 8.6.53
R e p o rt Sche d ule r W iza rd Ev e ry W e e k a t a Sp e cific T im e a nd Da y Op tio n
Click Next. The Settings Panel is displayed to allow you to define the folder in which the file must be saved, the filename template you wish to use. Proceed with the appropriate settings and click Next to continue. The last step of the Configuration Report Scheduling Wizard confirms the specified settings. Click Finish to close the wizard.
Every month at a specific time and day

Indicate the day of each month and the time at which the report is to be generated.
R e p o rt Sche d ule r W iza rd Ev e ry M o nth a t a Sp e cific T im e a nd Da y Op tio n
Click Next. The Settings Panel is displayed to allow you to define the folder in which the file must be saved, the filename template you wish to use. Proceed with the appropriate settings and click Next to continue. The last step of the Report Scheduler Wizard confirms the specified settings. Click Finish to quit the wizard.
284

Version 8.6.53
Operator Day-to-Day Tasks

This section describes features that facilitate the daily tasks of the operator, such as, how to stop or restart an application, how to view file content or restart the scanning from the beginning of a file. It also describes the Acknowledge all and reset option that is available to the String search, SNMP traps, and Windows Events tools.
Acknowledge and Update

This is applicable to File Security instances. Right-click File Security icon > KM commands > Acknowledge alerts and update. This menu command allows you to acknowledge all alerts triggered on a File security monitoring object, and update the settings to conform with the recently made changes to the security settings (user access rights etc).
Acknowledge all and Reset

This is applicable to String searches, SNMP traps and Windows events instances. Right-click the object icon > KM commands > Acknowledge all and reset. This menu command allows you to acknowledge all alerts and reset the MatchingTrapCount or MatchingEventCount parameter to zero.
Acknowledge Alerts
This option is applicable to all application classes except for String searches, SNMP traps and Windows events instances for which a specific command Acknowledge Alerts and Reset can be used to acknowledge all alerts and reset parameters to zero. To acknowledge all alerts for a specific instance :
285

Version 8.6.53
1. Right-click the Object icon > KM Commands > Acknowledge Alerts...
A ck no wle d g ing A le rts
2. Monitoring Studio displays the name of the parameters for which an alert can be acknowledged. Click a parameter to select it and click OK. The selected parameter(s) will be deactivate and then reactivate. An acknowledging event will automatically be triggered.
No new data can be collected upon an alert acknowledgment.
Copy, Cut and Paste

Once you have configured one or several monitoring tools, you may need to copy or move them under a new container, or duplicate the String searches that you have setup on one command line execution on another one. This can be done easily with the Copy, Cut and Paste feature of Monitoring Studio: Copy or Cut any Monitoring Studio object and then Paste it in a new container. To access the Copy, Cut and Paste features, right-click the desired object > KM commands > Copy or Cut or Paste, depending on what you want to do.
286

Version 8.6.53
Cut/Co p y KM Co m m a nd s
Some objects cannot be pasted in other objects. F or ex ample, y ou cannot paste a String search object in/under a Process monitoring object. Basically , y ou can paste ev ery thing ev ery where that y ou would hav e been able to do with the regular wizards.
Delete a Monitored Object

Delete the monitoring of an object
Monitoring Studio allows you to delete any monitored object: right-click the object icon > KM commands > Delete. This removes the icon and all dependencies from your console and it signifies that the object is no longer monitored.
287

Version 8.6.53
Delete the monitoring of all objects

Monitoring Studio allows you to delete the monitoring of all objects under the main Monitoring Studio icon in one step. right-click the main Monitoring Studio icon > KM commands >Delete All.
Deletion of objects is irrev ersible. O nce y ou click on Delete/Delete all y ou cannot undo the action.
Temporarily suspend the monitoring of an object

This is applicable to all monitored instances. Right-click the object icon > Pause monitoring. In order to perform maintenance tasks, it is often useful to pause the monitoring (by Monitoring Studio) of an object: Right click the object icon > KM commands > Pause monitoring. When in a paused state, the object is still displayed in the PATROL Console but in an 'OFFLINE' status and no information is collected for that particular object. The monitoring of the object, however, can easily be restarted by selecting the Resume monitoring option in the menu.
Rename an Object
Monitoring Studio provides two ways for renaming objects. 1. Right-click on the object icon > KM commands > Edit and follow the wizard steps until you arrive at the last panel shown below:
288

Version 8.6.53
R e na m ing a n o bje ct
2.
Change the object label/display name, and click Finish. The object icon will now display the new label in the PATROL console. However, you cannot change the object ID through this method. To edit the object ID as well, you need to use the method shown below in step 2. Right-click on the object icon > KM commands > Rename. The Rename feature allows you to edit the object display name as well as the object ID. Click OK. A pop-up will ask you to confirm the change of the object ID:
M o d ify ing a n o bje ct ID
If you are certain that the new ID will not cause any problems, click Yes and the PATROL console will display the new label and will update the ID as well.
Restart Scan from the Beginning of the File

When looking for strings or numbers in a LOG file, the file content is scanned as new content is added. This means that the information that is in the file is only scanned once and then skipped over by the next polling. This option offers the possibility to restart the scanning from the beginning of the file. To do so: 1. 2. 3. Right-click the LOG File icon > KM commands > Restart scan from the Beginning of file. A message asks for confirmation. Click the Yes button to proceed. At the next polling, the entire file will be scanned.
O nce this option has been selected and confirmed, it cannot be canceled.
289

Version 8.6.53
Restart an Application
If Monitoring Studio warns you that the application you are monitoring is down, it is possible to relaunch the application by using the Application/Container icon> KM commands > Manage > Start the application command menu. This runs the command line entered in the "Start--Stop" option of New/Edit Application icon (container) wizard. If no starting command line is provided, the following message pops-up:
Ca nno t Sta rt the A p p lica tio n M e s s a g e
If the execution of the Start application command is confirmed, a window comes up with the output of the command being executed.
This option should be used by adv anced users only .
Stop an Application
It is possible to stop an application that you are monitoring by using the Application/Container icon> KM commands > Manage > Stop the application command menu. This runs the command line entered in the Start--Stop option of the New/Edit Application icons (container) wizard. If no stopping command line is provided, the following message pops-up:
290

Version 8.6.53
Sto p the A p p lica tio n Co nfirm a tio n M e s s a g e
If the execution of the Stop application command is confirmed, a window comes up with the output of the command being executed.
This option should be used by adv anced users only .
See Also
How to restart an application SW_APPLICATIONS SW_SENTRY
View the Content of a File

Monitoring Studio provides an easy way to check the content of a file that is being monitored. To see the files content, right-click the File monitoring icon > KM commands > View File content. You can also view the content of any monitored file by right-clicking the main Monitoring Studio icon > KM commands > Tools > File Viewer. In this case, you need to enter the details in field for the File path. The panel that opens offers you the options shown below:
291

Version 8.6.53
File Vie we r
When this panel first opens the File Content window displays the first 64 KB of the file. To view other sections of the file, you select the options and click Update. File path: This displays the path of the file you are currently viewing. You can also enter another file path and click Update to view another file. Show me: The first/last: X KB: You can select what part of the file you wish to view. Make your selection and click Update Only lines matching with (RegExp): Enter a regular expression and only the lines matching this regular expression are displayed in the File content field. File content: This is the where the content is displayed.
292
Examples

Version 8.6.53
This section shows two examples: one is about checking the availability of a website using the Command Line analysis tool, and the other illustrates the Alert Actions feature.
Alert Actions Example

In this example, we monitor a LOG file and look for the string "error" in the lines. Every time an "error" is found, we want to trigger a standard PATROL event containing the name of the parameter, that of the LOG file and the name of the application that triggered the alert. 1. Select the Set Alert Actions command from the menu to run the Alert Actions wizard as shown below.
Se tting a n A le rt A ctio n o n a String Se a rch Obje ct
294

Version 8.6.53
2.
This launches the wizard to set specific Alert Actions, as shown in the screenshot below.
Se le cting the M a tching Line Co unt Pa ra m e te r
3.
At this step, you want to run an Alert Action every time the matching line is found: Select the MatchingLineCount parameter from the list of parameters related to the String search Ensure that the thresholds for this parameter are set to 1 so that an alert is triggered every time a line containing the word "error" is found. Click Next to carry on with the Alert Actions wizard.
295

Version 8.6.53
Se le cting a n A le rt
4.
Select the type of action to be executed when the MatchingLineCount parameter goes into alert state: Check the Trigger a PATROL event box and click Next. Enter the message of the PATROL event: Name of the application ; Name of the log file ; The error message (i.e. the line in the LOG file that triggered the alert) Enter the text below in the box called Enter the text to be sent with the PATROL Event: Application %{APPLICATION_LABEL}: error found in %{PARENT_LABEL}.%{NEWLINE}Error message: %{MORE_INFORMATION} %{APPLICATION_LABEL} contains the application display name in the PATROL Console. %{PARENT_LABEL} contains the LOG file display name (it is the parent of the String search in the PATROL Console). %{NEWLINE} will create a new line in the message. %{MORE_INFORMATION} contains the entire line in the LOG file that triggered the alert.
Se tting the A le rt Pa ra m e te rs
5.
The text sent with the PATROL event will look like this: Application myApplication: error found in LOG File: /opt/myApplication/log/myApp*.log. Error message: [line content]
296

Version 8.6.53
6.
click the Next button to get to the final panel of the Alert Actions wizard that summarizes the Alert Actions set for the MatchingLineCount parameter.
Co nfirm ing a n A le rt A ctio n
In this example you set just one Alert Action, Trigger a PATROL Event, but it would have been possible to set several Alert Actions, such as an OS command that runs a recovery action for the monitored application or writes an annotation to the graph built by the MatchingLineCount parameter with the content of the matching line.
XML LOG File Parsing

Monitoring the content of an XML LOG file with Monitoring Studio
Specifying the file to monitor
1. Right-click the main Monitoring Studio icon or your previously-created application icon > KM Commands > New > File monitoring and analysis 2. Specify that file is a LOG file, i.e. that Monitoring Studio needs to monitor only the new lines that are being added to the file. 3. Specify the path to the file. You can use wildcards (* and ?) if the name of the file changes over time (like a time-stamped LOG file). In such case, Monitoring Studio monitors the most recently updated file which matches with the specified path. 4. Enter a label and ID for the icon which is going to be created in the PATROL Console. You have successfully setup the monitoring of an XML log file. Now to parse this file, you first need to preprocess the XML text in order to then run string searches or perform numeric value extraction on the result.
297

Version 8.6.53
Pre-processing the content of the file (converting XML to CSV)

Right-click the File object which has been created > KM Commands > New > Text PreProcessing Select the Convert XML to CSV option.
Se le cting a T y p e o f Co nv e rs io n to A p p ly to a Lo g File
In this example, the records in this XML LOG file are in the following format: <rec> <vm>su37sr72</vm> <ts>2003-09-22 11:47:35.511 CEST</ts> <level>ERROR</level> <class></class> <method></method> <ctx> <pid>A141607</pid> <appid>frontnet</appid> <cname>User_3_0.getDefaultUserRole</cname> <reqid>2</reqid> <sesid>1uEPHTdRG2mM6GCfhv1EkwcBrCi68ffGizgIEtGHWFMt5Hc7lwE7!-1625978434!-1455528670! 7501!7502!1064223951289</sesid> <thrid>ExecuteThread: '68' for queue: 'default'-f7c8b25c01</thrid> <cthid>ExecuteThread: '68' for queue: 'default'-f7c8b1696c</cthid>
298

Version 8.6.53
</ctx> <msg> <![CDATA[FNNotAuthorizedException;FEA002002;No authorization to execute service operation]]> </msg> <exc> <ts>2003-09-22 11:47:35.509 CEST</ts> <sev>ERROR</sev> <ctx> <pid>A141607</pid> <appid>frontnet</appid> <cname>User_3_0.getDefaultUserRole</cname> <reqid>2</reqid> <sesid>1uEPHTdRG2mM6GCfhv1EkwcBrCi68ffGizgIEtGHWFMt5Hc7lwE7!-1625978434!-1455528670! 7501!7502!1064223951289</sesid> <thrid>ExecuteThread: '68' for queue: 'default'-f7c8b25c01</thrid> <cthid>ExecuteThread: '68' for queue: 'default'-f7c8b1696c</cthid> </ctx> <stack> <![CDATA[com.csg.pb.frontnet.exec_arch.calx.FNNotAuthorizedException: No authorization to execute service operation at com.csg.pb.frontnet.services.user_3_0.bean.UserBean_3_0.getDefaultUserRole(UserBean_3_0. java:345) at com.csg.pb.frontnet.services.user_3_0.bean.UserBean_3_0_3c05dc_EOImpl.getDefaultUserRole (UserBean_3_0_3c05dc_EOImpl.java:145) at com.csg.pb.frontnet.services.user_3_0.bean.UserBean_3_0_3c05dc_EOImpl_WLSkel.invoke (Unknown Source) at weblogic.rmi.internal.BasicServerRef.invoke(BasicServerRef.java:360) at weblogic.rmi.cluster.ReplicaAwareServerRef.invoke(ReplicaAwareServerRef.java:93) at weblogic.rmi.internal.BasicServerRef.handleRequest(BasicServerRef.java:329) at weblogic.rmi.internal.BasicServerRef.dispatch(BasicServerRef.java:178) at weblogic.rmi.internal.ServerRequest.sendOneWayRaw(ServerRequest.java:92) at weblogic.rmi.internal.ServerRequest.sendReceive(ServerRequest.java:112) at weblogic.rmi.cluster.ReplicaAwareRemoteRef.invoke(ReplicaAwareRemoteRef.java:263) at weblogic.rmi.cluster.ReplicaAwareRemoteRef.invoke(ReplicaAwareRemoteRef.java:230) at weblogic.rmi.internal.ProxyStub.invoke(ProxyStub.java:35) at $Proxy1401.getDefaultUserRole(Unknown Source) at com.csg.pb.frontnet.services.user_3_0.bean.UserCA_3_0.getDefaultUserRole(UserCA_3_0.
299

Version 8.6.53
java:244) at com.csg.pb.frontnet.apps.common.brokers.FnUserBroker.getDefaultPortalUserSettings (FnUserBroker.java:56) at com.csg.pb.frontnet.apps.common.brokers.FnUserBroker.getDefaultMandant(FnUserBroker. java:280) at com.csg.pb.frontnet.apps.common.base.DefaultAuthorizationStrategy.resetBusinessUnitParam (DefaultAuthorizationStrategy.java:72) at com.csg.pb.frontnet.apps.common.base.DefaultAuthorizationStrategy.assertAvailableBusinessUnit (DefaultAuthorizationStrategy.java:48) at com.csg.pb.frontnet.apps.common.base.AuthorizationServlet.doGetManaged(AuthorizationServlet. java:99) at com.csg.cs.servlet.CSServlet.doGet(CSServlet.java:82) at javax.servlet.http.HttpServlet.service(HttpServlet.java:740) at com.csg.cs.servlet.CSServlet.service(CSServlet.java:459) at com.csg.pb.frontnet.util.servlet.FNServlet.service(FNServlet.java:334) at com.csg.pb.frontnet.apps.common.base.CommonServlet.service(CommonServlet.java:66) at javax.servlet.http.HttpServlet.service(HttpServlet.java:853) at weblogic.servlet.internal.ServletStubImpl.invokeServlet(ServletStubImpl.java:262) at weblogic.servlet.internal.TailFilter.doFilter(TailFilter.java:21) at weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:27) at com.csg.cs.security.wls.enforce.IntranetPLEnfFilter.doFilter(IntranetPLEnfFilter.java:174) at weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:27) at weblogic.servlet.internal.RequestDispatcherImpl.forward(RequestDispatcherImpl.java:287) at com.csg.pb.frontnet.apps.common.util.RequestForwarder.forward(RequestForwarder.java:48) at com.csg.pb.frontnet.apps.portals.base.PortalSelectionController.processSelectionPage (PortalSelectionController.java:49) at com.csg.pb.frontnet.apps.portals.base.PortalSelectionController.doGetManaged (PortalSelectionController.java:29) at com.csg.cs.servlet.CSServlet.doGet(CSServlet.java:82) at javax.servlet.http.HttpServlet.service(HttpServlet.java:740) at com.csg.cs.servlet.CSServlet.service(CSServlet.java:459) at com.csg.pb.frontnet.util.servlet.FNServlet.service(FNServlet.java:334) at javax.servlet.http.HttpServlet.service(HttpServlet.java:853) at weblogic.servlet.internal.ServletStubImpl.invokeServlet(ServletStubImpl.java:262) at weblogic.servlet.internal.TailFilter.doFilter(TailFilter.java:21) at weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:27) at com.csg.cs.security.wls.enforce.IntranetPLEnfFilter.doFilter(IntranetPLEnfFilter.java:174)
300

Version 8.6.53
at weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:27) at weblogic.servlet.internal.WebAppServletContext.invokeServlet(WebAppServletContext.java:2684) at weblogic.servlet.internal.ServletRequestImpl.execute(ServletRequestImpl.java:2412) at weblogic.kernel.ExecuteThread.execute(ExecuteThread.java:140) at weblogic.kernel.ExecuteThread.run(ExecuteThread.java:121) ]]> </stack> </exc> </rec> So, <REC> is the XML tag for each new record. Lets say that we would like to retrieve the <TS> value, the <LEVEL> value, the <CNAME> value under <CTX> and the <MSG> value. Therefore, we are specifying that REC is the XML tag for a new record and that we would like to include the value for the following properties and sub-tags:TS LEVEL CTX.CNAME MSG. Please note the syntax "CTX.CNAME" which means the value of CNAME under the CTX tag.
De fining the Co nv e rs io n Pa ra m e te rs
Then, specify a label and ID for the text pre-processing object that will be created under the file icon.
301

Version 8.6.53
De fining the Obje ct
As a result, we get a new icon in the PATROL Console, corresponding to the XML to CSV preprocessing:
A cce s s ing the R e s ult File
This object has a single TransformResult text parameter as a result of the XML to CSV pre-processing:
2003-09-22 11:47:35.511 CEST;ERROR;User_3_0.getDefaultUserRole; FNNotAuthorizedException; FEA002002;No authorization to execute service operation]]>; 2003-09-22 11:52:05.984 CEST;ERROR;User_3_0.getDefaultUserRole; FNNotAuthorizedException; FEA002002;No authorization to execute service operation]]>; 2003-09-22 12:06:18.272 CEST;ERROR;User_3_0.getDefaultUserRole; FNNotAuthorizedException; FEA002002;No authorization to execute service operation]]>; 2003-09-22 12:09:53.920 CEST;ERROR;User_3_0.getDefaultUserRole; FNNotAuthorizedException; FEA002002;No authorization to execute service operation]]>; 2003-09-22 12:10:39.557 CEST;ERROR;KycBeneficialOwnerProfiles;
302

Version 8.6.53
FNDBDataAccessFailureException;RDS001003;Code not Found - TableName: Landcode_1_RefTableObject, BusinessUnit: 0012, Language: 891, Code: 001]]>; 2003-09-22 12:10:39.566 CEST;ERROR;KycBeneficialOwnerProfiles; FNDBDataAccessFailureException;RDS001003;Code not Found - TableName: Landcode_1_RefTableObject, BusinessUnit: 0012, Language: 891, Code: 001]]>; 2003-09-22 12:10:56.637 CEST;ERROR;CIFS_Customer_1.getCustomer; FNDBDataAccessFailureException;RDS001002;Code not Found - TableName: Service_Status_InfoRefTableObject, BusinessUnit: 0000, Code: CIFS_Customer_1_0]]>; 2003-09-22 12:10:56.643 CEST;SEVERE;CIFS_Customer_1.getCustomer; FNServiceNotAvailableException;FEA000001;Service not available - Service FNServiceState.getState]] >; 2003-09-22 12:10:56.945 CEST;ERROR;BPST_UserProfile_3.getUsers; FNDBDataAccessFailureException;RDS001002;Code not Found - TableName: Service_Status_InfoRefTableObject, BusinessUnit: 0000, Code: BPST_UserProfile_3_0]]>; 2003-09-22 12:10:56.950 CEST;SEVERE;BPST_UserProfile_3.getUsers; FNServiceNotAvailableException;FEA000001;Service not available - Service FNServiceState.getState]] >; 2003-09-22 12:21:30.004 CEST;ERROR;User_3_0.getDefaultUserRole; FNNotAuthorizedException; FEA002002;No authorization to execute service operation]]>;
Searching for strings in the result of the XML-to-CSV pre-processing

Right-click the Text-Pre-Processing icon > KM Commands > New > String search Now, we are going to search for lines that contain the string "SEVERE" in the second column, corresponding to XML records whose <LEVEL> is "SEVERE".
303

Version 8.6.53
Pe rfo rm ing a String Se a rch Co m m a nd o n a Co nv e rte d File
We enter SEVERE in the field for the string to search for, and select the option in the following column number and enter 2. Then we click the column separator tab and uncheck all except the semicolon and click Accept. Finally, we click Next and follow the wizard steps as for any normal string search on a LOG file, keeping the default values shown. This brings us to the last panel, where we select the I want to use the default thresholds option.
304

Version 8.6.53
String Se a rch Co nfirm a tio n
As a result, we get the following String search object: SEVERE under the XML-to-CSV pre-processing object.
A cce s s ing the String Se a rch R e s ults
You can create as many string searches as y ou want on a file and on a tex t-processing object, and y ou can create sev eral different tex t-processing objects on the same file object.
305
Troubleshooting

Version 8.6.53
This section deals with troubleshooting. It tells you how to enable the debug mode and then states the most frequently asked questions based on issues encountered by customers.
Enabling the Debug Mode

By default, Monitoring Studio sends only the most critical information, such as warning and error messages to the System Output Window of the PATROL Consoles. Most often, this information is accurate enough to ensure that Monitoring Studio is properly working. If you encounter an issue, and want to report it to Sentry Software, you will be asked to enable the Debug Mode and provide the debug output to the Sentry Software support team.
Ena bling De bug M o d e
To enable the debug mode: 1. Right-click the main Monitoring Studio icon 2. Select KM commands> Options > Debug... 3. The panel show above pops-up. Check the Enable debug box. By default, Monitoring Studio will send its debug output to the System Output Window of the PATROL Consoles. When debugging the discovery process of Monitoring Studio at the starting time of the Agent, some debugging information may be lost by the PATROL Console, which is not yet connected to the PATROL
307

Version 8.6.53
Agent. In some other cases, such as when you want to trace the activity of Monitoring Studio for a few minutes, some debugging information may also be lost by the PATROL Console because its buffer is full. In these cases, it can be useful to send the debug output of Monitoring Studio to a specified file.
The debug file is stored on the computer where the A gent is running.
Pay attention to the file size! The debug output of Monitoring Studio may make the file v ery large after running for sev eral day s. Do not forget to turn off the debug mode once the necessary information is collected.
Enabling the Debug Mode
308
Reference Guide

Version 8.6.53
Introduction
This chapter gives you some additional information on Processes, WMI, Regular expression and Format symbols for macros.
About Processes
Whats a process
In practice, a process is basically a binary code being executed by processors. Processes are launched by the operating system (since the operating system controls the execution flow) and have several properties: PID (unique identifier of a process); Name; User ID; Command line that was used to launch the process (arguments passed to the binary); Environment; CPU and memory usage; Other various OS-specific properties.
How to identify a process

When you monitor an application, you typically want to check that the application's processes are running properly. The problem lies in how to identify the processes of this application, how to recognize them amongst all of the running processes. The only thing that really identifies a process is its PID (Process ID). But since the PID is an integer number randomly set upon the process startup, most often we cannot use it to identify the processes of an application (unless the application gives you its PID in a so-called PID file). In general, you recognize application processes by their name if this criterion is enough to distinguish them from other processes. If the name of the process is not sufficient, you can identify application processes by parsing the processs command lines. This is typically useful with scripts and java processes, whose process names are the same: java, CSCRIPT.EXE, etc.
Process name
Under Windows, the name of a process is basically the file name of the binary file which is being executed: Java.exe, IisAdmin.Exe. It always includes the ".EXE" extension. Process names can easily be shown in Windows Task Manager. Under UNIX, the process name could be either the file name of the binary being executed, including the path or not, or something completely different (e.g. Oracle processes).
The naming of processes is highly platform dependant. Linux processes are not named in the same way as on HP-UX serv ers, for ex ample. Under UNIX, process names can be shown by ex ecuting the "ps e o name" command line.
310

Version 8.6.53
Process command line

Every process is launched through a command line, which consists of the file path to the binary which has to be executed, and arguments that have to be passed to the binary: <path to the binary file> <argument1> <argument2> etc. If the directory of the binary file is in the PATH environment variable, the path may not be included in the command line: <binary file name> <argument1> <argument2> etc. This is the only way to distinguish Java processes and scripts from others, because their process names are all identical (Java.EXE). Unfortunately, in Windows, there is no easy way to see the command lines of the currently running processes. Under UNIX, processes command lines can be shown by executing the "ps e o comm" command.
Process user ID
On both Windows and UNIX systems, processes run "as" a user. Depending on this, the process may be allowed to access various system resources (files, network, databases, etc.). In secured environments, most applications processes have to run as a specific user to let them access the application resources. If the processes run as another user, the application is very likely to fail and not run properly. This is why it could be important to check that the processes of the application you want to monitor are running as the appropriate user.
PID file
A classic way for applications to indicate they are running is to write the PID of their process into a given file. In this case we only need to read this file and check whether the PID written in the file corresponds to a running process. Please note that not the PID file is not provided for all the applications and most Windows applications do not provide PIDs.
About WMI
Definition
Windows Management Instrumentation (WMI) is a set of specifications from Microsoft for consolidating the management of devices and applications in a network from Windows computing systems. WMI is the Microsoft implementation of Web Based Enterprise Management (WBEM), which is built on the Common Information Model (CIM), a computer industry standard for defining device and application characteristics so that system administrators and management programs can control devices and applications from multiple manufacturers or sources in the same way.
About Processes
311

Version 8.6.53
What does it do?

WMI provides users with information about the status of local or remote computer systems. It also supports such actions as the configuration of security settings, setting and changing system properties, setting and changing permissions for authorized users and user groups, assigning and changing drive labels, scheduling processes to run at specific times, backing up the object repository, and enabling or disabling error logging. You can use WMI to manage both local and remote computers. The word "Instrumentation" in WMI refers to the fact that WMI can get information about the internal state of computer systems, much like the dashboard instruments of cars can retrieve and display information about the state of the engine. WMI "instruments" by modeling objects such as disks, processes, or other objects found in Windows systems. These computer system objects are modeled using classes such as Win32_LogicalDisk or Win32_Process; as you might expect, the Win32_LogicalDisk class models the logical disks installed on a computer, and the Win32_Process class models any processes currently running on a computer. Classes are based on the extensible schema called the Common Information Model (CIM). The CIM schema is a public standard of the Distributed Management Task Force (http://www.dmtf.org/). WMI capabilities also include eventing, remoting, querying, views, user extensions to the schema, instrumentation, and more.
WMI Concepts
CIM Repository
CIM stands for Common Information Model and the repository is the WMI schema that stores the class definitions that model WMI-managed resources. The repository holds the information required to work with live resources in the computing environment. It does not contain actual data about these resources since this data is dynamically retrieved as required. It is this schema that allows the wide variety of different resources to be uniformly managed.
Namespace
CIM classes are organized into namespaces. Each namespace in the CIM contains a logical group of related classes representing a specific technology or area of management. Anytime a connection is made to WMI, a namespace must be specified. Only the classes contained within this namespace may be accessed by the connection. The most common namespace used for Windows management is root\cimv2. This contains the classes with the Win32_ prefix representing various components of the Windows operating system and hosting computer. Examples include Win32_Process (running processes in Windows), Win32_LogicalDisk (Windows logical disk drives), and Win32_ComputerSystem (the computer hosting Windows). The namespace also includes the CIM_DataFile class which can be used to monitor files and folders. The following table lists common namespaces.
Namespace
root\cimv2
Description
Contains the most useful classes including all Win32_ classes
About WMI
312

Version 8.6.53
root\default
Contains registry events
Class
Every resource managed by WMI is defined by a class. A class is a template for each type of resource and defines the properties that will be collected for that resource. Examples of common WMI classes are shown in the table below:.
Class
Win32_Process Win32_ComputerSystem CIM_DataFile
Description
Processes running on a Windows computer The computer running a Windows operating system A file stored on a disk
Instance
An Instance is a unique occurrence of a particular class. For example, each service installed on a Windows computer is an instance of the Win32_Service class. The C: drive is an instance of the Win32_LogicalDrive class.
Instance
Name DisplayName PathName StartMode State
Description
Winmgmt Windows Management Instrumentation C:\WINDOWS\system32\svchost.exe -k netsvcs Auto Running
Property
A property is unique piece of information about an instance. All instances of a class will have the same set of properties although the values each instances properties may differ. Sample Properties of the Win32_Service class are shown in the table below:
Property
Name DisplayName PathName StartMode State
Description
Unique name of the service. Displayed name of the service. The command line path that was executed to start the service. Startup type of the service (Auto, Manual, or Disabled) Current state of the service (Running, Stopping, or Stopped)
Basic WMI Queries

Queries may be issued against WMI resources using WMI Query Language (WQL). WQL is a subset of
About WMI
313

Version 8.6.53
SQL designed to retrieve information from WMI. A simple example of a WMI query would be: SELECT * FROM Win32_Process. This retrieves all attributes (the * is used as a wildcard) for all processes currently running on the computer. Win32_Process is the name of the WMI class for Windows processes. WMI queries of this type are often issued from a script using Windows Script Host or from any application or tool that can access WMI. Queries retrieve specific information from instances of WMI resources or execute methods against instances to perform such actions as stopping services, or starting processes.
Keyword
SELECT FROM WHERE
Example code
SELECT * FROM __InstanceCreationEvent WHERE TargetInstance ISA 'Win32_Process' AND TargetInstance. Name = 'notepad.exe'
Description
Specifies what properties are returned. Typically * is used to simply retrieve all. Specifies the event class to query. This will be the extrinsic or intrinsic event class. Filters the results. For intrinsic events, will usually include the ISA keyword to specify the class of the TargetInstance.
In case you need help to build your WMI query, you could download WMI CIM Studio which is one of the WMI Administrative tools on the Microsoft site.
Alert Action Macros

A macro is a variable whose value is replaced when an Alert Action is triggered. Macros can be used to customize the content of each Alert Action. For example: %{VALUE} is replaced by the actual current value of the parameter that triggered the alert. When used in the text field for a PATROL event Alert Action, the percentage value is replaced by the actual current value of the parameter that triggered the alert. Each macro listed in the tables below contains information about what triggered the PATROL alert. Some macros are "general" or "common" - these can be used for any object, and some are "objectspecific" macros that are specific to the object, such as databases or files or JMX applications etc.
General Macros
The macros given in the table below can be used on any object:
General Macros
%{PARAMETER_NAME} %{VALUE} %{ALARM_TYPE} %{OBJECT_ID}
Description
Name of the parameter that triggered the alert Value of the parameter that triggered the alert Type of the alert triggered (ALARM, WARN or INFORMATION) PATROL ID of the object triggering the alert
About WMI
314

Version 8.6.53
General Macros
%{OBJECT_LABEL} %{OBJECT_CLASS} %{OBJECT_TYPE} %{PARENT_<PARENT MACRO>}
Description
Display name of the object triggering the alert Class (".KM") of the object triggering the alert Type of the object triggering the alert ("Process", "String", etc.) Gets the parent's object of a macro. Example: In the case of String Search performed in Command Line, use the following macro to get complete command line return output: %{PARENT_OSCOMMAND_RETURN_OUTPUT} ID of the objects parent triggering the alert (the parent of a String object could be a LOG file, e.g.) Display name of the objects parent triggering the alert Class (".KM") of the objects parent triggering the alert Type of the objects parent triggering the alert ("File", "OSCommand", etc.) PATROL ID of the application triggering the alert Display name of the application triggering the alert Class (".KM") of the application triggering the alert Type of the application triggering the alert ("Application") Contact information in case of an application failure Description of the application List of files that identify the application as present
%{PARENT_ID} %{PARENT_LABEL} %{PARENT_CLASS} %{PARENT_TYPE} %{APPLICATION_ID} %{APPLICATION_LABEL} %{APPLICATION_CLASS} %{APPLICATION_TYPE} %{APPLICATION_CONTACT} % {APPLICATION_DESCRIPTION} % {APPLICATION_EXISTENCEFILE S} %{ASCTIME:}
Current time when the Alert Action is performed. Specify a formatting as described under Format Symbols in the Reference section. Example: %{TIME:%H:%M:%S} will be replaced by 09:45:17 at run time Inserts carriage return Recommended for advanced users only Provides an internal instance variable name to be inserted. The path is relative to the object triggering the alert. Example: %{/worstParam} will be contain the name of the worst parameter on this instance, which is an application instance built-in variable (see the "PATROL Script Language Reference" document).
%{NEWLINE} %{/...}
Object Specific Macros

Database Macros
%{DATABASE_TYPE} %{DATABASE_QUERY} %{DATABASE_NAME}
Description
Type of the database. SQL Server or Oracle SQL statement sent for execution Name of the database the SQL query is sent to. May be the database name for SQL Server, or the Oracle SID for Oracle.
Dynamic Object Macros

%{DYNAMIC_RETUNR_OUTPUT}
Description
Returns the output of the dynamic object
Alert Action Macros
315

Version 8.6.53
File Macros
%{FILE_CURRENT_NAME} %{FILE_NAME}
Description
Current file being monitored when monitoring a file whose name changes over time) Name of the monitored file as entered in the GUI
File System Macro

%{FILESYSTEM_NAME}
Description
Name of the monitored file system
Folder Macro
%{FOLDER_PATH} %{FOLDER_OLDEST_REMAINING_FILE}
Description
Folder being monitored Folder with the oldest remaining file
HTTP Macros
%{HTTP_RETURN_OUTPUT} %{HTTP_METHOD} %{HTTP_URL}
Description
Result of the HTTP request GET or POST depending on what was selected in the GUI URL being tested
JMX Macros
%{JMXPOLLING_SERVER_TYPE} %{JMXPOLLING_HOST} %{JMXPOLLING_PORT} %{JMXPOLLING_DOMAIN} %{JMXPOLLING_KEY_PROPERTY} %{JMXPOLLING_ATTRIBUTE} %{JMXPOLLING_CONTENT}
Description
Type of JMX server being polled Host name of JMX server polled Port number of the JMX server polled Domain of the JMX server polled Key property of the JMX server polled Attribute of the JMX server polled Content of the result output of the JMX server polled
KM Watch Macros
%{KMWATCH_CLASS} %{KMWATCH_ID} %{KMWATCH_PARAMETER}
Description
Class of the PATROL object being monitored Instance ID of the PATROL object being monitored Parameter name of the PATROL object being monitored
MPF Macros
%{MPF_CLASS} %{MPF_ID} %{MPF_FORMULA}
Description
Class of the PATROL object being monitored Instance ID of the PATROL object being monitored User-defined formula used to rescale the parameter value
OS Command Macro
%{OSCOMMAND_OSCOMMAND} %{OSCOMMAND_RETURN_OUTPUT}
Description
Command line being executed and analyzed Return output of the OS command
Alert Action Macros
316

Version 8.6.53
Process Macros
%{PROCESS_NAME} %{PROCESS_COMMAND_LINE} %{PROCESS_USER_ID} %{PROCESS_PID_FILE}
Description
Process name being searched for, as entered in the GUI Process command line being searched for, as entered in the GUI Process user ID being searched for, as entered in the GUI Path to the PID file whose corresponding process is being monitored
SNMP Polling Macros

%{SNMPPOLLING_OID} %{SNMPPOLLING_HOST} %{SNMPPOLLING_COMMUNITY} %{SNMPPOLLING_PORT} %{SNMPPOLLING_CONTENT}
Description
SNMP OID being polled SNMP Agents host name being polled SNMP community string being used to query the SNMP agent UDP port being used to poll the SNMP agent. 161 by default Value of the OID being polled
SNMP Trap Macros

%{SNMPTRAP_IP} %{SNMPTRAP_FOUNDIP} %{SNMPTRAP_COMMUNITY} %{SNMPTRAP_ENTERPRISEID} %{SNMPTRAP_TRAPNUMBER} %{SNMPTRAP_FOUNDTRAPNUMBER} %{SNMPTRAP_CONTENT}
Description
Originating IP Address of the SNMP traps being looked for Actual originating IP address of the trap that has been received SNMP community string of the SNMP traps being looked for Enterprise ID (OID) of the SNMP traps being looked for SNMP Trap numbers (specific numbers) being looked for Actual SNMP trap number that has been received and matches the entered criteria Content of the found trap
String search Macros

%{STRING_SEARCHED_1} %{STRING_SEARCHED_2} %{STRING_LAST_MATCHING_LINE}
Description
First regular expression being searched for Second regular expressions being searched for Last line that match with the String search criteria
WMI Macros
%{WMI_HOST} %{WMI_NAME_SPACE} %{WMI_QUERY} %{WMI_USERNAME} %{WMI_RETURN_OUTPUT}
Description
Name of host where the WMI query is being run Namespace of the WMI query WMI statement sent for execution WMI execution username Content of the result output of the WMI query
Alert Action Macros
317

Version 8.6.53
WBEM Macros
%{WBEM_HOST} %{WBEM_NAME_SPACE} %{WBEM_QUERY} %{WBEM_USERNAME} %{WBEM_RETURN_OUTPUT}
Description
Name of host where the WBEM query is being run Namespace of the WBEM query WBEM statement sent for execution WBEM execution username Content of the result output of the WBEM query
Windows Event Macros

%{NTEVENT_LOG} %{NTEVENT_SOURCE} %{NTEVENT_ID} %{NTEVENT_LAST_MATCHING} %{NTEVENT_LAST_MATCHING_CONTENT}
Description
Name of the Windows event log being monitored Windows Event source whose new entries are monitored ID of the Windows events being searched for Last matching event found Content of the NT event
Windows Performance Macros

%{PERFORMANCE_INSTANCELIST} %{PERFORMANCE_COUNTER} %{PERFORMANCE_PERFORMANCE}
Description
Windows performance object instances being monitored Windows performance counter being monitored Windows performance object name being monitored
Windows Service Macros

%{SERVICE_NAME}
Description
Name of the service of an NT service class
Format Symbols for %{ASCTIME:} Macros

The following table recapitulates all of the time formats available in the %{TIME:}, %{ASCTIME:} and %{LASTTIME:} macros in the Command Line execution wizard, the File monitoring and analysis wizard, and the Alert Actions wizard.
Format
%% %a %A %b %B %c
Description
This symbol allows you to use a percent sign (%) in the format of a date string Locale's abbreviated name of the day of week Locale's full name of the day of week Locale's abbreviated name of the month Locale's full name of the month Locale's appropriate date and time representation
Alert Action Macros
318

Version 8.6.53
%C %d %D %e %h %H %I %j %k %l %m %M %n %p %r %R %S %t %T %u %U %V
Data and time as %c Day of month [1,31]; single digits are preceded by 0 Date as %m/%d/%y Day of month [1,31]; single digits are preceded by a space Locale's abbreviated name of the month Hour (24-hour clock) [0,23]; single digits are preceded by 0 Hour (12-hour clock) [1,12]; single digits are preceded by 0 Day of year [1,366]; single digits are preceded by 0 Hour (24-hour clock) [0,23]; single digits are preceded by a space Hour (12-hour clock) [1,12]; single digits are preceded by a space Month as a decimal number [1,12]; single digits are preceded by 0 Minute [0,59]; leading zero is permitted but not required Insert a new line Locale's equivalent of either a.m. Or p.m. Appropriate time representation in 12-hour clock format with %p Time as %H:%M Seconds [0,61] Insert a tab Time as %H:%M:%S Day of week as a decimal number [1,7], with 1 representing Monday Week of the year as a decimal number [0,53], with Sunday as the first day of week 1 Week of the year as a decimal number [01,53], with Monday as the first day of the week If the week containing 1 January has four or more days in the new year, then it is considered week 1; otherwise, it is week 53 of the previous year, and the next week, is, week 1. Day of week as a decimal number [0,6], with 0 representing Sunday Week of the year as a decimal number [0,53], with Monday as the first day of week 1 Locale's appropriate date representation Locale's appropriate time representation Year within century [0,99] Year, including the century (for example 1993) Abbreviated or full name of time zone, or no bytes if no information of the time zone exists Locale's alternative appropriate date and time representation Name of the base year (period) in the locale's alternative representation Locale's alternative date representation Locale's alternative time representation Offset from %EC (year only) in the locale's alternative representation Alternative representation of the year in full Day of the month using the locale's alternative numeric symbols
%w %W %x %X %y %Y %Z %Ec %EC %Ex %EX %Ey %EY %Od
319

Version 8.6.53
%Oe %OH %OI %Om %OM %OS %OU %Ow %OW %Oy
Same as %Od Hour (24-hour clock) using the locale's alternative numeric symbols Hour (12-hour clock) using the locale's alternative numeric symbols Month using the locale's alternative numeric symbols Minutes using the locale's alternative numeric symbols Seconds using the locale's alternative numeric symbols Week of the year (Sunday as the first day of the week) using the locale's alternative numeric symbols Day of week (Sunday=0) using the locale's alternative numeric symbols Week of the year (Monday as the first day of the week) using the locale's alternative numeric symbols Year (offset from %C) in the locale's alternative representation and using the locale's alternative numeric symbols
Regular Expressions
Regular expressions are used in Monitoring Studio to define strings to be searched for. A regular expression is: A string formatted with a specific syntax. It is intended to select some lines in a text, which will match the regular expression. Regular expressions are commonly used in pattern matching, and especially on UNIX systems with the grep, awk and sed commands. You can use regular expressions in Monitoring Studio in order to: Find a process Search for strings in a file Check a web page Parse a table in a database Retrieve numbers, etc. The following table describes the regular expression syntax that is supported in Monitoring Studio.
Character
. (dot)
Meaning
Match any single character Example: Err.. will match Err01, Err02 or ErrAB, etc. Match any character in the brackets Example: Err[123] will match Err1, Err2 or Err3 [Ee]rror will match either error or Error Match any character not in the brackets Example: Err[^12345] will match Err0, Err6, Err7, etc. but not Err1 Match any character in the range in the brackets Example: Err[0-9] will match Err0, Err1, etc. and Err9 Err[A-Z][0-9] will match ErrA0, ErrA1, ErrS9, ErrZ0, etc. but not Err1A Err[A-Z0-9] will match ErrA0, ErrA1, etc. and Err1A
[xyz]
[^xyz]
[a-z]
320

Version 8.6.53
[^a-z]
Match any character not in the range in the brackets Example: Application[^0-9] will match ApplicationA, ApplicationB, Application! but not Application1 Match zero or more repetitions of the preceding Example: Err[0-9A-F]* will match Err, Err0, ErrA, Err11, ErrBF0001, etc. Error.*ApplicationABC will match all lines that contains Error and ApplicationABC further (Critical Error 0x000295F0 on ApplicationABC) Match one or more repetitions of the preceding Example: Err[0-9A-F]+ will match Err0, ErrA, Err11, ErrBF0001, etc. but not Err Match the beginning of the line Example: ^Err will match all lines that begin with Err Match the end of the line Example: [0-9]+ connections$ will match all lines that end with xxx connections where xxx is an integer Match the beginning of a word Example: \<set will match any line that contains a word that begins with set. It will not match a line that only contains the word unset Match the end of a word Example: [Aa]pplication\> will match all lines that contain the word Application or application but not ApplicationAA
\<
\>
$expression\ Defines an expression which has to be processed as a unit regarding the modifier *, + and \| ) Example: \(_[a-zA-Z0-9]$+ will match only sequences like _patrol, _patrol_agent, _patrol_console, etc. exprA\| exprB \ Match either exprA or exprB Example: $firewall$\|$antivirus$ will match all lines that contains either the word firewall or the word antivirus Avoid the meaning of the following character Example: \. will match the single character dot (.) C:\\Program Files will match C:\Program Files
Application Classes
This section lists the 22 application classes of Monitoring Studio KM for PATROL with details on the parameters discovered and the menu commands available for each application class.
List of Application Classes

There are 28 application classes in Monitoring Studio KM for PATROL. If the KM is properly loaded, the following classes should be loaded on the monitored system and console:
Application Class
SW_APPLICATIONS SW_DB_QUERIES
Description
Monitors application/container icons Executes and monitors database queries
Regular Expressions
321

Version 8.6.53
SW_DYNAMIC SW_DYNAMIC_CONTAINER SW_DYNAMIC_DISCOVERY SW_DYNAMIC_NUMBERS SW_DYNAMIC_STRING SW_FILES SW_FILE_SECURITY SW_FILESYSTEMS SW_FOLDERS SW_HTTP_REQUESTS SW_HTTP_WEBFARM SW_JMX SW_KMWATCH SW_NTEVENTS SW_NTPERFORMANCE SW_NTSERVICES SW_NT_WMI SW_NUMBERS SW_OSCOMMANDS SW_PROCESSES SW_SENTRY SW_SNMP_POLLING SW_SNMP_TRAPS SW_STRINGS SW_TRANSFORM SW_WBEM
Executes Dynamic Items Creates a Dynamic Object Container Creates a Dynamic Object Builder Performs dynamic numeric value extractions Executes dynamic string searches Monitors files and file content Monitors file security Monitors file-systems Monitors folders Monitors web-based applications and executes HTTP requests Monitors web farms Polls and monitors JMX-enabled application servers Monitors parameters of other KMs Monitors Windows Event Logs Monitors Windows Performance counters Monitors Windows Services Executes and monitors WMI queries Performs numeric value extractions Executes, monitors and parses command lines and scripts Monitors processes Main application class Polls and monitors SNMP devices Monitors and listens for SNMP traps Executes string searches Transforms complex (multi-line, HTML, XML) text to enable string/numeric value searches Executes and monitors WBEM queries
Application Classes
322

Version 8.6.53
SW_APPLICATIONS
You can create SW_APPLICATIONS instances (application/container icons) through the New > Application icon (container) Menu Command of the Monitoring Studio icon. SW_APPLICATIONS instances are used to group different monitoring tools configured to monitor a given application, device, or any other IT component. SW_APPLICATIONS instances may contain other SW_APPLICATIONS instances (containers and sub-containers).
Parameters
None.
Infobox
Name
ID Parent ID Application ID First required file Second required file Third required file Fourth required file Constant 1 Constant 2 Constant 3 Constant 4 Constant 5 Contact Description Start command line Stop command line
Description
PATROL internal identifier of the application/container icon PATROL internal identifier of the parent icon PATROL internal identifier of the root parent icon File whose presence is required to activate the monitoring of this application/ container File whose presence is required to activate the monitoring of this application/ container File whose presence is required to activate the monitoring of this application/ container File whose presence is required to activate the monitoring of this application/ container Name of the first application constant Name of the second application constant Name of the third application constant Name of the fourth application constant Name of the fifth application constant Name or contact information of the person in charge of the application Description of the application Displays the command line that will be used to start the application by the "Manage > Start the application" Menu Command Displays the command line that will be used to stop the application by the "Manage > Stop the application" Menu Command
Application Classes
323

Version 8.6.53
Menu Commands
Menu Command
New > Process monitoring New> Windows Service monitoring New > File monitoring and analysis New > Folder monitoring New > File System monitoring New > Command line analysis New > Database Query analysis New> Java MBean Polling New> WMI Query analysis New > Web Request analysis New > Web-farm monitoring New > SNMP polling New > SNMP Trap listening New > Windows Event monitoring New > Windows Performance monitoring New > KM Watch New > Sub-container Edit Modify Application constants Set Polling Interval Set Global Alert Actions Display Object Configuration Cut Copy Paste Delete Rename Manage > Start Application Manage > Stop Application Export configuration
Description
Adds a Process monitoring using the New Process wizard Adds a Windows Service monitoring using the New Windows Service wizard (only available on Windows servers) Adds a File monitoring using the New File wizard Adds a Folder monitoring using the New Folder wizard Adds a File System monitoring using the File System wizard Adds an OS Command monitoring using the New OS Command wizard Adds a Database Query analysis using the New Database Request wizard. Adds a JMX polling using the Java MBean polling wizard Adds a WMI Query analysis using the new WMI query wizard. Adds an HTTP Request analysis using the New HTTP Request wizard Adds a Web-farm monitoring using the New web-farm wizard Adds an SNMP polling monitoring using the New SNMP polling wizard Adds an SNMP polling monitoring using the New SNMP Trap wizard Adds a Windows Event monitoring using the New Windows Event wizard (only available on Windows servers) Adds a Windows Performance counter monitoring using the New Windows Performance wizard (only available on Windows servers) Adds another KM parameter monitoring using the New KM Watch wizard Starts the new sub-container icon wizard Allows you to edit the Application monitoring Modifies the application constants Sets the polling interval Allows you to add Alert Actions that will be used for the application as well as its dependent objects Displays the Monitoring Studio configuration report of this Database Query instances and all dependent instances Cuts this application/container object Copies this application/container object Pastes a previously copied or cut object into this application/container Deletes the application monitoring and all its dependent objects Allows you to rename this application monitoring Allows you to start the application using the Start command line. Allows you to stop the application using the Stop command line. Allows you to export the configuration of this application/container along with all of its dependent objects
Application Classes
324

Version 8.6.53
Menu Command
Pause monitoring Resume monitoring
Description
Allows you to pause the monitoring of the application as well as all its dependent objects Allows you to resume the monitoring of the application as well as all its dependent objects after it has been paused
Application Classes
325

Version 8.6.53
SW_DB_QUERIES
Parameters
Name
ConnectionStatus
Description
State of the server connection Unit: 0 = OK, 1 = ALARM Value set by DbQueryColl every 2 minutes
QueryStatus
Displays whether or not the query was successfully executed Unit: 0 = OK, 1 =ALARM Value set by DbQueryColl every 2 minutes
ReturnOutput
Displays the output of the Database query execution Unit: N/A Value set by DbQueryColl every 2 minutes
ExecutionTime
Displays the SQL query execution time Unit: second(s) Value set by DbQueryColl every 2 minutes
DbQueryColl
Database Request collector Executes the SQL query Default polling interval: 2 minutes
Infobox
Name
ID Parent ID Application ID Database Type Connection Type Hostname Database name Connect as SQL Query
Description
PATROL internal identifier of the Database query analysis PATROL internal identifier of the parent application PATROL internal identifier of the Database querys root application Displays the Database type Displays the connection type Display the name of the host machine Displays the database name Login used to connect to the database server Displays the SQL query that will be executed
Menu Commands
Menu Command
New > String search
Description
Creates a new String search for this Database Query analysis
Application Classes
326

Version 8.6.53
Menu Command
New > Numeric value extraction New > Text Pre-Processing New > Dynamic Object Builder Edit Set Thresholds Set Polling Interval Set Alert actions
Description
Creates a new Numeric Value extraction for this Database Query analysis Creates a new Text pre-processing for this Database Query analysis Creates a new Dynamic Object Builder for this Database Query analysis Edits the Database Query monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this Database Query analysis monitoring Adds specific Alert Actions to the Database Query analysis monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this Database Query object and all dependent objects Cut Copy Paste Delete Rename Pause monitoring Resume monitoring Refresh parameters Cuts this object Copies this object Pastes a previously copied or cut Database Query analysis object Deletes the Database Query analysis monitoring and all its dependent objects Allows you to rename this Database Query analysis monitoring Pauses the monitoring of this Database Query analysis object Resumes the monitoring of this Database Query analysis object Refreshes all instance parameters of the Database Query analysis monitoring
Application Classes
327

Version 8.6.53
SW_DYNAMIC
Parameters
Name
Status
Description
Instance missing status Unit: 0 = Present, 1 = Missing Default pooling interval: 1 minute
ExtractedLine
Displays the output of the dynamic object
Infobox
Name
ID
Description
Dynamic object ID
Application Classes
328

Version 8.6.53
SW_DYNAMIC_CONTAINER
Parameters
None.
Infobox
Name
ID Parent ID Application ID
Description
Dynamic container ID PATROL internal identifier of the KM command to which dynamics objects are linked PATROL internal identifier of the root parent icon
Application Classes
329

Version 8.6.53
SW_DYNAMIC_DISCOVERY
Parameters
None.
Infobox
Name
ID Parent ID Type Dynamic Object Display Name Dynamic Object ID Column Separator Include Object Matching Exclude Object Matching Alarm on Missing Objects
Description
Dynamic discovery ID PATROL internal identifier of the parent application Dynamic object type Defines how dynamic object labels are generated Defines how dynamic object IDs are generated Defines symbols used to separate columns in the dynamic parent output file Keeps only lines matching a user-defined regular expression from the dynamic parent output file Discard lines matching a user-defined regular expression from the dynamic parent output file States the user-defined settings for alarm triggering on missing objects
Menu Commands
Menu Command
New > String search New > Numeric value extraction Edit Set Alert actions Display Object Configuration Cut Copy Paste Delete
Description
Creates a new String search for this File Creates a new Numeric Value extraction for this File Edits the File monitoring settings Adds specific Alert Actions to the File monitoring Displays the Monitoring Studio configuration report of this File monitoring object and all dependent objects Cuts this object Copies this object Pastes a previously copied or cut File monitoring object Deletes the File monitoring and all its dependent objects
Application Classes
330

Version 8.6.53
SW_DYNAMIC_NUMBERS
Parameters
Name
ValueFound Value
Description
States if a numeric valued has been found Value of the searched Numeric Value (no value will be given if no number is found) Value set by the collector of the parents object
Infobox
Name
ID Parent ID Line Mode Column Mode Parameter Type Line numerics Regular Expression Skip blank lines After/Before Specified String Character Offset Field numeric Field Separators
Description
PATROL internal identifier of the numeric extraction PATROL internal identifier of the numeric extractions parent Method used to select lines to search for the numeric Method chosen to search and extraction the number in the line Type of the parameter Line numbers in which the numeric will be extracted from Regular expression used to select the lines where the number will be searched for Indicates whether or not blank lines are skipped when searching for the numeric Searches for the numeric either after or before the specified string Searches for the number before or after this specified string Character offset where the number is searched for Numeric of the field in which the numeric will be searched for Characters that separates the fields in a text line
Application Classes
331

Version 8.6.53
SW_DYNAMIC_STRINGS
Parameters
Name
MatchingLineCount
Description
Indicate if a matching string has been found Value set by the collector of the parent object
Infobox
Name
ID Parent ID Type Lines Run Alert Actions
Description
PATROL internal identifier of the Dynamic String search PATROL internal identifier of the Dynamic String searchs parent Dynamic String type Lines that are searched When Alert Actions have to be executed
Application Classes
332

Version 8.6.53
SW_FILES
Parameters
Name
GrowthPercentage
Description
File growth percentage Unit: Percent per minute (%/min) Value set by fileColl
FileColl
Collects information about the file Default polling interval: 2 minutes
GrowthSpeed
File growth speed Unit: Kilobytes per minute (KB/min) Value set by fileColl
Size
File size Unit: Kilobytes (KB) Value set by fileColl
LastChanged
Elapsed time since the file was modified Unit: Minutes (min) Value set by fileColl
Exists
Determines whether the file exists or not Unit: 0 = Exists, 1 = Does not exist Value set by fileColl
Infobox
Name
ID Parent ID Application ID File name & path Monitored parameters Scan mode Monitored file
Description
PATROL internal identifier of the File monitoring PATROL internal identifier of Files parent PATROL internal identifier of the Files root application. File name and path (with wildcards) List of parameters that are currently being used for the File monitoring File scan mode (either "From start" or "From last position") File name path of the file currently being monitored
Menu Commands
Menu Command Description
Application Classes
333

Version 8.6.53
New > String search New > Numeric value extraction New > Text Pre-Processing New > File security check New > Dynamic Object Builder Edit Set Thresholds Set Polling Interval Set Alert actions Display Object Configuration Cut Copy Paste Delete Rename View file content Restart scan from start of file Pause monitoring Resume monitoring Refresh parameters
Creates a new String search for this File Creates a new Numeric Value extraction for this File Creates a new Text pre-processing for this File Creates a new File security monitoring for the current File Creates a new Dynamic Object Builder for the current file Edits the File monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this File monitoring Adds specific Alert Actions to the File monitoring Displays the Monitoring Studio configuration report of this File monitoring object and all dependent objects Cuts this object Copies this object Pastes a previously copied or cut File monitoring object Deletes the File monitoring and all its dependent objects Allows you to rename this File monitoring Displays the File content If a String, Numeric value search is performed for this File, restart the File scan from the Beginning of the File (only relevant to "LOG" Files) Pauses the File monitoring Resumes the File monitoring as well as all its dependent objects Refreshes all instance parameters of the SW_FILES class
Application Classes
334

Version 8.6.53
SW_FILE_SECURITY
Parameters
Name
fileSecurityColl
Description
Collects the security information about the monitored file Default polling: 2 minutes
AccessRightsCheck
Files access right status. Unit: 0 = OK, 1 = Files access rights have changed Value set by fileSecurityColl every 2 minutes
Integrity
Files integrity status (i.e. no changes made to the content) Unit: 0 = OK, 1 = File content has changed Value set by fileSecurityColl every 2 minutes
GroupCheck
Files group status. Unit: 0 = OK, 1 = Files group has changed Value set by fileSecurityColl every 2 minutes
OwnerCheck
Files owner status. Unit: 0 = OK, 1 = Files owner has changed Value set by fileSecurityColl every 2 minutes
Infobox
Name
Description
PATROL internal identifier of the File security check PATROL internal identifier of the File security checks parent PATROL internal identifier of the File security checks root application
Menu Commands
Menu Command
Edit Set Polling Interval Set Alert Actions Display Object Configuration Cut Copy Delete
Description
Edits the File security monitoring settings Sets the polling interval for this File monitoring Adds specific Alert Actions to the File security monitoring Displays the Monitoring Studio configuration report of this File security monitoring object and all dependent objects Cuts this File security monitoring object. Copies this File security monitoring object Deletes the File security monitoring and all its dependent objects
Application Classes
335

Version 8.6.53
Menu Command
Rename Acknowledge and Update Pause monitoring Resume monitoring Refresh parameters
Description
Renames this File security monitoring Acknowledges all the alerts on this File security object and updates its settings to reflect any security changes made Pauses the File security monitoring Resumes the File security monitoring Refreshes all instance parameters of the SW_FILE_SECURITY application class
Application Classes
336

Version 8.6.53
SW_FILESYSTEMS
Parameters
Name
UsedSpaceGrowthPercentage
Description
How fast the file system is getting filled in, in percentage of its size Unit: Percentage per hour (%/h) Value set by FileSystemColl every 2 minutes
UsedSpaceGrowthSpeed
How fast the file system is getting filled in Unit: Megabytes per hour (MB/h) Value set by FileSystemColl every 2 minutes
FreeSpacePercent
File system free space left in percentage. Unit: Percent (%) Value set by FileSystemColl every 2 minutes
FreeMegabytes
File system free space left in megabytes. Unit: Megabytes (MB) Value set by FileSystemColl every 2 minutes
Infobox
Name
ID Parent ID Application ID File system object
Description
PATROL internal identifier of the File systems monitoring PATROL internal identifier of File systems parent PATROL internal identifier of the File systems root application File System object monitored
Menu Commands
Menu Command
Edit Set Thresholds Set Polling Interval Set Alert Actions Display Object Configuration Cut Copy Delete
Description
Edits the File system monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this File systems monitoring Adds specific Alert Actions to the File systems monitoring Displays the configuration report of this File system object and all dependent objects Cuts this File system monitoring object Copies this File system monitoring object Deletes the File systems monitoring and all its dependent objects
Application Classes
337

Version 8.6.53
Rename Pause monitoring Resume monitoring Refresh parameters
Allows you to rename this File systems monitoring Pauses the File systems monitoring Resumes the File systems monitoring Refreshes all instance parameters of the SW_FILESYSTEMS application class
Application Classes
338

Version 8.6.53
SW_FOLDERS
Parameters
Name
GrowthPercentage
Description
Displays the percentage of the folder size growth per minute Unit: Percent per minute (%/min) Value set by FolderColl
LastModifiedFileElapsedTime
Displays the elapsed time since the last modification of any file in this folder Unit: Minute(s) (min) Value set by FolderColl
OldestModifiedFileElapsedTim e
Displays the elapsed time since the oldest modification of any file in this folder or subfolder Unit: Minute(s) (min) Value set by FolderColl
FolderColl
Folder collector. Default polling interval: 2 minutes
FileCount
Displays the number of files in a folder. If the option "Include sub-folders" is selected, the number of files is the sum of the number of files of every sub- folders and the main folder Unit: file(s) Value set by FolderColl
NewFileCount
Displays the number of new files per minute Unit: Displays the number of new files per minute Value set by FolderColl
DeletedFileCount
Displays the number of deleted files per minute Unit: File(s) per minute (File(s)/min) Value set by FolderColl
ModifiedFileCount
Displays the number of modified files per minute Unit: File(s) per minute (File(s)/min) Value set by FolderColl
GrowthSpeed
Displays the folder size growth per minute Unit: Kilobyte(s) per minute (KB/min) Value set by FolderColl
FolderSize
Displays the folder size (include sub-folders) in MB Unit: Megabyte(s) (MB) Value set by FolderColl
Application Classes
339

Version 8.6.53
Name
LongestTimeFileRemainsInFol der
Description
Displays the longest time an existing file has been placed in the folder. Unit: Minutes (min)
Infobox
Name
ID Parent ID Application ID Folder Include subfolders
Description
PATROL internal identifier of the Folder monitoring PATROL internal identifier of the Folders parent PATROL internal identifier of the Folders root application Path of the monitored folder Displays whether subfolders are monitored or not
Menu Commands
Menu Command
Edit Set Thresholds Set Polling interval Set Alert Actions Display Object Configuration Cut Copy Delete Rename Pause monitoring Resume monitoring Refresh parameters
Description
Edits the Folder monitoring settings. Allows you to set or edit the thresholds Sets the polling interval for this Folder monitoring Adds specific Alert Actions to the Folder monitoring Displays the Monitoring Studio configuration report of this Folder monitoring object and all dependent objects Cuts this Folder monitoring object. Copies this Folder monitoring object Deletes the Folder monitoring Renames the Folder monitoring Pauses the Folder monitoring Resumes the Folder monitoring Refreshes all instance parameters of the SW_FOLDERS class
Application Classes
340

Version 8.6.53
SW_HTTP_REQUESTS
Parameters
Name
httpRequestColl
Description
HTTP Request collector Default polling interval: 2 minutes
ReturnOutput ExecutionTime
Displays the returned output of the HTTP Request execution. Time taken by the HTTP request to execute Unit: Seconds(s) Value set by httpRequestColl
ServerConnectionState
State of the connection to the server Unit: 0 = OK, 1 = ALARM Value set by httpRequestColl
HTTPStatusCode
HTTP Response Status code Unit: 200=OK, 404 = Error Value set by httpRequestColl
Status
HTTP Request status. Unit: 0 = OK, 1 = WARNING, 2 = ALARM Value set by httpRequestColl
Infobox
Name
ID Parent ID Application ID Used HTTP method
Description
PATROL internal identifier of the HTTP Request analysis PATROL internal identifier of the HTTP Requests parent PATROL internal identifier of the HTTP Requests root application HTTP method that is used for this HTTP Request analysis
Menu Commands
Menu Command
New > String search New > Numeric value extraction
Description
Creates a new String search for this Web Request Creates a new Numeric Value extraction for this Web Request
Application Classes
341

Version 8.6.53
Menu Command
New > Text Pre-Processing New > Dynamic Object Builder Edit Set Thresholds Set Polling interval Set Alert Actions Display Object Configuration Cut Copy Paste Delete Rename Pause monitoring Resume monitoring Refresh parameters
Description
Creates a new Text pre-processing for this Web Request Creates a new Dynamic Object Builder for this Web Request Edits the Web Request analysis settings. Allows you to set or edit the thresholds Sets the polling interval for this Web Request monitoring object Adds specific Alert Actions to the Web Request analysis Displays the Monitoring Studio configuration report of this Web request object and all dependent objects Cuts this Web request object Copies this Web request object Pastes a previously copied or cut String search or Numeric Value search object Deletes the Web Request analysis and all its dependent objects Renames the Web Request monitoring object Pauses the Web Request analysis as well as all its dependent objects Resumes the Web Request analysis as well as all its dependent objects Refreshes all parameters of this Web request object
Application Classes
342

Version 8.6.53
SW_HTTP_WEBFARM
Parameters
Name
OperationalServerPercent
Description
Number of servers that are operational Unit: Server(s) Value set by httpWebFarmColl
OperationServerCount
Percentage of operational servers Unit: Percent (%) Value set by httpWebFarmColl
httpWebFarmColl
HTTP Web-farm collector Polling interval: 1 minute
Infobox
Name
Description
PATROL internal identifier of the Web-farm monitoring PATROL internal identifier of the Web-farm monitorings parent PATROL internal identifier of the Web-farm monitorings root application
Menu Commands
Menu Command
New > String search New > Numeric value extraction New > Text Pre-Processing Edit Add hosts Set Alert actions Display Object Configuration Cut Copy Paste Delete Rename
Description
Creates a new String search for this Web-farm monitoring Creates a new Numeric Value extraction for this Web-farm monitoring Creates a new Text pre-processing for this Web-farm monitoring Edits the Web-farm monitoring settings Adds new hosts to the Web-farm monitoring. A new Web request monitoring will be created for each host added Adds specific Alert Actions to the Web-farm monitoring Displays the Monitoring Studio configuration report of this Web-farm monitoring object and all dependent objects Cuts this Web farm monitoring object Copies this Web farm monitoring object Pastes a previously copied or cut Web request monitoring object Deletes the Web-farm monitoring and all its dependent objects Renames the Web-farm monitoring object
Application Classes
343

Version 8.6.53
Menu Command
Pause monitoring Resume monitoring Refresh parameters
Description
Pauses the Web-farm monitoring as well as all its dependent objects Resumes the Web-farm monitoring as well as all its dependent objects Refreshes all instance parameters of the Web-farm monitoring
Application Classes
344

Version 8.6.53
SW_JMX
Parameters
Name
JMXColl
Description
JMX collector. Executes the JMX polling query Default polling interval set at 2 minutes
ExecutionStatus
Displays the output of the JMX poll execution Unit: 0 =OK; 1= ALARM Value set by JMXColl every 2 minutes
Value
Displays the value of an attribute in integers Value set by JMXColl every 2 minutes
Text
Displays the value of an attribute in text Value set by JMXColl every 2 minutes
Delta DeltaPerSecond
Displays the difference between values collected during two consecutive polling Displays the value corresponding to "Delta" devided by the elapsed time in seconds between the collection times
Infobox
Name
ID Parent ID Application ID Server type Host Port JMX Query User Name Path to java Timeout Domain Key property Attribute
Description
PATROL internal identifier of the JMX polling object PATROL internal identifier of the JMX polling objects parent PATROL internal identifier of the JMX polling objects root application Type of JMX server (JBoss/WebLogic/generic etc.) Displays name of host machine Displays port number of JMX server Displays the query to be executed Displays the user name Displays the path of the java virtual machine on the local server (e.g.% JAVA_HOME%\bin) Displays the execution timeout Displays the domain monitored Displays the key property monitored Displays the attribute monitored
Application Classes
345

Version 8.6.53
Menu Commands
Menu Command
New > String search New > Numeric value extraction New > Text Pre-Processing New > Dynamic Object Builder Edit Set Thresholds Set Polling Interval Set Alert actions Display Object Configuration Cut Copy Paste Delete Rename Pause monitoring Resume monitoring Refresh parameters
Description
Creates a new String search for this JMX polling object Creates a new Numeric value extraction for this JMX polling object Creates a new Text pre-processing for this JMX polling object Creates a new Dynamic Object Builder for this JMX polling object Allows you to edit the JMX polling settings Allows you to set or edit the thresholds Sets the polling interval for this JMX polling object monitoring Adds specific Alert Actions to the JMX polling monitoring Displays the Monitoring Studio configuration report of this JMX polling object and all dependent objects Cuts this object Copies this object Pastes a previously copied or cut JMX polling object Deletes the JMX polling and all its dependent objects Allows you to rename this JMX polling object monitoring Pauses the monitoring of this JMX polling object Resumes the monitoring of this JMX polling object Refreshes all instance parameters of the JMX polling object monitoring
Application Classes
346

Version 8.6.53
SW_KMWATCH
Parameters
Name
KMWatchColl
Description
Collects values by getting the information from the monitored parameter and setting the KM Watch value parameter with this value Default pooling interval: 1 minute
Value
Value of the parameter that is being monitored. Unit: Depends on the parameter Value set by KMWatchColl
Infobox
Name
ID Parent ID Application ID Class Instance Parameter Scale
Description
PATROL internal identifier of the KM Watch monitoring PATROL internal identifier of the KM Watch parent PATROL internal identifier of the KM Watchs root application Class of the parameter that is being monitored Instance of the parameter that is being monitored Name of the parameter that is being monitored Scale used for the parameters value
Menu Commands
Menu Command
Edit Set Thresholds Set Polling Intervals Set Alert Actions Display Object Configuration Cut Copy Delete Rename Pause monitoring Resume monitoring Refresh parameters
Description
Edits the KM Watch monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this KM Watch monitoring Adds specific Alert Actions to the KM Watch monitoring Displays the Monitoring Studio configuration report of this KM Watch object and all dependent objects Cuts this KM Watch monitoring object Copies this KM Watch monitoring object Deletes the KM Watch monitoring Renames the KM Watch monitoring object Pauses the KM Watch monitoring Resumes the KM Watch monitoring Refreshes all instance parameters of the SW_KMWATCH class
Application Classes
347

Version 8.6.53
SW_NTEVENTS
Parameters
Name
MatchingEventRate
Description
Rate of matching Windows Events Unit: Event/minute Value set by NTEventColl
MatchingEventCount
Number of Matching Windows Events Unit: Event Value set by NTEventColl
Infobox
Name
ID Parent ID Application ID Event log Event source Event ID Acknowledging Windows Event Acknowledge Timeout Run Alert Actions
Description
PATROL internal identifier of the Windows Event monitoring PATROL internal identifier of the Windows Events parent PATROL internal identifier of the Windows Events root application Indicates which EventLog is searched Source of the event to be searched for ID of the event to be searched for Is the auto-acknowledgment activated What is to be acknowledged: one event or all events Time after which a matching Windows Even is acknowledged Alert Actions trigger
Menu Commands
Menu Command
Edit Set Thresholds Set Polling interval Set Alert Actions Display Object Configuration Cut Copy Delete
Description
Edits the Windows Event monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this Windows Event monitoring Adds specific Alert Actions to the Windows Event monitoring Displays the Monitoring Studio configuration report of this Windows Event object and all dependent objects Cuts this Windows Event monitoring object Copies this Windows Event monitoring object Deletes the Windows Event monitoring
Application Classes
348

Version 8.6.53
Menu Command
Rename Acknowledge all and reset Pause monitoring Resume monitoring Refresh parameters
Description
Renames the Windows Event monitoring Acknowledges all alerts and resets the "MatchingEventCount" parameter to 0 Pauses the Windows Event monitoring Resumes the Windows Event monitoring Refreshes all instance parameters of the SW_NTEVENTS class
Application Classes
349

Version 8.6.53
SW_NTPERFORMANCE
Parameters
Name
NTPerformanceColl
Description
Collects Windows Performance counter values. Default Polling Interval: 2 minutes
Value
Value of the monitored Windows Performance counter. Unit: Depends on the parameter Value set by NTPerformanceColl
Infobox
Name
ID Parent ID Application ID Performance object Counter Instances Value Type Scale
Description
PATROL internal identifier of the Windows Performance monitoring PATROL internal identifier of the Windows Performances parent PATROL internal identifier of the Windows Performances root application Name of the Windows Performance object that is read Name of the Windows Performance counter that is read Selected Windows performance instances How the value is calculated (average, maximum, etc.) when more than one instance was selected Scale used (the original performance value is divided by this number)
Menu Commands
Menu Command
Edit Set Thresholds Set Polling interval Set Alert Actions Display Object Configuration Cut Copy Delete Rename Pause monitoring Resume monitoring
Description
Edits the Windows Performance monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this Windows Performance monitoring Adds specific Alert Actions to the Windows Performance monitoring Displays the Monitoring Studio configuration report of this Windows Performance object and all dependent objects Cuts this Windows Performance monitoring object Copies this Windows Performance monitoring object Deletes the Windows Performance monitoring Renames the Windows Performance monitoring Pauses the Windows Performance monitoring Resumes the Windows Performance monitoring
Application Classes
350

Version 8.6.53
Menu Command
Refresh parameters
Description
Refreshes all instance parameters of the SW_NTPERFORMANCE class
Application Classes
351

Version 8.6.53
SW_NTSERVICES
Parameters
Name
Status
Description
Status of the Windows Service Unit: 0 = Started, 1 = Intermediate state, 2 = Stopped Value set by NTServiceColl
Infobox
Name
ID Parent ID Application ID Service name
Description
PATROL internal identifier of the Windows Service monitoring PATROL internal identifier of the Windows Services parent PATROL internal identifier of the Windows Services root application Name of the Service that is monitored
Menu Commands
Menu Command
Description
Edits the Windows Service monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this Windows Service monitoring Adds specific Alert Actions to the Windows Service monitoring Displays the Monitoring Studio configuration report of this Windows Service object and all dependent objects Cuts this Windows Service monitoring object Copies this Windows Service monitoring object Deletes the Windows Service monitoring Renames the Windows Service monitoring Pauses the Windows Service monitoring Resumes the Windows Service monitoring Refreshes all instance parameters of the SW_NTSERVICES class
Application Classes
352

Version 8.6.53
SW_NT_WMI
Parameters
Name Description
WMIQueryColl
WMI Request collector. Executes the WMI query Default polling interval set at 2 minutes
ReturnOutput
Displays the output of the WMI query execution Unit: N/A Value set by WMIQueryColl every 2 minutes
QueryStatus
Displays whether or not the query was successfully executed Unit: 0 = OK, 1 =ALARM Value set by WMIQueryColl every 2 minutes
Infobox
Name
ID Parent ID Application ID Parent type Host Name Space WMI Query User Name
Description
PATROL internal identifier of the WMI query object PATROL internal identifier of the WMI query objects parent PATROL internal identifier of the T WMI query objects root application Type of the parent (File, OSCommand, etc.) Displays name of host machine Displays WMI namespace (e.g.: root\cimv2) Displays the query to be executed Displays the user name
Menu Commands
Menu Command
New > String search New > Numeric value extraction New > Text PreProcessing New > Dynamic Object Builder Edit Set Thresholds
Description
Creates a new String search for this WMI query Creates a new Numeric Value extraction for this WMI query Creates a new Text pre-processing for this WMI query Creates a new Dynamic Object Builder for this WMI query Allows you to edit the WMI query monitoring settings Allows you to set or edit the thresholds
Application Classes
353

Version 8.6.53
Menu Command
Set Polling Interval Set Alert actions Display Object Configuration Cut Copy Paste Delete Rename Pause monitoring Resume monitoring Refresh parameters
Description
Sets the polling interval for this WMI query monitoring Adds specific Alert Actions to the WMI query monitoring Displays the Monitoring Studio configuration report of this WMI query object and all dependent objects Cuts this object Copies this object Pastes a previously copied or cut WMI query object Deletes the WMI query monitoring and all its dependent objects Allows you to rename this WMI query monitoring Pauses the monitoring of this WMI query object Resumes the monitoring of this WMI query object Refreshes all instance parameters of the WMI query monitoring
Application Classes
354

Version 8.6.53
SW_WBEM
Parameters
Name
WBEMQueryColl ReturnOutput
Description
WBEM Request collector. Executes the WBEM query Default polling interval set at 2 minutes Displays the output of the WBEM query execution Unit: N/A Value set by WBEMQueryColl every 2 minutes Displays whether or not the query was successfully executed Unit: 0 = OK, 1 =ALARM Value set by WBEMIQueryColl every 2 minutes
QueryStatus
Infobox
Name
ID Parent ID Application ID Host Name Space
Description
PATROL internal identifier of the WBEM query object PATROL internal identifier of the WBEM query objects parent PATROL internal identifier of the T WBEM query objects root application Displays name of host machine Displays WBEM namespace Displays the query to be executed
WBEM Query
User Name
Displays the user name
Menu Commands
Menu Command
New > String search New > Numeric value extraction New > Dynamic Object Builder Edit Set Thresholds Set Polling interval Set Alert Actions Display Object Configuration Cut Copy Delete
Description
Creates a new String search for this File Creates a new Numeric Value extraction for this File Creates a new Dynamic Object Builder for this File Edits the Process monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this instance Adds specific Alert Actions to the Process monitoring Displays the Monitoring Studio configuration report of this Process monitoring object and all dependent objects Cuts this Process monitoring object Copies this Process monitoring object Deletes the Process monitoring
Application Classes
355

Version 8.6.53
Menu Command
Rename Pause monitoring Resume monitoring Refresh parameters
Description
Renames the Process monitoring object Pauses the Process monitoring Resumes the Process monitoring Refreshes all instance parameters of the SW_PROCESSES class
Application Classes
356

Version 8.6.53
SW_NUMBERS
Parameters
Name
ValueFound Value
Description
States if a numeric valued has been found Value of the searched Numeric Value (no value will be given if no number is found) Value set by the collector of the parents object
Infobox
Name
ID Parent ID Application ID Parent Type Line Mode Column Mode Parameter Type Line numerics Regular Expression Skip blank lines After/Before Specified String Character Offset Field numeric Field Separators Unique Separator
Description
PATROL internal identifier of the numeric extraction PATROL internal identifier of the numeric extractions parent PATROL internal identifier of the numeric extractions root application Type of the parent (File, OS Command, etc.) Method used to select lines to search for the numeric Method chosen to search and extraction the number in the line Type of the parameter Line numbers in which the numeric will be extracted from Regular expression used to select the lines where the number will be searched for Indicates whether or not blank lines are skipped when searching for the numeric Searches for the numeric either after or before the specified string Searches for the number before or after this specified string Character offset where the number is searched for Numeric of the field in which the numeric will be searched for Characters that separates the fields in a text line Considers consecutive separators as a unique separator
Menu Commands
Menu Command
Edit Set Thresholds Set Alert Actions
Description
Edits the numeric extraction settings Allows you to set or edit the thresholds Adds specific Alert Actions to the Numeric Value extraction object
Application Classes
357

Version 8.6.53
Menu Command
Display Object Configuration Cut Copy Delete Rename Pause monitoring Resume monitoring
Description
Displays the Monitoring Studio configuration report of this object and all dependent objects Cuts this Numeric Value extraction object Copies this Numeric Value extraction object Deletes the Numeric Value extraction Renames the Numeric Value extraction object Pauses the Numeric Value extraction Resumes the Numeric Value extraction
Application Classes
358

Version 8.6.53
SW_OSCOMMANDS
Parameters
Name
OSCommandColl ReturnOutput
Description
Execute the OS Command and collects the information Displays the return output of the OS command Unit: N/A Value set by OSCommandColl
ExecutionTime
Time taken by the OS Command to run Unit: Seconds Value set by OSCommandColl
ExecutionStatus
Status of the execution Unit: 0 = executed successfully, 1 = error while executing the OS command Value set by OSCommandColl
ExitStatus
Status of the OS command exit code Unit: 0 = executed successfully, 1 = error while executing the OS command Value set by OSCommandColl
Infobox
Name
ID Parent ID Application ID OS Command Timeout Username
Description
PATROL internal identifier of the OS Command analysis. PATROL internal identifier of the OS Commands parent. PATROL internal identifier of the OS Commands root application. Command line that is given to the OS to execute. Maximum execution time before timeout. The command line is executed with this username.
Menu Commands
Menu Command
New > String search New > Numeric value extraction New > Text Pre-Processing New > Dynamic Object Builder Edit
Description
Creates a new String search for this command line execution Creates a new Numeric value extraction for this command line execution Creates a new Text pre-processing for this command line execution Creates a new Dynamic Object Builder for this command line execution Edits the command line execution settings
Application Classes
359

Version 8.6.53
Menu Command
Set Thresholds Set Polling interval Set Alert Actions Display Object Configuration Cut Copy Paste Delete Rename Pause monitoring Resume monitoring Refresh parameters
Description
Allows you to set or edit the thresholds Sets the polling interval for this command line execution monitoring Adds specific Alert Actions to the command line execution Displays the Monitoring Studio configuration report of this command line object and all dependent objects Cuts this command line execution object Copies this command line execution object Pastes a previously copied or cut String search or Numeric Value search Deletes the command line execution and all its dependent objects Renames the command line execution monitoring object Pauses the command line execution as well as all its dependent objects Resumes the command line execution as well as all its dependent objects Re-execute the command line (if needed) and refresh all parameters. All dependent objects will be refreshed as well (SW_STRINGS and SW_NUMBERS instances)
Application Classes
360

Version 8.6.53
SW_PROCESSES
Parameters
Name
ThreadCount (Windows only)
Description
Displays the number of threads of the matching process(es). Unit: Threads Value set by proColl
ChildCount
Displays the number of children of the matching process(es). Unit: Processes Value set by proColl
HandleCount (Windows only)
Displays the number of handles opened by the matching process(es). Unit: Handles Value set by proColl
PageFaultsPerSec (Windows only)
Displays the number of page faults per second caused by the matching process(es). Unit: Page fault/sec Value set by proColl
VirtualBytes
Displays the virtual memory used by the matching process(es). Unit: Megabytes Value set by proColl
PrivateBytes (Windows only)
Displays the processor time percent used by the matching process(es). On multiprocessor computers, this parameter may go over 100%. Unit: Percent (%) Value set by proColl
PageFileBytes (Windows only)
Displays the page file used by the matching process(es). Unit: Megabytes Value set by proColl
WorkingSet (Windows only)
Displays the working set size of the matching process(es). Unit: Megabytes Value set by proColl
ProcessorTime
Displays the processor time percent used by the matching process(es). Unit: Percent (%) Value set by proColl
Count
Displays the number of processes that match the criteria. Unit: Processes Value set by proColl
Application Classes
361

Version 8.6.53
Infobox
Name
Object ID Object Type Object Class Parent ID Application ID
Description
PATROL internal identifier of the Process monitoring Type of the object (Process) Class of the object (SW_PROCESSES) PATROL internal identifier of the Process parent PATROL internal identifier of the Process root application
Menu Commands
Menu Command
Description
Edits the Process monitoring settings Allows you to set or edit the thresholds Sets the polling interval for this instance Adds specific Alert Actions to the Process monitoring Displays the Monitoring Studio configuration report of this Process monitoring object and all dependent objects Cuts this Process monitoring object Copies this Process monitoring object Deletes the Process monitoring Renames the Process monitoring object Pauses the Process monitoring Resumes the Process monitoring Refreshes all instance parameters of the SW_PROCESSES class
Application Classes
362

Version 8.6.53
SW_SENTRY
One single instance of the SW_SENTRY class is created and labeled Monitoring Studio. Once installed, it is the only visible icon under host icon in the PATROL Console. This icon gives you access to the various monitoring tools available in Monitoring Studio. Monitoring objects will be placed under this Monitoring Studio icon by default. You can also use this icon to create new application/container icons in the PATROL Console tree.
Parameters
Name
NTEventColl
Description
Windows Event collector. It uses the following script: "SW_EventLogReader. exe" to get a formatting list of Windows Events. Default polling internal: 2 minutes
ApplicationColl
Collector that checks whether the application signature files are present, signifying thus that the application is present and should be monitored. The "signature files" are specified when setting up a new application monitoring. Default polling internal: 2 minutes
NTServiceColl
Windows Service collector. It uses the following script: "SW_sentry_ServiceInfo.exe". Default polling internal: 2 minutes
FileSystemColl
File system collector. For UNIX systems, the command "df-k" is used. For Windows systems, the performance command "GetPerformanceValue Logical Disk" is used. Default polling internal: 2 minutes
ExtraFileList ProColl common collectors
Non-visible. Process Collector. Finds the processes that match the criteria and collects the performance information about the matching processes. Finds the processes that match the criteria and collects the performance information about the matching processes. Default polling internal: 2 minutes
Infobox
Name
Product Version Released Copyright Web Site
Description
Product name Monitoring Studio version number Release date of this version of Monitoring Studio Copyright information Web site address
Application Classes
363

Version 8.6.53
Name
Contact Support
Description
Contact information Support information
Menu Commands
Menu Command
New > Process monitoring New> Windows Service monitoring New > File monitoring and analysis New > Folder monitoring New > File System monitoring New > Command line analysis New > Database Query analysis New > Process monitoring New> Windows Service monitoring New > File monitoring and analysis New > Folder monitoring New > File System monitoring New > Command line analysis New > Database Query analysis New > Windows Performance monitoring New > KM Watch New > Application icon (container) Paste Delete All Tools > Process Viewer Tools > Windows EventLog Reader Tools > SNMP Browser Tools > Real-time SNMP Trap listener Import and Export > Export configuration Import and Export > Import configuration Options > Thresholds management Option > Debug Display Configuration > Object Configuration
Description
Starts the process monitoring wizard. Starts the Windows service monitoring wizard. Starts the file monitoring and analysis wizard Starts the folder monitoring wizard Starts the file system monitoring wizard Starts the command line execution and analysis wizard. Starts the database query analysis wizard Starts the Java MBean polling wizard Starts the WMI query wizard Starts the Web request analysis wizard Starts the Web-farm monitoring wizard Starts the SNMP polling wizard Starts the SNMP trap listening wizard Starts the Windows EventLog monitoring wizard (On Windows Agents only) Starts the Windows Performance counter monitoring wizard. (On Windows Agents only) Starts the KM Watch wizard Starts the new application/container icon wizard Pastes the previously copied object under the Monitoring Studio icon Deletes all monitoring objects under this icon Starts the process viewer tool Starts the Windows EventLog Reader tool (On Windows Agents only) Starts the SNMP browser tool Starts the real-time SNMP trap listener Starts the Export configuration wizard Starts the Import configuration wizard Shows the thresholds management options Shows the debug options Displays the Monitoring Studio configuration for all objects under the Monitoring Studio icon
Application Classes
364

Version 8.6.53
Menu Command
Display Configuration > Entire Configuration Report Scheduler License About
Description
Displays the Monitoring Studio configuration for all objects under the Monitoring Studio icon and any user-defined container Starts the Monitoring Studio configuration report scheduler Shows the currently registered license keys and registers new license keys Shows the version and general information about Monitoring Studio
Application Classes
365

Version 8.6.53
SW_SNMP_POLLING
Parameters
Name
SNMPPollingColl Content
Description
Polls the SNMP and collects the information received. Content of the SNMP received. Unit: Varies Note: Only applicable to SNMP of String type. Value set by SNMPPollingColl
Value
Value of the SNMP received. Unit: Varies Note: Only applicable to SNMPs of integer type. Value set by SNMPPollingColl
Status
Status of the SNMP Polling. Unit: 0 = working, 1 = a problem occurred Value set by SNMPPollingColl
Infobox
Name
ID Parent ID Application ID OID OID type Host Port Community
Description
PATROL internal identifier of the SNMP Polling. PATROL internal identifier of the SNMP Pollings parent. PATROL internal identifier of the SNMP Pollings root application. OID that is polled. Type of the value of the selected OID (number or string). Host name where the SNMP agent is running. Port used to connect to the SNMP agent. Community used to connect to the SNMP agent.
Menu Commands
Menu Command
New > String search New > Numeric value extraction
Description
Creates a new String search for this SNMP Polling Creates a new Numeric Value search for this SNMP Polling
Application Classes
366

Version 8.6.53
Menu Command
New > Dynamic Object Builder Edit Set Thresholds Set Polling interval Set Alert Actions Display Object Configuration Cut Copy Paste Delete Rename Pause monitoring Resume monitoring Refresh parameters
Description
Creates a new Dynamic Object Builder for this SNMP Polling Edits the SNMP Polling settings Allows you to set or edit the thresholds Sets the polling interval for this SNMP Polling Adds specific Alert Actions to the SNMP Polling Displays the Monitoring Studio configuration report of this SNMP Polling object and all dependent objects Cuts this SNMP Polling object Copies this SNMP Polling object Pastes a previously copied or cut String search or Numeric Value search Deletes the SNMP Polling and all its dependent objects Renames the SNMP Polling object Pauses the SNMP Polling as well as all its dependent objects Resumes the SNMP Polling as well as all its dependent objects Re-poll the OID and refresh all parameters. All dependent objects will be refreshed as well (SW_STRINGS and SW_NUMBERS instances)
Application Classes
367

Version 8.6.53
SW_SNMP_TRAPS
Parameters
Name
SNMPTrapColl
Description
The SNMP trap collector is a detached process launched at the start of BMC Performance Manager Monitoring Studio. This process waits for SNMP Traps and analyzes traps as it receives them. Number of SNMP traps matching the search. Unit: Trap Value set by SNMPtrapColl
MatchingTrapRate
MatchingTrapCount
Number of matching SNMP traps per minute. Unit: Trap/min Value set by SNMPtrapColl
Infobox
Name
ID Parent ID Application ID Source IP Community Enterprise ID Trap number OID 1 String 1 OID 2 String 2 Acknowledging Trap Number Acknowledging OID 1 Acknowledging String 1 Acknowledging OID 2 Acknowledging String 2 Timeout Run Alert Actions
Description
PATROL internal identifier of the SNMP Trap listening PATROL internal identifier of the SNMP Trap listening parent PATROL internal identifier of the SNMP Trap listening root application IP address of the SNMP agent that raises the traps Community used to listen to traps Enterprise ID of the SNMP agent that raises the traps Number of the searched trap OID of the first varBind of the searched traps Searched string in the first varBind OID of the second varBind of the searched traps Searched string in the second varBind Number of the trap that will acknowledge this trap search OID of the first varBind of the trap that will acknowledge this trap search Searched string in the first varBind of the acknowledging trap. OID of the second varBind of the trap that will acknowledge this trap search Searched string in the second varBind of the acknowledging trap Timeout for auto-acknowledgment Indicates when Alert Actions should be executed
Application Classes
368

Version 8.6.53
Menu Commands
Menu Command
Edit Set Thresholds Set Alert Actions Display Object Configuration Cut Copy Delete Rename Acknowledge all and reset Pause monitoring Resume monitoring Refresh parameters
Description
Edits the SNMP Trap listening settings Allows you to set or edit the thresholds Adds specific Alert Actions to the SNMP Trap listening Displays the Monitoring Studio configuration report of this SNMP Trap object and all dependent objects Cuts this SNMP Trap listening object Copies this SNMP Trap listening object Deletes the SNMP Trap listening Renames the SNMP Trap listening Acknowledges all alerts on the SNMP Trap object and resets the "MatchingTrapCount" parameter to 0 Pauses the SNMP Trap listening Resumes the SNMP Trap listening Refreshes all parameters of the SW_SNMP_TRAPS class
Application Classes
369

Version 8.6.53
SW_STRINGS
Parameters
Name
LastMatchingLines
Description
Lines matching the String search. Unit: N/A Value set by the collector of the parent object. Note: The number of lines displayed can be changed to a custom value by adding the variable "/MASAI/SENTRY8/ LastMachingLinesNumber" with the proper line number to the PATROL Agent configuration Default: the 10 last matching lines are displayed.
MatchingLineCount
Number of lines matching the String search. Unit: Line Value set by the collector of the parent object
MatchingLineRate
Number of lines matching the String search per minute. Unit: Line/minute (line/min) Value set by the collector of the parent object The MatchingLineRate parameter is only activated for String searches in LOG files and in "never-ending" command lines
Infobox
Name
ID Parent ID Application ID Parent type Search Lines Acknowledge String Acknowledge Timeout Run Alert Actions
Description
PATROL internal identifier of the String search PATROL internal identifier of the String searchs parent PATROL internal identifier of the String searchs root application Type of the parent (File, OSCommand, etc.) Search mode Lines that are searched String that auto-acknowledges this string search Is the auto-acknowledgment enabled? Timeout for the auto-acknowledging When Alert Actions have to be executed
Menu Commands
Menu Command
Edit
Description
Edits the String search settings
Application Classes
370

Version 8.6.53
Menu Command
Set Thresholds Set Alert Actions Display Object Configuration Cut Copy Delete Rename Acknowledge all and reset Pause monitoring Resume monitoring
Description
Allows you to set or edit the thresholds Adds specific Alert Actions to the String search Displays the Monitoring Studio configuration report of this String search object and all dependent objects Cuts this String search object Copies this String search object Deletes the String search Renames the String search object Acknowledge all alerts for this object. The MatchingLineCount parameter is set to zero Pauses the String search Resumes the String search
Application Classes
371

Version 8.6.53
SW_Transform
Parameters
Name
TransformResult
Description
Lines matching the Text pre-processing. Unit: N/A
Infobox
Name
ID Parent ID Application ID Parent type
Description
PATROL internal identifier of the Text Pre-processing object PATROL internal identifier of the Text Pre-processing objects parent PATROL internal identifier of the Text Pre-processing objects root application Type of the parent (File, OS Command, etc.)
Menu Commands
Menu Command
New > String search New > Numeric value extraction New > Dynamic Object Builder Edit Display Object Configuration Cut Copy Paste Delete Rename Pause monitoring Resume monitoring
Description
Creates a new String search for this Text pre-processing object Creates a new Numeric value extraction for this Text pre-processing object Creates a new Dynamic Object Builder for this Text pre-processing object Edits the Text-preprocessing monitoring settings Displays the Monitoring Studio configuration report of this Text- pre-processing object and all dependent objects Cuts this object Copies this object Pastes a previously copied or cut Text pre-processing object Deletes the Text-preprocessing monitoring and all its dependent objects Allows you to rename this Text pre-processing object Pauses the monitoring of this Text pre-processing object Resumes the monitoring of this Text pre-processing object
Application Classes
372

Version 8.6.53
Application Classes
373

Version 8.6.53
Index
-AAbout processes 310 About WMI 311 Access 53, 101, 169, 177, 196, 236, 261, 266, 270, 271, 276, 285, 286, 310, 311, 335, 363 Access rights 335 AccessRightsCheck 335 ACEs 101 Acknowledeges 348, 368 Acknowledge alerts 138, 143, 183, 285 Acknowledge all 183, 285, 335, 348, 368, 370 Acknowledge all alerts 370 Acknowledge String 370 Acknowledgement 138, 143, 183 Acknowledging 138, 143, 183, 368 Windows Event ACL 101 Adapter 35 348
File 333, 337 Folder 339 JMX polling 345 Process 361 Run 294 Setting 242 SNMP Trap 368 Types 246 Web-farm 343 Alert Actions capabilities 246 Alert Actions description 242 Alert Actions example 294 Alert Actions on any/all 242 Alert Actions trigger 348 Analysis 48, 118, 289, 318, 323, 326, 341, 359, 368 Annotate 246 Antivirus 320 API adapts APP_PATH 196
Add 36, 44 Create 36 Update 44 Adaptors 196 Additional 199, 234 Additional information 207, 221 Administrator 31, 48, 101, 161, 246, 266, 270, 290, 363 Advanced 53, 234, 236, 290 After/Before 118, 357 Agent 11, 13, 24, 25, 31, 48, 53, 113, 138, 192, 196, 234, 254, 258, 261, 307, 314, 363 AgentSetup/preloadedKMs 25 AgentSpring 234 Alarm 101, 236, 326, 345, 353 Alert 14, 50, 51, 61, 93, 98, 101, 109, 113, 118, 138, 143, 177, 188, 192, 199, 207, 221, 234, 236, 246, 285, 294, 318, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370 Alert Action macros 254, 314 Alert Actions 53, 143, 183, 234, 236, 254, 294, 314, 318, 323, 326, 335, 341, 347, 348, 350, 352, 353, 357, 359, 363, 366, 370 Execute 294
define 53 Application 53, 109, 310, 323, 326, 333, 337, 339, 341 Application class 24, 335, 337 existing 31 Application constants 53, 323 Application icons 192, 271, 290 Application ID 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Application monitoring 113, 258, 261, 290, 323 Application myApplication 294 Application/container 24, 53, 61, 71, 93, 98, 109, 113, 138, 177, 183, 188, 236, 271, 323, 363 APPLICATION_CLASS 242, 254, 314 APPLICATION_EXI 242 APPLICATION_ID 242, 254, 314 APPLICATION_LABEL 294 APPLICATION_PATH 53 APPLICATION_TYPE 242 Application1 320 ApplicationA 320 ApplicationAA 320 ApplicationABC 320 ApplicationB 320 ApplicationColl 363
Index
374

Version 8.6.53
Applications 11, 24, 31, 48, 50, 51, 53, 61, 71, 93, 98, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 196, 199, 205, 207, 214, 221, 228, 234, 242, 246, 254, 258, 261, 271, 290, 294, 310, 311, 314, 320, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370, 372 Argument 310 window shows 276 Argument1 310 Argument2 310 AS 234 AS_EVENTSPRING 234 AS_EVENTSPRING.kml 25 asctime 318 Atrium Orchestrator 35 Authenticate 169, 177 Auto-acknowledgement 143, 348, 370 Timeout 368 Automatic 11, 138, 143, 183, 234 Automatic collection process 9
administrator identify 266 analyze 271 ignore 271 Check 14, 24, 50, 53, 61, 93, 101, 109, 118, 125, 138, 143, 149, 169, 177, 236, 291, 294, 307, 310, 320, 335, 363 ChildCount 125, 361 Choosing the way thresholds are managed 234 CIM 311 CIM contains 311 CIM Repository 311 CIM stands 311 CIM_DataFile 311 CityEnterprise StateID SNMP Trap 138 Cityplace7 258 CityplaceEnterprise StateID 138, 368 CityplaceSplit 258 CityplaceWebSphere StateAS 214 Class 11, 24, 31, 53, 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 199, 207, 214, 228, 234, 236, 254, 271, 311, 314, 333, 339, 347, 348, 350, 352, 361, 363, 368 ClientKeyFile.jks 205 ClientTrustFile.jks 205 Collect 31, 118, 188, 199, 207, 214, 221, 228, 271, 288, 307, 311, 333, 335, 347, 350, 359, 363, 366 Column 118, 143, 276, 297, 357 Column Mode 357 com.blahbmah 205 com.csg.cs.servlet.CSServlet.doGet 297 com.csg.pb.frontnet.apps.common.base.DefaultA uthorizationStrategy.assertAvailableBusinessUnit 297 com.csg.pb.frontnet.apps.portals.base.PortalSele ctionController.doGetManaged 297 com.sun.jndi.rmi.registry.RegistryContextFactory 205, 221 Command line 53, 61, 125, 143, 149, 254, 266, 286, 290, 310, 311, 314, 318, 323, 359, 363 Command lines and scripts execution and analysis 61 Command-line MUST MATCH THE REGULAR EXPRESSION 125
-BBACKENDDB Oracle 71 Basic 50, 61, 246 BMC 12, 13, 14, 25, 31, 51, 61, 93, 98, 118, 138, 183, 192, 196, 234, 236, 368 BMC PM Monitoring Studio 14, 51, 363 BMC Portal 31 BMC Software 12, 13, 14, 25, 234 BMC Software FTP site 12 BMC Software Installation Utility 13, 14 BMC Software PATROL 12, 25 BMC Software PATROL Agent 12 BMC Software PATROL Console 12 BMC Software provides 31 BMC Software website 31 Browse 14, 31 Browser 177
-CCalculate 118, 188, 350 carol.properties 221 Case 11, 188, 261, 271, 307, 310 CD 31 Character Offset 118, 143, 357 Characteristics
Index
375

Version 8.6.53
Commands 11, 24, 53, 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 196, 199, 207, 214, 221, 228, 234, 236, 242, 246, 254, 258, 261, 266, 267, 270, 271, 276, 286, 287, 288, 289, 290, 291, 297, 307, 310, 311, 314, 318, 320, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370, 372 Comma-separated list 25 Commit KMs 11 Common Information Model 161 Common services 14 Community 132, 138, 254, 270, 271, 314, 366, 368 Configuration Report 278, 280 Configuring 25, 31, 50, 51, 61, 71, 98, 118, 138, 183, 196, 242, 246, 258, 261, 267, 286, 323 Monitoring Studio 48, 53 Connect 11, 196, 199, 205, 207, 214, 221, 228, 307, 326 Oracle SQL*Plus 71 SNMP 366 Connection Information 196, 199, 205 ConnectionStatus 71, 326 Consecutive 118, 143, 357 Console 11, 12, 13, 14, 24, 25, 31, 50, 113, 149, 161, 196, 207, 246, 261, 287, 294, 307 Console Server 11, 12, 14 Console Systems 14 Constant 53, 118, 149, 323 Constant name 53 constants facilitate 53 Contact 323, 363 Contain/do 143 Container 53, 242, 258, 286, 290, 323 Containing 125 Content 24, 71, 93, 101, 109, 125, 138, 143, 149, 169, 177, 183, 246, 254, 289, 291, 294, 297, 314, 333, 335, 366 Convert Multi-line 143, 149 Convert Multi-line records 149 Convert XML 149, 297 Converted multi-line records 143, 149 Converting 149 Converting multi-line records 149 Copy 205, 214, 258, 261, 286, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370, 372 Copy Cut and Paste 286
Count 118, 361 Create 48, 93, 98, 101, 109, 113, 118, 188, 192, 199, 258, 271, 291, 294, 323, 326, 333, 341, 343, 345, 353, 359, 366, 372 Credentials 53, 161, 169, 177, 196, 199, 205, 207, 214, 221, 228 Critical Error 0x000295F0 on ApplicationABC 320 CSCRIPT.EXE 310 CSV Convert XML 149, 297 CSV pre-processing 297 ctx 297 CTX.CNAME 297 Custom standalone MBean application server 199 Customer support 31 Cut 286, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Cut JMX polling 345 Cut Text 372 Cut Text pre-processing object 372 CutCopy_Cut_and_Paste 335
-DDatabase 31, 50, 71, 118, 143, 177, 234, 310, 320, 323, 326, 363 Database Client 71 Database Macros 254, 314 Database monitoring 71 Database Query 143, 323, 326, 363 Database Request 323, 326 Database Type 326 DATABASE_TYPE 242 Dataset 118, 143 Day-to-day monitoring 51 DbQueryColl 326 DEBUG 149 Debug mode 258, 363 Enabling 307 Default 14, 61, 93, 98, 101, 109, 113, 118, 138, 143, 161, 169, 177, 188, 192, 196, 199, 205, 207, 221, 228, 234, 236, 258, 270, 271, 307, 311, 326, 333, 335, 339, 341, 345, 347, 350, 353, 363, 370 Default ID 61, 93, 98, 101, 109, 113, 118, 138, 143, 161, 169, 177, 188, 192, 199, 207, 221, 228 Default pooling interval 347
Index
376

Version 8.6.53
default WebAS 205, 214 Define 53, 101, 188, 246, 271, 320 Delete 287, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370, 372 Delete All 287, 363 DeletedFileCount 339 Description 276, 318, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Dir 339 Directory 258, 310, 339 Disabled 53, 161, 311 Display/information 98 Displays 11, 51, 53, 61, 71, 93, 98, 101, 109, 113, 118, 138, 143, 161, 169, 177, 183, 188, 192, 196, 199, 207, 221, 228, 236, 258, 261, 267, 270, 288, 291, 294, 311, 323, 326, 333, 339, 341, 345, 353, 359, 361, 370 Displays WMI namespace 353 DisplaysDatabase 12, 14 Distributed Management Task Force 161, 311 Divide 109, 113, 118, 188, 350 Domain-specific 196 Drive/file 98 Dropdown list 101, 183, 199 DummyClientKeyFile.jks 205, 214 Dynamic Numeric Value Extractions 240 Dynamic Object 240
Enterprise 138, 161, 214, 228, 254, 271, 311, 314 Enterprise ID SNMP 368 Enterprise StateID 138 Environment CPU 125, 310 EPD 31 Err 320 Err0 320 Err01 320 Err02 320 Err1 320 Err11 320 Err1A 320 Err2 320 Err3 320 Err6 320 Err7 320 Err9 320 ErrA 320 ErrA0 320 ErrA1 320 ErrAB 320 ErrBF0001 320 Error 11, 50, 61, 118, 143, 149, 161, 183, 270, 271, 291, 294, 307, 311, 320, 341, 359 Error logging 161, 311 Error.*ApplicationABC 320 errpt 61 ErrS9 320 ErrZ0 320 Event 31, 161, 183, 234, 242, 246, 271, 276, 294, 311, 348, 363 characteristics 183 matching 183 Event ID 348 Event Management 234 Event Viewer 183 Event/minute 348 EVENT_MANAGEMENT.kml 25 EventLog 183, 276, 348 EventLog Reader 276 EventSpring 234 EX 318 exe 310 execute WMI 161 Executes 11, 24, 48, 53, 61, 71, 101, 125, 143, 149, 161, 183, 236, 242, 246, 254, 290, 310, 311, 314, 341, 345, 353, 359, 368, 370
-EEdit 53, 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Elements 31, 109 Enable string/numeric 24 Enables extracting 24 Enabling 24, 50, 53, 98, 101, 138, 143, 177, 234, 236, 370 debug mode 307 Enabling the debug mode 307 Entering 53, 61, 71, 93, 98, 101, 109, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 196, 199, 205, 207, 214, 221, 228, 234, 236, 242, 258, 261, 266, 290, 291, 294 hostname 270
Index
377

Version 8.6.53
Executes 11, 24, 48, 53, 61, 71, 101, 125, 143, 149, 161, 183, 236, 242, 246, 254, 290, 310, 311, 314, 341, 345, 353, 359, 368, 370 Alert Actions 294 Command line 359 OS 359 OS Command 242, 359 PSL 242 SQL 326 execution 101, 286, 290, 318, 326, 341, 345, 353, 359 choose/configure 242 operating system controls 310 ExecutionStatus 61, 199, 207, 214, 221, 228, 345, 359 ExecutionTime 326, 341, 359 Export 53, 258, 261, 323, 363 Export Configuration 258, 323, 363 Export_SW_Sentry.cfg 258 Exporting the configuration to a file 258 exprA 320 exprA\|exprB 320 ExprB 320 Extract text 149 Extracting setup 23 Extracting numeric values Extracting the setup files Ey 318 240 23
file ClientTrustFile.jks 205, 214 file DummyClientKeyFile.jks 205 file DummyClientTrustFile.jks 205, 214 File Flow 109 File matching 93, 109 File monitoring 93, 101, 149, 291, 318, 323, 333, 335, 363 File monitoring icon 101 File monitoring object 93, 333 file name>~n.cfg Split 258 File Security > Acknowledge and update alerts 285 File security monitoring 101 File System monitoring 98, 323, 337, 363 File system monitoring object 98, 337 File systems 31, 98, 254, 271, 314, 323, 337, 363 File/LOG File 291 FILE_CURRENT_NAME 242, 254, 314 FILE_NAME 242, 254, 314 FileColl 333 FileCount 109, 339 Files 93, 101, 289, 291, 318, 335 Files Currently Loaded 31 FileSecurityColl 335 Filesystem 98, 337 FileSystemColl 337 FILESYSTEMS 24 Firewall 320 First/last 291 Flat file 93, 143 FNDBDataAccessFailureException RDS001002 Code 297 FNServiceNotAvailableException FEA000001 Service 297 Folder 14, 24, 50, 109, 323, 339 Folder Disk Usage 109 Folder monitoring 339 Folder monitoring object 109, 339 FOLDER_PATH 242, 254, 314 FolderColl 339 FolderSize 109, 339 Format symbols 318 Format symbols for %{ASCTIME...} 318 FreeMegabytes 98, 337 FreeSpacePercent 98, 337 ftp 13 ftp.bmc.com/pub/patrol/patches 13
-FFailure audit 183 Farms 24, 169 Fi 205, 221 Field Number 357 Field Separators 143, 357 Fifo 101 File 11, 14, 23, 24, 25, 48, 93, 98, 101, 118, 188, 236, 258, 261, 271, 285, 294, 307, 310, 318, 320, 323, 333, 335, 339, 353, 357, 361, 363, 370, 372 50KB 291 Alert Actions 333, 337 Displays 333 File > Restart scan from start 289 modification/creation 109 File > Restart scan from beginning of file file ClientKeyFile.jks 205, 214
289
Index
378

Version 8.6.53
Full Client
71
-GGeneral Macros 254, 314 General Tasks 24 Generic 345 Generic JMX 199, 207, 221, 228 Generic JMX clie 199 Generic JMX client 199 GET 169, 177, 254, 314 getAttribute use 196 GetPerformanceValue Logical Disk 363 Group 101, 188, 323, 335 Group ID 101 GroupCheck 335 GrowthPercentage 109, 333, 339 GrowthSpeed 93, 109, 333, 339 GUI 48
HTTP Web-farm 343 HTTP_RETURN_OUTPUT 242 HTTP_URL 242, 254, 314 HttpRequestColl 341 Https 169, 177 HTTPStatusCode 341
-IIBM 12 IBM AIX 12, 61 Icon 24, 48, 53, 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 196, 199, 207, 214, 221, 228, 234, 236, 242, 258, 261, 266, 270, 271, 276, 287, 288, 290, 307, 318, 323, 363 ID 53, 98, 101, 109, 113, 188, 192, 199, 267, 276, 310, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 366, 368, 370, 372 Identifier 53, 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 199, 207, 214, 221, 228, 267, 310, 318, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Ignore 118, 138, 271 IIOP 196, 199, 221 IisAdmin.Exe 310 Import 31, 53, 113, 234, 258, 261, 363 Import configuration 261 Include 11, 258, 310, 318, 339 Solaris 12 Windows NT4 12 Include subfolders 339 Include Win32_Process 311 including Red Hat Enterprise Linux 207 Infobox 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370, 372 INFORMATION 101, 236, 242, 254, 314, 318 Infrastructures 113 Input variables JMX polling wizards 205 INPUTFILE 149 Ins_ALL_7550.tar 23 ins_WINDOWS_<version number>.exe Ins_WINDOWS_7550.exe 23 ins_WINDOWS_7552.exe 23 Installation Utility 14
-HHost 132 Hostname Enter 270 Hosts 31, 53, 71, 161, 169, 177, 196, 205, 207, 221, 228, 261, 311, 345, 353, 363, 366 Monitor Studio considers 199 Web-farm 343 How to configure Monitoring Studio 50 How to restart an application 290 How to stop an application 290 HP Tru64 12 HP-UX 12, 207, 310 HTML 24, 341 HTML/HTTP 196 HTTP 24, 118, 143, 169, 177, 228, 323, 341, 343 HTTP Authentication 169, 177 HTTP Digest 169, 177 HTTP GET 169, 177 HTTP POST 169, 177 HTTP Request 169, 177, 323, 341 HTTP Request Mode 169 HTTP Requests 341, 343 HTTP Response Status 341 HTTP Status 169, 177
23
Index
379

Version 8.6.53
Installing 14 Instance/Service 326 InstanceCreationEvent 311 Instant Client Basic Lite 71 Instant Client SQL*Plus 71 Integration 267 Integration Service Agent 36 Integration with Portal 31 Internet Explorer 177 Intervals 271, 347, 353 IntranetPLEnfFilter.java 297 IP 31, 53, 71, 138, 161, 270, 271, 368 IP address 270, 271 SNMP 368 ipconfig 149 ipconfig/all 149 ISA 311 IT 48, 51, 323
JMX client 199, 207 JMX Macros 254, 314 JMXColl 345 JMXMP 199 JMXPOLLING_CONTENT 254, 314 JMXPOLLING_HOST 254, 314 JNDI 205 JNDI name 196 JNXMP 199 Jonas 221 JOnAs applicarion 205 JOnAS applicarion server 205 JOnAs application 205, 221 JonAS monitoring 221 jonas_home%/conf 221 JONBoss application 221 JRMP 221 JVM v1.4. 228
-JJ2EE 221 J2EE 214 J2SE 5.0 196 Java 196, 199, 205, 207, 214, 221, 228, 310, 323, 345, 363 Java EE 221 Java EE-based 207 Java Management Extensions 196 Java MBean polling 196, 199, 207, 221, 228, 323, 363 Java Virtual Machine 345 running 207 Java.EXE 310 JavaMBean 196 javax.management 196 javax.servlet.http.HttpServlet.service 297 JBoss 205, 207, 345 JBoss/WebLogic/generic etc.Host 345 JConsole 196 JDK v1.4 228 JDK v1.5 228 JMX 118, 196, 199, 205, 207, 214, 221, 228, 254, 314 Adds 323 Type 345 JMX Architecture
-KKB 291, 333 KB/min 333, 339 KeyStore password 205, 214 KeyStoreFile path 205, 214 KM 11, 24, 31, 50, 51, 53, 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 196, 199, 207, 214, 221, 228, 234, 236, 242, 254, 258, 261, 266, 267, 270, 271, 276, 286, 287, 288, 289, 291, 297, 307, 314, 323, 347, 363 console requesting 25 install 14 KM depending 11 KM Watch 113, 323, 347, 363 KMWATCH_CLASS 242, 254, 314 KMWATCH_ID 242, 254, 314 KMWATCH_PARAMETER 242, 254, 314 KMWatchColl 347 Knowledge Modules 11, 24, 113, 347
-LLast Step GET 177 LastChanged 333 LastMachingLinesNumber 370 LastMatchingLines 370 LastModifiedFileElapsedTime 109, 339
196
Index
380

Version 8.6.53
LASTTIME 318 Launch 14, 61, 125, 138, 161, 294, 310, 368 setup.exe 14 setup.sh 14 License 14, 261, 363 License key 261 License4 261 licenseList 149 Line 24, 61, 93, 118, 143, 236, 246, 258, 276, 291, 294, 310, 318, 320, 357, 359, 370, 372 Lines matching 236, 291, 370 entered 118 Text 372 Linux 13, 310 Linux-based 12 List 25, 98, 113, 188, 192, 236, 258, 266, 271, 276, 294, 333 Listening 138 50001 14 Load 11, 24, 25, 31, 234, 258 Load Knowledge Modules 24 LOG 53, 93, 118, 143, 149, 242, 246, 254, 289, 294, 297, 314, 333, 370 LOG file 246, 289, 294, 333, 370 Login 53, 125, 177, 326
MBean 196, 199, 207, 214, 221, 228, 323, 363 MBeanServer access 196 MBeanServer API access 196 Mega-bytes 188 Menu Command 53, 93, 271, 285, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370, 372 MIB 138, 366 MIB Browser tool 138 Microsoft 71, 161, 188, 207, 228, 311 Microsoft SQL Server 71, 326 Middleware 50, 51, 113 Migrating from previous versions of Monitoring Studio 11 Min 333, 339 ModifiedFileCount 109, 339 Modify 31, 53, 61, 71, 93, 98, 101, 109, 113, 118, 138, 143, 161, 169, 177, 183, 188, 192, 196, 199, 205, 207, 221, 228, 234, 236, 267, 271, 311, 323, 333, 339 Modify Alert Thresholds 234, 236 Monitor 50, 323, 326, 333, 337, 339, 341, 347, 348, 350, 352, 359, 361, 368 Monitor my application 50 Monitor Studio considers 71 host 169, 177, 199, 207, 214, 221, 228 Monitor Type 36 Monitor web sites 177 Monitored files 24, 101, 149, 254, 314, 333, 335 Monitoring 11, 13, 14, 24, 25, 31, 48, 50, 51, 53, 98, 101, 109, 113, 118, 138, 143, 161, 169, 177, 183, 188, 192, 196, 199, 207, 221, 228, 234, 236, 242, 246, 258, 261, 266, 267, 270, 271, 276, 285, 286, 287, 288, 290, 291, 294, 307, 310, 311, 318, 320, 335, 343, 345, 353, 363, 372 databases 71 In order 61, 93 Monitoring datasbase queries 24 Monitoring JMX-enabled 24 Monitoring Studio 11, 13, 14, 24, 25, 31, 50, 51, 61, 71, 93, 98, 101, 109, 113, 118, 138, 143, 161, 169, 177, 183, 188, 192, 196, 199, 207, 221, 228, 234, 236, 246, 258, 261, 266, 267, 270, 271, 276, 286, 287, 288, 290, 291, 307, 320, 323, 363, 368 Configuring 48, 53
-Mm%d%H%M%S 61 m/%d/%y 318 maching process 361 Manage 11, 12, 14, 24, 31, 53, 161, 196, 214, 234, 290, 311, 323 Managed System 11, 14 Management Information Base 366 Managing thresholds 234 Matching 348 line/event 236 SNMP Trap 138 String 370 MatchingEventCount 236, 285, 348 MatchingEventRate 348 MatchingLineCount 143, 236, 285, 294, 370 MatchingLineRate 370 MatchingTrapCount 138, 236, 285, 368 MatchingTrapRate 368 MB 188, 337, 339 MB/h 337 MB/hour 98
Index
381

Version 8.6.53
Monitoring Studio 11, 13, 14, 24, 25, 31, 50, 51, 61, 71, 93, 98, 101, 109, 113, 118, 138, 143, 161, 169, 177, 183, 188, 192, 196, 199, 207, 221, 228, 234, 236, 246, 258, 261, 266, 267, 270, 271, 276, 286, 287, 288, 290, 291, 307, 320, 323, 363, 368 Console Server 14 PATROL Agent 14 PATROL Classic Console 14 Monitoring Studio 8.3.00 11 Monitoring Studio builds 125, 192 Monitoring Studio deletes missing objects after they have been missing a specific number of times in a row 88 Monitoring Studio Installation Packages 13 Monitoring Studio objects 271, 286 Monitoring Studio packages 13 Monitoring Studio Settings 53, 93, 98, 101, 118, 125, 138, 143, 149, 183, 188, 192 parameters 113 Monitoring Studio v8.5 161, 196 Monitoring Tools 93, 98, 109, 143 Monitoring web farms 169 MORE_INFORMATION 294 MS_HW_MAIN/localhost 149 MSMQ 50 Multi-Parameter Formula 9, 113
-NName 11, 23, 93, 98, 101, 109, 113, 118, 188, 192, 199, 205, 207, 221, 236, 246, 258, 266, 267, 294, 310, 318, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370, 372 event containing 294 event contains 294 Oracle 71 Name entered/displayed 199, 207, 214, 221, 228 Namespace 161, 311, 353 New 11, 93, 98, 101, 109, 113, 118, 188, 192, 199, 205, 207, 221, 234, 236, 258, 261, 270, 271, 286, 289, 291, 294, 318, 323, 326, 333, 339, 341, 343, 345, 353, 359, 363, 366, 372 New application 53, 323, 363 New File 11, 93, 98, 101, 323, 333 New file security-related 11 New folder monitoring 109 New MBeans 196
New Menu 11, 271 New Menu Commands 11, 271 New Process 323 New process monitoring 125 New SOAP 205, 214 New web-farm 323 New/Edit 290 NewFileCount 109, 339 NEWLINE 294 Node name 205 notepad.exe 311 NTEVENT_LAST_MATCHING 242 NTEVENT_SOURCE 242, 254, 314 NTEventColl 348, 363 NTLM 169, 177 NTML 169, 177 NTPERFORMANCE 24 NTPerformanceColl 350 NTServiceColl 352, 363 NTSERVICES 24 Numeric 24, 61, 71, 93, 118, 149, 161, 177, 196, 199, 207, 214, 221, 228, 271, 318, 326, 333, 341, 343, 345, 353, 357, 359, 366, 372 Numeric Value 199, 326, 333, 341, 343, 345, 353, 357, 359, 366, 372 Numeric Value Extraction 118, 149, 326, 333, 341, 343, 345, 353, 359, 372 Numeric values 61, 199, 207, 221, 343, 372
-OObject 98, 101, 113, 188, 192, 234, 236, 261, 270, 271, 285, 286, 287, 288, 291, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 modifying 267 Object Class 361 Object display 61, 71, 93, 98, 109, 113, 118, 125, 138, 143, 149, 161, 169, 177, 183, 188, 192, 199, 207, 214, 221, 228, 267 Object ID 267, 361 Object Type 254, 314, 361 OBJECT_LABEL 242, 254, 314 OBJECT_TY 254, 314 OBJECT_TYPE 242 Offline 113, 288 OID 138, 242, 254, 270, 271, 314, 366, 368 OID1 138 OIDs containing 138
Index
382

Version 8.6.53
OldestModifiedFileElapsedTime 109, 339 Online 31 online help 31 OpenVMS 12 Operating 12 Operating system 12, 101, 125, 183, 310, 311 OperationalServerPercent 343 OperationServerCount 343 opt/MyApp value 53 opt/myApp/bin/diag/diagnose.sh 61 opt/myApplication/log/myApp*.log 294 opt/myApplication/log/myApp_20030807_1711 93 opt/myApplication/log/myApp_20030808_0512 93 Optional 109 Oracle 50, 310 Oracle Database Server 326 Oracle Instant Client 71 Oracle SID 71 Oracle 254, 314 Oracle SQL*Plus connect 71 Oracle\ora92 71 org.objectweb.jonas.naming 205, 221 OS 51, 61, 143, 149, 246, 254, 271, 294, 314, 318, 323, 357 execute 359 OS Command 61, 149, 161, 242, 246, 254, 294, 314, 323, 357, 359 OS command ipconfig/all 149 OS Command Macro 254, 314 OSCommand 353, 370, 372 OSCOMMAND_OSCOMMAND 242, 254, 314 OSCommandColl 359 OS-specific 310 other KMs 24, 113 Other KMs parameters 113 OW2 221 OwnerCheck 335
parameter monitoring 323 Parameter Type 357 PARAMETER_NAME 242 parameters 24, 31, 48, 61, 118, 138, 143, 161, 177, 188, 207, 221, 234, 236, 246, 285, 333, 335, 337, 339, 341, 343, 350, 352, 353, 357, 359, 361, 370, 372
93, 98, 101, 109, 192, 196, 199, 294, 323, 326, 345, 347, 348, 363, 366, 368,
Monitoring 113 Parent ID 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Parent Type 353, 357, 370, 372 PARENT_ID 242, 254, 314 PARENT_LABEL 242, 254, 294, 314 Password 31, 53, 61, 71, 161, 169, 177, 196, 199, 205, 207, 214, 221, 228 Paste 286, 326, 333, 341, 343, 345, 353, 359, 366, 372 paste everything 286 PATH 71, 310 PathName 311 Paths 53, 61, 71, 93, 109, 205, 207, 221, 228, 258, 261, 291, 310, 311, 333, 339, 345 Java PATROL 101, 113, 271, 288, 337, 339, 353, 357, 199 11, 12, 13, 14, 24, 25, 48, 51, 98, 188, 192, 234, 236, 246, 258, 261, 291, 294, 307, 323, 326, 333, 335, 341, 343, 345, 347, 348, 350, 352, 359, 361, 366, 368, 370, 372
-PPackages 13, 23, 71, 205, 207, 221 Page fault/sec 361 Page fault/secs 361 Pagefile 361 PageFileBytes 361 PAR file 31
Knowledge Modules 11 PATROL Agent 11, 14, 25, 31, 61, 71, 101, 138, 234, 258, 261, 271, 307, 370 PATROL Central 11, 12, 14, 24 PATROL Central Operator 12, 24 PATROL Classic 14 PATROL Classic Consoles 14 PATROL Configuration Manager 25, 234 PATROL Console 11, 12, 24, 48, 51, 98, 101, 109, 113, 188, 192, 199, 271, 288, 291, 294, 307 PATROL Console Web-edition 12 PATROL ID 149, 254, 314 PATROL MIB 246 PATROL Object 101, 113, 161, 188, 254, 314 PATROL Object ID 101 PATROL Object Label 101, 113, 161 Patrol_Home%\bin 214 PATROL_HOME%\config 258 Patrol_Home%\Patrol3\bin 214
Index
383

Version 8.6.53
Pause monitoring 288 Pause monitoringTemporarily_suspend_the_monitoring _of_an_object 335 Pauses 271, 288, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 PCM 25, 234 PCM/Event Management 234 pconfig 258 PendingCustomers 71 Performance 11, 14, 31, 51, 61, 93, 98, 118, 138, 143, 183, 192, 196, 214, 236, 276, 350, 363, 368 performance defined 188 Performance Manager 11, 14, 31, 51, 61, 93, 98, 118, 138, 183, 192, 196, 236, 368 Performance Manager Integration 31 performance objects 188, 350 PERFORMANCE_INSTANCELIST 242, 254, 314 PERFORMANCE_PERFORMANCE 242, 254, 314 Perl.exe 14 PERPETUAL_LICENSE 149 PID 61, 310, 361 Place 31, 113, 228, 363 Platform 169, 177, 196, 214, 228, 310 Platform MBean Servers 196 PM Portal 31 Poll WebLogic 8.x 228 Polling 50, 98, 113, 188, 192, 205, 236, 270, 271, 289, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 359, 361, 363, 366 Polling Interval 101, 271, 311, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 359, 361, 366 Polling Macros 254, 314 Popup 53 Port 14, 132, 270, 271, 345, 366 POST 169, 177, 254, 314 Preloading 25, 234 Preprocessing text 149 Previous versions 11, 236 Principle 149, 196, 199, 205, 207, 214, 221, 228 PrivateBystes 361 PrivateBytes 125, 361 ProactiveNet 35, 36
Process 24, 31, 61, 93, 109, 118, 125, 149, 161, 169, 177, 188, 254, 261, 266, 271, 307, 310, 311, 314, 320, 323, 363, 368 Alert Actions 361 in/under 286 Process Command Lines 310 Process monitoring 9, 323, 361, 363 Process monitoring object 125, 286, 361 Process Names 310 process scommand 310 Process User IDs AND 125 ID 125 Process Viewer 266, 363 Process viewer tool 266 PROCESS_NAME 242, 254, 314 ProcessorTime 125, 361 ProColl 361, 363 Protocol 199, 205, 221, 271 Proxy1401.getDefaultUserRole 297 ps 310 PSL 98, 125, 246 PW Commands 45
-QQuery 24, 50, 71, 118, 143, 161, 165, 169, 177, 196, 254, 311, 314, 326, 345, 353 Query timeout 71 QueryStatus 161, 326, 353
-RReal-time 271, 363 Recordset 326 Redhat 205 RedHat Linux 12 Reference 31, 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 161, 169, 177, 183, 188, 192, 199, 207, 214, 221, 228, 236, 254, 314 Reference Guide 61, 71, 93, 98, 101, 109, 113, 118, 125, 138, 143, 161, 169, 177, 183, 188, 192, 199, 207, 214, 221, 228, 236 Refresh 31, 51, 118, 266, 276, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 359, 361, 366, 368 Refresh PATROL Integration 31 RegExp 291, 320
Index
384

Version 8.6.53
Regular expression 61, 118, 125, 149, 254, 291, 314, 320, 357, 370 Remote Management 196 Rename 267, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Rename monitored object 267 ReplicaAwareRemoteRef.java 297 Report 278, 280 RequestDispatcherImpl.java 297 Requirements 12, 236 Requires Sun JVM 1.5 214 Rescaling 118, 132 Reset 138, 143, 285, 348, 368 Resource-intensive 271, 276 Result 14, 98, 109, 113, 188, 192, 199, 270 Resume monitoring 288 Resume monitoringTemporarily_suspend_the_monitoring _of_an_object 335 Resumes 271, 288, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 366, 368, 370, 372 Retrieve 93, 125, 161, 169, 177, 297, 311, 320 ReturnOutput 326, 341, 353, 359 RMI 199 root\cimv2 353 rror 320 Run 11, 48, 50, 53, 61, 71, 93, 101, 113, 118, 138, 143, 149, 169, 177, 183, 192, 196, 207, 228, 236, 242, 246, 266, 270, 271, 290, 307, 310, 311, 348, 359, 366, 368, 370 Alert Actions WMI 161 Run Alert Actions rwxr-xr-x 101 294 348, 368, 370
Security
11, 14, 24, 93, 205, 285, 333, 335
access rights 101 sed commands 320 Select 14, 24, 93, 98, 101, 109, 118, 188, 192, 199, 207, 221, 234, 236, 258, 261, 271, 276, 288, 289, 291, 294, 307, 320, 339, 350, 357, 366 In order 113, 143 Select Common services 14 Select Console Systems 14 Select Convert XML 149 Sentry 11, 13, 48, 307 Sentry Installation Packages 13 Sentry Software 13, 307 Sentry Software website 31, 214 Server V6.1 214 Server V6.1 delivers 214 ServerConnectionState 341 Servers 24, 50, 71, 98, 125, 169, 177, 183, 188, 192, 196, 199, 205, 207, 214, 221, 228, 254, 310, 311, 314, 323, 326, 341, 343, 345 Service 14, 24, 169, 177, 188, 192, 196, 271, 352 ServletRequestImpl.java 297 ServletStubImpl.java 297 Set 25, 48, 93, 98, 101, 109, 113, 118, 125, 169, 177, 188, 192, 199, 207, 221, 234, 236, 246, 271, 294, 310, 320, 323, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370 Set Alert 61, 71, 93, 98, 109, 113, 118, 125, 177, 183, 188, 192, 199, 207, 221, 234, 236, 294, 335, 353 Set Alert Actions 236, 294 Set Alert ActionsAlert_Actions_description 335 Set Global Alert Actions 242 Set Thresholds 71, 93, 98, 101, 109, 113, 138, 161, 169, 177, 183, 188, 192, 199, 207, 221, 228, 234, 240, 294, 353 Setting username/password 242 Setting Alert Actions 242, 294 Setting polling intervals 271 Setup 14, 48, 53, 161, 196, 236, 242, 270, 271, 286 Extracting Setup files 23
-SSample Properties Win32_Service class 311 Save 98, 101, 113, 188, 192, 258, 261 Scale 113, 188, 347, 350 Schedule a Configuration Report 278, 280 Search 24, 50, 61, 71, 93, 101, 118, 125, 138, 143, 149, 161, 183, 196, 199, 207, 214, 221, 228, 236, 254, 271, 286, 294, 314, 320, 326, 333, 341, 343, 345, 348, 353, 359, 366, 370, 372 Number 357 traps matching 368
Extracting 23 Setup.exe 14 Setup.sh 14 sev>ERROR</sev 297
Index
385

Version 8.6.53
SGID 101 Signature 53, 323, 363 Simple Network Management Protocol 366 Size 50, 93, 98, 109, 125, 307, 333, 337, 339, 361 Skip 289, 357 SNMP 50, 138, 236, 246, 270, 271, 366, 368 Enterprise ID 368 IP address 368 listening 138 matching 138 Number 368 String 366 Value 366 SNMP agent 50, 132, 138, 143, 254, 270, 314, 366, 368 SNMP Browser 270 SNMP Browser tool 270, 363 SNMP Polling 132, 366 SNMP Table OID 132 SNMP Trap Listener 138, 271, 363 SNMP Trap Listener tool 271 SNMP Trap listening 271, 368 SNMP Trap listening icon 138 SNMP Trap listening object 271, 368 SNMP Trap Macros 254, 314 SNMP trap monitoring 138 SNMP Traps 53, 236, 246, 271, 323, 363, 368 CityEnt 138 SNMP traps/Windows events 285 SNMP traps/Windows events > Acknowledge all and reset 285 SNMPPOLLING_COMMUNITY 242, 254, 314 SNMPPOLLING_OID 242, 254, 314 SNMPPollingColl 366 SNMPTRAP_COMMUNITY 242 SNMPTRAP_ENTERPRISEID 242, 254, 314 SNMPTRAP_FOUNDTRAPNUMBER 242, 254, 314 SNMPtrapColl 368 SOA 214 SOAP Port 205, 214 Software 14, 50, 183, 188, 214, 234 Software Web site 13 Solaris 12 Source 50, 118, 138, 143, 149, 221, 276, 348, 368 Source IP 138, 368 Split
file 258 SQL 326 SQL Query 326 SQL Server 71, 183 Start 14, 234, 236, 267, 271, 289, 290, 307, 333, 352, 368 Start Install 14 Starting v8.5 271 Start--Stop button clicking 53 State7 138 StateOm 318 StateState7 214, 258 StateStateEnterprise StateID 138 StateStateJBoss StateAS 207 StateStateWebSphere StateAS 214 Status 50, 192, 288, 335, 341, 352, 359, 366 Stderr 61 Stdout 61 Step 2-a 169 Step 2-b 169 Step 3-b 169 Step3 261 Stop 53, 61, 93, 271, 290, 311, 323, 352 String 161, 370 String search.See 93 STRING_LAST_MATCHING_LINE 242, 254, 314 Strings 24, 61, 71, 93, 101, 118, 138, 143, 149, 161, 177, 183, 196, 199, 207, 214, 221, 228, 236, 246, 254, 271, 276, 285, 286, 289, 294, 314, 318, 320, 326, 333, 341, 343, 345, 353, 357, 359, 366, 368, 370, 372 Sub-applications 258 Sub-container 53, 323 subfolder 23 Subfolders 339 SUID 101 Support 11, 12, 31, 53, 71, 161, 169, 177, 183, 234, 258, 307, 311, 320, 363 SUSE Linux 12, 207 SW 24 SW_ 228 SW_APPLICARIONS 24 SW_APPLICATION 53 SW_APPLICATIONS 323 SW_DB_QUERIES 24, 326 SW_EventLogReader.exe 363 SW_FILE_SECURITY 24, 335 SW_FILES 24, 333
Index
386

Version 8.6.53
SW_FILESYSTEMS 337 SW_FOLDERS 24, 339 SW_HTTP_REQUESTS 24, 169, 341 SW_HTTP_REQUESTS class 169 SW_HTTP_WEBFARM 24, 343 SW_JMX 24, 199, 207, 221, 345 SW_KMWATCH 24, 347 SW_NT_WMI 24, 353 SW_NTEVENTS 24, 348 SW_NTPERFORMANCE 350 SW_NTSERVICES 352 SW_NUMBERS 24, 357, 359, 366 SW_OSCOMMANDS 24, 359 SW_Process class 271 SW_PROCESSES 24, 361 SW_SENTRY 24, 363 SW_sentry_ServiceInfo.exe 363 SW_SENTRY8.kml 11, 24, 25 SW_SNMP_POLIING 24 SW_SNMP_POLLING 366 SW_SNMP_TRAPS 24, 368 SW_ST 24 SW_STRINGS 359, 366, 370 SW_Transform 24, 372 SW_wl8x_wlclient.jar 228 SW_wl9x_weblogic.jar 228 Swsy_ntx86_8401.exe 13, 23 swsy_ntx86_8500.exe 23 Windows-based Swsy_unix_8401.tar swsy_unix_8500.tar 13 13, 23
Text 24, 101, 271, 294, 320, 326, 333, 341, 343, 345, 353, 357, 359 Lines matching 372 names contain 125 Text Preprocessing 93, 143, 149, 271, 326, 333, 341, 343, 345, 353, 359, 372 Text Preprocessing object 372 Text Preprocessing step 149 Text Transform 149 Text Transform objects 149 Text Transform tool 149 Thorium 13 ThreadCount 361 Threshold 31, 50, 61, 93, 98, 101, 109, 113, 138, 143, 161, 169, 177, 188, 192, 199, 207, 221, 228, 234, 236, 294, 326, 333, 337, 339, 341, 345, 347, 348, 350, 352, 353, 357, 359, 361, 363, 366, 368, 370 number breaches 118 Threshold Management 149, 234, 236, 363 Threshold Type 234, 236 Thresholds Customize 45 Import 45 TIME 318 Timeout 61, 71, 138, 143, 169, 177, 183, 199, 207, 214, 221, 228, 345, 348, 359, 368, 370 TNS_ADMIN 71 tnsnames.ora file 71 Transaction Server 228 TransformResult 149, 297, 372 Trap listening 53 Trap/min 368 Traps 24, 50, 53, 138, 254, 271, 314 varBind 368 Trig 61, 143 Trigger 51, 93, 98, 101, 109, 113, 118, 188, 192, 199, 207, 221, 234, 236, 246, 285, 294, 348 Alarm 236 Warning 236 Trigger Information 236 TrustStore password 205, 214 TrustStoreFile path 205, 214 Tuning 234 txt myFiles?log file 109 Types 11, 93, 101, 109, 113, 118, 125, 143, 149, 169, 177, 183, 188, 196, 234, 236, 246, 254, 261, 311, 314, 345, 353, 357, 361, 366, 370, 372
UNIX 13 swsy_WINDOWS_<version number>.exe 23 swsy_WINDOWS_8500.exe 13, 23 sysApp 71 System 11, 12, 13, 14, 24, 51, 98, 101, 113, 188, 192, 271, 307, 310, 320, 337 System monitoring 98, 337 System Output Window 11, 307
-TTargeted computers 11 Temporarily 288 Temporarily suspend 288 Temporarily suspend the monitoring of an object 288
Index
387

Version 8.6.53
-UUDP/162 handling 271 Unable 31 Uncheck 118, 143 Uninstall 11 Unique Separator 357 UNIX 12, 14, 24, 71, 101, 169, 177, 271, 310, 320, 363 swsy_unix_8500.tar 13 UNIX/Linux 23, 25, 98 Update 11, 12, 93, 266, 270, 276, 285, 291, 335 URL 205, 207, 221 urlToQuery.php 169, 177 UsedSpaceGrowthPercent 98 UsedSpaceGrowthPercentage 98, 337 UsedSpaceGrowthSpeed 98, 337 User 31, 48, 53, 61, 101, 161, 169, 177, 234, 236, 285, 290, 310, 345, 353 UserBean_3_0.java 297 Username 61, 199, 205, 207, 221, 276, 359 Username/Password 246 Using ManagementFactory 196 Using MBean ServerConnection 196
VirtualBytes 361 VMWare ESX Host
12
-WWait 25, 71, 118, 138 368 SNMP Traps Warning Trigger 236 WBEM 165, 355 Web 11, 13, 14, 320, 341, 343 application provides 50 Web Edition 11, 14, 24 Web farm monitoring 169, 343 Web Request 118, 143, 149, 177, 341, 343, 363 Web Request analysis 177 Web Request monitoring 177, 341, 343 Web Server Authentication 169, 177 Web Site 13 Web-Based CityplaceEnterprise Management 161, 311 Web-based GUI 196 Web-farm 169, 323, 343, 363 Web-farm monitoring 169, 343 Weblogic 228, 345 WebLogic 8.x 205, 228 WebLogic 9.x 205, 228 WebLogic application 205, 228 WebLogic Communication Platform 228 WebLogic JAR files/zipped files 228 WebLogic monitoring 228 WebLogic Server 228 WebLogic v8.x 228 WebLogic v9.x 228 weblogic.jndi.WLInitialContextFactory 205, 228 weblogic.kernel.ExecuteThread.execute 297 weblogic.rmi.internal.BasicServerRef.handleRequ est 297 weblogic.rmi.internal.ServerRequest.sendOneWa yRaw 297 weblogic.servlet.internal.TailFilter.doFilter 297 WebLogic9.x 228 Websphere 205, 214 WebSphere for 205, 214 WHERE 311 WHERE TargetInstance ISA 311 Wildcard 53, 93, 109, 138, 297, 311, 333 Win32 311
-VV6.1 214 Value 24, 51, 98, 109, 113, 188, 199, 236, 246, 270, 271, 326, 333, 335, 337, 339, 341, 343, 345, 347, 348, 350, 352, 353, 357, 359, 361, 368, 370 SNMP 366 Value Type 350 valueA&varB 169, 177 valueB 169, 177 Values Extraction 149 VarBind trap 368 Varbinds 138, 271 VBS 61 VBScript 61 View 31, 125, 138, 183, 196, 236, 271, 276, 291, 311 View File 291 View the content of a file 291
Index
388

Version 8.6.53
Win32_ComputerSystem 311 Win32_LogicalDrive class 311 Win32_Process 311 Windows 12, 14, 23, 24, 25, 50, 53, 61, 71, 98, 101, 125, 143, 149, 161, 169, 177, 183, 188, 192, 207, 228, 254, 261, 266, 271, 276, 290, 310, 311, 314, 323, 348, 350, 352, 359, 361, 363 Windows Agents 169, 177, 363 Windows Create 183 Windows Event ID 183 Windows Event log 24, 183, 254, 314 Windows Event matches 183 Windows Event monitoring 276, 323, 348 Windows Event monitoring object 183, 348 Windows Event Types 183 Windows EventLog 183, 276, 363 Windows EventLog monitoring 363 Windows EventLog Reader 183, 276, 363 Windows EventLog Reader tool 183, 276, 363 Windows EventLogs 348 Windows Events 24, 276, 323 Acknowledging 348 Windows Management Instrumentation 161, 311 Windows NT/2000/2003 188 Windows NT4 12 Windows operating systems 161, 311 Windows Performance 24, 188, 254, 314, 323, 350, 359, 361, 363 Windows Performance monitoring 188, 350, 359, 361 Windows Services 192, 323, 352 Windows services monitoring 50, 192, 323, 352 Windows Task Manager 125, 310 Windows Windows/2000 350 Windows XP 14 WINDOWS\system32\svchost.exe 311 Windows_BASE.kml 25 Windows_PERFMON_WIZARD.kml 25 Windows-based 12 swsy_ntx86_8500.exe winlog.exe process 271 WITHIN 30 311 WMI 24, 353 query 161 WMI Administrative WMI namespace enter 161 13
WMI query 161, 254, 311, 314, 323, 353, 363 WMI query monitoring 161, 353 WMI Request 353 WMI Scripting Library 161, 311 WMI_HOST 254, 314 WMI_NAME_SPACE 254, 314 WMI_RETURN_OUTPUT 254, 314 WMI_USERNAME 254, 314 WMI-managed 311 WMIQueryColl 353 WML/HTTP.Applications 196 Workaround 31 WorkingSet 125, 361 worstParam 254, 314 WPCONFIG.EXE 25 www.bmc.com/support_home 00d0c9ea79f9bace118c8200aa004ba90b0200000 0030000 31 www.hotmail.com 169, 177
-Xxf ins_ALL_<version number>.tar 23 xf ins_ALL_7552.tar 23 xf swsy_UNIX_<version number>.tar 23 xf swsy_unix_8500.tar 23 XML 24, 48, 93, 143, 149 corresponding XML tag 297
new 297 XML-to-CSV pre-processing object XP 12 Xpconfig 25 xxx 320 x-y 118, 143 xyz 320
297
161, 311
Index
389
204102
About BMC Software

BMC Software, Inc. NYSE:BMC, is a leading provider of enterprise management solutions that empower companies to manage their IT infrastructure from a business perspective. Delivering Business Service Management, BMC Software solutions span enterprise systems, applications, databases, and service management. Founded in 1980, BMC Software has offices worldwide and fiscal 2004 revenues of more than $1.4 billion. For more information about BMC
About Sentry Software

Sentry Software, a strategic Technology Alliance Partner of BMC Software, provides key monitoring solutions specifically designed to expand the capabilities of BMC Performance Manager, thus enabling up to 100% coverage of any infrastructure. Sentry Software specializes in single solutions for multiplatform monitoring of hardware, custom applications or any IT component, and blackout windows. Sentry Software products are deployed in 45 countries across the globe and lead the list of BMC Softwares third-party product sales. For more

Monitoring Studio KM For PATROL 8.6.53

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Monitoring Studio KM For PATROL 8.6.53

Uploaded by

Copyright:

Available Formats

Monitoring Studio KM for PATROL