User Documentation May 2011
Monitoring Studio KMfor PATROL
Version 8.6.53
Contacting BMC SoftwareYou can access the BMC Software Web site at http://www.bmc.com/. From this Web site, you can obtaininformation 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 77042-2827
Telephone (01) 713 918 8800
Telephone 713 918 8800 or 800 841 2031
Fax (01) 713 918 8000
Fax 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 areregistered 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 ortrademarks 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 LicenseAgreement for the product and the proprietary and restricted rights notices included in thisdocumentation.
Restricted Rights Legend
U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDERTHE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data andcomputer software by the U.S. Government is subject to restrictions, as applicable, set forth in FARSection 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC Software, Inc., 2101CityWest Blvd., Houston, TX 77042-2827, USA. Any contract notices should be sent to this address.
2
Version 8.6.53
Monitoring Studio KM for PATROL
You can obtain technical support by using the Support page on the BMC Software Web site or bycontacting Customer Support by telephone or e-mail. To expedite your inquiry, please see "BeforeContacting 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-mailaddresses, 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, call800 537 1813. Outside the United States and Canada, please contact your local support center forassistance. To find telephone and email contact information for the BMC Software support center thatservices your location, refer to the Contact Customer Support section of the Support page on the BMCSoftware 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 canbegin 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, andservice 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"
3
Monitoring Studio KM for PATROL
Version 8.6.53
Table of Contents 4
Monitoring Studio KM for PATROL
Version 8.6.53
Table of Contents...........................................................................................................................11Targeted Computers
...........................................................................................................................11Migrating from Previous Versions of Monitoring Studio
...........................................................................................................................12Requirements
...........................................................................................................................13Installation Packages
...........................................................................................................................14Installing Monitoring Studio KM for PATROL
...........................................................................................................................14Getting the BMC Software Installation utility
...........................................................................................................................14Installation Procedure
..................................................................................................................23Extracting the Setup Files
..................................................................................................................24Loading Monitoring Studio KM for PATROL
..................................................................................................................25Preloading Monitoring Studio
...........................................................................................................................26Uninstalling BMC Performance Manager Monitoring Studio
...........................................................................................................................36Creating and Importing an Adapter for a BMC PATROL KM
...........................................................................................................................44Updating an Adapter for a BMC PATROL KM
...........................................................................................................................45Importing and Customizing Thresholds
...........................................................................................................................48Monitoring with Monitoring Studio
...........................................................................................................................50Configuring Monitoring Studio to Monitor your Application
...........................................................................................................................51Day-to-day monitoring with Monitoring Studio
...........................................................................................................................53Monitoring Features
...........................................................................................................................53Application/Container Icons
...........................................................................................................................61Command Line Analysis
...........................................................................................................................7 1Database Query Analysis
..................................................................................................................7 6Setting connection to Microsoft SQL Server Databases
..................................................................................................................80Setting connection to MySQL Server Databases
..................................................................................................................83Setting connection to Oracle Database Server
..................................................................................................................87Setting connection to Other Databases (ODBC only)
...........................................................................................................................88Dynamic Object Builder
...........................................................................................................................93File Monitoring and Analysis
...........................................................................................................................98File System Monitoring
...........................................................................................................................101File Security Check
...........................................................................................................................109Folder Monitoring
...........................................................................................................................113Multi-Parameter Formula
...........................................................................................................................118Numeric Value Extraction
Table of Contents 5
Monitoring Studio KM for PATROL
Version 8.6.53
...........................................................................................................................125Process Monitoring
...........................................................................................................................132SNMP Polling
...........................................................................................................................138SNMP Trap Listening
...........................................................................................................................143String Search
...........................................................................................................................149Text Pre-Processing
...........................................................................................................................161WMI Query Analysis
...........................................................................................................................165WBEM Query Analysis
...........................................................................................................................169Web-farm Monitoring
...........................................................................................................................17 7Web Request Analysis
...........................................................................................................................183Windows Event Monitoring
...........................................................................................................................188Windows Performance Monitoring
...........................................................................................................................192Windows Service Monitoring
...........................................................................................................................196JMX
..................................................................................................................196Java MBean Polling (JMX)
..................................................................................................................199Generic JMX Client
..................................................................................................................205Input variables for JMX polling Wizards
..................................................................................................................207JBoss
..................................................................................................................214WebSphere
..................................................................................................................221JOnAS
..................................................................................................................228WebLogic
...........................................................................................................................234Thresholds and Alert Actions
...........................................................................................................................234Managing Thresholds
...........................................................................................................................236Setting or Modifying Alert Thresholds
...........................................................................................................................240Setting Thresholds on Dynamic Numeric Value Extractions
...........................................................................................................................242Alert Actions Description
...........................................................................................................................246Alert Actions Capabilities
...........................................................................................................................254Alert Action Macros
...........................................................................................................................258Administration Features
...........................................................................................................................258Exporting Configuration to a File
...........................................................................................................................261Importing Configuration
...........................................................................................................................266Process Viewer Tool
...........................................................................................................................267Modifying Object Name and/or ID
...........................................................................................................................269Process Command Credentials
...........................................................................................................................27 0SNMP Browser Tool
...........................................................................................................................27 1SNMP Trap Listener Tool
...........................................................................................................................27 1Setting Polling Interval
Table of Contents 6
Monitoring Studio KM for PATROL
Version 8.6.53
...........................................................................................................................27 3Java Settings
...........................................................................................................................27 6Windows EventLog Reader Tool
...........................................................................................................................27 7Setting the Discovery Interval
...........................................................................................................................27 7Trigger a KM Discovery
...........................................................................................................................27 8Monitoring Studio Configuration Reports
..................................................................................................................27 8Instant Configuration Reports
..................................................................................................................280Scheduling Configuration Reports
...........................................................................................................................285Operator Day-to-Day Tasks
...........................................................................................................................285Acknowledge and Update
...........................................................................................................................285Acknowledge all and Reset
...........................................................................................................................285Acknowledge Alerts
...........................................................................................................................286Copy, Cut and Paste
...........................................................................................................................287Delete a Monitored Object
...........................................................................................................................288Pause the Monitoring of an Object
...........................................................................................................................288Rename an Object
...........................................................................................................................289Restart Scan from the Beginning of the File
...........................................................................................................................290Restart an Application
...........................................................................................................................290Stop an Application
...........................................................................................................................291View the Content of a File
...........................................................................................................................294Alert Actions Example
...........................................................................................................................297XML LOG File Parsing
...........................................................................................................................307Enabling the Debug Mode
...........................................................................................................................310About Processes
...........................................................................................................................311About WMI
...........................................................................................................................314Alert Actions Macros
...........................................................................................................................318Format Symbols for %{ASCTIME:…} Macros
...........................................................................................................................320Regular Expressions
...........................................................................................................................321Application Classes
...........................................................................................................................321List of Application Classes
...........................................................................................................................323SW_APPLICATIONS
...........................................................................................................................326SW_DB_QUERIES
...........................................................................................................................328SW_DYNAMIC
...........................................................................................................................329SW_DYNAMIC_CONTAINER
...........................................................................................................................330SW_DYNAMIC_DISCOVERY
...........................................................................................................................331SW_DYNAMIC_NUMBERS
...........................................................................................................................332SW_DYNAMIC_STRINGS
Table of Contents 7
Monitoring Studio KM for PATROL
Version 8.6.53
...........................................................................................................................333SW_FILES
...........................................................................................................................335SW_FILE_SECURITY
...........................................................................................................................337SW_FILESYSTEMS
...........................................................................................................................339SW_FOLDERS
...........................................................................................................................341SW_HTTP_REQUESTS
...........................................................................................................................343SW_HTTP_WEBFARM
...........................................................................................................................345SW_JMX
...........................................................................................................................347SW_KMWATCH
...........................................................................................................................348SW_NTEVENTS
...........................................................................................................................350SW_NTPERFORMANCE
...........................................................................................................................352SW_NTSERVICES
...........................................................................................................................353SW_NT_WMI
...........................................................................................................................355SW_WBEM
...........................................................................................................................357SW_NUMBERS
...........................................................................................................................359SW_OSCOMMANDS
...........................................................................................................................361SW_PROCESSES
...........................................................................................................................363SW_SENTRY
...........................................................................................................................366SW_SNMP_POLLING
...........................................................................................................................368SW_SNMP_TRAPS
...........................................................................................................................37 0SW_STRINGS
...........................................................................................................................37 2SW_TRANSFORM
Release Notes for v8.6.53
9
Monitoring Studio KM for PATROL
Version 8.6.53
This section describes changes and updates that have occurred since the release 8.6.52 of MonitoringStudio KM for PATROL.
What's NewFull support for BMC ProactiveNet Performance Management (BPPM 8.5): Monitoring StudioKM for PATROL now fully and natively integrates with the latest iteration of BMC's monitoringframework. It includes the required metadata that describe the classes and parameters for accurateinterpretation, correlation and trending in ProactiveNet.
Changes and ImprovementsWindow Service Monitoring: It is now possible to manually enter the name of a service tomonitor allowing the possibility to configure a Service monitoring even if the service is not currentlyinstalled on the server (for deployed configurations).
Process Monitoring: The KM commands now retrieves the entire process command-line and is nolonger limited to the first 2048 characters.
Fixed IssuesMonitoring Studio would show invalid service display names in the New Windows Service Wizard onWindows 7 and Windows 2008 servers.
The ASCII filter used by Monitoring Studio did not take Asian characters into account preventingPATROL IDs to be properly displayed.
Dynamic Numbers or Dynamics Strings: A problem occurred when two or more dynamiccontainers with dynamic string/number templates were configured. Every time a dynamic discoverywas performed, the dynamic string/number instances were updated. Instead of simply destroyingall missing instances related to one dynamic container, the running discovery also destroyed anyinstances that were not related to the current container running the discovery thus resulting indynamic string/number instances clipping.
The product could not perform SQL queries to an Oracle database on Windows anymore (invalidusername/password message)
The new Java polling method introduced in v.8.6.50 for optimization purposes was not compatiblewith special characters.
Monitoring Studio would show the Exit Status in the ReturnOuput parameter of the OS if thecommand output was empty.
Known IssueOracle Database: Space characters are not supported for passwords in Windows, thus, whenworking with this operation system, you must enter a space-free password to access an OracleDatabase.
Installation Guide
11
Monitoring Studio KM for PATROL
Version 8.6.53
Introduction
This section provides detailed information about the pre-requisites for the installation of MonitoringStudio. It helps you understand what you need to install and where (on which components of your ITinfrastructure) 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 followingcomponents 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 ofMonitoring Studio
Monitoring Studio is the new name assigned to Application Sentry KM for PATROL. Previous versions ofMonitoring 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 ofMonitoring 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 Studiowill take the action necessary to complete the migration (migrating configuration variables if needed).
Automatic migration is only supported f rom 8.x versions of Monitoring Studio. Earlie r v ersions are no longersupported.
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 PATROLAgents, each with different versions of Monitoring Studio. This version of Monitoring Studio supersedesprevious 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.
12Migrating from Previous Versions of MonitoringStudio
Monitoring Studio KM for PATROL
Version 8.6.53
However, you do need to update the console profiles to include the new Monitoring Studio classes. Toachieve 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 afile.
Avoid the use of the "Deve loper" connection type in the PATROL Console . It is even more important that you neveruse the "Commit KMs" feature of the PATROL Console , especia lly when you dea l with severa l v ersions of the sameKM in your 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, previousversions of Monitoring Studio (formerly known as Application Sentry) will not be able to execute thesenew Menu Commands. In such case, an error message will be displayed in the System Output Windowof 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 caninstall the current version of Monitoring Studio and earlier versions side-by-side on the same ConsoleServer. Console Server will automatically use the appropriate version of the KM depending on what isrunning on the displayed agent. However, you still need to update the console profiles to include thenew 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 touse 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.
13Requirements
Monitoring Studio KM for PATROL
Version 8.6.53
Requirements for console systems
BMC Software PATROL Console
PATROL Central Operator
PATROL Console Web-edition
Monitoring Studio InstallationPackages
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. TheInstallation 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 packagedownload 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 MonitoringStudio KM for PATROL product page on the Sentry Software Web site at www.sentrysoftware.net.
14Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
Installing Monitoring Studio KM forPATROL
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 byMonitoring Studio.
Although not covered by this section, installation through the Distribution Server is fully supported aswell. Please refer to the Distribution Server documentation on the BMC website for a detaileddescription of the procedure.
See Also
Installation BasicsInstalling Monitoring Studio KM for PATROLTargeted Computers
Getting the BMC Software Installation UtilityIn 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 MonitoringStudio:
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
2. Place the Installation Utility package in the same folder as the Monitoring Studio package
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 thenecessary steps to properly install Monitoring Studio and all files associated with it. You are simplyprompt for the product's folder location and the product/components to install. Browse to the
15Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
bmc_products folder where the files have been extracted (both Monitoring Studio and the CommonInstaller).
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 PATROL1. The welcome screen of the installer appears. Click Next to continue.
Insta lla t ion W iza rd - Ste p 1: W e lcom e
16Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
2. Read the license agreement, click the Accept option and then click Next to continue.
Insta lla t ion W iza rd - Ste p 2: Re v ie wing Lice nce A gre e m e nt
3. Select Install the products on this computer now and click Next to continue.
Insta lla t ion W iza rd - Ste p 3: Se le ct ing Insta lla t ion Options
17Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
The activ e part of Monitoring Studio resides on the PATROL Agent, therefore: A PATROL Agent must be insta lledon each server that needs monitoring; Monitoring Studio KM for PATROL must be insta lled on each PATROLAgent. Please refer to the Monitoring Studio KM for PATROL – Insta lla t ion Guide for further deta ils on theinsta lla t ion procedure.
4. Specify the BMC Software products folder. See the BMC Software documentation for moreinformation about the BMC Software products folder. Click Next to continue.
Insta lla t ion W iza rd - Ste p 4: Se le ct ing the Insta lla t ion Dire ctory
18Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
5. Select Default. Installing Monitoring Studio does not require any customization. Click Next tocontinue.
Insta lla t ion W iza rd - Ste p 5: Se le ct ing a n Insta lla t ion Ty pe
19Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
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.
Insta lla t ion W iza rd - Ste p 6: Se le ct ing Role s
Se lect as many options at required.
20Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
7. Check the Monitoring Sentry KM for PATROL box to install the KM (it should be selected bydefault). Click Next to continue.
Insta lla t ion W iza rd - Ste p 7: Se le ct ing Products a nd Com pone nts
8. Review the installation parameters and click Start Install to launch the installation procedure.
21Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
Insta lla t ion W iza rd - Ste p 8: Re v ie wing Insta lla t ion Options
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.
Insta lla t ion W iza rd - Ste p 9 Insta lla t ion Sta tus
22Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
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 toexit the setup program.
Insta lla t ion W iza rd - Ste p 10: Insta lla t ion Re sults
11. Click the Finish button to quit the installation wizard.
23Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
Insta lla t ion W iza rd - Ste p 11: Com ple t ing a nd clos ing the Insta lla t ion W iza rd
A Help button in ava ilable at each step of the procedure. C lick to display the insta lla t ion online he lp. The Ex it buttona llows you to stop the insta lla t ion procedure.
Extracting the Setup Files
On Windows
The packages for Windows can simply be extracted by double-clicking the following files in aconsecutive order:
1. BMC Installation Utililty: ins_WINDOWS_<version number>.exe
2. 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. BMC Installation Utililty: tar xf ins_ALL_<version number>.tar
2. Monitoring Studio for PATROL: tar xf swsy_UNIX_8653.tar
The files are extracted in a sub-directory named bmc_products.
24Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
Loading the Monitoring Studio KMPrior to using Monitoring Studio KM for PATROL you must load the Knowledge Modules (KMs) on thePATROL Console. Follow the steps below to load Monitoring Studio KM for PATROL:
Loading the KM on PATROL Console for Windows or on PATROLConsole for UNIX
1. Select File > Load KM in the PATROL Console menu
2. 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 MonitoringStudio 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 KMfor 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 andConsole:
Classes Description
SW_APPLICATIONS Monitors application/container icons
SW_DB_QUERIES Executes and monitors database queries
SW_FILES Monitors files and file content
SW_FILE_SECURITY Monitors file security
SW_ FILESYSTEMS Monitors file-systems
SW_FOLDERS Monitors folders
SW_HTTP_REQUESTS Monitors web-based applications, executes HTTP requests
SW_HTTP_WEBFARM Monitors web farms
SW_JMX Polls and monitors JMX-enabled application servers
25Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
Classes Description
SW_KMWATCH Monitors parameters of other KMs
SW_NTEVENTS Monitors Windows Event Logs
SW_ NTPERFORMANCE Monitors Windows Performance
SW_ NTSERVICES Monitors Windows Services
SW_NT_WMI Executes and monitors WMI queries
SW_NUMBERS Enables extracting numeric values
SW_OSCOMMANDS Executes, monitors and parses command lines and scripts
SW_PROCESSES Monitors Processes
SW_SENTRY Main application class
SW_SNMP_POLLING Polls and monitors SNMP agents
SW_SNMP_TRAPS Monitors and listens for SNMP traps
SW_STRINGS Executes string searches
SW_TRANSFORM Transforms complex (multi-line, HTML, XML) text to enable string/numeric valuesearches
Preloading Monitoring StudioFor optimal operation of Monitoring Studio, it is strongly recommended that you configure the PATROLAgent to pre-load the KM. This means that the PATROL Agent will automatically load Monitoring Studioupon startup and will not wait for a console requesting the KM.
This can be done by setting the /AgentSetup/preloadedKMs configuration variable of each PATROLAgent 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 loadedby 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.
26Installing Monitoring Studio KM for PATROL
Monitoring Studio KM for PATROL
Version 8.6.53
kml,SW_SENTRY8.kml
Uninstalling BMC PerformanceManager Monitoring Studio
Uninstalling Monitoring Studio is an automated process managed by a wizard. The wizard goes throughthe necessary steps to remove Monitoring Studio and all files associated with it. You are simply promptfor 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\BMCSoftware, or /opt/bmc):
On Windows systems, launch uninstall.exe
On UNIX, launch uninstall.sh
Un-insta lla t ion W iza rd — W e lcom e Ste p
Ensure that the uninsta ll program is up-to-date. You may need to use the insta lla t ion program from a f reshInsta lla t ion Utility package.
2. Specify the BMC Software products folder. See the BMC Software documentation for moreinformation about the BMC Software products folder.
27Uninstalling BMC Performance ManagerMonitoring Studio
Monitoring Studio KM for PATROL
Version 8.6.53
Un-insta lla t ion W iza rd — Spe cify ing fo lde r
3. To uninstall the KM, select Monitoring Studio KM for PATROL.
Un-insta lla t ion W iza rd — Se le ct ing Products a nd Com pone nts Dire ctory
4. Review your selection and click Start Uninstall to run the un-installation.
28Uninstalling BMC Performance ManagerMonitoring Studio
Monitoring Studio KM for PATROL
Version 8.6.53
Un-insta lla t ion W iza rd — Re v ie wing Se le cte d Products & com pone nts a nd sta rt uninsta lling
5. A page displays the list of products/components processed and the percentage of completion. ClickNext to continue.
Un-insta lla t ion W iza rd — Sta tus
29Uninstalling BMC Performance ManagerMonitoring Studio
Monitoring Studio KM for PATROL
Version 8.6.53
6. A page displaying SUCCESS indicates that Monitoring Studio KM for PATROL is now uninstalled. ClickFinish to quit the wizard.
Un-insta lla t ion W iza rd — Uninsta ll Re sults
Integrating with BMC Portal
31
Monitoring Studio KM for PATROL
Version 8.6.53
Since v8.5.00, an additional component called BMC-PM-PATROL-Monitoring-Studio-8.5.xx.par.zip isreleased with the KM. This is an integration component for the BMC Portal environment in the form of aPAR 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 PortalIntegration available on the Monitoring Studio product page of the Sentry Software website. Theintegration component provided with this release is the same as the one provided with v8.5.00, and isvalid 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 thePATROL Agent for integration into the BMC Performance Manager Portal, so that you can use the Portalto 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 systemsas monitored elements, you can select the parameter threshold values that can be used by theintegration component. After you perform the initial import of threshold values into the Portal, you canupdate the threshold settings from within the Portal and not impact the values set in the BMCPerformance Manager Consoles, PATROL Configuration Manager, or PATROL KM for EventManagement.
During the data process, the Portal matches the application classes and parameters in its BMCPerformance Manager Integration with PATROL component with those in the KM on the agent, and itobtains 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 sameas those in the KM for PATROL. Please refer to the Reference section of this online help for details onthe same.
32
Monitoring Studio KM for PATROL
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. Toremove 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 scientificnotation
It is not possible to have border thresholds in the Portal as opposed to in the KM. The Portal willtranslate border thresholds from the KM into its own system of "greater than"/"lesser than".
How to obtain BMC Performance Manager Integrationwith 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 aknown location on your file system. To install BMC Performance Manager Integration with MonitoringStudio KM for PATROL:
1. Log on to the Portal with administrator credentials, and select the Portal tab.
2. Under Tasks in the navigation pane, select Performance Managers. Click the Import tab.
3. Click Browse to open a file selection dialog box, and select the PAR file. Click Upload.
4. The portal uploads the PAR file to the application server. On the PAR Files page, the PAR file nameand Performance Manager properties appear as Published under PAR Files Currently Loaded.
5. Add Elements and then add the application class to them or add this application class to existingelements, just as you would do for any PM on the Portal.
6. 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 themin the Portal.
33
Monitoring Studio KM for PATROL
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 – thesewill not in any way impact the values set in the PATROL Agent. Also, clicking the Refresh PATROLIntegration 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 MonitoringStudio KM for PATROL as it does for the corresponding BMC Performance Manager Monitoring StudioKM for PATROL.
For more information about the latest Support policies and guidelines, see the Customer Support pageof 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 athttp://www.bmc.com/support_home or visit the BMC Performance Manager Monitoring Studio page onthe Sentry Software website, from where you can download updates as well as all the supportdocuments in PDF format and refer to the online version of the support documents available in theonline technical library.
Integrating with BMC Atrium Orchestrator
35
Monitoring Studio KM for PATROL
Version 8.6.53
OverviewTo 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 da pte r for BM C PA TROL A rchite cture
36Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
Creating and Importing an Adapterfor a BMC PATROL KM
Creating an Adapter for a BMC PATROL KM1. Open the BMC ProactiveNet Administration Console. The BMC ProactiveNet Administration Console
is displayed as shown in the following figure:
A cce ss ing the A dm inistra t ion ta b in the A dm inistra t ion Console
37Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
2. Right-click the Adapters folder and select Import Monitor Type and Add Adapter > BMCPATROL.
Im port ing M onitor Ty pe s a nd A dding A da pte r
38Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
3. In the Configuration tab, enter the required information:
Se tt ing the conne ction pa ra m e te rs
In the Instance Name field, enter a name for this instance of the Adapter that will perform theintegration 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
39Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
4. Click Next to continue
Re v ie wing the Inte gra t ion Se rv ice configura t ion
40Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
5. Click Next to let the system load the BMC PATROL application classes.
Se le ct ing A pplica t ion Cla sse s to im port
6. Select the application classes to import
Unse lect ing will de lete the applicat ion classes that have a lready been imported during a prev ious operation.Applicat ion classes ready to be de leted are marked with a red x .
41Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
7. Click Next to start the import process. The system displays a summary of the application classimport, click Next to continue.
8. Select the application classes you wish to auto-synchronize with the Integration Service Agent.
Se le ct ing A pplica t ion Cla sse s for A uto-sy nc
42Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
9. Click Next to continue
10. Set the Filter details if need.
Se tt ing filte r de ta ils
43Creating and Importing an Adapter for a BMCPATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
11. Click Next to continue.
12. Set the Auto-sync poll scheduling, if needed.
Sche duling A uto-sy nc po lls
13. Click Next to continue. The system displays a summary of your settings, click Finish to confirm. TheAdapter 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 you create a specif ic adapter for each KM you need to integrate into BMC Proactiv eNetto enable the update of a single KM independently .
44Updating an Adapter for a BMC PATROL KM
Monitoring Studio KM for PATROL
Version 8.6.53
Updating an Adapter for a BMCPATROL KM
Updating an Adapter1. Delete the Adapter instance
2. Go through the Add an Adapter wizard to actually delete the monitor types that had been createdbased on the previous version of the KM
3. Close
4. Resume the entire Creating an Adapter for a BMC PATROL KM procedure
For complete and deta iled information on these procedures, please refer to the BMC Proactiv eNet documentationava ilable f rom BMC W eb site .
45Importing and Customizing Thresholds
Monitoring Studio KM for PATROL
Version 8.6.53
Importing and CustomizingThresholds
1. Launch the BMC ProactiveNet PW Commands. On Windows 2008, you need to run the PWCommands as Administrator.
2. Execute the following command line:pw adapter -type patrol -get_thresholds <file name> -pproxy_host <hostname|ipaddress> [-pproxy_port <port_number>] [-pproxy_user <username>] [-pproxy_passwd <password>] -i -v
where
-get_thresholds <file name> = File name with absolute path at which thresholds will be imported
-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 Proxy Server
-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 conversion processes
The command has produced a text file with all the parameter threshold settings.
46Importing and Customizing Thresholds
Monitoring Studio KM for PATROL
Version 8.6.53
3. Open the file in a text editor. Check that the global thresholds have been properly interpreted.
4. Then go to the # INSTANCE LEVEL THRESHOLDS section of the file.
5. Uncomment all instance level thresholds for the _PATROL__SW_ prefixed instances.
Search the f ile for the 'NOT_IMPLEMENTED' occurrences to detect thresholds that were not properly converted bythe PATROL Adapter.
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 default '<Installation Directory>/pw/tmp/' is used
-v enables the Verbose mode
Class-level thresholds can be displayed using the Absolute Global Thresholds panel in the BMCProactiveNet Operator Console, while instance-level thresholds are displayed in the Absolute InstanceThresholds panel:
Thresholds have been successfully imported into BMC ProactiveNet.
Getting Started
48
Monitoring Studio KM for PATROL
Version 8.6.53
Introduction
While out-of-the-box BMC Software monitoring solutions are available for the most commonapplications, 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 thebusiness, was feasible only through a custom PATROL KM. Developing a PATROL KM, although not animpossible task, inevitably involves a lot of programming, project management, release andmaintenance 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 anyapplication, device or IT component for which there is no out-of-the-box monitoring solution available. Italso 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 applicationswithin your BMC Software monitoring environment.
This chapter helps you understand how Monitoring Studio KM for PATROL works and what you can dowith it. It gives you a quick glimpse of the installation and integration process, and a basic guideline onhow 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 remainsessential 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 customapplications 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 administratorscan 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 isto be monitored. Once Monitoring Studio is properly configured, the application/device or IT componentappears 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 ITcomponent
Monitoring Studio provides a graphical user interface that allows PATROL administrators to set up themonitoring 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
49Monitoring with Monitoring Studio
Monitoring Studio KM for PATROL
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 conf iguration of Monitoring Studio is stored in the agent conf iguration tree (under /MASA I/SENTRY8).
50Configuring Monitoring Studio to Monitor yourApplication
Monitoring Studio KM for PATROL
Version 8.6.53
Configuring Monitoring Studio toMonitor 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, wherequeries are queued, etc.)
Files that are critical to your application (to check their presence, size, growth, etc.) as well astheir security settings
Other middleware information provided by other KMs if your application relies on somemiddleware software that can be monitored by specific KMs (Oracle, Tuxedo, MSMQ, etc.)
Other middleware information provided by Windows performance counters if your applicationrelies on middleware software under Windows and provides perfmon data
2. Specify the information sources (where or how can you getinformation 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 usefuldata or procedures that should be tested)
SNMP agents (your application provides information through an SNMP agent that can be polled orthat 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 applicationfailure has been detected:
Decide what kind of Alert Actions are to be taken when an error is detected.
51Day-to-day Monitoring with BMC PerformanceManager Monitoring Studio
Monitoring Studio KM for PATROL
Version 8.6.53
Day-to-day Monitoring with BMCPerformance Manager MonitoringStudio
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 onitoring Studio — Tre 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
User Guide
53
Monitoring Studio KM for PATROL
Version 8.6.53
Introduction
This chapter helps you understand how Monitoring Studio KM for PATROL works and what you can dowith 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 itprovides 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 samemonitored application, IT component or device. It greatly facilitates the monitoring management ofapplications/components and permits you to have a clean and well-structured hierarchy of themonitored objects.
Method (summary)
Create a new application or container icon (when created, it appears at the same level as the mainMonitoring Studio icon).
You can create sub-conta iners within your applicat ion/conta iner which is v ery useful to ensure that the monitoringmatches your actua l applicat ions as close ly as possible .
Specify an application name (or container name) and enter properties that will be useful to operatorssuch 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 monitoringmanagement of applications:
54Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
You can set command lines that allow starting or stopping of the application from the menucommand.
You can specify signature files whose existence means that the managed application is currentlypresent 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 anapplication 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 othermonitored objects belonging to the application under it. This way they are all grouped together. This isuseful, for instance, if you wish to apply global Alert Actions to all monitored objects belonging to oneapplication. The application containers enable you to have a clean and structured hierarchy of yourmonitored objects.
Create and edit application/container icons
To create a new application/container icon, right-click the Monitoring Studio icon in the PATROL Consoleand select KM Commands > New > Application icon (container)…
Ne w A pplica t ion/Conta ine r Icon W iza rd — W e lcom e Pa ge
To edit an existing application/container icon, right-click the icon in the PATROL Console > select KMCommands > Edit.
To create sub-containers, right-click the application/container icon under which you want to createa sub-container > select KM Commands > New > Sub-container…
55Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Identifying the application to monitor (naming a container)
Ne w A pplica t ion/Conta ine r Icon W iza rd — Conta ine r Na m e Pa ge
Container name: Enter the name of the container or application to monitor. This builds the labelof 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 incase of an application failure.
Let me setup advanced options: Selection enables setting advanced options.
56Monitoring Features
Monitoring Studio KM for PATROL
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 youaccess to three options start--stop; signature files; applications constants:
Ne w A pplica t ion/Conta ine r Icon W iza rd — A dv a nce d Options Pa ge
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 KMcommand. 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:
57Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ne w A pplica t ion/Conta ine r Icon W iza rd — A dv a nce d Options (Sta rt/Stop Options) Pa ge
<Application name> can be started with the following command line: Set a command lineto start the application.
<Application name> can be stopped with the following command line: Set a command lineto stop the application.
Run these commands as this user with password: Enter a login and password to execute thestart and stop command lines. If you enter the word "PASSWORD" as a Command name, thecorresponding value will automatically encrypted once you click the Finish button at the last step ofthe wizard. The Password field will then show instead of the actual password characters.
Make sure you click the A ccept button before you go to the nex t step. If y ou click the Cance l button, the newlyapplied sett ings will be disregarded!
You can start or stop this application by right-clicking on the application/container icon > KMcommands > Manage > Start the application/Stop the application.
58Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Signature files
This is a feature for managing the monitoring of clustered applications. The presence of signature filesindicates 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 onthe system and consequently should not be monitored. In such case, Monitoring Studio will disable theentire 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 panelis displayed:
Ne w A pplica t ion/Conta ine r Icon W iza rd — A dv a nce d Options (Signa ture File ) Pa ge
Paths to the signature files: Up to four signature file paths can be entered in these fields. Theapplication monitoring will be performed only if a minimum of one of these four files is found. Thepresence of a signature file means that the application is currently present and should bemonitored.
If none of the required files can be found, the application monitoring will be turned offline.
These f ile names do not accept wildcards.
Make sure you click the A ccept button before you go to the nex t step. If y ou click the Cance l button, the f reshlyapplied sett ings will be disregarded!
59Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Application Constants
Application constants are defined at the level of an application/container and can be reused in thevarious objects underneath. They facilitate the monitoring across various systems of an applicationwhose properties may change from one system to another.
Ne w A pplica t ion/Conta ine r Icon W iza rd — A dv a nce d Options (A pplica t ion Consta nts) Pa ge
Example 1When creating the application/container icon for "MyApplication", you define the APP_PATH constantwith the /opt/MyApp value. Then, when creating a "LOG File Analysis" object in Monitoring Studio, youcan 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 underanother directory (/usr/local/MyApp for example), you will be able to use the same configuration ofMonitoring Studio (export and import) and just modify the APP_PATH constant on the new system.
Example 2You specify the monitoring of a remote device using SNMP polling and SNMP trap listening objects inMonitoring Studio.Instead of specifying the IP address of the remote device directly in these SNMP objects, you candefine 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_IPADDRESSconstant, instead of editing every SNMP polling and trap listening object.
60Monitoring Features
Monitoring Studio KM for PATROL
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" asa Constant name, the corresponding value will automatically encrypted once you click the Finishbutton at the last step of the wizard. The Value field will then show instead of the actualpassword characters.
Required: Check the box to activate this newly-set application constant.
W hen you check the Required box , the monitoring of the applicat ion conta iner and a ll its dependent objects aretaken of f line if the va lue of the applicat ion constant is not set. This ensures that no monitoring operation isperformed until the required applicat ion constants are properly set.
This feature is particularly useful if you create an application monitoring template where all the definedapplication constants are empty – in this case, you first:
1. Import the configuration template
2. Enter values to all required application constants before the monitoring actually starts
3. Click Accept. The application constant/s will be taken into consideration by Monitoring Studio.
Step 3: Monitoring Studio settings
Ne w A pplica t ion/Conta ine r Icon W iza rd — Obje ct ID Pa ge
Container/Application name: Label that will be displayed in the PATROL Console for thisapplication/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.
61Monitoring Features
Monitoring Studio KM for PATROL
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 theapplication icon and selecting KM commands > Delete. After confirmation, the application icon and allits dependent objects will be removed from the PATROL Console and from the agent configuration.
Deletion of an applicat ion icon or conta iner 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 inaddition, verify the status of the execution by searching for a string, to run an infinite backgroundcommand 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 in-house script or command that you need to run and analyze at regular intervals in order to monitor yourapplication.
You can configure Monitoring Studio to execute any command line and parse the output of thiscommand. 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, analyzeand monitor the script or command line.
The program or script be ing executed should not need any user interaction and should not create any window.Monitoring Studio will ana ly ze its output, i. e . what has been written to the stdout and stderr streams.
The command line ana ly sis features prov ides a "do-it-yourse lf" kind of tool a llowing you to execute any she ll script orVBScript and search for Strings and Numeric v a lues in the returned output.
62Monitoring Features
Monitoring Studio KM for PATROL
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 PATROLConsole and select KM Commands > New > Command Line analysis...
Ne w Com m a nd Line Exe cution W iza rd — W e lcom e Pa ge
To edit an existing Command Line analysis, right-click the Command Line icon in the PATROL Consoleand select KM Commands > Edit.
63Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Classic command execution
Step 1: Entering the command line to execute
Ne w A pplica t ion/Conta ine r Icon W iza rd — Com m a nd Line Pa ge
Command line to execute: Enter the OS command line or the path to the script that Monitoring Studiowill execute.
Execute this command line as Username/Password: Enter a username and password if thecommand line needs to be run with a user account different from the default PATROL Agent account.
You can use the % {TIME:…} and % {LASTTIME:…} macros in the command line that will be executed. They will bereplaced respectiv e ly by the current t ime and by the last execution t ime. See Format symbols for more deta ils on themacros.
64Monitoring Features
Monitoring Studio KM for PATROL
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 linesthat 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 notselected in step 1, the following dialog box is displayed.
Ne w A pplica t ion/Conta ine r Icon W iza rd — Com m a nd Exe cution Pe riod Pa ge
Stop the command if it takes longer than … seconds: The time after which the command will bestopped.
If the t imeout is reached, the va lue of the ExecutionStatus parameter will be set to 1, indicating that the commandfa iled to execute properly . No further ana ly sis will be performed (String and Numeric Va lue searches).
65Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Command to execute if the timeout above is reached: A command similar to a recovery/cleaningaction that will be executed when the timeout is reached.
The {% PID} macro can be used to indicate the PID of command line process be ing interrupted.
Step 3: Command execution validation (optional)
This option is useful to avoid basic execution errors like File not found because the command line wasmistyped. The following panel will pop up:
Ne w A pplica t ion/Conta ine r Icon W iza rd — Com m a nd Exe cution Va lida t ion Pa ge
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 theend of the command line execution.
Enter one or several exit codes separated by commas. When one of the exit codes is found or notdepending on the execution option selected, Monitoring Studio triggers an alarm on the ExitStatusparameter to indicate that the execution failed.
Command execution validation: The regular expression entered here will be searched in the outputof the command. If it is not found, the value of the ExecutionStatus parameter will be set to 1, indicatingthat the command failed to execute properly.
66Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 4: Monitoring Studio settings
Ne w A pplica t ion/Conta ine r Icon W iza rd — Se tt ings Pa ge
Object display name: Label that will be displayed in the PATROL Console for this command linemonitoring 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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
67Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied 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 nding Com m a nd Exe cution — Com m a nd Line
Command line to execute: Enter the OS command line or the path to the script that Monitoring Studiowill execute.
Execute this command line as Username/Password: Enter a username and password if thecommand 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 "never-ending" command is a program or script that runs continuously. It is not actually polled but insteadexecuted just once and the returned value of the command is displayed in the ReturnOutput parameteras it runs. In addition, String and Numeric value searches are performed as new output is received.
You can use the % {TIME:…} and % {LASTTIME:…} macros in the command line that will be executed to display thecurrent t ime and the last execution t ime. See Format symbols for more information on how to format the % {TIME:…}and % {LASTTIME:…} macros.
68Monitoring Features
Monitoring Studio KM for PATROL
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 lineslogged since the last polling:
errpt –a –s %{LASTTIME:%m%d%H%M%S}
Step 2: Confirm never-ending command and additional command toexecute to stop the never-ending command
If you select the option This command needs to be launched only once and runs continuously instep 1, the following pop-up asks you to confirm your choice:
Ne v e r-e nding Com m a nd Exe cution — Confirm a tion M e ssa ge
Once the "never-ending" option is confirmed, the following dialog box confirming that the commandline will be executed just once and will run continuously is shown:
69Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ne v e r-e nding Com m a nd Exe cution — Com m a nd Exe cution
Additional command to execute in such a case: Enter a specific command to execute in order tostop the execution of the previous launched never-ending Command. This command runs when thecommand analysis is deleted from the PATROL configuration. It is required to properly end the executionof the command.
Abort any previous execution of this command upon a PATROL Agent restart: Select thisoption if you wish the system to automatically stop the execution of the previous launched never-endingCommand upon the next PATROL Agent restart.
Click Next.
70Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3: Monitoring Studio settings
Ne v e r-e nding Com m a nd Exe cution — Se tt ings
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
71Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se t Thre sholds.
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 themarket (Microsoft SQL, MySQL and Oracle for instance) and monitor their return output within yourPATROL environment.You can then run string or numeric value searches on the return output to get/monitor the result inmyriad 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 sendingapplicative 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 thenumerical values returned. Queries can be set up to perform complex tasks with just the click of abutton, 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 specifystrings 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.
ExampleHow the database query result is formatted and then searched for strings and numeric values:
72Monitoring Features
Monitoring Studio KM for PATROL
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 PATROLConsole and select KM Commands > New > Database Query analysis…
To edit an existing Database query analysis, right-click the Database Query analysis icon in thePATROL Console and select KM Commands > Edit.
Step 1: Selecting the database type
Da ta ba se Que ry A na ly s is W iza rd — W e lcom e Pa ge
Select a database type: Specify here whether the database used by your application is anOracle 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 connectionmethod you wish to use to access the database. A list of available connection methods will bedisplayed 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 selecteddatabase type. If a Database Query Analysis is found, Monitoring Studio uses these settings to accessthe database. If no Database Query Analysis is found, the following panel is displayed whether the Letme set up the database connection method is selected or not.
73Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Da ta ba se Que ry A na ly s is W iza rd — Da ta ba se Conne ction M e thod Se le ct ion
Command line utility: Select this option to use the command line tool developed by the databaseprovider to manage access to a database. This method is by far the fastest but requires thecommand line tools to be installed on the local server and properly set. These command line toolsare:
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 thedatabase. 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 tothe database. This method is known as the most flexible. However, it requires the proper driver tobe installed on the local server as well as Java for UNIX/Linux servers.
Addit iona l information:
SQL queries on O racle Database running on W indows servers can only be performed loca lly with the ODBCconnection method; for UNIX, SQL queries are not limited to the loca l host but a specif ic driv er must beinsta lled on the server where the agent is running.Performing an SQL Query on a Microsoft SQL database insta lled on a UNIX Server is only possible with JDBCand ODBC connection methods since Microsoft does not prov ide OSQL 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)
74Monitoring Features
Monitoring Studio KM for PATROL
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 andconnection methods. They follow Step 3 that depends on the database server and the connectionmethods you have selected (see above).
Step 4 - Defining the query to be executed
Da ta ba se Que ry A na ly s is W iza rd — Que ry De finit ion Pa ge
SQL Query to execute: Single line SQL statement to be executed by the Oracle server. This canbe also the path to an existing SQL script file.
Use the following syntax if y ou want to execute the SQL query f rom a f ile : "@ @ <f ile name>". Only supportedwith Command Line connection method.
Query timeout: When the execution exceeds the given timeout (in seconds), the ConnectionStatusparameter 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
75Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Password: ******
SQL query: SELECT COUNT(*) FROM PendingCustomers
Behavior: Will connect to the BACKENDDB Oracle server instance using the sysApp databaseaccount and ask the server to return the number of rows in the Pending Customers table. Thisquery 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 thethreshold settings.
Da ta ba se Que ry A na ly s is W iza rd — Se tt ings Pa ge
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 toselect the mode of setting alert thresholds:
76Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
Database query analysis objects are instances of the SW_DB_QUERIES class.
Setting connection to Microsoft SQL Server DatabasesThis section details the various connection settings available for performing queries on Microsoft SQLdatabase server. Step 1 and 2 are common to all database queries and connection methods. They aredocumented in the Database Query Analysis section.
Step 3.1a - Setting Command line connection to Microsoft SQLdatabase servers
If you have selected Command Line Utility as the connection method at Step 2 of the Database QueryAnalysis wizard, the following panel is displayed:
77Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Da ta ba se Que ry A na ly s is W iza rd — M icrosoft SQL Se rv e r Com m a nd Line Conne ction Se tt ings
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 SQLServer 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 thedatabase through your Windows user account. Select SQL Server if you wish to connect thedatabase 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 hasbeen set up and if the specified password matches the one previously recorded. If SQL Server doesnot 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.
78Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3.2a - Setting JDBC connection to Microsoft SQL databaseservers
If you have selected Java Database Connectivity (JDBC) as the connection method at Step 2 of theDatabase Query Analysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — M S SQL Se rv e r JDBC Conne ction Se tt ings
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 SQLServer 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 thedatabase through your Windows user account. Select SQL Server if you wish to connect thedatabase 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 hasbeen set up and if the specified password matches the one previously recorded. If SQL Server doesnot 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
79Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3.3a - Setting ODBC connection to Microsoft SQL databaseservers
If you have selected Open Database Connectivity (ODBC) as the connection method at Step 2 of theDatabase Query Analysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — M S SQL Se rv e r ODBC Conne ction Se tt ings
Click Next to open the query definition panel.
ODBC Driver (for ODBC Connection only): Select the appropriate ODBC driver. The ODBC drivermust 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: SQL Server and SQL Server 2005; and one driv er for UNIX:Easy soft ODBC -SQL
Click Next to access the query definition panel.
80Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Setting connection to MySQL Server DatabasesThis section details the various connection settings available for performing queries on MySQL databaseserver. Step 1 and 2 are common to all database queries and connection methods. They aredocumented in the Database Query Analysis section.
Step 3.1b - Setting Command line connection for MySQL databaseservers
If you have selected Command Line Utility as the connection method at Step 2 of the Database QueryAnalysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — M y SQL Da ta ba se Se rv e r Com m a nd Line Conne ction Se tt ings
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.
81Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Monitoring Studio connects to MySQL databases using the mysql command-line tool. This client can be downloadedfrom the MySQL website and is insta lled by default when insta lling a MySQL database. This command-line tool, ca lledmysql on Linux /UNIX and mysql.exe on W indows needs to be insta lled on the sy stem that will perform the SQLqueries. Monitoring Studio uses the following optiona l mysql parameters to connect to the database and execute theSQL query :connect_timeout: The number of seconds before connection t imeout (as entered in the Monitoring Studio interface).
quick: Do not cache each query result; print each row as it is rece iv ed. This may slow down the server if theoutput is suspended. W ith this option, mysql does not use the history f ile . It forces mysql to retrieve results f romthe server a row at a t ime rather than retriev ing the entire result set and buffering it in memory beforedisplay ing it. This is done to avoid problems due to insuf f icient memory for la rge result sets.
safe_updates: A llow only those UPDATE and DELETE statements that specify which rows to modify by using keyva lues.
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
If you have selected Java Database Connectivity (JDBC) as the connection method at Step 2 of theDatabase Query Analysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — M y SQL Da ta ba se Se rv e r JDBC Conne ction Se tt ings
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
82Monitoring Features
Monitoring Studio KM for PATROL
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
If you have selected Open Database Connectivity (ODBC) as the connection method at Step 2 of theDatabase Query Analysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — M y SQL Da ta ba se Se rv e r OCBC Conne ction Se tt ings
ODBC Driver (for ODBC Connection only): Select the appropriate ODBC driver. The ODBC drivermust 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): MySQL Connector 3.5 and MySQL Connector 3.51.
Click Next to access the query definition panel.
83Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Setting connection to Oracle Database ServerThis section details the various connection settings available for performing queries on Oracle databaseserver. Step 1 and 2 are common to all database queries and connection methods. They aredocumented at the beginning of this section. .
Step 3.1c: Setting Command line connection to Oracle databaseservers
If you have selected Command Line Utility as the connection method at Step 2 of the Database QueryAnalysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — Ora cle Da ta ba se Se rv e r Com m a nd Line Conne ction Se tt ings
System identifier (Oracle SID) or connection string: Specify the Oracle SID of the databaseserver you want to connect to.
If the O racle Instant C lient is insta lled, you can use the syntax ://hostname:1521/oracleSID. O therwise, this mustmatch one of the tnsnames.ora entries.
84Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Oracle location: Path to the Oracle client. This can be either ORACLE_HOME if the OracleDatabase Server or Full Client is installed (example: c:\Oracle\ora92, or the path to Oracle InstantClient (example: /opt/oracle_instant_client).
Optional alternate TNS_ADMIN path: If the Oracle Database Server or Full Client is installedand the tnsnames.ora file is not located in the default directory, you can specify the path to thedirectory which contains tnsnames.ora that will allow SQL*Plus to resolve the Oracle SID that youentered 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 you need to enter a space-freepassword if y ou are working with this operating sy stem.
SQL*Plus:
Monitoring Studio uses O racle SQL*Plus to connect to an O racle Database Server. Therefore, SQL*Plus needs tobe insta lled on the computer where Monitoring Studio and the PATROL Agent are running.
SQL*Plus is insta lled by default with O racle Database Server (f rom version 7.x to 10g). If y ou are conf iguringloca l queries, you need to enter the current ORACLE_HOME as the O racle location.
SQL*Plus is a lso insta lled by default with the O racle Database C lient (f rom version 7.x to 10g). If the O racleDatabase C lient has been insta lled on the computer where the PATROL Agent is running, you need to enter thecurrent ORACLE_HOME as the O racle location.
Start ing with version 10g, O racle now prov ides a new lightweight client: O racle Instant C lient. This new client ismade of severa l packages. In order to make O racle queries with Monitoring Studio, you need to insta ll the"Instant C lient Basic" (or "Instant C lient Basic Lite") as well as "Instant C lient SQL*Plus". Specify the directorywhere you unzipped the O racle packages as the O racle location.
On W indows, Monitoring Studio will try to detect by itse lf the SQL*Plus sett ings. On Linux and UNIX, MonitoringStudio will detect the proper SQL*Plus sett ings only if the PATH env ironment variable conta ins the directory ofthe SQL*Plus binary .
O racle sy stem identif ie r (O racle SID):
If O racle Database Server of the full O racle Database C lient is insta lled on the computer where the PATROLAgent and Monitoring Studio are running, SQL*Plus will be using the classic name resolution sy stem. In this case,the O racle sy stem identif ie r (O racle SID) that you enter in the f irst f ie ld will be resolv ed by using the tnsnames.ora f ile .
In most cases, the tnsnames.ora f ile is located in the $ORACLE_HOME/network/admin directory . If it is located inanother specif ic directory , you must specify the optiona l a lternate TNS_ADMIN path (only enter the path to thedirectory ).
The tnsnames.ora needs to be mainta ined by an O racle administrator. Please consult your databaseadministrator if the O racle sy stem identif ie r of the database you want to connect to is not registered in thetnsnames.ora f ile .
If the O racle Instant C lient is insta lled on the computer where the PATROL Agent and Monitoring Studio arerunning, you do not need the tnsnames.ora f ile . Instead, you can use the following syntax for the O raclesy stem identif ie r: //server_hostname:1521/database_sid
Click Next to access the query definition panel.
85Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3.2c - Setting JDBC connection to Oracle database servers
If you have selected Java Database Connectivity (JDBC) as the connection method at Step 2 of theDatabase Query Analysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — Ora cle Da ta ba se Se rv e r JDBC Conne ction Se tt ings
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.
86Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3.3c - Setting ODBC connection to Oracle database servers
If you have selected Open Database Connectivity (ODBC) as the connection method at Step 2 of theDatabase Query Analysis wizard, the following panel is displayed:
Da ta ba se Que ry A na ly s is W iza rd — Ora cle Da ta ba se Se rv e r ODBC Conne ction Se tt ings
ODBC Driver (for ODBC Connection only): Select the appropriate ODBC driver. The ODBC drivermust 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 ODBC driv er for UNIX servers.On W indows, only queries to a loca l O racle database are supported.
Click Next to access the query definition panel.
87Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Setting connection to Other Databases (ODBC only)This section details the various connection settings available for performing queries on database serversother than MS SQL, MySQL or Oracle. Step 1 and 2 are common to all database queries and connectionmethods. They are documented in the Database Query Analysis section.
Step 3.1d - Setting Command line connection to Other databaseservers (ODBC only)
Connection settings for databases other than MS SQL, MySQL or Oracle is only supported through ODBCconnection. You can set the connection parameters with the following panel:
Da ta ba se Que ry A na ly s is W iza rd — Othe r (ODBC only ) conne ction se tt ings Pa ge
88Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Connection String: Enter the connection string that includes attributes such as the name of thedriver, 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 themeans of connecting to it. It is passed in code to an underlying driver or provider in order to initiatethe connection.The connection string may include attributes such as the name of the driver, serverand database, as well as security information such as user name and password.Whilst commonlyused 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 beingencrypted. 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 you need to enter a space-freepassword 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 applyinga 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:
89Monitoring Features
Monitoring Studio KM for PATROL
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 consoleaccording to the user-defined naming
Groups all dynamic objects under a dynamic container to facilitate the management of all thedynamic 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 haveselected the Trigger an alarm when objects are missing option, a parameter named Status isautomatically added to the PATROL Console for Dynamic Items. It informs you of the Dynamic Itempresence 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 DynamicObject 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 Consoleand select KM Commands > Edit.
Dy na m ic Obje ct Builde r W iza rd — W e lcom e Pa ge
90Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
1. Defining the rules to apply to the output data
Dy na m ic Obje ct Builde r W iza rd — Rule s De finit ion Pa ge
View Parameter Output: Displays the output data to which the Dynamic Object Builder rules willbe applied.
Keep only lines matching the regular expression below: Specify the regular expression youwish the Dynamic Object Builder to search for in the output data. Each matching lines is displayedin a separated Dynamic Item automatically added in the PATROL Console under the DynamicContainer icon.
Exclude lines matching the regular expression below: Specify the regular expression youwish the Dynamic Object Builder to search for in the output data. Each matching lines will beignored.
Trigger an alarm when objects are missing: This option allows you to define if and howMonitoring Studio must trigger an alert when the Dynamic Item, containing the extracted line, ismissing from one collect to another:
Do not trigger any alert: Select this option if you do not wish Monitoring Studio to trigger anyalert when objects are missingTrigger an INFORMATION: Select this option if you wish Monitoring Studio to trigger anInformation alert when objects are missingTrigger a WARNING: Select this option if you wish Monitoring Studio to trigger a Warning alertwhen objects are missingTrigger an ALARM: Select this option if you wish Monitoring Studio to trigger an Alarm alertwhen objects are missing
91Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
I you have chosen to trigger an alert, a Status parameter will automatically be activated anddisplayed under the Dynamic Item in the PATROL Console to indicate that the Dynamic Item ismissing. Click the Status parameter to open a graph pane displaying the status history of theDynamic Item.
Delete missing objects: Set this option according to how you want Monitoring Studio to displaymissing objects in the console. The available options are:
Never: Monitoring Studio never deletes missing objects in the console. They will always bepresent.As soon as they are missing: Monitoring Studio deletes missing objects from the console assoon as their absence is discovered. If an alarm is configured, Monitoring Studio will trigger thealarm before deleting the object.When they are missing .... in a row: Monitoring Studio deletes missing objects after they havebeen 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 Builde r W iza rd — Colum n se pa ra tor de finit ion
92Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
2. Define Dynamic Objects, Instance Names and Internal identifier
Dy na m ic Obje ct Builde r W iza rd — Dy na m ic Obje ct Na m e s a nd ID de finit ion Pa ge
Object Display Name: Name of the Dynamic Object Builder as it will appear in the PATROLConsole
Object Internal Identifier (ID): Name used by the PATROL Console to internally identify theDynamic Object Builder
Object Display Name: Name of the Dynamic item that contains the data retrieved from the outputdata. 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 theDynamic 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 ExtractionTemplates
Features such as String Search and Numeric Value Extraction can help you analyze the Dynamic Itemsoutput. In order to apply these features to all the Dynamic Items in a single operation, the DynamicObject Builder creates Templates instances of these features. While standard String Search andNumeric 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 datacollection.
93Monitoring Features
Monitoring Studio KM for PATROL
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 afile 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 filesand 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 andnumeric values to build graphs).
The most typical usage of file monitoring is parsing a LOG file. Most applications use LOG files to tracetheir operations and notify operators when failures occur.
94Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
The dif ference between f la t f iles and LOG f iles: A s opposed to the LOG f iles, so-ca lled "f la t f iles" are a lways entire lyparsed when you specify strings or numeric v a lues to search in the f ile . In LOG f iles, only the new lines will bescanned when searching for strings or numeric v a lues.
Method (summary)
In order to monitor a file, you must first:
1. Specify whether it is a flat file or a LOG file
2. (Flat files are entirely updated and therefore need to be parsed entirely as opposed to LOG fileswhere new lines are appended at the end of the file and therefore only these new lines need to beanalyzed).
3. Indicate the path to the file
4. Select the characteristics to be monitored.
5. If required, create string search and numeric value extraction objects
6. If you have large multi-line records, or XML files or complex LOG files, you can first transform thecontent with the text pre-processing tool, and then run string and numeric value searches on it.
Result
Once the file monitoring is set up and string searches/numeric value searches/text preprocessing, andfile security objects are set up for the monitored file, the objects hierarchy in the PATROL Console willbe as illustrated in the image below:
Hie ra rchy in the PA TROL Console
Create or edit a file monitoring
To create a new file monitoring and analysis, right-click the Application/Container icon in thePATROL Console > KM Commands > New > File monitoring and analysis...
95Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Selecting the type of file to monitor
File M onitoring a nd A na ly s is W iza rd — W e lcom e Pa ge
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 thePATROL 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. Right-click the file icon (once it has been created) in the PATROL Console
2. 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. Right-click the file icon (once it has been created) in the PATROL Console
2. Select KM Commands > New > Numeric Value extraction…
See chapter "Searching for numeric values" for more information about this feature.
96Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 2: Identifying the file to monitor
Identify the file you wish to monitor
File M onitoring a nd A na ly s is W iza rd — File Na m e a nd Pa ra m e te rs Pa ge
File name and path: Path and name of the file to be monitored.
W ildcards can be used in the path or f ile name. In this case, the most recently modif ied or created f ile matching thecriteria will be monitored. The wildcard characters that can be used are:
'?': replaces one character,
'* ': replaces one or more characters.
It is a lso possible to use a format Menu Command to dynamica lly assign the current date or t ime in the f ile name orpath. Simply insert the following string in the "F ile name and path" f ie ld, replacing the three dots by date formatsymbols: % {ASCTIME:…}. For the complete list of format symbols, meaning and some examples, please see FormatSymbols in the Reference 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 searchesfor strings and numbers, and then switch to this new file. This way, no information is lost whenswitching from the previous file to the new one.
97Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Select the parameters you want to monitor: Select only those relevant to this file monitoring anddeselect the others. See SW_FILES for parameter details.
W hen you set or edit thresholds, the thresholds dia logue box display s only those parameters se lected at this stage. A ta la ter stage, if y ou wish to monitor more parameters of this f ile (or less), click on the instance > KM commands > Editand se lect or de-se lect the parameters.
Click Next. You arrive at the last panel of the file monitoring set-up process.
A warning pane l will appear if the f ile does not actua lly ex ist/if the path entered is incorrect.
Step 3: Monitoring Studio settings
File M onitoring a nd A na ly s is W iza rd — Se tt ings Pa ge
Object display name: Label displayed in the PATROL Console
Object internal identifier (ID): PATROL internal identifier of this monitored object. Althoughmodifiable, 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 toselect the mode of setting alert thresholds:
98Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM commands > Set Thresholds.
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 impactedapplications 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 filesystems are already monitored by BMC Performance Manager for Servers, operators often do not knowwhich application is impacted when a file system is full.
99Monitoring Features
Monitoring Studio KM for PATROL
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 PATROLConsole 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 andselect KM Commands > Edit.
Step 1: Identifying the file system to monitor
File Sy ste m M onitoring W iza rd on W indows — W e lcom e Pa ge
Select a File System: This drop-list box contains the list of file systems on the computer. Select thefile 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 willdisplay the dialogue box. By clicking Existing File Systems a small box showing current file systemswill appear. Again, owing to PSL limitation, selection of the drive/file system with the cursor is notpossible – you are required to enter the drive manually. The panel that shows all the drives is fordisplay/information purpose only. Click Accept/Cancel.
The parameters you can monitor on a file system are:
100Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
FreeMegabytes: Free space left in megabytes. It is possible to trigger an alert when the freespace in MB is lower than a given value.
FreeSpacePercent: Displays the free space in percentage. You can configure Monitoring Studio totrigger an alert when the percentage of free space on the file system is lower than a giventhreshold.
UsedSpaceGrowthPercentage: Shows how fast the file system is filled up, in percentage of itssize (in percentage per hour - %/hour). Note that the UsedSpaceGrowthPercent parameter mayhave 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.
Step 2: Monitoring Studio settings
File Sy ste m M onitoring W iza rd — Se tt ings Pa ge
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 toselect the mode of setting alert thresholds:
101Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking Finish , the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 thatfile security is respected.
With a few clicks, you can monitor the access and rights of groups and users and define who should bealerted 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 Consoleand select KM Commands > New > File security check....
To edit an existing File Security monitoring, right-click the File security icon in the PATROL Consoleand 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.
102Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
File Se curity Che ck W iza rd — W e lcom e Pa ge
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 f ile a ttributes and owners in the nex t steps. If the current f ileconf iguration is the correct one, simply click on Nex t until the end of the wizard.
Step 2: File’s access rights
This panel helps you select the type of alert to be triggered if the file’s access rights do not match thecriteria entered. Depending on the operating system the PATROL agent is running on, you may getdifferent options.
On UNIX and Linux systems
103Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W indows Se rv ice M onitoring W iza rd — File A cce ss Rights on UNIX/Linux Sy ste m s
Choose type of alert: The first dropdown list enables you to choose the type of alert to trigger if thecurrent 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 entrytype:
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 andexecution permissions for the owner, group, and others categories.
The" – "indicates that permission is not granted. Various permission combinations are possible, exceptthat the x, s, S, t, and T characters are mutually exclusive.
The access right characters are interpreted as follows:
104Monitoring Features
Monitoring Studio KM for PATROL
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 theowner (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 tablethat 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 eachsystem user with access privileges. The most common privileges include the ability to:
105Monitoring Features
Monitoring Studio KM for PATROL
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 indows Se rv ice M onitoring W iza rd — File A cce ss Rights on W indows Sy ste 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 groupof 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 calledan access mask.
Generally, the system administrator or the object owner creates the access control list for an object.
106Monitoring Features
Monitoring Studio KM for PATROL
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 file’s access rights differ from the specified criteria.
Step 3: Ownership
Monitoring Studio can check if the file’s owner is approved.
W indows Se rv ice M onitoring W iza rd — File Owne rship Pa ge
Select the type of alert: Do nothing; Trigger an ALARM; Trigger a WARNING; Trigger anINFORMATION
Specify whether the file owner is or is not: Specify whether or not the file’s owner should orshould not match the specified names.
Step 4: File’s group
Monitoring Studio checks if a group differs from the specified criteria.
107Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W indows Se rv ice M onitoring W iza rd — File Group Pa ge
Select the type of alert: Do nothing; Trigger an ALARM; Trigger a WARNING; Trigger anINFORMATION
Specify whether the file’s group is or is not: Specify whether or not the file’s group matches thespecified criteria.
Step 5: File’s integrity
In this panel, you are simply asked to select the type of alert to trigger when the file’s content ismodified.
W indows Se rv ice M onitoring W iza rd — File Inte grity Pa ge
Select the type of alert: Do nothing; Trigger an ALARM; Trigger a WARNING; Trigger anINFORMATION
108Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 6: Monitoring Studio settings
W indows Se rv ice M onitoring W iza rd — Se tt ings Pa ge
PATROL Object Label: Label displayed in the PATROL Console.
PATROL Object ID: PATROL internal identifier of this File security monitoring. Although modifiable, it isstrongly recommended not to change the default ID.
Poll every "x" minutes: Set the polling interval for this monitored object. The default polling interval is2 minutes.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM commands > Set Thresholds.
File security check objects are instances of the SW_FILE_SECURITY class.
109Monitoring Features
Monitoring Studio KM for PATROL
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 goodway 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) etcdepending 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).
Folder monitoring may be t ime-consuming for la rge size folders. Therefore, Monitoring Studio will automatica lly reduceits monitoring features when the monitored folder conta ins more than 1000 f iles. If y ou want to avoid the use of thislimit, y ou can set the conf iguration variable "/MASA I/SENTRY8/folderLimit" to a va lue greater than 1000.
Create or edit a folder monitoring
To create a new folder monitoring, right-click the application/container icon in the PATROL Consoleand select KM Commands > New > Folder monitoring...
110Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Folde r M onitoring W iza rd — W e lcom e Pa ge
To edit an existing folder monitoring, right-click the folder icon in the PATROL Console and select KMCommands > Edit.
Step 1: Identifying the folder
Ne w Com m a nd Line Exe cution W iza rd — Fo lde r Ide ntifica t ion Pa ge
Folder name and path: Enter the name and path of the folder (directory) to be monitored.
111Monitoring Features
Monitoring Studio KM for PATROL
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, andonly these files will be monitored.
You can use wildcards such as "*" to replace any number of characters, or "?" to replace just one character. You maya lso use severa l masks separated by ";". Monitoring Studio will only take into account the f iles matching the masksentered.
Example
You can enter:.txt;myFiles?.log;file.*, and all files matching these masks will be monitored
Step 2: Select the parameters
M onitoring Fo lde r W iza rd — Pa ra m e te rs Pa ge
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 sizedivided 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.
112Monitoring Features
Monitoring Studio KM for PATROL
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 thepolling interval. Unit: files per minute
NewFileCount: Number of new files added to this folder since the last polling, divided by thepolling 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 thisfolder. Unit: minutes
OldestModifiedFileElapsedTime: Time lapsed since the last modification/creation of the oldestfile in this folder. Unit: minutes
Step 3: Monitoring Studio settings
Folde r M onitoring W iza rd — Se tt ings Pa ge
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 toselect the mode of setting alert thresholds:
113Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 yourconsole and to apply a mathematic formula to the collected values in order to obtain a meaningfulresult.
Method (summary)
The Multi-Parameter Formula option has been specifically designed to apply mathematical formulas tomonitored 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 createdin 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 ofyour application.
114Monitoring Features
Monitoring Studio KM for PATROL
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 PATROLConsole and select KM Commands > New > Multi-Parameter Formula...
M ult i-Pa ra m e te r Form ula W iza rd — W e lcom e Pa ge
To edit an existing Multi-Parameter Formula, right-click the Multi-Parameter Formula icon in thePATROL Console and select KM Commands > Edit.
115Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Selecting the parameter(s) you wish to use in the formula
M ult i-Pa ra m e te r Form ula W iza rd — Pa ra m e te r(s) Se le ct ion Pa ge
Select the parameter(s) you wish to use in the formula: Click as many parameters as you needto 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 IDsoption to allow the use of label instances instead of PATROL IDs to determine a parameter's path. Thisoption 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 theselected instance label. Monitoring Studio will list the objects actually present at the time of the collectand will only consider and monitor the first instance that matches the label selected in the Multi-Parameter Formula wizard.
116Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 2: Define the formula to apply to the monitored parameter(s)
M ult i-Pa ra m e te r Form ula W iza rd — De fining a form ula to a pply to the se le cte d pa ra m e te r(s)
The parameter(s) you have selected at the previous step are listed and labeled alphabetically: A, for thefirst parameter, B for the second, C for the third, and so on. Use these letters to represent theparameters in the formula.
Formula: Enter the formula you wish to apply to the parameter(s). Use the standard mathematicalsymbols to do so, such as: + - / * ( ).
Do not collect if one or more parameter has no value: Select this option if you do not wish tocollect data for parameter(s) not returning any value.
Off-line parameters and parameters with no va lues (like collectors) are displayed as "OFFLINE" in the list. It isrecommended not to se lect these parameters.
117Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3: Defining a name for the formula result
M ult i-Pa ra m e te r Form ula W iza rd — De fining a Na m e for the Form ula Re sult
Object display name: Label that will be displayed in the PATROL Console for this Multi-ParameterFormula.
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
118Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Click Finish to start monitoring the selected parameters. A new object labeled with the name you haveentered at Step 3, is automatically created under the application/container icon in the PATROL console.
M ult i-Pa ra m e te r Form ula Obje ct in the PA TROL Console
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 actualvalues 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 hasoccurred." Sometimes, an application reports its health by providing critical numbers, like a queuelength, a processing time, a utilization percentage, etc. These numbers may be reported by theapplication through its files, in the output of commands, in a database, in a Web page, etc. MonitoringStudio extracts these values and reports them as graphs in the Console. This feature is called "NumericValue extraction" as its purpose is to extract numeric values from a text input (the output of acommand, 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 basicmechanism is:
1. Specify an information source
2. Specify with a regular expression the location of the numeric value within the searched lines
3. Indicate the numeric value’s position in these lines i.e. before/after the string; column number etc.
4. 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 never-ending 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 aresearched only in new lines since the last polling.
On "flat sources" (flat files, command lines, Web requests, database queries), the numeric valuesare searched in the entire source (the whole file, the whole standard output, the whole HTTPresponse, the whole data-set).
If several values are found, it is possible to select which value should be kept: the last value found, the
119Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
average of all values, the minimum or maximum or a total of all values. A graph is then built with thesevalues.
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 Extra ct ion W iza rd — W e lcom e Pa ge
To edit an existing numeric value search, right-click the Numeric Value Extraction icon in the PATROLConsole 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:
120Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Num e ric Va lue Extra ct ion W iza rd — Line s Ide ntifica t ion Pa ge
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 tochoose from:
All lines: All lines of the text will be scanned for the Numeric value search. There is no need toenter 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 theregular 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:
121Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Num e ric Va lue Extra ct ion W iza rd — Loca tion Pa ge
The numeric value is located: There are four different modes to choose from and theinformation to enter depends on this choice.
After/before the string…: Indicate if the numeric value is located after or before the string tobe entered in the text field.
At the character offset…: The value should be at a specific character offset in the line. Enterthe offset number in the box. Monitoring Studio will look for the numeric value at that exactcharacter offset in the line. If no numeric data is found, no value will be collected.
A character of fset is nothing but the character "number", for example: you want to search for a va lue that startsf rom the 7th character in the line. . . so you will enter "7" as the character of fset.
In the column number…: The previously selected lines contain several columns identified by aseparator character. Enter the column number that should contain the value and click the "Columnseparators" button to specify how columns are separated.
122Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Num e ric Va lue Extra ct ion W iza rd — Colum n Se pa ra tor De finit ion
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 thatconsecutive separators must be treated as a single separator.
Consecutive separators mean empty columns: Each separator is treated as an individualcolumn 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 extractnumeric 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 benegative.
If Monitoring Studio does not f ind a number at the specif ied location, no numeric v a lue will be ex tracted and thePATROL graph will not be refreshed (space characters are ignored).
Step 3: Value selection from multiple matches
Num e ric Va lue Extra ct ion W iza rd — A ddit iona l Options Pa ge
If several values are found in the searched text, it is necessary to identify which one should be used toset 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)
123Monitoring Features
Monitoring Studio KM for PATROL
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 Extra ct ion W iza rd — Pa ra m e te rs Se le ct ion Pa ge
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 ofseconds elapsed between the collection times
Select the option "Discard negative Delta values" if you do not want negative values to be reportedon the graph.
Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extractedin order to have a more readable graph in the PATROL Console. The available rescaling optionsare:
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
124Monitoring Features
Monitoring Studio KM for PATROL
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).
Step 5: Monitoring Studio settings
Num e ric Va lue Extra ct ion W iza rd — Se tt ings Pa ge
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 listallows 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 theinstance
Use default thresholds and customize them: Sets the default Monitoring Studio thresholdson certain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
Do not set any thresholds for now: No thresholds will be set on any parameter of theinstance, and as a result no alerts will be triggered. Monitoring Studio will poll the object andreturn the output of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
125Monitoring Features
Monitoring Studio KM for PATROL
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 bychecking 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 launchedby the operating system and have several properties: PID (unique identifier of a process); Name; UserID; 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 theReference section.
Method to monitor a process (summary)
On Windows, UNIX and Linux systems, Monitoring Studio allows you to check the presence of theseprocesses 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 whichparameters should be monitored. When several processes match the entered criteria, the selectedparameters will be valued in the PATROL Console (under the single process icon) by summing up thevalue of the parameters for each matching process.
Advanced privileges are sometimes required to collect process information. In that case, you will be promptto enter process command credentials that will be used for running OS commands. See section ProcessCommand Credentials for more information.
Result
All processes that match the entered criteria will be monitored and identified as one icon in the PATROLConsole.
126Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Example
If the criterion entered to detect the processes is "ORA," then all the Oracle processes will bemonitored within a single icon in the PATROL Console. The ProcessorTime parameter under this iconwill 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 PATROLConsole and select KM Commands > New > Process monitoring....
Step 1 – Select the action you wish to perform
Proce ss M onitoring W iza rd — W e lcom e Pa ge
To edit an existing process monitoring, right-click the Process icon within the PATROL Console andselect 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 thedetails of each process: PID, process name, user name and command line.
127Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Proce ss M onitoring W iza rd — Pick the proce ss to m onitor from a lis t
Click the process you wish to monitor and click the Next button. This will bring up the process criteriapanel (see step 1-b) with all information already filled. You may remove or modify any information youdo 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 a ll the arguments. You can click on any ofthe process’ lines to se lect the process f rom the list.
If y ou proceed to the nex t pane l and come back to this one, the process you chose will not be pre-se lected f rom thelist. This is due to some PSL limitat ion. You have to re-se lect the process before clicking on Nex t >. You may , ofcourse, se lect any other process.
It may take a few seconds for the pane l to be displayed. Monitoring Studio has to retrieve the list of currentlyrunning processes which may a moment depending on the server type 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 isshown:
128Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Proce ss M onitoring W iza rd — Ente r crite ria to ide ntify a nd m onitor proce sse s
The name of the process must be exactly/must contain: Choose the appropriate option and enter thename of the process to monitor. Under Windows, do not forget the ".exe" extension at the end of thename.
Must be exactly: Signifies that Monitoring Studio will search for a process whose name is exactlyas stated in the text you enter.
The tex t entered in the f ie lds is case-sensit iv e on UNIX and Linux , but not on W indows.
AND the command line that launched the process must match the regular expressionbelow/must contain: Enter a regular expression. Only processes that have been launched by acommand-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 isrunning as.
View processes: Click this button to view the currently running processes.
Here are a few examples:
Criteria Processes that match thecriteria
Example 1
Process name MUST BE EXACTLY patrolagent.exeCommand-line = <nothing>
PatrolAgent.ExeC:\Patrol\PatrolAgent.exe -p 3181
129Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Criteria Processes that match thecriteria
User Identity = <nothing> C:\Patrol\PatrolAgent.exe
Example 2
Process name MUST BE EXACTLY patrolagent.exeCommand-line MUST MATCH THE REGULAR EXPRESSION -[pP] 3181User Identity = <nothing>
C:\Patrol\PatrolAgent.exe -p 13181
Example 3
Process name MUST CONTAIN patCommand-line = <nothing>User Identity = <nothing>
PatrolAgent.exePatProcess.exePatrolPerf.exe
Step 2 - c: PID files
If you choose to specify a PID file, the following dialog box is shown:
Proce ss M onitoring W iza rd — Prov ide a PID file pa th
Path to the file containing the Process PID: Enter the path for the file with the process PID. At eachpolling, Monitoring Studio reads this file, retrieves the PID number and checks whether this process PIDexists or not. Normally, the process PID is dynamically allocated. The process PID number should be atthe very beginning of the file’s content.
130Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3: Select parameters
Proce ss M onitoring W iza rd — Proce ss PID: Pa ra m e te r Se le ct ion
Here’s a table that describes the parameters available for process monitoring:
Name Description
Count Displays the number of processes that match the criteria.Unit: Processes
ChildCount Displays the number of children of the matching process(es).Unit: Processes
ProcessorTime Displays the processor time percent used by the matching process(es).Unit: Percentage (%)
HandleCount(Windows only)
Displays the number of handles opened by the matching process(es).Unit: Handles
PageFaultsPerSec(Windows only)
Displays the number of page faults per second caused by the matching process(es).Unit: Page fault/sec
PageFileBytes(Windows only)
Displays the page file used by the matching process(es).Unit: Megabytes
PrivateBytes(Windows only)
Displays the processor time percent used by the matching process(es). On multi- processorcomputers, this parameter may go over 100%.Unit: Percentage (%)
ThreadCount(Windows only)
Displays the number of threads of the matching process(es).Unit: Threads
VirtualBytes Displays the virtual memory used by the matching process(es).Unit: Megabytes
WorkingSet(Windows only)
Displays the working set size of the matching process(es).Unit: Megabytes
131Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 4: Monitoring Studio settings
Proce ss M onitoring W iza rd — Se tt ings Pa ge
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
132Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 theproblem 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 itsoperation. These objects are arranged in a Management Information Base (MIB). SNMP is anApplication Layer protocol that allows external tools to communicate with the agent and read the valuesof the objects.
Method (summary)
The SNMP agent collects critical information about the middleware, and Monitoring Studio, directly pollsthe agent and retrieves the value of a given OID (object identifier). All the operator has to do isinterrogate the MIB and interpret the value of the OID retrieved by Monitoring Studio. The 3 basic stepsto 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 OIDcontent…
Create or edit a SNMP polling
To create a new SNMP polling: Right-click the Application/Container icon in the PATROL Consoleand select KM Commands > New > SNMP polling.
To edit an existing SNMP polling: Right-click the SNMP polling icon in the PATROL Console and select
133Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
KM Commands > Edit.
Step 1: Select the type of value you want to poll: Single OID value orSNMP table values
SNM P Polling W iza rd — W e lcom e Pa ge
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 anSNMP table
Click Next to launch the corresponding set-up wizard.
134Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Single value from one OID
Step 2: Identifying the SNMP agent and the OID to poll
SNM P Polling W iza rd — SNM P a ge nt a nd OID se le ct ion Pa ge
Host: Enter the IP of the computer running the SNMP agent that will be polled. If it is the sameserver 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 OIDcannot 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 theOID type, it is recommended to select “The OID returns a string.”
If y ou are unsure about the exact O ID to poll, y ou should use a SNMP MIB Browser tool to identify which O IDcorresponds to which variable . You can a lso use the Monitoring Studio built-in SNMP Browser tool to list the ava ilableO ID variables and the ir v a lues. R ight-click the main Monitoring Studio icon > KM Commands > Tools > SNMP Browser.
Step 3: Parameter Selection
135Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Select the parameter you wish to collect:
SNM P Polling W iza rd — Pa ra m e te r Se le ct ion Pa ge
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 ofseconds elapsed between the collection times
Select the option "Discard negative Delta values" if you do not want negative values to be reportedon the graph.
Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extractedin order to have a more readable graph in the PATROL Console. The available rescaling optionsare:
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.
136Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 4: Monitoring Studio settings
SNM P Polling W iza rd — Se tt ings Pa ge
Multiple values from an SNMP Table
Step 2: Identifying the SNMP agent and the list of columns from theSNMP table to poll
137Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
SNM P Polling W iza rd — SNM P a ge nt ide ntifica t ion Pa ge
Host: Enter the IP of the computer running the SNMP agent that will be polled. If it is the sameserver 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 ManagementInformation 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 columnnumbers separated by commas. Example: 4,8,9.
If for some reason, the O ID cannot be polled, a message is displayed stat ing that the table seems to be empty .In such a case, v erify that you have entered the right O ID and/or that the table rea lly ex ists and has va lues.
Step 3: Monitoring Studio settings
SNM P Polling W iza rd — Se tt ings Pa ge
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 toselect the mode of setting alert thresholds:
138Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance will appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
Do not set any thresholds: No thresholds will be set on any parameter of the instance, and as aresult no alerts will be triggered. Monitoring Studio will poll the object and return the output of thepolling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM commands > Set Thresholds.
For details on the parameters discovered, please refer to the Reference Guide. SNMP Polling objects areinstances 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 dependingon the traps received, thereby ensuring optimal functioning of applications or devices that use SNMPtraps.
SNMP Traps are network packets containing data about a component of the system. They are generatedby an SNMP agent when certain conditions are met and then sent to an SNMP Trap listener. Manyapplications 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 suchapplications.
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 toquickly take care of the problem. You can:
139Monitoring Features
Monitoring Studio KM for PATROL
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 PATROLConsole and select KM Commands > New > SNMP Trap listening....
SNM P Tra p Liste ning W iza rd — W e lcom e Pa ge
To edit an existing SNMP Trap listening, right-click the SNMP Trap listening icon in the PATROLConsole and select KM Commands > Edit.
140Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Identifying the agent and the traps to listen to
SNM P Tra p Liste ning W iza rd — A ge nt ide ntifica t ion Pa ge
IP address: IP address of the computer or device where the SNMP agent is running and that willsend the SNMP traps. You can leave this field empty to listen to SNMP traps from multiplecomputers or devices.
Community: Specifies the SNMP community name in which the Agent will be listening. Public isusually 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 withinthe attached variable content will be case sensitive.
All these pieces of information define the SNMP Trap that is expected. Monitoring Studio will react to theSNMP Trap received only if this information is found within the SNMP Trap. All other SNMP Traps will beignored.
If y ou are unsure about the characterist ics of the SNMP trap you want to detect, you will need to use a SNMP MIBBrowser tool to understand the exact meaning of each trap. You can a lso use the Monitoring Studio built-in SNMPtrap listener tool to v iew in rea l t ime the SNMP traps and the ir characterist ics that are rece iv ed by the PATROLAgent. R ight-click on the main Monitoring Studio icon > KM commands > Tools > Rea l-t ime SNMP Trap Listener.
The SNMP trap listening port is actua lly a Patrol Agent conf iguration variable: /snmp/trap_port=162.You can set thisvariable to whatever port you want Monitoring Studio to listen on.
141Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
The SNMP Agent emitt ing the traps should be conf igured to send them to the PATROL Agent where Monitoring Studiois insta lled and running. If the SNMP agent is not properly conf igured, Monitoring Studio will not rece iv e any SNMPtrap.
Step 2: Automatic acknowledgement
SNM P Tra p Liste ning W iza rd — A utom a tic a cknowle dge m e nt Pa ge
Acknowledge alert(s) if the following SNMP Trap is received: Check the box if you wish toacknowledge 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 specifiedtrap.
OID1 & 2: Definition of the attached variables OID that should be contained within the SNMP trapto acknowledge a matching trap received.
Acknowledge alert(s) if the following timeout is reached: Check the box if you wish toacknowledge a matching SNMP trap after a certain time has been reached.
Timeout value: Time, in minutes, after which the matching SNMP Trap received, will beacknowledged. This value is only applicable if you have checked the "Acknowledge alert(s) if thefollowing 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
142Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3: Monitoring Studio settings
SNM P Tra p Liste ning W iza rd — Se tt ings Pa ge
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
SNMP Trap listening objects are instances of the SW_SNMP_TRAPS class.
143Monitoring Features
Monitoring Studio KM for PATROL
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 ofMonitoring Studio’s key features.
A "must be found" string search looks through the specified file and triggers an alert if the specifiedstring is not found. A "must not be found" string search triggers an alert when the specified string isfound.
It is possible to run string searches on mult i-line records, XML or HTML content. This is feasible owing to the Tex t Pre-processing tool. You use the Tex t Pre-processing tool to transform "complex " content, a f ter which you can run stringsearches on it or ex tract numeric v a lues f rom it. See Tex t Pre-processing for deta ils.
LOG file analysis
The most commonly used method to monitor an application is still LOG files analysis. Applications logproblems in a file as they occur. Monitoring this information helps in understanding the behavior andperformance of the application. Most log monitoring tools do not offer acknowledgement/recoveryactions. This is where the string search feature makes a difference: it not only allows you to search theLOG file for specified strings, but it is also enable automatic or manual acknowledgement of theseerrors.
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 theinformation source. Once you have defined the information source, you can specify a string search in avery 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 you specify should apply toone line; ex cept if y ou have a lready pre-processed this tex t and have converted mult i-line records to single lines. Seetopic Tex t pre-processing for more deta ils.
The string searching function works a bit dif ferently on "running sources" (LOG f iles and never-ending OS commands)than on f la t sources (f la t f iles, OS commands, W eb requests, e tc. ):
On "running sources" (LOG f iles and never ending OS commands), the strings are searched only in new linessince the last polling. For a string search in a running source, two graphs are built: Number of matches since thelast acknowledgement and Number of matches per minute since the last polling.In addit ion, for LOG f iles and "never-ending" OS commands, you can specify auto-acknowledging strings that willautomatica lly reset the graph to the "number of matches".
144Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
On "f la t sources" (f la t f iles, OS commands, W eb requests, database queries), the strings are searched in theentire source every t ime (the whole f ile , the whole standard output, the whole HTTP response, the wholedataset). For a string search in a f la t source, one graph is built: Number of matches at the current polling.
You cannot use auto-acknowledging strings in f la t sources (it is not applicable because the parameter restarts f rom ‘0’a t each polling), but you can specify : Location/area of the source in which to search: n lines, pre-f ilter, e tc.
Create or edit a string search
To create a new string search, right-click the information source icon (file, Web request, etc.) in thePATROL 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 selectKM Commands > Edit.
Step 1: Specifying what to search for
String Se a rch W iza rd — Se a rch de finit ion Pa ge
Search for lines that:
Contain/do not contain: You can enter up to two strings (regular expressions) to look for, anddecide 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 thetwo 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 thestring
145Monitoring Features
Monitoring Studio KM for PATROL
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 offsetin 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 startsfrom 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 specificcolumn in the line, you must specify how to identify that column by entering the column number andspecifying the separator.
Click the column separator tab in order to select the appropriate field separator. The following panelshows the available default separators: blank space, semicolon, tabulation, comma, and pipe.
String Se a rch W iza rd — Colum n se pa ra tor de finit ion
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 thatconsecutive separators must be treated as a single separator.
Consecutive separators mean empty columns: Each separator is treated as an individualcolumn separator and the column is considered empty.
The above two options are especially useful for data separated by blanks.
146Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 2: Line selection (flat source only)
String Se a rch W iza rd — Line se le ct ion (for fla t source only )
This window is only displayed when a string search in a flat source (flat file, command line, Webrequest, 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 thespecified source.
Search for the String(s) only in the following line numbers: Enter the list of line numbersyou 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
147Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 2: Automatic acknowledgement of alerts (LOG files and "never-ending" command lines only)
String Se a rch W iza rd — A utom a tic a cknowle dge m e nt
This dialog-box is displayed only for a string search on a "running source" (LOG file and never-endingOS commands).
In such a case, each time the specified strings are found, the MatchingLineCount parameter increasesand triggers an alert. The automatic acknowledgement feature allows you to reset MatchingLineCountvalue 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 alertacknowledgement. A timeout expires since the last matching line found; enter the value (default is setto 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 previouslytriggered by this string search should be acknowledged at one time (the MatchingLineCount parametergoes back to zero), or if only one alert should be acknowledged (the MatchingLineCount parameter isdecreased by one)
148Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Reset the MatchingLineCount parameter to zero (clear all previous alerts)
Decrease the MatchingLineCount by one (clear the previous alert)
Step 3: Monitoring Studio settings
String Se a rch W iza rd — Se tt ings Pa ge
Object display name: Label that will be displayed in the PATROL Console for this string searchobject.
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
149Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 inorder to be able to run string searches and/or numeric value searches on this content and then analyzeand 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 normalstring or numeric value searches on paragraphs, it limits the monitoring and analyzing capabilities ofsuch content.
Monitoring Studio allows you to transform the paragraphs of the text into single lines for easy parsingwith the String Search and Numeric Values Extraction tools. String Search and Numeric Value Extractionobjects 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:
150Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
The aim here is to detect any disconnected cards. So we add a monitoring instance for the OScommand ipconfig/all. But as the text is in paragraphs, a direct string search will not get the desiredresult in this case – which is why we run the Text pre-processing tool to convert the multi-line text tosingle lines.
In the screenshot below, the "ipconfig /all" command is executed and its output is pre-processed totransform its paragraphs into single lines, which in turn enables an efficient parsing with a Stringsearch 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 numericvalue 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, theoutput 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 thePATROL Console and select KM Commands > New > Text Preprocessing....
151Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Te xt Pre -Proce ss ing W iza rd — W e lcom e Pa ge
To edit an existing Text preprocessing object, right-click the Text Preprocessing icon in the PATROLConsole 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, aCommand Line analysis, etc.), right-click this object > KM Commands > New > Text Pre-Processing….
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.
152Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Select the "Convert multi-line records into single lines" option
Te xt Pre -Proce ss ing W iza rd: Conv e rt m ult i-line re cords into s ingle line s — Conv e rs ion Ty pe Se le ct ion
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".
153Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Te xt Pre -Proce ss ing W iza rd: Conv e rt m ult i-line re cords into s ingle line s — Sta rt/End of line de finit ion
This RegExp marks the beginning of a new record: Enter the word/regular expression or stringthat marks the beginning of a new record. Include the first line in the result: Check the case to includethe first line in the result.
Use the f irst f ie ld if y ou can prov ide a regular expression that identif ies the f irst line of each paragraph. Please notethat this regular expression can match with any part of the f irst line of each paragraph.
This RegExp marks the end of a new record: Enter the word/regular expression or string thatmarks 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 f ie ld if y ou can prov ide a regular expression that identif ies the last line of each paragraph. Aga in,this regular expression 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 toseparate each record or enter the character you wish as a separator.
Click Next.
You can specify only a regular expression that identif ies the beginning of a new paragraph (record). In this case,Monitoring Studio skips the content until it f inds a line matching with the specif ied criteria . The tex t that follows thisline (and optiona lly including this f irst line) is concatenated in a single line by using the specif ied separator, untilMonitoring Studio f inds another line that matches with the specif ied regular expression. Each line in the origina lcontent that matches with this regular expression produces a new line in the result content. The same is true for theregular expression that marks the end of a paragraph (or record).
If y ou specify both regular expressions to identify the beginning and the end of a record, Monitoring Studio will onlytake into account the tex t content that is in between lines that matches these regular expressions (i. e . between thestart line and the end line). Lines in the origina l tex t between a line matching the end marker and the nex t linematching the beginning marker will be skipped and not integrated in the tex t result.
Step 3: Monitoring Studio settings
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.
154Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Te xt Pre -Proce ss ing W iza rd: Conv e rt m ult i-line re cords into s ingle line s — Obje ct Ide ntifica t ion
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/orextract numeric values from it.
B - Convert XML to CSV (comma separated values) ( seeexample)
Right-click the file object > KM Commands > New > Text Pre-Processing….
155Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Select "Convert XML to CSV"
Te xt Pre -Proce ss ing W iza rd: Conv e rt XM L to CSV — Conv e rs ion Ty pe Se le ct ion
Click Next.
Step 2: Define the record, the sub-objects and properties
Te xt Pre -Proce ss ing W iza rd: Conv e rt XM L to CSV — Obje ct De finit ion
156Monitoring Features
Monitoring Studio KM for PATROL
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 andproperties
Concatenation of sub-objects and properties into a single line: Enter a separator to concatenate
Click Next.
Step 3: Monitoring Studio settings
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.
Te xt Pre -Proce ss ing W iza rd: Conv e rt XM L to CSV — Obje ct Ide ntifica t ion
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/orextract numeric values from it.
C - Extract text from HTML
This allows you to extract text from an HTML source and then run string or numeric value searches onthe output.
Right-click on a an instance with an HTML source/file (HTML file monitoring or web request, web farm
157Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
etc) > New > Text pre-processing.
Step 1: Select "Extract text from HTML"
Te xt Pre -Proce ss ing W iza rd: Extra ct te xt from HTM L — Conv e rs ion Ty pe Se le ct ion
Click Next.
Step 2: Panel confirms extraction of text from HTML source
158Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Te xt Pre -Proce ss ing W iza rd: Extra ct te xt from HTM L — Extra ct ion Confirm a tion
There are no options to select here, as Monitoring Studio is simply going to transform the HTML sourceby removing the HTML tags. It then displays the output in the parameter TransformResult.
Click Next.
Step 3: Monitoring Studio settings
Te xt Pre -Proce ss ing W iza rd: Extra ct te xt from HTM L — Obje ct Ide ntifica t ion
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 parameterTransformResult displays the output.
Step 4: Run a string search on the "transformed" output and/orextract numeric values from it.
D - Text processing through an external command
Some text inputs (files, output of commands, Web requests, etc.) may need to be transformed in aspecial way in order to be parsed with Monitoring Studio’s String Searches and Numeric ValueExtractions. If the built-in text transformation features of Monitoring Studio cannot handle such "speciallyformatted" text, you then have the possibility to process the content through a custom script or utilitythat performs the required transformation (i.e. it simplifies to process the content and makes it "stringsearch-ready").
The main advantage of processing the text through an external command feature is that it enables youto customize the processing of almost any source of information important to your application.
159Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Right click the File/Command Line/Web request/etc. object > New > KM commands > TextPre-processing…
Step 1: Select " Text processing through an external command "
Te xt Pre -Proce ss ing W iza rd: Te xt proce ss ing through a n e xte rna l com m a nd — Conv e rs ion Ty pe Se le ct ion
Click Next.
Step 2: Specify OS command to be executed to transform the text
160Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Te xt Pre -Proce ss ing W iza rd: Te xt proce ss ing through a n e xte rna l com m a nd — Com m a nd De finit ion
Command to be executed: Enter the command
The principle is v ery similar to the "pipe" mechanism of the UNIX she ll ex cept that the content is not passed direct ly butis stored in a temporary f ile and then the result needs to be stored in another temporary f ile .
Hence the command line you specify needs to take the % {INPUTFILE} macro as an argument (the % {INPUTFILE}macro is replaced by the rea l temporary input f ile location at run t ime) as well as % {OUTPUTFILE}.
The output of the command must match this RegExp to be considered as successful: Enter aRegExp to avoid typical path problems such as getting ""... not found" error messages instead of theproperly transformed text
If y our command line redirects its output to % {OUTPUTFILE}, the va lidation regular expression is like ly to fa ilbecause the standard output is empty and thus matches with nothing. Use a va lidation regular expression only ify our command line is able to produce both the % {OUTPUTFILE} and some tex t to its standard output.
Step 3: Monitoring Studio settings
Te xt Pre -Proce ss ing W iza rd: Te xt proce ss ing through a n e xte rna l com m a nd — Obje ct Ide ntifica t ion
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 parameterTransformResult displays the output.
161Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 4: Run a string search on the "transformed" output and/orextract numeric values from it.
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 yourPATROL environment along with the application monitoring under a single icon. It has the ability toquery the WMI repository for class and instance information. For example, you can request that WMIreturn all the objects representing shut-down events from your desktop system. You can also retrieveclass, instance, or schema data. Monitoring Studio enables you to run WMI queries remotely and youcan 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 consolidatingthe management of devices and applications in a network from Windows computing systems. WMI isthe Microsoft implementation of Web Based Enterprise Management (WBEM), which is built on theCommon Information Model (CIM), a computer industry standard for defining device and applicationcharacteristics so that system administrators and management programs can control devices andapplications 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 alsosupports 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 drivelabels, scheduling processes to run at specific times, backing up the object repository, and enabling ordisabling 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 ofcomputer systems, much like the dashboard instruments of cars can retrieve and display informationabout the state of the engine. WMI "instruments" by modeling objects such as disks, processes, or otherobjects found in Windows systems. For more information on WMI, please refer to About WMI in theReference section.
162Monitoring Features
Monitoring Studio KM for PATROL
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 andQueryStatus 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 lcom e Pa ge
To edit a WMI query analysis, right-click the WMI query icon > KM Commands > Edit.
163Monitoring Features
Monitoring Studio KM for PATROL
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 finit ion Pa ge
Hostname: Enter the host name or IP address.
Name space: Enter the WMI namespace. A namespace is a logical group of related classesrepresenting 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 ofthe WMI Administrative tools on the Microsoft site.
Username and Password: Enter your credentials: username and password
Click Next.
164Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 2: Monitoring Studio settings
W M I Que ry A na ly s is W iza rd — Se tt ings Pa ge
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
165Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 numericvalue 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 withinyour PATROL environment along with the application monitoring under a single icon. It has the ability toquery the WBEM repository for class and instance information.
Definition
Web-Based Enterprise Management (WBEM) is a set of systems management technologies developed tounify the management of distributed computing environments. WBEM is based on Internet standardsand Distributed Management Task Force (DMTF) open standards: Common Information Model (CIM)infrastructure and schema, CIM-XML, CIM operations over HTTP, and WS-Management. Although thename refers to WBEM as being "Web-Based", it is not necessarily tied in any way to a particular userinterface (see below). Other systems management approaches are remote shells, proprietary solutionsand network management architectures like SNMP.
What does WBEM do?
WBEM provides users with information about the status of local or remote computer systems. It alsosupports 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 drivelabels, scheduling processes to run at specific times, backing up the object repository, and enabling ordisabling error logging.
166Monitoring Features
Monitoring Studio KM for PATROL
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 andQueryStatus 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 lcom e Pa ge
To edit a WBEM query analysis, right-click the WBEM query icon > KM Commands > Edit.
167Monitoring Features
Monitoring Studio KM for PATROL
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 — Host Ide ntifica t ion Pa ge
Hostname: Enter the host name or IP address
Connect through port: Enter the port number you wish to use for the connection. By default, instandard environments, the port 5988 is used for non-encrypted data, while port 5989 is used for0encrypted data.
Name space: Enter the WBEM namespace. A namespace is a logical group of related classesrepresenting 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 HTTPSprotocol.Hyper Text Transfer Protocol Secure (HTTPS) is a secure version of the Hyper Text TransferProtocol (http) based on the SSL (Secure Sockets Layer) protocol. SSL creates a secure connectionbetween 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 variable used to specify the path to the jar f ile used to perform W BEM queries is: /MASA I/SENTRY8/wbemJarPath
Click Next.
168Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 2: Monitoring Studio settings
W BEM Que ry A na ly s is W iza rd — Se tt ings Pa ge
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
169Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 numericvalue 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 manyof 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 tosuccessfully measure and monitor the web farm’s overall availability to determine its success, and driveits improvement. Monitoring Studio essentially groups HTTP requests all together, allowing you to useall 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 andselect KM Commands > New > Web farm monitoring…
170Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W e b-Fa rm M onitoring W iza rd — W e lcom e Pa ge
Edit ing the webfarm instance is not feasible; but you can edit indiv idua l hosts (web –requests) under this web farm.You can add, edit and de lete the hosts grouped under the webfarm icon at any t ime.
Step 1: Enter the URL, select the type of HTTP request and specifydesired output
After the welcome panel of the Web farm monitoring wizard, you are asked to enter the URL to queryand the type of HTTP request.
171Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W e b Re que st A na ly s is W iza rd — De finit ion Pa ge
URL to query: Enter the URL of the web site that needs to be monitored. From a Windows agent, it ispossible 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 Webserver.
The "POST" mode (HTTP POST method) is classically used to post a form to a Web server andobtain the result of the processing of the form data. If you choose this mode, you must specifythe variables and values to be transmitted to the Web server.
Some W eb forms can be passed to the server with the HTTP GET method. In such case, the form data is passedthrough the URL (http://server/form.php?varA=va lueA&varB=va lueB&…). You must check the W eb form HTMLsource to know which method needs to be used (GET or POST).
W hen posting a form to a W eb server, you have to enter the URL of the script/CGI/page that will actua lly process thedata, which may be dif ferent f rom the W eb page URL that shows the form itse lf . Aga in, you need to check the W ebform HTML source to identify the URL to query .
A W eb form HTML source should conta in a statement like the following one: <FORM METHOD="POST" ACTION="/urlToQuery .php">
Timeout after: Enter the connection timeout period. The default is set to 30 seconds. When thistimeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on theServerConnectionState parameter.
172Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Proxy settings (optional): If your environment uses a proxy server, click to enter the proxy settingsrequired 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 moreinformation)
Password: Enter the password.
Specify what should be shown in the ReturnOutput parameter: Select what you would like toretrieve 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 onthe Web server.
Starting with version 8.5.00, Monitoring Studio supports HTTP authentication. The HTTP authenticationis 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 usercredentia ls 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 InternetExplorer:
173Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
HTTP a uthe ntica t ion
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 pla tform the W eb server isrunning 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 abase 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 orNTLM authentication, we recommend that you install Monitoring Studio on a Windows system and set upthe 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 Re que st A na ly s is W iza rd — GET M e thod Inform a tion Pa ge
Since a web-farm is composed of several servers, in this panel, you can enter up to 10 hosts that make-up the web-farm.
174Monitoring Features
Monitoring Studio KM for PATROL
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 thecase 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 Re que st A na ly s is W iza rd — POST Va ria ble s De finit ion Pa ge
Here, up to eight variables to post can be entered. For each variable, enter its name in the first box andits value in the second one.
Step 3-b: POST method -entering Host information
This is the same as for the GET method:
175Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W e b Re que st A na ly s is W iza rd — POST M e thod Inform a tion Pa ge
Since a web-farm is composed of several servers, in this panel, you can enter up to 10 hosts that make-up 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 thecase may be.
176Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Last Step for GET & POST methods: Monitoring Studio settings
W e b Re que st A na ly s is W iza rd — Se tt ings Pa ge
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
Web-farm monitoring objects are instances of the SW_HTTP_WEBFARM class.
177Monitoring Features
Monitoring Studio KM for PATROL
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, postforms, parse the HTML page that is returned, etc. Monitoring Studio enables you to ensure that end-users 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 PATROLConsole and select KM Commands > New > Web Request analysis…
W e b Re que st A na ly s is W iza rd — W e lcom e Pa ge
To edit an existing Web Request analysis, right-click the Web Request analysis icon in the PATROLConsole and select KM Commands > Edit.
Step 1: enter the URL, select the HTTP request type and specifydesired output
After the welcome panel of the wizard, the next panel (shown below) asks you to enter the URL toquery and the method to be used.
178Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W e b Re que st A na ly s is W iza rd — De finit ion Pa ge
URL to query: Enter the URL of the web site that needs to be monitored. From a Windows agent, it ispossible 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 f rom a W eb server. The "POST" mode(HTTP POST method) is classica lly used to post a form to a W eb server and obta in the result of the processing of theform data. If y ou choose this mode you need to specify which variables with what va lues must be passed to the W ebserver.
Some W eb forms can be passed to the server with the HTTP GET method. In this case, the form data goes throughthe URL (http://server/form.php?varA=va lueA&varB=va lueB&…).
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 server, you need to enter the URL of the script/CGI/page that will actua lly process the data ,which may be dif ferent f rom the W eb page URL that shows the form itse lf . Aga in, you need to check the W eb formHTML source to identify the URL to query .
A W eb form HTML source should conta in a statement like the following one: <FORM METHOD="POST" ACTION="/urlToQuery .php">
Timeout after: Enter the timeout period. The default is set to 30 seconds. When this timeout is
179Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
reached, Monitor Studio considers the host to be unreachable and triggers an alert on theServerConnectionState parameter.
Proxy settings (optional): If your environment uses a proxy server, click to enter the proxy settingsrequired 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 moreinformation)
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 entireHTTP 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 onthe Web server.
Starting with version 8.5.00, Monitoring Studio supports HTTP authentication. The HTTP authenticationis 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 usercredentia ls like on www.hotmail. com or www.yahoo.com or any public W ebmail serv ice .
A Web server that requires an HTTP authentication results in the following dialog box in InternetExplorer:
180Monitoring Features
Monitoring Studio KM for PATROL
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 pla tform the W eb server isrunning on.
When running on a Windows machine, Monitoring Studio supports Basic, Digest and NTLMauthentication 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 orNTLM authentication, we recommend that you install Monitoring Studio on a Windows system and set upthe 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:
181Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W e b Re que st A na ly s is W iza rd — Va ria ble s De finit ion Pa ge
Here, up to eight variables to post can be entered. For each variable, enter its name in the first box andits value in the second one.
The variable used to specify the path to the VB script used to perform web requests on W indows servers is: /MASA I/SENTRY8/windowsW ebRequestScriptPath
Click Next and you arrive at the last step of Monitoring Studio settings for this web request object
182Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Last Step GET and POST methods: Monitoring Studio settings
W e b Re que st A na ly s is W iza rd — Se tt ings Pa ge
Object display name: Label that will be displayed in the PATROL Console for this web requestmonitoring.
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
183Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 toconsolidating the application monitoring under just one icon (and not have to additionally look upWindows EventLog).
It also enables you to define automatic acknowledgment of previously triggered alerts by specifying theWindows 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 theparameters MatchingEventRate and MatchingEventCount. You can set alert thresholds and automaticacknowledgements for the events found.
Create or edit a Windows Create or edit a Windowsevent monitoring
To create a new NT event, right-click the Application/Container icon in the PATROL Console andselect KM Commands > New > NT event monitoring...
To edit an existing NT Event monitoring, right-click the Windows Event icon in the PATROL Consoleand select KM Commands > Edit.
184Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Selecting the Windows Event log to monitor
W indows Ev e nt M onitoring W iza rd — W e lcom e Pa ge
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 eachsystem.
Step 2: Identifying the Windows Event to monitor
This panel is used to identify the Windows Event to monitor.
185Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W indows Ev e nt M onitoring W iza rd — Ev e nt Ide ntifica t ion Pa ge
Source: The software that logged the event, which can be either a program name such as "SQLServer," 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, orWarning in the system and application logs; Success Audit or Failure Audit in the security log. In theEvent 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 lineof 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 thedescription of such an event is "The Event log service was started." The Event ID and the Source canbe used by product support representatives to troubleshoot system problems.
Optional information: Arguments (insertion strings) that create a description of the NT Event. Seethe 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
186Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
arguments can be chosen and it is possible to indicate whether the information entered in the textbound 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 theWindows Event description will be case sensitive.
If y ou are unsure about the characterist ics of the W indows event you want to detect, you will need to use theMonitoring Studio built-in W indows EventLog Reader tool to v iew content of the EventLogs and the characterist ics ofthe events, including the ir arguments (insert ion strings). right-click on the main Monitoring Studio icon > KMcommands > Tools > W indows EventLog Reader.
Step 3: Automatic acknowledgement configuration
The automatic acknowledging feature allows you to reset the MatchingEventCount parameter to zeroand its status to 'normal' – thereby, acknowledging the alert.. This can be done in the following twocases:
Acknowledge alert(s)if the following timeout is reached: A timeout since the last foundmatching Event
Acknowledge alert(s)if the following NT Event is found: Specify the Windows Event
187Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W indows Ev e nt M onitoring W iza rd — A le rt A cknowle dge m e nt De finit ion Pa ge
When this occurs, you can specify whether to:
Acknowledge all alerts, previously triggered by this Windows Event monitoring: All theprevious 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 beacknowledged (the MatchingEventCount parameter is thus decreased by one).
Click Next and you arrive at the last panel with the Monitoring Studio settings.
Step 4: Monitoring Studio settings
W indows Ev e nt M onitoring W iza rd — Se tt ings Pa ge
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 toselect the mode of setting alert thresholds:
188Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 ofyour applications, within your PATROL environment. Alerts can be set to provide immediate notificationin 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 andmeasures them. Theses objects can be processors, threads, processes, memory, etc., with each onehaving an associate set of counters and possibly instances. The data gathered by the Windowsperformances about specific components can be used to identify problems and bottlenecks within yourapplication and plan ahead for your future needs.
A Windows performance is defined by a performance object name and a counter name, as well asanything from none to several instances. Furthermore, each performance counter contains a unique setof counters and instances. Some objects are built into the system, typically corresponding to the majorhardware 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:
189Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Performance object: A logical collection of counters that is associated with a resource or servicethat 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 theperformance object.
Instance: A term used to distinguish between multiple performance objects of the same type on acomputer.
If an object has several instances, it is possible to monitor them either individually or all at once. In thelatter 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 thePATROL Console and select KM Commands > New > Windows Performance monitoring...
To edit an existing Windows Performance monitoring, right-click the Windows Performancemonitoring 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 todo is select an object from the list of available performances on your system.
190Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W indows Pe rform a nce M onitoring W iza rd — W e lcom e Pa ge
Step 2: Counter and instances
W indows Pe rform a nce M onitoring W iza rd — De finit ion Pa ge
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 objectinstances. Select which one(s) you wish to monitor from the list.
Select a counter: The counters available for the selected Windows Performance object are listedhere. 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 inbytes, so, to obtain the value in mega-bytes (MB), type "1024" in the field for scale. By default, thescale value is 1 (no scale).
PATROL object creation and type of value obtained: This is only relevant if more than oneinstance is selected. The radio buttons at the bottom of the panel can be used to select the creationmode of the Windows performance PATROL object instance:
191Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Create one PATROL object per instance: All selected instances will have their own PATROL objectand will be monitored separately.
Group all selected instances into one PATROL object: All selected instances are grouped into onePATROL object and are monitored all together. If you select this option, you must choose one of thefollowing:
Calculate average of all selected instances for selected counter: Each value will be addedthen divided by the number of instances. So the average value of all the selected instances will bemonitored.
Use minimum value of all selected instances for selected counter: The minimum value ofthe different selected instances will be monitored.
Use maximum value of all selected instances for selected counter: The maximum value ofthe different selected instances will be monitored.
Calculate total value of all selected instances for selected counter: The value of eachselected instance is added so the total value of all selected instances will be monitored.
Step 3: Monitoring Studio settings
W indows Pe rform a nce M onitoring W iza rd — Se tt ings Pa ge
Object display name: Label displayed in the PATROL Console for this Windows Performancemonitoring.
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 toselect the mode of setting alert thresholds:
192Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 applicationunder 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 Consoleand select KM Commands > New > Windows Service Monitoring...
193Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W indows Se rv ice M onitoring W iza rd — W e lcom e Pa ge
Monitoring Studio allows you to select a service from a list or to enter a service name manually. Selectone of the two available options:
Select a service from the existing list of services: To display a list of services currentlyinstalled 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 Windowsservice that is not currently installed on the managed system.
To edit an existing Windows service monitoring, right-click the Windows service icon in the PATROLConsole 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 previousstep, Monitoring Studio builds and displays a list of services currently installed on the server. Select theWindows Service you wish to monitor and click Next.
194Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
W indows Se rv ice M onitoring W iza rd — Se rv ice Se le ct ion Pa ge
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 isone of the two names that can identify a service and which is how the service configuration is stored inthe registry.
195Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Click Next to continue.
Step 2: Monitoring Studio settings
W indows Se rv ice M onitoring W iza rd — Se tt ings Pa ge
196Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Object display name: Label displayed in the PATROL Console for this Windows Servicesmonitoring.
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,and certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se tThre sholds .
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 thefollowing 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 thatsupplies tools for managing and monitoring applications, system objects, devices (e.g. printers) andservice oriented networks. Those resources are represented by objects called MBeans (for ManagedBean).
197Monitoring Features
Monitoring Studio KM for PATROL
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-drivennetworks. 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 knownas the instrumentation level.
The Agent level: the MBeanServer is the core of JMX. It is an intermediary between the MBean andthe applications.
The Remote Management level: enables remote applications to access the MBeanServer throughConnectors and Adaptors. A connector provides full remote access to the MBeanServer API usingvarious communication frameworks such as RMI, IIOP, JMS, WS-*; while an adaptor adapts the APIto 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, aservice, 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 withtheir 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-mentionedapplication servers and consolidate the monitoring of these MBeanServers along with the applicationmonitoring under a single icon. You need no longer interrogate the various application servers throughtheir 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 ofa running JVM. In this method, you use the getAttribute () method of MBeanServerConnection to get anattribute of a platform MBean, providing the MBean's ObjectName and the attribute name asparameters.
198Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Monitoring Studio can only poll the applicat ion servers and display the MBeans attributes and va lues. To create andregister new MBeans or modify ex ist ing ones, you are required to do so using the specif ic applicat ion serverinterface.
Method (summary)
To setup the monitoring and consolidate the querying of resources represented by Mbeans within yourPATROL environment, all you need to do is go through the JMX wizard of Monitoring Studio. The wizardpanels differ for each type of JMX application server, the following is just a summary of the overallmethod.
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 andpresents 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. Tomonitor several attributes of the same key property, you are required to go through the wizardeach time.
11. Click Finish. You can add a string or numeric value search if you wish.
Once a JMX polling is conf igured, Monitoring Studio uses that JMX Polling conf iguration by default whenever you adda new Java MBean Polling. This way , you do not have to re-enter the conf iguration sett ings each t ime.
The above-mentioned instructions giv e an overv iew of the procedure to poll a JMX server. Please refer to the sectionon a specif ic applicat ion server for exact deta ils and procedure. You can a lso consult the Input variables for JMX
polling wizards section to know what input is required for which type of applicat ion server.
199Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Generic JMX client using RMI or IIOP ProtocolsTo set-up the monitoring of a generic JMX client, right-click the main Monitoring Studio icon > KMCommands > New > Java MBean polling (JMX) and select the environment Generic from the drop-down list:
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — W e lcom e Pa ge
The applicat ion server should be started with the option: -Dcom.sun.management. jmx remote.port=portNumberUsing the above option starts a dedicated JMX agent for this part icular applicat ion. The Monitoring Studio generic JMXclient needs to use this port number to establish a connection.
200Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Enter the generic environment connection information
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — Conne ction Inform a tion Pa ge
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 RMI or IIOP. If y ou use theprotocol RMI the default server name is “jmx rmi” and if y ou use the IIOP protocol then the default server name is“jmx iiop”.
201Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 2: Enter the connection account credentials:
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — Conne ction A ccount Cre de ntia ls Pa ge
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 settingsare correct.
Connection timeout period: Default is set to 120 seconds; you can change this if you wish. Whenthis timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alerton the ExecutionStatus parameter.
Click Next.
Step 3: Select domain
If the credentials entered are correct, Monitoring Studio connects to the application server and presentsa list of domains for you to select from. Select the domain to monitor and click Next.
202Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — Dom a in Se le ct ion Pa ge
Step 4: Select the key property
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — Ke y Prope rty Pa ge
Select the key property to monitor in this domain and click Next.
203Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 5: Select the attribute
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — A ttribute Se le ct ion Pa ge
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, youare 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 additionalpanel is displayed to allow you to select the parameters to collect.
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — Pa ra m e te rs Se le ct ion Pa ge
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 ofseconds elapsed between the collection times
204Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Select the option "Discard negative Delta values" if you do not want negative values to be reportedon the graph.
Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extractedin order to have a more readable graph in the PATROL Console. The available rescaling optionsare:
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).
Step 6: Monitoring Studio settings
You arrive at the final step of the wizard that displays the object display name, ID and threshold options.
Ja v a M Be a n Polling W iza rd (Ge ne ric Env ironm e nt) — Se tt ings Pa ge
Object display name: Label displayed in the PATROL Console for this generic JMX applicationmonitoring.
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 toselect the mode of setting alert thresholds:
205Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se t Thre sholds.
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio iconbearing the name entered/displayed in the PATROL Label field; and at the next collect you will seevalues 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 WizardsHere is a recapitulative table with the input variables required to connect to the various JMX applicationservers.
JMXApplicationServer
Input Variables
JBoss by Redhat 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
206Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
JMXApplicationServer
Input Variables
Server name: Name given to the JOnAS application server
Initial context factory: com.sun.jndi.rmi.registry.RegistryContextFactory (by default). Can bemodified
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 informationInitial context factory: weblogic.jndi.WLInitialContextFactory (by default) Can be modified
For WebLogic 9.xJNDI: weblogic.management.mbeanservers.domainruntime (by default). Can be modified
For WebLogic 8.xServer 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 thenumber 8880 and every profile created on WebSphere is allotted a new SOAP port number byincreasing the count from 8880. This can be modified.
To connect to the W ebSphere AS, it is essentia l to connect to certa in credentia l f iles:C lientKeyF ile . jks and C lientTrustF ile . jks. These f iles are prof ile -specif ic and are created andstored by W ebSphere under % IBM_HOME% \prof ile\prof ilename\etc.Depending on the security of your env ironment, e ither giv e the path to these f iles to where theW ebSphere AS resides, or, copy them from there to your loca l f ile -sy stem.
TrustStoreFile path: Enter the path to the file ClientTrustFile.jks.
TrustStore password: Enter the password created on WebSphere for your profile (defaultWebAS)
KeyStoreFile path: Enter the path to the file ClientKeyFile.jks
KeyStore password: Enter the password created on WebSphere for your profile (defaultWebAS)
Server name: Name of the WebSphere application server.
Node name: Enter node name allotted to your profile. By default WebSphere assigns a uniquenode name to each profile created.
Connection Account
Principle: Username
Credentials: Password
Path to Java on the local server: java home path
207Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
JMXApplicationServer
Input Variables
Generic JMXapplications
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 serverProtocol: Name of protocol
The Monitoring Studio generic client connects to the JMX agent using the protocol RMI or IIOP. Ifyou use the protocol RMI the default server name is “jmx rmi” and if y ou use the IIOP protocolthen the default server 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 part icular applicat ion. The MonitoringStudio generic JMX client needs to use this port number to establish a connection.
JBossJBoss is an open source Java EE-based application server implemented in Java. As the JBoss ApplicationServer is 100% pure Java, it is interoperable with most operating systems that are capable of running aJava Virtual Machine (JVM); including Red Hat Enterprise Linux, SUSE Linux, Microsoft Windows, SunSolaris, 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 theenvironment: JBoss 3.2.x or 4.x.
208Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — W e lcom e Pa ge
Step 1: Enter the server connection information and the additionalinformation
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — Conne ction Inform a tion Pa ge
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:
209Monitoring Features
Monitoring Studio KM for PATROL
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
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — Conne ction A ccount Cre de ntia ls Pa ge
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 arecorrect. You can choose to execute additional JAR files by clicking the External JAR files button andenter the JAR files names and locations.
Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When thistimeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on theExecutionStatus parameter.
Click Next. If the credentials entered are correct, Monitoring Studio connects to the application serverand presents a list of domains for you to select from.
210Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 3: Select the domain
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — Dom a in Se le ct ion Pa ge
Select the domain to monitor and click Next.
211Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 4: Select the key property
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — Ke y Prope rty Pa ge
Select the key property to monitor from this domain and click Next.
Step 5: Select the attribute
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — A ttribute Se le ct ion Pa ge
212Monitoring Features
Monitoring Studio KM for PATROL
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, youare required to go through the wizard for each attribute.
Step 5a: Select parameters to collect
When you select a numeric attribute (boolean, integer, number) at the previous step, an additionalpanel is displayed to allow you to select the parameters to collect.
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — Pa ra m e te rs Se le ct ion Pa ge
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 ofseconds elapsed between the collection times
Select the option "Discard negative Delta values" if you do not want negative values to be reportedon the graph.
Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extractedin order to have a more readable graph in the PATROL Console. The available rescaling optionsare:
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
213Monitoring Features
Monitoring Studio KM for PATROL
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).
Step 6: Monitoring Studio settings
Ja v a M Be a n Polling W iza rd (JBoss Env ironm e nt) — Se tt ings Pa ge
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
214Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se t Thre sholds.
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 monitoredobject.
You can add a string or numeric value search if you wish.
JBoss objects are instances of the SW_JMX class.
WebSphereIBM® WebSphere Application Server is the foundation of the IBM WebSphere software platform, and akey 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 highperformance transaction engine that can help you build, run, integrate and manage dynamic OnDemand Business™ applications.
To monitor a WebSphere application server within your PATROL environment:
Before sett ing-up the monitoring of a W ebSphere AS, you need to download the W ebSphere. jar f iles created to workwith Monitoring Studio f rom the Sentry Software website and store them in (% Patrol_Home% \bin). These f iles areessentia l in order to connect to your W ebSphere AS through Monitoring Studio. The f iles for W ebSphere 5.x aredif ferent f rom those for W ebSphere 6.x , so please ensure you download the correct f iles f rom the Sentry Softwarewebsite .
After ensuring that the required files are present on the local host, right-click the main MonitoringStudio 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.
215Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — W e lcom e Pa ge
Dif ference in connecting to 5.x versus 6.x : The main dif ference between the 5.x and 6.x versions is that W ebSphere5.x requires IBM JVM whereas W ebSphere 6.x requires Sun JVM 1.5 and above. Please ensure you have the rightjava v irtua l machine depending on the version of your W ebSphere applicat ion servers.
216Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 1: Enter the environment connection information and theadditional information
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — Conne ction Inform a tion Pa ge
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 number8880 and every profile created on WebSphere is allotted a new SOAP port number by increasing thecount from 8880. This can be modified.
To connect to the W ebSphere AS, it is essentia l to connect to certa in credentia l f iles: C lientKeyF ile . jks andC lientTrustF ile . jks.These f iles are prof ile -specif ic and are created and stored by W ebSphere under % IBM_HOME%\prof ile\prof ilename\etc.Depending on the security of your env ironment, you can e ither giv e the path to these f iles on where the W ebSphereAS resides, or, just copy them from there to your loca l f ile -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)
217Monitoring Features
Monitoring Studio KM for PATROL
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 nodename to each profile created.
Click Next.
Step 2: Enter the connection account credentials
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — Conne ction A ccount Cre de ntia ls Pa ge
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 arecorrect.
Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When thistimeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on theExecutionStatus parameter.
Click Next. Ensure that all the settings are correct. If the credentials entered are correct, Monitoring
218Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Studio connects to the application server and presents a list of domains for you to select from.
Step 3: Select the domain
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — Dom a in Se le ct ion Pa ge
Select the domain to monitor and click Next.
Step 4: Select the key property
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — Ke y Prope rty Pa ge
Select the key property to monitor from this domain and click Next.
219Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 5: Select the attribute
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — A ttribute Se le ct ion Pa ge
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, youare 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 additionalpanel is displayed to allow you to select the parameters to collect.
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — Pa ra m e te rs Se le ct ion Pa ge
Value: Reports the actual value collected upon data polling
220Monitoring Features
Monitoring Studio KM for PATROL
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 ofseconds elapsed between the collection times
Select the option "Discard negative Delta values" if you do not want negative values to be reportedon the graph.
Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extractedin order to have a more readable graph in the PATROL Console. The available rescaling optionsare:
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).
Step 6: Monitoring Studio settings
Ja v a M Be a n Polling W iza rd (W e bSphe re Env ironm e nt) — Se tt ings Pa ge
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 toselect the mode of setting alert thresholds:
221Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se t Thre sholds .
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio iconbearing the name entered/displayed in the Object display name field; and at the next collect you will seevalues 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.
JOnAsJOnAS is a leading edge Open Source implementation by OW2 of the Java EE specification.
Monitoring Studio KM for PATROL requires applicat ions classes ava ilable only with JVM 1.5. Prev ious versions of JVMare 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 drop-down list, select the environment: JOnAs 4.x.
222Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ja v a M Be a n Polling W iza rd (JOnA s Env ironm e nt) — W e lcom e Pa ge
Step 1: Enter the server connection information and the additionalinformation
Ja v a M Be a n Polling W iza rd (JOnA s Env ironm e nt) — Conne ction Inform a tion Pa ge
Host: Name of host server where the JOnAS application server is installed
223Monitoring Features
Monitoring Studio KM for PATROL
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.
Step 2: Enter the connection account credentials
Ja v a M Be a n Polling W iza rd (JOnA s Env ironm e nt) — Conne ction A ccount Cre de ntia ls Pa ge
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 arecorrect.
Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When this
224Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
timeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on theExecutionStatus parameter.
Click Next. If the credentials entered are correct, Monitoring Studio connects to the application serverand presents a list of domains for you to select from.
Step 3: Select the domain
Ja v a M Be a n Polling W iza rd (JOnA s Env ironm e nt) — Dom a in Se le ct ion Pa ge
Select the domain to monitor and click Next.
225Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 4: Select the key property
Ja v a M Be a n Polling W iza rd (JOnA s Env ironm e nt) — Ke y Prope rty Pa ge
Select the key property to monitor from this domain and click Next.
Step 5: Select the attribute
Ja v a M Be a n Polling W iza rd (JOnA s Env ironm e nt) — A ttribute Se le ct ion Pa ge
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, youare required to go through the wizard each time.
226Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 5a: Select parameters to collect
When you select a numeric attribute (boolean, integer, number) at the previous step, an additionalpanel is displayed to allow you to select the parameters to collect.
Ja v a M Be a n Polling W iza rd (JOnA S Env ironm e nt) — Pa ra m e te rs Se le ct ion Pa ge
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 ofseconds elapsed between the collection times
Select the option "Discard negative Delta values" if you do not want negative values to be reportedon the graph.
Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extractedin order to have a more readable graph in the PATROL Console. The available rescaling optionsare:
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
227Monitoring Features
Monitoring Studio KM for PATROL
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).
Step 6: Monitoring Studio settings
Ja v a M Be a n Polling W iza rd (JOnA s Env ironm e nt) — Se tt ings Pa ge
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 toselect 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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
228Monitoring Features
Monitoring Studio KM for PATROL
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 theoutput of the polling, but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se t Thre sholds.
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio iconbearing the name entered/displayed in the Object display name field; and at the next collect you will seevalues 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.
WebLogicBEA WebLogic is a J2EE Platform product family that includes a J2EE application server- WebLogicServer, an Enterprise Portal - WebLogic Portal, an Enterprise Application Integration platform, aTransaction Server and Infrastructure - WebLogic Tuxedo, a Telecommunication Platform - WebLogicCommunication 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 todownload certain WebLogic JAR files/zipped files from the Sentry Software download page and placethem into: %PATROL_home%/bin.
The f iles required by W ebLogic9.x are dif ferent f rom those required for W ebLogic 8.x . Please ensure you downloadthe correct f iles corresponding to your W ebLogic server version.
W ebLogic v8.x was created using JDK v1.4; therefore to run and poll W ebLogic 8.x , you need to run JVM v1.4. Noother JVM version will be able to run W ebLogic 8.x .W ebLogic v9.x was created using the JDK v1.5, you need JVM v1.5 and above to connect to this server.
Right-click the main Monitoring Studio icon > KM Commands > New > Java MBean polling(JMX) From the drop-down list, select the environment: WebLogic "x"
229Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — W e lcom e Pa ge
Step 1: Enter the server connection information and the additionalinformation
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — Conne ction Inform a tion Pa ge
Host: Name of host server where the WebLogic application server is installed.
Port: Port number. (By default: 7001). Can be modified
230Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
For W ebLogic 9.x :
Init ia l contex t factory : weblogic. jndi.W LInit ia lContex tFactory (by default). Can be modif ied
JNDI: weblogic.management.mbeanservers.domainruntime (by default). Can be modif ied
For W ebLogic 8.x
Init ia l contex t factory : weblogic. jndi.W LInit ia lContex tFactory (by default). Can be modif ied
Server name (optiona l): Enter the server name
Step 2: Enter the connection account credentials
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — Conne ction A ccount Cre de ntia ls Pa ge
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 arecorrect.
Connection timeout period: Default is set to 120 seconds; you can change this if you wish. When thistimeout is reached, Monitor Studio considers the host to be unreachable and triggers an alert on theExecutionStatus parameter.
231Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Click Next. If the credentials entered are correct, Monitoring Studio connects to the application serverand presents a list of domains for you to select from.
Step 3: Select the domain
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — Dom a in Se le ct ion Pa ge
Select the domain to monitor and click Next.
Step 4: Select the key property
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — Ke y Prope rty Pa ge
Select the key property to monitor from this domain and click Next.
232Monitoring Features
Monitoring Studio KM for PATROL
Version 8.6.53
Step 5: Select the attribute
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — A ttribute Se le ct ion Pa ge
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, youare 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 additionalpanel is displayed to allow you to select the parameters to collect.
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — Pa ra m e te rs Se le ct ion Pa ge
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
233Monitoring Features
Monitoring Studio KM for PATROL
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 reportedon the graph.
Use the Rescaling option to configure Monitoring Studio to rescale the value that is being extractedin order to have a more readable graph in the PATROL Console. The available rescaling optionsare:
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).
Step 6: Monitoring Studio settings
Ja v a M Be a n Polling W iza rd (W e bLogic Env ironm e nt) — Se tt ings Pa ge
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 toselect the mode of setting alert thresholds:
234Monitoring Features
Monitoring Studio KM for PATROL
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 oncertain parameters (see list of parameters with default thresholds) and then allows you tocustomize any/all of them. This is mainly intended to help save time if you wish to customize thethresholds of just one of many parameters for the instance, and leave the default settings for theothers.
If y ou se lect Use default thresholds and customize them; on clicking F inish, the Set Thresholds pane l will appear,certa in parameters for the instance may appear with an asterisk symbol - indicating that they a lready havethresholds. You can then customize (any /a ll) the thresholds of the parameters as per your specif ic needs.
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 theoutput of the polling – but will not raise any alerts until you set thresholds.
Thresholds can be set or modif ied at any time by right-clicking on the instance > KM com m a nds > Se t Thre sholds .
Click Finish. An icon for the monitored instance will appear under the main Monitoring Studio iconbearing the name entered/displayed in the Object display name field; and at the next collect you will seevalues 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 alertthresholds on various parameters. These alert thresholds typically depend on the application or devicesyou want to monitor.
Monitoring Studio uses a standard internal PATROL mechanism, often known as the Overrideparameters feature. It sets the alarm and warning thresholds you entered by setting a speciallyformatted variable under the /___tuning___ tree in the PATROL Agent configuration. This is thestandard method to set thresholds and is supported by BMC Software since version 3.4.11 of thePATROL 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 forEvent Management (formerly known as EventSpring) or PATROL Configuration Manager (PCM, formerlyknown as AgentSpring). Monitoring Studio fully supports PATROL for Event Management and is able tomanage its thresholds through this new mechanism.
235Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
By default, Monitoring Studio uses the Automatic method. This thresholds mode detects the type ofthresholds 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 > ThresholdsMechanism Selection.... The following dialog box appears:
Thre shold M e cha nism Se le ct ion — De fa ult opt ion
Select one of the three following options:
Automatic: Monitoring Studio automatically detects the way thresholds are managed by thePATROL Agent and uses the correct mode, either Tuning or PCM, accordingly. This is recommendedif you are unsure of the way thresholds are managed.
W hen the Automatic mode is used, Monitoring Studio will se lect PCM/Event Management to manage thresholds if the"AS_EVENTSPRING" class is stat ica lly loaded or pre loaded on the PATROL agent. O therwise, Monitoring Studio willuse the Tuning thresholds management mode.
Tuning: Monitoring Studio manages its thresholds through the standard Override parametersmechanism. 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 usePATROL for Event Management, it is recommended that you use this option.
Event Management: Monitoring Studio manages its thresholds through the Event Managementmechanism. Monitoring Studio is fully compatible with this mechanism. All classes are providedwithout any pre-set thresholds.
Once you se lect the Event Management threshold management method, you can modify and manage your thresholdse ither through the Monitoring Studio interface, or through Event Management. Thresholds are stored in the PATROLAgent conf iguration under the /AS tree. This option requires that you set up the PATROL for Event Management KMon your PATROL Agent. PATROL for Event Management has to be enabled and pre loaded. If y ou use PATROL forEvent Management in order to modify or customize your thresholds, it is recommended that you use this option.
236Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
In order to avoid side ef fects and unpredictable behav ior, if y ou change the thresholds management option,Monitoring Studio will automatica lly migrate the thresholds set through the prev ious method to the new method (onlyfor its monitored objects). That is: if y ou se lect the Event Management option, Monitoring Studio will automatica llyremove a ll the thresholds (set for its monitored objects) stored in the /___tuning___ tree in the PATROL Agentconf iguration, and set the same under in the Event Management database, under the /AS tree in the Agentconf iguration.
You may import a PATROL agent conf iguration (". cfg") with any type of thresholds. If necessary , Monitoring Studiowill convert the thresholds to the type of thresholds currently used at the nex t discovery (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. Thresholds are set and modified through the Threshold wizard accessible by right-clicking the instance > KM commands > Set Thresholds.
2. Select the parameter on which you wish to set/modify thresholds
3. Select the threshold "type": Simple (2 alerts can be triggered) or Advanced (3 alerts can betriggered)
4. 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 ThresholdsMonitoring 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 a lso be prompted immediate ly following the setup of a new monitoring object.The last pane l of the wizard of fers you the option of e ither accepting default thresholds, modify ing them right away ,or sett ing them la ter.
237Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Thre shold M a na ge m e nt W iza rd — W e lcom e Pa ge
A drop down list displays the parameters available for the instance.
An asterisk symbol "*" displayed nex t to the parameter name signif ies that the parameter a lready has thresholds.You can then choose to e ither 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 parametersavailable 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 user’s selection, both types of thresholds canraise 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 seethe section: Alert Actions capabilities for more details on the same.
238Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Simple Thresholds
Sim ple Thre sholds Se tt ings
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 specificrequirement, and the frequency of occurrence. This type of threshold can raise a maximum of twoalerts.
Certain parameters have "pre-defined" values. Basically these parameters are the ones with booleanvalues, so the choice you can make can only be only one or the other – depending on the parameteritself.
Advanced thresholds
Thre shold M a na ge r W iza rd – Pa ra m e te r Se le ct ion
239Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
To access the advanced threshold options, check the box for Use advanced thresholds… when youselect the parameter > click Next.
The advanced thresholds mode allows you to set up to a maximum of 3 alerts.
Thre shold M a na ge r W iza rd – Thre sholds Se tt ing
This type of threshold setting is a little more complex as it requires the user to enter specific ranges ofvalues as thresholds. This setting is like that of PATROL thresholds, where you have the possibility ofraising three alerts:
Border Alert: An alert can be triggered when the value polled is not between "x" and "x" andoccurs "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 Advanced Thresholds: In genera l, A lert A ctions are triggered only when aparameter breaches its thresholds. However for certa in parameters, such as MatchingTrapCount, MatchingLineCountand MatchingEventCount, it is possible to trigger A lert A ctions not just when thresholds are breached, but a lso eachtime an SNMP trap is rece iv ed or a matching line/event is found.This option Execute the A lert A ctions appears in the thresholds wizard for the parameters to which this feature isapplicable under the section for A larms.
Example
Let’s say you are setting thresholds on a string search. In this wizard you will find the optionExecute the Alert Action as string search has the parameter MatchingLineCount. If you selectExecute 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.
240Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Setting Thresholds on Dynamic Numeric ValueExtractionsMonitoring Studio enables you to set thresholds on Dynamic Numeric Value Extractions, that is NumericValue Extractions performed on instances of a Dynamic Object.
Extracting numeric values can help you analyze the Dynamic Items output (the output of a command, aweb page, the result of a SQL query, or WBEM query etc.). In order to apply this feature to all theDynamic Items in a single operation, the Dynamic Object Builder creates Templates instances of thefeature. While the standard Numeric Value Extraction feature apply to a single return output, Templatesapply 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 ValueExtraction (Template) > KM commands > Set thresholds and the threshold management wizardappears.
Step 1: Parameter Selection
Select the parameter on which you wish to apply the parameter and click Next.
Se t Thre shold W iza rd — Pa ra m e te r Se le ct ion Pa ge
An asterisk (*) displayed nex t to the parameter name signif ies that the parameter a lready has thresholds.
The Reference Guide lists a ll the classes with deta ils on the menu commands and the parameters ava ilable for eachclass.
241Thresholds and Alert Actions
Monitoring Studio KM for PATROL
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 Thre shold W iza rd — Dy na m ic Thre shold Se tt ing Pa ge
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" andoccurs "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 befound –use the %{<Column Number>} syntax–, or a regular static numeric threshold. Both dynamic andstatic thresholds can be mixed.
Since Monitoring Studio applies thresholds as def ined in the Threshold wizard and to avoid inconsistent a larms, makesure the Static and the Dynamic thresholds are in concordance with the va lues/columns of the ex tracted output.
Dynamic Numeric Va lue Ex tract ions can only be def ined when the location of the numeric v a lue in the Template is setto "in the column number "n""
Click Set thresholds to apply the thresholds to the parameter.
242Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Alert Actions DescriptionAlert Actions enables the PATROL administrator to choose/configure the execution of certain actionswhen an application goes into a state of alert, this is also referred to as recovery actions. With the AlertActions 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 whichthe notification of a problem is done for all instances in the application/root container. This meansthat any parameter within this application/root container that trigger an alert will perform the AlertActions set at the global level.
Specific Alert Actions are set individual parameters and generally indicate the actions to perform inorder to recover from a particular problem (e.g.: when this parameter goes into alarm - executethis recovery script). Therefore, specific Alert Actions need to be set for each parameter as theneed may be.
If a specific Alert Action is set on a parameter belonging to a root container already set to trigger GlobalAlert 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 applicat ion or conta inericon, you cannot set globa l A lert A ctions on them. Globa l A lert A ctions can only be set on an applicat ion conta iner andwill 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 andclick Next.
243Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Globa l A le rt A ct ion W iza rd — A le rt A ct ion Se le ct ion Pa ge
The next panel depends on your selection; if the selection requires further input (as for PATROL Eventcommand lines, or write a line to a LOG file etc.), enter the relevant text with the help of Alert Actionmacros, as in the example shown below:
Globa l A le rt A ct ion W iza rd — Input De finit ion Pa ge
Global Alert Actions have been set. Click Finish.
244Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Globa l A le rt A ct ion W iza rd — A le rt Exe cution Confirm a tion Pa ge
You can set addit iona l A lert A ctions on any /a ll of the monitored parameters by using "Specif ic A lert A ctions".
Example
Let’s 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 AlertActions will be triggered each time any parameter held under this application container goes into alertstate.
Specific Alert Actions set on parameters under this application container on which global Alert Actionshave been set, are triggered in addition to those set on the global level. This helps customize thealerts 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.
245Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Spe cific A le rt A ct ion W iza rd — Pa ra m e te r Se le ct ion Pa ge
The panel lists all the available specific Alert Actions. Make your selection and click Next.
Spe cific A le rt A ct ion W iza rd — A le rt A ct ion Se le ct ion Pa ge
246Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
The nex t pane l depends on the se lect ion. If the se lect ion requires further input (as for command lines, or write a lineto a LOG f ile etc. ), enter the re levant tex t, with the he lp of A lert A ction macros as in the example shown.
Enter the required input. Click Next.
Spe cific A le rt A ct ion W iza rd — Input De finit ion Pa ge
The next panel will confirm the selected Alert Action specific to the chosen parameter. Click Finish.
Spe cific A le rt A ct ion W iza rd — A le rt Exe cution Confirm a tion Pa ge
If/when the selected parameter goes into alert, it will trigger the specific Alert Action as configured.
Alert Actions CapabilitiesAlert Actions offers a large choice of actions in order to notify the administrator of a problem with theapplication or to recover from a particular problem. Monitoring Studio can be configured to run one orseveral types of actions when an alert is triggered by PATROL.
The following types of Alert Actions can be performed by Monitoring Studio:
247Thresholds and Alert Actions
Monitoring Studio KM for PATROL
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 displayedwith the event
A le rt A ct ions: Trigge r a PA TROL 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 parameter’s graph action, you need to enter the string that will bedisplayed within the annotation point.
248Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
A le rt A ct ions: A nnota te the pa ra m e te r's gra ph
Execute an OS command
If you select the Execute an OS command action, you need ton complete the following panel:
A le rt A ct ions: Exe cute a n OS com 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)
249Thresholds and Alert Actions
Monitoring Studio KM for PATROL
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 executedby the PATROL Agent. Although only a single line is permitted, it can have several PSL instructions.
A le rt A ct ions: Exe cute a PSL sta te m e nt
The PSL command is recommended for advanced user of PATROL.
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 messagethat will be displayed in the pop-up as well as the in title of the pop-up window.
250Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
A le rt A ct ions: Se nd a pop-up to the PA TROL Console 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 contentof the line.
A le rt A ct ions: W rite a line to a LOG file
251Thresholds and Alert Actions
Monitoring Studio KM for PATROL
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 ct ions: 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:
252Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
A le rt A ct ions: Se nd a custom 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:
253Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
A le rt A ct ions: 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 tomultiple recipients, use the comma (,) or the semi-column (;) to separate the recipients' emailaddresses (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 availablethrough 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.
254Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Alert Action MacrosA macro is a variable whose value is replaced when an Alert Action is triggered. Macros can be used tocustomize the content of each Alert Action.
For example: %{VALUE} is replaced by the actual current value of the parameter that triggered thealert. When used in the text field for a PATROL event Alert Action, the percentage value is replaced bythe 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 "object-specific" 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 Description
%{PARAMETER_NAME} Name of the parameter that triggered the alert
%{VALUE} Value of the parameter that triggered the alert
%{ALARM_TYPE} Type of the alert triggered (ALARM, WARN or INFORMATION)
%{OBJECT_ID} PATROL ID of the object triggering the alert
%{OBJECT_LABEL} Display name of the object triggering the alert
%{OBJECT_CLASS} Class (".KM") of the object triggering the alert
%{OBJECT_TYPE} Type of the object triggering the alert ("Process", "String", etc.)
%{PARENT_<PARENTMACRO>}
Gets the parent's object of a macro.Example: In the case of String Search performed in Command Line, use the followingmacro to get complete command line return output:%{PARENT_OSCOMMAND_RETURN_OUTPUT}
%{PARENT_ID} ID of the object’s parent triggering the alert (the parent of a String object could be aLOG file, e.g.)
%{PARENT_LABEL} Display name of the object’s parent triggering the alert
%{PARENT_CLASS} Class (".KM") of the object’s parent triggering the alert
%{PARENT_TYPE} Type of the object’s parent triggering the alert ("File", "OSCommand", etc.)
%{APPLICATION_ID} PATROL ID of the application triggering the alert
%{APPLICATION_LABEL} Display name of the application triggering the alert
%{APPLICATION_CLASS} Class (".KM") of the application triggering the alert
%{APPLICATION_TYPE} Type of the application triggering the alert ("Application")
%{APPLICATION_CONTACT} Contact information in case of an application failure
%{APPLICATION_DESCRIPTION}
Description of the application
255Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
General Macros Description
%{APPLICATION_EXISTENCEFILES}
List of files that identify the application as present
%{ASCTIME:…} Current time when the Alert Action is performed. Specify a formatting as describedunder Format Symbols in the Reference section.Example: %{TIME:%H:%M:%S} will be replaced by 09:45:17 at run time
%{NEWLINE} Inserts carriage return
%{/...} Recommended for advanced users onlyProvides an internal instance variable name to be inserted. The path is relative to theobject triggering the alert.Example: %{/worstParam} will be contain the name of the worst parameter on thisinstance, which is an application instance built-in variable (see the "PATROL ScriptLanguage Reference" document).
Object Specific Macros
Database Macros Description
%{DATABASE_TYPE} Type of the database. SQL Server or Oracle
%{DATABASE_QUERY} SQL statement sent for execution
%{DATABASE_NAME} Name of the database the SQL query is sent to. May be the databasename for SQL Server, or the Oracle SID for Oracle.
Dynamic Object Macros Description
%{DYNAMIC_RETUNR_OUTPUT} Returns the output of the dynamic object
File Macros Description
%{FILE_CURRENT_NAME} Current file being monitored when monitoring a file whose name changesover time)
%{FILE_NAME} Name of the monitored file as entered in the GUI
File System Macro Description
%{FILESYSTEM_NAME} Name of the monitored file system
Folder Macro Description
%{FOLDER_PATH} Folder being monitored
%{FOLDER_OLDEST_REMAINING_FILE} Folder with the oldest remaining file
HTTP Macros Description
%{HTTP_RETURN_OUTPUT} Result of the HTTP request
%{HTTP_METHOD} GET or POST depending on what was selected in the GUI
%{HTTP_URL} URL being tested
256Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
JMX Macros Description
%{JMXPOLLING_SERVER_TYPE} Type of JMX server being polled
%{JMXPOLLING_HOST} Host name of JMX server polled
%{JMXPOLLING_PORT} Port number of the JMX server polled
%{JMXPOLLING_DOMAIN} Domain of the JMX server polled
%{JMXPOLLING_KEY_PROPERTY} Key property of the JMX server polled
%{JMXPOLLING_ATTRIBUTE} Attribute of the JMX server polled
%{JMXPOLLING_CONTENT} Content of the result output of the JMX server polled
KM Watch Macros Description
%{KMWATCH_CLASS} Class of the PATROL object being monitored
%{KMWATCH_ID} Instance ID of the PATROL object being monitored
%{KMWATCH_PARAMETER} Parameter name of the PATROL object being monitored
MPF Macros Description
%{MPF_CLASS} Class of the PATROL object being monitored
%{MPF_ID} Instance ID of the PATROL object being monitored
%{MPF_FORMULA} User-defined formula used to rescale the parameter value
OS Command Macro Description
%{OSCOMMAND_OSCOMMAND} Command line being executed and analyzed
%{OSCOMMAND_RETURN_OUTPUT} Return output of the OS command
Process Macros Description
%{PROCESS_NAME} Process name being searched for, as entered in the GUI
%{PROCESS_COMMAND_LINE} Process command line being searched for, as entered in the GUI
%{PROCESS_USER_ID} Process user ID being searched for, as entered in the GUI
%{PROCESS_PID_FILE} Path to the PID file whose corresponding process is being monitored
SNMP Polling Macros Description
%{SNMPPOLLING_OID} SNMP OID being polled
%{SNMPPOLLING_HOST} SNMP Agent’s host name being polled
%{SNMPPOLLING_COMMUNITY} SNMP community string being used to query the SNMP agent
%{SNMPPOLLING_PORT} UDP port being used to poll the SNMP agent. 161 by default
%{SNMPPOLLING_CONTENT} Value of the OID being polled
257Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
SNMP Trap Macros Description
%{SNMPTRAP_IP} Originating IP Address of the SNMP traps being looked for
%{SNMPTRAP_FOUNDIP} Actual originating IP address of the trap that has been received
%{SNMPTRAP_COMMUNITY} SNMP community string of the SNMP traps being looked for
%{SNMPTRAP_ENTERPRISEID} Enterprise ID (OID) of the SNMP traps being looked for
%{SNMPTRAP_TRAPNUMBER} SNMP Trap numbers (specific numbers) being looked for
%{SNMPTRAP_FOUNDTRAPNUMBER} Actual SNMP trap number that has been received and matches theentered criteria
%{SNMPTRAP_CONTENT} Content of the found trap
String search Macros Description
%{STRING_SEARCHED_1} First regular expression being searched for
%{STRING_SEARCHED_2} Second regular expressions being searched for
%{STRING_LAST_MATCHING_LINE} Last line that match with the String search criteria
WMI Macros Description
%{WMI_HOST} Name of host where the WMI query is being run
%{WMI_NAME_SPACE} Namespace of the WMI query
%{WMI_QUERY} WMI statement sent for execution
%{WMI_USERNAME} WMI execution username
%{WMI_RETURN_OUTPUT} Content of the result output of the WMI query
WBEM Macros Description
%{WBEM_HOST} Name of host where the WBEM query is being run
%{WBEM_NAME_SPACE} Namespace of the WBEM query
%{WBEM_QUERY} WBEM statement sent for execution
%{WBEM_USERNAME} WBEM execution username
%{WBEM_RETURN_OUTPUT} Content of the result output of the WBEM query
Windows Event Macros Description
%{NTEVENT_LOG} Name of the Windows event log being monitored
%{NTEVENT_SOURCE} Windows Event source whose new entries are monitored
%{NTEVENT_ID} ID of the Windows events being searched for
%{NTEVENT_LAST_MATCHING} Last matching event found
%{NTEVENT_LAST_MATCHING_CONTENT} Content of the NT event
258Thresholds and Alert Actions
Monitoring Studio KM for PATROL
Version 8.6.53
Windows Performance Macros Description
%{PERFORMANCE_INSTANCELIST} Windows performance object instances being monitored
%{PERFORMANCE_COUNTER} Windows performance counter being monitored
%{PERFORMANCE_PERFORMANCE} Windows performance object name being monitored
Windows Service Macros Description
%{SERVICE_NAME} 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 afew useful features of Monitoring Studio such as cut/copy/paste and how to temporarily suspend themonitoring of an object.
Exporting Configuration to a FileThis feature provides a simple way to save the configuration of a PATROL Agent by exporting it to a filefor reuse later. The configuration saved in a file can then be loaded onto a different PATROL Agentthrough the PATROL interface. The main benefits are that it:
Eliminates the trouble of manually configuring Monitoring Studio on another PATROL Agent all overagain
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 configurationfiles.
Right-click the main Monitoring Studio icon > KM commands > Configuration > ExportConfiguration
259Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Configura t ion Export W iza rd — A pplica t ion/Conta ine r Se le ct ion Pa ge
If you select the option "Include Monitoring Studio global settings", you will arrive at this panel:
Configura t ion Export W iza rd — A pplica t ion/Conta ine r Se le ct ion Pa ge
Select the settings you wish to export and click Next.
Enter the path and file name of the file that will contain the PATROL Agent’s configuration:
260Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Configura t ion Export W iza rd — Configura t ion File Loca tion Pa ge
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 pconfigversion may not support large files.
Click Finish.
A successful export of the configuration will bring-up this panel:
Configura t ion Export W iza rd — Export Confirm a tion M e ssa ge
By default, the conf iguration f ile is created in the "% PATROL_HOME% \conf ig" directory and named"Export_SW _Sentry .cfg".
Exporting an application monitoring configuration
Exporting one or several application monitoring configurations works exactly the same way as exportingthe entire application. The main difference is that only the information relevant to the applicationmonitoring will be saved.
261Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Right-click the main Monitoring Studio icon > KM commands > Configuration > ExportConfiguration and select the application-monitoring to export from the drop down list:
Configura t ion Export W iza rd — A pplica t ion/Conta ine r Se le ct ion Pa ge
Or right-click an application or sub-application container > KM commands > ExportConfiguration.
Go through the same procedure of entering the destination file path and file name etc. as displayedabove for exporting the entire configuration. A confirmation message will pop-up once the configurationhas been successfully exported.
Importing ConfigurationThis feature provides a simple way configure a PATROL Agent by importing a configuration already inuse on another PATROL agent. It:
Eliminates the trouble of manually configuring Monitoring Studio on another PATROL Agent all overagain
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 andsaved (entire Monitoring Studio configuration and/or application monitoring).
262Administration Features
Monitoring Studio KM for PATROL
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 port ing Configura t ion W iza rd — W e lcom e Pa ge
Step 2: Select config file to import
Im port ing Configura t ion W iza rd — File Se le ct ion Pa ge
Select the configuration file and click Next. Monitoring Studio will detect the configuration files stored in
263Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
the entered path.
Step 3: Confirm import of global settings
Im port ing Configura t ion W iza rd — Globa l Se tt ing Im port Pa ge
Click Yes if you wish to import the global settings as well.
Importing globa l sett ings will impact the globa l sett ings on your ex ist ing objects. It will overwrite the old globa lsett ings. These globa l v ariables would have been specif ied and se lected/or not, during the export of thisconf iguration.For instance, take the case of the globa l v ariable for License. If the imported conf iguration has License4, and youaccept the globa l sett ings during the import, this is the license key that will now be assigned to the host which isimport ing the conf iguration.
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 tooverwrite the existing objects or make a copy.
264Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Im port ing Configura t ion W iza rd — Ex ist ing Obje cts Pa ge
Clicking Overwrite will overwrite existing objects and then on clicking Finish the summary of theimported objects will pop up:
Im port ing Configura t ion W iza rd — Ov e rride Confirm a tion Pa ge
Or
265Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Im port ing Configura t ion W iza rd — Im port Confirm a tion Pa ge (Ov e rride Option)
Selecting Make a copy instead of Overwrite will make a copy of the configuration in your consolewithout overwriting current existing objects. A panel will ask you to assign prefixes to these copiedobjects:
Im port ing Configura t ion W iza rd — Pre fix De finit ion Pa ge
Enter the prefix. The new panel will show a summary.
266Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Im port ing Configura t ion W iza rd — Im port Confirm a tion Pa ge (Copy with Pre fix )
Click Finish, and a panel confirming the import will pop-up
Im port ing Configura t ion W iza rd — Com ple te d Im port Confirm a tion Pa ge
On completion of the discovery process, you will see all the objects of the imported configuration in yourconsole.
Process Viewer ToolThe Process Viewer built-in tool helps the Monitoring Studio administrator identify the characteristics ofthe currently running processes and therefore monitor them in the most efficient way. To access theProcess Viewer tool:
Right-click on the main Monitoring Studio icon > KM commands > Tools > Process Viewer.
267Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Proce ss Vie we r
This window shows you how processes are currently seen by Monitoring Studio. It helps you enter thecriteria 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 IDOnce you have configured one or several monitoring tools, you may need to rename/modify somedisplay 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.
268Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
M odify ing a n Obje ct Na m e a nd/or ID
The Rename feature allows you to edit the object display name as well as the object ID. Make thechanges and click OK.
You will get a pop-up asking you to confirm the change of the object ID:
M odifica t ion of a n Obje ct Na m e a nd/or ID W a rning
If you are certain that the new ID will not cause any problems, click Yes, and the PATROL console willdisplay the new label and will update the ID as well.
269Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Process Command CredentialsMonitoring Studio KM for PATROL runs OS commands to collect process information. In order to gather allprocess information, advanced privileges are sometimes required.
On Windows Systems
1. Right-click the Monitoring Studio icon > Options > Process Command Credentials...
Se tt ing Proce ss Com m a nd Cre de ntia ls on W indows Sy ste m s
Monitoring Studio allows you to set or modify the process command credentials that will be used forrunning OS commands.
Enter a username and password or leave the fields blank if you want Monitoring Studio toautomatically 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 gatherinformation. Sometimes the PATROL Agent default account does not have sufficient privileges to executethese commands and it is not possible in your environment to give super-user rights to the PATROLAgent. 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 authorizingsome users to execute only certain commands specified as another user account (typically root). If thisapplies to you, the "sudo" options feature could be a good workaround.
270Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
1. Right-click the Monitoring Studio icon > Options > Process Command Credentials...
Se tt ing Proce ss Com m a nd Cre de ntia ls a nd Com m a nd Line on Unix/Linux Sy ste m s
2. Enter the user credentials to execute external "ps" command, or leave blank to use the defaultPATROL account
3. Enter the command line to execute the sudo utility
Ensure that the sudo utility is insta lled on the sy stem, and that the "/etc/sudoers" f ile is conf igured to a llow thePATROL Agent to execute the se lected commands as root.
SNMP Browser ToolThe SNMP Browser built-in tool allows the Monitoring Studio administrator to easily visualize thevariables (OID and values) available in an SNMP agent. This tool is very useful to identify which OID youneed to poll in the SNMP Polling wizard.
To set the SNMP Browser tool:
271Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
1. Right-click the main Monitoring Studio icon > KM commands > Tools > SNMP Browser
2. Enter the hostname or IP address of the computer where the SNMP agent is running
3. Enter its port (by default: 161) and its community
4. Specify the root OID from which you want to perform a "SNMP walk" (sort of SNMP dump)
5. Click the Update button. If the information entered is correct, the result of the SNMP walk is showna few seconds later, if not, an error message is displayed with some details about the failure. Youcan 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 t ime.
6. Click the Close button to quit the SNMP Browser tool.
SNMP Trap Listener ToolThe Real-time SNMP Trap Listener built-in tool allows you to visualize all of the SNMP traps and theircharacteristics received by the PATROL Agent and Monitoring Studio. This tool is pretty helpful when youwant to setup a SNMP Trap listening object in Monitoring Studio, but you ignore the characteristics ofthe 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 SNMPTrap 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 andtrap specific number) as well as their attached "varBinds" (attached variables). This will help youspecify the search criteria in the SNMP Trap Listening wizard.
The newest (or latest arrived) trap is shown first in the list.
2. Pause if you wish to stop the reception of traps and have more time to analyze the characteristicsof the previously arrived traps.
3. Resume to resume the listening.
4. Close to quit the tool window.
Due to an SNMP protocol limita t ion, it is not possible to have more than one program on one computer listening toSNMP traps (handling the UDP/162 port). If another program is listening to SNMP traps, Monitoring Studio is not ableto listen to SNMP traps and an error message is shown. For the same reason, it is not possible to use this tool andlisten for SNMP traps f rom a Monitoring Studio object in the PATROL Console . It may just be one or the other.
Setting Polling IntervalA polling interval defines how often new data is collected. A new collect can be performed from onceevery second, to once in a day. Monitoring Studio allows you to set/modify the polling interval of eachmonitored 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.
272Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
To access this feature, right-click the Application/Container icon > KM commands > Set PollingInterval.
Se tt ing a n A pplica t ion Polling 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 indicatethe 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 valuesselected indicate the time of the selected weekday. Example: 14; 30; 0 would mean that the pollingis done only once a week on <selected weekday> at 2:30pm (14:30 hrs)
The option to set polling interva ls is not ava ilable for string searches, numeric v a lues, tex t pre-processing,applicat ion/conta iners and SNMP trap instances, since e ither they do not have collectors, or as in the case of SNMPtraps – have collectors that react to events.
Behavior of polling interval for common collectors:
Common collectors
Certain collectors are "common collectors". A common collector fetches data for all the objects of itsclass at the same time. For instance, for Processes, the collector fetches data from all processes at thesame time.
The collection would be very resource-intensive (especially on UNIX) if the collector were to look fordata one-by-one for each running process. This is why certain classes/objects have "commoncollectors". These objects are: Process, Windows Events, Windows Systems and File Systems.
The common collectors are listed under the SW_SENTRY class.
273Administration Features
Monitoring Studio KM for PATROL
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, WindowsEvents, Windows Services and File Systems) – the polling interval will be applicable to all objects of thatparticular class.
Therefore, if you set the polling interval to "collect every 5 minutes" for a winlog.exe process that youare monitoring; all the process objects you are monitoring will also be polled every 5 minutes, since theSW_Process class has a common collector.
Java SettingsThe 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 pathleading 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.
Ja v a Se tt ings W iza rd — W e lcom e Pa ge
Select the Java executable detection method: Select one of the three following options:
274Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Let Monitoring Studio automatically detect the Java path: Select this option if you wishMonitoring 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 aJava executable directory within a list of pre-detected executables.
Enter manually the Java path to be used by Monitoring Studio: Select this option if youwish 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 Studiodisplays the path of the Java executable directory that will be used when performing commandsrequiring Java features.
Ja v a Se tt ings W iza rd — A utom a tic De te ct ion
Click Finish to save your settings.
User Selection
If you have selected the user selection option at the previous step of the wizard, Monitoring Studiodisplays a list of all the Java executable directory found on your machine.
275Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Ja v a Se tt ings W iza rd — Use r Se le ct ion
Select the Java executable directory you wish Monitoring Studio to use when performing commandsrequiring Java features and click Finish to save your settings.
Manual
Ja v a Se tt ings W iza rd — M a nua l Se tt ings
If you have selected the Manual option at the previous step of the wizard, Monitoring Studio let youenter the path to the Java executable directory you wish Monitoring Studio to use when performingcommands requiring Java features. Click Finish to save your settings.
276Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Windows EventLog Reader ToolThe 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, itsID and its arguments (or "insertion strings"), the criteria required for monitoring EventLogs.
As opposed to other common EventLog Reader tools ava ilable , this one shows ne ither the whole event descript ionstring nor the username that has logged the even, because these operations are resource-intensiv e. By doing so,Monitoring Studio a llows you to monitor rea lly heavy EventLogs 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 EventLogReader.
W indows Ev e ntLog Re a de r
2. Select the EventLog you wish to view and click the Update button to refresh the window. This maytake a few seconds to complete. The latest event is shown first in this list.
3. The last column in this window shows the arguments registered in each event.
4. There is one line per argument: the first argument line corresponds to the "Argument 1" field in theWindows Event monitoring wizard, the second argument line corresponds to the "Argument 2" field,etc.
5. To refresh the window, click the Update button.
6. To close the window, click the Close button.
277Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Setting the Discovery IntervalBy default, Monitoring Studio performs a discovery every hour to create, modify and update monitoredobjects, if necessary. However, you can easily change the default discovery interval to meet yourspecific needs.
1. Right-click the Monitoring Studio icon > Options > Discovery Interval...
Se tt ing Discov e ry Inte rv a l
2. Use the arrows to customize the discovery interval from once every 5 minutes to once every 24hours.
3. Click OK to save your settings.
Trigger a KM DiscoveryMonitoring 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 > KMCommands > Trigger a KM Discovery.
278Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Monitoring Studio Configuration Reports
Instant Configuration ReportsMonitoring 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 ss ing Configura t ion Re port Com m a nd
279Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Se tt ing the Configura t ion Re port Pa ra m e te rs
The report is generated in the selected format and saved in the defined location.
Exa m ple of a XM L Configura t ion Re port
Object Configuration Reports
The Object Configuration menu command generates an instant report on the configuration of all objects
280Administration Features
Monitoring Studio KM for PATROL
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 containericon: Monitoring Studio/Container icon > KM Commands > Configuration > DisplayObject Configuration. The report is generated and displayed instantly.
2. Configuration reports on individual objects: Object icon > KM Commands > Display ObjectConfiguration. The report is generated and displayed instantly.
Entire Configuration Reports
The Entire Configuration Report command enables you to generate an instant report of the configurationof all the monitored objects: Monitoring Studio icon > KM Commands > Configuration > DisplayEntire Configuration. The report is generated and displayed instantly.
Scheduling Configuration ReportsMonitoring 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 > ReportScheduler. The scheduling wizard appears.
281Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Re port Sche dule r W iza rd — W e lcom e Pa ge
Click Next.
The next panel enables you select the report output format and to configure the scheduling options.
Re port Sche dule r W iza rd — Sche duling Options Pa ge
The configuration report will include the entire configuration of all monitored objects under theMonitoring 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 toseparate 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 theconfirmation panel wizard.
282Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Every hour
Re port Sche dule r W iza rd — Ev e ry Hour Option
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 itsfilename. Available macros are listed under Macros of the Reference section. Using the givenmacros will enable you to have reports that are properly named with the hostname and time thereports are generated.
Click Next to continue.
The last step of the Configuration Report Scheduling Wizard confirms the specified settings. Click Finishto close the wizard.
Every day at a specific time
Indicate the time at which the report is to be generated.
283Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Re port Sche dule r W iza rd — Ev e ry Da y a t a Spe cific T im e Option
Click Next.
The Settings Panel is displayed to allow you to define the folder in which the file must be saved, thefilename 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 Finishto 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.
284Administration Features
Monitoring Studio KM for PATROL
Version 8.6.53
Re port Sche dule r W iza rd — Ev e ry W e e k a t a Spe cific T im e a nd Da y Option
Click Next.
The Settings Panel is displayed to allow you to define the folder in which the file must be saved, thefilename 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 Finishto 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.
Re port Sche dule r W iza rd — Ev e ry M onth a t a Spe cific T im e a nd Da y Option
Click Next.
The Settings Panel is displayed to allow you to define the folder in which the file must be saved, thefilename 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 thewizard.
285Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
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 orrestart an application, how to view file content or restart the scanning from the beginning of a file. Italso describes the Acknowledge all and reset option that is available to the String search, SNMP traps,and Windows Events tools.
Acknowledge and UpdateThis 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 accessrights etc).
Acknowledge all and ResetThis is applicable to String searches, SNMP traps and Windows events instances. Right-click the objecticon > KM commands > Acknowledge all and reset.
This menu command allows you to acknowledge all alerts and reset the MatchingTrapCount orMatchingEventCount parameter to zero.
Acknowledge AlertsThis option is applicable to all application classes except for String searches, SNMP traps and Windowsevents instances for which a specific command Acknowledge Alerts and Reset can be used toacknowledge all alerts and reset parameters to zero.
To acknowledge all alerts for a specific instance :
286Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
Version 8.6.53
1. Right-click the Object icon > KM Commands > Acknowledge Alerts...
A cknowle dging 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 thenreactivate. An acknowledging event will automatically be triggered.
No new data can be collected upon an a lert acknowledgment.
Copy, Cut and PasteOnce you have configured one or several monitoring tools, you may need to copy or move them under anew container, or duplicate the String searches that you have setup on one command line execution onanother one.
This can be done easily with the Copy, Cut and Paste feature of Monitoring Studio: Copy or Cut anyMonitoring 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 > Copyor Cut or Paste, depending on what you want to do.
287Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
Version 8.6.53
Cut/Copy KM Com m a nds
Some objects cannot be pasted in other objects. For example, you cannot paste a String search object in/under aProcess monitoring object. Basica lly , y ou can paste every thing everywhere that you would have been able to do withthe 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 > KMcommands > Delete.
This removes the icon and all dependencies from your console and it signifies that the object is nolonger monitored.
288Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
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 Studioicon in one step. right-click the main Monitoring Studio icon > KM commands >Delete All.
Deletion of objects is irreversible . Once you click on De lete/De lete a ll – you cannot undo the action.
Temporarily suspend the monitoring of an objectThis 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' statusand no information is collected for that particular object. The monitoring of the object, however, caneasily be restarted by selecting the Resume monitoring option in the menu.
Rename an ObjectMonitoring Studio provides two ways for renaming objects.
1. Right-click on the object icon > KM commands > Edit and follow the wizard steps until youarrive at the last panel shown below:
289Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
Version 8.6.53
Re na m ing a n obje ct
Change the object label/display name, and click Finish. The object icon will now display the newlabel 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.
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 odify ing a n obje ct ID
If you are certain that the new ID will not cause any problems, click Yes and the PATROL console willdisplay the new label and will update the ID as well.
Restart Scan from the Beginning of the FileWhen 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 thenext polling. This option offers the possibility to restart the scanning from the beginning of the file. Todo so:
1. Right-click the LOG File icon > KM commands > Restart scan from the Beginning of file.
2. A message asks for confirmation.
3. Click the Yes button to proceed. At the next polling, the entire file will be scanned.
Once this option has been se lected and conf irmed, it cannot be cance led.
290Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
Version 8.6.53
Restart an ApplicationIf Monitoring Studio warns you that the application you are monitoring is down, it is possible to re-launch 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 nnot Sta rt the A pplica t ion M e ssa ge
If the execution of the Start application command is confirmed, a window comes up with the output ofthe command being executed.
This option should be used by advanced users only .
Stop an ApplicationIt 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:
291Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
Version 8.6.53
Stop the A pplica t ion Confirm a tion M e ssa ge
If the execution of the Stop application command is confirmed, a window comes up with the output ofthe command being executed.
This option should be used by advanced users only .
See Also
How to restart an applicationSW_APPLICATIONSSW_SENTRY
View the Content of a FileMonitoring Studio provides an easy way to check the content of a file that is being monitored. To seethe file’s 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 theFile path.
The panel that opens offers you the options shown below:
292Operator Day-to-Day Tasks
Monitoring Studio KM for PATROL
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 othersections 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 anotherfile 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 yourselection and click Update
Only lines matching with (RegExp): Enter a regular expression and only the lines matching thisregular expression are displayed in the File content field.
File content: This is the where the content is displayed.
Examples
294
Monitoring Studio KM for PATROL
Version 8.6.53
This section shows two examples: one is about checking the availability of a website using theCommand 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 theLOG 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 shownbelow.
Se tt ing a n A le rt A ct ion on a String Se a rch Obje ct
295Alert Actions Example
Monitoring Studio KM for PATROL
Version 8.6.53
2. This launches the wizard to set specific Alert Actions, as shown in the screenshot below.
Se le ct ing the M a tchingLine Count 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 timea line containing the word "error" is found.
Click Next to carry on with the Alert Actions wizard.
296Alert Actions Example
Monitoring Studio KM for PATROL
Version 8.6.53
Se le ct ing a n A le rt
4. Select the type of action to be executed when the MatchingLineCount parameter goes into alertstate:
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 ; Theerror 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}Errormessage: %{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 inthe 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 tt ing 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]
297Alert Actions Example
Monitoring Studio KM for PATROL
Version 8.6.53
6. click the Next button to get to the final panel of the Alert Actions wizard that summarizes the AlertActions set for the MatchingLineCount parameter.
Confirm ing a n A le rt A ct ion
In this example you set just one Alert Action, Trigger a PATROL Event, but it would have been possibleto set several Alert Actions, such as an OS command that runs a recovery action for the monitoredapplication or writes an annotation to the graph built by the MatchingLineCount parameter with thecontent of the matching line.
XML LOG File Parsing
Monitoring the content of an XML LOG file withMonitoring 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 thatare being added to the file.
3. Specify the path to the file. You can use wildcards (* and ?) if the name of the file changes overtime (like a time-stamped LOG file). In such case, Monitoring Studio monitors the most recentlyupdated 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 topreprocess the XML text in order to then run string searches or perform numeric value extraction on theresult.
298XML LOG File Parsing
Monitoring Studio KM for PATROL
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 Pre-Processing… Select the Convert XML to CSV option.
Se le ct ing a Ty pe of Conv e rs ion to A pply to a Log 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>
299XML LOG File Parsing
Monitoring Studio KM for PATROL
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 executeservice 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.
300XML LOG File Parsing
Monitoring Studio KM for PATROL
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)
301XML LOG File Parsing
Monitoring Studio KM for PATROL
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. Let’s 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 includethe 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 Conv e rs ion 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.
302XML LOG File Parsing
Monitoring Studio KM for PATROL
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 pre-processing:
A cce ss ing the Re sult 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;
303XML LOG File Parsing
Monitoring Studio KM for PATROL
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".
304XML LOG File Parsing
Monitoring Studio KM for PATROL
Version 8.6.53
Pe rform ing a String Se a rch Com m a nd on a Conv e rte d File
We enter SEVERE in the field for the string to search for, and select the option in the following columnnumber and enter 2. Then we click the column separator tab and uncheck all except the semicolon andclick Accept. Finally, we click Next and follow the wizard steps as for any normal string search on a LOG file, keepingthe default values shown.
This brings us to the last panel, where we select the I want to use the default thresholds option.
305XML LOG File Parsing
Monitoring Studio KM for PATROL
Version 8.6.53
String Se a rch Confirm a tion
As a result, we get the following String search object: SEVERE under the XML-to-CSV pre-processingobject.
A cce ss ing the String Se a rch Re sults
You can create as many string searches as you want on a f ile and on a tex t-processing object, and you can createsevera l dif ferent tex t-processing objects on the same f ile object.
Troubleshooting
307
Monitoring Studio KM for PATROL
Version 8.6.53
This section deals with troubleshooting. It tells you how to enable the debug mode and then states themost 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 errormessages to the System Output Window of the PATROL Consoles. Most often, this information isaccurate 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 theDebug Mode and provide the debug output to the Sentry Software support team.
Ena bling De bug M ode
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 PATROLConsoles.
When debugging the discovery process of Monitoring Studio at the starting time of the Agent, somedebugging information may be lost by the PATROL Console, which is not yet connected to the PATROL
308Enabling the Debug Mode
Monitoring Studio KM for PATROL
Version 8.6.53
Agent.
In some other cases, such as when you want to trace the activity of Monitoring Studio for a fewminutes, 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 f ile is stored on the computer where the Agent is running.
Pay attention to the f ile size! The debug output of Monitoring Studio may make the f ile v ery la rge af ter running forsevera l day s. Do not forget to turn of f the debug mode once the necessary information is collected.
Reference Guide
310
Monitoring Studio KM for PATROL
Version 8.6.53
Introduction
This chapter gives you some additional information on Processes, WMI, Regular expression and Formatsymbols for macros.
About Processes
What’s a process
In practice, a process is basically a binary code being executed by processors. Processes are launchedby the operating system (since the operating system controls the execution flow) and have severalproperties: PID (unique identifier of a process); Name; User ID; Command line that was used to launchthe process (arguments passed to the binary); Environment; CPU and memory usage; Other variousOS-specific properties.
How to identify a process
When you monitor an application, you typically want to check that the application's processes arerunning properly. The problem lies in how to identify the processes of this application, how to recognizethem 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 integernumber randomly set upon the process startup, most often we cannot use it to identify the processes ofan 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 distinguishthem from other processes. If the name of the process is not sufficient, you can identify applicationprocesses by parsing the process’s command lines. This is typically useful with scripts and javaprocesses, 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 beingexecuted: Java.exe, IisAdmin.Exe. It always includes the ".EXE" extension. Process names can easily beshown in Windows Task Manager.
Under UNIX, the process name could be either the file name of the binary being executed, including thepath or not, or something completely different (e.g. Oracle processes).
The naming of processes is highly pla tform dependant. Linux processes are not named in the same way as on HP-UXservers, for example. Under UNIX, process names can be shown by executing the "ps –e –o name" command line.
311About Processes
Monitoring Studio KM for PATROL
Version 8.6.53
Process command line
Every process is launched through a command line, which consists of the file path to the binary whichhas 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 inthe command line: <binary file name> <argument1> <argument2> etc.
This is the only way to distinguish Java processes and scripts from others, because their process namesare all identical (Java.EXE). Unfortunately, in Windows, there is no easy way to see the command linesof the currently running processes. Under UNIX, processes command lines can be shown by executingthe "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 beallowed 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 iswhy it could be important to check that the processes of the application you want to monitor are runningas 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 givenfile. In this case we only need to read this file and check whether the PID written in the file correspondsto a running process. Please note that not the PID file is not provided for all the applications and mostWindows applications do not provide PIDs.
About WMI
Definition
Windows Management Instrumentation (WMI) is a set of specifications from Microsoft for consolidatingthe management of devices and applications in a network from Windows computing systems. WMI isthe Microsoft implementation of Web Based Enterprise Management (WBEM), which is built on theCommon Information Model (CIM), a computer industry standard for defining device and applicationcharacteristics so that system administrators and management programs can control devices andapplications from multiple manufacturers or sources in the same way.
312About WMI
Monitoring Studio KM for PATROL
Version 8.6.53
What does it do?
WMI provides users with information about the status of local or remote computer systems. It alsosupports 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 drivelabels, scheduling processes to run at specific times, backing up the object repository, and enabling ordisabling 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 internalstate of computer systems, much like the dashboard instruments of cars can retrieve and displayinformation 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 modeledusing classes such as Win32_LogicalDisk or Win32_Process; as you might expect, the Win32_LogicalDiskclass models the logical disks installed on a computer, and the Win32_Process class models anyprocesses currently running on a computer. Classes are based on the extensible schema called theCommon Information Model (CIM). The CIM schema is a public standard of the Distributed ManagementTask 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 classdefinitions that model WMI-managed resources. The repository holds the information required to workwith live resources in the computing environment. It does not contain actual data about these resourcessince this data is dynamically retrieved as required. It is this schema that allows the wide variety ofdifferent resources to be uniformly managed.
Namespace
CIM classes are organized into namespaces. Each namespace in the CIM contains a logical group ofrelated classes representing a specific technology or area of management. Anytime a connection ismade to WMI, a namespace must be specified. Only the classes contained within this namespace maybe accessed by the connection. The most common namespace used for Windows management isroot\cimv2. This contains the classes with the Win32_ prefix representing various components of theWindows operating system and hosting computer. Examples include Win32_Process (running processesin Windows), Win32_LogicalDisk (Windows logical disk drives), and Win32_ComputerSystem (thecomputer 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 Description
root\cimv2 Contains the most useful classes including all Win32_ classes
313About WMI
Monitoring Studio KM for PATROL
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 resourceand defines the properties that will be collected for that resource. Examples of common WMI classesare shown in the table below:.
Class Description
Win32_Process Processes running on a Windows computer
Win32_ComputerSystem The computer running a Windows operating system
CIM_DataFile A file stored on a disk
Instance
An Instance is a unique occurrence of a particular class. For example, each service installed on aWindows computer is an instance of the Win32_Service class. The C: drive is an instance of theWin32_LogicalDrive class.
Instance Description
Name Winmgmt
DisplayName Windows Management Instrumentation
PathName C:\WINDOWS\system32\svchost.exe -k netsvcs
StartMode Auto
State Running
Property
A property is unique piece of information about an instance. All instances of a class will have the sameset of properties although the values each instance’s properties may differ. Sample Properties of theWin32_Service class are shown in the table below:
Property Description
Name Unique name of the service.
DisplayName Displayed name of the service.
PathName The command line path that was executed to start the service.
StartMode Startup type of the service (Auto, Manual, or Disabled)
State 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
314About WMI
Monitoring Studio KM for PATROL
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 processescurrently running on the computer. Win32_Process is the name of the WMI class for Windowsprocesses.WMI queries of this type are often issued from a script using Windows Script Host or from anyapplication or tool that can access WMI. Queries retrieve specific information from instances of WMIresources or execute methods against instances to perform such actions as stopping services, orstarting processes.
Keyword Example code Description
SELECT SELECT * Specifies what properties are returned. Typically * isused to simply retrieve all.
FROM FROM __InstanceCreationEvent Specifies the event class to query. This will be theextrinsic or intrinsic event class.
WHERE WHERE TargetInstance ISA'Win32_Process' AND TargetInstance.Name = 'notepad.exe'
Filters the results. For intrinsic events, will usually includethe ISA keyword to specify the class of theTargetInstance.
In case you need help to build your WMI query, you could download WMI CIM Studio – which is one ofthe 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 tocustomize the content of each Alert Action.
For example: %{VALUE} is replaced by the actual current value of the parameter that triggered thealert. When used in the text field for a PATROL event Alert Action, the percentage value is replaced bythe 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 "object-specific" 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 Description
%{PARAMETER_NAME} Name of the parameter that triggered the alert
%{VALUE} Value of the parameter that triggered the alert
%{ALARM_TYPE} Type of the alert triggered (ALARM, WARN or INFORMATION)
%{OBJECT_ID} PATROL ID of the object triggering the alert
315Alert Action Macros
Monitoring Studio KM for PATROL
Version 8.6.53
General Macros Description
%{OBJECT_LABEL} Display name of the object triggering the alert
%{OBJECT_CLASS} Class (".KM") of the object triggering the alert
%{OBJECT_TYPE} Type of the object triggering the alert ("Process", "String", etc.)
%{PARENT_<PARENTMACRO>}
Gets the parent's object of a macro.Example: In the case of String Search performed in Command Line, use the followingmacro to get complete command line return output:%{PARENT_OSCOMMAND_RETURN_OUTPUT}
%{PARENT_ID} ID of the object’s parent triggering the alert (the parent of a String object could be aLOG file, e.g.)
%{PARENT_LABEL} Display name of the object’s parent triggering the alert
%{PARENT_CLASS} Class (".KM") of the object’s parent triggering the alert
%{PARENT_TYPE} Type of the object’s parent triggering the alert ("File", "OSCommand", etc.)
%{APPLICATION_ID} PATROL ID of the application triggering the alert
%{APPLICATION_LABEL} Display name of the application triggering the alert
%{APPLICATION_CLASS} Class (".KM") of the application triggering the alert
%{APPLICATION_TYPE} Type of the application triggering the alert ("Application")
%{APPLICATION_CONTACT} Contact information in case of an application failure
%{APPLICATION_DESCRIPTION}
Description of the application
%{APPLICATION_EXISTENCEFILES}
List of files that identify the application as present
%{ASCTIME:…} Current time when the Alert Action is performed. Specify a formatting as describedunder Format Symbols in the Reference section.Example: %{TIME:%H:%M:%S} will be replaced by 09:45:17 at run time
%{NEWLINE} Inserts carriage return
%{/...} Recommended for advanced users onlyProvides an internal instance variable name to be inserted. The path is relative to theobject triggering the alert.Example: %{/worstParam} will be contain the name of the worst parameter on thisinstance, which is an application instance built-in variable (see the "PATROL ScriptLanguage Reference" document).
Object Specific Macros
Database Macros Description
%{DATABASE_TYPE} Type of the database. SQL Server or Oracle
%{DATABASE_QUERY} SQL statement sent for execution
%{DATABASE_NAME} Name of the database the SQL query is sent to. May be the databasename for SQL Server, or the Oracle SID for Oracle.
Dynamic Object Macros Description
%{DYNAMIC_RETUNR_OUTPUT} Returns the output of the dynamic object
316Alert Action Macros
Monitoring Studio KM for PATROL
Version 8.6.53
File Macros Description
%{FILE_CURRENT_NAME} Current file being monitored when monitoring a file whose name changesover time)
%{FILE_NAME} Name of the monitored file as entered in the GUI
File System Macro Description
%{FILESYSTEM_NAME} Name of the monitored file system
Folder Macro Description
%{FOLDER_PATH} Folder being monitored
%{FOLDER_OLDEST_REMAINING_FILE} Folder with the oldest remaining file
HTTP Macros Description
%{HTTP_RETURN_OUTPUT} Result of the HTTP request
%{HTTP_METHOD} GET or POST depending on what was selected in the GUI
%{HTTP_URL} URL being tested
JMX Macros Description
%{JMXPOLLING_SERVER_TYPE} Type of JMX server being polled
%{JMXPOLLING_HOST} Host name of JMX server polled
%{JMXPOLLING_PORT} Port number of the JMX server polled
%{JMXPOLLING_DOMAIN} Domain of the JMX server polled
%{JMXPOLLING_KEY_PROPERTY} Key property of the JMX server polled
%{JMXPOLLING_ATTRIBUTE} Attribute of the JMX server polled
%{JMXPOLLING_CONTENT} Content of the result output of the JMX server polled
KM Watch Macros Description
%{KMWATCH_CLASS} Class of the PATROL object being monitored
%{KMWATCH_ID} Instance ID of the PATROL object being monitored
%{KMWATCH_PARAMETER} Parameter name of the PATROL object being monitored
MPF Macros Description
%{MPF_CLASS} Class of the PATROL object being monitored
%{MPF_ID} Instance ID of the PATROL object being monitored
%{MPF_FORMULA} User-defined formula used to rescale the parameter value
OS Command Macro Description
%{OSCOMMAND_OSCOMMAND} Command line being executed and analyzed
%{OSCOMMAND_RETURN_OUTPUT} Return output of the OS command
317Alert Action Macros
Monitoring Studio KM for PATROL
Version 8.6.53
Process Macros Description
%{PROCESS_NAME} Process name being searched for, as entered in the GUI
%{PROCESS_COMMAND_LINE} Process command line being searched for, as entered in the GUI
%{PROCESS_USER_ID} Process user ID being searched for, as entered in the GUI
%{PROCESS_PID_FILE} Path to the PID file whose corresponding process is being monitored
SNMP Polling Macros Description
%{SNMPPOLLING_OID} SNMP OID being polled
%{SNMPPOLLING_HOST} SNMP Agent’s host name being polled
%{SNMPPOLLING_COMMUNITY} SNMP community string being used to query the SNMP agent
%{SNMPPOLLING_PORT} UDP port being used to poll the SNMP agent. 161 by default
%{SNMPPOLLING_CONTENT} Value of the OID being polled
SNMP Trap Macros Description
%{SNMPTRAP_IP} Originating IP Address of the SNMP traps being looked for
%{SNMPTRAP_FOUNDIP} Actual originating IP address of the trap that has been received
%{SNMPTRAP_COMMUNITY} SNMP community string of the SNMP traps being looked for
%{SNMPTRAP_ENTERPRISEID} Enterprise ID (OID) of the SNMP traps being looked for
%{SNMPTRAP_TRAPNUMBER} SNMP Trap numbers (specific numbers) being looked for
%{SNMPTRAP_FOUNDTRAPNUMBER} Actual SNMP trap number that has been received and matches theentered criteria
%{SNMPTRAP_CONTENT} Content of the found trap
String search Macros Description
%{STRING_SEARCHED_1} First regular expression being searched for
%{STRING_SEARCHED_2} Second regular expressions being searched for
%{STRING_LAST_MATCHING_LINE} Last line that match with the String search criteria
WMI Macros Description
%{WMI_HOST} Name of host where the WMI query is being run
%{WMI_NAME_SPACE} Namespace of the WMI query
%{WMI_QUERY} WMI statement sent for execution
%{WMI_USERNAME} WMI execution username
%{WMI_RETURN_OUTPUT} Content of the result output of the WMI query
318Alert Action Macros
Monitoring Studio KM for PATROL
Version 8.6.53
WBEM Macros Description
%{WBEM_HOST} Name of host where the WBEM query is being run
%{WBEM_NAME_SPACE} Namespace of the WBEM query
%{WBEM_QUERY} WBEM statement sent for execution
%{WBEM_USERNAME} WBEM execution username
%{WBEM_RETURN_OUTPUT} Content of the result output of the WBEM query
Windows Event Macros Description
%{NTEVENT_LOG} Name of the Windows event log being monitored
%{NTEVENT_SOURCE} Windows Event source whose new entries are monitored
%{NTEVENT_ID} ID of the Windows events being searched for
%{NTEVENT_LAST_MATCHING} Last matching event found
%{NTEVENT_LAST_MATCHING_CONTENT} Content of the NT event
Windows Performance Macros Description
%{PERFORMANCE_INSTANCELIST} Windows performance object instances being monitored
%{PERFORMANCE_COUNTER} Windows performance counter being monitored
%{PERFORMANCE_PERFORMANCE} Windows performance object name being monitored
Windows Service Macros Description
%{SERVICE_NAME} 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 analysiswizard, and the Alert Actions wizard.
Format Description
%% This symbol allows you to use a percent sign (%) in the format of a date string
%a Locale's abbreviated name of the day of week
%A Locale's full name of the day of week
%b Locale's abbreviated name of the month
%B Locale's full name of the month
%c Locale's appropriate date and time representation
319Format Symbols for %{ASCTIME:…} Macros
Monitoring Studio KM for PATROL
Version 8.6.53
%C Data and time as %c
%d Day of month [1,31]; single digits are preceded by 0
%D Date as %m/%d/%y
%e Day of month [1,31]; single digits are preceded by a space
%h Locale's abbreviated name of the month
%H Hour (24-hour clock) [0,23]; single digits are preceded by 0
%I Hour (12-hour clock) [1,12]; single digits are preceded by 0
%j Day of year [1,366]; single digits are preceded by 0
%k Hour (24-hour clock) [0,23]; single digits are preceded by a space
%l Hour (12-hour clock) [1,12]; single digits are preceded by a space
%m Month as a decimal number [1,12]; single digits are preceded by 0
%M Minute [0,59]; leading zero is permitted but not required
%n Insert a new line
%p Locale's equivalent of either a.m. Or p.m.
%r Appropriate time representation in 12-hour clock format with %p
%R Time as %H:%M
%S Seconds [0,61]
%t Insert a tab
%T Time as %H:%M:%S
%u Day of week as a decimal number [1,7], with 1 representing Monday
%U Week of the year as a decimal number [0,53], with Sunday as the first day of week 1
%V Week of the year as a decimal number [01,53], with Monday as the first day of the weekIf 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.
%w Day of week as a decimal number [0,6], with 0 representing Sunday
%W Week of the year as a decimal number [0,53], with Monday as the first day of week 1
%x Locale's appropriate date representation
%X Locale's appropriate time representation
%y Year within century [0,99]
%Y Year, including the century (for example 1993)
%Z Abbreviated or full name of time zone, or no bytes if no information of the time zone exists
%Ec Locale's alternative appropriate date and time representation
%EC Name of the base year (period) in the locale's alternative representation
%Ex Locale's alternative date representation
%EX Locale's alternative time representation
%Ey Offset from %EC (year only) in the locale's alternative representation
%EY Alternative representation of the year in full
%Od Day of the month using the locale's alternative numeric symbols
320Format Symbols for %{ASCTIME:…} Macros
Monitoring Studio KM for PATROL
Version 8.6.53
%Oe Same as %Od
%OH Hour (24-hour clock) using the locale's alternative numeric symbols
%OI Hour (12-hour clock) using the locale's alternative numeric symbols
%Om Month using the locale's alternative numeric symbols
%OM Minutes using the locale's alternative numeric symbols
%OS Seconds using the locale's alternative numeric symbols
%OU Week of the year (Sunday as the first day of the week) using the locale's alternative numeric symbols
%Ow Day of week (Sunday=0) using the locale's alternative numeric symbols
%OW Week of the year (Monday as the first day of the week) using the locale's alternative numeric symbols
%Oy Year (offset from %C) in the locale's alternative representation and using the locale's alternative numericsymbols
Regular Expressions
Regular expressions are used in Monitoring Studio to define strings to be searched for. A regularexpression 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 thegrep, 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 Meaning
. (dot) Match any single characterExample:Err.. will match Err01, Err02 or ErrAB, etc.
[xyz] Match any character in the bracketsExample:Err[123] will match Err1, Err2 or Err3[Ee]rror will match either error or Error
[^xyz] Match any character not in the bracketsExample:Err[^12345] will match Err0, Err6, Err7, etc. but not Err1
[a-z] Match any character in the range in the bracketsExample:Err[0-9] will match Err0, Err1, etc. and Err9Err[A-Z][0-9] will match ErrA0, ErrA1, ErrS9, ErrZ0, etc. but not Err1AErr[A-Z0-9] will match ErrA0, ErrA1, etc. and Err1A
321Regular Expressions
Monitoring Studio KM for PATROL
Version 8.6.53
[^a-z] Match any character not in the range in the bracketsExample:Application[^0-9] will match ApplicationA, ApplicationB, Application! but not Application1
* Match zero or more repetitions of the precedingExample: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 Error0x000295F0 on ApplicationABC)
+ Match one or more repetitions of the precedingExample:Err[0-9A-F]+ will match Err0, ErrA, Err11, ErrBF0001, etc. but not Err
^ Match the beginning of the lineExample:^Err will match all lines that begin with Err
$ Match the end of the lineExample:[0-9]+ connections$ will match all lines that end with xxx connections where xxx is an integer
\< Match the beginning of a wordExample:\<set will match any line that contains a word that begins with set. It will not match a line that onlycontains the word unset
\> Match the end of a wordExample:[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 exprBExample:\(firewall\)\|\(antivirus\) will match all lines that contains either the word firewall or the word antivirus
\ Avoid the meaning of the following characterExample:\. 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 theparameters discovered and the menu commands available for each application class.
List of Application ClassesThere are 28 application classes in Monitoring Studio KM for PATROL. If the KM is properly loaded, thefollowing classes should be loaded on the monitored system and console:
Application Class Description
SW_APPLICATIONS Monitors application/container icons
SW_DB_QUERIES Executes and monitors database queries
322Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_DYNAMIC Executes Dynamic Items
SW_DYNAMIC_CONTAINER Creates a Dynamic Object Container
SW_DYNAMIC_DISCOVERY Creates a Dynamic Object Builder
SW_DYNAMIC_NUMBERS Performs dynamic numeric value extractions
SW_DYNAMIC_STRING Executes dynamic string searches
SW_FILES Monitors files and file content
SW_FILE_SECURITY Monitors file security
SW_FILESYSTEMS Monitors file-systems
SW_FOLDERS Monitors folders
SW_HTTP_REQUESTS Monitors web-based applications and executes HTTP requests
SW_HTTP_WEBFARM Monitors web farms
SW_JMX Polls and monitors JMX-enabled application servers
SW_KMWATCH Monitors parameters of other KMs
SW_NTEVENTS Monitors Windows Event Logs
SW_NTPERFORMANCE Monitors Windows Performance counters
SW_NTSERVICES Monitors Windows Services
SW_NT_WMI Executes and monitors WMI queries
SW_NUMBERS Performs numeric value extractions
SW_OSCOMMANDS Executes, monitors and parses command lines and scripts
SW_PROCESSES Monitors processes
SW_SENTRY Main application class
SW_SNMP_POLLING Polls and monitors SNMP devices
SW_SNMP_TRAPS Monitors and listens for SNMP traps
SW_STRINGS Executes string searches
SW_TRANSFORM Transforms complex (multi-line, HTML, XML) text to enable string/numeric valuesearches
SW_WBEM Executes and monitors WBEM queries
323Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_APPLICATIONSYou 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 monitora given application, device, or any other IT component.
SW_APPLICATIONS instances may contain other SW_APPLICATIONS instances (containers andsub-containers).
Parameters
None.
Infobox
Name Description
ID PATROL internal identifier of the application/container icon
Parent ID PATROL internal identifier of the parent icon
Application ID PATROL internal identifier of the root parent icon
First required file File whose presence is required to activate the monitoring of this application/container
Second required file File whose presence is required to activate the monitoring of this application/container
Third required file File whose presence is required to activate the monitoring of this application/container
Fourth required file File whose presence is required to activate the monitoring of this application/container
Constant 1 Name of the first application constant
Constant 2 Name of the second application constant
Constant 3 Name of the third application constant
Constant 4 Name of the fourth application constant
Constant 5 Name of the fifth application constant
Contact Name or contact information of the person in charge of the application
Description Description of the application
Start command line Displays the command line that will be used to start the application by the "Manage> Start the application" Menu Command
Stop command line Displays the command line that will be used to stop the application by the "Manage> Stop the application" Menu Command
324Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Commands
Menu Command Description
New > Process monitoring Adds a Process monitoring using the New Process wizard
New> Windows Service monitoring Adds a Windows Service monitoring using the New Windows Service wizard (onlyavailable on Windows servers)
New > File monitoring and analysis Adds a File monitoring using the New File wizard
New > Folder monitoring Adds a Folder monitoring using the New Folder wizard
New > File System monitoring Adds a File System monitoring using the File System wizard
New > Command line analysis Adds an OS Command monitoring using the New OS Command wizard
New > Database Query analysis Adds a Database Query analysis using the New Database Request wizard.
New> Java MBean Polling Adds a JMX polling using the Java MBean polling wizard
New> WMI Query analysis Adds a WMI Query analysis using the new WMI query wizard.
New > Web Request analysis Adds an HTTP Request analysis using the New HTTP Request wizard
New > Web-farm monitoring Adds a Web-farm monitoring using the New web-farm wizard
New > SNMP polling Adds an SNMP polling monitoring using the New SNMP polling wizard
New > SNMP Trap listening Adds an SNMP polling monitoring using the New SNMP Trap wizard
New > Windows Event monitoring Adds a Windows Event monitoring using the New Windows Event wizard (onlyavailable on Windows servers)
New > Windows Performancemonitoring
Adds a Windows Performance counter monitoring using the New WindowsPerformance wizard (only available on Windows servers)
New > KM Watch Adds another KM parameter monitoring using the New KM Watch wizard
New > Sub-container Starts the new sub-container icon wizard
Edit Allows you to edit the Application monitoring
Modify Application constants Modifies the application constants
Set Polling Interval Sets the polling interval
Set Global Alert Actions Allows you to add Alert Actions that will be used for the application as well as itsdependent objects
Display Object Configuration Displays the Monitoring Studio configuration report of this Database Queryinstances and all dependent instances
Cut Cuts this application/container object
Copy Copies this application/container object
Paste Pastes a previously copied or cut object into this application/container
Delete Deletes the application monitoring and all its dependent objects
Rename Allows you to rename this application monitoring
Manage > Start Application Allows you to start the application using the Start command line.
Manage > Stop Application Allows you to stop the application using the Stop command line.
Export configuration Allows you to export the configuration of this application/container along with all ofits dependent objects
325Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Pause monitoring Allows you to pause the monitoring of the application as well as all its dependentobjects
Resume monitoring Allows you to resume the monitoring of the application as well as all its dependentobjects after it has been paused
326Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_DB_QUERIES
Parameters
Name Description
ConnectionStatusState of the server connection
Unit: 0 = OK, 1 = ALARM
Value set by DbQueryColl every 2 minutes
QueryStatusDisplays 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
ExecutionTimeDisplays the SQL query execution time
Unit: second(s)
Value set by DbQueryColl every 2 minutes
DbQueryCollDatabase Request collector
Executes the SQL query
Default polling interval: 2 minutes
Infobox
Name Description
ID PATROL internal identifier of the Database query analysis
Parent ID PATROL internal identifier of the parent application
Application ID PATROL internal identifier of the Database query’s root application
Database Type Displays the Database type
Connection Type Displays the connection type
Hostname Display the name of the host machine
Database name Displays the database name
Connect as Login used to connect to the database server
SQL Query Displays the SQL query that will be executed
Menu Commands
Menu Command Description
New > String search Creates a new String search for this Database Query analysis
327Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
New > Numeric valueextraction
Creates a new Numeric Value extraction for this Database Query analysis
New > Text Pre-Processing Creates a new Text pre-processing for this Database Query analysis
New > Dynamic ObjectBuilder
Creates a new Dynamic Object Builder for this Database Query analysis
Edit Edits the Database Query monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling Interval Sets the polling interval for this Database Query analysis monitoring
Set Alert actions 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 alldependent objects
Cut Cuts this object
Copy Copies this object
Paste Pastes a previously copied or cut Database Query analysis object
Delete Deletes the Database Query analysis monitoring and all its dependent objects
Rename Allows you to rename this Database Query analysis monitoring
Pause monitoring Pauses the monitoring of this Database Query analysis object
Resume monitoring Resumes the monitoring of this Database Query analysis object
Refresh parameters Refreshes all instance parameters of the Database Query analysis monitoring
328Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_DYNAMIC
Parameters
Name Description
StatusInstance missing status
Unit: 0 = Present, 1 = Missing
Default pooling interval: 1 minute
ExtractedLineDisplays the output of the dynamic object
Infobox
Name Description
ID Dynamic object ID
329Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_DYNAMIC_CONTAINER
Parameters
None.
Infobox
Name Description
ID Dynamic container ID
Parent ID PATROL internal identifier of the KM command to which dynamics objects are linked
Application ID PATROL internal identifier of the root parent icon
330Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_DYNAMIC_DISCOVERY
Parameters
None.
Infobox
Name Description
ID Dynamic discovery ID
Parent ID PATROL internal identifier of the parent application
Type Dynamic object type
Dynamic Object Display Name Defines how dynamic object labels are generated
Dynamic Object ID Defines how dynamic object IDs are generated
Column Separator Defines symbols used to separate columns in the dynamic parent output file
Include Object Matching Keeps only lines matching a user-defined regular expression from the dynamic parentoutput file
Exclude Object Matching Discard lines matching a user-defined regular expression from the dynamic parent outputfile
Alarm on Missing Objects States the user-defined settings for alarm triggering on missing objects
Menu Commands
Menu Command Description
New > String search Creates a new String search for this File
New > Numeric valueextraction
Creates a new Numeric Value extraction for this File
Edit Edits the File monitoring settings
Set Alert actions Adds specific Alert Actions to the File monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this File monitoring object and alldependent objects
Cut Cuts this object
Copy Copies this object
Paste Pastes a previously copied or cut File monitoring object
Delete Deletes the File monitoring and all its dependent objects
331Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_DYNAMIC_NUMBERS
Parameters
Name Description
ValueFound States if a numeric valued has been found
ValueValue of the searched Numeric Value (no value will be given if no number is found)
Value set by the collector of the parent’s object
Infobox
Name Description
ID PATROL internal identifier of the numeric extraction
Parent ID PATROL internal identifier of the numeric extraction’s parent
Line Mode Method used to select lines to search for the numeric
Column Mode Method chosen to search and extraction the number in the line
Parameter Type Type of the parameter
Line numerics Line numbers in which the numeric will be extracted from
Regular Expression Regular expression used to select the lines where the number will be searched for
Skip blank lines Indicates whether or not blank lines are skipped when searching for the numeric
After/Before Searches for the numeric either after or before the specified string
Specified String Searches for the number before or after this specified string
Character Offset Character offset where the number is searched for
Field numeric Numeric of the field in which the numeric will be searched for
Field Separators Characters that separates the fields in a text line
332Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_DYNAMIC_STRINGS
Parameters
Name Description
MatchingLineCountIndicate if a matching string has been found
Value set by the collector of the parent object
Infobox
Name Description
ID PATROL internal identifier of the Dynamic String search
Parent ID PATROL internal identifier of the Dynamic String search’s parent
Type Dynamic String type
Lines Lines that are searched
Run Alert Actions When Alert Actions have to be executed
333Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_FILES
Parameters
Name Description
GrowthPercentageFile growth percentage
Unit: Percent per minute (%/min)
Value set by fileColl
FileCollCollects information about the file
Default polling interval: 2 minutes
GrowthSpeedFile growth speed
Unit: Kilobytes per minute (KB/min)
Value set by fileColl
SizeFile size
Unit: Kilobytes (KB)
Value set by fileColl
LastChanged Elapsed time since the file was modified
Unit: Minutes (min)
Value set by fileColl
ExistsDetermines whether the file exists or not
Unit: 0 = Exists, 1 = Does not exist
Value set by fileColl
Infobox
Name Description
ID PATROL internal identifier of the File monitoring
Parent ID PATROL internal identifier of File’s parent
Application ID PATROL internal identifier of the File’s root application.
File name & path File name and path (with wildcards)
Monitored parameters List of parameters that are currently being used for the File monitoring
Scan mode File scan mode (either "From start" or "From last position")
Monitored file File name path of the file currently being monitored
Menu Commands
Menu Command Description
334Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
New > String search Creates a new String search for this File
New > Numeric valueextraction
Creates a new Numeric Value extraction for this File
New > Text Pre-Processing Creates a new Text pre-processing for this File
New > File security check Creates a new File security monitoring for the current File
New > Dynamic ObjectBuilder
Creates a new Dynamic Object Builder for the current file
Edit Edits the File monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling Interval Sets the polling interval for this File monitoring
Set Alert actions Adds specific Alert Actions to the File monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this File monitoring object and alldependent objects
Cut Cuts this object
Copy Copies this object
Paste Pastes a previously copied or cut File monitoring object
Delete Deletes the File monitoring and all its dependent objects
Rename Allows you to rename this File monitoring
View file content Displays the File content
Restart scan from start of file If a String, Numeric value search is performed for this File, restart the File scan from theBeginning of the File (only relevant to "LOG" Files)
Pause monitoring Pauses the File monitoring
Resume monitoring Resumes the File monitoring as well as all its dependent objects
Refresh parameters Refreshes all instance parameters of the SW_FILES class
335Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_FILE_SECURITY
Parameters
Name Description
fileSecurityCollCollects the security information about the monitored file
Default polling: 2 minutes
AccessRightsCheckFile’s access right status.
Unit: 0 = OK, 1 = File’s access rights have changed
Value set by fileSecurityColl every 2 minutes
IntegrityFile’s 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
GroupCheckFile’s group status.
Unit: 0 = OK, 1 = File’s group has changed
Value set by fileSecurityColl every 2 minutes
OwnerCheckFile’s owner status.
Unit: 0 = OK, 1 = File’s owner has changed
Value set by fileSecurityColl every 2 minutes
Infobox
Name Description
ID PATROL internal identifier of the File security check
Parent ID PATROL internal identifier of the File security check’s parent
Application ID PATROL internal identifier of the File security check’s root application
Menu Commands
Menu Command Description
Edit Edits the File security monitoring settings
Set Polling Interval Sets the polling interval for this File monitoring
Set Alert Actions Adds specific Alert Actions to the File security monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this File security monitoring objectand all dependent objects
Cut Cuts this File security monitoring object.
Copy Copies this File security monitoring object
Delete Deletes the File security monitoring and all its dependent objects
336Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Rename Renames this File security monitoring
Acknowledge and Update Acknowledges all the alerts on this File security object and updates its settings to reflectany security changes made
Pause monitoring Pauses the File security monitoring
Resume monitoring Resumes the File security monitoring
Refresh parameters Refreshes all instance parameters of the SW_FILE_SECURITY application class
337Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_FILESYSTEMS
Parameters
Name Description
UsedSpaceGrowthPercentageHow 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
UsedSpaceGrowthSpeedHow fast the file system is getting filled in
Unit: Megabytes per hour (MB/h)
Value set by FileSystemColl every 2 minutes
FreeSpacePercentFile system free space left in percentage.
Unit: Percent (%)
Value set by FileSystemColl every 2 minutes
FreeMegabytesFile system free space left in megabytes.
Unit: Megabytes (MB)
Value set by FileSystemColl every 2 minutes
Infobox
Name Description
ID PATROL internal identifier of the File systems monitoring
Parent ID PATROL internal identifier of File systems’ parent
Application ID PATROL internal identifier of the File systems’ root application
File system object File System object monitored
Menu Commands
Menu Command Description
Edit Edits the File system monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling Interval Sets the polling interval for this File systems monitoring
Set Alert Actions Adds specific Alert Actions to the File systems monitoring
Display Object Configuration Displays the configuration report of this File system object and all dependent objects
Cut Cuts this File system monitoring object
Copy Copies this File system monitoring object
Delete Deletes the File systems monitoring and all its dependent objects
338Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Rename Allows you to rename this File systems monitoring
Pause monitoring Pauses the File systems monitoring
Resume monitoring Resumes the File systems monitoring
Refresh parameters Refreshes all instance parameters of the SW_FILESYSTEMS application class
339Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_FOLDERS
Parameters
Name Description
GrowthPercentageDisplays the percentage of the folder size growth per minute
Unit: Percent per minute (%/min)
Value set by FolderColl
LastModifiedFileElapsedTimeDisplays the elapsed time since the last modification of any file in this folder
Unit: Minute(s) (min)
Value set by FolderColl
OldestModifiedFileElapsedTime
Displays the elapsed time since the oldest modification of any file in this folder or sub-folder
Unit: Minute(s) (min)
Value set by FolderColl
FolderCollFolder collector.
Default polling interval: 2 minutes
FileCountDisplays the number of files in a folder. If the option "Include sub-folders" is selected, thenumber 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
NewFileCountDisplays the number of new files per minute
Unit: Displays the number of new files per minute
Value set by FolderColl
DeletedFileCountDisplays the number of deleted files per minute
Unit: File(s) per minute (File(s)/min)
Value set by FolderColl
ModifiedFileCountDisplays the number of modified files per minute
Unit: File(s) per minute (File(s)/min)
Value set by FolderColl
GrowthSpeedDisplays 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 MBUnit: Megabyte(s) (MB)Value set by FolderColl
340Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Name Description
LongestTimeFileRemainsInFolder
Displays the longest time an existing file has been placed in the folder.Unit: Minutes (min)
Infobox
Name Description
ID PATROL internal identifier of the Folder monitoring
Parent ID PATROL internal identifier of the Folder’s parent
Application ID PATROL internal identifier of the Folder’s root application
Folder Path of the monitored folder
Include subfolders Displays whether subfolders are monitored or not
Menu Commands
Menu Command Description
Edit Edits the Folder monitoring settings.
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this Folder monitoring
Set Alert Actions Adds specific Alert Actions to the Folder monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this Folder monitoring object and alldependent objects
Cut Cuts this Folder monitoring object.
Copy Copies this Folder monitoring object
Delete Deletes the Folder monitoring
Rename Renames the Folder monitoring
Pause monitoring Pauses the Folder monitoring
Resume monitoring Resumes the Folder monitoring
Refresh parameters Refreshes all instance parameters of the SW_FOLDERS class
341Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_HTTP_REQUESTS
Parameters
Name Description
httpRequestCollHTTP Request collector
Default polling interval: 2 minutes
ReturnOutput Displays the returned output of the HTTP Request execution.
ExecutionTimeTime taken by the HTTP request to execute
Unit: Seconds(s)
Value set by httpRequestColl
ServerConnectionStateState of the connection to the server
Unit: 0 = OK, 1 = ALARM
Value set by httpRequestColl
HTTPStatusCodeHTTP Response Status code
Unit: 200=OK, 404 = Error
Value set by httpRequestColl
StatusHTTP Request status.
Unit: 0 = OK, 1 = WARNING, 2 = ALARM
Value set by httpRequestColl
Infobox
Name Description
ID PATROL internal identifier of the HTTP Request analysis
Parent ID PATROL internal identifier of the HTTP Request’s parent
Application ID PATROL internal identifier of the HTTP Request’s root application
Used HTTP method HTTP method that is used for this HTTP Request analysis
Menu Commands
Menu Command Description
New > String search Creates a new String search for this Web Request
New > Numeric valueextraction
Creates a new Numeric Value extraction for this Web Request
342Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
New > Text Pre-Processing Creates a new Text pre-processing for this Web Request
New > Dynamic ObjectBuilder
Creates a new Dynamic Object Builder for this Web Request
Edit Edits the Web Request analysis settings.
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this Web Request monitoring object
Set Alert Actions Adds specific Alert Actions to the Web Request analysis
Display ObjectConfiguration
Displays the Monitoring Studio configuration report of this Web request object and alldependent objects
Cut Cuts this Web request object
Copy Copies this Web request object
Paste Pastes a previously copied or cut String search or Numeric Value search object
Delete Deletes the Web Request analysis and all its dependent objects
Rename Renames the Web Request monitoring object
Pause monitoring Pauses the Web Request analysis as well as all its dependent objects
Resume monitoring Resumes the Web Request analysis as well as all its dependent objects
Refresh parameters Refreshes all parameters of this Web request object
343Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_HTTP_WEBFARM
Parameters
Name Description
OperationalServerPercentNumber of servers that are operational
Unit: Server(s)
Value set by httpWebFarmColl
OperationServerCountPercentage of operational servers
Unit: Percent (%)
Value set by httpWebFarmColl
httpWebFarmCollHTTP Web-farm collector
Polling interval: 1 minute
Infobox
Name Description
ID PATROL internal identifier of the Web-farm monitoring
Parent ID PATROL internal identifier of the Web-farm monitoring’s parent
Application ID PATROL internal identifier of the Web-farm monitoring’s root application
Menu Commands
Menu Command Description
New > String search Creates a new String search for this Web-farm monitoring
New > Numeric valueextraction
Creates a new Numeric Value extraction for this Web-farm monitoring
New > Text Pre-Processing Creates a new Text pre-processing for this Web-farm monitoring
Edit Edits the Web-farm monitoring settings
Add hosts Adds new hosts to the Web-farm monitoring. A new Web request monitoring will becreated for each host added
Set Alert actions Adds specific Alert Actions to the Web-farm monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this Web-farm monitoring object andall dependent objects
Cut Cuts this Web farm monitoring object
Copy Copies this Web farm monitoring object
Paste Pastes a previously copied or cut Web request monitoring object
Delete Deletes the Web-farm monitoring and all its dependent objects
Rename Renames the Web-farm monitoring object
344Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Pause monitoring Pauses the Web-farm monitoring as well as all its dependent objects
Resume monitoring Resumes the Web-farm monitoring as well as all its dependent objects
Refresh parameters Refreshes all instance parameters of the Web-farm monitoring
345Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_JMX
Parameters
Name Description
JMXCollJMX collector. Executes the JMX polling query
Default polling interval set at 2 minutes
ExecutionStatusDisplays the output of the JMX poll execution
Unit: 0 =OK; 1= ALARM
Value set by JMXColl every 2 minutes
ValueDisplays the value of an attribute in integers
Value set by JMXColl every 2 minutes
TextDisplays the value of an attribute in text
Value set by JMXColl every 2 minutes
Delta Displays the difference between values collected during two consecutive polling
DeltaPerSecond Displays the value corresponding to "Delta" devided by the elapsed time in secondsbetween the collection times
Infobox
Name Description
ID PATROL internal identifier of the JMX polling object
Parent ID PATROL internal identifier of the JMX polling object’s parent
Application ID PATROL internal identifier of the JMX polling object’s root application
Server type Type of JMX server (JBoss/WebLogic/generic etc.)
Host Displays name of host machine
Port Displays port number of JMX server
JMX Query Displays the query to be executed
User Name Displays the user name
Path to java Displays the path of the java virtual machine on the local server (e.g.%JAVA_HOME%\bin)
Timeout Displays the execution timeout
Domain Displays the domain monitored
Key property Displays the key property monitored
Attribute Displays the attribute monitored
346Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Commands
Menu Command Description
New > String search Creates a new String search for this JMX polling object
New > Numeric valueextraction
Creates a new Numeric value extraction for this JMX polling object
New > Text Pre-Processing Creates a new Text pre-processing for this JMX polling object
New > Dynamic Object Builder Creates a new Dynamic Object Builder for this JMX polling object
Edit Allows you to edit the JMX polling settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling Interval Sets the polling interval for this JMX polling object monitoring
Set Alert actions Adds specific Alert Actions to the JMX polling monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this JMX polling object and alldependent objects
Cut Cuts this object
Copy Copies this object
Paste Pastes a previously copied or cut JMX polling object
Delete Deletes the JMX polling and all its dependent objects
Rename Allows you to rename this JMX polling object monitoring
Pause monitoring Pauses the monitoring of this JMX polling object
Resume monitoring Resumes the monitoring of this JMX polling object
Refresh parameters Refreshes all instance parameters of the JMX polling object monitoring
347Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_KMWATCH
Parameters
Name Description
KMWatchCollCollects values by getting the information from the monitored parameter and settingthe KM Watch value parameter with this value
Default pooling interval: 1 minute
ValueValue of the parameter that is being monitored.
Unit: Depends on the parameter
Value set by KMWatchColl
Infobox
Name Description
ID PATROL internal identifier of the KM Watch monitoring
Parent ID PATROL internal identifier of the KM Watch’ parent
Application ID PATROL internal identifier of the KM Watch’s root application
Class Class of the parameter that is being monitored
Instance Instance of the parameter that is being monitored
Parameter Name of the parameter that is being monitored
Scale Scale used for the parameter’s value
Menu Commands
Menu Command Description
Edit Edits the KM Watch monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling Intervals Sets the polling interval for this KM Watch monitoring
Set Alert Actions Adds specific Alert Actions to the KM Watch monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this KM Watch object and alldependent objects
Cut Cuts this KM Watch monitoring object
Copy Copies this KM Watch monitoring object
Delete Deletes the KM Watch monitoring
Rename Renames the KM Watch monitoring object
Pause monitoring Pauses the KM Watch monitoring
Resume monitoring Resumes the KM Watch monitoring
Refresh parameters Refreshes all instance parameters of the SW_KMWATCH class
348Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_NTEVENTS
Parameters
Name Description
MatchingEventRateRate of matching Windows Events
Unit: Event/minute
Value set by NTEventColl
MatchingEventCountNumber of Matching Windows Events
Unit: Event
Value set by NTEventColl
Infobox
Name Description
ID PATROL internal identifier of the Windows Event monitoring
Parent ID PATROL internal identifier of the Windows Event’s parent
Application ID PATROL internal identifier of the Windows Event’s root application
Event log Indicates which EventLog is searched
Event source Source of the event to be searched for
Event ID ID of the event to be searched for
AcknowledgingWindows Event
Is the auto-acknowledgment activated
Acknowledge What is to be acknowledged: one event or all events
Timeout Time after which a matching Windows Even is acknowledged
Run Alert Actions Alert Actions trigger
Menu Commands
Menu Command Description
Edit Edits the Windows Event monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this Windows Event monitoring
Set Alert Actions Adds specific Alert Actions to the Windows Event monitoring
Display ObjectConfiguration
Displays the Monitoring Studio configuration report of this Windows Event object and alldependent objects
Cut Cuts this Windows Event monitoring object
Copy Copies this Windows Event monitoring object
Delete Deletes the Windows Event monitoring
349Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Rename Renames the Windows Event monitoring
Acknowledge all andreset
Acknowledges all alerts and resets the "MatchingEventCount" parameter to ‘0’
Pause monitoring Pauses the Windows Event monitoring
Resume monitoring Resumes the Windows Event monitoring
Refresh parameters Refreshes all instance parameters of the SW_NTEVENTS class
350Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_NTPERFORMANCE
Parameters
Name Description
NTPerformanceCollCollects Windows Performance counter values.
Default Polling Interval: 2 minutes
ValueValue of the monitored Windows Performance counter.
Unit: Depends on the parameter
Value set by NTPerformanceColl
Infobox
Name Description
ID PATROL internal identifier of the Windows Performance monitoring
Parent ID PATROL internal identifier of the Windows Performance’s parent
Application ID PATROL internal identifier of the Windows Performance’s root application
Performance object Name of the Windows Performance object that is read
Counter Name of the Windows Performance counter that is read
Instances Selected Windows performance instances
Value Type How the value is calculated (average, maximum, etc.) when more than one instance wasselected
Scale Scale used (the original performance value is divided by this number)
Menu Commands
Menu Command Description
Edit Edits the Windows Performance monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this Windows Performance monitoring
Set Alert Actions Adds specific Alert Actions to the Windows Performance monitoring
Display ObjectConfiguration
Displays the Monitoring Studio configuration report of this Windows Performance object and alldependent objects
Cut Cuts this Windows Performance monitoring object
Copy Copies this Windows Performance monitoring object
Delete Deletes the Windows Performance monitoring
Rename Renames the Windows Performance monitoring
Pause monitoring Pauses the Windows Performance monitoring
Resume monitoring Resumes the Windows Performance monitoring
351Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Refresh parameters Refreshes all instance parameters of the SW_NTPERFORMANCE class
352Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_NTSERVICES
Parameters
Name Description
StatusStatus of the Windows Service
Unit: 0 = Started, 1 = Intermediate state, 2 = Stopped
Value set by NTServiceColl
Infobox
Name Description
ID PATROL internal identifier of the Windows Service monitoring
Parent ID PATROL internal identifier of the Windows Service’s parent
Application ID PATROL internal identifier of the Windows Service’s root application
Service name Name of the Service that is monitored
Menu Commands
Menu Command Description
Edit Edits the Windows Service monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this Windows Service monitoring
Set Alert Actions Adds specific Alert Actions to the Windows Service monitoring
Display ObjectConfiguration
Displays the Monitoring Studio configuration report of this Windows Service object and alldependent objects
Cut Cuts this Windows Service monitoring object
Copy Copies this Windows Service monitoring object
Delete Deletes the Windows Service monitoring
Rename Renames the Windows Service monitoring
Pause monitoring Pauses the Windows Service monitoring
Resume monitoring Resumes the Windows Service monitoring
Refresh parameters Refreshes all instance parameters of the SW_NTSERVICES class
353Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_NT_WMI
Parameters
Name Description
WMIQueryColl WMI Request collector. Executes the WMI query
Default poll ing 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 Description
ID PATROL internal identifier of the WMI query object
Parent ID PATROL internal identifier of the WMI query object’s parent
Application ID PATROL internal identifier of the T WMI query object’s root application
Parent type Type of the parent (File, OSCommand, etc.)
Host Displays name of host machine
Name Space Displays WMI namespace (e.g.: root\cimv2)
WMI Query Displays the query to be executed
User Name Displays the user name
Menu Commands
Menu Command Description
New > String search Creates a new String search for this WMI query
New > Numericvalue extraction
Creates a new Numeric Value extraction for this WMI query
New > Text Pre-Processing
Creates a new Text pre-processing for this WMI query
New > DynamicObject Builder
Creates a new Dynamic Object Builder for this WMI query
Edit Allows you to edit the WMI query monitoring settings
Set Thresholds Allows you to set or edit the thresholds
354Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Set Polling Interval Sets the polling interval for this WMI query monitoring
Set Alert actions Adds specific Alert Actions to the WMI query monitoring
Display ObjectConfiguration
Displays the Monitoring Studio configuration report of this WMI query object and all dependentobjects
Cut Cuts this object
Copy Copies this object
Paste Pastes a previously copied or cut WMI query object
Delete Deletes the WMI query monitoring and all its dependent objects
Rename Allows you to rename this WMI query monitoring
Pause monitoring Pauses the monitoring of this WMI query object
Resume monitoring Resumes the monitoring of this WMI query object
Refresh parameters Refreshes all instance parameters of the WMI query monitoring
355Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_WBEM
Parameters
Name Description
WBEMQueryColl WBEM Request collector. Executes the WBEM queryDefault polling interval set at 2 minutes
ReturnOutput Displays the output of the WBEM query executionUnit: N/AValue set by WBEMQueryColl every 2 minutes
QueryStatus Displays whether or not the query was successfully executedUnit: 0 = OK, 1 =ALARMValue set by WBEMIQueryColl every 2 minutes
Infobox
Name Description
ID PATROL internal identifier of the WBEM query object
Parent ID PATROL internal identifier of the WBEM query object’s parent
Application ID PATROL internal identifier of the T WBEM query object’s root application
Host Displays name of host machine
Name Space Displays WBEM namespace
WBEM QueryDisplays the query to be executed
User Name Displays the user name
Menu Commands
Menu Command Description
New > String search Creates a new String search for this File
New > Numeric value extraction Creates a new Numeric Value extraction for this File
New > Dynamic Object Builder Creates a new Dynamic Object Builder for this File
Edit Edits the Process monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this instance
Set Alert Actions Adds specific Alert Actions to the Process monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this Process monitoring objectand all dependent objects
Cut Cuts this Process monitoring object
Copy Copies this Process monitoring object
Delete Deletes the Process monitoring
356Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Rename Renames the Process monitoring object
Pause monitoring Pauses the Process monitoring
Resume monitoring Resumes the Process monitoring
Refresh parameters Refreshes all instance parameters of the SW_PROCESSES class
357Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_NUMBERS
Parameters
Name Description
ValueFound States if a numeric valued has been found
ValueValue of the searched Numeric Value (no value will be given if no number is found)
Value set by the collector of the parent’s object
Delta Displays the difference between values collected during two consecutive polling
DeltaPerSecond Displays the value corresponding to "Delta" devided by the elapsed time in secondsbetween the collection times
Infobox
Name Description
ID PATROL internal identifier of the numeric extraction
Parent ID PATROL internal identifier of the numeric extraction’s parent
Application ID PATROL internal identifier of the numeric extraction’s root application
Parent Type Type of the parent (File, OS Command, etc.)
Line Mode Method used to select lines to search for the numeric
Column Mode Method chosen to search and extraction the number in the line
Parameter Type Type of the parameter
Line numerics Line numbers in which the numeric will be extracted from
Regular Expression Regular expression used to select the lines where the number will be searched for
Skip blank lines Indicates whether or not blank lines are skipped when searching for the numeric
After/Before Searches for the numeric either after or before the specified string
Specified String Searches for the number before or after this specified string
Character Offset Character offset where the number is searched for
Field numeric Numeric of the field in which the numeric will be searched for
Field Separators Characters that separates the fields in a text line
Unique Separator Considers consecutive separators as a unique separator
Menu Commands
Menu Command Description
Edit Edits the numeric extraction settings
Set Thresholds Allows you to set or edit the thresholds
Set Alert Actions Adds specific Alert Actions to the Numeric Value extraction object
358Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Display Object Configuration Displays the Monitoring Studio configuration report of this object and all dependentobjects
Cut Cuts this Numeric Value extraction object
Copy Copies this Numeric Value extraction object
Delete Deletes the Numeric Value extraction
Rename Renames the Numeric Value extraction object
Pause monitoring Pauses the Numeric Value extraction
Resume monitoring Resumes the Numeric Value extraction
359Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_OSCOMMANDS
Parameters
Name Description
OSCommandColl Execute the OS Command and collects the information
ReturnOutputDisplays the return output of the OS command
Unit: N/A
Value set by OSCommandColl
ExecutionTimeTime taken by the OS Command to run
Unit: Seconds
Value set by OSCommandColl
ExecutionStatusStatus of the execution
Unit: 0 = executed successfully, 1 = error while executing the OS command
Value set by OSCommandColl
ExitStatusStatus of the OS command exit code
Unit: 0 = executed successfully, 1 = error while executing the OS command
Value set by OSCommandColl
Infobox
Name Description
ID PATROL internal identifier of the OS Command analysis.
Parent ID PATROL internal identifier of the OS Command’s parent.
Application ID PATROL internal identifier of the OS Command’s root application.
OS Command Command line that is given to the OS to execute.
Timeout Maximum execution time before timeout.
Username The command line is executed with this username.
Menu Commands
Menu Command Description
New > String search Creates a new String search for this command line execution
New > Numeric valueextraction
Creates a new Numeric value extraction for this command line execution
New > Text Pre-Processing Creates a new Text pre-processing for this command line execution
New > Dynamic Object Builder Creates a new Dynamic Object Builder for this command line execution
Edit Edits the command line execution settings
360Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this command line execution monitoring
Set Alert Actions Adds specific Alert Actions to the command line execution
Display Object Configuration Displays the Monitoring Studio configuration report of this command line object and alldependent objects
Cut Cuts this command line execution object
Copy Copies this command line execution object
Paste Pastes a previously copied or cut String search or Numeric Value search
Delete Deletes the command line execution and all its dependent objects
Rename Renames the command line execution monitoring object
Pause monitoring Pauses the command line execution as well as all its dependent objects
Resume monitoring Resumes the command line execution as well as all its dependent objects
Refresh parameters Re-execute the command line (if needed) and refresh all parameters. All dependentobjects will be refreshed as well (SW_STRINGS and SW_NUMBERS instances)
361Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_PROCESSES
Parameters
Name Description
ThreadCount(Windows only)
Displays the number of threads of the matching process(es).
Unit: Threads
Value set by proColl
ChildCountDisplays 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
VirtualBytesDisplays 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 multi-processor 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
ProcessorTimeDisplays the processor time percent used by the matching process(es).
Unit: Percent (%)
Value set by proColl
CountDisplays the number of processes that match the criteria.
Unit: Processes
Value set by proColl
362Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Infobox
Name Description
Object ID PATROL internal identifier of the Process monitoring
Object Type Type of the object (Process)
Object Class Class of the object (SW_PROCESSES)
Parent ID PATROL internal identifier of the Process’ parent
Application ID PATROL internal identifier of the Process’ root application
Menu Commands
Menu Command Description
Edit Edits the Process monitoring settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this instance
Set Alert Actions Adds specific Alert Actions to the Process monitoring
Display Object Configuration Displays the Monitoring Studio configuration report of this Process monitoring objectand all dependent objects
Cut Cuts this Process monitoring object
Copy Copies this Process monitoring object
Delete Deletes the Process monitoring
Rename Renames the Process monitoring object
Pause monitoring Pauses the Process monitoring
Resume monitoring Resumes the Process monitoring
Refresh parameters Refreshes all instance parameters of the SW_PROCESSES class
363Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_SENTRYOne single instance of the SW_SENTRY class is created and labeled Monitoring Studio. Once installed, itis the only visible icon under host icon in the PATROL Console. This icon gives you access to the variousmonitoring tools available in Monitoring Studio.
Monitoring objects will be placed under this Monitoring Studio icon by default. You can also use this iconto create new application/container icons in the PATROL Console tree.
Parameters
Name Description
NTEventCollWindows Event collector. It uses the following script: "SW_EventLogReader.exe" to get a formatting list of Windows Events.
Default polling internal: 2 minutes
ApplicationCollCollector 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 applicationmonitoring.
Default polling internal: 2 minutes
NTServiceCollWindows Service collector. It uses the following script:"SW_sentry_ServiceInfo.exe".
Default polling internal: 2 minutes
FileSystemCollFile system collector. For UNIX systems, the command "df-k" is used. ForWindows systems, the performance command "GetPerformanceValue LogicalDisk" is used.
Default polling internal: 2 minutes
ExtraFileListNon-visible.
ProColl common collectorsProcess Collector. Finds the processes that match the criteria and collects theperformance information about the matching processes. Finds the processesthat match the criteria and collects the performance information about thematching processes.
Default polling internal: 2 minutes
Infobox
Name Description
Product Product name
Version Monitoring Studio version number
Released Release date of this version of Monitoring Studio
Copyright Copyright information
Web Site Web site address
364Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Name Description
Contact Contact information
Support Support information
Menu Commands
Menu Command Description
New > Process monitoring Starts the process monitoring wizard.
New> Windows Service monitoring Starts the Windows service monitoring wizard.
New > File monitoring and analysis Starts the file monitoring and analysis wizard
New > Folder monitoring Starts the folder monitoring wizard
New > File System monitoring Starts the file system monitoring wizard
New > Command line analysis Starts the command line execution and analysis wizard.
New > Database Query analysis Starts the database query analysis wizard
New > Process monitoring Starts the Java MBean polling wizard
New> Windows Service monitoring Starts the WMI query wizard
New > File monitoring and analysis Starts the Web request analysis wizard
New > Folder monitoring Starts the Web-farm monitoring wizard
New > File System monitoring Starts the SNMP polling wizard
New > Command line analysis Starts the SNMP trap listening wizard
New > Database Query analysis Starts the Windows EventLog monitoring wizard(On Windows Agents only)
New > Windows Performance monitoring Starts the Windows Performance counter monitoring wizard.(On Windows Agents only)
New > KM Watch Starts the KM Watch wizard
New > Application icon (container) Starts the new application/container icon wizard
Paste Pastes the previously copied object under the Monitoring Studio icon
Delete All Deletes all monitoring objects under this icon
Tools > Process Viewer Starts the process viewer tool
Tools > Windows EventLog Reader Starts the Windows EventLog Reader tool(On Windows Agents only)
Tools > SNMP Browser Starts the SNMP browser tool
Tools > Real-time SNMP Trap listener Starts the real-time SNMP trap listener
Import and Export > Export configuration Starts the Export configuration wizard
Import and Export > Import configuration Starts the Import configuration wizard
Options > Thresholds management Shows the thresholds management options
Option > Debug Shows the debug options
Display Configuration > ObjectConfiguration
Displays the Monitoring Studio configuration for all objects under theMonitoring Studio icon
365Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Display Configuration > EntireConfiguration
Displays the Monitoring Studio configuration for all objects under theMonitoring Studio icon and any user-defined container
Report Scheduler Starts the Monitoring Studio configuration report scheduler
License Shows the currently registered license keys and registers new license keys
About… Shows the version and general information about Monitoring Studio
366Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_SNMP_POLLING
Parameters
Name Description
SNMPPollingColl Polls the SNMP and collects the information received.
ContentContent of the SNMP received.
Unit: Varies
Note: Only applicable to SNMP of String type.
Value set by SNMPPollingColl
ValueValue of the SNMP received.
Unit: Varies
Note: Only applicable to SNMPs of integer type.
Value set by SNMPPollingColl
StatusStatus of the SNMP Polling.
Unit: 0 = working, 1 = a problem occurred
Value set by SNMPPollingColl
Delta Displays the difference between values collected during two consecutive polling
DeltaPerSecond Displays the value corresponding to "Delta" devided by the elapsed time in secondsbetween the collection times
Infobox
Name Description
ID PATROL internal identifier of the SNMP Polling.
Parent ID PATROL internal identifier of the SNMP Polling’s parent.
Application ID PATROL internal identifier of the SNMP Polling’s root application.
OID OID that is polled.
OID type Type of the value of the selected OID (number or string).
Host Host name where the SNMP agent is running.
Port Port used to connect to the SNMP agent.
Community Community used to connect to the SNMP agent.
Menu Commands
Menu Command Description
New > String search Creates a new String search for this SNMP Polling
New > Numeric value extraction Creates a new Numeric Value search for this SNMP Polling
367Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
New > Dynamic Object Builder Creates a new Dynamic Object Builder for this SNMP Polling
Edit Edits the SNMP Polling settings
Set Thresholds Allows you to set or edit the thresholds
Set Polling interval Sets the polling interval for this SNMP Polling
Set Alert Actions Adds specific Alert Actions to the SNMP Polling
Display Object Configuration Displays the Monitoring Studio configuration report of this SNMP Polling object andall dependent objects
Cut Cuts this SNMP Polling object
Copy Copies this SNMP Polling object
Paste Pastes a previously copied or cut String search or Numeric Value search
Delete Deletes the SNMP Polling and all its dependent objects
Rename Renames the SNMP Polling object
Pause monitoring Pauses the SNMP Polling as well as all its dependent objects
Resume monitoring Resumes the SNMP Polling as well as all its dependent objects
Refresh parameters Re-poll the OID and refresh all parameters. All dependent objects will be refreshedas well (SW_STRINGS and SW_NUMBERS instances)
368Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_SNMP_TRAPS
Parameters
Name Description
SNMPTrapCollThe SNMP trap collector is a detached process launched at the start of BMCPerformance Manager Monitoring Studio. This process waits for SNMP Traps andanalyzes traps as it receives them.
MatchingTrapRateNumber of SNMP traps matching the search.
Unit: Trap
Value set by SNMPtrapColl
MatchingTrapCountNumber of matching SNMP traps per minute.
Unit: Trap/min
Value set by SNMPtrapColl
Infobox
Name Description
ID PATROL internal identifier of the SNMP Trap listening
Parent ID PATROL internal identifier of the SNMP Trap listening parent
Application ID PATROL internal identifier of the SNMP Trap listening root application
Source IP IP address of the SNMP agent that raises the traps
Community Community used to listen to traps
Enterprise ID Enterprise ID of the SNMP agent that raises the traps
Trap number Number of the searched trap
OID 1 OID of the first varBind of the searched traps
String 1 Searched string in the first varBind
OID 2 OID of the second varBind of the searched traps
String 2 Searched string in the second varBind
Acknowledging Trap Number Number of the trap that will acknowledge this trap search
Acknowledging OID 1 OID of the first varBind of the trap that will acknowledge this trap search
Acknowledging String 1 Searched string in the first varBind of the acknowledging trap.
Acknowledging OID 2 OID of the second varBind of the trap that will acknowledge this trap search
Acknowledging String 2 Searched string in the second varBind of the acknowledging trap
Timeout Timeout for auto-acknowledgment
Run Alert Actions Indicates when Alert Actions should be executed
369Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Commands
Menu Command Description
Edit Edits the SNMP Trap listening settings
Set Thresholds Allows you to set or edit the thresholds
Set Alert Actions Adds specific Alert Actions to the SNMP Trap listening
Display Object Configuration Displays the Monitoring Studio configuration report of this SNMP Trap object and alldependent objects
Cut Cuts this SNMP Trap listening object
Copy Copies this SNMP Trap listening object
Delete Deletes the SNMP Trap listening
Rename Renames the SNMP Trap listening
Acknowledge all and reset Acknowledges all alerts on the SNMP Trap object and resets the "MatchingTrapCount"parameter to ‘0’
Pause monitoring Pauses the SNMP Trap listening
Resume monitoring Resumes the SNMP Trap listening
Refresh parameters Refreshes all parameters of the SW_SNMP_TRAPS class
370Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_STRINGS
Parameters
Name Description
LastMatchingLinesLines 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 thevariable "/MASAI/SENTRY8/ LastMachingLinesNumber" with the proper line number tothe PATROL Agent configuration
Default: the 10 last matching lines are displayed.
MatchingLineCountNumber of lines matching the String search.
Unit: Line
Value set by the collector of the parent object
MatchingLineRateNumber 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 andin "never-ending" command lines
Infobox
Name Description
ID PATROL internal identifier of the String search
Parent ID PATROL internal identifier of the String search’s parent
Application ID PATROL internal identifier of the String search’s root application
Parent type Type of the parent (File, OSCommand, etc.)
Search Search mode
Lines Lines that are searched
Acknowledge String String that auto-acknowledges this string search
Acknowledge Is the auto-acknowledgment enabled?
Timeout Timeout for the auto-acknowledging
Run Alert Actions When Alert Actions have to be executed
Menu Commands
Menu Command Description
Edit Edits the String search settings
371Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Menu Command Description
Set Thresholds Allows you to set or edit the thresholds
Set Alert Actions Adds specific Alert Actions to the String search
Display Object Configuration Displays the Monitoring Studio configuration report of this String search object and alldependent objects
Cut Cuts this String search object
Copy Copies this String search object
Delete Deletes the String search
Rename Renames the String search object
Acknowledge all and reset Acknowledge all alerts for this object. The MatchingLineCount parameter is set to zero
Pause monitoring Pauses the String search
Resume monitoring Resumes the String search
372Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
SW_Transform
Parameters
Name Description
TransformResultLines matching the Text pre-processing.
Unit: N/A
Infobox
Name Description
ID PATROL internal identifier of the Text Pre-processing object
Parent ID PATROL internal identifier of the Text Pre-processing object’s parent
Application ID PATROL internal identifier of the Text Pre-processing object’s root application
Parent type Type of the parent (File, OS Command, etc.)
Menu Commands
Menu Command Description
New > String search Creates a new String search for this Text pre-processing object
New > Numeric value extraction Creates a new Numeric value extraction for this Text pre-processing object
New > Dynamic Object Builder Creates a new Dynamic Object Builder for this Text pre-processing object
Edit Edits the Text-preprocessing monitoring settings
Display Object Configuration Displays the Monitoring Studio configuration report of this Text- pre-processingobject and all dependent objects
Cut Cuts this object
Copy Copies this object
Paste Pastes a previously copied or cut Text pre-processing object
Delete Deletes the Text-preprocessing monitoring and all its dependent objects
Rename Allows you to rename this Text pre-processing object
Pause monitoring Pauses the monitoring of this Text pre-processing object
Resume monitoring Resumes the monitoring of this Text pre-processing object
373Application Classes
Monitoring Studio KM for PATROL
Version 8.6.53
Index 374
Monitoring Studio KM for PATROL
Version 8.6.53
Index
- A -About 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 348ACL 101
Adapter 35
Add 36, 44
Create 36
Update 44Adaptors 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
File 333, 337
Folder 339
JMX polling 345
Process 361
Run 294
Setting 242
SNMP Trap 368
Types 246
Web-farm 343Alert 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 196APP_PATH
define 53Application 53, 109, 310, 323, 326, 333, 337,339, 341
Application class 24, 335, 337
existing 31Application 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 375
Monitoring Studio KM for PATROL
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 276Argument1 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 368Automatic 11, 138, 143, 183, 234
Automatic collection process 9
- B -BACKENDDB 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
- C -Calculate 118, 188, 350
carol.properties 221
Case 11, 188, 261, 271, 307, 310
CD 31
Character Offset 118, 143, 357
Characteristics
administrator identify 266
analyze 271
ignore 271Check 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 138Cityplace7 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.DefaultAuthorizationStrategy.assertAvailableBusinessUnit 297
com.csg.pb.frontnet.apps.portals.base.PortalSelectionController.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 andanalysis 61
Command-line MUST MATCH THE REGULAREXPRESSION 125
Index 376
Monitoring Studio KM for PATROL
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, 53Connect 11, 196, 199, 205, 207, 214, 221,228, 307, 326
Oracle SQL*Plus 71
SNMP 366Connection 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, 297CSV 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
- D -Database 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 307Default 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 377
Monitoring Studio KM for PATROL
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
- E -Edit 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 307Enabling 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
Enterprise 138, 161, 214, 228, 254, 271, 311,314
Enterprise ID
SNMP 368Enterprise 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 183Event 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
Index 378
Monitoring Studio KM for PATROL
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 326execution 101, 286, 290, 318, 326, 341, 345,353, 359
choose/configure 242
operating system controls 310ExecutionStatus 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 23Extracting numeric values 240
Extracting the setup files 23
Ey 318
- F -Failure 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 109File > Restart scan from beginning of file 289
file ClientKeyFile.jks 205, 214
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 258File 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 RDS001002Code 297
FNServiceNotAvailableException FEA000001Service 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
Index 379
Monitoring Studio KM for PATROL
Version 8.6.53
Full Client 71
- G -General 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 196GetPerformanceValue Logical Disk 363
Group 101, 188, 323, 335
Group ID 101
GroupCheck 335
GrowthPercentage 109, 333, 339
GrowthSpeed 93, 109, 333, 339
GUI 48
- H -Host 132
Hostname
Enter 270Hosts 31, 53, 71, 161, 169, 177, 196, 205,207, 221, 228, 261, 311, 345, 353, 363, 366
Monitor Studio considers 199
Web-farm 343How 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
HTTP Web-farm 343
HTTP_RETURN_OUTPUT 242
HTTP_URL 242, 254, 314
HttpRequestColl 341
Https 169, 177
HTTPStatusCode 341
- I -IBM 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 12Include 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 205INPUTFILE 149
Ins_ALL_7550.tar 23
ins_WINDOWS_<version number>.exe 23
Ins_WINDOWS_7550.exe 23
ins_WINDOWS_7552.exe 23
Installation Utility 14
Index 380
Monitoring Studio KM for PATROL
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 31Internet Explorer 177
Intervals 271, 347, 353
IntranetPLEnfFilter.java 297
IP 31, 53, 71, 138, 161, 270, 271, 368
IP address 270, 271
SNMP 368ipconfig 149
ipconfig/all 149
ISA 311
IT 48, 51, 323
- J -J2EE 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 207Java.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 345JMX Architecture 196
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
- K -KB 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 14KM 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
- L -Last Step GET 177
LastChanged 333
LastMachingLinesNumber 370
LastMatchingLines 370
LastModifiedFileElapsedTime 109, 339
Index 381
Monitoring Studio KM for PATROL
Version 8.6.53
LASTTIME 318
Launch 14, 61, 125, 138, 161, 294, 310, 368
setup.exe 14
setup.sh 14License 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 372Linux 13, 310
Linux-based 12
List 25, 98, 113, 188, 192, 236, 258, 266, 271,276, 294, 333
Listening 138
50001 14Load 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
- M -m%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 370MatchingEventCount 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
MBean 196, 199, 207, 214, 221, 228, 323, 363
MBeanServer
access 196MBeanServer API
access 196Mega-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 MonitoringStudio 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, 228Monitor 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, 93Monitoring 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
Index 382
Monitoring Studio KM for PATROL
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 14Monitoring Studio 8.3.00 11
Monitoring Studio builds 125, 192
Monitoring Studio deletes missing objects afterthey have been missing a specific number oftimes 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 113Monitoring 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
- N -Name 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 71Name 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
- O -Object 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 267Object 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 383
Monitoring Studio KM for PATROL
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, 314Oracle SQL*Plus
connect 71Oracle\ora92 71
org.objectweb.jonas.naming 205, 221
OS 51, 61, 143, 149, 246, 254, 271, 294, 314,318, 323, 357
execute 359OS 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
- P -Packages 13, 23, 71, 205, 207, 221
Page fault/sec 361
Page fault/secs 361
Pagefile 361
PageFileBytes 361
PAR file 31
parameter monitoring 323
Parameter Type 357
PARAMETER_NAME 242
parameters 24, 31, 48, 61, 93, 98, 101, 109,118, 138, 143, 161, 177, 188, 192, 196, 199,207, 221, 234, 236, 246, 285, 294, 323, 326,333, 335, 337, 339, 341, 343, 345, 347, 348,350, 352, 353, 357, 359, 361, 363, 366, 368,370, 372
Monitoring 113Parent 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 199PATROL 11, 12, 13, 14, 24, 25, 48, 51, 98,101, 113, 188, 192, 234, 236, 246, 258, 261,271, 288, 291, 294, 307, 323, 326, 333, 335,337, 339, 341, 343, 345, 347, 348, 350, 352,353, 357, 359, 361, 366, 368, 370, 372
Knowledge Modules 11PATROL 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 384
Monitoring Studio KM for PATROL
Version 8.6.53
Pause monitoring 288
PausemonitoringTemporarily_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 188Performance 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 31Poll 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 286Process 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 125Process 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
- Q -Query 24, 50, 71, 118, 143, 161, 165, 169,177, 196, 254, 311, 314, 326, 345, 353
Query timeout 71
QueryStatus 161, 326, 353
- R -Real-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 385
Monitoring Studio KM for PATROL
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
ResumemonitoringTemporarily_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 294
WMI 161Run Alert Actions 348, 368, 370
rwxr-xr-x 101
- S -Sample Properties
Win32_Service class 311Save 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
Security 11, 14, 24, 93, 205, 285, 333, 335
access rights 101sed 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, 143Select 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 242Setting Alert Actions 242, 294
Setting polling intervals 271
Setup 14, 48, 53, 161, 196, 236, 242, 270,271, 286
Extracting 23Setup files
Extracting 23Setup.exe 14
Setup.sh 14
sev>ERROR</sev 297
Index 386
Monitoring Studio KM for PATROL
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 366SNMP 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 138SNMP traps/Windows events 285
SNMP traps/Windows events > Acknowledge alland 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 258SQL 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 53State7 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 387
Monitoring Studio KM for PATROL
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 13Swsy_unix_8401.tar 13, 23
swsy_unix_8500.tar
UNIX 13swsy_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
- T -Targeted computers 11
Temporarily 288
Temporarily suspend 288
Temporarily suspend the monitoring of an object 288
Text 24, 101, 271, 294, 320, 326, 333, 341,343, 345, 353, 357, 359
Lines matching 372
names contain 125Text 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 118Threshold Management 149, 234, 236, 363
Threshold Type 234, 236
Thresholds
Customize 45
Import 45TIME 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 368Trig 61, 143
Trigger 51, 93, 98, 101, 109, 113, 118, 188,192, 199, 207, 221, 234, 236, 246, 285, 294, 348
Alarm 236
Warning 236Trigger 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
Index 388
Monitoring Studio KM for PATROL
Version 8.6.53
- U -UDP/162
handling 271Unable 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 13UNIX/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
- V -V6.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 366Value Type 350
valueA&varB 169, 177
valueB 169, 177
Values Extraction 149
VarBind
trap 368Varbinds 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
VirtualBytes 361
VMWare ESX Host 12
- W -Wait 25, 71, 118, 138
SNMP Traps 368Warning
Trigger 236WBEM 165, 355
Web 11, 13, 14, 320, 341, 343
application provides 50Web 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.handleRequest 297
weblogic.rmi.internal.ServerRequest.sendOneWayRaw 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
Index 389
Monitoring Studio KM for PATROL
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 348Windows 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 13winlog.exe process 271
WITHIN 30 311
WMI 24, 353
query 161WMI Administrative 161, 311
WMI namespace
enter 161
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_home00d0c9ea79f9bace118c8200aa004ba90b02000000030000 31
www.hotmail.com 169, 177
- X -xf 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 297XML tag
new 297XML-to-CSV pre-processing object 297
XP 12
Xpconfig 25
xxx 320
x-y 118, 143
xyz 320
About BMC® Software
BMC Software, Inc. NYSE:BMC, is a leading provider of enterprise managementsolutions that empower companies to manage their IT infrastructure from abusiness perspective. Delivering Business Service Management, BMC Softwaresolutions span enterprise systems, applications, databases, and servicemanagement. Founded in 1980, BMC Software has offices worldwide and fiscal2004 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 thecapabilities of BMC Performance Manager, thus enabling up to 100% coverage ofany infrastructure. Sentry Software specializes in single solutions for multi-platform monitoring of hardware, custom applications or any IT component, andblackout windows. Sentry Software products are deployed in 45 countries acrossthe globe and lead the list of BMC Software’s third-party product sales. For more
204102