HP SiteScope - Monitor Reference

HP SiteScope - Monitor Reference
HP SiteScope
For the Windows, Solaris, and Linux operating systems
Software Version: 11.23
Monitor Reference
Document Release Date: December 2013
Software Release Date: December 2013
Monitor Reference
Legal Notices
Warranty
The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be
construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Restricted Rights Legend
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer
Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial
license.
Copyright Notice
© Copyright 2005 - 2013 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
Intel®, Pentium®, and Intel® Xeon® are trademarks of Intel Corporation in the U.S. and other countries.
iPod is a trademark of Apple Computer, Inc.
Java is a registered trademark of Oracle and/or its affiliates.
Microsoft®, Windows®, Windows NT®, and Windows® XP are U.S registered trademarks of Microsoft Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
UNIX® is a registered trademark of The Open Group.
Documentation Updates
The title page of this document contains the following identifying information:
l
l
l
Software Version number, which indicates the software version.
Document Release Date, which changes each time the document is updated.
Software Release Date, which indicates the release date of this version of the software.
To check for recent updates or to verify that you are using the most recent edition of a document, go to: http://h20230.www2.hp.com/selfsolve/manuals
This site requires that you register for an HP Passport and sign in. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html
Or click the New users - please register link on the HP Passport login page.
You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details.
Support
Visit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport
This web site provides contact information and details about the products, services, and support that HP Software offers.
HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage
your business. As a valued support customer, you can benefit by using the support web site to:
l
l
l
l
l
l
l
l
Search for knowledge documents of interest
Submit and track support cases and enhancement requests
Download software patches
Manage support contracts
Look up HP support contacts
Review information about available services
Enter into discussions with other software customers
Research and register for software training
Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support contract. To register for an HP Passport ID, go to:
http://h20229.www2.hp.com/passport-registration.html
To find more information about access levels, go to:
http://h20230.www2.hp.com/new_access_levels.jsp
HP Software Solutions Now accesses the HPSW Solution and Integration Portal Web site. This site enables you to explore HP Product Solutions to meet your
business needs, includes a full list of Integrations between HP Products, as well as a listing of ITIL Processes. The URL for this Web site is
http://h20230.www2.hp.com/sc/solutions/index.jsp
HP SiteScope (11.23)
Page 2 of 926
Monitor Reference
Contents
Contents
3
Welcome to the SiteScope Monitor Reference
8
Part 1: SiteScope Monitor Reference Overview
9
Chapter 1: SiteScope Monitor Categories
10
Chapter 2: Monitor Categories List
13
Chapter 3: Monitor Permissions and Credentials
19
Part 2: SiteScope Monitors (A-Z)
43
Chapter 4: Active Directory Replication Monitor
44
Chapter 5: Amazon Web Services Monitor
47
Chapter 6: Apache Server Monitor
51
Chapter 7: BroadVision Application Server Monitor
54
Chapter 8: Browsable Windows Performance Counter Monitor
58
Chapter 9: Check Point Monitor
61
Chapter 10: Cisco Works Monitor
63
Chapter 11: Citrix Monitor
68
Chapter 12: ColdFusion Server Monitor
73
Chapter 13: COM+ Server Monitor
77
Chapter 14: Composite Monitor
81
Chapter 15: CPU Monitor
84
Chapter 16: Custom Monitor
89
Chapter 17: Custom Database Monitor
106
Chapter 18: Custom Log File Monitor
129
Chapter 19: Custom WMI Monitor
156
Chapter 20: Database Counter Monitor
176
Chapter 21: Database Query Monitor
185
Chapter 22: DB2 JDBC Monitor
200
Chapter 23: DHCP Monitor
207
Chapter 24: Directory Monitor
209
Chapter 25: Disk Space Monitor (Deprecated)
213
HP SiteScope (11.23)
Page 3 of 926
Monitor Reference
Chapter 26: DNS Monitor
217
Chapter 27: Dynamic Disk Space Monitor
220
Chapter 28: Dynamic JMX Monitor
232
Chapter 29: e-Business Transaction Monitor
250
Chapter 30: F5 Big-IP Monitor
254
Chapter 31: File Monitor
259
Chapter 32: Formula Composite Monitor
264
Chapter 33: FTP Monitor
268
Chapter 34: Generic Hypervisor Monitor
273
Chapter 35: Hadoop Monitor
280
Chapter 36: HAProxy Monitor
295
Chapter 37: HP iLO (Integrated Lights-Out) Monitor
298
Chapter 38: HP NonStop Event Log Monitor
302
Chapter 39: HP NonStop Resources Monitor
306
Chapter 40: HP Vertica JDBC Monitor
310
Chapter 41: IPMI Monitor
322
Chapter 42: KVM Monitor
325
Chapter 43: JMX Monitor
333
Chapter 44: LDAP Monitor
345
Chapter 45: Link Check Monitor
349
Chapter 46: Log File Monitor
352
Chapter 47: Mail Monitor
367
Chapter 48: MAPI Monitor
371
Chapter 49: Memcached Statistics Monitor
376
Chapter 50: Memory Monitor
378
Chapter 51: Microsoft ASP Server Monitor
383
Chapter 52: Microsoft Exchange Monitor
388
Chapter 53: Microsoft Exchange 2003 Mailbox Monitor
398
Chapter 54: Microsoft Exchange 5.5 Message Traffic Monitor
401
Chapter 55: Microsoft Exchange 2000/2003/2007 Message Traffic Monitor
403
Chapter 56: Microsoft Exchange 2003 Public Folder Monitor
406
HP SiteScope (11.23)
Page 4 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
409
Chapter 58: Microsoft IIS Server Monitor
418
Chapter 59: Microsoft Lync Server 2010 Monitors
425
Chapter 60: Microsoft SQL Server Monitor
440
Chapter 61: Microsoft Windows Dial-up Monitor
449
Chapter 62: Microsoft Windows Event Log Monitor
453
Chapter 63: Microsoft Windows Media Player Monitor
463
Chapter 64: Microsoft Windows Media Server Monitor
466
Chapter 65: Microsoft Windows Performance Counter Monitor
471
Chapter 66: Microsoft Windows Resources Monitor
475
Chapter 67: Microsoft Windows Services State Monitor
483
Chapter 68: Multi Log Monitor
488
Chapter 69: Network Bandwidth Monitor
498
Chapter 70: News Monitor
504
Chapter 71: Oracle 10g Application Server Monitor
507
Chapter 72: Oracle 9i Application Server Monitor
514
Chapter 73: Oracle Database Monitor
517
Chapter 74: Ping Monitor
526
Chapter 75: Port Monitor
529
Chapter 76: Radius Monitor
532
Chapter 77: Real Media Player Monitor
535
Chapter 78: Real Media Server Monitor
538
Chapter 79: SAP CCMS Monitor
542
Chapter 80: SAP CCMS Alerts Monitor
549
Chapter 81: SAP Java Web Application Server Monitor
554
Chapter 82: SAP Performance Monitor
558
Chapter 83: SAP Work Processes Monitor
564
Chapter 84: Script Monitor
570
Chapter 85: Service Monitor
580
Chapter 86: Siebel Application Server Monitor
586
Chapter 87: Siebel Log File Monitor
596
HP SiteScope (11.23)
Page 5 of 926
Monitor Reference
Chapter 88: Siebel Web Server Monitor
600
Chapter 89: SNMP Monitor
607
Chapter 90: SNMP by MIB Monitor
614
Chapter 91: SNMP Trap Monitor
621
Chapter 92: Solaris Zones Monitor
624
Chapter 93: SunONE Web Server Monitor
631
Chapter 94: Sybase Monitor
635
Chapter 95: Syslog Monitor
638
Chapter 96: Tuxedo Monitor
645
Chapter 97: UDDI Monitor
649
Chapter 98: UNIX Resources Monitor
650
Chapter 99: URL Monitor
655
Chapter 100: URL Content Monitor
669
Chapter 101: URL List Monitor
682
Chapter 102: URL Sequence Monitor
689
Chapter 103: VMware Datastore Monitor
713
Chapter 104: VMware Host Monitors
727
Chapter 105: VMware Performance Monitor
752
Chapter 106: Web Script Monitor
772
Chapter 107: Web Server Monitor
784
Chapter 108: Web Service Monitor
787
Chapter 109: WebLogic Application Server Monitor
798
Chapter 110: WebSphere Application Server Monitor
804
Chapter 111: WebSphere MQ Status Monitor
831
Chapter 112: WebSphere Performance Servlet Monitor
840
Chapter 113: XML Metrics Monitor
844
Part 3: Integration Monitors (A-Z)
848
Chapter 114: HP OM Event Monitor
849
Chapter 115: HP Service Manager Monitor
860
Chapter 116: NetScout Event Monitor
867
Chapter 117: Technology Database Integration Monitor
871
HP SiteScope (11.23)
Page 6 of 926
Monitor Reference
Chapter 118: Technology Log File Integration Monitor
886
Chapter 119: Technology SNMP Trap Integration Monitor
899
Chapter 120: Technology Web Service Integration Monitor
911
We appreciate your feedback!
HP SiteScope (11.23)
926
Page 7 of 926
Welcome to the SiteScope Monitor
Reference
This guide describes how to set up the monitoring environment and configure SiteScope and
integration monitors to monitor the enterprise IT infrastructure. It contains information for
configuring the specific monitor only. For information on configuring setting panels that are common
to all monitors, see Common Monitor Settings in the Using SiteScope Guide.
How This Guide Is Organized
This guide covers the following topics:
l
"SiteScope Monitor Reference Overview" on page 9
Describes the SiteScope monitor classes and category listing formats, the monitors in each
monitor category, and the user permissions and credentials needed to access each monitor.
l
"SiteScope Monitors (A-Z)" on page 43
Describes how to set up the monitoring environment and configure each type of SiteScope
monitor. It includes information on supported versions, setup requirements, user permissions,
and troubleshooting issues.
l
"Integration Monitors (A-Z)" on page 848
Describes how to configure each type of integration monitor, including troubleshooting issues
relating to monitoring EMS environments with SiteScope.
Note: For details on setting panels in the monitor Properties tab that are common to all
monitors, see Common Monitor Settings in Using SiteScope.
Who Should Read This Guide
This guide is intended for the following users of HP SiteScope and HP Business Service
Management (BSM):
l
SiteScope/BSM administrators
l
SiteScope/BSM application administrators
l
SiteScope/BSM data collector administrators
l
SiteScope/BSM end users
Readers of this guide should be knowledgeable about enterprise system administration,
infrastructure monitoring systems, and SiteScope, and have familiarity with the systems being set
up for monitoring. In addition, readers who are integrating with BSM should be familiar with BSM
and enterprise monitoring and management concepts.
HP SiteScope (11.23)
Page 8 of 926
Part 1: SiteScope Monitor Reference
Overview
HP SiteScope (11.23)
Page 9 of 926
Chapter 1: SiteScope Monitor Categories
SiteScope monitors are grouped according to classes that indicates their availability and category
that reflect their function. When you select to add a new monitor to a SiteScope agent, the list of
available monitor types for that agent are displayed both alphabetically and divided by category in
the product interface. The availability of the monitor category is dependent on the class of monitor.
Note: User permissions and credentials are needed to access each monitor. For details on the
required permissions and credentials, and the corresponding protocol used by each monitor,
see "Monitor Permissions and Credentials" on page 19.
This section describes the monitor classes and the category listing formats. To see the list of
monitors contained in each monitor category, see Monitor Categories List.
Standard Monitors
Standard monitor categories represent the monitor categories available with a general SiteScope
license. These monitor categories include many of the general purpose monitor categories.
l
Application Monitors. Monitors in this category monitor third-party applications. These
monitors enable SiteScope to access and retrieve data from the monitored applications.
l
Big Data. Monitors in this category monitor Big Data platforms to gain real-time visibility and
insight into the health and performance of the big data infrastructure.
l
Database Monitors. Monitors in this category monitor different types of database applications.
There are monitors that access data from specific database applications and generic monitors
that can be configured to monitor any database application.
l
Generic Monitors. Monitors in this category monitor different types of environment. These
monitors can monitor networks, applications, and databases depending on how they are
configured.
l
Media Monitors. Monitors in this category monitor applications that play media files and stream
data.
l
Network Monitors. Monitors in this category monitor network health and availability.
l
Server Monitors. Monitors in this category monitor server health and availability.
l
Virtualization and Cloud Monitors. Monitors in this category monitor virtualized environments
and cloud infrastructures.
l
Web Transaction Monitors. Monitors in this category monitor web-based applications.
Customizable Monitors
Custom monitors broaden the capabilities of regular SiteScope monitors for tracking the availability
and performance of your infrastructure systems and applications. Using custom monitors, you can
develop your own solutions for environments that are not supported by predefined SiteScope
HP SiteScope (11.23)
Page 10 of 926
Monitor Reference
Chapter 1: SiteScope Monitor Categories
monitors.
You can create your own monitor that collects data, and define a script that processes the collected
data and creates metrics. Each time the custom monitor runs, it updates the metrics and returns a
status for the metrics defined in the script.
Custom monitors can be published to the HP Live Network for sharing with other SiteScope users.
For more details on using Custom monitors, see Creating Custom Monitors.
Integration Monitors
Integration monitors are used to capture and forward data from third-party domain managers or
applications (typically Enterprise Management Systems (EMS)) into BSM.
These monitor types require additional licensing and may only be available as part of another HP
product. For more information about Integration Monitor capabilities, see Integration Monitors.
Solution Template Monitors
Solution template monitor types are a special class of monitors that enable new monitoring
capabilities for specific applications and environments. As part of a solution template, these
monitor types are deployed automatically together with other, standard monitor types to provide a
monitoring solution that incorporates best practice configurations. These monitor types are
controlled by option licensing and can only be added by deploying the applicable solution template.
After they have been deployed, you can edit or delete them using the same steps as with other
monitor types. For more information, see Deploying Solution Templates.
SiteScope provides the following solution templates that include standard SiteScope monitor types
and solution-specific monitors:
l
Active Directory (with and without Global Catalog)
l
AIX Host
l
Hadoop
l
HP Quality Center
l
HP Service Manager
l
HP Vertica
l
JBoss Application Server
l
Linux Host (OS )
l
Microsoft Exchange
l
Microsoft IIS Server
l
Microsoft Lync Server
l
Microsoft SharePoint
HP SiteScope (11.23)
Page 11 of 926
Monitor Reference
Chapter 1: SiteScope Monitor Categories
l
Microsoft SQL Server
l
Microsoft Windows Host
l
.NET
l
Oracle Database
l
SAP Application Server
l
Siebel Application/Gateway/Web Server (for UNIX and Windows)
l
VMware Capacity Management
l
VMware Host CPU/Memory/Network/State/Storage
l
VMware Host For Performance Troubleshooting
l
WebLogic Application Server
l
WebSphere Application Server
HP SiteScope (11.23)
Page 12 of 926
Chapter 2: Monitor Categories List
This section displays the SiteScope monitors in each monitor category.
l
"Application Monitors" below
l
"Big Data" on page 15
l
"Customizable Monitors" on page 15
l
"Database Monitors" on page 15
l
"Generic Monitors" on page 15
l
"Integration Monitors" on page 16
l
"Media Monitors" on page 16
l
"Network Monitors" on page 16
l
"Server Monitors" on page 17
l
"Virtualization and Cloud Monitors" on page 18
l
"Web Transaction Monitors" on page 18
Application Monitors
l
"Active Directory Replication Monitor" on page 44
l
"Apache Server Monitor" on page 51
l
"BroadVision Application Server Monitor" on page 54
l
"Check Point Monitor" on page 61
l
"Cisco Works Monitor" on page 63
l
"Citrix Monitor" on page 68
l
"ColdFusion Server Monitor" on page 73
l
"COM+ Server Monitor" on page 77
l
"F5 Big-IP Monitor" on page 254
l
"HAProxy Monitor" on page 295
l
"Mail Monitor" on page 367
HP SiteScope (11.23)
Page 13 of 926
Monitor Reference
Chapter 2: Monitor Categories List
l
"MAPI Monitor" on page 371
l
"Memcached Statistics Monitor" on page 376
l
"Microsoft ASP Server Monitor" on page 383
l
"Microsoft Exchange Monitor" on page 388
l
"Microsoft Exchange 2003 Mailbox Monitor" on page 398
l
"Microsoft Exchange 5.5 Message Traffic Monitor" on page 401
l
"Microsoft Exchange 2000/2003/2007 Message Traffic Monitor" on page 403
l
"Microsoft Exchange 2003 Public Folder Monitor" on page 406
l
"Microsoft IIS Server Monitor" on page 418
l
"News Monitor" on page 504
l
"Oracle 9i Application Server Monitor" on page 514
l
"Oracle 10g Application Server Monitor" on page 507
l
"Radius Monitor" on page 532
l
"SAP CCMS Monitor" on page 542
l
"SAP CCMS Alerts Monitor" on page 549
l
"SAP Java Web Application Server Monitor" on page 554
l
"SAP Performance Monitor" on page 558
l
"SAP Work Processes Monitor" on page 564
l
"Siebel Application Server Monitor" on page 586
l
"Siebel Log File Monitor" on page 596
l
"Siebel Web Server Monitor" on page 600
l
"SunONE Web Server Monitor" on page 631
l
"Tuxedo Monitor" on page 645
l
"UDDI Monitor" on page 649
l
"WebLogic Application Server Monitor" on page 798
HP SiteScope (11.23)
Page 14 of 926
Monitor Reference
Chapter 2: Monitor Categories List
l
"Web Server Monitor" on page 784
l
"WebSphere Application Server Monitor" on page 804
l
"WebSphere MQ Status Monitor" on page 831
l
"WebSphere Performance Servlet Monitor" on page 840
Big Data
l
"Hadoop Monitor" on page 280
l
"HP Vertica JDBC Monitor" on page 310
Customizable Monitors
l
"Custom Monitor" on page 89
l
"Custom Database Monitor" on page 106
l
"Custom Log File Monitor" on page 129
l
"Custom WMI Monitor" on page 156
Database Monitors
l
"Database Counter Monitor" on page 176
l
"Database Query Monitor" on page 185
l
"DB2 JDBC Monitor" on page 200
l
"LDAP Monitor" on page 345
l
"Microsoft SQL Server Monitor" on page 440
l
"Oracle Database Monitor" on page 517
l
"Sybase Monitor" on page 635
Generic Monitors
l
"Composite Monitor" on page 81
l
"Directory Monitor" on page 209
l
"Dynamic JMX Monitor" on page 232
l
"File Monitor" on page 259
HP SiteScope (11.23)
Page 15 of 926
Monitor Reference
Chapter 2: Monitor Categories List
l
"Formula Composite Monitor" on page 264
l
"JMX Monitor" on page 333
l
"Log File Monitor" on page 352
l
"Multi Log Monitor" on page 488
l
"Script Monitor" on page 570
l
"Syslog Monitor" on page 638
l
"Web Service Monitor" on page 787
l
"XML Metrics Monitor" on page 844
Integration Monitors
l
"HP OM Event Monitor" on page 849
l
"HP Service Manager Monitor" on page 860
l
"NetScout Event Monitor" on page 867
l
"Technology Database Integration Monitor" on page 871
l
"Technology Log File Integration Monitor" on page 886
l
"Technology SNMP Trap Integration Monitor" on page 899
l
"Technology Web Service Integration Monitor" on page 911
Media Monitors
l
"Microsoft Lync Server 2010 Monitors" on page 425 (Microsoft A/V Conferencing Server,
Microsoft Archiving Server, Microsoft Director Server, Microsoft Edge Server, Microsoft Front
End Server, Microsoft Mediation Server, Microsoft Monitoring and CDR Server, and Microsoft
Registrar Server)
l
"Microsoft Windows Media Player Monitor" on page 463
l
"Microsoft Windows Media Server Monitor" on page 466
l
"Real Media Player Monitor" on page 535
l
"Real Media Server Monitor" on page 538
Network Monitors
l
"DNS Monitor" on page 217
HP SiteScope (11.23)
Page 16 of 926
Monitor Reference
Chapter 2: Monitor Categories List
l
"FTP Monitor" on page 268
l
"Microsoft Windows Dial-up Monitor" on page 449
l
"Network Bandwidth Monitor" on page 498
l
"Ping Monitor" on page 526
l
"Port Monitor" on page 529
l
"SNMP Monitor" on page 607
l
"SNMP Trap Monitor" on page 621
l
"SNMP by MIB Monitor" on page 614
Server Monitors
l
"Browsable Windows Performance Counter Monitor" on page 58
l
"CPU Monitor" on page 84
l
"Disk Space Monitor (Deprecated)" on page 213
l
"DHCP Monitor" on page 207
l
"Dynamic Disk Space Monitor" on page 220
l
"HP iLO (Integrated Lights-Out) Monitor" on page 298
l
"HP NonStop Event Log Monitor" on page 302
l
"HP NonStop Resources Monitor" on page 306
l
"IPMI Monitor" on page 322
l
"Memory Monitor" on page 378
l
"Microsoft Windows Event Log Monitor" on page 453
l
"Microsoft Windows Performance Counter Monitor" on page 471
l
"Microsoft Windows Resources Monitor" on page 475
l
"Microsoft Windows Services State Monitor" on page 483
l
"Service Monitor" on page 580
l
"UNIX Resources Monitor" on page 650
HP SiteScope (11.23)
Page 17 of 926
Monitor Reference
Chapter 2: Monitor Categories List
Virtualization and Cloud Monitors
l
"Amazon Web Services Monitor" on page 47
l
"Generic Hypervisor Monitor" on page 273
l
"KVM Monitor" on page 325
l
"Microsoft Hyper-V Monitor" on page 409
l
"Solaris Zones Monitor" on page 624
l
"VMware Datastore Monitor" on page 713
l
"VMware Host Monitors" on page 727 (VMware Host CPU, VMware Host Memory, VMware
Host Network, VMware Host State, and VMware Host Storage)
l
"VMware Performance Monitor" on page 752
Web Transaction Monitors
l
"e-Business Transaction Monitor" on page 250
l
"Link Check Monitor" on page 349
l
"URL Monitor" on page 655
l
"URL Content Monitor" on page 669
l
"URL List Monitor" on page 682
l
"URL Sequence Monitor" on page 689
l
"Web Script Monitor" on page 772
HP SiteScope (11.23)
Page 18 of 926
Chapter 3: Monitor Permissions and Credentials
This section contains a table of SiteScope monitors. Each monitor is listed with its corresponding
protocol, the user permissions and credentials needed to access the monitor, and any further notes.
The purpose of this section is to provide you with basic information about the permissions needed
to secure your SiteScope monitors.
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Amazon Web
Services
HTTPS
AWS AccessKey ID,
AWS SecretKey
Apache
Server
HTTP,
HTTPS
None needed unless
required to access the
server statistics page.
BroadVision
Proprietary
CheckPoint
Firewall-1
SNMP
HP SiteScope (11.23)
Community string.
Notes
This monitor uses secret access keys
provided by Amazon. User can find
them at Amazon's official site under
the user’s profile. The HTTP
connection is secured.
This monitor does not support SNMP
V3, so the community string passes
plain text over the network. The
target's SNMP agent may be
configured so that the community
string can only be used to read a
subset of the MIB. The implication for
such a configuration is that if an
unauthorized person obtained the
community string, he would only be
able to read OIDs from the agent (but
not be able to set them).
Page 19 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Cisco Works
SNMP
Community string or
user name/password,
depending on SNMP
version.
Notes
The safest possible configuration for
this monitor is running it against an
agent configured to use SNMP V3 with
authentication (SHA or MD5) and DES
encryption for privacy. In this
configuration, no unencrypted SNMP
data passes over the network. This
greatly reduces the risk that a
malicious user could compromise the
monitored device. It does not take into
account security vulnerabilities from
implementation bugs in the monitored
device's SNMP agent.
The riskiest configuration of this
monitor is to use SNMP V1 with a
community string that has both read
and write access on the entire MIB
implemented by the agent on the
monitored device. In this configuration,
a malicious user could obtain the
community string by eavesdropping on
the network, and then use that
community string to reconfigure the
device.
Citrix Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
ColdFusion
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
HP SiteScope (11.23)
Page 20 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
COM+
HTTP,
HTTPS
CPU
(Windows)
NetBIOS,
WMI
User Permissions
and Credentials
Notes
Specific access
permissions are
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Add the server where SiteScope is
running to the Domain Admin group in
Active Directory (for Windows 2003 or
later). With this option, the SiteScope
service is set to log on as a local
system account, but the machine
where SiteScope is running is added to
a group having domain administration
privileges.
Edit the registry access permissions
for all machines in the domain to
enable non-admin access. For details
on enabling non-admin users to
remotely monitor machines with
perfmon, see Microsoft Knowledge
Base article 164018 (
http://support.microsoft.com/kb/1640
18/en-us). This option requires
changes to the registry on each remote
machine that you want to monitor. This
means that while the list of servers in
the domain includes all machines in
the domain, only those whose registry
has been modified can be monitored
without use of a connection profile.
CPU
(Solaris/
Linux)
Telnet, SSH,
rlogin
HP SiteScope (11.23)
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permissions to
run specific
executable programs.
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Page 21 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Database
Counter
JDBC
User credentials are
needed to
authenticate access
to the particular
database. Each
database has a
particular method for
providing access
control to the
particular tables that
need to be accessed.
The user needs sufficient permission
to execute any specified SQL
statements.
Directory
Shell
Need shell access to
the remote server.
Supported access
protocols are telnet,
SSH, and rlogin. It is
also necessary for the
logged-in user to have
permissions to run
specific executable
programs.
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Directory
(Windows)
NetBIOS
Read-only file system
access.
Permissions for specific files can be
controlled at the operating system
level.
Directory
(Solaris/
Linux)
Telnet, SSH,
rlogin
Read-only file system
access to the
particular files.
Permissions for specific files can be
controlled at the operating system
level.
Disk Space
(Windows)
NetBIOS,
WMI
Specific access
permissions are
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
HP SiteScope (11.23)
Notes
Page 22 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Notes
Disk Space
(Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permission to
run specific
executable programs.
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Dynamic
Disk Space
(Windows)
NetBIOS,
WMI
Specific access
permissions are
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Dynamic
Disk Space
(Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permission to
run specific
executable programs.
Dynamic
JMX
RMI, IIOP
None needed for
SiteScope. The
server may require a
valid user name and
password.
HP SiteScope (11.23)
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Page 23 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
F5 Big-IP
SNMP
Community string or
user name/password
depending on SNMP
version.
Notes
The safest possible configuration for
this monitor is running it against an
agent configured to use SNMP V3 with
authentication (SHA or MD5) and DES
encryption for privacy. In this
configuration, no unencrypted SNMP
data passes over the network. This
greatly reduces the risk that a
malicious user could compromise the
monitored device. It does not take into
account security vulnerabilities from
implementation bugs in the monitored
device's SNMP agent.
The riskiest configuration of this
monitor is to use SNMP V1 with a
community string that has both read
and write access on the entire MIB
implemented by the agent on the
monitored device. In this configuration,
a malicious user could obtain the
community string by eavesdropping on
the network, and then use that
community string to reconfigure the
device.
File
(Windows)
NetBIOS,
WMI
Windows permissions
for read-only access
to log file.
File (Solaris/
Linux)
Telnet, SSH,
rlogin
Read-only file
permission to the
target file system.
FTP
FTP
Valid user name and
password for the FTP
site with read-only
permission to copy
the user-specified file.
The customer site
may permit
anonymous logon.
HP SiteScope (11.23)
Page 24 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Notes
Generic
Hypervisor
Telnet, SSH,
and rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permission to
run specific
executable programs.
It is possible to restrict logged-in
users' access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Hadoop
JMX
Valid user name and
password for Hadoop
master node JMX.
HAProxy
HTTP/
HTTPS
None needed for
SiteScope. The
server may require a
valid user name and
password.
HP iLO
(Integrated
Lights-Out)
SSH
Should be configured
by the HP iLO system
administrator.
HP SiteScope (11.23)
When configuring the remote server,
select SSH version 2 only in the
Advanced Settings pane (to make it
work faster).
Page 25 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
HP Vertica
JDBC
JDBC
Valid user name and
password for the
Vertica database.
Notes
No explicit permissions are required
for the following tables; however,
users see only the records that
correspond to tables they have
permissions to view:
- active_events
- disk_storage
- configuration_parameters
- critical_hosts
- critical_nodes
- disk_resource_rejection
- disk_storage
- host_resources
- nodes
- locks
- node_resources
- projections
- query_metrics
- query_profiles
- recovery_status
- resource_pools
- resource_pool_status
- resource_queues
- resource_rejections
- resource_usage
- system
- system_services
- wos_container_storage
The user must be a Superuser to view
data from the following tables:
- database_backups tree branch
“Backups”
- storage_tiers tree branch “Storage
Tiers”
- system_resource_usage tree branch
“System Resource Usage”
JMX
RMI, IIOP
HP SiteScope (11.23)
None needed for
SiteScope. The
server may require a
valid user name and
password.
Page 26 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Notes
KVM
Telnet, SSH,
and rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permission to
run specific
executable programs.
It is possible to restrict logged-in
users' access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
LDAP
LDAP
Valid user name and
password on the
LDAP server to do
simple authentication.
Query or search
operations require
appropriate
permissions.
Anonymous
authentication also
supported in version
7.9.
Link Check
HTTP/
HTTPS
None needed unless
the HTTP/HTTPS
site requires a user
name/password.
Log File
(Windows)
NetBIOS
Windows permissions
for read-only access
to log file.
Log File
(Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permissions to
run specific
executable programs.
Read-only file
permissions to the
target file system.
Mail
SMTP
A valid email account
and password.
HP SiteScope (11.23)
User needs sufficient permission to
click on links.
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the command that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Page 27 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
MAPI
MAPI
User name/password
of one or two email
accounts to send and
receive test emails.
Memory
(Windows)
NetBIOS,
WMI
Same as Microsoft
ASP Server monitor.
Memory
(Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permissions to
run specific
executable programs.
Memcached
Statistics
TCP
None needed.
Microsoft
Archiving
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft A/V NetBIOS,
Conferencing WMI
Server
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
HP SiteScope (11.23)
Notes
SiteScope must run as local
administrator on the SiteScope server.
Test email accounts must have local
administrator authority in the
SiteScope server.
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Page 28 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Microsoft
ASP Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Director
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Edge Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Front End
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
HP SiteScope (11.23)
Notes
Page 29 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Microsoft IIS
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Mediation
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Monitoring
and CDR
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Registrar
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
HP SiteScope (11.23)
Notes
Page 30 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Microsoft
SQL Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Windows
Dialup
MODEM
User name/password
to the ISP account
being contacted. The
account needs
sufficient authority to
execute its specified
test monitors.
Microsoft
Windows
Event Log
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Windows
Media Player
Telnet, SSH,
rlogin
Read-only file
permission to the
target file system.
Microsoft
Windows
Media Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
HP SiteScope (11.23)
Notes
Page 31 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Microsoft
Windows
Performance
Counter
NetBIOS
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Microsoft
Windows
Resources
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Multi Log
(Windows)
NetBIOS
Windows permissions
for read-only access
to log file.
Multi Log
(Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permissions to
run specific
executable programs.
Read-only file
permissions to the
target file system.
HP SiteScope (11.23)
Notes
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the command that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Page 32 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Network
Bandwidth
SNMP
Community string or
user name/password
depending on SNMP
version.
Notes
The safest possible configuration for
this monitor is running it against an
agent configured to use SNMP V3 with
authentication (SHA or MD5) and DES
encryption for privacy. In this
configuration no unencrypted SNMP
data passes over the network. This
greatly reduces the risk that a
malicious user could compromise the
monitored device. It does not take into
account security vulnerabilities from
implementation bugs in the monitored
device's SNMP agent.
The riskiest configuration of this
monitor is to use SNMP V1 with a
community string that has both read
and write access on the entire MIB
implemented by the agent on the
monitored device. In this configuration,
a malicious user could obtain the
community string by eavesdropping on
the network, and then use that
community string to reconfigure the
device.
News
NNTP
Oracle 9i
Application
Server
HTTP/
HTTPS
HP SiteScope (11.23)
A valid user name and
password if the news
server requires it, with
read-only permission
to query total number
of messages in the
news groups.
Page 33 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Oracle
Database
JDBC
An Oracle user logs in
with the ability to
execute all the SQL
statements found in
<SiteScope root
directory>\
templates.applicatio
ns\
commands.oraclejd
bc.
Ping
ICMP
N/A
Port
TCP
N/A
Radius
Radius
A valid user name and
password on the
Radius server. No
other permissions are
needed.
Real Media
Player
Telnet, SSH,
rlogin
Read-only file
permission on the
target file system.
Real Media
Server
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
SAP CCMS
Proprietary
XMI authorization.
SAP CCMS
Alert
Proprietary
SAP
Performance
or SAP Work
Processes
Proprietary
HP SiteScope (11.23)
Notes
SiteScope’s IP must be added to the
list of servers enabled to communicate
with the Radius server. It must also be
configured to do PAP authentication.
Profiles that have XMI authorization
are S_A.SYSTEM, PD_CHICAGO,
S_WF_RWTEST, and SAP_ALL.
Page 34 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Script
(Windows)
Telnet, SSH,
rlogin
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Script
(Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permissions to
run specific
executable programs.
Notes
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Script on
Telnet, SSH,
local machine rlogin/
(Solaris,
NetBIOS
Linux and
Windows)
Read-only file
permission to the
target file system.
Service
(Windows)
NetBIOS,
WMI
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on page 41.
required for monitoring
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on page
41).
Service
(Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permissions to
run specific
executable programs.
HP SiteScope (11.23)
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the commands that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Page 35 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Siebel
Application
Server
(previously
Siebel Server
Manager)
CmdLine
User account must
have Siebel
Administrator
Responsibility
privileges to issue
Siebel server
manager (srvrmgr)
commands.
Siebel Log
Telnet, SSH,
rlogin
File read-only
permission to the
target Siebel server
file system.
Siebel Web
Server
HTTP/
HTTPS
User name and
password are needed
if target Siebel
Extensions Page is
behind third-party,
HTML, form-based
authentication
software.
HP SiteScope (11.23)
Notes
If the srvrmgr client is remote then a
Remote (Windows or UNIX) must be
set up with the appropriate user name
and password credentials for
executing the remote srvrmgr
command.
User must have permission to retrieve
the Siebel SWE page.
Page 36 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
SNMP
SNMP
Community string or
user name/password,
depending on the
SNMP version.
Notes
The safest possible configuration for
this monitor is running it against an
agent configured to use SNMP V3 with
authentication (SHA or MD5) and DES
encryption for privacy. In this
configuration, no unencrypted SNMP
data passes over the network. This
greatly reduces the risk that a
malicious user could compromise the
monitored device. It does not take into
account security vulnerabilities from
implementation bugs in the monitored
device's SNMP agent.
The riskiest configuration of this
monitor is to use SNMP V1 with a
community string that has both read
and write access on the entire MIB
implemented by the agent on the
monitored device. In this configuration,
a malicious user could obtain the
community string by eavesdropping on
the network, and then use that
community string to reconfigure the
device.
HP SiteScope (11.23)
Page 37 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
SNMP by
MIB
SNMP
Community string or
user name and
password, depending
on the SNMP version.
Notes
The safest possible configuration for
this monitor is running it against an
agent configured to use SNMP V3 with
authentication (SHA or MD5) and DES
encryption for privacy. In this
configuration, no unencrypted SNMP
data passes over the network. It
greatly reduces the risk that a
malicious user could compromise the
monitored device. It does not take into
account security vulnerabilities from
implementation bugs in the monitored
device's SNMP agent.
The riskiest configuration of this
monitor is to use SNMP V1 with a
community string that has both read
and write access on the entire MIB
implemented by the agent on the
monitored device. In this configuration,
a malicious user could obtain the
community string by eavesdropping on
the network, and then use that
community string to reconfigure the
device.
SNMP Trap
SunONE
SNMP
HTTP/
HTTPS
HP SiteScope (11.23)
None, although
permissions to
configure agents on
the network to send
traps to SiteScope are
required. SiteScope
must be running as a
privileged user so that
it can bind to port 162,
a reserved port.
The security risk associated with
SNMP V1 and V2 traps is that a
malicious user could eavesdrop on the
data that is passed in the traps.
Using V3 traps with authentication and
privacy greatly reduces the chance
that data can be used maliciously by
eavesdroppers.
None, unless using a
proxy that requires
authentication.
Page 38 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
Syslog
Telnet, SSH,
rlogin
Need shell access to
the remote server. It
is also necessary for
the logged-in user to
have permissions to
run specific
executable programs.
Read-only file
permissions to the
target file system.
Tuxedo
Proprietary
PeopleSoft Tuxedo
comes with two
preconfigured users,
PS and VP, that are
monitor-only
accounts. No other
user can be created or
used for SiteScope
monitoring.
URL
HTTP/
HTTPS
None needed for
SiteScope. The
server may require a
valid user name and
password.
URL Content
HTTP/
HTTPS
None needed for
SiteScope. The
server may require a
valid user name and
password.
URL List
HTTP/
HTTPS
None needed for
SiteScope. The
server may require a
valid user name and
password.
URL
Sequence
HTTP/
HTTPS
None needed for
SiteScope. The
server may require a
valid user name and
password.
HP SiteScope (11.23)
Notes
It is possible to restrict logged-in
users’ access by using UNIX group
permissions for the command that
SiteScope would run. A list of the
relevant commands for a particular
operating system can be found in the
templates.os files.
Page 39 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
VMware
Datastore
HTTPS
Valid username and
password for vCenter
User needs sufficient permissions to
view datacenters, datastores, and
vmdisks. For vmdisks, user should
have Datastore browsable
permissions. These monitors also
require importing server certificates
from vCenter. This can be done using
Certificate Management in SiteScope
(either before or during monitor
configuration, using the Import
Certificate option).
VMware Host HTTPS
CPU/
Memory/
Storage/
Network/
State
Valid username and
password for
vCenter/Host.
User needs sufficient permissions to
view hosts and VMs. These monitors
also require importing server
certificates from vCenter/Host. This
can be done manually or by using
Certificate Management in SiteScope
(either before or during monitor
configuration, using the Import
Certificate option).
Web Server
NetBIOS
Specific access
See notes in "Monitoring Performance
permissions are
Objects on Windows" on the next
required for monitoring page.
performance objects
on Windows (see
"Monitoring
Performance Objects
on Windows" on the
next page).
Web Server
(Solaris,
Linux and
Windows)
Telnet, SSH,
rlogin
Read-only file
permission to the
target file system.
Web Service
HTTP/
HTTPS
Supports basic,
digest, and NTLM
authentication if
required by the target
Web service.
WebLogic
Application
Server 5.x
SNMP
Community string
credential must match
the string in the
SNMP agent.
HP SiteScope (11.23)
Notes
Page 40 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor
Name
Protocol /
Technology
User Permissions
and Credentials
WebLogic
Application
Server 6.x
and later
RMI
Requires a user that
belongs to a group
with at least monitor
role privilege.
WebSphere
Application
Server
(SOAP over
HTTP)
HTTP/
HTTPS
Requires a user that
has or belongs to a
group with at least the
monitor role privilege.
WebSphere
MQ Status
Proprietary
SiteScope account
must be a member of
mqm group in the MQ
Windows server.
Notes
In MQ UNIX, the
server connection
channel used must
not require SSL
authentication.
WebSphere
Performance
Servlet
HTTP/
HTTPS
HTTP authentication
through user name
and password to the
URL of the servlet.
Credentials can be
customized by the
user.
Monitoring Performance Objects on Windows
Access Permissions:
Monitoring performance objects on Windows requires that a user have specific access permissions
as described in the Microsoft Knowledge Base for article 300702
(http://support.microsoft.com/kb/300702/en-us) and article 164018
(http://support.microsoft.com/kb/164018/en-us).
These articles describe the permissions and security policies that should be granted to the user on
the monitored server.
Notes:
l
Perfmon User. A user that was granted the required privileges to be able to monitor
performance objects on Windows servers.
HP SiteScope (11.23)
Page 41 of 926
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
The Performance Monitor Users (on Windows 2003), Power Users, and Administrators
groups on Windows servers are already associated with the set of permissions and security
policies that are required for a Perfmon User. Any user that belongs to these groups has all
required permissions to monitor the performance objects and automatically becomes a Perfmon
User. The Performance Monitor Users group contains the exact set of privileges whereas the
Power Users and Administrators groups are associated with multiple additional privileges that
are not required for performance monitoring.
l
SiteScope User. The user that the SiteScope service logs on as.
For SiteScope monitors to be able to collect perfmon data from remote servers, connections
must be established to these servers using the credentials of a user defined as a Perfmon User.
These connections can be established with the following options:
n
Configure the SiteScope user to be a domain user that is also a user on the remote machines.
n
Where the SiteScope User is not defined as a Perfmon User on remote machines, a Remote
NT object must be configured in SiteScope using the credentials of a user that is defined as a
Perfmon User on the remote machine. Monitors are then configured to use the Remote NT
object.
HP SiteScope (11.23)
Page 42 of 926
Part 2: SiteScope Monitors (A-Z)
HP SiteScope (11.23)
Page 43 of 926
Chapter 4: Active Directory Replication Monitor
Use the Active Directory Replication monitor to monitor the time that it takes a change made on one
Domain Controller to replicate to up to as many as ten other Domain Controller.
Note: The Active Directory Replication monitor can only be added by deploying an Active
Directory solution template, which requires additional licensing to enable it in the SiteScope
interface. Contact your HP sales representative for more information about solution licensing.
For information about using templates to deploy monitors, see SiteScope Templates in the
Using SiteScope Guide.
To access
Select the Templates context. In the template tree, expand the Solution Templates container.
Right-click the Active Directory solution template that you require, and select Deploy Template.
Select the SiteScope group container into which you want to deploy the solution template, and enter
the deployment values.
Learn About
This section includes:
l
"Active Directory Replication Monitor Overview" below
l
"Supported Platforms/Versions" below
Active Directory Replication Monitor Overview
The Active Directory Replication monitor enables you to verify that replication, a key part of the
Active Directory System, is occurring within set thresholds. Create a separate Active Directory
Replication monitor for each Domain Controller that is being replicated throughout your system. The
error and warning thresholds for the monitor can be set on each of the monitored Domain
Controllers.
No additional setup is required other than to enable access to a Domain Admin account.
The Active Directory Replication monitor works by making a small change to part of the Directory
Service tree of the configured Domain Controller. It then checks each of the configured Replicating
Domain Controllers for this small change. As the change is detected the difference between when
the change was made and when it was replicated is calculated.
Supported Platforms/Versions
This monitor supports monitoring remote servers running on Windows Server 2003, 2008, and 2008
R2.
HP SiteScope (11.23)
Page 44 of 926
Monitor Reference
Chapter 4: Active Directory Replication Monitor
Tasks
How to Configure the Active Directory Replication Monitor
1. Prerequisites
n
The Active Directory Replication monitor can only be added by deploying an Active
Directory solution template, which requires additional licensing to enable it in the SiteScope
interface. Contact your HP sales representative for more information about solution
licensing.
n
The LDAP Authentication Tool is available when configuring this monitor to authenticate
a user on an LDAP server (provided you are an administrator in SiteScope, or a user granted
Use monitor tools permissions). To use the tool when configuring or editing a monitor,
click the Use Tool button. For details on the tool, see LDAP Authentication Status Tool in
the Using SiteScope Guide.
2. Deploy the Active Directory Solution template
For details on using templates to deploy monitors, see SiteScope Templates in the Using
SiteScope Guide.
For details on the Active Directory solution template, see Active Directory Solution Templates
in the Using SiteScope Guide.
3. Configure the monitor properties
After the monitor has been created, you can edit the monitor configuration in the same way as
other monitors.
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Active Directory Replication Monitor Settings
User interface elements are described below:
UI Element
Description
Domain
controller
Domain controller that contains the replicated data.
Replicating
domain
controllers
Comma separated list of domain controllers that replicate data from the domain
controller entered above.
HP SiteScope (11.23)
Page 45 of 926
Monitor Reference
Chapter 4: Active Directory Replication Monitor
UI Element
Description
User name
User name or the entire Security Principal of a Domain Admin account.
If a user name is given, the default security principal is created from the root
context of the Domain Controller.
Example: If you enter Administrator for a domain controller in the domain
yourcompany.com, then the entire Security Principal would be
CN=Administrator,CN=Users,DC=yourcompany,DC=com.
Password
Password for the Domain Admin account.
Maximum
replication
time
(seconds)
Maximum amount of time for replication to occur. The monitor goes into error if
any of the Replicating Domain Controllers exceed this replication time.
Polling
interval
(seconds)
Amount of time this monitor should wait between queries of the Replicating
Domain Controllers. A higher number reduces the number of LDAP queries
against the servers.
Default value: 600 seconds
Default value: 10 seconds
Directory
path
Path to a directory in the Active Directory that you want to monitor. This is in the
form of an LDAP query.
Default value: Based on the default Directory for this server. For example, the
default for a Domain Controller for sub.yourcompany.com is
DC=sub,DC=yourcompany,DC=com.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 46 of 926
Chapter 5: Amazon Web Services Monitor
The Amazon Web Services monitor enables monitoring of Amazon Web Services (AWS) cloud
resources.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Amazon Web Services monitor.
Learn About
This section includes:
l
"Amazon Web Services Monitor Overview" below
l
"Supported Platforms/Versions" below
Amazon Web Services Monitor Overview
The Amazon Web Services monitor enables monitoring of Amazon Web Services (AWS) cloud
resources, starting with Amazon Elastic Compute Cloud service (EC2) and Amazon Virtual Private
Cloud (VPC). It provides data on resource utilization, operational performance, and overall network
demand patterns.
Data collected from AWS-hosted applications can also be reported to Amazon CloudWatch using
the Amazon CloudWatch integration. This data can then be used for AWS AutoScaling, reporting
and alerting. For details on enabling the Amazon CloudWatch integration, see Amazon CloudWatch
Integration Preferences.
The Amazon Web Services monitor enables monitoring of Amazon Web service cloud resources,
starting with Amazon Elastic Compute Cloud service (EC2). It provides data on resource
utilization, operational performance, and overall network demand patterns.
Supported Platforms/Versions
This monitor supports monitoring Amazon EC2 API version 2009-11-30.
Tasks
How to Configure the Amazon Web Services Monitor
1. Prerequisites
The Amazon CloudWatch Service is required to monitor Amazon Web Services.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 47 of 926
Monitor Reference
Chapter 5: Amazon Web Services Monitor
UI Descriptions
Amazon Web Services Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
AWS Access
Key ID
An alphanumeric token that uniquely identifies a request sender. This ID is
associated with your AWS Secret Access Key.
AWS Secret
Key
The key assigned to you by AWS when you sign up for an AWS account. Used
for request authentication.
Socket
Amount of time, in milliseconds, to wait for data from a server during a single
timeout
data request. After the socket timeout period elapses, the monitor logs an error
(milliseconds) and reports the error status. A value of zero means there is no timeout used.
Default value: 120 milliseconds
Region
The Amazon EC2 region that is used to get or store measurements.
Default value: US East (Northern Virginia)
Note: When configuring the monitor in template mode, enter the Amazon region
ID in the Region ID box as follows:
HP SiteScope (11.23)
l
us-east-1 for US East (Northern Virginia)
l
us-west-2 for US West (Oregon)
l
us-west-1 for US West (Northern California)
l
eu-west-1 for EU (Ireland)
l
ap-southeast-1 for Asia Pacific (Singapore)
l
ap-northeast-1 for Asia Pacific (Tokyo)
l
sa-east-1 for South America (Sao Paulo)
l
us-gov-west-1 for AWS GovCloud
Page 48 of 926
Monitor Reference
Chapter 5: Amazon Web Services Monitor
UI Element
Description
Get Regions
Opens the Get Regions dialog box, enabling you to select the Amazon EC2
region that is used to get or store measurements. Amazon EC2 is currently
available in the following regions: US East (Northern Virginia), US West
(Oregon), US West (Northern California), EU (Ireland), Asia Pacific
(Singapore), Asia Pacific (Tokyo), South America (Sao Paulo), and AWS
GovCloud.
Note: This button is not available when configuring the monitor in template
mode; you must manually enter the region ID using one of the IDs listed in
Region above.
Counter Settings
Counters
Server performance counters to check with this monitor. The list displays the
available counters and those currently selected for this monitor. Use the Get
Counters button to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you want
to monitor. For the list of counters that can be configured for this monitor, see
"Monitor Counters" below.
Proxy Settings
NTLM V2
Proxy
Select if the proxy requires authentication using NTLM version 2.
Address
Domain name and port of an HTTP Proxy Server if a proxy server can be used
to access the AWS cloud resources to be monitored.
User name
Proxy server user name if required to access the AWS cloud resources.
Note: Your proxy server must support Proxy-Authenticate for these options to
function.
Password
Proxy server password if required to access the AWS cloud resources.
Note: Your proxy server must support Proxy-Authentication for these options
to function.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
l
CPUUtilization
l
NetworkIn
HP SiteScope (11.23)
Page 49 of 926
Monitor Reference
Chapter 5: Amazon Web Services Monitor
l
NetworkOut
l
DiskWriteOps
l
DiskReadBytes
l
DiskReadOps
l
DiskWriteBytes
Tips/Troubleshooting
General Tips/Limitations
l
The Amazon Web Services Monitor only gets data from instances that have detailed monitoring
enabled in the AWS Management Console (it does not get data from instances with basic
monitoring enabled).
l
Amazon does not store data sent from SiteScope via the Amazon integration or from Amazon
instances for more than two weeks (old data is automatically removed). As a result, the Amazon
Web Services monitor does not return data older than two weeks.
l
By default, SiteScope gets data from AWS-hosted applications at a 2-minutes interval. You can
customize the period for receiving data from Amazon by adding the _
amazonCloudWebServiceMonitorPeriod property (and a value in minutes) to the <SiteScope
root directory>\groups\master.config file. For example, _
amazonCloudWebServiceMonitorPeriod=10 means that SiteScope gets the average values
of metrics for the last 10 minutes.
HP SiteScope (11.23)
Page 50 of 926
Chapter 6: Apache Server Monitor
Use the Apache Server monitor to monitor the content of server administration pages for Apache
servers. You can monitor multiple parameters or counters with a single monitor instance. This
enables you to watch server loading for performance, availability, and capacity planning. Create a
separate monitor instance for each Apache server you are running.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Apache Server monitor.
Learn About
Supported Platforms/Versions
This monitor supports monitoring remote servers running on Apache 1.3.9, 1.3.12, 2.0 and 2.2
servers.
Tasks
How to Configure the Apache Server Monitor
1. Prerequisites
Before you can use the Apache Server monitor, you must do the following:
n
Configure the Apache server you want to monitor so that status reports (server-status) are
enabled for the server. The steps needed to do this may vary depending on the version of
Apache you are using.
n
Enable extended status (ExtendedStatus On) in the configuration file.
n
Know the URL of the server statistics page for the server you want to monitor.
n
Know the user name and password for accessing the counters of the Apache server you
want to monitor, if required.
n
If using a proxy server to access the server, get the domain name and port of an HTTP
Proxy Server from your network administrator.
n
The SiteScope Apache Server monitor currently supports the server status page available at
http://<server_address>:<port>/server-status?auto. The port is normally port 80,
although this may vary depending on the server set up and your environment. For some
Apache server configurations, you may need to use the server name rather than an IP
address to access the server statistics page.
2. Configure the monitor properties
HP SiteScope (11.23)
Page 51 of 926
Monitor Reference
Chapter 6: Apache Server Monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Apache Server Monitor Settings
User interface elements are described below:
UI Element
Description
Server Settings
Administration Server URL you want to verify with this monitor. This should be the Apache
URL
server statistics URL which usually has the form of
http://<servername>:<port>/server-status?auto.
Operating
System
Operating system that the Apache server is running on. This is used to
correctly read server statistics from Apache based on the operating system
platform.
Default value: UNIX
Counter Settings
Counters
Server performance counters to check with this monitor. The list displays the
available counters and those currently selected for this monitor.
For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Connection Settings
Authorization
user name
User name if the server you want to monitor requires a name and password for
access.
Authorization
password
Password if the server you want to monitor requires a name and password for
access.
HTTP Proxy
Domain name and port of an HTTP Proxy Server if required by the proxy
server is to access the server.
Proxy user
name
Proxy server user name if required to access the server.
Proxy
password
Proxy server password if required to access the server.
HP SiteScope (11.23)
Note: Your proxy server must support Proxy-Authenticate for these options to
function.
Note: Your proxy server must support Proxy-Authenticate for these options to
function.
Page 52 of 926
Monitor Reference
Chapter 6: Apache Server Monitor
UI Element
Description
Timeout
(seconds)
Number of seconds that the monitor should wait for a response from the server
before timing-out. Once this time period passes, the monitor logs an error and
reports an error status.
Default value: 60 seconds
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Counters for server-status?auto
Counters for server-status?refresh=30
l
Total Accesses
l
Server Version
l
Total kBytes
l
Server Built
l
CPULoad
l
Current Time
l
Uptime
l
Restart Time
l
ReqPerSec
l
Parent Server Generation
l
BytesPerSec
l
Server uptime
l
BytesPerReq
l
Total accesses
l
BusyWorkers
l
Total Traffic
l
IdleWorkers
l
CPU Usage
l
CPU load
l
requests/sec
l
B/second
l
B/request
l
requests currently being processed
l
idle workers
HP SiteScope (11.23)
Page 53 of 926
Chapter 7: BroadVision Application Server
Monitor
Use the BroadVision Application Server monitor to monitor the server performance data for
BroadVision servers. You can monitor multiple parameters or counters with a single monitor
instance. This enables you to watch server loading for performance, availability, and capacity
planning. Create a separate monitor instance for each BroadVision server in your environment. The
error and warning thresholds for the monitor can be set on one or more BroadVision server
performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the BroadVision Application monitor.
Learn About
Supported Platforms/Versions
This monitor supports monitoring remote servers running on BroadVision 4.1, 5.x, and 6.0 servers.
Tasks
How to Configure the BroadVision Application Server Monitor
1. Prerequisites
n
You must know the Object Request Broker (ORB) port number for the BroadVision server
you are trying to monitor.
n
In a BroadVision Production-style environment where there is one primary root server and
other secondary servers (for example, Interaction Manager node) on different machines, you
can only define a monitor against the primary root node. Metrics for the other nodes in the
configuration are available for selection during root node monitor definition. In other words,
monitoring is always accomplished through the primary root node, for all servers.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 54 of 926
Monitor Reference
Chapter 7: BroadVision Application Server Monitor
UI Descriptions
BroadVision Application Server Monitor Settings
User interface elements are described below:
UI
Element
Description
Main Settings
Server
BroadVision root server name of the BroadVision server you want to monitor. For
example, 199.123.45.678.
Port
ORB port number to the BroadVision server you want to monitor.
Example: 1221
Counter Settings
Counters Server performance counters selected for this monitor. Use the Get Counters
button to select counters.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 55 of 926
Monitor Reference
Chapter 7: BroadVision Application Server Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
BV_SRV_CTRL
• BVLOG
• SHUTDOWN
BV_SRV_STAT
• CPU
• IDL
• LWP
• RSS
• STIME
• SYS
• USR
• VSZ
NS_STAT
• BIND
• LIST
• NEW
• REBND
• RSOLV
• UNBND
BV_DB_STAT
• DELETE
• INSERT
• SELECT
• SPROC
• UPDATE
BV_CACHE_STAT
• BV_GDBQUERY_CACHE-HIT
• BV_GDBQUERY_CACHEMAX
• BV_GDBQUERY_CACHEMISS
• BV_GDBQUERY_CACHESIZE
• BV_GDBQUERY_CACHESWAP
• BV_QUERY_CACHE-HIT
• BV_QUERY_CACHE-MAX
• BV_QUERY_CACHE-MISS
• BV_QUERY_CACHE-SIZE
• BV_QUERY_CACHE-SWAP
HP SiteScope (11.23)
• CNT-AD-HIT
• CNT-AD-MAX
• CNT-AD-MISS
• CNT-AD-SIZE
• CNT-AD-SWAP
• CNT-ALERTSCHED-HIT
• CNT-ALERTSCHED-MAX
• CNT-ALERTSCHED-MISS
• CNT-ALERTSCHED-SIZE
• CNT-ALERTSCHED-SWAP
• CNT-CATEGORY_CONTENT-HIT
• CNT-CATEGORY_CONTENTMAX
• CNT-CATEGORY_CONTENTMISS
• CNT-CATEGORY_CONTENTSIZE
• CNT-CATEGORY_CONTENTSWAP
• CNT-DF_GROUP-HIT
• CNT-DF_GROUP-MAX
• CNT-DF_GROUP-MISS
• CNT-DF_GROUP-SIZE
• CNT-DF_GROUP-SWAP
• CNT-DF_MESSAGE-HIT
• CNT-DF_MESSAGE-MAX
• CNT-DF_MESSAGE-MISS
• CNT-DF_MESSAGE-SIZE
• CNT-DF_MESSAGE-SWAP
• CNT-EDITORIAL-HIT
• CNT-EDITORIAL-MAX
• CNT-EDITORIAL-MISS
• CNT-EDITORIAL-SIZE
• CNT-EDITORIAL-SWAP
• CNT-EXT_FIN_PRODUCT-HIT
• CNT-EXT_FIN_PRODUCT-MAX
• CNT-EXT_FIN_PRODUCT-MISS
• CNT-EXT_FIN_PRODUCT-SIZE
• CNT-EXT_FIN_PRODUCT-SWAP
• CNT-INCENTIVE-HIT
• CNT-INCENTIVE-MAX
• CNT-INCENTIVE-MISS
• CNT-INCENTIVE-SIZE
• CNT-INCENTIVE-SWAP
• CNT-MSGSCHED-HIT
• CNT-MSGSCHED-MAX
• CNT-MSGSCHED-MISS
• CNT-MSGSCHED-SIZE
• CNT-MSGSCHEDSWAP
• CNT-MSGSCRIPT-HIT
• CNT-MSGSCRIPT-MAX
• CNT-MSGSCRIPTMISS
• CNT-MSGSCRIPT-SIZE
• CNT-MSGSCRIPTSWAP
• CNT-PRODUCT-HIT
• CNT-PRODUCT-MAX
• CNT-PRODUCT-MISS
• CNT-PRODUCT-SIZE
• CNT-PRODUCT-SWAP
• CNT-QUERY-HIT
• CNT-QUERY-MAX
• CNT-QUERY-MISS
• CNT-QUERY-SIZE
• CNT-QUERY-SWAP
• CNT-SCRIPT-HIT
• CNT-SCRIPT-MAX
• CNT-SCRIPT-MISS
• CNT-SCRIPT-SIZE
• CNT-SCRIPT-SWAP
• CNT-SECURITIES-HIT
• CNT-SECURITIES-MAX
• CNT-SECURITIESMISS
• CNT-SECURITIES-SIZE
• CNT-SECURITIESSWAP
• CNT-TEMPLATE-HIT
• CNT-TEMPLATE-MAX
• CNT-TEMPLATE-MISS
Page 56 of 926
Monitor Reference
Chapter 7: BroadVision Application Server Monitor
• CNT-TEMPLATE-SIZE
• CNT-TEMPLATE-SWAP
• PARENTCATEGORY
CACHE-HIT
• PARENTCATEGORY
CACHE-MAX
• PARENTCATEGORY
CACHE-MISS
• PARENTCATEGORY
CACHE-SIZE
• PARENTCATEGORY
CACHE-SWAP
JS_SCRIPT_CTRL
• CACHE
• DUMP
• FLUSH
• METER
• TRACE
BV_SMGR_STAT
• CGI
• CONN
• IdlQ
• JOB
• MODE
• Q_0
• Q_1
• Q_10
• Q_11
• Q_12
• Q_13
• Q_14
• Q_15
• Q_2
• Q_3
• Q_4
• Q_5
• Q_6
• Q_7
• Q_8
• Q_9
• SESS
• THR
JS_SCRIPT_STAT
• ALLOC
• CTX
• ERROR
• FAIL
• JSPPERR
• RELEASE
• STOP
• SUCC
• SYNTAX
BV_SMGR_QOS
• ADMIN_CT
• DEF_P
• NEW_P
• P_WEIGHT
• REWARD_P1
• REWARD_P2
• REWARD_P3
• REWARD_P4
• REWARD_P5
BV_SMGR_CTRL
• DRAIN
Tips/Troubleshooting
General Tips/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 57 of 926
Chapter 8: Browsable Windows Performance
Counter Monitor
Use the Browsable Windows Performance Counter monitor to monitor the values of Windows
performance statistics. Each time the Browsable Windows Performance Counter monitor runs, it
returns readings and a status message and writes them in the monitoring log file. The status is
displayed in the group detail table for the monitor which represents the current value returned by this
monitor. The status is logged as either OK or warning. A count of the number of counters that could
not be read is also kept, and error conditions can be created depending on this count.
Note: The Browsable Windows Performance Counter monitor can only be added by deploying
an Microsoft Exchange solution template, which requires additional licensing to enable it in the
SiteScope interface. Contact your HP sales representative for more information about solution
licensing.
To access
Select the Templates context. In the template tree, expand the Solution Templates container.
Right-click the required Microsoft Exchange Solution Template, and select Deploy Template.
Select the SiteScope group container into which you want to deploy the solution template, and enter
the deployment values.
Tasks
How to Configure the Browsable Windows Performance Counter monitor
1. Prerequisites
The Browsable Windows Performance Counter monitor can only be added by deploying an
Microsoft Exchange solution template, which requires additional licensing to enable it in the
SiteScope interface. Contact your HP sales representative for more information about solution
licensing.
2. Deploy the monitor using the Microsoft Exchange Solution Template
For details on using templates to deploy monitors, see Deploying a SiteScope Solution
Template in the Using SiteScope Guide.
For details on the Microsoft Exchange solution template, see Microsoft Exchange Solution
Templates in the Using SiteScope Guide.
3. Configure the monitor properties
After the monitor has been created, you can edit the monitor configuration in the same way as
other monitors.
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 58 of 926
Monitor Reference
Chapter 8: Browsable Windows Performance Counter Monitor
UI Descriptions
Browsable Windows Performance Counter Monitor Settings
User interface elements are described below:
UI
Element
Description
Server
Server where the performance counters you want to monitor are found.
Note: After deployment, you can use the drop-down list to select a server from the
list of Microsoft Windows remote servers that are available to SiteScope.
Note when working in template mode: You can use the template remote server (if
one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Counter
file
File that contains a list of counters from which to choose to monitor. Use the dropdown list to select a server from the list of remote servers that are available to
SiteScope.
The files in this list all reside in the <SiteScope
root directory>\templates.perfmon\
browsable directory under SiteScope. There are a number of default files in the
standard SiteScope distribution.
Counters Server performance counters you want to check with this monitor. Use the Get
Counters button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters dialog box, enabling you to select the counters you want
Counters to monitor.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 59 of 926
Monitor Reference
Chapter 8: Browsable Windows Performance Counter Monitor
Tips/Troubleshooting
General Tips/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 60 of 926
Chapter 9: Check Point Monitor
Use the Check Point monitor to monitor the content of event logs and other data from Check Point
Firewall-1 4.1 NG servers. You can monitor multiple parameters or counters with a single monitor
instance. This enables you to watch server loading for performance, availability, and capacity
planning. Create a separate Check Point monitor instance for each Check Point Firewall-1 server in
your environment. The error and warning thresholds for the monitor can be set on one or more
firewall statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Check Point monitor.
Tasks
How to Configure the Check Point monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Check Point Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
Index
Index of the SNMP object you want to check with this monitor. Non-table object
IDs have an index of 0 (zero).
Default value: 0
Community Community name of the Check Point Firewall-1 you want to monitor. You may
need to consult with your network administrators about what community names
are active in your network environment.
Default value: public
Host
Host name or IP address of the Check Point Firewall-1 server you want to
monitor. If the Check Point Firewall is configured to respond to SNMP on a port
number other than the default port (161), enter the port number as part of the
server address.
Retry delay
(seconds)
Number of seconds that the monitor should wait for a response from the server
before retrying the request.
Default value: 1 second
HP SiteScope (11.23)
Page 61 of 926
Monitor Reference
Chapter 9: Check Point Monitor
UI Element
Description
Timeout
(seconds)
Number of seconds that the monitor should wait for a response from the server
before timing out. Once this time period passes, the monitor logs an error and
reports an error status.
Default value: 5 seconds
Counter Settings
<List of
counters>
Displays the available server performance counters and those currently selected
for this monitor. For the list of counters that can be configured for this monitor, see
"Monitor Counters" below.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Dropped
• Logged
• Major
• Minor
• ModuleState
• PointEvent
• Product
• Rejected
HP SiteScope (11.23)
Page 62 of 926
Chapter 10: Cisco Works Monitor
Use the Cisco Works monitor to monitor the content of event logs and other data from Cisco Works
servers. You can monitor multiple parameters or counters with a single monitor instance. This
enables you to watch server loading for performance, availability, and capacity planning. Create a
separate Cisco Works monitor instance for each Cisco Works server in your environment. The error
and warning thresholds for the monitor can be set on one or more Cisco Works server statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Cisco Works monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
Supported Platforms/Versions
This monitor supports monitoring Cisco Works 2000 servers and later.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the SNMP protocol.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Cisco Works Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The SNMP Browser Tool is available when configuring this monitor to verify the
connection properties of an SNMP agent and to gain more information about the MIBs which
that agent implements (provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions). To use the tool when configuring or editing a monitor, click the
Use Tool button. For details on the tool, see SNMP Browser Tool in the Using SiteScope
Guide.
HP SiteScope (11.23)
Page 63 of 926
Monitor Reference
Chapter 10: Cisco Works Monitor
UI Descriptions
Cisco Works Monitor Settings
User interface elements are described below:
UI Element
Description
SNMP Settings
Server
Name of the server you want to monitor.
Port
Port to use when requesting data from the SNMP agent.
Default value: 161
MIB file
MIB file display option.
l
CISCOWORKS-MIB file causes only those objects that are described
within that MIB file to be displayed.
l
All MIBs causes all objects discovered on the given Cisco Works server to
be displayed when browsing counters.
If no MIB information is available for an object, it is still displayed, but with no
textual name or description.
Default value: All MIBs
Counter
calculation
mode
Performs a calculation on objects of type Counter, Counter32, or Counter64.
The available calculations are:
l
Calculate delta. Calculates a simple delta of the current value from the
previous value.
l
Calculate rate. Calculates a rate calculation using the delta of current
value from previous value, divided by the time elapsed between
measurements.
l
Do not calculate. No calculation is performed.
Note: This option only applies to the aforementioned object types. A Cisco
Works monitor that monitors Counter objects as well as DisplayString objects
only performs this calculation on the Counter objects.
HP SiteScope (11.23)
Page 64 of 926
Monitor Reference
Chapter 10: Cisco Works Monitor
UI Element
Description
Starting OID
Use when selecting counters for this monitor. When the monitor attempts to
retrieve the SNMP agent's tree, it starts with the OID value that is entered
here.
You can edit this box only when attempting to retrieve values from an
application that does not handle OIDs starting with 1. If the default value of 1
did not enable retrieving any counters, then you may have to enter a different
value.
Default value: 1
Note: This field is available in template mode only.
SNMP Connection Settings
Timeout
(seconds)
Amount of time, in seconds, that SiteScope should wait for all SNMP requests
(including retries) to complete.
Default value: 5
Number of
retries
Number of times each SNMP GET request should be retried before SiteScope
considers the request to have failed.
Default value: 1
Community
Community name of the Cisco Works Server you want to monitor (valid only
for version 1 or 2 connections). You may need to consult with your network
administrators about what community names are active in your network
environment.
Default value: public
SNMP version
Version of SNMP to use when connecting. Supports SNMP version 1, 2, and
3. Selecting V3 enables you to enter V3 settings in the SNMP V3 setting fields
below.
Default value: V1
Authentication Authentication algorithm to use for version 3 connections.
algorithm
Default value: MD5
Note: This field is available only if SNMP V3 is selected.
User name
User name for version 3 connections.
Note: This field is available only if SNMP V3 is selected.
Password
Authentication password to use for version 3 connections.
Note: This field is available only if SNMP V3 is selected.
HP SiteScope (11.23)
Page 65 of 926
Monitor Reference
Chapter 10: Cisco Works Monitor
UI Element
Description
Privacy
algorithm
The privacy algorithm used for authentication for SNMP version 3 (DES,128Bit AES,192-Bit AES, 256-Bit AES).
Default value: DES
Note: This field is available only if SNMP V3 is selected.
Privacy
password
Privacy password for version 3 connections. Leave blank if you do not want
privacy.
Note: This field is available only if SNMP V3 is selected.
Context name
Context Name to use for this connection. This is applicable for SNMP V3 only.
Note: This field is available only if SNMP V3 is selected.
Context
engine ID
Hexadecimal string representing the Context Engine ID to use for this
connection. This is applicable for SNMP V3 only.
Note: This field is available only if SNMP V3 is selected.
SNMP Counters
Counters
Displays the server performance counters you want to check with this monitor.
Use the Get Counters button to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you
want to monitor. For the list of counters that can be configured for this monitor,
see "Monitor Counters" on the next page.
Note:
l
The counters displayed are those received during the timeout period, and
may not include all the counters available on the server. Specifying a longer
timeout in the Timeout (seconds) field in the SNMP Connection Settings
panel may result in receiving more counters.
l
The total time for receiving the counters may be longer than the timeout
specified, due to additional processing time not part of the
request/response period.
Note when working in template mode: The maximum number of counters
that you can select is 100. If you import a template monitor from an earlier
version of SiteScope, or perform a copy to template action, the number of
counters is not limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 66 of 926
Monitor Reference
Chapter 10: Cisco Works Monitor
Monitor Counters
SNMP data including the following categories and all of their metrics:
• applConformance
• applTable
• assocTable
• at
• egp
• egpNeighTable
• host
• icmp
• interfaces
• ip
• rdbmsConformance
• rdbmsObjects
• snmp
• system
• tcp
• udp
Tips/Troubleshooting
General Tips/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 67 of 926
Chapter 11: Citrix Monitor
Use the Citrix monitor to monitor the server performance statistics from Citrix servers. You can
monitor multiple parameters or counters with a single monitor instance. This enables you to watch
server loading for performance, availability, and capacity planning.
Create a separate Citrix monitor instance for each Citrix server in your environment. The error and
warning thresholds for the monitor can be set on one or more Citrix server performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Citrix monitor.
Learn About
This section includes:
l
"What to Monitor" below
l
"Supported Versions/Platforms" below
l
"IPv6 Addressing Supported Protocols" on the next page
What to Monitor
The Citrix monitor makes use of performance objects and counters to measure application server
performance. The Citrix monitor keeps track of the following performance objects:
l
Citrix IMA Networking
l
Citrix Presentation Server (Citrix MetaFrame XP)
l
ICA Session
l
Terminal Services Session
You can find information about the Citrix performance objects and their counters in Appendix C of
the Presentation Server 4.0 Administrator's Guide (http://support.citrix.com/article/CTX106319),
and about the Terminal Services Session Object at http://msdn.microsoft.com/enus/library/ms804500.aspx.
Supported Versions/Platforms
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on:
HP SiteScope (11.23)
Page 68 of 926
Monitor Reference
Chapter 11: Citrix Monitor
l
n
Citrix MetaFrame 1.8 Service Pack 3
n
Citrix MetaFrame XP(s,a,e) Feature Release 1/Service Pack 1
n
Citrix MetaFrame XP(s,a,e) Feature Release 2/Service Pack 2
n
Citrix Presentation Server 3.5, 4.x
n
Citrix XenApp 4.6, 5.0, 6.0
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Citrix Monitor
1. Prerequisites
The following are important requirements for using the Citrix monitor:
n
SiteScopes running on Windows platforms need to be running under an account that has the
necessary administrative security privileges to access performance counter data from
remote servers. If the servers you want to monitor are in a different domain, are governed
under a different policy, or require a unique login different than the account SiteScope is
HP SiteScope (11.23)
Page 69 of 926
Monitor Reference
Chapter 11: Citrix Monitor
running under, then you must define the connection to these servers under the Microsoft
Windows Remote Servers option in the remote server view. For SiteScopes installed on
UNIX platforms, you only need to define the connection to these servers under the Microsoft
Windows Remote Servers option in the remote server view.
n
The Citrix Resource Manager must be available, installed, and running on the Citrix servers
you want to monitor.
n
One or more Citrix vusers must have established a connection with the Citrix server to
enable viewing of ICA Session object.
n
The Citrix monitor requires the same permissions (trust level between monitoring and
monitored machines) in Windows 2003 as Microsoft Windows Resources monitor. For
details, see "Configuring the Monitor to Run on Windows 2003 as a Non-Administrator
User" on page 476.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Citrix Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Server where the Citrix server you want to monitor is running. Select a server from
the server list (only those Windows remote servers that have been configured in
SiteScope are displayed). Alternatively, click the Browse Servers button to select a
server from the local domain, or Add Remote Server to add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed in the server list. For details, see Configure the WMI Service for
Remote Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
HP SiteScope (11.23)
Page 70 of 926
Monitor Reference
Chapter 11: Citrix Monitor
UI
Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
Counters The server performance counters selected for this monitor. Use the Get Counters
button to select counters.
For information about the Citrix performance counters, see Appendix C of the
MetaFrame Presentation Server 4.0 Administrator's Guide
(http://support.citrix.com/article/CTX106319).
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 71 of 926
Monitor Reference
Chapter 11: Citrix Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
TerminaI Services
• Total Sessions
• Active Sessions
• Inactive Sessions
Terminal Services
Session
Console
• % Processor Time
• % User Time
• % Privileged Time
• Virtual Bytes Peak
• Virtual Bytes
• Page Faults/sec
• Working Set Peak
• Working Set
• Page File Bytes Peak
• Page File Bytes
• Private Bytes
• Thread Count
• Pool Paged Bytes
• Pool Nonpaged Bytes
• Handle Count
• InputWdBytes
• Input WdFrames
• Input WaitForOutBuf
• Input Frames
• Input Bytes
• Input Compressed Bytes
• Input Compress Flushes
• Input Errors
• Input Timeouts
• Input Async Frame Error
• Input Async Overrun
• Input Async Overflow
• Input Async Parity Error
• Input Transport Errors
• Output WdBytes
• OutputWdFrames
• Output WaitForOutBuf
• Output Frames
• Output Bytes
• Output Compressed
Bytes
• Output Compress
Flushes
• Output Errors
• Output Timeouts
• Output Async Frame
Error
• Output Async Overrun
• Output Async Overflow
• Output Async Parity
Error
• Output Transport Errors
• Total WdBytes
• Total WdFrames
• Total WaitForOutBuf
• Total Frames
• Total Bytes
• Total Compressed Bytes
• Total Compress Flushes
• Total Errors
• Total Timeouts
• Total Async Frame Error
• Total Async Overrun
• Total Async Overflow
• Total Async Parity Error
• Total Transport Errors
• Total Protocol Cache Reads
• Total Protocol Cache Hits
• Total Protocol Cache Hit Ratio
• Protocol Bitmap Cache Reads
• Protocol Bitmap Cache Hits
• Protocol Bitmap Cache Hit Ratio
• Protocol Glyph Cache Reads
• Protocol Glyph Cache Hits
• Protocol Glyph Cache Hit Ratio
• Protocol Brush Cache Reads
• Protocol Brush Cache Hits
• Protocol Brush Cache Hit Ratio
• Protocol Save Screen Bitmap Cache
Reads
• Protocol Save Screen Bitmap Cache
Hits
• Protocol Save Screen Cache Hit Ratio
• Input Compression Ratio
• Output Compression Ratio
• Total Compression Ratio
Tips/Troubleshooting
General Tips/Limitations
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 72 of 926
Chapter 12: ColdFusion Server Monitor
Use the ColdFusion Server monitor to monitor the server performance statistics from ColdFusion
servers. You can monitor multiple parameters or counters with a single monitor instance. This
enables you to watch server loading for performance, availability, and capacity planning. Create a
separate ColdFusion Server monitor instance for each ColdFusion server in your environment. The
error and warning thresholds for the monitor can be set on one or more ColdFusion server
performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the ColdFusion Server monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
Supported Platforms/Versions
l
This monitor supports monitoring ColdFusion 4.5.x and 9 servers.
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
HP SiteScope (11.23)
Page 73 of 926
Monitor Reference
Chapter 12: ColdFusion Server Monitor
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the ColdFusion Server Monitor
1. Prerequisites
SiteScopes running on Windows platforms need to be running under an account that has the
necessary administrative security privileges to access performance counter data from remote
servers. If the servers you want to monitor are in a different domain, are governed under a
different policy, or require a unique login different than the account SiteScope is running under,
then you must define the connection to these servers under the Microsoft Windows Remote
Servers option in the remote server view. For SiteScopes installed on UNIX platforms, you
only need to define the connection to these servers under the Microsoft Windows Remote
Servers option in the remote server view.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 74 of 926
Monitor Reference
Chapter 12: ColdFusion Server Monitor
UI Descriptions
ColdFusion Server Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Server where the ColdFusion Server you want to monitor is running. Select a server
from the server list (only those Windows remote servers that have been configured in
SiteScope are displayed). Alternatively, click the Browse Servers button to select a
server from the local domain, or Add Remote Server to add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed in the server list. For details, see Configure the WMI Service for
Remote Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 75 of 926
Monitor Reference
Chapter 12: ColdFusion Server Monitor
UI
Element
Description
Counters Server performance counters selected for this monitor. Use the Get Counters
button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" below.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Avg DB Time (msec)
• Avg Queue Time (msec)
• Avg Req Time (msec)
• Bytes In / Sec
• Bytes Out / Sec
• Cache Pops / Sec
• DB Hits / Sec
• Page Hits / Sec
• Queued Requests
• Running Requests
• Timed Out Requests
Tips/Troubleshooting
General Tips/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 76 of 926
Chapter 13: COM+ Server Monitor
Use the COM+ Server monitor to monitor the performance of COM+ software components
registered and running on Microsoft Windows Servers. When you specify the host and port number
of this probe instance, SiteScope retrieves all the functions running on the COM+ server for your
monitoring selection. Error and warning thresholds for the monitor can be set on one or more
function measurements.
Note: The COM+ Server monitor is an optional SiteScope monitor that requires additional
licensing to enable it in the SiteScope interface after the free trial period expires. Contact your
HP sales representative for more information.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the COM+ monitor.
Learn About
Supported Platforms/Versions
This monitor supports monitoring COM+ software components running on Microsoft Windows
Server 2003, 2008, and 2008 R2 servers.
Tasks
How to Configure the COM+ Monitor
1. Prerequisites
n
An Option license for the COM+ Server monitor must be obtained and input into SiteScope.
Contact your HP sales representative for more information.
n
There must be HTTP connectivity between the SiteScope server and the server running the
COM+ probe.
2. Install the COM+ probe
A COM+ probe component must be installed and running on the target COM+ server you want
to monitor.
a. Go to the HP Software Support site (http://www.hp.com/go/hpsoftwaresupport) and click
the Downloads tab. Then click Software patches, and enter your HP user name and
password to access the Software Patches page.
b. In the optional search box, enter COM+ and click Search.
c. Download the COM+ probe from the results.
HP SiteScope (11.23)
Page 77 of 926
Monitor Reference
Chapter 13: COM+ Server Monitor
d. After downloading, follow the instructions for installing the probe on the COM+ server to be
monitored.
Note: You cannot have multiple SiteScope instances share one probe instance. You
can have multiple COM+ Server monitors within a single SiteScope installation
access the same probe instance (uniquely identified by the probe host and port). The
probe cannot serve data to multiple SiteScope installations.
3. Start the COM+ probe
After successfully installing the probe, you must start it prior to running or defining a COM+
Server monitor, by invoking mon_cplus_probe.exe found in the COM+ probe's bin directory.
By default, the installation creates this file at C:\Program Files\Mercury
Interactive\COMPlusMonitor\bin\.
4. Configure the monitor properties
Create a COM+ Server monitor, and specify the COM+ probe for the target COM+ server. The
COM+ probe is queried for a list of available functions to monitor, and a browse tree is
displayed. Select the COM+ functions or counters that you want to measure.
Configure the other COM+ Server monitor fields as described in the UI Descriptions section
below.
UI Descriptions
COM+ Monitor Settings
User interface elements are described below:
UI Element
Description
COM+
probe host
name
Host name of the COM+ probe.
COM+
probe port
number
Port number of the COM+ probe.
Default value: 8008
HP SiteScope (11.23)
Page 78 of 926
Monitor Reference
Chapter 13: COM+ Server Monitor
UI Element
Description
Credentials Option for providing the user name and password authorization to the COM+
probe:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password in the User name and
Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default option).
Select the credential profile to use from the Credential profile drop-down list,
or click Add Credentials and create a new credential profile. For details on
how to perform this task, see How to Configure Credential Preferences in the
Using SiteScope Guide.
HTTP
proxy
Domain name and port of an HTTP proxy server if a proxy server is used to
access the probe.
Proxy
server user
name
Proxy user name if the proxy server requires a name and password to access the
probe. Your proxy server must support Proxy-Authenticate for these options to
function.
Proxy
server
password
Proxy password if the proxy server requires a name and password to access the
probe.
Timeout
(seconds)
Number of seconds that the monitor should wait for a response from the server
before timing-out. Once this time period passes, the monitor logs an error and
reports an error status.
Default value: 60 seconds
Note: Depending on the activity on the server, the time to build the server monitor
statistics Web page may take more than 15 seconds. You can test the monitor
with a timeout value of more than 60 seconds to enable the server to build and
serve the server monitor statistics Web page before the SiteScope monitor is
scheduled to run again.
Counters
Server performance counters selected for this monitor. Use the Get Counters
button to select counters.
Get
Counters
Opens the Select Counters Form, enabling you to select the counters you want to
monitor. For the list of counters that can be configured for this monitor, see
"Monitor Counters" on the next page.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
HP SiteScope (11.23)
Page 79 of 926
Monitor Reference
Chapter 13: COM+ Server Monitor
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Application Level
• Activation
• Authenticate
• Authenticate Failed
• Shutdown
• Thread Start
• Thread Terminate
• Work Enque
• Work Reject
Transaction Level
• Transaction Aborted
• Transaction Commit
• Transaction Duration
• Transaction Prepared
• Transaction Start
Object Level (per object)
• Disable Commit
• Enable Commit
• Object Activate
• Object Create
• Object Deactivate
• Object Destroy
• Object LifeTime
• Set Abort
• Set Complete
Tips/Troubleshooting
General Tips/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 80 of 926
Chapter 14: Composite Monitor
This monitor enables you to monitor complex network environments by checking the status
readings of a set of other SiteScope monitors, groups, or both. Each time the Composite monitor
runs, it returns a status based on the number and percentage of items in the specified monitors,
groups, or both, currently reporting an error, warning, or OK status. It writes the percentages
reported in the monitoring log file.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Composite monitor.
Learn About
What to Monitor
Use this monitor is if you want to create complex monitor alert logic. For example, if you want to
trigger an alert when:
l
Five or more monitors in a group of eight are in error
l
Three or more groups have monitors with errors in them
l
You have two monitors, and exactly one is in error
Then you could create a Composite monitor that went into error on these conditions, and then add
alerts on the Composite monitor to take the desired actions.
If you need alert logic that is more complex than SiteScope's standard alerts permit, you can use
the Composite monitor to create customized alert behavior.
Tasks
How to Configure the Composite Monitor
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 81 of 926
Monitor Reference
Chapter 14: Composite Monitor
UI Descriptions
Composite Monitor Settings
User interface elements are described below:
UI
Element
Items
Description
Click the Add
button to open the Add Items dialog box, and select the groups,
monitors, or both, that you want in the Composite monitor. For details on the Add
Items dialog box, see "Add Items Dialog Box" on the next page. The Add Items
dialog box displays all the monitors that are part of the same SiteScope.
To remove items from the list, select the groups, monitors, or both, you want to
remove (you can select multiple items using the CTRL or SHIFT keys), and click the
Delete
button.
Note when working in template mode:
Run
monitors
l
The monitors that you add to the Composite monitor are placeholders. They
become real monitors when you deploy the Composite monitor.
l
If you add the Composite monitor to a template, group, or subgroup, when you
click the Add Items button, the Add Items dialog box displays only the monitors
that are part of the same template as the new Composite monitor.
The Composite monitor controls the scheduling of the selected monitors, as
opposed to just checking their status readings.
Monitors that are to be run this way should not also be run separately, so edit the
individual monitors, set the Frequency box for that monitor to zero ("0"), and save
the changes. Those monitors then run only when scheduled by the Composite
monitor. This is useful if you want the monitors to run one after another or run at
approximately the same time.
Default value: Not selected
Monitor
Amount of time, in seconds, to wait between running each monitor (if Run monitors
delay
is selected).
(seconds)
This setting is useful if you need to wait for processing to occur on your systems
before running the next monitor.
Default value: 0 seconds
Check all
monitors
in group
(s)
All monitors in the selected groups (and their subgroups) are checked and counted.
Default value: Not selected (each group is checked and counted as a single item
when checking status readings).
HP SiteScope (11.23)
Page 82 of 926
Monitor Reference
Chapter 14: Composite Monitor
Add Items Dialog Box
This dialog box enables you to select the monitors, groups, or both, that you want in the Composite
monitor.
User interface elements are described below:
UI Element
Description
Add
Selected
Items
Click to add the selected groups, monitors, or both, to the Composite monitor.
Represents the SiteScope root directory.
Represents a SiteScope monitor group or subgroup (with enabled monitors/with
no monitors or no enabled monitors).
If a group alert has been set up for the monitor group or subgroup, the alert
symbol is displayed next to the group icon.
Represents a SiteScope monitor (enabled/disabled).
If an alert has been set up for the monitor, the alert symbol is displayed next to
the monitor icon.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Tips/Limitations
l
When using this monitor to monitor a URL monitor in which at least one of the steps uses a
session cookie to send to the server instead of logging in each time, the Composite monitor
saves the context including the cookie. This means that the login information does not need to
be entered again, as the login credentials are sent in a cookie.
l
This monitor cannot be copied to a template. It must be created directly in a template.
HP SiteScope (11.23)
Page 83 of 926
Chapter 15: CPU Monitor
Use the CPU monitor to monitor the percentage of CPU time that is currently being used on the
server. By monitoring CPU usage, you can prevent poor system response times and outages
before they occur.
Whether the servers in your infrastructure are running with a single CPU or with multiple CPUs, you
need to create only one CPU monitor per remote server. If you have multiple CPUs, SiteScope
reports on the average usage for all of them, as well as each individual CPU usage.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the CPU monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"Status" below
l
"IPv6 Addressing Supported Protocols" on the next page
l
"Scheduling the Monitor" on the next page
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH (for details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide).
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
Status
The Status reading is the current value returned by this monitor; for example, 68% used. SiteScope
displays an average for multiple CPU systems. On Windows, this is the average CPU usage
between runs of the monitor. On UNIX, this is the instantaneous CPU when the monitor runs.
The status is logged as either OK or warning. A warning status is returned if the CPU is in use more
than 90% of the time.
HP SiteScope (11.23)
Page 84 of 926
Monitor Reference
Chapter 15: CPU Monitor
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Scheduling the Monitor
In general, the CPU monitor does not need to be run as often as some of the other monitors. If you
do not usually suffer from CPU problems, you can run it less frequently, perhaps every half hour or
so. If you are prone to CPU usage problems, you can run it more frequently. All machines have
short spikes of CPU usage, but the primary thing that you are looking for is high usage on a regular
basis. This indicates that your system is overloaded and that you need to look for a cause.
Tasks
How to Configure the CPU Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Performance Counters Tool is available when configuring this monitor to check
performance counters on a specific machine in a Windows network (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions). To use the tool
when configuring or editing a monitor, click the Use Tool button. For details on the tool, see
Performance Counters Tool in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 85 of 926
Monitor Reference
Chapter 15: CPU Monitor
UI Descriptions
CPU Monitor Settings
User interface elements are described below:
UI
Element Description
Server
Server where the CPU you want to monitor is running. Select a server from the server
list (only those remote servers that have been configured in SiteScope are displayed).
Alternatively, click the Browse Servers button to select a server from the local
domain, or Add Remote Server to add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote Monitoring
in the Using SiteScope Guide.
l
When configuring this monitor on SiteScopes running on UNIX versions, only
remote servers that have been configured with an SSH connection method are
displayed.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers in the local
domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 86 of 926
Monitor Reference
Chapter 15: CPU Monitor
UI
Element Description
Add
Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of remote
you want to add (Windows or UNIX), and enter the configuration details.
For details on the Microsoft Windows Remote Servers user interface, see New/Edit
Microsoft Windows Remote Server Dialog Box in the Using SiteScope Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX Remote
Server Dialog Box in the Using SiteScope Guide.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Tips/Limitations
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
To get a detailed list of processes consuming most CPU resources, create an Email alert using
the WithDiagnostics template. When the monitor reaches the configured threshold, CPU
consumption for each process is sent in the body of the email alert.
Monitor Specific Troubleshooting/Limitations
l
If unable to monitor CPU usage on a Linux installation, check the sysstat package is deployed
on the target Linux system.
l
Getting invalid CPU value error message in <SiteScope root
directory>\logs\RunMonitor.log file when using perfmon monitors on VMware host servers.
Solution: Use the VMWare Performance monitor to measure CPU on VMWare host servers.
l
When you run a CPU Monitor on a server that has no metrics, the calculated metric result that
appears in the SiteScope Dashboard is n/a. If you then select a server that has metrics and run
the monitor again, the calculated metric result remains n/a.
Cause: The CPU Monitor is not a dynamic monitor.
Solution: Create a new calculated metric for the monitor that has metrics and rerun the monitor.
l
Incorrect CPU cores number is given when you run this monitor on an AIX operating system
using multiple cores when CPU utilization is low, and simultaneous multithreading (SMT) is on.
HP SiteScope (11.23)
Page 87 of 926
Monitor Reference
Chapter 15: CPU Monitor
Cause: If SMT is on (it is on by default in AIX), the CPU cores number will be multiplied by 2 or 4
depending on the hardware model and/or partition mode.
Solution: Turn SMT to off.
HP SiteScope (11.23)
Page 88 of 926
Chapter 16: Custom Monitor
The Custom monitor broadens the capabilities of regular SiteScope monitors for tracking the
availability and performance of monitored environments. The Custom monitor enables you to create
your own monitor by developing a script that collects data from an application or a remote machine
using custom Java or JavaScript code. The script then processes the data and creates metrics in
names determined by you. You can use Java code developed by yourself or by a third-party to
process the data.
You can share custom monitors by publishing them to the HP Live Network community, enabling
other SiteScope users to import the monitor template for their own use.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Custom monitor.
Learn About
Custom Monitor Overview
The Custom monitor enables you to develop your own monitor on top of the SiteScope
infrastructure.
Custom monitors enable you to do the following:
l
Create monitors that provide additional metrics not available in existing monitors, and
then process the collected data
You can create your own monitor by developing a script that collects data using custom Java or
JavaScript code, and then processes the data and creates metrics. Each time the Custom
monitor runs, it updates the metrics and returns a status for the metrics defined in the script.
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip).
l
Customize how results are displayed
You can determine how results are displayed. For example, whether result data is displayed in
megabytes or kilobytes.
l
Debug custom monitors offline
You can perform offline debugging of a custom monitor script using a remote debugging server.
This makes the script development process easier, since it enables you to complete the code
and see the debugged data inside the script during the data processing stage. For details, see
"How to Debug a Custom Monitor Offline" on page 96.
HP SiteScope (11.23)
Page 89 of 926
Monitor Reference
Chapter 16: Custom Monitor
After developing the monitor, you can:
l
Define thresholds for new metrics
Because some metrics are defined only during a script run, you cannot define thresholds for
them in advance. After the script has run for the first time and the metrics have been defined,
you can then define thresholds for them. This provides more advanced data processing options
than regular monitors. Note that metrics can change between script runs, for example, where
variables are used in metric names. Thresholds using a metric that does not exist after the
monitor run are removed automatically.
l
Share the monitor with other SiteScope users
After developing the monitor, you can export the monitor to a template, add external jars and/or
classes if the monitor depends on them, and create a content package. The content package
can then be sent to specific users, or shared with other SiteScope users by publishing it to the
SiteScope community on HP Live Network (https://hpln.hp.com/group/sitescope).
By sharing knowledge with other SiteScope users, you can benefit from extended SiteScope
monitor coverage and the development of new monitors outside the SiteScope release cycle.
Tasks
This section includes:
l
"How to Develop a Custom Monitor" below
l
"How to Debug a Custom Monitor Offline" on page 96
l
"How to Access the Monitor Configuration Parameters Exposed in the Script" on page 98
l
"How to Import and Use a Customizable Monitor" on page 99
How to Develop a Custom Monitor
1.
2.
Prerequisites
n
You must be an advanced user SiteScope with knowledge of JavaScript.
n
Knowledge of the application being monitored.
Create a Custom monitor
Create a group into which you want to add the custom monitor. Right-click the group, select
New > Monitor, and select the Custom monitor. In the General Settings panel, enter a name
and description for the monitor.
3.
Create script parameters - optional
You can create a list of parameters that can be repeatedly used in the data processing script.
To do so, enter the parameter name and value in the Script Parameters Table.
HP SiteScope (11.23)
Page 90 of 926
Monitor Reference
Chapter 16: Custom Monitor
For example, you might want to create a host, user name, and password parameter. You can
choose to hide parameter values, such as passwords, behind asterisks (*****) in the user
interface. The hide option is editable when working in template mode only.
For user interface details, see the UI Descriptions section below.
Note: By default, the maximum number of parameters allowed in the table is 10. When the
maximum number of rows is reached, no additional rows can be added. You can modify
this number by changing the Custom monitor maximum number of script parameters
value in Preferences > Infrastructure Preferences > Custom Settings. You must
restart SiteScope if you change this setting.
4.
Create the data processing script
In the Data Processing Script area of Custom Monitor Settings, create the script that parses
the results and creates new metrics according to the name that you determined.
For details on the monitor configuration properties, including how to access them, and the
monitor storage and metrics names, see "How to Access the Monitor Configuration
Parameters Exposed in the Script" on page 98.
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip). A sample jar file showing the
custom monitor's capability to access Java code is provided in the <SiteScope root
directory>\examples\monitors\custom\lib folder.
For details on scripting in Java, see http://www.mozilla.org/rhino/ScriptingJava.html.
Tip:
n
A sample Custom monitor script is provided in the Data Processing Script box. To
use it, you need to uncomment the script.
n
Sample scripts for all the custom monitors are available from the sample content
package located in the <SiteScope installation
directory>\examples\monitors\custom folder. CustomMonitorSamplePackage.zip
contains examples for SiteScope 11.20, and CustomMonitorsExamples_11_21.zip
contains updated examples including a Custom Database monitor with a dynamic
query, a manifest file created using the Export Content Package Wizard, and template
mail and template mail subject files, To use these scripts, you need to import the
custom monitor content package and then deploy the custom monitor template. For
task details, see steps 3 and 4 of "How to Import and Use a Customizable Monitor" on
page 99.
HP SiteScope (11.23)
Page 91 of 926
Monitor Reference
Chapter 16: Custom Monitor
Note:
5.
n
If your monitor needs to open a network connection to another server from the data
processing script or the Java code that is called from the script, you must enable the
Allow network access setting in Preferences > Infrastructure Preferences >
Custom Monitor Settings.
n
Access for the data processing script is restricted to the following folders/files on the
SiteScope server:
o
The \conf folder which is located inside each content package (<SiteScope root
directory>\packages\imported or <SiteScope root
directory>\packages\workspace) (requires Read permissions).
o
<SiteScope root directory>\logs\custom_monitors\* (all permissions)
n
You can use the custom_monitor.log file for any info, warning, error, and debug
messages that you want to write during the execution of the script. The log is located in
<SiteScope root directory>\logs\custom_monitors. For details on changing the log
to DEBUG mode, see "Custom Monitor Logs" on page 104.
n
By default, the number of metrics that are allowed in custom monitors is 1000. You can
modify this number by changing the Maximum number of counters value in
Preferences > Infrastructure Preferences > Custom Monitor Settings.
n
When working in template mode, you can use template variables in a data processing
script.
Generate a path for storing the files used for creating the Custom
monitor
Click the Create Path button to create a folder where the relevant jars, classes, configuration,
and template files required for running the monitor can be saved. A folder with a relative path is
created under <SiteScope root directory>\packages\workspace\package_<Package ID>.
The path is displayed as read only.
The folder contains the following (empty) subfolders:
n
packages\workspace\package_<>\lib. Used for storing external jar files used by the
monitor script.
n
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note
that they should be copied with the entire package folder structure.
n
packages\workspace\package_<>\conf. Used for storing configuration files,
documentation, and XML files.
n
packages\workspace\package_<>\template. Used for storing the template files that
HP SiteScope (11.23)
Page 92 of 926
Monitor Reference
Chapter 16: Custom Monitor
contain the custom monitor (you perform this in "Create a monitor template - optional" on the
next page).
You can copy the required files to these folders at this stage, or when performing "Create a
content package - optional" on the next page.
Note: If you add or modify jars/classes after the first monitor run, you must either:
6.
n
Restart SiteScope for the changes to take effect, or
n
To avoid having to restart SiteScope, you should enable the Reload classes and jars
on each monitor run option in Preferences > Infrastructure Preferences > Custom
Monitor Settings. This option should only be used be during script development, and
should be cleared in the production stages since it impacts performance.
Configure topology reporting - optional
To report monitor and related CI topology data to BSM's RTSM, configure the required topology
reporting settings as described in How to Configure Topology Reporting for a Custom Monitor
in the Using SiteScope Guide.
7.
Configure other settings for the monitor - optional
Configure other settings for the monitor as required. For details, see Common Monitor Settings
in the Using SiteScope Guide.
8.
Save the monitor and wait for the first monitor run
Save the monitor. SiteScope verifies the correctness of the monitor configuration both locally
and on the remote server to be monitored, before saving the settings, regardless of whether
you clicked Verify & Save or Save.
The monitor collects data and filters it based on the script you supplied.
9.
Managing custom monitors
After creating a custom monitor, you can copy, move, or delete the monitor. When doing so,
this affects the content package folder (created in the <SiteScope root
directory>\packages\workspace directory) as follows:
Action
File System Impact
Copy Monitor
Makes a copy of the content package folder in the <SiteScope root
directory>\packages\workspace folder.
Cut Monitor
No change.
HP SiteScope (11.23)
Page 93 of 926
Monitor Reference
Chapter 16: Custom Monitor
10.
Action
File System Impact
Delete Monitor
If you delete the custom monitor, the content package folder is
removed from the <SiteScope root
directory>\packages\workspace folder of the SiteScope file
system.
Deploy template with
custom monitor +
content package
No change.
If a deployed monitor is copied, the content package will be copied
to the <SiteScope root directory>\packages\workspace folder of
the SiteScope file system.
Define thresholds for the metrics - optional
After the monitor has run, you can:
11.
n
Make changes to the script and define thresholds for metrics that were created or updated in
the run. For details, see Threshold Settings in the Using SiteScope Guide.
n
Check status and values of the metrics in the SiteScope Dashboard.
n
Set up alerts on the monitor. For details, see How to Configure an Alert in the Using
SiteScope Guide.
Create a monitor template - optional
a. To copy the monitor to a template, right-click the monitor, select Copy to Template, and
select the template group to which you want to add the copied configuration. For details,
see How to Create a Template by Copying Existing Configurations in the Using SiteScope
Guide.
b. Make any necessary changes such as adding template variables to the template. For
details on template variables, see New Variable Dialog Box.
12.
Create a content package - optional
a. Copy the files used for creating the monitor to the predefined content package subfolders:
o
<SiteScope>\packages\workspace\package_<Package ID>\lib. (Optional) Copy
any external jars used by the custom monitor script to this folder. Java classes from the
jar files can be accessed from the data processing script. Note that you can use this
monitor without external jars.
Note: In the data processing script, to import a package from a jar that does not
start with com., org., or java., you must add the package's prefix:
importPackage(Packages.<packageName>)
For example, importPackage(Packages.it.companyname.test);
HP SiteScope (11.23)
Page 94 of 926
Monitor Reference
Chapter 16: Custom Monitor
For details on importing Java classes and packages, see
http://www.mozilla.org/rhino/ScriptingJava.html.
o
<SiteScope>\packages\workspace\package_<>\classes. (Optional) Copy the
compiled Java classes with the entire package folder structure to this folder; this is not
required if the class files were packaged in a jar that was copied to the \lib folder. The
class files can be accessed from the data processing script.
o
<SiteScope>\packages\workspace\package_<>\conf. (Optional) Copy the
configuration files, documentation, and XML files to this folder.
o
<SiteScope>\packages\workspace\package_<>\template. (Optional) The folder
should contain the template files exported from SiteScope (performed in "Create a
monitor template - optional" on the previous page). Each template can contain various
types of monitors, custom and regular.
b. Copy extension files - optional
If the monitor references script or alert extension files in the SiteScope file system, copy
them to the relevant folders in <SiteScope root
directory>\packages\workspace\extensions>:
o
\scripts. Used for storing script files that are used to run shell commands or other
scripts on the machine where SiteScope is running.
o
\scripts.remote. Used for storing script files that are used for running a script that is
stored on a remote machine.
o
\templates.mail. Used for storing the file containing the format and content of alert
messages sent by email.
o
\templates.mail.subject. Used for storing the file containing the subject line of alert
messages sent by email.
o
\templates.mib. Used for storing the MIB files that are used to create a browsable tree
that contains names and descriptions of the objects found during a traversal.
o
\templates.os. Used for storing the shell commands to be run when monitoring remote
UNIX servers.
Note:
o
On exporting the files to a content package, the unique package ID is added to the
script and template files as a suffix (before the file extension) under the relevant
folder in the SiteScope root directory.
HP SiteScope (11.23)
Page 95 of 926
Monitor Reference
Chapter 16: Custom Monitor
o
As part of the import process, the template.os and templates.mib files are edited
and the unique package ID is added to some properties inside the files.
c. Export the content package to a zip file
Select the Templates context. In the template tree, right-click the template or template
container that you want to export to a content package, and select Export > Content
Package. For details on the Content Import dialog box, see Content Import Dialog Box in
the Using SiteScope Guide.
In the Export Content Package Wizard, enter details of the content package (manifest),
and select the templates and files associated with these templates to include. For Wizard
details, see Export Content Package Wizard.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
Note: The Select Files page of the Wizard displays files from the <SiteScope root
directory>\packages\workspace\package_<Package ID> and <SiteScope root
directory>\packages\workspace\extensions> folders listed above, except for the
\META-INF and \templates folders which are not displayed.
13.
Share the custom monitor with other SiteScope users - optional
You can distribute a content package zip file by:
n
Sending it to individual SiteScope users.
n
Sharing it with other SiteScope users by uploading it to the Community Content for
SiteScope page on HP Live Network (https://hpln.hp.com/group/sitescope). HP Live
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to publish content to the HP Live Network community.
How to Debug a Custom Monitor Offline
This task describes the steps involved in offline debugging of a custom monitor script using a
remote debugging environment. This makes the script development process easier, since it
enables you to complete the code and see the debugged data inside the script during the data
processing stage.
1. Prerequisites
To perform offline debugging, the Eclipse IDE with Web Tools must be installed on a local
machine.
HP SiteScope (11.23)
Page 96 of 926
Monitor Reference
Chapter 16: Custom Monitor
2. In SiteScope, enable the global custom monitor debugging setting in SiteScope Preferences
Select Preferences > Infrastructure Preferences > Custom Monitor Settings, and select
the Enable custom monitor debugging check box.
3. In SiteScope, create a custom monitor with offline debugging enabled
Create a custom monitor. For details, see the previous task.
When configuring the monitor settings, expand Custom Monitor Settings, and under the Data
Processing Script section, select Enable monitor debugging.
Save the monitor.
4. Copy the Custom Monitor Debugging Eclipse project to the debugging environment
The Custom Monitor Debugging Eclipse project is available (in zip format) from:
n
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
n
The Community Content for SiteScope page on the HP Live Network
(https://hpln.hp.com/group/community-content-sitescope).
Note: Make sure you use the correct version of the Custom Monitor Debugging Eclipse
project. SiteScope 11.23 is compatible with version 2.0 of the project (SISProxy2.0.min.js).
5. Import the Custom Monitor Debugging project into Eclipse IDE
a. On the debugging environment, open Eclipse IDE and click Import.
b. Select General > Existing Project into Workspace, and click Next.
c. Select the Custom Monitor Debugging Eclipse project (zip file).
6. Copy the SiteScope Custom Monitor Data Processing Script to the Custom Monitor
Debugging project
a. Copy the content of Data Processing Script from the SiteScope custom monitor to
MonitorScript.js script.
b. Connect to the SiteScope monitor by entering the following in the DebugConfiguration.js
file:
o
host. Name of the SiteScope server.
o
port. Port used by the SiteScope server.
HP SiteScope (11.23)
Page 97 of 926
Monitor Reference
Chapter 16: Custom Monitor
o
username. Username for accessing the SiteScope server.
o
password. Password to access the SiteScope server.
o
monitorPath. Full path to the custom monitor to debug in SiteScope including the
monitor name, separated by “/”. For example, Group1/Group2/Group3/Custom
Monitor Name.
7. Enable the debugger to use external jar files - optional (where the script uses external jar files)
If the monitor script uses external jar files, copy the jar files from <SiteScope root
directory>\packages\workspace\package_<Package ID>\lib to the <JRE installation
path>\lib\ext directory on the debugging environment.
8. Run the debugger
a. In the Eclipse IDE, select Debug Configuration.
b. Select Rhino JavaScript > Custom Monitor Debugging - MonitorScript.js.
c. The debugger connects to SiteScope, and runs the script within the monitor.
SiteScope returns the data to the debugger and then disconnects. This enables the
debugger to simulate the script running the same data.
9. Debug the script
Use Eclipse IDE to debug the script.
How to Access the Monitor Configuration Parameters Exposed in the
Script
Data Processing Script:
l
You can access the configuration parameters for custom monitors in the data processing script
using:
myContext.getInputData().getConfigurationParameter("<configuration parameter name>");
Example:
var monitorName = myContext.getInputData().getConfigurationParameter("monitorName");
The following monitor properties are exposed to the script (for all custom monitors):
n
monitorName.
The name of the monitor.
n
monitorDescription. A description of the monitor.
The following monitor properties are exposed to the script for the Custom Database monitor
HP SiteScope (11.23)
Page 98 of 926
Monitor Reference
Chapter 16: Custom Monitor
only:
dbConnectionUrl.
n
The connection URL of the database to which you want to connect.
l
No additional properties are exposed for the Custom Monitor.
l
You can set the summary string which is used as the monitor status in the SiteScope
Dashboard using:
myContext.getScriptResult().setSummary("<text summary>");
The default value is: summary = <a set of metrics and their values>
l
You can set monitor availability which is displayed in the SiteScope Dashboard using:
myContext.getScriptResult().setAvailability(<true/false>)
The default value is: availability = true
Topology Script:
You can access the configuration parameters for custom monitors in the topology script using:
Framework.getDestinationAttributeAsObject("configuration").get("<configuration parameter
name>")
To access data saved in the monitor storage (this is a place where you can save script data for use
in future executions):
Framework.getDestinationAttributeAsObject("monitorStorage").get("<configuration parameter
name>")
To access the list of metric names used in the script:
Framework.getDestinationAttributeAsObject("metrics")
How to Import and Use a Customizable Monitor
After developing a custom monitor and creating a content package zip file, the content package can
then be sent to specific users, or be published to the HP Live Network
(https://hpln.hp.com/group/sitescope) community enabling other users to import the monitor for
their own use.
For details on using the Wizard, see Export Content Package Wizard.
1.
Prerequisites
Only a SiteScope administrator user, or a user granted the Add, edit or delete templates
permissions can import monitor templates from a content package. For details, see
Permissions.
2.
Access the custom monitor content package
n
If a content package zip file was sent to you, skip to the next step.
n
If a content package was made available to the Community Content for SiteScope page on
HP SiteScope (11.23)
Page 99 of 926
Monitor Reference
Chapter 16: Custom Monitor
HP Live Network, download the content package to your SiteScope machine. HP Live
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to download a template or content package from the HP Live
Network in the Using SiteScope Guide.
3.
Import the custom monitor content package
a. In SiteScope, select the Templates context. In the template tree, right-click the template
container into which you want to import the content package, and click Import.
b. In the Content Import dialog box, select Content package, and click the Browse button.
Navigate to the folder containing the package you want to import (packages are distributed
in zip format). Click Open, and then click OK. For details on the Content Import dialog box,
see Content Import Dialog Box in the Using SiteScope Guide.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
4.
Verify the template was imported successfully by checking it was
added to the template tree
The content package is copied to the <SiteScope root directory>\packages\imported
folder, and a new folder is created with the name: <Package/Zip Name>.zip_<Package ID>.
The folder contains:
n
\META-INF. Contains the manifest file where information about the content package is
stored.
n
\templates. Contains files from which templates in this content package were imported into
SiteScope.
n
<Package/Zip Name>. Uncompressed package that contains the above-mentioned
folders, the \extensions folder which contains script and alert template files referenced by
monitors in the imported templates, and the folders used for Custom monitors:
n
o
\classes. Used for storing compiled Java classes.
o
\conf Used for storing configuration files, documentation, and XML files.
o
\lib Used for storing external jar files used by the monitor script. Note that the \lib folder
is shared between all monitors imported in the same template.
<Package/Zip Name>.zip.properties. This is the descriptor (manifest) file for content
packages created in SiteScope 11.20, that is used in case of rollback, uninstall, or upgrade.
HP SiteScope (11.23)
Page 100 of 926
Monitor Reference
Chapter 16: Custom Monitor
The file contains the ID of the SiteScope template that was deployed, the location of the
files in SiteScope, and other information about the content package.
The imported templates and dependency files can be used directly or modified as required.
Where script or alert templates are referenced in the user interface, the unique package ID is
added as a suffix.
Example: ShortMail alert action template referenced in the Template field.
5.
Deploy the custom monitor template
After importing the custom monitor template, you can deploy the template to a group.
a. In the template tree, right-click the custom monitor template you want to deploy, and select
Deploy Template.
b. In the Select Group dialog box, select a group into which you want to deploy the template.
Alternatively, you can click the New Group button and create a new group to which you
can deploy the template. For user interface details, see Select Group Dialog Box in the
Using SiteScope Guide.
c. In the Deployment Values dialog box, enter the required variable values in the entry boxes
displayed, and click OK. The entry boxes displayed correspond to the template variables
used in the template objects. For user interface details, see Deployment Values Dialog
Box in the Using SiteScope Guide.
Note: When deploying the template or publishing changes in the template to deployed
groups, clearing the Verify monitor properties with remote server check box in the
Deployment Values dialog box has no effect, because the monitor configuration
properties in the template must be checked against the remote server on which the
template is being deployed.
d. Verify that the template was deployed successfully (the template objects should be added
to the specified group in the monitor tree).
HP SiteScope (11.23)
Page 101 of 926
Monitor Reference
Chapter 16: Custom Monitor
For task details, see How to Deploy Templates Using the User Interface in the Using
SiteScope Guide.
6.
Configure monitor status thresholds
After the monitor run, you can define thresholds for metrics that were resolved in the run. In the
Threshold Settings panel of the custom monitor, select metrics for which you want to define
thresholds in the Condition column by using variables or free text, or selecting default metrics
from the drop-down list, and enter the value applicable to the metric parameter.
UI Descriptions
Custom Monitor Settings
User interface elements are described below:
UI Element
Description
Script Parameters Table
Add Parameter. Adds a new line to the Script Parameters table, enabling you to
define parameters for use in the custom monitor script.
Delete Parameter. Deletes the selected parameter.
Parameter
Name
The name assigned to the parameter. All parameter names must be different.
Parameter
Value
The parameter value.
Hide Value
Select to hide the parameter value in the Script Parameters table and in the
custom monitor script. The value is masked behind asterisks (*****).
If you want to hide a parameter value such as a password, select the Hide Value
check box. The value is masked behind asterisks (*****) in the user interface.
This option is useful for an administrator in SiteScope when creating custom
monitor templates, since it enables the monitor to be deployed without the
parameter value being displayed in the monitor view.
Default value: Not selected
Note: The hide option is editable when working in template mode only.
Data Processing Script
HP SiteScope (11.23)
Page 102 of 926
Monitor Reference
Chapter 16: Custom Monitor
UI Element
Description
<Script>
The input data for the data processing script is displayed in this box.
Define the script that parses the results and creates new metrics. For details on
the monitor configuration properties in the script, including how to access them,
and the monitor storage and metrics names, see "How to Access the Monitor
Configuration Parameters Exposed in the Script" on page 98.
Note: By default, the number of metrics that are allowed in custom monitors is
1000. You can modify this number by changing the Maximum number of
counters value in Preferences > Infrastructure Preferences > Custom
Monitor Settings.
Package
path
Path generated by SiteScope where the files used for developing the monitor can
be saved. This enables you to add the jars on which the monitor depends (if
applicable), classes, configuration, and templates files to the monitor. The path is
displayed as read only.
Click the Create Path button to create a folder with a relative path in the
SiteScope root directory (packages\workspace\package_<unique ID>). The
path is displayed as read only.
The folder contains the following subfolders into which you copy the files used to
create the monitor:
l
lib. (Optional) Used for storing external jar files used by the monitor script.
Note that you can use this monitor without external jars.
l
classes. (Optional) Used for storing Java compiled classes; note that they
should be copied with the entire package folder structure.
l
conf. (Optional) Used for storing configuration files, documentation, and XML
files.
l
template. (Mandatory) Used for storing the template files that contain the
custom monitor. It must contain at least one template. Each template can
contain various types of monitors; custom and regular.
Note: This field is displayed when working in monitor mode only. When working in
template mode and the monitor is deployed, the content pack is imported into the
path.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Custom monitor.
HP SiteScope (11.23)
Page 103 of 926
Monitor Reference
Chapter 16: Custom Monitor
l
"General Tips/Limitations" below
l
"Custom Monitor Logs" below
General Tips/Limitations
l
If a user-defined or imported Java package has the same name as an existing SiteScope or
standard Java package, SiteScope ignores the user-defined/imported Java package.
l
When setting custom monitor metrics with a string (non-numeric) value, the maximum and
average values in the Measurement Summary table of the Management Report are shown as
'n/a'. This also occurs if you change the metric value type, for example, if you set the metric with
a numeric value, and later change it to a string value or vice versa.
l
When deploying a custom monitor using a template, clearing the Verify monitor properties
with remote server check box in the Deployment Values dialog box has no effect, because the
monitor configuration properties in the template must be checked against the remote server on
which the template is being deployed.
l
When publishing changes to a template that contains a custom monitor, we recommend using
the Disable custom monitors while publishing changes option (selected by default) in
Preferences > Infrastructure Preferences > Custom Monitor Settings. The monitor is
temporarily disabled before changes are published and is restored to the enabled state after
changes have been made.
l
Setting status thresholds using a baseline is not supported on user-defined metrics.
l
You can use third-party .jar files without removing the JVM security from the registry by adding
the _scriptSandboxRuntimePermissions property to the <SiteScope root
directory>;\groups\ master.config file, and specifying the permitted jar files. For example, to
use signed libraries jopcagtbase.jar and jopcagtmsg.jar, configure the parameter as
follows: _scriptSandboxRuntimePermissions=loadLibrary.jopcagtbase,
loadLibrary.jopcagtmsg.
For the types of runtime permissions that can be used, see Runtime Permission class in the
Java API documentation
(http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimePermission.html).
Custom Monitor Logs
l
Errors in the monitor (including errors in the script) are written to the SiteScope logs in the same
way as for any other monitor. Check the error.log and RunMonitor.log files.
l
Error messages from the script are displayed in the custom_monitor.log file located in
<SiteScope root directory>\logs\custom_monitors. This log can be used for info, warning,
error, and debug messages from running the script.
HP SiteScope (11.23)
Page 104 of 926
Monitor Reference
Chapter 16: Custom Monitor
To change the log level to DEBUG mode, in <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava\log4j.properties, change ${loglevel} to
DEBUG in the following paragraph:
# Custom monitors category
log4j.category.CustomMonitor=${loglevel},custom.monitor.appender
log4j.additivity.CustomMonitor=false change
HP SiteScope (11.23)
Page 105 of 926
Chapter 17: Custom Database Monitor
The Custom Database monitor broadens the capabilities of database monitors which are used to
monitor the availability and performance of your systems and applications, whose data is
accessible through database queries. Using the Custom Database monitor, you can create your
own database monitor by developing queries that collect data, and a script that processes the
collected data and creates metrics. You can use Java code developed by yourself or by a thirdparty to process the data.
You can share custom monitors by publishing them to the HP Live Network community, enabling
other SiteScope users to import the monitor template for their own use.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Custom Database monitor.
Learn About
This section includes:
l
"Custom Database Monitor Overview" below
l
"IPv6 Addressing Supported Protocols" on the next page
Custom Database Monitor Overview
The Custom Database monitor enables you to develop your own database monitor on top of the
SiteScope infrastructure. This provides you with greater flexibility not available in existing monitors.
You can use the Custom Database monitor to:
l
Collect any database data you like
You can create a series of SQL queries for the database tables you want to monitor. SiteScope
runs the queries and returns the results to the monitor in an object that contains a set of results
for each query. Each time the monitor runs, it re-runs your queries and collects fresh data.
l
Process the collected data
You can create a script in the monitor that can extract and process the results of the collected
data. For example,you can define metrics based on collected data from the database and
perform mathematical operations on it as in the sample script provided.
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip).
l
Collect data dynamically
HP SiteScope (11.23)
Page 106 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
You can include dynamically-defined queries in the data processing script. These queries are
executed while the script is running, in contrast to predefined queries, which are executed before
the script is run. Dynamically-executed queries provide the added benefit of enabling you to
create queries based on values that are not in the monitored entity data store (for example,
timestamp), create queries based on previous query results or calculations, and include
variables in queries. For details, see Data Processing Script with Dynamic Queries in the Using
SiteScope Guide.
l
Debug custom monitors offline
You can perform offline debugging of a custom monitor script using a remote debugging server.
This makes the script development process easier, since it enables you to complete the code
and see the debugged data inside the script during the data processing stage. For details, see
"How to Debug a Custom Monitor Offline" on page 114.
After developing the monitor, you can:
l
Define thresholds for new metrics
Because some metrics are defined only during a script run, you cannot define thresholds for
them in advance. After the script has run for the first time and the metrics have been defined,
you can then define thresholds for them. This provides more advanced data processing options
than regular monitors. Note that metrics can change between script runs, for example, where
variables are used in metric names. Thresholds using a metric that does not exist after the
monitor run are removed automatically.
l
Share the monitor with other SiteScope users
After developing the monitor, you can export the monitor to a template, add external jars and/or
classes if the monitor depends on them, and create a content package. The content package
can then be sent to specific users, or shared with other SiteScope users by publishing it to the
SiteScope community on HP Live Network (https://hpln.hp.com/group/sitescope).
By sharing knowledge with other SiteScope users, you can benefit from extended SiteScope
monitor coverage and the development of new monitors outside the SiteScope release cycle.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports IPv6 addresses in the TCP (JDBC)
protocol. Support for IPv6 might also depend on the JDBC driver being used.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
This section includes:
HP SiteScope (11.23)
Page 107 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
l
"How to Develop a Custom Database Monitor" below
l
"How to Debug a Custom Monitor Offline" on page 114
l
"How to Access the Monitor Configuration Parameters Exposed in the Script" on page 116
l
"How to Import and Use a Custom Database Monitor" on page 117
How to Develop a Custom Database Monitor
1.
2.
Prerequisites
n
You must be an advanced SiteScope user with knowledge of JavaScript.
n
Knowledge of SQL and the database systems being monitored.
n
The database monitoring environment must be configured as described in "How to
Configure the Database Query Monitoring Environment" on page 189. (Ignore the last step in
this task.)
Create a Custom Database monitor with the relevant database queries
a. Create a group into which you want to add the custom monitor. Right-click the group,
select New > Monitor, and select the Custom Database monitor.
b. Configure the monitor properties:
o
In the General Settings panel, enter a name and description for the monitor.
o
In the Main Settings area of Custom Database Monitor Settings, configure the monitor
properties as described in the UI Descriptions section below.
o
In the Queries table, enter a separate query for each database instance and table in the
database you want to monitor.
Tip: By default, you can enter up to 10 queries in the table. You can modify the
number of queries that can be added to the table in Preferences > Infrastructure
Preferences > Custom Monitor Settings by configuring the Maximum number
of queries value.
3.
Create script parameters - optional
You can create a list of parameters that can be repeatedly used in the data processing script.
To do so, enter the parameter name and value in the Script Parameters Table.
For example, you might want to create a host, user name, and password parameter. You can
choose to hide parameter values, such as passwords, behind asterisks (*****) in the user
interface. The hide option is editable when working in template mode only.
HP SiteScope (11.23)
Page 108 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
For user interface details, see the UI Descriptions section below.
Note: By default, the maximum number of parameters allowed in the table is 10. When the
maximum number of rows is reached, no additional rows can be added. You can modify
this number by changing the Custom monitor maximum number of script parameters
value in Preferences > Infrastructure Preferences > Custom Settings. You must
restart SiteScope if you change this setting.
4.
Create the data processing script
In the Data Processing Script area of Custom Database Monitor Settings, create the script
that parses the results and creates new metrics in the names that you determined.
In addition, you can include any number of queries in the script. The queries are executed as
the script is run, which means that the monitor collects fresh data from the database being
monitored. After the data is retrieved, it becomes available for the script to use. A query in a
script has the same syntax as a query defined in the queries table, but it can be structured
using variables which makes it dynamic within the monitor run context. For details on dynamic
queries, see Data Processing Script with Dynamic Queries in the Using SiteScope Guide.
For details on the monitor configuration properties, including how to access them, and the
monitor storage and metrics names, see "How to Access the Monitor Configuration
Parameters Exposed in the Script" on page 116.
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip). A sample jar file showing the
custom monitor's capability to access Java code is provided in the <SiteScope root
directory>\examples\monitors\custom\lib folder.
For details on scripting in Java, see http://www.mozilla.org/rhino/ScriptingJava.html.
Tip:
n
A sample Custom Database monitor script is provided in the Data Processing Script
box. To use it, you need to uncomment the script.
n
Sample scripts for all the custom monitors are available from the sample content
package located in the <SiteScope installation
directory>\examples\monitors\custom folder. CustomMonitorSamplePackage.zip
contains examples for SiteScope 11.20, and CustomMonitorsExamples_11_21.zip
contains updated examples including a Custom Database monitor with a dynamic
query, a manifest file created using the Export Content Package Wizard, and template
mail and template mail subject files, To use these scripts, you need to import the
custom monitor content package and then deploy the custom monitor template. For
HP SiteScope (11.23)
Page 109 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
task details, see steps 3 and 4 of "How to Import and Use a Custom Database Monitor"
on page 117.
Note:
5.
n
If your monitor needs to open a network connection to another server from the data
processing script or the Java code that is called from the script, you must enable the
Allow network access setting in Preferences > Infrastructure Preferences >
Custom Monitor Settings.
n
Access for the data processing script is restricted to the following folders/files on the
SiteScope server:
o
The \conf folder which is located inside each content package (<SiteScope root
directory>\packages\imported or <SiteScope root
directory>\packages\workspace) (requires Read permissions).
o
<SiteScope root directory>\logs\custom_monitors\* (all permissions)
n
You can use the custom_monitor.log file for any info, warning, error, and debug
messages that you want to write during the execution of the script. The log is located in
<SiteScope root directory>\logs\custom_monitors. For details on changing the log
to DEBUG mode, see "Custom Monitor Logs" on page 126.
n
By default, the number of metrics that are allowed in custom monitors is 1000. You can
modify this number by changing the Maximum number of counters value in
Preferences > Infrastructure Preferences > Custom Monitor Settings.
n
When working in template mode, you can use template variables in a data processing
script.
Generate a path for storing the files used for creating the Custom
Database monitor
Click the Create Path button to create a folder where the relevant jars, classes, configuration,
and template files required for running the monitor can be saved. A folder with a relative path is
created under <SiteScope root directory>\packages\workspace\package_<Package ID>.
The path is displayed as read only.
The folder contains the following (empty) subfolders:
n
packages\workspace\package_<>\lib. Used for storing external jar files used by the
monitor script.
n
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note
that they should be copied with the entire package folder structure.
HP SiteScope (11.23)
Page 110 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
n
packages\workspace\package_<>\conf. Used for storing configuration files,
documentation, and XML files.
n
packages\workspace\package_<>\template. Used for storing the template files that
contain the custom monitor (you perform this in "Create a monitor template - optional" on the
next page).
You can copy the required files to these folders at this stage, or when performing "Create a
content package - optional" on the next page.
Note: If you add or modify jars/classes after the first monitor run, you must either:
6.
n
Restart SiteScope for the changes to take effect, or
n
To avoid having to restart SiteScope, you should enable the Reload classes and jars
on each monitor run option in Preferences > Infrastructure Preferences > Custom
Monitor Settings. This option should only be used be during script development, and
should be cleared in the production stages since it impacts performance.
Configure topology reporting - optional
To report monitor and related CI topology data to BSM's RTSM, configure the required topology
reporting settings as described in How to Configure Topology Reporting for a Custom Monitor
in the Using SiteScope Guide.
7.
Configure other settings for the monitor - optional
Configure other settings for the monitor as required. For details, see Common Monitor Settings
in the Using SiteScope Guide.
8.
Save the monitor and wait for the first monitor run
Save the monitor. SiteScope verifies the correctness of the monitor configuration both locally
and on the remote server to be monitored, before saving the settings, regardless of whether
you clicked Verify & Save or Save.
The monitor collects data from the database instances, and filters the data based on the script
you supplied.
9.
Managing custom monitors
After creating a custom monitor, you can copy, move, or delete the monitor. When doing so,
this affects the content package folder (created in the <SiteScope root
directory>\packages\workspace directory) as follows:
HP SiteScope (11.23)
Page 111 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
10.
Action
File System Impact
Copy Monitor
Makes a copy of the content package folder in the <SiteScope root
directory>\packages\workspace folder.
Cut Monitor
No change.
Delete Monitor
If you delete the custom monitor, the content package folder is
removed from the <SiteScope root
directory>\packages\workspace folder of the SiteScope file
system.
Deploy template with
custom monitor +
content package
No change.
If a deployed monitor is copied, the content package will be copied
to the <SiteScope root directory>\packages\workspace folder of
the SiteScope file system.
Define thresholds for the metrics - optional
After the monitor has run, you can:
11.
n
Make changes to the script and define thresholds for metrics that were created or updated in
the run. For details, see Threshold Settings in the Using SiteScope Guide.
n
Check status and values of the metrics in the SiteScope Dashboard.
n
Set up alerts on the monitor. For details, see How to Configure an Alert in the Using
SiteScope Guide.
Create a monitor template - optional
a. To copy the monitor to a template, right-click the monitor, select Copy to Template, and
select the template group to which you want to add the copied configuration. For details,
see How to Create a Template by Copying Existing Configurations in the Using SiteScope
Guide.
b. Make any necessary changes such as adding template variables to the template. For
details on template variables, see New Variable Dialog Box.
12.
Create a content package - optional
a. Copy the files used for creating the monitor to the predefined content package subfolders:
o
<SiteScope>\packages\workspace\package_<Package ID>\lib. (Optional) Copy
any external jars used by the custom monitor script to this folder. Java classes from the
jar files can be accessed from the data processing script. Note that you can use this
monitor without external jars.
HP SiteScope (11.23)
Page 112 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
Note: In the data processing script, to import a package from a jar that does not
start with com., org., or java., you must add the package's prefix:
importPackage(Packages.<packageName>)
For example, importPackage(Packages.it.companyname.test);
For details on importing Java classes and packages, see
http://www.mozilla.org/rhino/ScriptingJava.html.
o
<SiteScope>\packages\workspace\package_<>\classes. (Optional) Copy the
compiled Java classes with the entire package folder structure to this folder; this is not
required if the class files were packaged in a jar that was copied to the \lib folder. The
class files can be accessed from the data processing script.
o
<SiteScope>\packages\workspace\package_<>\conf. (Optional) Copy the
configuration files, documentation, and XML files to this folder.
o
<SiteScope>\packages\workspace\package_<>\template. (Optional) The folder
should contain the template files exported from SiteScope (performed in "Create a
monitor template - optional" on the previous page). Each template can contain various
types of monitors, custom and regular.
b. Copy extension files - optional
If the monitor references script or alert extension files in the SiteScope file system, copy
them to the relevant folders in <SiteScope root
directory>\packages\workspace\extensions>:
o
\scripts. Used for storing script files that are used to run shell commands or other
scripts on the machine where SiteScope is running.
o
\scripts.remote. Used for storing script files that are used for running a script that is
stored on a remote machine.
o
\templates.mail. Used for storing the file containing the format and content of alert
messages sent by email.
o
\templates.mail.subject. Used for storing the file containing the subject line of alert
messages sent by email.
o
\templates.mib. Used for storing the MIB files that are used to create a browsable tree
that contains names and descriptions of the objects found during a traversal.
o
\templates.os. Used for storing the shell commands to be run when monitoring remote
UNIX servers.
HP SiteScope (11.23)
Page 113 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
Note:
o
On exporting the files to a content package, the unique package ID is added to the
script and template files as a suffix (before the file extension) under the relevant
folder in the SiteScope root directory.
o
As part of the import process, the template.os and templates.mib files are edited
and the unique package ID is added to some properties inside the files.
c. Export the content package to a zip file
Select the Templates context. In the template tree, right-click the template or template
container that you want to export to a content package, and select Export > Content
Package. For details on the Content Import dialog box, see Content Import Dialog Box in
the Using SiteScope Guide.
In the Export Content Package Wizard, enter details of the content package (manifest),
and select the templates and files associated with these templates to include. For Wizard
details, see Export Content Package Wizard.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
Note: The Select Files page of the Wizard displays files from the <SiteScope root
directory>\packages\workspace\package_<Package ID> and <SiteScope root
directory>\packages\workspace\extensions> folders listed above, except for the
\META-INF and \templates folders which are not displayed.
13.
Share the custom monitor with other SiteScope users - optional
You can distribute a content package zip file by:
n
Sending it to individual SiteScope users.
n
Sharing it with other SiteScope users by uploading it to the Community Content for
SiteScope page on HP Live Network (https://hpln.hp.com/group/sitescope). HP Live
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to publish content to the HP Live Network community.
How to Debug a Custom Monitor Offline
This task describes the steps involved in offline debugging of a custom monitor script using a
remote debugging environment. This makes the script development process easier, since it
enables you to complete the code and see the debugged data inside the script during the data
HP SiteScope (11.23)
Page 114 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
processing stage.
1. Prerequisites
To perform offline debugging, the Eclipse IDE with Web Tools must be installed on a local
machine.
2. In SiteScope, enable the global custom monitor debugging setting in SiteScope Preferences
Select Preferences > Infrastructure Preferences > Custom Monitor Settings, and select
the Enable custom monitor debugging check box.
3. In SiteScope, create a custom monitor with offline debugging enabled
Create a custom monitor. For details, see the previous task.
When configuring the monitor settings, expand Custom Monitor Settings, and under the Data
Processing Script section, select Enable monitor debugging.
Save the monitor.
4. Copy the Custom Monitor Debugging Eclipse project to the debugging environment
The Custom Monitor Debugging Eclipse project is available (in zip format) from:
n
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
n
The Community Content for SiteScope page on the HP Live Network
(https://hpln.hp.com/group/community-content-sitescope).
Note: Make sure you use the correct version of the Custom Monitor Debugging Eclipse
project. SiteScope 11.23 is compatible with version 2.0 of the project (SISProxy2.0.min.js).
5. Import the Custom Monitor Debugging project into Eclipse IDE
a. On the debugging environment, open Eclipse IDE and click Import.
b. Select General > Existing Project into Workspace, and click Next.
c. Select the Custom Monitor Debugging Eclipse project (zip file).
6. Copy the SiteScope Custom Monitor Data Processing Script to the Custom Monitor
Debugging project
a. Copy the content of Data Processing Script from the SiteScope custom monitor to
MonitorScript.js script.
HP SiteScope (11.23)
Page 115 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
b. Connect to the SiteScope monitor by entering the following in the DebugConfiguration.js
file:
o
host. Name of the SiteScope server.
o
port. Port used by the SiteScope server.
o
username. Username for accessing the SiteScope server.
o
password. Password to access the SiteScope server.
o
monitorPath. Full path to the custom monitor to debug in SiteScope including the
monitor name, separated by “/”. For example, Group1/Group2/Group3/Custom
Monitor Name.
7. Enable the debugger to use external jar files - optional (where the script uses external jar files)
If the monitor script uses external jar files, copy the jar files from <SiteScope root
directory>\packages\workspace\package_<Package ID>\lib to the <JRE installation
path>\lib\ext directory on the debugging environment.
8. Run the debugger
a. In the Eclipse IDE, select Debug Configuration.
b. Select Rhino JavaScript > Custom Monitor Debugging - MonitorScript.js.
c. The debugger connects to SiteScope, and runs the script within the monitor.
SiteScope returns the data to the debugger and then disconnects. This enables the
debugger to simulate the script running the same data.
9. Debug the script
Use Eclipse IDE to debug the script.
How to Access the Monitor Configuration Parameters Exposed in the
Script
Data Processing Script:
l
You can access the configuration parameters for custom monitors in the data processing script
using:
myContext.getInputData().getConfigurationParameter("<configuration parameter name>");
Example:
var monitorName = myContext.getInputData().getConfigurationParameter("monitorName");
The following monitor properties are exposed to the script (for all custom monitors):
HP SiteScope (11.23)
Page 116 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
n
monitorName. The name of
n
monitorDescription.
the monitor.
A description of the monitor.
The following monitor properties are exposed to the script for the Custom Database monitor
only:
n
l
dbConnectionUrl.
The connection URL of the database to which you want to connect.
You can set the summary string which is used as the monitor status in the SiteScope
Dashboard using:
myContext.getScriptResult().setSummary("<text summary>");
The default value is: summary = <a set of metrics and their values>
l
You can set monitor availability which is displayed in the SiteScope Dashboard using:
myContext.getScriptResult().setAvailability(<true/false>)
The default value is: availability = true
Topology Script:
You can access the configuration parameters for custom monitors in the topology script using:
Framework.getDestinationAttributeAsObject("configuration").get("<configuration parameter
name>")
To access data saved in the monitor storage (this is a place where you can save script data for use
in future executions):
Framework.getDestinationAttributeAsObject("monitorStorage").get("<configuration parameter
name>")
To access the list of metric names used in the script:
Framework.getDestinationAttributeAsObject("metrics")
How to Import and Use a Custom Database Monitor
After developing a custom monitor and creating a content package zip file, the content package can
then be sent to specific users, or be published to the HP Live Network
(https://hpln.hp.com/group/sitescope) community enabling other users to import the monitor for
their own use.
For details on using the Wizard, see Export Content Package Wizard.
1.
Prerequisites
Only a SiteScope administrator user, or a user granted the Add, edit or delete templates
permissions can import monitor templates from a content package. For details, see
Permissions.
2.
Access the custom monitor content package zip file
HP SiteScope (11.23)
Page 117 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
n
If a content package zip file was sent to you, skip to the next step.
n
If a content package was made available to the Community Content for SiteScope page on
HP Live Network, download the content package to your SiteScope machine. HP Live
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to download a template or content package from the HP Live
Network in the Using SiteScope Guide.
3.
Import the custom monitor content package
a. In SiteScope, select the Templates context. In the template tree, right-click the template
container into which you want to import the content package, and click Import.
b. In the Content Import dialog box, select Content package, and click the Browse button.
Navigate to the folder containing the package you want to import (packages are distributed
in zip format). Click Open, and then click OK. For details on the Content Import dialog box,
see Content Import Dialog Box in the Using SiteScope Guide.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
4.
Verify the template was imported successfully by checking it was
added to the template tree
The content package is copied to the <SiteScope root directory>\packages\imported
folder, and a new folder is created with the name: <Package/Zip Name>.zip_<Package ID>.
The folder contains:
n
\META-INF. Contains the manifest file where information about the content package is
stored.
n
\templates. Contains files from which templates in this content package were imported into
SiteScope.
n
<Package/Zip Name>. Uncompressed package that contains the above-mentioned
folders, the \extensions folder which contains script and alert template files referenced by
monitors in the imported templates, and the folders used for Custom monitors:
o
\classes. Used for storing compiled Java classes.
o
\conf Used for storing configuration files, documentation, and XML files.
o
\lib Used for storing external jar files used by the monitor script. Note that the \lib folder
is shared between all monitors imported in the same template.
HP SiteScope (11.23)
Page 118 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
n
<Package/Zip Name>.zip.properties. This is the descriptor (manifest) file for content
packages created in SiteScope 11.20, that is used in case of rollback, uninstall, or upgrade.
The file contains the ID of the SiteScope template that was deployed, the location of the
files in SiteScope, and other information about the content package.
The imported templates and dependency files can be used directly or modified as required.
Where script or alert templates are referenced in the user interface, the unique package ID is
added as a suffix.
Example: ShortMail alert action template referenced in the Template field.
5.
Deploy the custom monitor template
After importing the custom monitor template, you can deploy the template to a group.
a. In the template tree, right-click the custom monitor template you want to deploy, and select
Deploy Template.
b. In the Select Group dialog box, select a group into which you want to deploy the template.
Alternatively, you can click the New Group button and create a new group to which you
can deploy the template. For user interface details, see Select Group Dialog Box in the
Using SiteScope Guide.
c. In the Deployment Values dialog box, enter the required variable values in the entry boxes
displayed, and click OK. The entry boxes displayed correspond to the template variables
used in the template objects. For user interface details, see Deployment Values Dialog
Box in the Using SiteScope Guide.
Note: When deploying the template or publishing changes in the template to deployed
groups, clearing the Verify monitor properties with remote server check box in the
Deployment Values dialog box has no effect, because the monitor configuration
properties in the template must be checked against the remote server on which the
template is being deployed.
HP SiteScope (11.23)
Page 119 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
d. Verify that the template was deployed successfully (the template objects should be added
to the specified group in the monitor tree).
For task details, see How to Deploy Templates Using the User Interface in the Using
SiteScope Guide.
6.
Configure monitor status thresholds
When deploying the template, only the default metrics included with the monitor are displayed
(custom metrics defined in the script do not exist until after the monitor has run). For example,
when configuring a Custom Log File monitor, the following metrics are default: line,
lines/min,matches, matches/min.
After the monitor run, you can define thresholds for metrics that were resolved in the run. In the
Threshold Settings panel of the custom monitor, select metrics for which you want to define
thresholds in the Condition column by using variables or free text, or selecting default metrics
from the drop-down list, and enter the value applicable to the metric parameter.
UI Descriptions
Custom Database Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
Database
connection
URL
Connection URL of the database to which you want to connect. The syntax
should be in the format:
jdbc:<sub protocol>:<subname> or
<IP address>:<database server port>:<sid>.
Example: To connect to the Oracle database on a machine using port 1521 use:
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
The colon (:) and the (@) symbols must be included as shown.
HP SiteScope (11.23)
Page 120 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
UI Element
Description
Database
driver
Java class name of the JDBC database driver.
The default driver uses ODBC to make database connections. SiteScope uses
the same database driver for both primary and backup database connections.
If a custom driver is used, the driver must also be installed in the <SiteScope
root directory>\WEB-INF\lib\ directory.
Default value: sun.jdbc.odbc.JdbcOdbcDriver
Tip: You can specify database drivers that have timeout problems (where
database queries processed with these drivers exceed the timeout specified in
the monitor's Query timeout field) in the Timeout proxied query drivers list
field (in Preferences > Infrastructure Preferences > General Settings).
These drivers are queried separately with a monitor-based timeout.
Database
user name
User name used to log on to the database.
If you are using Microsoft SQL server and the default driver (Sun Microsystem
JDBC-ODBC bridge driver, sun.jdbc.odbc.JdbcOdbcDriver), you can leave
this blank and choose Windows Authentication when you setup the ODBC
connection.
With Windows Authentication, SiteScope connects using the login account of
the SiteScope service.
Note: The specified user name must have privileges to run the query specified
for the monitor.
Database
password
Password used to log on to the database.
If you are using Microsoft SQL server and the default driver (Sun Microsystem
JDBC ODBC bridge driver (sun.jdbc.odbc.JdbcOdbcDriver), you can leave this
blank and choose Windows Authentication when you create the ODBC
connection.
With Windows Authentication, SiteScope connects using the login account of
the SiteScope service.
HP SiteScope (11.23)
Page 121 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
UI Element
Description
Max rows
Maximum number of rows the monitor retrieves from the database for each
monitor run. If the number of result rows exceeds the set maximum, the monitor
retrieves the remaining rows (those that exceeded the maximum) on future
cycles, until all result rows are retrieved. The same rows in the amount limited by
this property value are retrieved from the beginning of the table on each monitor
run if Enumerating field, Enumerating field type and Initial enumerating
value fields are not populated.
The value should be sufficient to keep up with database table growth, yet small
enough to avoid java.lang.OutOfMemoryException errors. Further, monitor run
frequency should also be considered. Make sure that the rate at which data is
collected by the monitor—which is dependent on both monitor run frequency and
network/system speed—is greater than, or equal to, the rate of data insertion on
the monitored system.
Default value: 5000 rows
Physically
close if idle
connection
count
exceeds
Maximum number of unused SQL connections in the SQL connection pool.
When this number is exceeded, unused connections are closed rather than
returned to the connection pool.
Idle
connection
timeout
Maximum amount of time, in seconds/minutes/hours/days, that a SQL
connection remains unused after it has been returned to the SQL connection
pool. When the time is exceeded, the connection is automatically closed.
Default value: 10
Default value: 5 minutes
Query
timeout
Amount of time, in seconds/minutes/hours/days, to wait for execution of a SQL
statement. Not all SQL drivers have this function. If your SQL driver does not
support this function, this parameter is ignored.
Default value: 1 minute
Use
connection
pool
Enables SQL connection sharing. This means that you use a connection pool
rather than open and close a new connection for each monitor query.
Default value: Selected
Queries
New query. Adds a new line to the Database queries table, enabling you to
enter a new query.
Edit query. Opens the Query Editor, in which the selected SQL query is
displayed and can be edited.
Delete query. Deletes the selected query.
HP SiteScope (11.23)
Page 122 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
UI Element
Description
No
The query number. By default, you can add up to 10 queries to the table. The
queries are run in the order in which they appear in the table.
Note: You can modify the number of queries that can be added to the table by
changing the Maximum number of queries value in Preferences >
Infrastructure Preferences > Custom Monitor Settings.
Queries
Enter a query for each database instance and table in the database you want to
monitor. You can create or edit a query in the table (in line mode), or in the Query
Editor. To open the Query Editor, click the Edit query button. It is recommended
to use the Query Editor when adding or viewing long queries.
Enumerating Enumeration means the monitor retrieves the rows that were added to the
field
queried table since its last execution. Enumerating field is the column name for
the database field that the monitor uses for retrieving these rows.
Note: The column used as enumerating field must be included in the SELECT
clause.
Enumerating
field type
Initial
enumerating
value
The type of field used to order the result set. This can be a DATE field, an
INTEGER field, a DOUBLE floating point numeral field, or a LONG field. The
following table maps SQL types to the required enumerating field type.
SQL Type
Enumerating Field Type
SMALLINT
INTEGER
INTEGER
INTEGER / LONG
BIGINT
LONG
NUMERIC
LONG
DOUBLE
DOUBLE
DECIMAL
DOUBLE
FLOAT
DOUBLE
TIMESTAMP
TIMESTAMP
DATE
TIMESTAMP
Initial value to be used as a condition for the initial run of this monitor instance.
For example, if you specify the Enumerating Field Type as a field type DATE
and you enter a value of 2000-01-31 12:00:00 in the Start from value field,
only records that were added to the database after the specified date are
forwarded.
Note: The value of this field cannot be edited.
Script Parameters Table
HP SiteScope (11.23)
Page 123 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
UI Element
Description
Add Parameter. Adds a new line to the Script Parameters table, enabling you to
define parameters for use in the custom monitor script.
Delete Parameter. Deletes the selected parameter.
Parameter
Name
The name assigned to the parameter. All parameter names must be different.
Parameter
Value
The parameter value.
Hide Value
Select to hide the parameter value in the Script Parameters table and in the
custom monitor script. The value is masked behind asterisks (*****).
If you want to hide a parameter value such as a password, select the Hide
Value check box. The value is masked behind asterisks (*****) in the user
interface.
This option is useful for an administrator in SiteScope when creating custom
monitor templates, since it enables the monitor to be deployed without the
parameter value being displayed in the monitor view.
Default value: Not selected
Note: The hide option is editable when working in template mode only.
Data Processing Script
<Script>
The input data for the data processing script is displayed in this box.
Define the script that parses the results and creates new metrics. For details on
the monitor configuration properties in the script, including how to access them,
and the monitor storage and metrics names, see "How to Access the Monitor
Configuration Parameters Exposed in the Script" on page 116.
Note: By default, the number of metrics that are allowed in custom monitors is
1000. You can modify this number by changing the Maximum number of
counters value in Preferences > Infrastructure Preferences > Custom
Monitor Settings.
HP SiteScope (11.23)
Page 124 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
UI Element
Description
Package
path
Path generated by SiteScope where the files used for developing the monitor can
be saved. This enables you to add the jars on which the monitor depends (if
applicable), classes, configuration, and templates files to the monitor. The path
is displayed as read only.
Click the Create Path button to create a folder with a relative path in the
SiteScope root directory (packages\workspace\package_<unique ID>). The
path is displayed as read only.
The folder contains the following subfolders into which you copy the files used to
create the monitor:
l
lib. (Optional) Used for storing external jar files used by the monitor script.
Note that you can use this monitor without external jars.
l
classes. (Optional) Used for storing Java compiled classes; note that they
should be copied with the entire package folder structure.
l
conf. (Optional) Used for storing configuration files, documentation, and XML
files.
l
template. (Mandatory) Used for storing the template files that contain the
custom monitor. It must contain at least one template. Each template can
contain various types of monitors; custom and regular.
Note: This field is displayed when working in monitor mode only. When working
in template mode and the monitor is deployed, the content pack is imported into
the path.
Use Tool
(Lower left
side of the
New Custom
Database
Monitor dialog
box)
Click the Use Tool button to open the Database Connection tool when
configuring or editing a monitor. This enables you to test and verify connectivity
between SiteScope and an external ODBC or JDBC compatible database
(provided you are an administrator in SiteScope, or a user granted Use monitor
tools permissions). For details on the tool, see Database Connection Tool in the
Using SiteScope Guide.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Custom Database monitor.
HP SiteScope (11.23)
Page 125 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
l
"General Tips/Limitations" below
l
"Custom Monitor Logs" below
General Tips/Limitations
l
If a user-defined or imported Java package has the same name as an existing SiteScope or
standard Java package, SiteScope ignores the user-defined/imported Java package.
l
When setting custom monitor metrics with a string (non-numeric) value, the maximum and
average values in the Measurement Summary table of the Management Report are shown as
'n/a'. This also occurs if you change the metric value type, for example, if you set the metric with
a numeric value, and later change it to a string value or vice versa.
l
When deploying a custom monitor using a template, clearing the Verify monitor properties
with remote server check box in the Deployment Values dialog box has no effect, because the
monitor configuration properties in the template must be checked against the remote server on
which the template is being deployed.
l
When publishing changes to a template that contains a custom monitor, we recommend using
the Disable custom monitors while publishing changes option (selected by default) in
Preferences > Infrastructure Preferences > Custom Monitor Settings. The monitor is
temporarily disabled before changes are published and is restored to the enabled state after
changes have been made.
l
Setting status thresholds using a baseline is not supported on user-defined metrics.
l
You can use third-party .jar files without removing the JVM security from the registry by adding
the _scriptSandboxRuntimePermissions property to the <SiteScope root
directory>;\groups\ master.config file, and specifying the permitted jar files. For example, to
use signed libraries jopcagtbase.jar and jopcagtmsg.jar, configure the parameter as
follows: _scriptSandboxRuntimePermissions=loadLibrary.jopcagtbase,
loadLibrary.jopcagtmsg.
For the types of runtime permissions that can be used, see Runtime Permission class in the
Java API documentation
(http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimePermission.html).
l
If running a dynamic query from within a data processing script fails, an exception is thrown.
Custom Monitor Logs
l
Errors in the monitor (including errors in the script) are written to the SiteScope logs in the same
way as for any other monitor. Check the error.log and RunMonitor.log files.
l
Error messages from the script are displayed in the custom_monitor.log file located in
<SiteScope root directory>\logs\custom_monitors. This log can be used for info, warning,
error, and debug messages from running the script.
HP SiteScope (11.23)
Page 126 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
To change the log level to DEBUG mode, in <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava\log4j.properties, change ${loglevel} to
DEBUG in the following paragraph:
# Custom monitors category
log4j.category.CustomMonitor=${loglevel},custom.monitor.appender
log4j.additivity.CustomMonitor=false change
Possible Errors Using the Oracle Thin Driver
l
error, connect error, No suitable driver: check for syntax errors in Database connection
URL, such as dots instead of colons.
l
error, connect error, Io exception: The Network Adapter could not establish the
connection: in Database connection URL, check
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
l
error, connect error, Io exception: Invalid connection string format, a valid format is:
"host:port:sid": in Database connection URL check
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
l
error, connect error, Invalid Oracle URL specified: OracleDriver.connect: in Database
connection URL, check for a colon before the "@"
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
l
Refused:OR=(CODE=12505)(EMFI=4)))): in Database connection URL, the database SID is
probably incorrect (ORCL part). This error can also occur when the TCP address, or TCP port is
incorrect. If this is the case, verify the TCP port and check with the your database administrator
to verify the proper SID.
l
String Index out of range: -1: in Database connection URL, check for the database server
address, port, and the database SID.
l
error, driver connect error, oracle.jdbc.driver.OracleDriver: check syntax in Database
driver.
l
error, driver connect error, oracle.jdbc.driver.OracleDriver: check that driver is loaded in
correct place.
l
error, connect error, No suitable driver: check driver specified in Database driver.
l
error, connect error, No suitable driver: check for syntax errors in Database connection
URL, such as dots instead of colons.
Possible Errors Using the MySQL Driver
If, after enabling SiteScope to monitor a MySQL database, you get an authorization error in the
Database Query monitor, you may have to grant rights for the SiteScope machine to access the
MySQL database. Consult the MySQL Database administrator for setting up privileges for the
SiteScope machine to access the MySQL server.
HP SiteScope (11.23)
Page 127 of 926
Monitor Reference
Chapter 17: Custom Database Monitor
Possible Errors with Sybase Database Monitoring
l
Verify you are using the correct driver for the version of Sybase you are monitoring. Enter
com.sybase.jdbc.SybDriver for Sybase version 4.x. and
com.sybase.jdbc2.jdbc.SybDriver for Sybase version 5.x.
l
error, driver connect error, com/sybase/jdbc/SybDriver. Verify there are no spaces at the
end of the driver name. Save the changes and try the monitor again.
l
connect error, JZ006: Caught IOException: java.net.UnknownHostException:
dbservername. Verify the name of the database server in Database connection URL is
correct.
HP SiteScope (11.23)
Page 128 of 926
Chapter 18: Custom Log File Monitor
The Custom Log File monitor broadens the capabilities of Log File monitors which are used to
automatically scan log files for error information, thereby eliminating the need to manually scan the
logs. You can create your own Log File monitor that scans for matches in the form of a text phrase
or regular expression, and a script that processes the collected data and creates metrics. You can
use Java code developed by yourself or by a third-party to process the data.
You can share custom monitors by publishing them to the HP Live Network community, enabling
other SiteScope users to import the monitor template for their own use.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Custom Log File monitor.
Learn About
This section includes:
l
"Custom Log File Monitor Overview" below
l
"Scheduling the Monitor" on the next page
l
"Customizing Custom Log File Content Matches and Monitor Alerts" on page 131
l
"Support for IPv6 Addresses" on page 131
Custom Log File Monitor Overview
The Custom Log File monitor enables you to develop your own Log File monitor on top of the
SiteScope infrastructure.
Custom monitors enable you to do the following:
l
Create monitors that provide additional metrics not available in existing monitors
You can define a text phrase or regular expression that watches for log file entries, and create
new metrics from the collected data. Each time the monitor runs, it updates the metrics and
returns a status for the metrics defined in the script.
l
Process the collected data
The returned data can be extracted and processed in the script. For example, you can create a
monitor that scans a log file for content match of system time and idle time values, and
develop a script that creates a metric named sum of overall CPU usage, which is the sum of
these values.
HP SiteScope (11.23)
Page 129 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip).
l
Customize how results are displayed
You can determine how results are displayed. For example, whether result data is displayed in
megabytes or kilobytes.
l
Debug custom monitors offline
You can perform offline debugging of a custom monitor script using a remote debugging server.
This makes the script development process easier, since it enables you to complete the code
and see the debugged data inside the script during the data processing stage. For details, see
"How to Debug a Custom Monitor Offline" on page 141.
After developing the monitor, you can:
l
Define thresholds for new metrics
Because some metrics are defined only during a script run, you cannot define thresholds for
them in advance. After the script has run for the first time and the metrics have been defined,
you can then define thresholds for them. This provides more advanced data processing options
than regular monitors. Note that metrics can change between script runs, for example, where
variables are used in metric names. Thresholds using a metric that does not exist after the
monitor run are removed automatically.
l
Share the monitor with other SiteScope users
After developing the monitor, you can export the monitor to a template, add external jars and/or
classes if the monitor depends on them, and create a content package. The content package
can then be sent to specific users, or shared with other SiteScope users by publishing it to the
SiteScope community on HP Live Network (https://hpln.hp.com/group/sitescope).
By sharing knowledge with other SiteScope users, you can benefit from extended SiteScope
monitor coverage and the development of new monitors outside the SiteScope release cycle.
Scheduling the Monitor
You can schedule Custom Log File monitors to run as often as every 15 seconds. However,
depending on the size of the log file, the total number of monitors you have running, and Check
from beginning option selected, the monitor may take 15 seconds or longer to check the file for
the desired entries. The default update schedule of every 10 minutes is a reasonable frequency in
most cases.
By default, each time that SiteScope runs this monitor, it starts from the point in the file where it
stopped reading last time it ran. This insures that you are notified only of new entries and speeds
the rate at which the monitor runs. You change this default behavior using the Check from
beginning property. For details, see the "Check from beginning" on page 149 property.
HP SiteScope (11.23)
Page 130 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
Customizing Custom Log File Content Matches and Monitor Alerts
You can create a Custom Log File monitor that triggers customized alerts for content matches
according to the threshold status of the monitor.
To configure the Custom Log File monitor with custom matches and alerts:
1. In the Custom Log File Monitor Settings, configure the following settings:
n
Run alerts: Select the For each log entry matched option.
n
Content match: Enter the text to look for in the log entries. For example, to find text entries
redflag and disaster in the log file, enter /(redflag|disaster)/.
n
Match value label:. Enter a label name for the matched values found in the target log file.
For example, type matchedValue.
2. In the Threshold Settings, set the error and warning threshold. For example, set Error if
matchedValue == disaster and set Warning if matchedValue == redflag.
3. Configure error, warning, and good alerts for the Custom Log File monitor. The alert that is sent
depends on the threshold that is met for each entry matched. For example, if the error threshold
is met, the error alert is triggered. For details on configuring alerts, see How to Configure an
Alert in the Using SiteScope Guide.
Support for IPv6 Addresses
This monitor supports the IPv6 protocol. If you want your environment to resolve host names to
IPv6, you can select the Prefer IP version 6 addresses option in SiteScope Infrastructure
Settings (Preferences > Infrastructure Preferences > Server Setting). If this option is selected,
whenever a host name is specified for a remote server and the name is resolved to both IPv4 and
IPv6, the IPv6 address is used.
When using IPv6, the following protocols are supported:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 131 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
Tasks
This section includes:
l
"How to Develop the Custom Log File Monitor" below
l
"How to Debug a Custom Monitor Offline" on page 141
l
"How to Access the Monitor Configuration Parameters Exposed in the Script" on page 143
l
"How to Import and Use a Custom Log File Monitor" on page 144
How to Develop the Custom Log File Monitor
1.
2.
Prerequisites
n
You should be an advanced SiteScope user with knowledge of writing scripts in JavaScript,
and have knowledge of the content of the log file of the application being monitored.
n
The following configuration requirements must be performed or verified before the Custom
Log File monitor can be used:
o
The log file to be monitored must exist, and be accessible under credentials used for
connecting to the remote server, or under which SiteScope is running (if monitoring a
local file).
o
The remote server should be created with credentials that grant read access on the
monitored file.
Create a Custom Log File monitor with the relevant regular expressions
to match lines in the log file
a. Create a group into which you want to add the custom monitor. Right-click the group,
select New > Monitor, and select the Custom Log File monitor.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the Custom Log File Monitor Settings panel, configure the monitor properties as
described in the UI Descriptions section below.
In the Content match box, enter a regular expression depending on whether:
o
You want to process matched rows only (in which case, the regular expression should
not contain groupings). For sample configuration details and results, see "Example A Configuring a Custom Log File monitor without grouping" on the next page.
o
You want to process the matched rows and custom matching values (in which case, the
regular expression should contain groupings). For sample configuration details and
results, see "Example B - Configuring a Custom Log File monitor with matching custom
HP SiteScope (11.23)
Page 132 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
values (grouping)" on page 134.
o
You are running the monitor on a remote UNIX machine. For sample configuration
details and results, see "Example C - Configuring a Custom Log File monitor to run on a
remote UNIX server" on page 135.
All matched lines of the log file are processed as input data for the data processing script.
Example A - Configuring a Custom Log File monitor without grouping
n
Configure the following properties in Custom Log File Monitor Settings:
Content match: /ERROR/
n
For logs:
2012-05-01 13:40:17, ERROR - request failed
2012-05-01 13:41:55, INFO - system check complete
2012-05-01 13:43:08, INFO - new record created
2012-05-01 13:47:12, INFO
- Starting service: Event Integration Startup Task
2012-05-01 13:47:12, INFO
- Starting service: Statistics Task
2012-05-01 13:47:12, INFO
- Starting service: SQL Connection Management Service
2011-09-07 16:50:43, ERROR - Standard directory handler failed with exception
2011-09-07 16:58:01, INFO - The Heartbeat Scheduler was started
The result is the following two lines:
2012-05-01 13:40:17, ERROR - request failed
2011-09-07 16:50:43, ERROR - Standard directory handler failed with exception
HP SiteScope (11.23)
Page 133 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
Example B - Configuring a Custom Log File monitor with matching custom values
(grouping)
n
Configure the following properties in Custom Log File Monitor Settings:
Content match: /Used Memory=([0-9]*)MB Available Memory=([0-9]*)MB/
Match value label: used,available
n
For logs:
2011-09-12 16:46:23,390 [StatisticsLogger]
INFO - Used Memory=56MB
Available Memory=439MB Total Memory=496MB
Max Memory=496MB
2011-09-12 16:46:23,390 [StatisticsLogger]
INFO - PoolName=ProcessPool::perfex utilization=0.0%
avgWaitInQueueTime=0 poolMaxSize=200 execTime=0
2011-09-12 16:46:23,390 [StatisticsLogger]
INFO - PoolName=ProcessPool::perfex_dispatcher utilization=0.0%
avgWaitInQueueTime=0 poolMaxSize=200 execTime=0
2011-09-12 16:46:23,390 [StatisticsLogger]
INFO - executionCount=0 averageTime=?ms driftAverageTime=?ms
2011-09-12 16:47:23,382 [StatisticsLogger]
INFO - Used Memory=51MB
Available Memory=444MB
Max Memory=496MB
Total Memory=496MB
The result is the following two lines and values in bold (for the used and available
labels):
2011-09-12 16:46:23,390 [StatisticsLogger]
INFO - Used Memory=56MB Available Memory=439MB
Max Memory=496MB
2011-09-12 16:47:23,382 [StatisticsLogger]
INFO - Used Memory=51MB
Available Memory=444MB
Max Memory=496MB
HP SiteScope (11.23)
Total Memory=496MB
Total Memory=496MB
Page 134 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
Example C - Configuring a Custom Log File monitor to run on a remote UNIX
server
n
Configure the following properties in Custom Log File Monitor Settings:
Content match: /Used Memory=([0-9]*)MB Available Memory=([0-9]*)MB/
Match value label: used,available
Server-side processing:Selected
Return matching raw data from server-side: Not selected
n
For logs:
2011-09-12 16:46:23,390 [StatisticsLogger] INFO - Used Memory=56MB
Available Memory=439MB
Total Memory=496MB
Max Memory=496MB
2011-09-12 16:46:23,390 [StatisticsLogger] INFO - PoolName=ProcessPool::
perfex utilization=0.0% avgWaitInQueueTime=0 poolMaxSize=200 execTime=0
2011-09-12 16:46:23,390 [StatisticsLogger] INFO - PoolName=ProcessPool::
perfex_dispatcher utilization=0.0% avgWaitInQueueTime=0 poolMaxSize=200 execTime=0
2011-09-12 16:46:23,390 [StatisticsLogger] INFO
averageTime=?ms driftAverageTime=?ms
- executionCount=0
2011-09-12 16:47:23,382 [StatisticsLogger] INFO - Used Memory=51MB
Available Memory=444MB
Total Memory=496MB
Max Memory=496MB
The result is the following two lines and values in bold (for the used and available labels):
2011-09-12 16:46:23,390 [StatisticsLogger] INFO - Used Memory=56MB
Available Memory=439MB Total Memory=496MB
Max Memory=496MB
2011-09-12 16:47:23,382 [StatisticsLogger] INFO - Used Memory=51MB
Available Memory=444MB
Total Memory=496MB
Max Memory=496MB
3.
Create script parameters - optional
You can create a list of parameters that can be repeatedly used in the data processing script.
To do so, enter the parameter name and value in the Script Parameters Table.
For example, you might want to create a host, user name, and password parameter. You can
choose to hide parameter values, such as passwords, behind asterisks (*****) in the user
interface. The hide option is editable when working in template mode only.
For user interface details, see the UI Descriptions section below.
Note: By default, the maximum number of parameters allowed in the table is 10. When the
maximum number of rows is reached, no additional rows can be added. You can modify
HP SiteScope (11.23)
Page 135 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
this number by changing the Custom monitor maximum number of script parameters
value in Preferences > Infrastructure Preferences > Custom Settings. You must
restart SiteScope if you change this setting.
4.
Create the data processing script
In the Data Processing Script area, create the script that parses raw data and log match
values and creates new metrics according to the name that you determined.
For example, you could write a script that calculates sum of the system time and idle time
that are transferred as a result of log file scanning. The new metric will be displayed in the
SiteScope Dashboard as sum of overall CPU usage.
For details on the monitor configuration properties, including how to access them, and the
monitor storage and metrics names, see "How to Access the Monitor Configuration
Parameters Exposed in the Script" on page 143.
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip). A sample jar file showing the
custom monitor's capability to access Java code is provided in the <SiteScope root
directory>\examples\monitors\custom\lib folder.
For details on scripting in Java, see http://www.mozilla.org/rhino/ScriptingJava.html.
Tip:
n
A sample Custom Log File monitor script is provided in the Data Processing Script
box. To use it, you need to uncomment the script.
n
Sample scripts for all the custom monitors are available from the sample content
package located in the <SiteScope installation
directory>\examples\monitors\custom folder. CustomMonitorSamplePackage.zip
contains examples for SiteScope 11.20, and CustomMonitorsExamples_11_21.zip
contains updated examples including a Custom Database monitor with a dynamic
query, a manifest file created using the Export Content Package Wizard, and template
mail and template mail subject files, To use these scripts, you need to import the
custom monitor content package and then deploy the custom monitor template. For
task details, see steps 3 and 4 of "How to Import and Use a Custom Log File Monitor"
on page 144.
Note:
n
If your monitor needs to open a network connection to another server from the data
processing script or the Java code that is called from the script, you must enable the
HP SiteScope (11.23)
Page 136 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
Allow network access setting in Preferences > Infrastructure Preferences >
Custom Monitor Settings.
n
5.
Access for the data processing script is restricted to the following folders/files on the
SiteScope server:
o
The \conf folder which is located inside each content package (<SiteScope root
directory>\packages\imported or <SiteScope root
directory>\packages\workspace) (requires Read permissions).
o
<SiteScope root directory>\logs\custom_monitors\* (all permissions)
n
You can use the custom_monitor.log file for any info, warning, error, and debug
messages that you want to write during the execution of the script. The log is located in
<SiteScope root directory>\logs\custom_monitors. For details on changing the log
to DEBUG mode, see "Custom Monitor Logs" on page 155.
n
By default, the number of metrics that are allowed in custom monitors is 1000. You can
modify this number by changing the Maximum number of counters value in
Preferences > Infrastructure Preferences > Custom Monitor Settings.
n
When working in template mode, you can use template variables in a data processing
script.
Generate a path for storing the files used for creating the Custom Log
File monitor
Click the Create Path button to create a folder where the relevant jars, classes, configuration,
and template files required for running the monitor can be saved. A folder with a relative path is
created under <SiteScope root directory>\packages\workspace\package_<Package ID>.
The path is displayed as read only.
The folder contains the following (empty) subfolders:
n
packages\workspace\package_<>\lib. Used for storing external jar files used by the
monitor script.
n
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note
that they should be copied with the entire package folder structure.
n
packages\workspace\package_<>\conf. Used for storing configuration files,
documentation, and XML files.
n
packages\workspace\package_<>\template. Used for storing the template files that
contain the custom monitor (you perform this in "Create a monitor template - optional" on
page 139).
HP SiteScope (11.23)
Page 137 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
You can copy the required files to these folders at this stage, or when performing "Custom Log
File Monitor" on page 129.
Note: If you add or modify jars/classes after the first monitor run, you must either:
6.
n
Restart SiteScope for the changes to take effect, or
n
To avoid having to restart SiteScope, you should enable the Reload classes and jars
on each monitor run option in Preferences > Infrastructure Preferences > Custom
Monitor Settings. This option should only be used be during script development, and
should be cleared in the production stages since it impacts performance.
Configure topology reporting - optional
To report monitor and related CI topology data to BSM's RTSM, configure the required topology
reporting settings as described in How to Configure Topology Reporting for a Custom Monitor
in the Using SiteScope Guide.
7.
Configure other settings for the monitor - optional
Configure other settings for the monitor as required. For details, see Common Monitor Settings
in the Using SiteScope Guide.
8.
Save the monitor and wait for the first monitor run
Save the monitor. SiteScope verifies the correctness of the monitor configuration both locally
and on the remote server to be monitored, before saving the settings (this is regardless of
whether you clicked Verify & Save or Save).
The monitor collects data from the log files, and filters the data based on the script you
supplied.
9.
Managing custom monitors
After creating a custom monitor, you can copy, move, or delete the monitor. When doing so,
this affects the content package folder (created in the <SiteScope root
directory>\packages\workspace directory) as follows:
Action
File System Impact
Copy Monitor
Makes a copy of the content package folder in the <SiteScope root
directory>\packages\workspace folder.
Cut Monitor
No change.
HP SiteScope (11.23)
Page 138 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
10.
Action
File System Impact
Delete Monitor
If you delete the custom monitor, the content package folder is
removed from the <SiteScope root
directory>\packages\workspace folder of the SiteScope file
system.
Deploy template with
custom monitor +
content package
No change.
If a deployed monitor is copied, the content package will be copied
to the <SiteScope root directory>\packages\workspace folder of
the SiteScope file system.
Define thresholds for the metrics - optional
After the monitor has run, you can:
11.
n
Make changes to the script and define thresholds for metrics that were created or updated in
the run. For details, see Threshold Settings in the Using SiteScope Guide.
n
Check status and values of the metrics in the SiteScope Dashboard.
n
Set up alerts on the monitor. For details, see How to Configure an Alert in the Using
SiteScope Guide.
Create a monitor template - optional
a. To copy the monitor to a template, right-click the monitor, select Copy to Template, and
select the template group to which you want to add the copied configuration. For details,
see How to Create a Template by Copying Existing Configurations in the Using SiteScope
Guide.
b. Make any necessary changes such as adding template variables to the template. For
details on template variables, see New Variable Dialog Box.
12.
Create a content package - optional
a. Copy the files used for creating the monitor to the predefined content package subfolders:
o
<SiteScope>\packages\workspace\package_<Package ID>\lib. (Optional) Copy
any external jars used by the custom monitor script to this folder. Java classes from the
jar files can be accessed from the data processing script. Note that you can use this
monitor without external jars.
Note: In the data processing script, to import a package from a jar that does not
start with com., org., or java., you must add the package's prefix:
importPackage(Packages.<packageName>)
For example, importPackage(Packages.it.companyname.test);
HP SiteScope (11.23)
Page 139 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
For details on importing Java classes and packages, see
http://www.mozilla.org/rhino/ScriptingJava.html.
o
<SiteScope>\packages\workspace\package_<>\classes. (Optional) Copy the
compiled Java classes with the entire package folder structure to this folder; this is not
required if the class files were packaged in a jar that was copied to the \lib folder. The
class files can be accessed from the data processing script.
o
<SiteScope>\packages\workspace\package_<>\conf. (Optional) Copy the
configuration files, documentation, and XML files to this folder.
o
<SiteScope>\packages\workspace\package_<>\template. (Optional) The folder
should contain the template files exported from SiteScope (performed in "Create a
monitor template - optional" on the previous page). Each template can contain various
types of monitors, custom and regular.
b. Copy extension files - optional
If the monitor references script or alert extension files in the SiteScope file system, copy
them to the relevant folders in <SiteScope root
directory>\packages\workspace\extensions>:
o
\scripts. Used for storing script files that are used to run shell commands or other
scripts on the machine where SiteScope is running.
o
\scripts.remote. Used for storing script files that are used for running a script that is
stored on a remote machine.
o
\templates.mail. Used for storing the file containing the format and content of alert
messages sent by email.
o
\templates.mail.subject. Used for storing the file containing the subject line of alert
messages sent by email.
o
\templates.mib. Used for storing the MIB files that are used to create a browsable tree
that contains names and descriptions of the objects found during a traversal.
o
\templates.os. Used for storing the shell commands to be run when monitoring remote
UNIX servers.
Note:
o
On exporting the files to a content package, the unique package ID is added to the
script and template files as a suffix (before the file extension) under the relevant
folder in the SiteScope root directory.
HP SiteScope (11.23)
Page 140 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
o
As part of the import process, the template.os and templates.mib files are edited
and the unique package ID is added to some properties inside the files.
c. Export the content package to a zip file
Select the Templates context. In the template tree, right-click the template or template
container that you want to export to a content package, and select Export > Content
Package. For details on the Content Import dialog box, see Content Import Dialog Box in
the Using SiteScope Guide.
In the Export Content Package Wizard, enter details of the content package (manifest),
and select the templates and files associated with these templates to include. For Wizard
details, see Export Content Package Wizard.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
Note: The Select Files page of the Wizard displays files from the <SiteScope root
directory>\packages\workspace\package_<Package ID> and <SiteScope root
directory>\packages\workspace\extensions> folders listed above, except for the
\META-INF and \templates folders which are not displayed.
13.
Share the custom monitor with other SiteScope users - optional
You can distribute a content package zip file by:
n
Sending it to individual SiteScope users.
n
Sharing it with other SiteScope users by uploading it to the Community Content for
SiteScope page on HP Live Network (https://hpln.hp.com/group/sitescope). HP Live
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to publish content to the HP Live Network community.
How to Debug a Custom Monitor Offline
This task describes the steps involved in offline debugging of a custom monitor script using a
remote debugging environment. This makes the script development process easier, since it
enables you to complete the code and see the debugged data inside the script during the data
processing stage.
1. Prerequisites
To perform offline debugging, the Eclipse IDE with Web Tools must be installed on a local
machine.
HP SiteScope (11.23)
Page 141 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
2. In SiteScope, enable the global custom monitor debugging setting in SiteScope Preferences
Select Preferences > Infrastructure Preferences > Custom Monitor Settings, and select
the Enable custom monitor debugging check box.
3. In SiteScope, create a custom monitor with offline debugging enabled
Create a custom monitor. For details, see the previous task.
When configuring the monitor settings, expand Custom Monitor Settings, and under the Data
Processing Script section, select Enable monitor debugging.
Save the monitor.
4. Copy the Custom Monitor Debugging Eclipse project to the debugging environment
The Custom Monitor Debugging Eclipse project is available (in zip format) from:
n
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
n
The Community Content for SiteScope page on the HP Live Network
(https://hpln.hp.com/group/community-content-sitescope).
Note: Make sure you use the correct version of the Custom Monitor Debugging Eclipse
project. SiteScope 11.23 is compatible with version 2.0 of the project (SISProxy2.0.min.js).
5. Import the Custom Monitor Debugging project into Eclipse IDE
a. On the debugging environment, open Eclipse IDE and click Import.
b. Select General > Existing Project into Workspace, and click Next.
c. Select the Custom Monitor Debugging Eclipse project (zip file).
6. Copy the SiteScope Custom Monitor Data Processing Script to the Custom Monitor
Debugging project
a. Copy the content of Data Processing Script from the SiteScope custom monitor to
MonitorScript.js script.
b. Connect to the SiteScope monitor by entering the following in the DebugConfiguration.js
file:
o
host. Name of the SiteScope server.
o
port. Port used by the SiteScope server.
HP SiteScope (11.23)
Page 142 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
o
username. Username for accessing the SiteScope server.
o
password. Password to access the SiteScope server.
o
monitorPath. Full path to the custom monitor to debug in SiteScope including the
monitor name, separated by “/”. For example, Group1/Group2/Group3/Custom
Monitor Name.
7. Enable the debugger to use external jar files - optional (where the script uses external jar files)
If the monitor script uses external jar files, copy the jar files from <SiteScope root
directory>\packages\workspace\package_<Package ID>\lib to the <JRE installation
path>\lib\ext directory on the debugging environment.
8. Run the debugger
a. In the Eclipse IDE, select Debug Configuration.
b. Select Rhino JavaScript > Custom Monitor Debugging - MonitorScript.js.
c. The debugger connects to SiteScope, and runs the script within the monitor.
SiteScope returns the data to the debugger and then disconnects. This enables the
debugger to simulate the script running the same data.
9. Debug the script
Use Eclipse IDE to debug the script.
How to Access the Monitor Configuration Parameters Exposed in the
Script
Data Script:
l
You can access the configuration parameters for custom monitors in the data script using:
myContext.getInputData().getConfigurationParameter(<config param name>);
Example:
var monitorName = myContext.getInputData().getConfigurationParameter("monitorName");
The following monitor properties are exposed to the script (for all custom monitors):
n
monitorName.
The name of the monitor.
n
monitorDescription. A description of the monitor.
The following monitor properties are exposed to the script for the Custom Log File monitor only:
HP SiteScope (11.23)
Page 143 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
l
n
server.
The name of the server where the log file you want to monitor is located.
n
logFilePath.
The path of the monitor's log file.
You can set the summary string which is used as the monitor status in the SiteScope
Dashboard using:
myContext.getScriptResult().setSummary(<user's text summary>);
The default value is: summary = <a set of metrics and their values>
l
You can set monitor availability which is displayed in the SiteScope Dashboard using:
myContext.getScriptResult().setAvailability(<true/false>)
The default value is: availability = true
Topology Script:
You can access the configuration parameters for custom monitors in the topology script using:
Framework.getDestinationAttributeAsObject("configuration").get("<configuration parameter
name>")
To access data saved in the monitor storage (this is a place where you can save script data for use
in future executions):
Framework.getDestinationAttributeAsObject("monitorStorage").get("<configuration parameter
name>")
To access the list of metric names used in the script:
Framework.getDestinationAttributeAsObject("metrics")
How to Import and Use a Custom Log File Monitor
After developing a custom monitor and creating a content package zip file, the content package can
then be sent to specific users, or be published to the HP Live Network
(https://hpln.hp.com/group/sitescope) community enabling other users to import the monitor for
their own use.
For details on using the Wizard, see Export Content Package Wizard.
1.
Prerequisites
Only a SiteScope administrator user, or a user granted the Add, edit or delete templates
permissions can import monitor templates from a content package. For details, see
Permissions.
2.
Access the content package zip file
n
If a content package zip file was sent to you, skip to the next step.
n
If a content package was made available to the Community Content for SiteScope page on
HP Live Network, download the content package to your SiteScope machine. HP Live
HP SiteScope (11.23)
Page 144 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to download a template or content package from the HP Live
Network in the Using SiteScope Guide.
3.
Import the custom monitor content package
a. In SiteScope, select the Templates context. In the template tree, right-click the template
container into which you want to import the content package, and click Import.
b. In the Content Import dialog box, select Content package, and click the Browse button.
Navigate to the folder containing the package you want to import (packages are distributed
in zip format). Click Open, and then click OK. For details on the Content Import dialog box,
see Content Import Dialog Box in the Using SiteScope Guide.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
4.
Verify the template was imported successfully by checking it was
added to the template tree
The content package is copied to the <SiteScope root directory>\packages\imported
folder, and a new folder is created with the name: <Package/Zip Name>.zip_<Package ID>.
The folder contains:
n
\META-INF. Contains the manifest file where information about the content package is
stored.
n
\templates. Contains files from which templates in this content package were imported into
SiteScope.
n
<Package/Zip Name>. Uncompressed package that contains the above-mentioned
folders, the \extensions folder which contains script and alert template files referenced by
monitors in the imported templates, and the folders used for Custom monitors:
n
o
\classes. Used for storing compiled Java classes.
o
\conf Used for storing configuration files, documentation, and XML files.
o
\lib Used for storing external jar files used by the monitor script. Note that the \lib folder
is shared between all monitors imported in the same template.
<Package/Zip Name>.zip.properties. This is the descriptor (manifest) file for content
packages created in SiteScope 11.20, that is used in case of rollback, uninstall, or upgrade.
The file contains the ID of the SiteScope template that was deployed, the location of the
files in SiteScope, and other information about the content package.
HP SiteScope (11.23)
Page 145 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
The imported templates and dependency files can be used directly or modified as required.
Where script or alert templates are referenced in the user interface, the unique package ID is
added as a suffix.
Example: ShortMail alert action template referenced in the Template field.
5.
Deploy the custom monitor template
After importing the custom monitor template, you can deploy the template to a group.
a. In the template tree, right-click the custom monitor template you want to deploy, and select
Deploy Template.
b. In the Select Group dialog box, select a group into which you want to deploy the template.
Alternatively, you can click the New Group button and create a new group to which you
can deploy the template. For user interface details, see Select Group Dialog Box in the
Using SiteScope Guide.
c. In the Deployment Values dialog box, enter the required variable values in the entry boxes
displayed, and click OK. The entry boxes displayed correspond to the template variables
used in the template objects. For user interface details, see Deployment Values Dialog
Box in the Using SiteScope Guide.
Note: When deploying the template or publishing changes in the template to deployed
groups, clearing the Verify monitor properties with remote server check box in the
Deployment Values dialog box has no effect, because the monitor configuration
properties in the template must be checked against the remote server on which the
template is being deployed.
d. Verify that the template was deployed successfully (the template objects should be added
to the specified group in the monitor tree).
For task details, see How to Deploy Templates Using the User Interface in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 146 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
6.
Configure monitor status thresholds
When deploying the template, only the default metrics included with the monitor are displayed
(custom metrics defined in the script do not exist until after the monitor has run).
After the monitor run, you can define thresholds for metrics that were resolved in the run. In the
Threshold Settings panel of the custom monitor, select metrics for which you want to define
thresholds in the Condition column by using variables or free text, or selecting default metrics
from the drop-down list, and enter the value applicable to the metric parameter.
UI Descriptions
Custom Log File Monitor Settings
User interface elements are described below:
UI Element Description
Main Settings
Server
Server where the file you want to monitor is located. Select a server from the
server list (only those remote servers that have been configured in SiteScope are
displayed). Alternatively, click the Browse Servers button to select a server from
the local domain, or Add Remote Server to add a new server.
Note: If using NetBIOS to connect to other servers in an Windows domain, use
the UNC format to specify the path to the remote log file. For example, \\lab_
machine\users\SiteScopes\Version_11.2\Build_2000\SiteScope.
Note when working in template mode: You can use the template remote server
(if one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in
the local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a
remote Windows server, see How to Configure SiteScope to Monitor a Remote
Microsoft Windows Server in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 147 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
UI Element Description
Add
Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of
remote you want to add (Windows or UNIX), and enter the configuration details.
For details on the Microsoft Windows Remote Servers user interface, see
New/Edit Microsoft Windows Remote Server Dialog Box in the Using SiteScope
Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX
Remote Server Dialog Box in the Using SiteScope Guide.
Log file
path
Path to the log file you want to monitor.
l
Remote UNIX. For reading log files on remote UNIX machines, the path must
be relative to the home directory of the UNIX user account being used to log on
to the remote machine.
l
Remote Windows through NetBIOS. For reading log files on remote
Windows servers using the NetBIOS method, use UNC to specify the path to
the remote log file.
Example: \\remoteserver\sharedfolder\filename.log
l
Remote Windows through SSH. For reading log files on remote Windows
servers using the SSH method, specify the local path of the remote log file on
the remote machine.
Example:C:\Windows\System32\filename.log
You must also select the corresponding remote Windows SSH server in the
Servers box. For details on configuring a remote Windows server for SSH, see
How to Configure SiteScope to Monitor a Remote Microsoft Windows Server in
the Using SiteScope Guide.
You can also monitor files local to the server where SiteScope is running.
Example: C:\application\appLogs\access.log
Optionally, you can use special date and time regular expression variables to
match log file names that include date and time information. For example, you can
use a syntax of s/ex$shortYear$$0month$$0day$.log/ to match a current datecoded log file. For details on using regular expressions, refer to SiteScope Date
Variables in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 148 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
UI Element Description
Run alerts
Method for running alerts for this monitor.
For each log entry matched. The monitor triggers alerts according to
thresholds applied to each matching entry found. Since status can change
according to thresholds for each matched entry, each alert action could be
triggered many times within a monitor run.
l
Example: If you want to send a warning alert on matched text value "power off"
and an error alert if more than one server is turned off, set the following
thresholds:
n
Error if matchCount > 1
n
Warning if value == 'power off'
To send an error alert if only one threshold is matched, set Error if value
== 'power off'.
For details on how to create a Custom Log File monitor that triggers
customized alerts for content matches, see "Customizing Custom Log File
Content Matches and Monitor Alerts" on page 131.
l
Once, after all log entries have been checked. The monitor counts up the
number of matches and then triggers alerts.
Note: The status category is resolved according to the last content that matched
the regular expression. If the last matched content does not meet the threshold
metric, an alert is not triggered.
Check
from
beginning
File checking option for this monitor instance. This setting controls what
SiteScope looks for and how much of the target file is checked each time that the
monitor is run.
l
Never. Checks newly added records only.
l
First time only. Checks the whole file once, and then newly added records
only.
l
Always. Always checks the whole file.
Default value: Never
HP SiteScope (11.23)
Page 149 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
UI Element Description
Content
match
Text to look for in the log entries. You can also use a regular expression in this
entry to match text patterns. Unlike the content match function of other SiteScope
monitors, the Custom Log File monitor content match is run repeatedly against the
most recent content of the target log file until all matches are found. This means
the monitor not only reports if the match was found but also how many times the
matched pattern was found. To match text that includes more than one line of text,
add an s search modifier to the end of the regular expression. For details, see
Regular Expressions Overview in the Using SiteScope Guide.
Open Tool
Opens the Regular Expression Tool, enabling you to test a regular expression for
content matching against a sample of the content you want to monitor. For details,
see Regular Expression Tool in the Using SiteScope Guide.
Advanced Settings
Log file
encoding
If the log file content to be monitored uses an encoding that is different than the
encoding used on the server where SiteScope is running, select the code page or
encoding to use. This may be necessary if the code page which SiteScope is
using does not support the character sets used in the target log file. This enables
SiteScope to match and display the encoded log file content correctly.
Default value: windows-1252
Rules file
path
Enter the full path to your rules file. In special cases, it may be necessary to create
a custom rules file to specify different alerts for different log entry matches. You
can also set a parameter in the rules file to run script alerts. You can use any of the
properties in the SiteScope Alert Template and Event Properties Directory.
An example rules file is located in <SiteScope root directory>\examples\log_
monitor\sample.rules. For instructions on how to use the file and example rules,
see "How to Use the Rules File" on page 354, or read the instructions in the file
itself.
Match
value
labels
Use to enter labels for the matched values found in the target log file. The match
value labels are used as variables to access retained values from the Content
match expression for use with the Data Processing Script. Separate multiple
labels with a comma (,).
Note: If match value labels are not used, the matched values are named value1,
value2, and so forth.
Multi-line
match
Runs a regular expression match on multiple lines of text.
Default value: Not selected
HP SiteScope (11.23)
Page 150 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
UI Element Description
ServerProcesses log file data on the server-side. Benefits include low memory usage and
side
low CPU utilization on the SiteScope server, and faster monitor run. Server-side
processing processing does however cause high CPU utilization on the remote server when
processing the file.
Default value: Not selected (we recommend using this option only if SiteScope
performance is affected by large amounts of data being appended to the target log
file between monitor runs, and the Log File monitor is performing badly in regular
mode).
Note:
l
Server-side processing is available for remote Linux, Red Hat Enterprise Linux,
and Oracle Solaris servers only. Windows SSH is not supported.
l
Rule files are not supported in this mode.
l
The encoding for the remote server must be Unicode, or match the encoding of
the log file (if the remote file is in Unicode charset).
Return
matching
raw data
from
server-side
Returns the whole row of raw data with matching patterns from the server-side
when a match is found.
No error if
file not
found
Monitor remains in Good status if the file is not found. The monitor status remains
Good regardless of the monitor threshold configuration.
Default value: Not selected
Note: This setting is only available when Server-side processing is selected.
Default value: Not selected
Timeout Settings
Enable
timeout
The monitor stops its run after the specified timeout period has been exceeded.
After
timeout,
resume
reading
from end
of file
If selected, the monitor resumes reading from the end of the log file during the next
run, instead of from the current location.
Default value: Not selected
Default value: Not selected
Note: This setting is only available when Enable timeout is selected.
HP SiteScope (11.23)
Page 151 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
UI Element Description
Status
after
timeout
The status condition that the monitor goes into if the monitor times out.
The status categories include: Error, Warning, Good
Default value: Warning
Note: This setting is only available when Enable timeout is selected.
Timeout
(seconds)
Amount of time, in seconds, that SiteScope should wait before the monitor times
out.
Default value: 60 seconds
Note: This setting is only available when Enable timeout is selected.
Script Parameters Table
Add Parameter. Adds a new line to the Script Parameters table, enabling you to
define parameters for use in the custom monitor script.
Delete Parameter. Deletes the selected parameter.
Parameter
Name
The name assigned to the parameter. All parameter names must be different.
Parameter
Value
The parameter value.
Hide Value
Select to hide the parameter value in the Script Parameters table and in the
custom monitor script. The value is masked behind asterisks (*****).
If you want to hide a parameter value such as a password, select the Hide Value
check box. The value is masked behind asterisks (*****) in the user interface.
This option is useful for an administrator in SiteScope when creating custom
monitor templates, since it enables the monitor to be deployed without the
parameter value being displayed in the monitor view.
Default value: Not selected
Note: The hide option is editable when working in template mode only.
Data Processing Script
HP SiteScope (11.23)
Page 152 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
UI Element Description
<Script>
The input data for the data processing script is displayed in this box.
Define the script that parses the results and creates new metrics. For details on
the monitor configuration properties in the script, including how to access them,
and the monitor storage and metrics names, see "How to Access the Monitor
Configuration Parameters Exposed in the Script" on page 143.
Note: By default, the number of metrics that are allowed in custom monitors is
1000. You can modify this number by changing the Maximum number of
counters value in Preferences > Infrastructure Preferences > Custom
Monitor Settings.
Package
path
Path generated by SiteScope where the files used for developing the monitor can
be saved. This enables you to add the jars on which the monitor depends (if
applicable), classes, configuration, and templates files to the monitor. The path is
displayed as read only.
Click the Create Path button to create a folder with a relative path in the
SiteScope root directory (packages\workspace\package_<unique ID>). The
path is displayed as read only.
The folder contains the following subfolders into which you copy the files used to
create the monitor:
l
lib. (Optional) Used for storing external jar files used by the monitor script. Note
that you can use this monitor without external jars.
l
classes. (Optional) Used for storing Java compiled classes; note that they
should be copied with the entire package folder structure.
l
conf. (Optional) Used for storing configuration files, documentation, and XML
files.
l
template. (Mandatory) Used for storing the template files that contain the
custom monitor. It must contain at least one template. Each template can
contain various types of monitors; custom and regular.
Note: This field is displayed when working in monitor mode only. When working in
template mode and the monitor is deployed, the content pack is imported into the
path.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Custom Log File monitor.
HP SiteScope (11.23)
Page 153 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
l
"General Tips/Limitations" below
l
"Custom Monitor Logs" on the next page
General Tips/Limitations
l
If a user-defined or imported Java package has the same name as an existing SiteScope or
standard Java package, SiteScope ignores the user-defined/imported Java package.
l
When setting custom monitor metrics with a string (non-numeric) value, the maximum and
average values in the Measurement Summary table of the Management Report are shown as
'n/a'. This also occurs if you change the metric value type, for example, if you set the metric with
a numeric value, and later change it to a string value or vice versa.
l
When deploying a custom monitor using a template, clearing the Verify monitor properties
with remote server check box in the Deployment Values dialog box has no effect, because the
monitor configuration properties in the template must be checked against the remote server on
which the template is being deployed.
l
When publishing changes to a template that contains a custom monitor, we recommend using
the Disable custom monitors while publishing changes option (selected by default) in
Preferences > Infrastructure Preferences > Custom Monitor Settings. The monitor is
temporarily disabled before changes are published and is restored to the enabled state after
changes have been made.
l
Setting status thresholds using a baseline is not supported on user-defined metrics.
l
You can use third-party .jar files without removing the JVM security from the registry by adding
the _scriptSandboxRuntimePermissions property to the <SiteScope root
directory>;\groups\ master.config file, and specifying the permitted jar files. For example, to
use signed libraries jopcagtbase.jar and jopcagtmsg.jar, configure the parameter as
follows: _scriptSandboxRuntimePermissions=loadLibrary.jopcagtbase,
loadLibrary.jopcagtmsg.
For the types of runtime permissions that can be used, see Runtime Permission class in the
Java API documentation
(http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimePermission.html).
l
This monitor supports monitoring remote servers running on HP NonStop operating systems.
For details on enabling the HP NonStop operating system monitoring environment, see "How to
Configure the HP NonStop Resources Monitor" on page 307.
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
When monitoring a log file on a FreeBSD remote server, make sure the correct path to the "cat"
command is used in <SiteScope root directory>\templates.os\FreeBSD.config, since the
command was moved in the latest FreeBSD versions.
HP SiteScope (11.23)
Page 154 of 926
Monitor Reference
Chapter 18: Custom Log File Monitor
Custom Monitor Logs
l
Errors in the monitor (including errors in the script) are written to the SiteScope logs in the same
way as for any other monitor. Check the error.log and RunMonitor.log files.
l
Error messages from the script are displayed in the custom_monitor.log file located in
<SiteScope root directory>\logs\custom_monitors. This log can be used for info, warning,
error, and debug messages from running the script.
To change the log level to DEBUG mode, in <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava\log4j.properties, change ${loglevel} to
DEBUG in the following paragraph:
# Custom monitors category
log4j.category.CustomMonitor=${loglevel},custom.monitor.appender
log4j.additivity.CustomMonitor=false change
HP SiteScope (11.23)
Page 155 of 926
Chapter 19: Custom WMI Monitor
The Custom WMI monitor broadens the capabilities of monitors that support the Windows
Management Instrumentation (WMI) method for collecting data by checking the availability and
performance of management data on Windows-based operating systems. You can create your own
WMI monitor by developing WMI Query Language (WQL) queries that collect data, and a script that
processes the collected data and creates metrics. You can use Java code developed by yourself or
by a third-party to process the data.
You can share custom monitors by publishing them to the HP Live Network community, enabling
other SiteScope users to import the monitor template for their own use.
Tip: You can view guided and narrated demonstrations for using the WMI Custom monitor on
the HP Videos channel on YouTube:
l
Custom WMI Monitor Creation Process and Packaging http://www.youtube.com/watch?v=bB6NlTGdd88
l
Custom WMI Monitor Data Processing Script http://www.youtube.com/watch?v=GIw3JVnunWE
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Custom WMI monitor.
Learn About
Custom WMI Monitor Overview
The Custom WMI monitor enables you to develop your own monitors on top of the SiteScope
infrastructure. This provides you with greater flexibility not available in existing monitors.
You can use the Custom WMI monitor to:
l
Collect any WMI data you like
You can create a series of pre-defined WQL queries for the Windows operating systems you
want to monitor. SiteScope runs the queries and returns the results to the monitor in an object
that contains a set of results for each query. Each time the monitor runs, it re-runs your queries
and collects fresh data.
l
Process the collected data
You can create a script in the monitor that can extract and process the results of the collected
data. For example, you can define metrics based on collected data from the Windows operating
system or perform mathematical operations on it as in the sample script provided.
HP SiteScope (11.23)
Page 156 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip).
l
Collect data dynamically
You can include dynamically-defined queries in the data processing script. These queries are
executed while the script is running, in contrast to predefined queries, which are executed before
the script is run. Dynamically-executed queries provide the added benefit of enabling you to
create queries based on values that are not in the monitored entity data store (for example,
timestamp), create queries based on previous query results or calculations, and include
variables in queries. For details, see Data Processing Script with Dynamic Queries in the Using
SiteScope Guide.
l
Debug custom monitors offline
You can perform offline debugging of a custom monitor script using a remote debugging server.
This makes the script development process easier, since it enables you to complete the code
and see the debugged data inside the script during the data processing stage. For details, see
"How to Debug a Custom Monitor Offline" on page 165.
After developing the monitor, you can:
l
Define thresholds for new metrics
Because some metrics are defined only during a script run, you cannot define thresholds for
them in advance. After the script has run for the first time and the metrics have been defined,
you can then define thresholds for them. This provides more advanced data processing options
than regular monitors. Note that metrics can change between script runs, for example, where
variables are used in metric names. Thresholds using a metric that does not exist after the
monitor run are removed automatically.
l
Share the monitor with other SiteScope users
After developing the monitor, you can export the monitor to a template, add external jars and/or
classes if the monitor depends on them, and create a content package. The content package
can then be sent to specific users, or shared with other SiteScope users by publishing it to the
SiteScope community on HP Live Network (https://hpln.hp.com/group/sitescope).
By sharing knowledge with other SiteScope users, you can benefit from extended SiteScope
monitor coverage and the development of new monitors outside the SiteScope release cycle.
HP SiteScope (11.23)
Page 157 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
Tasks
This section includes:
l
"How to Develop the Custom WMI Monitor" below
l
"How to Debug a Custom Monitor Offline" on page 165
l
"How to Access the Monitor Configuration Parameters Exposed in the Script" on page 167
l
"How to Import and Use a Custom WMI Monitor" on page 168
How to Develop the Custom WMI Monitor
1.
Prerequisites
n
You should be an advanced SiteScope user with knowledge of writing scripts in JavaScript,
and have knowledge of WMI and WQL.
n
The following are requirements for using SiteScope to collect performance measurements
on a remote machine using WMI:
o
The WMI service must be running on the remote machine. For details, refer to the
Windows Management Instrumentation documentation (http://msdn.microsoft.com/enus/library/aa826517(VS.85).aspx).
o
The user defined for the WMI remote server must have permissions to read statistics
remotely from any name space that they use in the queries. For details, refer to
http://support.microsoft.com/kb/295292.
For information about troubleshooting WMI service problems, see
"Tips/Troubleshooting" on page 173.
2.
Create a Custom WMI monitor with the relevant queries
a. Create a group into which you want to add the custom monitor. Right-click the group,
select New > Monitor, and select the Custom WMI monitor.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the Custom WMI Monitor Settings panel, select the server that you want to monitor
(only those Windows remote servers configured with a WMI connection are available).
d. In the WMI Queries Table, enter the WQL queries and the WMI namespace on which you
want to perform the queries.
Tip: By default, you can enter up to 10 queries in the table. You can modify the number
of queries that can be added to the table in Preferences > Infrastructure Preferences
HP SiteScope (11.23)
Page 158 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
> Custom Monitor Settings by configuring the Maximum number of queries
value.
For user interface details, see the UI Descriptions section below.
Example
These queries collect processor performance and memory data from the monitored
server.
3.
No. Queries
Namespace
0
Select PercentProcessorTime,Timestamp_Sys100NS From
Win32_PerfRawData_PerfOS_Processor
root\cimv2
1
Select PercentProcessorTime,Timestamp_Sys100NS From
Win32_PerfRawData_PerfOS_Processor
root\cimv2
Create script parameters - optional
You can create a list of parameters that can be repeatedly used in the data processing script.
To do so, enter the parameter name and value in the Script Parameters Table.
For example, you might want to create a host, user name, and password parameter. You can
choose to hide parameter values, such as passwords, behind asterisks (*****) in the user
interface. The hide option is editable when working in template mode only.
For user interface details, see the UI Descriptions section below.
Note: By default, the maximum number of parameters allowed in the table is 10. When the
maximum number of rows is reached, no additional rows can be added. You can modify
this number by changing the Custom monitor maximum number of script parameters
value in Preferences > Infrastructure Preferences > Custom Settings. You must
restart SiteScope if you change this setting.
4.
Create the data processing script
In the Data Processing Script area of Custom WMI Monitor Settings, create the script that
parses the results and creates new metrics according to the name that you determined.
In addition, you can include any number of queries in the script. The queries are executed as
the script is run, which means that the monitor collects fresh data from the Windows operating
system being monitored. After the data is retrieved, it becomes available for the script to use. A
query in a script has the same syntax as a query defined in the queries table, but it can be
structured using variables which makes it dynamic within the monitor run context. For details
HP SiteScope (11.23)
Page 159 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
on dynamic queries, see Data Processing Script with Dynamic Queries in the Using SiteScope
Guide.
For details on the monitor configuration properties, including how to access them, and the
monitor storage and metrics names, see "How to Access the Monitor Configuration
Parameters Exposed in the Script" on page 167.
For details on the methods and classes that are available in the script, see the HP SiteScope
Custom Monitor API Reference (available from <SiteScope installation
directory>\examples\monitors\custom\doc\javadoc.zip). A sample jar file showing the
custom monitor's capability to access Java code is provided in the <SiteScope root
directory>\examples\monitors\custom\lib folder.
For details on scripting in Java, see http://www.mozilla.org/rhino/ScriptingJava.html.
Tip:
n
A sample Custom WMI monitor script is provided in the Data Processing Script box.
To use it, you need to uncomment the script.
n
Sample scripts for all the custom monitors are available from the sample content
package located in the <SiteScope installation
directory>\examples\monitors\custom folder. CustomMonitorSamplePackage.zip
contains examples for SiteScope 11.20, and CustomMonitorsExamples_11_21.zip
contains updated examples including a Custom Database monitor with a dynamic
query, a manifest file created using the Export Content Package Wizard, and template
mail and template mail subject files. To use these scripts, you need to import the
custom monitor content package and then deploy the custom monitor template. For
task details, see steps 3 and 4 of "How to Import and Use a Custom WMI Monitor" on
page 168.
Note:
n
If your monitor needs to open a network connection to another server from the data
processing script or the Java code that is called from the script, you must enable the
Allow network access setting in Preferences > Infrastructure Preferences >
Custom Monitor Settings.
n
Access for the data processing script is restricted to the following folders/files on the
SiteScope server:
o
The \conf folder which is located inside each content package (<SiteScope root
directory>\packages\imported or <SiteScope root
directory>\packages\workspace) (requires Read permissions).
o
<SiteScope root directory>\logs\custom_monitors\* (all permissions)
HP SiteScope (11.23)
Page 160 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
5.
n
You can use the custom_monitor.log file for any info, warning, error, and debug
messages that you want to write during the execution of the script. The log is located in
<SiteScope root directory>\logs\custom_monitors. For details on changing the log
to DEBUG mode, see "Custom Monitor Logs" on page 175.
n
By default, the number of metrics that are allowed in custom monitors is 1000. You can
modify this number by changing the Maximum number of counters value in
Preferences > Infrastructure Preferences > Custom Monitor Settings.
n
When working in template mode, you can use template variables in a data processing
script.
Generate a path for storing the files used for creating the Custom WMI
monitor
Click the Create Path button to create a folder where the relevant jars, classes, configuration,
and template files required for running the monitor can be saved. A folder with a relative path is
created under <SiteScope root directory>\packages\workspace\package_<Package ID>.
The path is displayed as read only.
The folder contains the following (empty) subfolders:
n
packages\workspace\package_<>\lib. Used for storing external jar files used by the
monitor script.
n
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note
that they should be copied with the entire package folder structure.
n
packages\workspace\package_<>\conf. Used for storing configuration files,
documentation, and XML files.
n
packages\workspace\package_<>\template. Used for storing the template files that
contain the custom monitor (you perform this in "Custom WMI Monitor" on page 156).
You can copy the required files to these folders at this stage, or when performing "Custom
WMI Monitor" on page 156.
Note: If you add or modify jars/classes after the first monitor run, you must either:
n
Restart SiteScope for the changes to take effect, or
n
To avoid having to restart SiteScope, you should enable the Reload classes and jars
on each monitor run option in Preferences > Infrastructure Preferences > Custom
Monitor Settings. This option should only be used be during script development, and
should be cleared in the production stages since it impacts performance.
HP SiteScope (11.23)
Page 161 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
6.
Configure topology reporting - optional
To report monitor and related CI topology data to BSM's RTSM, configure the required topology
reporting settings as described in How to Configure Topology Reporting for a Custom Monitor
in the Using SiteScope Guide.
7.
Configure other settings for the monitor - optional
Configure other settings for the monitor as required. For details, see Common Monitor Settings
in the Using SiteScope Guide.
8.
Save the monitor and wait for the first monitor run
Save the monitor. SiteScope verifies the correctness of the monitor configuration locally and
on the remote server to be monitored, before saving the settings, regardless of whether you
click the Verify & Save or Save button.
The monitor collects data from the Windows operating system, and filters the data based on
the script you supplied.
9.
Managing custom monitors
After creating a custom monitor, you can copy, move, or delete the monitor. When doing so,
this affects the content package folder (created in the <SiteScope root
directory>\packages\workspace directory) as follows:
10.
Action
File System Impact
Copy Monitor
Makes a copy of the content package folder in the <SiteScope root
directory>\packages\workspace folder.
Cut Monitor
No change.
Delete Monitor
If you delete the custom monitor, the content package folder is
removed from the <SiteScope root
directory>\packages\workspace folder of the SiteScope file
system.
Deploy template with
custom monitor +
content package
No change.
If a deployed monitor is copied, the content package will be copied
to the <SiteScope root directory>\packages\workspace folder of
the SiteScope file system.
Define thresholds for the metrics - optional
After the monitor has run, you can:
n
Make changes to the script and define thresholds for metrics that were created or updated in
the run. For details, see Threshold Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 162 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
11.
n
Check status and values of the metrics in the SiteScope Dashboard.
n
Set up alerts on the monitor. For details, see How to Configure an Alert in the Using
SiteScope Guide.
Create a monitor template - optional
a. To copy the monitor to a template, right-click the monitor, select Copy to Template, and
select the template group to which you want to add the copied configuration. For details,
see How to Create a Template by Copying Existing Configurations in the Using SiteScope
Guide.
b. Make any necessary changes such as adding template variables to the template. For
details on template variables, see New Variable Dialog Box.
12.
Create a content package - optional
a. Copy the files used for creating the monitor to the predefined content package subfolders:
o
<SiteScope>\packages\workspace\package_<Package ID>\lib. (Optional) Copy
any external jars used by the custom monitor script to this folder. Java classes from the
jar files can be accessed from the data processing script. Note that you can use this
monitor without external jars.
Note: In the data processing script, to import a package from a jar that does not
start with com., org., or java., you must add the package's prefix:
importPackage(Packages.<packageName>)
For example, importPackage(Packages.it.companyname.test);
For details on importing Java classes and packages, see
http://www.mozilla.org/rhino/ScriptingJava.html.
o
<SiteScope>\packages\workspace\package_<>\classes. (Optional) Copy the
compiled Java classes with the entire package folder structure to this folder; this is not
required if the class files were packaged in a jar that was copied to the \lib folder. The
class files can be accessed from the data processing script.
o
<SiteScope>\packages\workspace\package_<>\conf. (Optional) Copy the
configuration files, documentation, and XML files to this folder.
o
<SiteScope>\packages\workspace\package_<>\template. (Optional) The folder
should contain the template files exported from SiteScope (performed in "Custom WMI
Monitor" on page 156). Each template can contain various types of monitors, custom
and regular.
b. Copy extension files - optional
HP SiteScope (11.23)
Page 163 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
If the monitor references script or alert extension files in the SiteScope file system, copy
them to the relevant folders in <SiteScope root
directory>\packages\workspace\extensions>:
o
\scripts. Used for storing script files that are used to run shell commands or other
scripts on the machine where SiteScope is running.
o
\scripts.remote. Used for storing script files that are used for running a script that is
stored on a remote machine.
o
\templates.mail. Used for storing the file containing the format and content of alert
messages sent by email.
o
\templates.mail.subject. Used for storing the file containing the subject line of alert
messages sent by email.
o
\templates.mib. Used for storing the MIB files that are used to create a browsable tree
that contains names and descriptions of the objects found during a traversal.
o
\templates.os. Used for storing the shell commands to be run when monitoring remote
UNIX servers.
Note:
o
On exporting the files to a content package, the unique package ID is added to the
script and template files as a suffix (before the file extension) under the relevant
folder in the SiteScope root directory.
o
As part of the import process, the template.os and templates.mib files are edited
and the unique package ID is added to some properties inside the files.
c. Export the content package to a zip file
Select the Templates context. In the template tree, right-click the template or template
container that you want to export to a content package, and select Export > Content
Package. For details on the Content Import dialog box, see Content Import Dialog Box in
the Using SiteScope Guide.
In the Export Content Package Wizard, enter details of the content package (manifest),
and select the templates and files associated with these templates to include. For Wizard
details, see Export Content Package Wizard.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 164 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
Note: The Select Files page of the Wizard displays files from the <SiteScope root
directory>\packages\workspace\package_<Package ID> and <SiteScope root
directory>\packages\workspace\extensions> folders listed above, except for the
\META-INF and \templates folders which are not displayed.
13.
Share the custom monitor with other SiteScope users - optional
You can distribute a content package zip file by:
n
Sending it to individual SiteScope users.
n
Sharing it with other SiteScope users by uploading it to the Community Content for
SiteScope page on HP Live Network (https://hpln.hp.com/group/sitescope). HP Live
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to publish content to the HP Live Network community.
How to Debug a Custom Monitor Offline
This task describes the steps involved in offline debugging of a custom monitor script using a
remote debugging environment. This makes the script development process easier, since it
enables you to complete the code and see the debugged data inside the script during the data
processing stage.
1. Prerequisites
To perform offline debugging, the Eclipse IDE with Web Tools must be installed on a local
machine.
2. In SiteScope, enable the global custom monitor debugging setting in SiteScope Preferences
Select Preferences > Infrastructure Preferences > Custom Monitor Settings, and select
the Enable custom monitor debugging check box.
3. In SiteScope, create a custom monitor with offline debugging enabled
Create a custom monitor. For details, see the previous task.
When configuring the monitor settings, expand Custom Monitor Settings, and under the Data
Processing Script section, select Enable monitor debugging.
Save the monitor.
4. Copy the Custom Monitor Debugging Eclipse project to the debugging environment
The Custom Monitor Debugging Eclipse project is available (in zip format) from:
HP SiteScope (11.23)
Page 165 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
n
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
n
The Community Content for SiteScope page on the HP Live Network
(https://hpln.hp.com/group/community-content-sitescope).
Note: Make sure you use the correct version of the Custom Monitor Debugging Eclipse
project. SiteScope 11.23 is compatible with version 2.0 of the project (SISProxy2.0.min.js).
5. Import the Custom Monitor Debugging project into Eclipse IDE
a. On the debugging environment, open Eclipse IDE and click Import.
b. Select General > Existing Project into Workspace, and click Next.
c. Select the Custom Monitor Debugging Eclipse project (zip file).
6. Copy the SiteScope Custom Monitor Data Processing Script to the Custom Monitor
Debugging project
a. Copy the content of Data Processing Script from the SiteScope custom monitor to
MonitorScript.js script.
b. Connect to the SiteScope monitor by entering the following in the DebugConfiguration.js
file:
o
host. Name of the SiteScope server.
o
port. Port used by the SiteScope server.
o
username. Username for accessing the SiteScope server.
o
password. Password to access the SiteScope server.
o
monitorPath. Full path to the custom monitor to debug in SiteScope including the
monitor name, separated by “/”. For example, Group1/Group2/Group3/Custom
Monitor Name.
7. Enable the debugger to use external jar files - optional (where the script uses external jar files)
If the monitor script uses external jar files, copy the jar files from <SiteScope root
directory>\packages\workspace\package_<Package ID>\lib to the <JRE installation
path>\lib\ext directory on the debugging environment.
8. Run the debugger
HP SiteScope (11.23)
Page 166 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
a. In the Eclipse IDE, select Debug Configuration.
b. Select Rhino JavaScript > Custom Monitor Debugging - MonitorScript.js.
c. The debugger connects to SiteScope, and runs the script within the monitor.
SiteScope returns the data to the debugger and then disconnects. This enables the
debugger to simulate the script running the same data.
9. Debug the script
Use Eclipse IDE to debug the script.
How to Access the Monitor Configuration Parameters Exposed in the
Script
Data Script:
l
You can access the configuration parameters for custom monitors in the data script using:
myContext.getInputData().getConfigurationParameter("<configuration parameter name>");
Example:
var monitorName = myContext.getInputData().getConfigurationParameter("monitorName");
The following monitor properties are exposed to the script (for all custom monitors):
n
monitorName.
The name of the monitor.
n
monitorDescription.
A description of the monitor.
The following monitor properties are exposed to the script for the Custom WMI monitor only:
n
l
server.
The name of the server from which you want to collect the data.
You can set the summary string which is used as the monitor status in the SiteScope
Dashboard using:
myContext.getScriptResult().setSummary(<user's text summary>);
The default value is: summary = <a set of metrics and their values>
l
You can set monitor availability which is displayed in the SiteScope Dashboard using:
myContext.getScriptResult().setAvailability(<true/false>)
The default value is: availability = true
Topology Script:
You can access the configuration parameters for custom monitors in the topology script using:
HP SiteScope (11.23)
Page 167 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
Framework.getDestinationAttributeAsObject("configuration").get("<configuration parameter
name>")
To access data saved in the monitor storage (this is a place where you can save script data for use
in future executions):
Framework.getDestinationAttributeAsObject("monitorStorage").get("<configuration parameter
name>")
To access the list of metric names used in the script:
Framework.getDestinationAttributeAsObject("metrics")
How to Import and Use a Custom WMI Monitor
After developing a custom monitor and creating a content package zip file, the content package can
then be sent to specific users, or be published to the HP Live Network
(https://hpln.hp.com/group/sitescope) community enabling other users to import the monitor for
their own use.
For details on using the Wizard, see Export Content Package Wizard.
1.
Prerequisites
Only a SiteScope administrator user, or a user granted the Add, edit or delete templates
permissions can import monitor templates from a content package. For details, see
Permissions.
2.
Access the custom monitor content package zip file
n
If a content package zip file was sent to you, skip to the next step.
n
If a content package was made available to the Community Content for SiteScope page on
HP Live Network, download the content package to your SiteScope machine. HP Live
Network is an online community providing a central location for HP customers to share
information and learn about add-on content, extensions and related activities across the HP
Software portfolio.
For task details, see How to download a template or content package from the HP Live
Network in the Using SiteScope Guide.
3.
Import the custom monitor content package
a. In SiteScope, select the Templates context. In the template tree, right-click the template
container into which you want to import the content package, and click Import.
b. In the Content Import dialog box, select Content package, and click the Browse button.
Navigate to the folder containing the package you want to import (packages are distributed
in zip format). Click Open, and then click OK. For details on the Content Import dialog box,
see Content Import Dialog Box in the Using SiteScope Guide.
For task details, see How to Create, Export, and Import a Custom Monitor Content
Package and How to Create, Export, and Import a Template Extension Content Package
in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 168 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
4.
Verify the template was imported successfully by checking it was
added to the template tree
The content package is copied to the <SiteScope root directory>\packages\imported
folder, and a new folder is created with the name: <Package/Zip Name>.zip_<Package ID>.
The folder contains:
n
\META-INF. Contains the manifest file where information about the content package is
stored.
n
\templates. Contains files from which templates in this content package were imported into
SiteScope.
n
<Package/Zip Name>. Uncompressed package that contains the above-mentioned
folders, the \extensions folder which contains script and alert template files referenced by
monitors in the imported templates, and the folders used for Custom monitors:
n
o
\classes. Used for storing compiled Java classes.
o
\conf Used for storing configuration files, documentation, and XML files.
o
\lib Used for storing external jar files used by the monitor script. Note that the \lib folder
is shared between all monitors imported in the same template.
<Package/Zip Name>.zip.properties. This is the descriptor (manifest) file for content
packages created in SiteScope 11.20, that is used in case of rollback, uninstall, or upgrade.
The file contains the ID of the SiteScope template that was deployed, the location of the
files in SiteScope, and other information about the content package.
The imported templates and dependency files can be used directly or modified as required.
Where script or alert templates are referenced in the user interface, the unique package ID is
added as a suffix.
Example: ShortMail alert action template referenced in the Template field.
HP SiteScope (11.23)
Page 169 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
5.
Deploy the custom monitor template
After importing the custom monitor template, you can deploy the template to a group.
a. In the template tree, right-click the custom monitor template you want to deploy, and select
Deploy Template.
b. In the Select Group dialog box, select a group into which you want to deploy the template.
Alternatively, you can click the New Group button and create a new group to which you
can deploy the template. For user interface details, see Select Group Dialog Box in the
Using SiteScope Guide.
c. In the Deployment Values dialog box, enter the required variable values in the entry boxes
displayed, and click OK. The entry boxes displayed correspond to the template variables
used in the template objects. For user interface details, see Deployment Values Dialog
Box in the Using SiteScope Guide.
Note: When deploying the template or publishing changes in the template to deployed
groups, clearing the Verify monitor properties with remote server check box in the
Deployment Values dialog box has no effect, because the monitor configuration
properties in the template must be checked against the remote server on which the
template is being deployed.
d. Verify that the template was deployed successfully (the template objects should be added
to the specified group in the monitor tree).
For task details, see How to Deploy Templates Using the User Interface in the Using
SiteScope Guide.
6.
Configure monitor status thresholds
When deploying the template, only the default metrics included with the monitor are displayed
(custom metrics defined in the script do not exist until after the monitor has run).
After the monitor run, you can define thresholds for metrics that were resolved in the run. In the
Threshold Settings panel of the custom monitor, select metrics for which you want to define
thresholds in the Condition column by using variables or free text, or selecting default metrics
from the drop-down list, and enter the value applicable to the metric parameter.
UI Descriptions
Custom WMI Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
HP SiteScope (11.23)
Page 170 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
UI Element
Description
Server
Name of the server that you want to monitor. Select a server from the server list
(only those Windows remote servers that have been configured in SiteScope with
a WMI connection are displayed). Alternatively, click the Add Remote Server
button to add a new server.
Note: When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to
enter the configuration details. For user interface details, see "New/Edit Microsoft
Windows Remote Server Dialog Box" in the Using SiteScope Guide.
Note: In the Add Microsoft Windows Remote Server dialog box, the Method field
is automatically set to WMI (and cannot be changed), since this monitor can only
use a Windows remote server configured with a WMI connection.
Script Parameters Table
Add Parameter. Adds a new line to the Script Parameters table, enabling you to
define parameters for use in the custom monitor script.
Delete Parameter. Deletes the selected parameter.
Parameter
Name
The name assigned to the parameter. All parameter names must be different.
Parameter
Value
The parameter value.
Hide Value
Select to hide the parameter value in the Script Parameters table and in the
custom monitor script. The value is masked behind asterisks (*****).
If you want to hide a parameter value such as a password, select the Hide Value
check box. The value is masked behind asterisks (*****) in the user interface.
This option is useful for an administrator in SiteScope when creating custom
monitor templates, since it enables the monitor to be deployed without the
parameter value being displayed in the monitor view.
Default value: Not selected
Note: The hide option is editable when working in template mode only.
WMI Queries Table
New query. Adds a new line to the WMI queries table, enabling you to enter a
new query.
Edit query. Opens the Query Editor, in which the selected WMI query is
displayed and can be edited.
HP SiteScope (11.23)
Page 171 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
UI Element
Description
Delete query. Enables you to delete the selected query.
No
The query number. By default, you can add up to 10 queries to the table. The
queries are run in the order in which they appear in the table.
Note: You can modify the number of queries that can be added to the table by
changing the Maximum number of queries value in Preferences >
Infrastructure Preferences > Custom Monitor Settings.
Queries
Enter the WMI query you want to use. You can create or edit a query in the table
(in line mode), or in the Query Editor. To open the Query Editor, click the Edit
query button. It is recommended to use the Query Editor when adding or viewing
long queries.
Namespace Enter the WMI namespace on which you want to perform the WQL query. Each
namespace holds classes that expose different types of information.
Example: root\cimv2
Data Processing Script
<Script>
The input data for the data processing script is displayed in this box.
Define the script that parses the results and creates new metrics. For details on
the monitor configuration properties in the script, including how to access them,
and the monitor storage and metrics names, see "How to Access the Monitor
Configuration Parameters Exposed in the Script" on page 167.
Note: By default, the number of metrics that are allowed in custom monitors is
1000. You can modify this number by changing the Maximum number of
counters value in Preferences > Infrastructure Preferences > Custom
Monitor Settings.
HP SiteScope (11.23)
Page 172 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
UI Element
Description
Package
path
Path generated by SiteScope where the files used for developing the monitor can
be saved. This enables you to add the jars on which the monitor depends (if
applicable), classes, configuration, and templates files to the monitor. The path is
displayed as read only.
Click the Create Path button to create a folder with a relative path in the
SiteScope root directory (packages\workspace\package_<unique ID>). The
path is displayed as read only.
The folder contains the following subfolders into which you copy the files used to
create the monitor:
l
lib. (Optional) Used for storing external jar files used by the monitor script.
Note that you can use this monitor without external jars.
l
classes. (Optional) Used for storing Java compiled classes; note that they
should be copied with the entire package folder structure.
l
conf. (Optional) Used for storing configuration files, documentation, and XML
files.
l
template. (Mandatory) Used for storing the template files that contain the
custom monitor. It must contain at least one template. Each template can
contain various types of monitors; custom and regular.
Note: This field is displayed when working in monitor mode only. When working in
template mode and the monitor is deployed, the content pack is imported into the
path.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Custom WMI monitor.
l
"General Tips/Limitations" below
l
"Monitor Specific Tips/Limitations" on the next page
l
"Custom Monitor Logs" on page 175
General Tips/Limitations
l
If a user-defined or imported Java package has the same name as an existing SiteScope or
standard Java package, SiteScope ignores the user-defined/imported Java package.
HP SiteScope (11.23)
Page 173 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
l
When setting custom monitor metrics with a string (non-numeric) value, the maximum and
average values in the Measurement Summary table of the Management Report are shown as
'n/a'. This also occurs if you change the metric value type, for example, if you set the metric with
a numeric value, and later change it to a string value or vice versa.
l
When deploying a custom monitor using a template, clearing the Verify monitor properties
with remote server check box in the Deployment Values dialog box has no effect, because the
monitor configuration properties in the template must be checked against the remote server on
which the template is being deployed.
l
When publishing changes to a template that contains a custom monitor, we recommend using
the Disable custom monitors while publishing changes option (selected by default) in
Preferences > Infrastructure Preferences > Custom Monitor Settings. The monitor is
temporarily disabled before changes are published and is restored to the enabled state after
changes have been made.
l
Setting status thresholds using a baseline is not supported on user-defined metrics.
l
You can use third-party .jar files without removing the JVM security from the registry by adding
the _scriptSandboxRuntimePermissions property to the <SiteScope root
directory>;\groups\ master.config file, and specifying the permitted jar files. For example, to
use signed libraries jopcagtbase.jar and jopcagtmsg.jar, configure the parameter as
follows: _scriptSandboxRuntimePermissions=loadLibrary.jopcagtbase,
loadLibrary.jopcagtmsg.
For the types of runtime permissions that can be used, see Runtime Permission class in the
Java API documentation
(http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimePermission.html).
Monitor Specific Tips/Limitations
l
SiteScope does not support WMI event handling or WMI method execution.
l
It is not recommended to have more than 4000 monitors using WMI.
l
Support for 32-bit access to the VSS WMI provider on a 64-bit operating system was removed in
Windows Server 2008. Therefore, any 32-bit program that attempts to enumerate Win32_
ShadowCopy instances (or instances of any VSS class) will fail on 64-bit Windows Server 2008.
l
When a metric or object is shared between resources, SiteScope is unable to receive data for
the metrics and the query fails. If other metrics are referenced in the same query, they also fail to
receive data. For details and troubleshooting information, refer to
http://support.microsoft.com/kb/836802.
l
If running a dynamic query from within a data processing script fails, an exception is thrown.
l
Due to a WMI Interface problem on Microsoft Windows Server 2003, the Custom WMI monitor
is unable to get the correct values for CurrentClockSpeed and MaxClockSpeed from WMI
namespace when SiteScope is running on a Windows Server 2003 platform.
HP SiteScope (11.23)
Page 174 of 926
Monitor Reference
Chapter 19: Custom WMI Monitor
Custom Monitor Logs
l
Errors in the monitor (including errors in the script) are written to the SiteScope logs in the same
way as for any other monitor. Check the error.log and RunMonitor.log files.
l
Error messages from the script are displayed in the custom_monitor.log file located in
<SiteScope root directory>\logs\custom_monitors. This log can be used for info, warning,
error, and debug messages from running the script.
To change the log level to DEBUG mode, in <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava\log4j.properties, change ${loglevel} to
DEBUG in the following paragraph:
# Custom monitors category
log4j.category.CustomMonitor=${loglevel},custom.monitor.appender
log4j.additivity.CustomMonitor=false change
HP SiteScope (11.23)
Page 175 of 926
Chapter 20: Database Counter Monitor
Use the Database Counter monitor to make SQL queries for performance metrics from any JDBCaccessible database. This monitor provides optional support for calculating deltas and rates for
metrics between monitor runs. You can monitor multiple counters with a single monitor instance.
This enables you to watch server loading for performance, availability, and capacity planning. The
error and warning thresholds for the monitor can be set on one or more database server performance
statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Database Counter monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"Setup Requirements and User Permissions" below
l
"IPv6 Addressing Supported Protocols" on page 178
l
"Database Counter Topology" on page 178
Supported Platforms/Versions
This monitor supports monitoring on any database with a valid JDBC driver that supports SQL
queries.
Setup Requirements and User Permissions
The following are several key requirements for using the Database Counter monitor:
l
You must install or copy a compatible JDBC database driver or database access API into the
required SiteScope directory location.
Many database driver packages are available as compressed (zipped) archive files or .jar files.
Copy the downloaded driver file into the <SiteScope root directory>\WEB-INF\lib
subdirectory. If the file is in zip format, unzip the contents to a temporary directory. Stop and
restart the SiteScope service after copying the driver file to the SiteScope machine.
l
You must know the syntax for accessing the database driver. Examples of common database
driver strings are:
n
sun.jdbc.odbc.JdbcOdbcDriver. JDBC-ODBC Bridge Driver from Sun Microsystems.
n
com.mercury.jdbc.sqlserver.SQLServerDriver. DataDirect driver from DataDirect
Technologies. It is a driver for those Microsoft SQL databases that use Windows
authentication. For details on installing the driver, see the note below.
HP SiteScope (11.23)
Page 176 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
Note: To install the MSSQL JDBC driver:
1). Download the MSSQL JDBC driver from the Microsoft Download Center
(http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=2505), and
unzip the contents to a temporary directory.
2). Copy the sqljdbc4.jar file to the <SiteScope root directory>\WEB-INF\lib\
subdirectory.
3). Restart the SiteScope service.
4). Use the Database Connection Tool for connection tuning:
Database Connection URL: jdbc:sqlserver://<IP
Address>:<port>;InstanceName=<name>;DatabaseName=<name>
Database Driver: com.microsoft.sqlserver.jdbc.SQLServerDriver
5). Create the desired database monitor type.
n
com.mercury.jdbc.oracle.OracleDriver. A driver for Oracle databases. This driver is
deployed with SiteScope. When using the driver, the database connection URL has the form
of: jdbc:mercury:oracle://<server name or IP address>:<database server
port>;sid=<sid>
n
oracle.jdbc.driver.OracleDriver.SiteScope supports the following categories of JDBC driver
that are supplied by Oracle:
n
o
JDBC thin driver for Oracle 7 and 8 databases.
o
JDBC OCI (thick) driver. For details on accessing Oracle databases using OCI driver, see
"How to access Oracle databases using OCI driver" on page 180.
org.postgresql.Driver. The database driver for the Postgresql database.
You must know the syntax for the Database connection URL. The Database connection URL
normally includes the class of driver you are using, some key name relating to the supplier of the
driver software, followed by a combination of server, host, and port identifiers.
l
Examples of common database connection URLs are:
n
jdbc:odbc:<dsname>
where <dsname> is the data source name in the system environment or configuration.
n
jdbc:mercury:sqlserver://<hosthost>:1433;DatabaseName=master;AuthenticationMetho
d=type2
where <hostname> is the name of the host where the database is running.
n
jdbc:oracle:thin:@<hostname>:<port>:<dbname>
where <hostname> is the name of the host where the database is running, <port> is the port on
which the database interfaces with the driver, and <dbname> is the SID of the Oracle database
instance.
n
jdbc:postgresql://<hostname>:<port>/<dbname>
where <hostname> is the name of the host where the database is running, <port> is the port on
HP SiteScope (11.23)
Page 177 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
which the database interfaces with the driver, and <dbname> is the name of the Postgresql
database.
l
Generally, only one instance of each type of JDBC driver client should be installed on the
SiteScope machine. If there is more than one instance installed, SiteScope may report an error
and be unable to connect to the database. For example, installing two classes12.zip files from
two different versions of Oracle is unlikely to work.
l
Database drivers that have timeout problems (where database queries processed with these
drivers exceed the timeout specified in the monitor's Query timeout field) can be specified in
the Timeout proxied query drivers list field (in Preferences > Infrastructure Preferences >
General Settings). These drivers are queried separately with a monitor-based timeout.
l
You must have a database user login that SiteScope can use to access the database with
CREATE SESSION system privileges. SiteScope is only able to run the SQL queries that this user
has permission to run on the database.
Note: When Windows authentication is used to connect to the database, configure
SiteScope using the following settings:
n
Database connection URL: jdbc:mercury:sqlserver://<server name or
IP address>:1433;DatabaseName=<database name>;
AuthenticationMethod=type2.
n
Database driver: com.mercury.jdbc.sqlserver.SQLServerDriver.
n
Leave the Database User name and Database Password boxes empty, because the
Windows user credentials of the account from which the SiteScope service is running are
used to establish a connection to the database.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the TCP (JDBC) protocol. Support for IPv6
might also depend on the JDBC driver being used.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Database Counter Topology
The Database Counter monitor can identify the topology of the database system being monitored.
The monitor creates the following topology in BSM's RTSM.
HP SiteScope (11.23)
Page 178 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
Tasks
This section includes:
l
"How to Configure the Database Counter Monitor" below
l
"How to access Oracle databases using OCI driver" on the next page
How to Configure the Database Counter Monitor
1. Prerequisites
Before configuring the monitor, make sure you have the necessary "Setup Requirements and
User Permissions" on page 176.
2. Configure the monitor properties
HP SiteScope (11.23)
Page 179 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Database Connection Tool is available when configuring this monitor to test
and verify connectivity between SiteScope and an external ODBC or JDBC compatible
database (provided you are an administrator in SiteScope, or a user granted Use monitor
tools permissions). To use the tool when configuring or editing a monitor, click the Use
Tool button. For details on the tool, see Database Connection Tool in the Using
SiteScope Guide.
3. Enable topology reporting - optional
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "Database Counter Topology" on page 178.
For user interface details, see "BSM Integration Data and Topology Settings" in the Using
SiteScope Guide.
How to access Oracle databases using OCI driver
You can monitor an Oracle database using an OCI driver. If the port or SID are changed, you only
need to make the change in the tnsnames.ora file (the SiteScope Oracle monitors remain
unchanged).
1. On the SiteScope server, install the version of Oracle client that you are using.
2. Connect to the Oracle database using the Oracle OCI driver.
n
Set ORACLE_HOME environment variable (ORACLE_HOME is the folder where the Oracle
client or database has been installed).
n
Add ORACLE_HOME\lib to System PATH (on Windows platforms), or LD_LIBRARY_
PATH env variable (on UNIX platforms).
n
Set CLASSPATH environment variable to use Oracle JDBC driver from ORACLE_
HOME\jdbc\lib.
3. In the \oracle\oraX\network\admin\tnsnames.ora file, configure the service name. You can
test this using a SQL+ tool or the SiteScope Database Connection tool (see Database
Connection Tool in the Using SiteScope Guide).
4. Add a database monitor within SiteScope, and configure the following settings in the Monitor
Settings panel:
n
Database connection URL: jdbc:oracle:oci8:@<service name>
n
Database driver: oracle.jdbc.driver.OracleDriver
HP SiteScope (11.23)
Page 180 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
n
Enter the database user credentials in the Database user name and Database password
boxes
UI Descriptions
Database Counter Monitor Settings
User interface elements are described below:
UI Element
Description
Database
connection
URL
Connection URL to the database you want to connect to. The syntax is
jdbc:oracle:thin:@<server name or IP address>:<database server
port>:<sid>.
Example: To connect to the ORCL database on a machine using port 1521 use:
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
The colon (:) and the (@) symbols must be included as shown.
Note for using Windows Authentication: If you want to access the database
using Windows authentication, enter
jdbc:mercury:sqlserver://<server name or
IP address>:1433;DatabaseName=<database name>;
AuthenticationMethod=type2 as the connection URL, and
com.mercury.jdbc.sqlserver.SQLServerDriver as your database driver.
Leave the Database user name and Database password boxes empty, because
the Windows user credentials of the account from which the SiteScope service is
running are used to establish a connection to the database.
Query
SQL query that returns at least two columns of data. The values in the first column
of data are interpreted as the labels for the entries in the each row. The values in
the first row are treated as labels for each entry in the column.
Database
driver
Driver used to connect to the database.
Example:org.postgresql.Driver
Tip: You can specify database drivers that have timeout problems (where
database queries processed with these drivers exceed the timeout specified in the
monitor's Query timeout field) in the Timeout proxied query drivers list field (in
Preferences > Infrastructure Preferences > General Settings). These drivers
are queried separately with a monitor-based timeout.
Database
machine
name
Identifier for the target database server, as it should be reported to BSM.
Note: This field is used only for topology reporting.
HP SiteScope (11.23)
Page 181 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
UI Element
Description
Database
port
Port number, for the target database server, as it should be reported to BSM. You
can specify the port manually. If none is specified, the monitor attempts to detect
the port from the database connection URL. If it fails, topology is still reported, just
without IpServiceEndpoint.
Note: This field is used only for topology reporting.
Database
instance
name
Name of the database instance, as it should be reported to BSM.
For SQL servers, the monitor automatically detects and populates this field from
the database connection URL.
For Oracle, the monitor automatically detects the instance name from the
database connection URL without populating the field.
If the field is empty and auto detection fails, no topology is reported and the default
CI type Node is displayed in the HP Integration Settings panel.
Note: This field is used only for topology reporting.
Divisor
query
SQL query that returns a single numeric value. The value of each counter is
calculated by dividing the counter value as retrieved from the database divided by
the Divisor Query value.
No
cumulative
counters
Turns off the default behavior of calculating the value of a counter as the
difference between that counter's cumulative values (as retrieved from the
database on consecutive monitor runs).
Credentials Option for providing the user name and password to be used to access the
database server:
No divide
counters
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password in the User name and
Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default option).
Select the credential profile to use from the Credential profile drop-down list,
or click Add Credentials and create a new credential profile. For details on
how to perform this task, see How to Configure Credential Preferences in the
Using SiteScope Guide.
Turns off the default behavior of calculating the value of a counter as the value
retrieved from the database (or the delta of two values retrieved from the database
over consecutive monitor runs) divided by some number.
The divisor is either taken from the Divisor Query, or it is the elapsed time in
seconds since the previous monitor run.
HP SiteScope (11.23)
Page 182 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
UI Element
Description
Counters
Server performance counters you want to check with this monitor. Use the Get
Counters button to select counters.
Get
Counters
Opens the Select Counters Form, enabling you to select the counters you want to
monitor.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Database Connection Settings
The Database Connection Settings enable you to retrieve, share, and reuse database
connections for database monitors that use any JDBC-compliant driver. When multiple database
monitors use the same database, using a connection pool instead of an open connection for each
monitor improves monitor performance and optimizes database server resource utilization.
Connections can be shared regardless of monitor enter. For example, SiteScope database
logger, database tools (Database Connection, Database Information), database alerts, and
database monitors (Oracle Database, Database Counter, Database Query, DB2 JDBC,
Technology Database Integration, and so forth) can share and reuse database connections in a
connection pool.
Use
connection
pool
Enables SQL connection sharing. This means that you use a connection pool
rather than open and close a new connection for each monitor query.
Physically
close if
idle
connection
count
exceeds
Maximum number of unused SQL connections in the SQL connection pool. When
this number is exceeded, unused connections are closed rather than returned to
the connection pool.
Idle
connection
timeout
Maximum amount of time, in seconds/minutes/hours/days, that a SQL connection
remains unused after it has been returned to the SQL connection pool. When the
time is exceeded, the connection is automatically closed.
Default value: Selected
Default value: 10
Default value: 5 minutes
Query
timeout
Amount of time, in seconds/minutes/hours/days, to wait for execution of a SQL
statement. Not all SQL drivers have this function. If your SQL driver does not
support this function, this parameter is ignored.
Default value: 1 minute
Note: For information on configuring setting panels that are common to all monitors, see
HP SiteScope (11.23)
Page 183 of 926
Monitor Reference
Chapter 20: Database Counter Monitor
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Tips/Limitations
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
You can set additional database options that affect all resources that connect to the database in
the JDBC Global Options in the General Preferences container. For details, see JDBC Global
Options in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 184 of 926
Chapter 21: Database Query Monitor
Use the Database Query monitor to monitor the availability and proper functioning of your database
application. If your database application is not working properly, the user may not be able to access
Web content and forms that depend on the database. Most importantly, the user cannot complete ecommerce transactions that are supported by databases. You can also use the Database Query
monitor to isolate performance bottlenecks. If the database interaction time and the associated user
URL retrieval times are both increasing at about the same amount, the database is probably the
bottleneck.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Database Query monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"What to Monitor" below
l
"Setup Requirements and User Permissions" below
l
"IPv6 Addressing Supported Protocols" on page 188
l
"Database Query Topology" on page 188
Supported Platforms/Versions
This monitor supports monitoring on any database with a valid JDBC driver that supports SQL
queries.
What to Monitor
Usually the most important thing to monitor in databases are the queries used by your most
frequently used and most important Web applications. If more than one database is used, you must
monitor each of the databases.
Each time the Database Query monitor runs, it returns a status, the time it takes to perform the
query, the number of rows in the query result, and the first two fields in the first row of the result and
writes them in the monitoring log file.
You can also monitor internal database statistics. The statistics provided by each database are
different but may include items such as database free space, transaction log free space,
transactions/second, and average transaction duration.
Setup Requirements and User Permissions
The steps for setting up a Database Query monitor vary according to what database software you
are trying to monitor. The following is an overview of the requirements for using the Database Query
HP SiteScope (11.23)
Page 185 of 926
Monitor Reference
Chapter 21: Database Query Monitor
monitor:
l
You must install or copy a compatible JDBC database driver or database access API into the
required SiteScope directory location.
Many database driver packages are available as compressed (zipped) archive files or .jar files.
Copy the downloaded driver file into the <SiteScope root directory>\WEB-INF\lib
subdirectory. If the file is in zip format, unzip the contents to a temporary directory. Stop and
restart the SiteScope service after copying the driver file to the SiteScope machine.
l
You must know the syntax for accessing the database driver. Examples of common database
driver strings are:
n
sun.jdbc.odbc.JdbcOdbcDriver. JDBC-ODBC Bridge Driver from Sun Microsystems.
n
com.mercury.jdbc.sqlserver.SQLServerDriver. DataDirect driver from DataDirect
Technologies. It is a driver for those Microsoft SQL databases that use Windows
authentication. For details on installing the driver, see the note below.
Note: To install the MSSQL JDBC driver:
1). Download the MSSQL JDBC driver from the Microsoft Download Center
(http://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774), and
unzip the contents to a temporary directory.
2). Copy the sqljdbc4.jar file to the <SiteScope root directory>\WEB-INF\lib\
subdirectory.
3). Restart the SiteScope service.
4). Use the Database Connection Tool for connection tuning:
Database Connection URL: jdbc:sqlserver://<IP
Address>:<port>;InstanceName=<name>;DatabaseName=<name>
Database Driver: com.microsoft.sqlserver.jdbc.SQLServerDriver
5). Create the desired database monitor type.
n
com.mercury.jdbc.oracle.OracleDriver. A driver for Oracle databases. This driver is
deployed with SiteScope. When using the driver, the database connection URL has the form
of: jdbc:mercury:oracle://<server name or IP address>:<database server
port>;sid=<sid>
n
oracle.jdbc.driver.OracleDriver.SiteScope supports the following categories of JDBC driver
that are supplied by Oracle:
n
l
o
JDBC thin driver for Oracle 7 and 8 databases.
o
JDBC OCI (thick) driver. For details on accessing Oracle databases using OCI driver, see
"How to Access Oracle Databases Using OCI Driver" on page 190.
org.postgresql.Driver. The database driver for the Postgresql database.
You must know the syntax for the database connection URL. The database connection URL
normally includes the class of driver you are using, some key name relating to the supplier of the
HP SiteScope (11.23)
Page 186 of 926
Monitor Reference
Chapter 21: Database Query Monitor
driver software, followed by a combination of server, host, and port identifiers.
Examples of common database connection URLs are:
n
jdbc:odbc:<dsname>
where <dsname> is the data source name in the system environment or configuration.
n
jdbc:mercury:sqlserver://<hosthost>:1433;DatabaseName=master;AuthenticationMetho
d=type2
where <hostname> is the name of the host where the database is running.
n
jdbc:oracle:thin:@<hostname>:<port>:<dbname>
where <hostname> is the name of the host where the database is running, <port> is the port on
which the database interfaces with the driver, and <dbname> is the name of the Oracle
database instance.
l
The database you want to monitor needs to be running, have a database name defined, and have
at least one named table created in the database. In some cases, the database management
software needs to be configured to enable connections by using the middleware or database
driver.
l
You need a valid user name and password to access and perform a query on the database. In
some cases, the machine and user account that SiteScope is running on must be given
permissions to access the database.
l
Database drivers that have timeout problems (where database queries processed with these
drivers exceed the timeout specified in the monitor's Query timeout field) can be specified in
the Timeout proxied query drivers list field (in Preferences > Infrastructure Preferences >
General Settings). These drivers are queried separately with a monitor-based timeout.
l
You must know a valid SQL query string for the database instance and database tables in the
database you want to monitor. Consult your database administrator to work out required queries
to test.
Note: When Windows authentication is used to connect to the database, configure SiteScope
using the following settings:
l
Database connection URL: jdbc:mercury:sqlserver://<server name or
IP address>:1433;DatabaseName=<database name>;
AuthenticationMethod=type2.
l
Database driver: com.mercury.jdbc.sqlserver.SQLServerDriver.
l
Leave the Database user name and Database password boxes empty, because the
Windows user credentials of the account from which the SiteScope service is running are
used to establish a connection to the database.
HP SiteScope (11.23)
Page 187 of 926
Monitor Reference
Chapter 21: Database Query Monitor
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports IPv6 addresses in the TCP (JDBC)
protocol. Support for IPv6 might also depend on the JDBC driver being used.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Database Query Topology
The Database Query monitor can identify the topology of the database system being monitored.
The monitor creates the following topology in BSM's RTSM.
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 188 of 926
Monitor Reference
Chapter 21: Database Query Monitor
Tasks
This section includes:
l
"How to Configure the Database Query Monitoring Environment" below
l
"How to Access Oracle Databases Using OCI Driver" on the next page
l
"How to Access Oracle Databases Without Using ODBC" on page 191
l
"How to Enable SiteScope to Monitor an Informix Database" on page 191
l
"How to Enable SiteScope to Monitor a MySQL Database" on page 192
l
"How to Enable SiteScope to Monitor a Sybase Database" on page 193
How to Configure the Database Query Monitoring Environment
1. Prerequisites
There are several key requirements for using this monitor. For details, see "Setup
Requirements and User Permissions" on page 185.
2. Configure the database driver
n
You can monitor an Oracle database using an OCI driver. For details, see "How to Access
Oracle Databases Using OCI Driver" on the next page.
n
You can monitor an Oracle database using the Oracle Thin JDBC Driver. For details, see
"How to Access Oracle Databases Without Using ODBC" on page 191.
3. Enable SiteScope to monitor the database
n
For details on enabling SiteScope to monitor an Informix database, see "How to Enable
SiteScope to Monitor an Informix Database" on page 191.
n
For details on enabling SiteScope to monitor a MySQL database, see "How to Enable
SiteScope to Monitor a MySQL Database" on page 192.
n
For details on enabling SiteScope to monitor a Sybase database, see "How to Enable
SiteScope to Monitor a Sybase Database" on page 193.
4. Troubleshoot driver or database errors
To troubleshoot possible errors using the Oracle Thin Driver, MySQL Driver, or Sybase
database, see "Tips/Troubleshooting" on page 197.
5. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 189 of 926
Monitor Reference
Chapter 21: Database Query Monitor
Tip:
n
The Database Connection Tool is available when configuring this monitor to test and
verify connectivity between SiteScope and an external ODBC or JDBC compatible
database (provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions). To use the tool when configuring or editing a monitor,
click the Use Tool button. For details on the tool, see Database Connection Tool in the
Using SiteScope Guide.
n
You may want to monitor your most critical and most common queries frequently, every
2-5 minutes. Database statistics that change less frequently can be monitored every 30
or 60 minute.
n
You can also modify the default number of columns, rows, and characters that are
displayed for the Database Query monitor in the SiteScope Dashboard by changing the
DB maximum columns, DB maximum rows, and DB maximum value
lengthsettings in Preferences > Infrastructure Preferences > Monitor Settings.
n
When setting the round trip time counter in Threshold Settings, counter values are in
milliseconds, whereas in the Dashboard summary they are displayed in seconds.
How to Access Oracle Databases Using OCI Driver
You can monitor an Oracle database using an OCI driver. If the port or SID are changed, you only
need to make the change in the tnsnames.ora file (the SiteScope Oracle monitors remain
unchanged).
1. On the SiteScope server, install the version of Oracle client that you are using.
2. Connect to the Oracle database using the Oracle OCI driver.
n
Set ORACLE_HOME environment variable (ORACLE_HOME is the folder where the Oracle
client or database has been installed).
n
Add ORACLE_HOME\lib to System PATH (on Windows platforms), or LD_LIBRARY_
PATH env variable (on UNIX platforms).
n
Set CLASSPATH environment variable to use Oracle JDBC driver from ORACLE_
HOME\jdbc\lib.
3. In the \oracle\oraX\network\admin\tnsnames.ora file, configure the service name. You can
test this using a SQL+ tool or the SiteScope Database Connection tool (see Database
Connection Tool in the Using SiteScope Guide).
4. Add a database monitor within SiteScope, and configure the following settings in the Monitor
Settings panel:
HP SiteScope (11.23)
Page 190 of 926
Monitor Reference
Chapter 21: Database Query Monitor
n
Database connection URL: jdbc:oracle:oci8:@<service name>
n
Database driver: oracle.jdbc.driver.OracleDriver
n
Enter the database user credentials in the Database user name and Database password
boxes
How to Access Oracle Databases Without Using ODBC
If you want to monitor an Oracle database without using ODBC, you can use the Oracle Thin JDBC
Drivers.
1. To set up SiteScope to use the JDBC Thin Drivers, download the Oracle Thin JDBC drivers
from the Oracle Web site (may require service/support agreement with Oracle).
2. Copy the downloaded driver package into the <SiteScope root directory>\WEB-INF\lib
subdirectory.
Note: Do not extract the files from the archive file.
3. Stop and restart the SiteScope service.
4. Add a Database Query monitor within SiteScope, and configure the following settings in the
Monitor Settings panel:
n
Database connection URL. The format for the Oracle JDBC driver is:
jdbc:oracle:thin:@<tcp address>:<tcp port>:<database SID>
For example to connect to the ORCL database on a machine using port 1521 you would use:
jdbc:oracle:thin:@206.168.191.19:1521:ORCL
Note: After the word thin is a colon (:) and an at (@) symbol.
n
Database driver. Enter the following string: oracle.jdbc.driver.OracleDriver.
How to Enable SiteScope to Monitor an Informix Database
Monitoring an Informix database requires the use of a JDBC driver.
1. Download the Informix JDBC driver from Informix. See the Informix Web site for details.
2. Uncompress the distribution file.
3. Open a DOS window and go to the jdbc140jc2 directory.
4. Unpack the driver by running the following command:
HP SiteScope (11.23)
Page 191 of 926
Monitor Reference
Chapter 21: Database Query Monitor
c:\SiteScope\java\bin\java -cp . setup
5. Copy ifxjdbc.jar to the <SiteScope root directory>\WEB-INF\lib subdirectory.
6. Stop and restart SiteScope.
7. Add a Database Query monitor within SiteScope, and configure the following settings in the
Monitor Settings panel:
n
Database connection URL. The format for the Informix JDBC driver is:
jdbc:informix-sqli://<database hostname>:<tcp port><database
server>:INFORMIXSERVER=<database>
n
If you require a Database user name and Database password, the database connection
URL format for the Informix JDBC driver is:
jdbc:informix-sqli://<database hostname>:<tcp port><database
server>:INFORMIXSERVER=<database>;user=myuser;password=mypassword
For example, to connect to the Database Server sysmaster running on the machine called
pond.thiscompany.com and the Database called maindbase, type:
jdbc:informixsqli://pond.thiscompany.com:1526/sysmaster:INFORMIXSERVER=maindbase;
n
Database driver. Enter the Informix JDBC driver com.informix.jdbc.IfxDriver
How to Enable SiteScope to Monitor a MySQL Database
Monitoring a MySQL database requires the use of a JDBC driver.
1. Download the MySQL JDBC driver from the MySQL web site (http://www.mysql.com).
2. Uncompress the distribution file.
3. Copy the .jar file into the <SiteScope root directory>\WEB-INF\lib directory.
4. Stop and restart SiteScope.
5. Add a Database Query monitor within SiteScope, and configure the following settings in the
Monitor Settings panel:
n
Database connection URL. The format for the MySQL JDBC driver is:
jdbc:mysql://<database hostname>[:<tcp port>]/<database>
For example to connect to the MySQL database "aBigDatabase" on a machine using the
standard MySQL port number 3306 you would use:
jdbc:mysql://206.168.191.19/aBigDatabase
HP SiteScope (11.23)
Page 192 of 926
Monitor Reference
Chapter 21: Database Query Monitor
If you are using a different port to connect to the database, include that port number as part of
the IP address.
n
Database driver. Enter the specification for the MySQL JDBC driver:
org.gjt.mm.mysql.Driver
How to Enable SiteScope to Monitor a Sybase Database
To use JDBC drivers with your Sybase SQL server, perform the following steps:
1. Obtain the driver for the version of Sybase that you are using. For example, for version 5.X
databases you need jconn2.jar. If you have Jconnect, look for a driver in the Jconnect
directory.
2. Place the zip file in the <SiteScope root directory>\WEB-INF\lib directory. Do not extract
the zip file.
3. Stop and restart the SiteScope service.
4. Add a Database Query monitor within SiteScope, and configure the following settings in the
Monitor Settings panel:
n
Database connection URL. Use the syntax of: jdbc:sybase:Tds:hostname:port
For example to connect to SQL server named bgsu97 listening on port 2408, you would enter:
jdbc:sybase:Tds:bgsu97:2408
n
You can specify a database by using the syntax:
jdbc:sybase:Tds:hostname:port#/database
For example to connect to SQL server named bgsu97 listening on port 2408 and to the
database of quincy, you would enter:
jdbc:sybase:Tds:bgsu97:2408/quincy
n
Database driver. Enter com.sybase.jdbc.SybDriver (for Sybase version 4.x) or
com.sybase.jdbc2.jdbc.SybDriver (for Sybase version 5.x).
n
Enter the Database user name and Database password.
n
Enter a query string for a database instance and table in the Sybase database you want to
monitor.
For example, Sp_help should work and return something similar to:
good, 0.06 sec, 27 rows, KIRK1, dbo, user table
Alternately, the query string select * from spt_ijdbc_mda should return something similar
to:
Monitor: good, 0.06 sec, 175 rows, CLASSFORNAME, 1, create table #tmp_class_
for_name (xtbinaryoffrow image null), sp_ijdbc_class_for_name(?), select *
from #tmp_class_for_name, 1, 7, 12000, -1
HP SiteScope (11.23)
Page 193 of 926
Monitor Reference
Chapter 21: Database Query Monitor
UI Descriptions
Database Query Monitor Settings
User interface elements are described below:
UI Element
Description
Database connection URL
URL to a database connection (no spaces are allowed in the
URL). One way to create a database connection is to use
ODBC to create a named connection to a database.
Example: First use the ODBC control panel to create a
connection called test. Then, enter jdbc:odbc:test as the
connection URL.
Note for using Windows Authentication: If you want to
access the database using Windows authentication, enter
jdbc:mercury:sqlserver://<server name or
<IP address>:1433;DatabaseName=<database name>;
AuthenticationMethod=type2 as the connection URL, and
com.mercury.jdbc.sqlserver.SQLServerDriver as your
database driver. Leave the Database user name and
Database password boxes empty, because the Windows user
credentials of the account from which the SiteScope service is
running are used to establish a connection to the database.
Database driver
Java class name of the JDBC database driver.
The default driver uses ODBC to make database connections.
SiteScope uses the same database driver for both primary and
backup database connections.
If a custom driver is used, the driver must also be installed in
the <SiteScope root directory>\WEB-INF\lib\ directory.
Default value: sun.jdbc.odbc.JdbcOdbcDriver
Tip: You can specify database drivers that have timeout
problems (where database queries processed with these
drivers exceed the timeout specified in the monitor's Query
timeout field) in the Timeout proxied query drivers list field
(in Preferences > Infrastructure Preferences > General
Settings). These drivers are queried separately with a monitorbased timeout.
HP SiteScope (11.23)
Page 194 of 926
Monitor Reference
Chapter 21: Database Query Monitor
UI Element
Description
Database user name
User name used to log on to the database.
If you are using Microsoft SQL server and the default driver
(Sun Microsystem JDBC-ODBC bridge driver,
sun.jdbc.odbc.JdbcOdbcDriver), you can leave this blank
and choose Windows Authentication when you setup the
ODBC connection.
With Windows Authentication, SiteScope connects using the
login account of the SiteScope service.
Note: The specified user name must have privileges to run the
query specified for the monitor.
Database password
Password used to log on to the database.
If you are using Microsoft SQL server and the default driver
(Sun Microsystem JDBC ODBC bridge driver
(sun.jdbc.odbc.JdbcOdbcDriver), you can leave this blank and
choose Windows Authentication when you create the ODBC
connection.
With Windows Authentication, SiteScope connects using the
login account of the SiteScope service.
Query
SQL query to test.
Example: select * from sysobjects
HP SiteScope (11.23)
Page 195 of 926
Monitor Reference
Chapter 21: Database Query Monitor
UI Element
Description
Match content
Text string to check for in the query result. If the text is not
contained in the result, the monitor displays no match on
content. This works for XML tags as well. The search is case
sensitive.
Note:
l
You can also perform a Perl regular expression match by
enclosing the string in forward slashes, with an i after the
trailing slash indicating case-insensitive matching. For
example, /href=Doc\d+\.html/ or
/href=doc\d+\.html/i.
l
If you want a particular piece of text to be saved and
displayed as part of the status, use parentheses in a Perl
regular expression. For example, /Temperature: (\d+)/
would return the temperature as it appears on the page and
this could be used when setting an Error if or Warning if
threshold.
For details on regular expressions, see Regular Expressions
Overview in the Using SiteScope Guide.
Open Tool
Opens the Regular Expression Tool, enabling you to test a
regular expression for content matching against a sample of the
content you want to monitor. For details, see Regular
Expression Tool in the Using SiteScope Guide.
File path
Name of the file that contains the query you want to run. The
file should be in a simple text format.
Use this function as an alternative to the Query text box for
complex queries or queries that change and are updated by an
external application.
Column labels
Field labels for all columns returned by the query, separated by
a comma (","). These column labels are used as data labels in
SiteScope reports for Database Query Monitors.
Note: The field labels should be the labels that are returned by
the Query string entered above.
Database machine name
HP SiteScope (11.23)
Text identifier describing the database server that this monitor
is monitoring if you are reporting monitor data to an installation
of HP Business Service Management. This text descriptor is
used to identify the database server when the monitor data is
viewed in an HP Business Service Management report.
Page 196 of 926
Monitor Reference
Chapter 21: Database Query Monitor
UI Element
Description
Database Connection Settings
The Database Connection Settings enable you to retrieve, share, and reuse database
connections for database monitors that use any JDBC-compliant driver. When multiple database
monitors use the same database, using a connection pool instead of an open connection for each
monitor improves monitor performance and optimizes database server resource utilization.
Connections can be shared regardless of monitor type. For example, SiteScope database logger,
database tools (Database Connection, Database Information), database alerts, and database
monitors (Oracle Database, Database Counter, Database Query, DB2 JDBC, Technology
Database Integration, and so forth) can share and reuse database connections in a connection
pool.
Use connection pool
Enables SQL connection sharing. This means that you use a
connection pool rather than open and close a new connection
for each monitor query.
Default value: Selected
Physically close if idle
connection count exceeds
The maximum number of unused SQL connections in the SQL
connection pool. When this number is exceeded, unused
connections are closed rather than returned to the connection
pool.
Default value: 10
Idle connection timeout
The maximum amount of time, in
seconds/minutes/hours/days, that a SQL connection remains
unused after it has been returned to the SQL connection pool.
When the time is exceeded, the connection is automatically
closed.
Default value: 5 minutes
Query timeout
The amount of time, in seconds/minutes/hours/days, to wait for
execution of a SQL statement. Not all SQL drivers have this
function. If your SQL driver does not support this function, this
parameter is ignored.
Default value: 1 minute
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Database Query monitor.
HP SiteScope (11.23)
Page 197 of 926
Monitor Reference
Chapter 21: Database Query Monitor
General Tips
l
If you require multiple columns in the monitor output, you can use the _databaseMaxColumns
property in the <SiteScope root directory>\groups\master.config file or the DB maximum
columns setting in Preferences > Infrastructure Preferences > Monitor Settings) to adjust
the maximum number of columns displayed in the SiteScope Dashboard (the default is 10
columns). You can also change the maximum number of rows processed by DB monitors (DB
maximum rows) and the maximum length, in characters, of the data processed by DB monitors
(DB maximum value length). The default maximum number of rows is 1, and the default
maximum value length is 200 characters.
l
When using the Database Connection Tool to apply properties to the monitor, you must enter the
credential data manually (if you select a credential profile the credential data is lost).
l
You can set additional database options that affect all resources that connect to the database in
the JDBC Global Options in Preferences > General Preferences. For details, see JDBC
Global Options in the Using SiteScope Guide.
l
When setting the round trip time counter in Threshold Settings, counter values are in
milliseconds, whereas in the Dashboard summary they are displayed in seconds.
Possible Errors Using the Oracle Thin Driver
l
error, connect error, No suitable driver: check for syntax errors in Database connection
URL, such as dots instead of colons.
l
error, connect error, Io exception: The Network Adapter could not establish the
connection: in Database connection URL, check
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
l
error, connect error, Io exception: Invalid connection string format, a valid format is:
"host:port:sid": in Database connection URL check
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
l
error, connect error, Invalid Oracle URL specified: OracleDriver.connect: in Database
connection URL, check for a colon before the "@"
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
l
Refused:OR=(CODE=12505)(EMFI=4)))): in Database connection URL, the database SID is
probably incorrect (ORCL part). This error can also occur when the TCP address, or TCP port is
incorrect. If this is the case, verify the TCP port and check with the your database administrator
to verify the proper SID.
l
String Index out of range: -1: in Database connection URL, check for the database server
address, port, and the database SID.
l
error, driver connect error, oracle.jdbc.driver.OracleDriver: check syntax in Database
driver.
l
error, driver connect error, oracle.jdbc.driver.OracleDriver: check that driver is loaded in
HP SiteScope (11.23)
Page 198 of 926
Monitor Reference
Chapter 21: Database Query Monitor
correct place.
l
error, connect error, No suitable driver: check driver specified in Database driver.
l
error, connect error, No suitable driver: check for syntax errors in Database connection
URL, such as dots instead of colons.
Possible Errors Using the MySQL Driver
If, after enabling SiteScope to monitor a MySQL database, you get an authorization error in the
Database Query monitor, you may have to grant rights for the SiteScope machine to access the
MySQL database. Consult the MySQL Database administrator for setting up privileges for the
SiteScope machine to access the MySQL server.
Possible Errors with Sybase Database Monitoring
l
Verify you are using the correct driver for the version of Sybase you are monitoring. Enter
com.sybase.jdbc.SybDriver for Sybase version 4.x. and
com.sybase.jdbc2.jdbc.SybDriver for Sybase version 5.x.
l
error, driver connect error, com/sybase/jdbc/SybDriver. Verify there are no spaces at the
end of the driver name. Save the changes and try the monitor again.
l
If you get the error: connect error, JZ006: Caught IOException:
java.net.UnknownHostException: dbservername. Verify the name of the database server in
the Database connection URL field is correct.
HP SiteScope (11.23)
Page 199 of 926
Chapter 22: DB2 JDBC Monitor
Use this monitor to monitor availability and proper functioning of DB2 servers. You can monitor
multiple parameters or counters with a single monitor instance. This enables you to monitor server
loading for performance, availability, and capacity planning. Create a separate DB2 monitor
instance for each Database in your IBM DB2 environment. The error and warning thresholds for the
monitor can be set on up to ten DB2 server performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the DB2 JDBC monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
l
"DB2 JDBC Topology" below
Supported Platforms/Versions
l
This monitor supports monitoring DB2 8.x, 9.x, and 10.1 servers.
l
It supports all operating systems with a supported JDBC driver and DB2 snapshot feature.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the TCP (JDBC) protocol. Support for IPv6
might also depend on the JDBC driver being used.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
DB2 JDBC Topology
The DB2 JDBC monitor can identify the topology of the DB2 system being monitored. The monitor
creates the following topology in BSM's RTSM.
HP SiteScope (11.23)
Page 200 of 926
Monitor Reference
Chapter 22: DB2 JDBC Monitor
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
Tasks
How to Configure the DB2 JDBC Monitor
1. Prerequisites
n
JDBC drivers for connecting to the DB2 Database server. These can be found in your DB2
server installation directories. Copy the db2jcc.jar file to the <SiteScope root
directory>\WEB-INF\lib folder.
n
This monitor uses the Snapshot mirroring functionality supported by DB2. You must enable
the Snapshot Mirror on your DB2 instance to retrieve counters. For details, refer to the
relevant IBM DB2 documentation.
Note: Since DB2 JDBC monitors are based on JDBC connections, there is no binding
with any specific operation systems.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Database Connection Tool is available when configuring this monitor to test
and verify connectivity between SiteScope and an external ODBC or JDBC compatible
database (provided you are an administrator in SiteScope, or a user granted Use monitor
tools permissions). To use the tool when configuring or editing a monitor, click the Use
Tool button. For details on the tool, see Database Connection Tool in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 201 of 926
Monitor Reference
Chapter 22: DB2 JDBC Monitor
3. Enable topology reporting - optional
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "DB2 JDBC Topology" on page 200.
For user interface details, see "BSM Integration Data and Topology Settings" in the Using
SiteScope Guide.
UI Descriptions
DB2 JDBC Monitor Settings
User interface elements are described below:
UI Element
Description
DB2 server
Address or name of the server where the DB2 database is
running.
Port
Port on which the DB2 database accepts connections.
Default value: 50000
Database
DB2 database node name that you want to monitor.
Default value: sample
Example: DB2 is the default node name created by DB2
installation.
Credentials
Partition
Option for providing the user name and password to be used to
access the DB2 database server:
l
Use user name and password. Select this option to
manually enter user credentials. Enter the user name and
password in the User name and Password box.
l
Select predefined credentials. Select this option to have
SiteScope automatically supply a predefined user name and
password (selected by default). Select the credential profile to
use from the Credential profile drop-down list, or click Add
Credentials and create a new credential profile. For details on
how to perform this task, see How to Configure Credential
Preferences in the Using SiteScope Guide.
Partition to monitor. -1 is the current partition; -2 is all partitions.
Default value: -1
HP SiteScope (11.23)
Page 202 of 926
Monitor Reference
Chapter 22: DB2 JDBC Monitor
UI Element
Description
Calculate rate
Calculates rates for counter values rather than the actual values
returned from the monitored server.
Example: If a counter counts logins and every second an
average of two users log on to the database, the counter keeps
growing. Selecting this option, the monitor displays the value 2,
which means 2 user logins per second.
Counters
Server performance counters to check with this monitor. Use the
Get Counters button to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the
counters you want to monitor. For the list of counters that can be
configured for this monitor, see "Monitor Counters" on page 205.
Note when working in template mode: The maximum number
of counters that you can select is 100. If you import a template
monitor from an earlier version of SiteScope, or perform a copy to
template action, the number of counters is not limited.
Database Connection Settings
The Database Connection Settings enable you to retrieve, share, and reuse database
connections for database monitors that use any JDBC-compliant driver. When multiple database
monitors use the same database, using a connection pool instead of an open connection for each
monitor improves monitor performance and optimizes database server resource utilization.
Connections can be shared regardless of monitor type. For example, SiteScope database logger,
database tools (Database Connection, Database Information), database alerts, and database
monitors (Oracle database, Database Counter, Database Query, DB2 JDBC, Technology
Database Integration, and so forth) can share and reuse database connections in a connection
pool.
Use connection pool
Enables SQL connection sharing. This means that you use a
connection pool rather than open and close a new connection for
each monitor query.
Default value: Selected
Physically close if idle
connection count exceeds
Maximum number of unused SQL connections in the SQL
connection pool. When this number is exceeded, unused
connections are closed rather than returned to the connection
pool.
Default value: 10
HP SiteScope (11.23)
Page 203 of 926
Monitor Reference
Chapter 22: DB2 JDBC Monitor
UI Element
Description
Idle connection timeout
Maximum amount of time, in seconds/minutes/hours/days, that a
SQL connection remains unused after it has been returned to the
SQL connection pool. When the time is exceeded, the
connection is automatically closed.
Default value: 5 minutes
Query timeout
Amount of time, in seconds/minutes/hours/days, to wait for
execution of a SQL statement. Not all SQL drivers have this
function. If your SQL driver does not support this function, this
parameter is ignored.
Default value: 1 minute
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 204 of 926
Monitor Reference
Chapter 22: DB2 JDBC Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
acc_curs_blk
active_sorts
agents_created_empty_pool
agents_from_pool
agents_registered
agents_stolen
agents_waiting_on_token
appl_section_inserts
appl_section_lookups
appls_cur_cons
appls_in_db2
binds_precompiles
cat_cache_heap_full
cat_cache_inserts
cat_cache_lookups
cat_cache_overflows
comm_private_mem
commit_sql_stmts
con_local_dbases
ddl_sql_stmts
deadlocks
direct_read_reqs
direct_read_time
direct_reads
direct_write_reqs
direct_write_time
direct_writes
dynamic_sql_stmts
failed_sql_stmts
files_closed
hash_join_overflows
hash_join_small_overflows
idle_agents
inactive_gw_agents
int_auto_rebinds
int_commits
int_deadlock_rollbacks
int_rollbacks
int_rows_deleted
int_rows_inserted
int_rows_inserted rows_deleted
int_rows_updated
local_cons
local_cons_in_exec
lock_escals
lock_list_in_use
lock_timeouts
lock_wait_time
lock_waits
lock_waits locks_held
locks_held
locks_waiting
log_reads
log_writes
num_assoc_agents
num_gw_conn_switches
open_loc_curs
open_loc_curs_blk
open_rem_curs
open_rem_curs_blk
piped_sorts_accepted
piped_sorts_requested
pkg_cache_inserts
pkg_cache_lookups
pkg_cache_lookups direct_reads
pkg_cache_num_overflows
pool_async_data_read_reqs
pool_async_data_reads
pool_async_data_writes
pool_async_index_reads
pool_async_index_writes
pool_async_read_time
pool_async_write_time
pool_data_from_estore
pool_data_l_reads
pool_data_p_reads
pool_data_to_estore
pool_data_writes
pool_drty_pg_steal_clns sort_overflows
pool_drty_pg_thrsh_clns
pool_index_from_estore
pool_index_l_reads
pool_index_p_reads
pool_index_to_estore
pool_index_writes
pool_lsn_gap_clns
pool_read_time
pool_write_time
post_threshold_sorts
prefetch_wait_time
rej_curs_blk
rem_cons_in
rem_cons_in_exec
rollback_sql_stmts
rows_deleted
rows_inserted
rows_read
rows_selected
rows_updated
rows_written
sec_logs_allocated
select_sql_stmts
sort_heap_allocated
sort_overflows
static_sql_stmts
total_hash_joins
total_hash_loops
total_log_used
total_sec_cons
total_sort_time
total_sorts
uid_sql_stmts
uow_lock_wait_time
uow_log_space_used
x_lock_escals
Tips/Troubleshooting
General Tips/Limitations
l
SiteScope DB2 10.1 supports the same tables and counters that are available with DB2 8 and 9
only; it does not support the additional tables and counters that were added in DB2 10.1.
l
When deploying this monitor using a template, an error message is displayed if you clear the
HP SiteScope (11.23)
Page 205 of 926
Monitor Reference
Chapter 22: DB2 JDBC Monitor
Verify monitor properties with remote server option in the Deployment Values dialog box.
l
You can set additional database options that affect all resources that connect to the database in
the JDBC Global Options in the General Preferences container. For details, see JDBC Global
Options in the Using SiteScope Guide.
l
When SiteScope is connected to BSM 9.2x or earlier, the previous name for this monitor (DB2
8.x and 9.x) is displayed in the Metrics and Indicators tab of System Availability Management
Administration.
HP SiteScope (11.23)
Page 206 of 926
Chapter 23: DHCP Monitor
This monitor enables you to monitor a DHCP Server by using the network. It verifies that the DHCP
server is listening for requests and that it can allocate an IP address in response to a request.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the DHCP monitor.
Learn About
DHCP Monitor Overview
If your DHCP server fails, machines relying on DHCP are unable to acquire a network configuration
when rebooting. Additionally, as DHCP address leases expire on already-configured machines,
those machines drop off the network when the DHCP server fails to renew their address lease.
Most networks have a DHCP server listening for DHCP requests. This monitor finds DHCP
servers by broadcasting a request for an IP address and waiting for a DHCP server to respond.
Each time the DHCP monitor runs, it returns a status and writes it in the monitoring log file. It also
writes the total time it takes to receive and release an IP address in the log file. Your DHCP server
is a critical part of providing functionality to other hosts on your network, so it should be monitored
about every 10 minutes.
Tasks
How to Configure the DHCP Monitor
1. Prerequisites
This monitor requires that a third-party Java DHCP library be installed on the server where
SiteScope is running. The DHCP monitor type does not appear in the interface until this library
is installed.
a. Download the jDHCP library (either in .zip or in .tar.gz format).
b. Extract the file named JDHCP.jar and copy it to the <SiteScope root directory>\WEBINF\lib directory.
c. After installing the JDHCP.jar file, restart the SiteScope service.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 207 of 926
Monitor Reference
Chapter 23: DHCP Monitor
UI Descriptions
DHCP Monitor Settings
User interface elements are described below:
UI Element
Description
Timeout
Amount of time, in seconds, to wait for an IP address.
Default value: 10 seconds
Requested client address
IP address to request from the DHCP server.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 208 of 926
Chapter 24: Directory Monitor
The Directory monitor enables you to monitor an entire directory and report on the total number of
files in the directory, the total amount of disk space used, and the time (in minutes) since any file in
the directory was modified. This information is useful if you have limited disk space, you want to
monitor the number of files written to a specific directory, or you want to know the activity level in a
certain directory.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Directory monitor.
Learn About
This section includes:
l
"Directory Monitor Overview" below
l
"Supported Platforms/Versions" below
Directory Monitor Overview
Use the Directory monitor to monitor directories that contain log files or other files that tend to grow
and multiply unpredictably. You can instruct SiteScope to notify you if either the number of files or
total disk space used gets out of hand. You can also use this to monitor directories in which new
files are added and deleted frequently. For example, in the case of an FTP directory, you probably
want to watch both the number of files in the directory and the files contained in the directory.
You can set up thresholds for this monitor based on the time in minutes since the latest time a file in
the directory has been modified, as well as the time in minutes since the first time a file in the
directory has been modified.
Because the uses for the Directory monitor vary so greatly, there is no one interval that works best.
Keep in mind that if you are watching a directory that contains a lot of files and sub directories, this
monitor may take longer to run.
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports monitoring remote servers running on HP NonStop operating systems.
For details on enabling the HP NonStop operating system monitoring environment, see "How to
Configure the HP NonStop Resources Monitor" on page 307.
HP SiteScope (11.23)
Page 209 of 926
Monitor Reference
Chapter 24: Directory Monitor
Tasks
How to Configure the Directory Monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Directory Monitor Settings
User interface elements are described below:
UI Element
Description
Server
Server where the directory you want to monitor is running. Select a server from
the server list (only those remote servers that have been configured in
SiteScope are displayed). Alternatively, click the Browse Servers button to
select a server from the local domain, or Add Remote Server to add a new
server.
Note: Monitoring log files using SSH on Windows platforms is supported for
this monitor only if the remote SSH server supports SSH File Transfer
Protocol.
Note when working in template mode: You can use the template remote
server (if one was created) without having to enter its name, by selecting the
Use already configured template remote under current template check
box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select
the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible
in the local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges
or authenticated access to the remote server. For details on how to configure a
remote Windows server, see How to Configure SiteScope to Monitor a Remote
Microsoft Windows Server in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 210 of 926
Monitor Reference
Chapter 24: Directory Monitor
UI Element
Description
Add Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of
remote you want to add (Windows or UNIX), and enter the configuration
details.
For details on the Microsoft Windows Remote Servers user interface, see
New/Edit Microsoft Windows Remote Server Dialog Box in the Using
SiteScope Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX
Remote Server Dialog Box in the Using SiteScope Guide.
Directory path
Directory that you want to monitor.
l
To monitor directories on a remote Windows server through NetBIOS, the
path should contain the name of the shared folder for remote NetBIOS
servers. You can also specify an absolute path of the directory on the
remote machine without specifying the server name. For example, if you
type c:\test, the remote directory is accessed as \\Server\C$\test.
l
To monitor a directory on a remote Windows SSH machine, the path must
be relative to the home directory of the user account used to log on to the
remote machine.
l
To monitor a directory on remote UNIX machines, the path must be relative
to the home directory of the UNIX user account used to log on to the remote
machine. You must also select the corresponding remote UNIX server in
the Servers box described above. For details on which UNIX user account
to use for the applicable remote server, see Configuring SiteScope to
Monitor Remote Windows Servers in the Using SiteScope Guide.
To monitor a directory that is created automatically by some application and
the directory path includes date or time information, you can use SiteScope's
special data and time substitution variables in the path of the directory. For
details, see SiteScope Date Variables in the Using SiteScope Guide.
No
Subdirectories are not included in the match count.
subdirectories
File name
match
Text or an expression to match against. Only file names which match are
counted in the totals.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• # of files
• Total disk space used
HP SiteScope (11.23)
Page 211 of 926
Monitor Reference
Chapter 24: Directory Monitor
• first time since modified - This counter shows the modification date for the latest accessed file in
the directory. If the directory contains no files, it shows the time that the last file was removed from
the directory, or the time that the directory was created.
Tips/Troubleshooting
General Tips/Limitations
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
HP SiteScope (11.23)
Page 212 of 926
Chapter 25: Disk Space Monitor (Deprecated)
Use the Disk Space monitor to track how much disk space is currently in use on your server.
Note: The Disk Space monitor was deprecated and replaced by the "Dynamic Disk Space
Monitor" on page 220. Disk Space monitors configured in previous versions still work when
upgrading to SiteScope 11.2x.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Disk Space monitor.
Learn About
This section includes:
l
"Disk Space Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" on the next page
Disk Space Monitor Overview
Use the Disk Space monitor to monitor the amount of disk space that is currently in use on your
server. Having SiteScope verify that your disk space is within acceptable limits can save you from
a failed system and corrupted files.
The disk space monitor does not require many resources, so you can check it as often as every 15
seconds, but every 10 minutes should be sufficient. You may want to have SiteScope run a script
(using a Script Alert) that deletes all files in certain directories, such as /tmp, when disk space
becomes constrained. For details on using a Script Alert, see Working with Script Alerts in the
Using SiteScope Guide.
Note: There is also a dynamic version of this monitor that automatically adds or removes
counters and thresholds that measure the disk according to changes in the environment. For
details, see "Dynamic Disk Space Monitor" on page 220.
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on HP NonStop operating systems.
For details on enabling the HP NonStop operating system monitoring environment, see "How to
HP SiteScope (11.23)
Page 213 of 926
Monitor Reference
Chapter 25: Disk Space Monitor (Deprecated)
Configure the HP NonStop Resources Monitor" on page 307.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
l
To monitor Microsoft Windows Server 2008 using WMI, install the Microsoft hot fix
(http://support.microsoft.com/kb/961435) on the target Windows system.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Disk Space Monitor
1. Prerequisites
You must have domain privileges or authenticated access to the remote Windows or UNIX
server, and specify valid user credentials. The user specified in the Credentials section must
have sufficient permissions to connect to and gather information from the remote server disk
drives. On UNIX systems, the defined user must have privileges to execute a command to
retrieve available mounted disks (for example, on Linux: /bin/df -k <disk>).
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 214 of 926
Monitor Reference
Chapter 25: Disk Space Monitor (Deprecated)
Tip: The Performance Counters Tool is available when configuring this monitor to
check performance counters on a specific machine in a Windows network (provided you
are an administrator in SiteScope, or a user granted Use monitor tools permissions). To
use the tool when configuring or editing a monitor, click the Use Tool button. For details
on the tool, see Performance Counters Tool in the Using SiteScope Guide.
UI Descriptions
Disk Space Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Server where the disk space you want to monitor is running. Select a server from the
server list (only those remote servers that have been configured in SiteScope are
displayed). Alternatively, click the Browse Servers button to select a server from
the local domain, or Add Remote Server to add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 215 of 926
Monitor Reference
Chapter 25: Disk Space Monitor (Deprecated)
UI
Element
Add
Remote
Server
Description
Opens the Add Remote Server dialog box, enabling you to select the type of remote
you want to add (Windows or UNIX), and enter the configuration details.
For details on the Microsoft Windows Remote Servers user interface, see New/Edit
Microsoft Windows Remote Server Dialog Box in the Using SiteScope Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX Remote
Server Dialog Box in the Using SiteScope Guide.
Disk/File Disk drive to monitor.
system
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
Tips
This monitor supports setting fractional thresholds which are more useful than setting whole
number thresholds when monitoring large disks (such as 1 terabyte and larger).
Troubleshooting and Limitations
WMI Returns Incorrect Disk Space Values
Due to a limitation with WMI, the WMI connection method returns incorrect results when this
monitor is used on Windows Server 2008.
Workaround: To monitor Windows Server 2008 using WMI, install the Microsoft hot fix
(http://support.microsoft.com/kb/961435/en-us) on the target Windows system.
HP SiteScope (11.23)
Page 216 of 926
Chapter 26: DNS Monitor
This monitor enables you to monitor your Domain Name Servers (DNS) to verify that they are
working properly.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the DNS monitor.
Learn About
DNS Monitor Overview
Use the DNS monitor to monitor your Domain Name Servers (DNS) to verify that they are working
properly. If your DNS server is not working properly, you cannot get out on the network, and people
trying to reach your server are not able to find it using the server name (they can connect to it using
the IP address only).
The DNS monitor checks your DNS server by using the network; verifies that the DNS server is
accepting requests; verifies that the address for a specific domain name can be found; and returns
a status and writes it in the monitoring log file with each running.
Most companies have both a primary and a secondary DNS server. If your company employs a
firewall, these DNS servers may sit outside the firewall with another DNS server located inside the
firewall. This internal DNS server provides domain name service for internal machines. It is
important to monitor all of these servers to check that each is functioning properly.
If you have both a primary and secondary DNS server outside your firewall and an internal DNS
server inside your firewall, you should monitor your internal server and your primary DNS server
every 2-5 minutes. You can monitor the secondary DNS server less frequently (about every 10-15
minutes). To use this monitor, the TCP/IP protocol must be installed.
Tasks
How to Configure the DNS Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The DNS Lookup Tool is available when configuring this monitor to look up names from
a Domain Name Server and show you the IP address for a domain name (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions). To use the tool
when configuring or editing a monitor, click the Use Tool button. For details on the tool, see
DNS Tool in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 217 of 926
Monitor Reference
Chapter 26: DNS Monitor
UI Descriptions
DNS Monitor Settings
User interface elements are described below:
UI Element
Description
IP address of IP address of the DNS server that you want to monitor.
DNS server to
Example: 206.168.191.1
monitor
Host name to
resolve
Host name to lookup. If you only want to verify that your DNS server is
operating, the host name you enter here can be any valid host name or domain
name.
Example: demo.thiscompany.com
To verify that a domain name resolves to a specific IP address, enter the IP
address that corresponds to the host name you enter in the Expected IP
address box.
IP address or
addresses
mapped to
the host to
verify that it
resolves
correctly
IP address or addresses that are mapped to the Host name to resolve
(domain name) entered above. You can use the DNS monitor to verify that a
host name or domain name resolves to the correct IP address or addresses.
Note: If you enter more than one IP address, the monitor reports a status of
good, even if only one of the IP addresses that you enter is mapped correctly to
the Host name to resolve. When using this option, the monitor only reports an
error if none of the IP addresses entered here are mapped to the given Host
name to resolve. When entering multiple IP addresses, separate them with a
comma (",").
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
Troubleshooting and Limitations
l
If the SiteScope server cannot reach a DNS server that is running (no ping to host), and there are
no network connectivity issues, check the TCP/IP client configuration settings on the DNS
server. Also verify that the DNS server itself does not a connectivity issue.
l
If the SiteScope server does not get a response to name resolution requests (even though it can
ping the DNS server), ask your network administrator to verify that the DNS Server service is
enabled and running on the DNS server.
HP SiteScope (11.23)
Page 218 of 926
Monitor Reference
Chapter 26: DNS Monitor
If the DNS server responds to queries for name resolution but with the incorrect information, it
might be because the DNS server has incorrect or outdated information in its resource records
for the specific zone. This situation can be due to a number of issues, including the following
(should be managed by network administrator):
l
n
If administrators are manually creating and updating resource records, the incorrect information
might have been inserted into the zone database file by the individual updating the resource
records. To rectify this issue, you would have to manually verify the validity of each resource
record.
n
If the DNS server is configured for dynamic updates, verify that dynamic updates have indeed
occurred. If no dynamic updates have occurred, this would be the reason that the DNS server
responded to SiteScope requests with outdated information. If the issue still persists, verify
that the DNS server is configured for dynamic updates.
n
The DNS server might be incorrectly resolving names from a secondary DNS server due to
zone transfer not occurring for the specific secondary DNS server. This would result in the
secondary zone database file containing the incorrect information. To rectify this issue,
manually force a zone transfer to ensure that the secondary DNS zone database file contains
updated information.
HP SiteScope (11.23)
Page 219 of 926
Chapter 27: Dynamic Disk Space Monitor
The Dynamic Disk Space monitor tracks how much disk space is currently in use on your server.
When dynamic monitoring is configured, the counters and thresholds are automatically updated as
disks are added to or removed from the server. This enables you to configure the monitor once, and
leave it to detect disks and file systems changes.
Note: The Dynamic Disk Space monitor replaces the Disk Space monitor that was deprecated
in SiteScope 11.20. Disk Space monitors configured in previous versions will work when
upgrading to SiteScope 11.20.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Dynamic Disk Space monitor.
Learn About
This section includes:
l
"Dynamic Disk Space Monitor Overview" below
l
"Supported Platforms/Versions" on the next page
l
"Dynamic Disk Space Monitor" above
l
"Monitor Run Frequency" on the next page
l
"IPv6 Addressing Supported Protocols" on the next page
l
"Dynamic Disk Space Monitor Topology" on page 222
Dynamic Disk Space Monitor Overview
Use the Dynamic Disk Space monitor, an advanced version of the Disk Space monitor, to monitor
the amount of disk space that is currently in use on your server. This monitor enables you to:
l
Monitor specific disks and counters on a host server using static counters. You can select one
or multiple disks to monitor.
l
Monitor changes in the host server's disks that correspond to a defined counter pattern.
Dynamic monitoring enables you to configure the monitor once, and leave it to discover the
addition and removal of disks and file systems in the environment and update itself.
When configuring a dynamic monitor, you can define a counter pattern that specifies the disks and
counters you want to monitor. You can also define the required thresholds for the counter's pattern.
The monitor scans the target host periodically, and creates the counters that are aligned with the
given counter pattern.
HP SiteScope (11.23)
Page 220 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
If a new disk (or mount) is added to the machine and that disk corresponds to the counter pattern,
the counters and thresholds that measure the disk are automatically added to the monitor when the
counters are next updated from the server. Similarly, if a disk that corresponds to the counter
pattern is no longer available, counters and thresholds for that disk are removed from the monitor
(unless you choose not to delete them, in which case they are still displayed in the monitor's
counter list).
For more details on the dynamic monitoring mechanism, see Dynamic Monitoring Mechanism in the
Using SiteScope Guide.
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports monitoring remote servers running on HP NonStop operating systems.
For details on enabling the HP NonStop operating system monitoring environment, see "How to
Configure the HP NonStop Resources Monitor" on page 307.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
Monitor Run Frequency
The Dynamic Disk Space monitor does not require many resources, so you can run it as often as
every 15 seconds, but every 10 minutes should be sufficient. You may want to have SiteScope run
a script (using a Script Alert) that deletes all files in certain directories, such as /tmp, when disk
space becomes constrained. For details on using a Script Alert, see Working with Script Alerts in
the Using SiteScope Guide.
Note: The frequency for updating counters from the server cannot be less than the monitor run
frequency in Monitor Run Settings.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
HP SiteScope (11.23)
Page 221 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Dynamic Disk Space Monitor Topology
The Dynamic Disk Space monitor can identify the topology of the server disks being monitored.
The monitor creates the following topology in BSM's RTSM.
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 222 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
Tasks
How to Configure the Dynamic Disk Space Monitor
1.
2.
Prerequisites
n
You must have domain privileges or authenticated access to the remote Windows or UNIX
server, and specify valid user credentials. The user specified in the Credentials section
must have sufficient permissions to connect to and gather information from the remote
server disk drives.
n
On UNIX systems, the defined user must have privileges to execute a command to retrieve
available mounted disks (for example, on Linux: /bin/df -T <disk>).
Configure the monitor properties
a. Right-click the group into which you want to add the monitor instance, select New >
Monitor, and select Dynamic Disk Space. The New Dynamic Disk Space Monitor dialog
box opens. For monitor user interface details, see "Dynamic Disk Space Monitor Settings"
on page 226.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the Dynamic Disk Space Monitor Settings panel, select the server where the disk space
you want to monitor is running.
d. In the Counter Settings section, click the Get Counter button, and select the disk and
counters you want to monitor from the Select Counters Form (the form displays static
counters only). The counters are added to the Counter Preview tree.
Tip: The Performance Counters Tool is available when configuring this monitor to
check performance counters on a specific machine in a Windows network (provided
you are an administrator in SiteScope, or a user granted Use monitor tools
permissions). To use the tool when configuring or editing a monitor, click the Use Tool
button. For details on the tool, see Performance Counters Tool in the Using SiteScope
Guide.
e. The default counter patterns are displayed in the Patterns & Counters table. You can add
other patterns to counters to instruct the monitor which counters to use. You can either:
o
Click the Add New Counter
button to add an empty line to the table, and create a
pattern format using a regular expression. By default the following counters are created:
HP SiteScope (11.23)
Page 223 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
Counter Pattern
Description
/.*/MB free/
Measures the amount of free memory.
/.*/MB total/
Measures the total amount of memory.
/.*/percent full/
Measures the percentage of the file system that is full.
Tip:
(1). The pattern should always start and end with the forward slash ("/") character.
(2). The "[" and "]" characters which appear as part of counter names should be
escaped (preceded with the backslash ("\") character).
(3). Use ".*" to describe any character any number of times.
o
Select a static counter, and edit the counter to create a pattern format using a regular
expression. For details on using regular expressions, see Regular Expressions
Overview in the Using SiteScope Guide.
Example:
If you enter the pattern /.*/.*platform.*/MB free/, the monitor retrieves the MB
free counters on disks that contain the word platform in their file system's name.
f. To view the counters that match a selected pattern, click the View Matches for selected
Pattern
button. The matching counters are highlighted in the Counter Preview tree.
g. Set the frequency for updating counters from the server, and then click Verify & Save or
Save to save your settings. If you use only static counters, they are not affected by the
frequency for updating counters, since the dynamic framework does not run.
h. To display counters that no longer exist after the update mechanism runs, select Continue
displaying counters that no longer exist after update. Any such counters are displayed
as unavailable. This can be useful if a disk fails or for keeping track of the counters that
were previously being monitored.
i. In the Threshold Settings tab, you can manually set logic conditions for the dynamic
counters that determine the reported status of each monitor instance. To view thresholds of
all patterns translated to actual current counters, click the Threshold Preview button.
For threshold user interface details, see Threshold Settings in the Using SiteScope Guide.
Note: When configuring threshold settings for Dynamic Disk Space monitor:
HP SiteScope (11.23)
Page 224 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
3.
o
The monitor always(default) counter configured in the Good if section of the
monitor's properties means that the state of the monitor is good, unless one of the
thresholds of any of the other counters is breached.
o
The countersinError counter configured in the Error if section of the monitor's
properties means that the state of the monitor is error if one of the other counters is
unavailable.
Enable topology reporting - optional
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "Dynamic Disk Space Monitor Topology" on page 222.
For user interface details, see "BSM Integration Data and Topology Settings" in the Using
SiteScope Guide.
4.
Results
If you are using the dynamic monitoring mechanism, during each update, the monitor connects
to the server where the disk space you want to monitor is running and updates the status of
each counter that matches the pattern defined by the regular expression. It also updates the
thresholds for the selected counters.
You can check performance of the dynamic monitoring framework in:
n
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details,
see Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
n
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic
Monitoring Page in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 225 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
UI Descriptions
Dynamic Disk Space Monitor Settings
User interface elements are described below:
UI Element
Description
Server
Server where the disk space you want to monitor is running. Select a server
from the server list (only those remote servers that have been configured in
SiteScope are displayed). Alternatively, click the Browse Servers button to
select a server from the local domain, or Add Remote Server to add a new
server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use
already configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select
the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible
in the local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Serverslist because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges
or authenticated access to the remote server. For details on how to configure a
remote Windows server, see How to Configure SiteScope to Monitor a Remote
Microsoft Windows Server in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 226 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
UI Element
Description
Add Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of
remote you want to add (Windows or UNIX), and enter the configuration details.
For details on the Microsoft Windows Remote Servers user interface, see
New/Edit Microsoft Windows Remote Server Dialog Box in the Using
SiteScope Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX
Remote Server Dialog Box in the Using SiteScope Guide.
Counter Settings
Get Counters
Opens a tree of all current counters, enabling you to select the counters you
want to monitor. The tree is opened with no nodes selected. When you make a
selection in the tree, the counters table is updated.
Patterns &
Counters
Displays the server performance counters selected for this monitor. Use the
Get Counters button to select counters.
Click the Add New Counter
button to add an empty row at the bottom of
the counters tree, enabling you to manually add a counter.
Click the Delete Counter
button to remove the selected counters from the
list. You can select multiple items using the CTRL or SHIFT keys.
Click the View Matches for Selected Pattern Counter
counters that match the selected patterns.
button to display
Note: SiteScope uses Perl regular expressions for pattern matching. For
example, if you enter /cpu.*/ or cpu, any counters with cpu in their name
match this pattern and are added to the counters list.
Counter
Preview
HP SiteScope (11.23)
Displays all real counters in the monitor. This includes static counters and
counter patterns that have been translated to real counters.
Page 227 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
UI Element
Description
Frequency of
updating
counters
from server
Time interval at which the counters that are requested by this monitor are
retrieved from the server, and the monitor is updated with counter pattern
matches. Use the drop-down list to specify increments of seconds, minutes,
hours, or days.
Default value: 1 hour
Note:
Continue
displaying
counters that
no longer
exist after
update
l
The update frequency cannot be less than the monitor run frequency in
Monitor Run Settings.
l
When configuring this setting in a template, the variable value can only be in
time units of seconds.
l
Static counters are never deleted.
When selected, counters that no longer exist after running the update
mechanism to retrieve counters from the monitored server, are not deleted and
are still displayed in the monitor (they are displayed as unavailable). This is
useful, for example, if a disk fails or for keeping track of counters that were
previously being monitored.
When cleared, the counters that no longer exist are removed from the Counter
Preview and Threshold Settings on the next update.
Default value: Selected
Note: This option is relevant for dynamic counters only (those set using a
regular expression). Static counters that are no longer available are still
displayed even when this check box is cleared.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Notes
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
When deploying these monitors using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 228 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
l
When SiteScope is connected to BSM 9.00 or later, the Indicator State and Severity column is
not displayed in Threshold Settings by default. This is because each counter pattern can affect
more than one measurement, and only static counters and counter patterns are displayed by
default. This column is displayed only when you click the Threshold Preview button
(thresholds of all patterns are translated to actual current counters and are displayed).
l
This monitor supports setting fractional thresholds which are more useful than setting whole
number thresholds when monitoring large disks (such as 1 terabyte and larger).
l
Baseline Settings are not available for dynamic monitors (these monitors configure their own
thresholds).
Troubleshooting and Limitations
This section describes troubleshooting and limitations for Dynamic Disk Space monitors.
l
"WMI Returns Incorrect Disk Space Values" below
l
"Unable to get counters from Red Hat Enterprise Linux about network file systems" below
l
"Maximum Number of Counters That Can be Saved" on the next page
WMI Returns Incorrect Disk Space Values
Due to a limitation with WMI, the WMI connection method returns incorrect results when this
monitor is used on Windows Server 2008.
Workaround: To monitor Windows Server 2008 using WMI, install the Microsoft hot fix
(http://support.microsoft.com/kb/961435/en-us) on the target Windows system.
Unable to get counters from Red Hat Enterprise Linux about network file
systems
By default, SiteScope is only able to display file systems under /dev. To change this, do the
following:
1. Create a backup of the <SiteScope root directory>/templates.os/Linux.config and
<SiteScope root directory>/templates.os/RedHatEnterpriseLinux.config files.
2. Edit the <SiteScope root directory>/templates.os/Linux.config as follows:
n
Search for "id=disks".
n
Add the following to the bottom of the "id=disks" section (the lines between the #s define
each section):
noNameFilter=true
startLine=2
#
n
Save the file.
HP SiteScope (11.23)
Page 229 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
3. Repeat for the <SiteScope root directory>/templates.os/RedHatEnterpriseLinux.config
file.
4. Restart SiteScope.
Maximum Number of Counters That Can be Saved
Browsable monitors are limited by the number of counters they have. The maximum number of
counters is determined by the _browsableContentMaxCounters parameter in the master.config
file (also in Preferences > Infrastructure Preferences > Monitor Settings > Maximum
browsable counters to be selected). If you create or edit a monitor so that it has more counters
than this value, only the number of counters up to this value is saved.
When a browsable monitor is deployed in a template, the number of counters that match the
selected patterns is limited by the _maxCountersForRegexMatch parameter in the master.config
file. If during deployment, the number of counters that match the patterns exceeds this value, only
the number of counters up to this value is saved.
The _maxCountersForRegexMatch parameter is also used to limit the number of counters that
match the selected counter patterns when creating and updating dynamic monitors. We
recommend using the same value for both _browsableContentMaxCounters and _
maxCountersForRegexMatch parameters in the master.config file. The default value for both of
these parameters is 1000.
When upgrading from earlier versions of SiteScope, the value for both of these parameters is set to
the higher of these two parameter values in the previous version, or to 1000 (whichever is greater).
Troubleshooting Logs
1. Check for dynamic framework errors in:
n
<SiteScope root directory>\logs\dynamic_monitoring_changes.log. This log describes
monitor changes made by the dynamic framework (adding/removing counters), including the
monitor name and counter name.
n
<SiteScope root directory>\logs\dynamic_monitoring.log. This log describes all the
tasks being run by the dynamic framework (counters extracted from the server, counters
matched to patterns, and so on).
To check for dynamic monitoring errors, copy the following section from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
###################################################################################
# Dynamic Monitoring
###################################################################################
log4j.category.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=
DEBUG, dynamic.monitoring.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=false
log4j.category.com.mercury.sitescope.entities.monitors.dynamic=DEBUG,
HP SiteScope (11.23)
Page 230 of 926
Monitor Reference
Chapter 27: Dynamic Disk Space Monitor
dynamic.monitoring.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.dynamic=false
log4j.appender.dynamic.monitoring.appender=org.apache.log4j.RollingFileAppender
log4j.appender.dynamic.monitoring.appender.File=../${log.file.path}/dynamic_monitoring.l
og
log4j.appender.dynamic.monitoring.appender.MaxFileSize=1000KB
log4j.appender.dynamic.monitoring.appender.MaxBackupIndex=5
log4j.appender.dynamic.monitoring.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.dynamic.monitoring.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p
- %m%n
2. Check for Dynamic Disk Space monitor errors in:
n
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific
monitor runs and actions related to managing monitors.
HP SiteScope (11.23)
Page 231 of 926
Chapter 28: Dynamic JMX Monitor
The Dynamic JMX monitor enables you to monitor performance statistics of those Java-based
applications that provide access to their statistics by using the standard JMX remoting technology
defined by JSR 160 (remote JMX). It enables you to select the same measurements that are
available on a JMX monitor, or use the dynamic monitoring mechanism that recognizes changes on
the monitored Java applications to automatically update the MBean counters and thresholds as
they change during runtime.
You can create one JMX monitor instance for each application you are monitoring, or several
monitors for the same application that analyze different counters.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Dynamic JMX monitor.
Learn About
This section includes:
l
"Dynamic JMX Monitor Overview" below
l
"Supported Platforms/Versions" on the next page
l
"Applications Supporting JSR 160" on the next page
l
"WebLogic Application Server Topology" on page 235
l
"Connection Pool Settings" on page 236
l
"Thread Pool Settings" on page 237
Dynamic JMX Monitor Overview
This monitor enables you to:
l
Use static counters. Monitor specific counters on a JMX application using static counters. You
can monitor multiple parameters or counters with a single monitor instance. The counters
available vary from application to application, but normally include both basic JVM performance
counters, as well as counters specific to the application.
l
Use dynamic monitoring. Select the counter patterns you want to monitor using a regular
expression or a static string, and let the monitor dynamically update MBean counters that match
the pattern defined by the regular expression. Dynamic monitoring enables you to configure the
monitor on a one time basis, and leave it to update itself.
When configuring a dynamic monitor, you can define a counter pattern that specifies the MBean
counters you want to monitor. The monitor scans the target host periodically, and creates the
counters that are aligned with the given counter pattern.
HP SiteScope (11.23)
Page 232 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
If a new MBean is added to the machine and part or all of its counters correspond to the counter
pattern, the counters that match the counter pattern are automatically added to the monitor when
the counters are next updated from the server. Similarly, if an MBean that corresponds to the
counter pattern is no longer available, counters for that MBean are removed from the monitor
(unless you choose not to delete them, in which case they are still displayed in the monitor's
counter list).
You can also define the required thresholds for the counter's pattern. In this way, thresholds are
also updated automatically when the counters are updated.
For more details on the dynamic monitoring mechanism, see Dynamic Monitoring Mechanism in
the Using SiteScope Guide.
Note:
l
The Dynamic JMX or JMX monitor is used for monitoring WebLogic 11g (10.3.1-10.3.5)
servers. For details, see "How to Configure the Dynamic JMX Monitor" on page 238.
l
When monitoring a WebLogic Application Server using a t3 or t3s protocol, you need to use
WebLogic's own protocol provider package. For details, see "How to monitor a WebLogic
10.0, 10.3, or 11g (10.3.1-10.3.5) server with an SSL connection using the t3, t3s, iiop or
iiops protocol" on page 241.
l
SiteScope also provides a solution template that includes a set of predefined monitors to
create a monitoring solution for various aspects of a WebLogic Application server. For
details, see WebLogic Solution Templates in the Using SiteScope Guide.
Supported Platforms/Versions
This monitor supports monitoring on:
l
WebLogic 11g (10.3.1-10.3.5)
l
Apache Tomcat 5.0, 5.5, 6.0, 6.0.33, 7.0.25
l
Oracle Application Server 10.1.3g
l
JBoss servers 4.0.3, 4.2, 5.0, 5.1, 6.0, 6.1, 7.0, 7.1.x
l
Sun Glassfish Enterprise Server 2.1, 3.1
Applications Supporting JSR 160
Here are some applications that currently support JSR 160 and information about how to monitor
them:
l
Oracle WebLogic 11g (10.3.1-10.3.5) support JSR 160, which can be enabled on the WebLogic
application server by following instructions found on the Oracle Web site
(http://download.oracle.com/docs/cd/E14571_
HP SiteScope (11.23)
Page 233 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
01/apirefs.1111/e13952/taskhelp/channels/EnableAndConfigureIIOP.html).
Once enabled, the JMX URL for monitoring the server follows the following form:
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime
or
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
where <host> is the server name or IP address that is running your WebLogic application.
Tomcat 5.x and 6.0 support JSR 160, by defining the following properties to the JVM on startup:
l
n
Dcom.sun.management.jmxremote
n
Dcom.sun.management.jmxremote.port=9999
n
Dcom.sun.management.jmxremote.ssl=false
n
Dcom.sun.management.jmxremote.authenticate=false
The above properties specify the port as 9999. This value can be changed to any available port.
Also, it specifies no authentication. If authentication is necessary, see the Oracle Web site for
more details (http://download.oracle.com/javase/1.5.0/docs/guide/jmx/tutorial/security.html).
If the above properties are defined when starting Tomcat 5.x on <host>, the following would be
the JMX URL for monitoring it:
service:jmx:rmi:///jndi/rmi://<host>:9999/jmxrmi
Note: SiteScope 8.x runs within Tomcat 5.x, and can be monitored as described above.
l
JBoss 4.0.3 supports JSR 160, by defining the following properties to the JVM on startup:
n
-Dcom.sun.management.jmxremote
n
-Dcom.sun.management.jmxremote.port=9999
n
-Dcom.sun.management.jmxremote.ssl=false
n
-Dcom.sun.management.jmxremote.authenticate=false
n
-Djboss.platform.mbeanserver
n
Djavax.management.builder.initial=org.jboss.system.server.jmx.MBeanServerBu
ilderImpl
HP SiteScope (11.23)
Page 234 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
l
l
JBoss 6.1 supports JSR 160, by defining the following properties to the JVM on startup:
n
-Dcom.sun.management.jmxremote
n
-Dcom.sun.management.jmxremote.port=9999
n
-Dcom.sun.management.jmxremote.authenticate=false
n
-Dcom.sun.management.jmxremote.ssl=false
n
-Djboss.platform.mbeanserver
n
-Djavax.management.builder.initial=org.jboss.system.server.
jmx.MBeanServerBuilderImpl
n
-Djava.endorsed.dirs="%JBOSS_ENDORSED_DIRS%"
n
-classpath "%JBOSS_CLASSPATH%" org.jboss.Main %*
Other vendors that have released versions of their software that are JSR 160 compliant, include
JBoss, Oracle 10g, and IBM WebSphere.
You can find more information about JSR 160 on the Java Community Process Web site
(http://www.jcp.org/en/jsr/detail?id=160).
WebLogic Application Server Topology
The Dynamic JMX monitor can identify the topology of WebLogic Application Servers. If Report
monitor and related CI topology is selected in HP Integration Settings (the default setting), the
monitor creates the following topology in BSM's RTSM.
Note: The Dynamic JMX monitor can report topology data to BSM only when monitoring the
WebLogic application server, not when monitoring any other environment.
HP SiteScope (11.23)
Page 235 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
Connection Pool Settings
The Dynamic JMX monitor uses connection pools to reduce the load on the JMX infrastructure and
SiteScope. Connection pools provide reusable connections by the monitor itself during different
monitor runs, and by several monitors that use the same connection details.
The connection pool is a set of pools per key. A key is the combination of a JMX URL, a user, and a
password. If all JMX monitors are configured with the same JMX URL, user, and password, one
connection pool is created. For two JMX applications and two different users, four connection pools
are created.
The connection pool evicts idle connections according to the maximum number of idle connections
allowed (configurable in Dynamic JMX connection pool: maximum idle connections in pool
(per key)). Connections are evicted based on evictable idle time (configurable in Dynamic JMX
connection pool: minimum evictable idle time (milliseconds)) and running the eviction thread
(configurable in Dynamic JMX connection pool: time between eviction runs (milliseconds)).
Process for Requesting a Connection from the PooI
1. If the connection pool key does not exist yet, a new pool is created for this key.
2. If the pool exists and there is an idle connection, the connection is returned.
3. If there is not an idle connection, a new connection is created until the maximum number of
active connections in the pool is reached (Dynamic JMX connection pool: maximum active
connections in pool (per key)), or until the maximum total connections in the pool is reached
(Dynamic JMX connection pool: total number of connections for whole pool).
4. When the maximum number of active connections in the pool (per key) or maximum total
connections is reached, the monitor waits x milliseconds (Dynamic JMX connection pool:
waiting for connection timeout (milliseconds)) for a connection to be freed.
5. If one of the connections is freed in the meantime, it will be returned. Otherwise, the connection
fails.
You can tune the following connection pool properties in Preferences > Infrastructure
Preferences > Monitor Settings, as required:
l
Dynamic JMX connection pool: minimum evictable idle time (milliseconds): The
minimum time that a connection must be idle before the eviction thread can evict it. Note that the
actual amount of time a connection will be idle depends on when the eviction thread runs
(Dynamic JMX connection pool: time between eviction runs (milliseconds)). The default value is
1800000 milliseconds (30 minutes).
l
Dynamic JMX connection pool: time between eviction runs (milliseconds): Interval
between eviction thread runs for closing idle connections. The default value is 600000
milliseconds (10 minutes).
l
Dynamic JMX connection pool: maximum active connections in pool (per key): The
HP SiteScope (11.23)
Page 236 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
maximum number of active connections that can be open in the connection pool at the same
time per key. (The connection pool is a set of pools per key. A key is the combination of a JMX
URL, a user, and a password). The default value is 10.
l
Dynamic JMX connection pool: maximum idle connections in pool (per key): The
maximum number of idle connections in the connection pool (per key). (The connection pool is a
set of pools per key. A key is the combination of a JMX URL, a user, and a password). When
this value is exceeded, the number of unused connections that exceed this value are closed
rather than kept in the connection pool. The default value is 5.
l
Dynamic JMX connection pool: total number of connections for whole pool: The total
number of dynamic JMX connections available for the JMX connection pool (for all the keys
together). When this number is exceeded, the number of connections that exceed this value are
closed. The default value is 500.
l
Dynamic JMX connection pool: waiting for connection timeout (milliseconds): The
amount of time to wait for a connection from the JMX connection pool before timing out. The
default value is 60000 milliseconds (1 minute).
Thread Pool Settings
The Dynamic JMX monitor always uses a separate thread pool to bring information (counter names
and values) from the JMX server (unlike the JMX monitor which has two modes for using thread
pools: regular mode and sandbox mode).
You can configure JMX thread pool settings in Preferences > Infrastructure Preferences >
Monitor Settings. These settings are for each thread pool. A new thread pool is created for each
additional classpath used by the Dynamic JMX monitor. The same thread pool is used for all
Dynamic JMX monitors that do not use an additional classpath.
l
JMX thread pool core size: Number of threads to keep in the JMX pool that can be created for
JMX tasks, even if they are idle. The default value is 10.
l
JMX thread pool idle time (seconds): When the number of threads is greater than the core,
this is the maximum time that excess idle threads will wait for new JMX tasks before timing out.
The default value is 30 seconds.
l
JMX thread pool maximum size: Maximum number of threads to allow in the pool. If the
number of threads in the pool is greater than the core but less than the maximum and the queue
is full, then new threads will be created for the JMX tasks until the maximum number of threads
in pool is reached. The default value is 200.
l
JMX thread pool queue size: Maximum number of JMX tasks that can be added to the queue.
If all the core threads are busy now, the new tasks will be added to queue until the max queue
size is reached. The default value is 400.
HP SiteScope (11.23)
Page 237 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
Tasks
This section includes the following tasks:
l
"How to Configure the Dynamic JMX Monitor" below
l
"How to monitor a WebLogic 10.0, 10.3, or 11g (10.3.1-10.3.5) server with an SSL connection
using the t3, t3s, iiop or iiops protocol" on page 241
How to Configure the Dynamic JMX Monitor
1.
Configure the monitor properties
a. Right-click the group into which you want to add the monitor instance, select New >
Monitor, and select Dynamic JMX. The New Dynamic JMX Monitor dialog box opens.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the Dynamic JMX Monitor Settings panel, enter the required settings as described in
"Dynamic JMX Monitor Settings" on page 244.
o
For a WebLogic 9.x, 10.3, or 11g (10.3.1-10.3.5) server, enter the following when
configuring the monitor:
o
In the JMX URL box, enter:
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime
or
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
o
(For WebLogic 10.3.x and 11g only) In the Additional Classpath box, enter the
wlfullclient.jar.
You can specify the timeout for JMX task execution (mbeans retrieval and
conversion into xml) by modifying the _overallJMXCountersRetrievalTimeout
property in the master.config file. The default value is 15 minutes. This is not an
ORB timeout.
Note: For details on creating the wlfullclient.jar, refer to the Oracle
documentation on Using the WebLogic JarBuilder Tool
(http://download.oracle.com/docs/cd/E12840_
01/wls/docs103/client/jarbuilder.html).
o
For monitoring WebLogic 10.0, 10.3, or 11g using a t3 or t3s protocol: You need to use
HP SiteScope (11.23)
Page 238 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
WebLogic's own protocol provider package as described in "How to monitor a
WebLogic 10.0, 10.3, or 11g (10.3.1-10.3.5) server with an SSL connection using the t3,
t3s, iiop or iiops protocol" on page 241.
o
For a WebLogic 6.x, 7.x, and 8.x server: To help you to select the counters that you
require, you can open a WebLogic monitor for versions prior to WebLogic 9.x and see
the counters that were defined there. Search for these same counters in the counter
tree. You can select additional counters that are available in the JMX monitor and were
not available in the WebLogic monitors.
d. In the Patterns & Counter section, click the Get Counter button, and select the counters
you want to monitor from the Select Counters Form (the form displays static counters
only). The counters are added to the Counter Preview tree.
e. For dynamic monitoring, you can add patterns to counters to instruct the monitor which
counters to use, either by:
o
Clicking the Add New Counter
button to add an empty line to the table, and then
by creating a pattern format using a regular expression.
Tip:
o
The pattern should always start and end with the forward slash ("/") character.
o
The "[" and "]" characters which appear as part of counter names should be
escaped (preceded with the backslash ("\") character)
o
Use ".*" to describe any character any number of times.
For example, /java.lang/Memory/.*/ shows all memory counters that are exposed
by the java.lang domain.
o
Selecting a static counter, and editing the counter to create a pattern format using a
regular expression. For details on using regular expressions, see Regular Expressions
Overview in the Using SiteScope Guide.
Note: For details on the maximum number of counters that can be selected from
the browsable tree and the maximum number of counters that can match the
selected counter patterns when creating and updating dynamic monitors, see
Troubleshooting and Limitations. If the maximum number of counters that can be
deployed is exceeded, an error is written to the RunMonitor.log.
Example:
HP SiteScope (11.23)
Page 239 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
If you enter the pattern /java.lang/ClassLoading/.*/, the monitor retrieves all the
ClassLoading counters in the JMX application, such as TotalLoadedClassCount,
UnloadedClassCount, LoadedClassCount, ObjectName.
f. To view the counters that match a selected pattern, click the View Matches for selected
Pattern
button. The matching counters are highlighted in the Counter Preview tree.
g. Set the frequency for updating counters from the server, and then click Verify & Save or
Save to save your settings. If you use only static counters, they are not affected by the
frequency for updating counters, since the dynamic framework does not run.
h. To display counters that no longer exist after the update mechanism runs, select Continue
displaying counters that no longer exist after update. Any such counters are displayed
as unavailable. This can be useful for keeping track of the counters that were previously
being monitored.
i. In the Threshold Settings tab, you can manually set logic conditions for the dynamic
counters that determine the reported status of each monitor instance. To view thresholds of
all patterns translated to actual current counters, click the Threshold Preview button.
For threshold user interface details, see Threshold Settings in the Using SiteScope Guide.
Note: When configuring threshold settings for the Dynamic JMX monitor:
2.
o
The monitor always(default) counter configured in the Good if section of the
monitor's properties means that the state of the monitor is good, unless one of the
thresholds of any of the other counters is breached.
o
The countersinError counter configured in the Error if section of the monitor's
properties means that the state of the monitor is error if one of the other counters is
unavailable.
Enable topology reporting - optional
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "WebLogic Application Server Topology" on page 235.
For user interface details, see "BSM Integration Data and Topology Settings" in the Using
SiteScope Guide.
3.
Configure connection pool and thread pool settings - optional
You can tune the connection pool and thread pool properties in Preferences > Infrastructure
Preferences > Monitor Settings.
HP SiteScope (11.23)
Page 240 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
For details, see "Connection Pool Settings" on page 236 and "Thread Pool Settings" on page
237.
4.
Results
If you are using the dynamic monitoring mechanism, during each update, the monitor connects
to the server where the JMX performance counters you want to monitor are running and
updates the status of each counter that matches the pattern defined by the regular expression.
It also updates the thresholds for the selected counters.
You can check performance of the dynamic monitoring framework in:
n
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details,
see Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
n
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic
Monitoring Page in the Using SiteScope Guide.
How to create a Dynamic JMX Monitor for Jboss 7.1
Configure the monitor properties as described in the UI Descriptions section below.
Note: To get counters from a JBoss 7.1.x server, you must:
1. Add the following jars to classpath:
n
jboss-common-core.jar
n
jboss-client.jar
2. Select the Load additional classpath first check box.
How to monitor a WebLogic 10.0, 10.3, or 11g (10.3.1-10.3.5) server with an
SSL connection using the t3, t3s, iiop or iiops protocol
When monitoring a WebLogic Application Server using a t3, t3s, iiop or iiops protocol, you need to
use WebLogic's own protocol provider package.
Note:
l
This task is part of a higher-level task. For details, see "How to Configure the Dynamic JMX
Monitor" on page 238.
l
When monitoring a WebLogic server with the Administration port enabled, the t3s protocol
must be used.
HP SiteScope (11.23)
Page 241 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
1. Enter the URL in the following format in the JMX URL box of JMX Monitor Settings:
For t3 protocol:
n
service:jmx:t3://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
where the default port for t3 protocol is 7001
For t3s protocol:
n
service:jmx:t3s://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
where the default port for t3s protocol is 7002
For iiop protocol:
n
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime or
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
For iiops protocol:
n
service:jmx:iiops://host:port/jndi/weblogic.management.
mbeanservers.runtime
2. (For t3 or t3s protocols) Copy the following jars from the WebLogic library to any folder on the
SiteScope server:
n
%WEBLOGIC_HOME%\server\lib\wlclient.jar
n
%WEBLOGIC_HOME%\server\lib\wljmxclient.jar
n
%WEBLOGIC_HOME%\server\lib\weblogic.jar
n
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
n
%WEBLOGIC_HOME%\server\lib\webserviceclient+ssl.jar (for t3s protocol only)
n
%WEBLOGIC_HOME%\server\lib\cryptoj.jar (for t3s protocol only, if this file is present in
WebLogic library)
Specify the full path to the copied jars in the Additional Classpath field in the JMX Monitor
Settings separated by “;”.
HP SiteScope (11.23)
Page 242 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
Note: For details on creating the wlfullclient.jar, refer to the Oracle documentation on
Using the WebLogic JarBuilder Tool (http://download.oracle.com/docs/cd/E12840_
01/wls/docs103/client/jarbuilder.html).
3. (For iiop or iiops protocols) Copy the following jars from the WebLogic library to any folder on
the SiteScope server:
n
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
n
%WEBLOGIC_HOME%\server\lib\wlcipher.jar (for iiops protocol only)
Specify the full path to wlfullclient.jar in the Additional Classpath field in the JMX Monitor
Settings.
For details on creating the wlfullclient.jar, refer to the Oracle documentation on Using the
WebLogic JarBuilder Tool (http://download.oracle.com/docs/cd/E12840_
01/wls/docs103/client/jarbuilder.html).
4. (For t3s and iiops protocols) Enable SSL on the WebLogic server and import the SSL certificate
into the SiteScope keystore. For details, see Certificate Management Overview.
5. Configure the other monitor settings as required.
For details, see Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 243 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
UI Descriptions
Dynamic JMX Monitor Settings
User interface elements are described below:
UI Element
Description
JMX URL
URL to gather JMX statistics. Typically the URL begins with
service:jmx:rmi:///jndi, followed by information specific to the application.
Note:
l
When creating a JMX monitor for a WebLogic 9.x, 10.x, or 11g server, enter
the following URL:
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
or
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime
l
When creating a JMX monitor for a JBoss server, your system administrator
should configure the JBoss server, and then report which ports are enabled for
JMX access.
l
When creating a JMX monitor for a JBoss 7.1 server, enter the following URL:
service:jmx:remoting-jmx://<host>:<port>
l
If you are using a t3 or t3s protocol, you need to use WebLogic's own protocol
provider package and the JMX URL is in a different format. For details, see
"Dynamic JMX Monitor" on page 232.
l
The JMX over RMI protocol is not firewall friendly.
HP SiteScope (11.23)
Page 244 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
UI Element
Description
Domain
filter
Domain filter to show only those counters existing within a specific domain
(optional). This filter does not have full regular expression support.
You can specify the domain name or full path to MBean. The full path can be taken
from the MBean obectName property using JConsole.
Example: Note that these MBean examples have different node properties in the
path: type-host-path in the first and type-resourcetype-name in the second.
l
For MBean "Catalina/Cache/localhost/SiteScope" specify:
"Catalina:type=Cache,host=localhost,path=/SiteScope"
l
For MBean "Catalina/Environment/Global/simpleValue" specify:
"Catalina:type=Environment,resourcetype=Global,name=simpleValue"
User name
User name for connection to the JMX application (if required by your JMX
application).
Password
Password for connection to the JMX application (if required by your JMX
application).
Timeout
(seconds)
Amount of time, in seconds, to wait for a response from the server before timingout. After this time period passes, the monitor logs an error and reports an error
status.
Default value: 60 seconds (using a value other than the default timeout value
may adversely affect performance)
Additional
Classpath
The classpath library that is used to resolve unknown classes retrieved from the
JMX server. Multiple libraries can be entered separated by a semicolon.
The Dynamic JMX monitor always uses a separate thread pool to bring
information (counter names and values) from the JMX server (unlike the JMX
monitor which has two modes for using thread pools: regular mode and sandbox
mode). For details, see "Thread Pool Settings" on page 237.
Note: When monitoring a WebLogic Application Server 10.0, 10.3, or 11g (10.3.1 10.3.5), this field is mandatory, and the wlfullclient.jar must be used. For details
on creating the wlfullclient.jar, refer to Using the WebLogic JarBuilder Tool
(http://download.oracle.com/docs/cd/E12840_
01/wls/docs103/client/jarbuilder.html).
Load
additional
classpath
first
Loads the additional classpath libraries before loading all the existing classpath
libraries. If no additional classpath libraries are found, the other classpaths folders
are loaded.
HP SiteScope (11.23)
Page 245 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
UI Element
Description
Patterns &
Counters
Displays the server performance counters selected for this monitor. Use the Get
Counters button to select counters.
Click the Add New Counter
button to add an empty row at the bottom of the
counters tree, enabling you to manually add a counter.
Click the Delete Counter
button to remove the selected counters from the
list. You can select multiple items using the CTRL or SHIFT keys.
Click the View Matches for Selected Pattern Counter
counters that match the selected patterns.
button to display
Note: SiteScope uses Perl regular expressions for pattern matching. For
example, if you enter /cpu.*/ or cpu, any counters with cpu in their name match
this pattern and are added to the counters list.
Get
Counters
Opens a tree of all current counters, enabling you to select the counters you want
to monitor. The tree is opened with no nodes selected. When you make a
selection in the tree, the counters table is updated.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Counter
Preview
Displays all real counters in the monitor. This includes static counters and counter
patterns that have been translated to real counters.
Frequency
of updating
counters
from server
Time interval at which the counters that are requested by this monitor are retrieved
from the server, and the monitor is updated with counter pattern matches. Use the
drop-down list to specify increments of seconds, minutes, hours, or days.
Default value: 1 hour
Note:
l
The update frequency cannot be less than the monitor run frequency in Monitor
Run Settings.
l
When configuring this setting in a template, the variable value can only be in
time units of seconds.
l
Static counters are never deleted.
HP SiteScope (11.23)
Page 246 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
UI Element
Description
Continue
displaying
counters
that no
longer
exist after
update
When selected, counters that no longer exist after running the update mechanism
to retrieve counters from the monitored server, are not deleted and are still
displayed in the monitor (they are displayed as unavailable). This is useful, for
example, if a disk fails or for keeping track of counters that were previously being
monitored.
When cleared, the counters that no longer exist are removed from the Counter
Preview and Threshold Settings on the next update.
Default value: Selected
Note: This option is relevant for dynamic counters only (those set using a regular
expression). Static counters that are no longer available are still displayed even
when this check box is cleared.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Notes
l
When deploying these monitors using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
When SiteScope is connected to BSM 9.00 or later, the Indicator State and Severity column is
not displayed in Threshold Settings by default. This is because each counter pattern can affect
more than one measurement, and only static counters and counter patterns are displayed by
default. This column is displayed only when you click the Threshold Preview button
(thresholds of all patterns are translated to actual current counters and are displayed).
l
Baseline Settings are not available for dynamic monitors (these monitors configure their own
thresholds).
Maximum Number of Counters That Can be Saved
Browsable monitors are limited by the number of counters they have. The maximum number of
counters is determined by the _browsableContentMaxCounters parameter in the master.config
file (also in Preferences > Infrastructure Preferences > Monitor Settings > Maximum
browsable counters to be selected). If you create or edit a monitor so that it has more counters
than this value, only the number of counters up to this value is saved.
When a browsable monitor is deployed in a template, the number of counters that match the
selected patterns is limited by the _maxCountersForRegexMatch parameter in the master.config
file. If during deployment, the number of counters that match the patterns exceeds this value, only
the number of counters up to this value is saved.
HP SiteScope (11.23)
Page 247 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
The _maxCountersForRegexMatch parameter is also used to limit the number of counters that
match the selected counter patterns when creating and updating dynamic monitors. We
recommend using the same value for both _browsableContentMaxCounters and _
maxCountersForRegexMatch parameters in the master.config file. The default value for both of
these parameters is 1000.
When upgrading from earlier versions of SiteScope, the value for both of these parameters is set to
the higher of these two parameter values in the previous version, or to 1000 (whichever is greater).
Troubleshooting Logs
1. Check for dynamic framework errors in:
n
<SiteScope root directory>\logs\dynamic_monitoring_changes.log. This log describes
monitor changes made by the dynamic framework (adding/removing counters), including the
monitor name and counter name.
n
<SiteScope root directory>\logs\dynamic_monitoring.log. This log describes all the
tasks being run by the dynamic framework (counters extracted from the server, counters
matched to patterns, and so on).
To check for dynamic monitoring errors, copy the following section from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
###################################################################################
# Dynamic Monitoring
###################################################################################
log4j.category.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=
DEBUG, dynamic.monitoring.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=false
log4j.category.com.mercury.sitescope.entities.monitors.dynamic=DEBUG, dynamic.monitoring
.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.dynamic=false
log4j.appender.dynamic.monitoring.appender=org.apache.log4j.RollingFileAppender
log4j.appender.dynamic.monitoring.appender.File=../${log.file.path}/dynamic_monitoring.l
og
log4j.appender.dynamic.monitoring.appender.MaxFileSize=1000KB
log4j.appender.dynamic.monitoring.appender.MaxBackupIndex=5
log4j.appender.dynamic.monitoring.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.dynamic.monitoring.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p
- %m%n
2. Check for Dynamic JMX monitor errors in:
n
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific
monitor runs and actions related to managing monitors.
n
<SiteScope root directory>\logs\dynamic_monitoring.log\dynamic_jmx_monitor.log.
This log provides information about Dynamic JMX monitor errors.
HP SiteScope (11.23)
Page 248 of 926
Monitor Reference
Chapter 28: Dynamic JMX Monitor
To view JMX monitor errors, copy the following sections from the log4j.properties.debug
file in the <SiteScope root directory>\conf\core\Tools\log4j\PlainJava folder to the
log4j.properties file, and change the log level to DEBUG.
###################################################################################
Dynamic JMX monitor
##################################################################################
log4j.category.com.mercury.sitescope.monitors.facades.DynamicJMXMonitor=DEBUG, dynamicjm
x.appender
log4j.additivity.com.mercury.sitescope.monitors.facades.DynamicJMXMonitor=false
log4j.category.com.mercury.sitescope.monitors.jmx=DEBUG, dynamicjmx.appender
log4j.additivity.com.mercury.sitescope.monitors.jmx=false
log4j.category.com.mercury.sitescope.infra.classpath=DEBUG, dynamicjmx.appender
log4j.additivity.com.mercury.sitescope.infra.classpath=false
log4j.appender.dynamicjmx.appender=org.apache.log4j.RollingFileAppender
log4j.appender.dynamicjmx.appender.File=../${log.file.path}/dynamic_jmx_monitor.log
log4j.appender.dynamicjmx.appender.MaxFileSize=${def.file.max.size}
log4j.appender.dynamicjmx.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.dynamicjmx.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.dynamicjmx.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p - %m%n
log4j.appender.dynamicjmx.appender.encoding=${general.encoding}
HP SiteScope (11.23)
Page 249 of 926
Chapter 29: e-Business Transaction Monitor
The e-Business Transaction monitor enables you to verify that the multiple tasks that make up an
online transaction are completed properly.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the e-Business Transaction monitor.
Learn About
This section includes:
l
" e-Business Transaction Monitor Overview" below
l
"Editing the Order of the Monitors in the Chain" on the next page
e-Business Transaction Monitor Overview
Use this monitor to verify that an end-to-end transaction and associated processes complete
properly. This includes:
l
Successful navigation through a series of URLs.
l
Transmission of an email confirming the sequence.
l
Logging the information into a database file.
The e-Business Transaction monitor runs a sequence of other SiteScope monitors, checking that
each monitor returns a status of OK. It reports an Error status if any monitor in the sequence fails.
For example, you could use this monitor to verify that the following steps, each of which is a step in
a single transaction, run properly:
l
Place an order on a Web site (see "URL Sequence Monitor" on page 689).
l
Check that the order status was updated (see "URL Sequence Monitor" on page 689).
l
Check that a confirmation email was received (see "Mail Monitor" on page 367).
l
Check that the order was added to the order database (see "Database Query Monitor" on page
185).
l
Check that the order was transferred to a legacy system (see "Script Monitor" on page 570).
Monitor any multi-step transaction process that causes other updates or actions in your systems.
Monitor each of the actions taken to check that updates were performed properly and that actions
were carried out successfully.
HP SiteScope (11.23)
Page 250 of 926
Monitor Reference
Chapter 29: e-Business Transaction Monitor
Using this example, you would first create the URL Sequence monitor, Mail monitor, Database
monitor, and applicable Script monitor needed to verify each step of the chain. Then you would
create an e-Business Transaction monitor and select each of these SiteScope monitors as a group
in the order they should be run. If any one monitor indicates a failure, the e-Business Transaction
monitor reports an error.
Each time the e-Business Transaction monitor runs, it returns a status based on the number and
percentage of items in the specified monitors, groups, or both, currently reporting an error, warning,
or OK status. It writes the percentages reported in the monitoring log file.
Editing the Order of the Monitors in the Chain
By default, the Add e-Business Transaction monitor page lists monitor groups and individual
monitors in alphabetical order. To have the e-Business Transaction monitor run the chain of
monitors in the proper order, they must appear in the proper order in the Selected table on the New
e-Business Transaction Monitor page. You can do this by selecting the individual monitors in the
order in which they should be run.
Tasks
How to Configure the e-Business Transaction Monitor
1. Set up monitors for the e-Business chain
Before you can add an e-Business Transaction monitor, you must define other SiteScope
monitors that report on the actions and results of the steps in the sequence chain.
a. Create a new group that contains all the individual monitors to be included in the sequence
chain (one or more URL Sequence monitor for verifying the sequence of online actions, a
Mail monitor to confirm that an email acknowledgement is sent, and a Database Query
monitor to see that information entered online is logged into a database).
b. Open the new monitor group, and add the first individual monitor type needed for the
sequence (for example, "URL Sequence Monitor" on page 689).
For task details on adding a monitor, see How to Deploy a Monitor in the Using SiteScope
Guide.
Note: Monitors should be added in the order that they are run in the chain. For
example, select a URL Sequence monitor which triggers an email event before you
select the Mail monitor to check for the email.
c. If necessary, set up the values to be passed from one monitor to another in the chain.
d. Add the other monitors for this transaction chain in the required order of execution into the
group.
HP SiteScope (11.23)
Page 251 of 926
Monitor Reference
Chapter 29: e-Business Transaction Monitor
Note: The individual monitors run by the e-Business Transaction monitor should
generally not be run separately by SiteScope. Make sure that the Frequency setting
for each of these monitors is set to zero ("0").
e. Create a new group or open an existing group that contains the e-business transaction
chain monitor you are creating.
f. Click New > Monitor and select the e-Business Transaction monitor.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
e-Business Transaction Monitor Settings
User interface elements are described below:
UI
Element
Description
Main Settings
Monitor
delay
(seconds)
Number of seconds to wait between running each monitor.
This setting is useful if you need to wait for processing to occur on your systems
before running the next monitor.
Default value: 0 seconds
When
error
Single
session
Error handling option during the sequence:
l
Continue to run the remainder of the monitors. This runs every monitor no
matter what the status of a given monitor is.
l
Stop and do not run any of the remaining monitors. This stops running the
list of monitors immediately, if a monitor returns an error.
l
Run the last monitor. This runs the last monitor in the list. It is useful if a
monitor is used for closing or logging off a session opened in a previous monitor.
URL monitors use the same network connection and the same set of cookies.
This is useful if you are using the e-Business Transaction monitor to group several
URL Sequence monitors and do not want to include the login steps as part of each
transaction.
Item Settings
HP SiteScope (11.23)
Page 252 of 926
Monitor Reference
Chapter 29: e-Business Transaction Monitor
UI
Element
Items
Description
Using the control key or equivalent, double-click the set of monitors that make up
the e-Business Transaction monitor to move them to the Selected column.
Note:
l
Monitors are run in the order that they are listed in their group. For details, see
"Editing the Order of the Monitors in the Chain" on page 251.
l
To control the order of the monitors in the chain, select monitors and not groups.
If you select groups, they are run at random and not by group order.
For the list of counters that can be configured for this monitor, see "Monitor
Counters" below.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• % items OK
• % items in error
• % items in warning
• items OK
• items checked
• items in error
• items in warning
• name of the items in warning
• name of the items in error
Tips/Troubleshooting
General Tips/Limitations
This monitor cannot be copied to a template. It must be created directly in a template.
HP SiteScope (11.23)
Page 253 of 926
Chapter 30: F5 Big-IP Monitor
This monitor enables you to monitor the content of event logs and other data from F5 Big-IP load
balancing device using SNMP. You can monitor multiple parameters or counters with a single
monitor instance. This enables you to watch server loading for performance, availability, and
capacity planning. Create a separate F5 Big-IP monitor instance for each F5 Big-IP load balancing
device in your environment. The error and warning thresholds for the monitor can be set on one or
more load balancer statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the F5 Big-IP monitor.
Learn About
Supported Platforms/Versions
This monitor supports monitoring F5 Big-IP 4.0, 10.x.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the SNMP protocol.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the F5 Big-IP Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The SNMP Browser Tool is available when configuring this monitor to verify the
connection properties of an SNMP agent and to gain more information about the MIBs which
that agent implements (provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions). To use the tool when configuring or editing a monitor, click the
Use Tool button. For details on the tool, see SNMP Browser Tool in the Using SiteScope
Guide.
HP SiteScope (11.23)
Page 254 of 926
Monitor Reference
Chapter 30: F5 Big-IP Monitor
UI Descriptions
F5 Big-IP Monitor Settings
User interface elements are described below:
UI Element
Description
SNMP Settings
Server
Name of the server you want to monitor.
Port
Port to use when requesting data from the SNMP agent.
Default value: 161
MIB file
MIB file option:
l
LOAD-BAL-SYSTEM-MIBS file displays only those objects that are
described within that MIB file.
l
All MIBs displays all objects discovered on the given F5 Big-IP when
browsing counters. If no MIB information is available for an object, it is still
displayed, but with no textual name or description.
Default value: All MIBs
Counter
calculation
mode
Performs a calculation on objects of type Counter, Counter32, or Counter64.
The available calculations are:
l
Calculate delta. Calculates a simple delta of the current value from the
previous value.
l
Calculate rate Calculates a rate calculation using the delta of current value
from previous value, divided by the time elapsed between measurements.
l
Do not calculate. No calculation is performed.
Note: This option only applies to the aforementioned object types. An SNMP
by MIB monitor that monitors Counter objects as well as DisplayString objects
only performs this calculation on the Counter objects.
HP SiteScope (11.23)
Page 255 of 926
Monitor Reference
Chapter 30: F5 Big-IP Monitor
UI Element
Description
Starting OID
Use when selecting counters for this monitor. When the monitor attempts to
retrieve the SNMP agent's tree, it starts with the OID value that is entered
here.
Edit this box only when attempting to retrieve values from an application that
does not handle OIDs starting with 1. If the default value of 1 did not enable
retrieving any counters, then you may have to enter a different value.
Default value: 1
Note: This field is available in template mode only.
SNMP Connection Settings
Timeout
(seconds)
Amount of time, in seconds, that SiteScope should wait for all SNMP requests
(including retries) to complete.
Default value: 5
Number of
retries
Number of times each SNMP GET request should be retried before SiteScope
considers the request to have failed.
Default value: 1
Community
Community string (valid only for version 1 or 2 connections).
Default value: public
SNMP version
Version of SNMP to use when connecting. Supports SNMP version 1, 2, and
3. Selecting V3 enables you to enter V3 settings in the SNMP V3 setting fields
below.
Default value: V1
Authentication The authentication algorithm to use for version 3 connections.
algorithm
Default value: MD5
Note: This field is available only if SNMP V3 is selected.
User name
User name for version 3 connections.
Note: This field is available only if SNMP V3 is selected.
Password
Authentication password to use for version 3 connections.
Note: This field is available only if SNMP V3 is selected.
HP SiteScope (11.23)
Page 256 of 926
Monitor Reference
Chapter 30: F5 Big-IP Monitor
UI Element
Description
Privacy
algorithm
The privacy algorithm used for authentication for SNMP version 3 (DES,128Bit AES,192-Bit AES, 256-Bit AES).
Default value: DES
Note: This field is available only if SNMP V3 is selected.
Privacy
password
Privacy password for version 3 connections. Leave blank if you do not want
privacy.
Note: This field is available only if SNMP V3 is selected.
Context name
Context Name to use for this connection. This is applicable for SNMP V3 only.
Note: This field is available only if SNMP V3 is selected.
Context
engine ID
Hexadecimal string representing the Context Engine ID to use for this
connection. This is applicable for SNMP V3 only.
Note: This field is available only if SNMP V3 is selected.
SNMP Counters
Counters
Displays the server performance counters you want to check with this monitor.
Use the Get Counters button to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you
want to monitor. For the list of counters that can be configured for this monitor,
see "Monitor Counters" on the next page.
Note: The counters displayed are those received during the timeout period,
and may not include all the counters available on the server. Specifying a
longer timeout in the Timeout (seconds) field in the SNMP Connection
Settings panel may result in receiving more counters. The total time for
receiving the counters may be longer than the timeout specified, due to
additional processing time not part of the request/response period.
Note when working in template mode: The maximum number of counters
that you can select is 100. If you import a template monitor from an earlier
version of SiteScope, or perform a copy to template action, the number of
counters is not limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 257 of 926
Monitor Reference
Chapter 30: F5 Big-IP Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
F5 systems
• active
• bitsin
• bitsinHi32
• bitsout
• bitsoutHi32
• concur • conmax
• contot
• cpuTemperature
• droppedin
• droppedout
• fanSpeed
• gatewayFailsafe
• ifaddress
• ifaddressTable
• interface
• loadbal
• loadbalMode
• loadBalTrap
• member
• memoryTotal
• memoryUsed
• mirrorenabled
• nat
• ndaddr
• nodePing
• nodeTimeout
• pktsin
• pktsinHi32
• pktsout
• pktsoutHi32
• pool
• poolMember
• portdeny
• resetcounters
• snat
• snatConnLimit
• snatTCPIdleTimeout
• snatUDPIdleTimeout
• sslProxy
• sslProxyEntry
• sslProxyTable
• unitId
• uptime
• vaddress
• virtualAddress
• virtualServer
• vport
• watchDogArmed
F5 DNS
• cache
• dataCenters
• globals
• hosts
• lbDnsServs
• lbDomains
• lbRouters
• summary
Tips/Troubleshooting
General Tips/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 258 of 926
Chapter 31: File Monitor
The File monitor enables you to read a specified file and check the size and age of the file.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the File monitor.
Learn About
This section includes:
l
"File Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Reading and Status" below
File Monitor Overview
The File monitor is useful for watching files that can grow too large and use up disk space, such as
log files. Other files that you may want to watch are Web pages that have important content that
does not change often.
You can set up your File Monitors to monitor file size, age, or content, and set a threshold at which
you will be notified. SiteScope can alert you to unauthorized content changes so that you can
correct them immediately. You can write scripts for SiteScope to run that automatically roll log files
when they reach a certain size.
Supported Platforms/Versions
l
This monitor supports monitoring UNIX remote servers that have been configured in SiteScope
and the local SiteScope machine only.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports monitoring remote servers running on HP NonStop operating systems.
For details on enabling the HP NonStop monitoring environment, see "How to Configure the HP
NonStop Resources Monitor" on page 307.
Reading and Status
Each time the File monitor runs, it returns a reading and a status and writes them in the monitoring
log file. It also writes the file size and age into the log file. The reading is the current value of the
monitor. Possible values are:
HP SiteScope (11.23)
Page 259 of 926
Monitor Reference
Chapter 31: File Monitor
l
OK
l
content match error
l
file not found
l
contents changed
An error status is returned if the current value of the monitor is anything other than OK.
Tasks
How to Configure the File Monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
File Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Server where the file you want to monitor is located. Select a server from the server
list (only UNIX remote servers that have been configured in SiteScope and the local
SiteScope machine are displayed), or click Add Remote Server to add a new UNIX
server.
Note when working in template mode: You can use the template remote server (if
one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Add
Remote
Server
Opens the Add UNIX Remote Server dialog box, enabling you to enter the
configuration details. For user interface details, see New/Edit UNIX Remote Server
Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 260 of 926
Monitor Reference
Chapter 31: File Monitor
UI
Element
File
name
Description
Path and name to the file you want to monitor.
Note:
l
It may be necessary to provide the full path to the target file. For example,
/opt/application/logs/user.log.
l
You must also select the corresponding remote UNIX server in the Server box
described above. For details on which UNIX user account to use for the
applicable remote server, see How to Configure SiteScope to Monitor a Remote
UNIX Server in the Using SiteScope Guide.
l
For reading files on remote Windows servers, use NetBIOS to specify the server
and UNC path to the remote log file. For example,
\\remoteserver\sharedfolder\filename.log.
l
You can also monitor files local to the server where SiteScope is running. For
example, C:\application\appLogs\access.log.
l
Optionally, you can use regular expressions for special date and time variables to
match on log file names that include date and time information. For example, you
can use a syntax of s/ex$shortYear$$0month$$0day$.log/ to match a current
date-coded file. For details on using regular expressions and dates, see
SiteScope Date Variables in the Using SiteScope Guide.
File
File content is monitored using an encoding that is different than the encoding used
encoding on server where SiteScope is running. This may be necessary if the code page
which SiteScope is using does not support the character set used in the target file.
This enables SiteScope to match and display the encoded file content correctly.
Default value: windows-1252
HP SiteScope (11.23)
Page 261 of 926
Monitor Reference
Chapter 31: File Monitor
UI
Element
Match
content
Description
Text string to match in the returned page or frameset. If the text is not contained in
the page, the monitor displays the message content match error. The search is
case sensitive.
Note:
l
HTML tags are part of a text document, so include the HTML tags if they are part
of the text you are searching for. This works for XML pages as well. For example,
< B> Hello< /B> World.
l
You can also perform a regular expression match by enclosing the string in
forward slashes, with a letter i after the trailing slash indicating case-insensitive
matching. For example, /href=Doc\d+\.html/ or /href=doc\d+\.html/i.
l
You can search for a pattern string across multiple lines. To do so, add the /s
modifier to the end of the regular expression. For example, /(state).*
(populate)/s checks if the returned page contains both “state” and "populate".
l
To save and display a particular piece of text as part of the status, use
parentheses in a Perl regular expression. For example, /Temperature: (\d+)
returns the temperature as it appears on the page, and this could be used when
setting an Error if or Warning if threshold.
For details on regular expressions, see Regular Expressions Overview in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 262 of 926
Monitor Reference
Chapter 31: File Monitor
UI
Element
Check
for
content
changes
Description
Unless this is set to "no content checking" (the default) SiteScope records a
checksum of the document the first time the monitor runs and then does a checksum
comparison each subsequent time it runs. If the checksum changes, the monitor has
a status of "content changed error" and goes into error. If you want to check for
content changes, use "compare to saved contents".
The options for this setting are:
No error
if file not
found
l
No content checking (default). SiteScope does not check for content changes.
l
Compare to last contents. The new checksum is recorded as the default after
the initial error content changed error occurs, so the monitor returns to OK until
the checksum changes again.
l
Compare to saved contents. The checksum is a snapshot of a given page
(retrieved either during the initial or a specific run of the monitor). If the contents
change, the monitor gets a content changed error and stays in error until the
contents return to the original contents, or the snapshot is update by resetting the
saved contents.
l
Reset saved contents. Takes a new snapshot of the page and saves the
resulting checksum on the first monitor run after this option is chosen. After
taking the snapshot, the monitor reverts to compare to saved contents mode.
The monitor remains in Good status even if the file is not found. The monitor status
is Good regardless of how the monitor's thresholds have been configured.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• content match
• file age
• size
• status
HP SiteScope (11.23)
Page 263 of 926
Chapter 32: Formula Composite Monitor
This monitor enables you to monitor complex network environments by checking the status
readings of two SNMP, Script, Database Query, or Microsoft Windows Performance Counter
monitors and performing an arithmetic calculation on their results.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Formula Composite monitor.
Learn About
Formula Composite Monitor Overview
Use this monitor if you have devices or systems in your network that return values that you want to
combine in some way to produce a composite value. The following monitor types can be used to
build a Formula Composite monitor:
l
Database Query monitor.
l
Microsoft Windows Performance Counter monitor.
l
Script monitor.
l
SNMP monitor.
If you need alert logic that is more complex than SiteScope's standard alerts permit, you can use
the Formula Composite monitor to create custom alert behavior. For example, if you have two
parallel network devices that record network traffic but the values need to be combined to produce
an overall figure of network traffic. This monitor may also be used to combine the results returned
by scripts run on two different machines.
Each time the Formula Composite monitor runs, it returns a status based on the measurement
results of the two subordinate monitors and the calculation specified for the composite monitor.
Tasks
How to Configure the Formula Composite Monitor
1. Prerequisites
You must create at least two individual Database Query, Microsoft Windows Performance
Counter, Script, or SNMP monitor instances before you can set up a Formula Composite
monitor for those monitors. For details, see:
n
o
"Database Query Monitor" on page 185.
o
"Microsoft Windows Performance Counter Monitor" on page 471.
HP SiteScope (11.23)
Page 264 of 926
Monitor Reference
Chapter 32: Formula Composite Monitor
For Microsoft Windows Performance Counter monitors, you can use the (Custom Object)
option for the PerfMon Chart File setting and then specify a single performance Object,
Counter, and Instance (if applicable) in the Microsoft Windows Performance Counter
Monitor Settings section of the monitor setup. If a subordinate monitor is configured to
return more than one numeric measurement, only the first numeric measurement from that
monitor instance is used by the Formula Composite monitor.
n
o
"Script Monitor" on page 570.
o
"SNMP Monitor" on page 607.
The monitors you create for use with a Formula Composite monitor should be configured to
return a single value per monitor. This is generally simple with SNMP monitors. Database
Query and Script monitors should use queries and scripts that return a single value.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Formula Composite Monitor Settings
User interface elements are described below:
UI
Element
Monitors
Description
Click the Add
button , and select two SNMP monitors, two Script monitors,
two Database monitors, or two Microsoft Windows Performance Counter monitors
that the Formula Composite monitor should operate on. Click Add Selected
Monitors to display the selected monitors in the Monitors box. For details on the
Add Items dialog box, see "Add Items Dialog Box" on the next page.
To remove monitors from the list, select the monitors and the Delete
Run
monitors
button.
The Formula Composite monitor controls the scheduling of the selected monitors,
as opposed to just checking their status readings. This is useful if you want the
monitors to run one after another or run at approximately the same time.
Note: Any monitors that are to be run this way should not also be run separately, so
set Frequency in Monitor Run Settings to 0. Those monitors then only run when
scheduled by the Formula Composite monitor.
Counters
Server performance counters to check with this monitor. The list displays the
available counters and those currently selected for this monitor.
HP SiteScope (11.23)
Page 265 of 926
Monitor Reference
Chapter 32: Formula Composite Monitor
UI
Element
Monitor
delay
(seconds)
Description
Amount of time, in seconds, to wait between running each monitor (if Run
monitors is selected).
Default value: 0 seconds
Operation Arithmetic operation to be performed on the results of the two monitors selected
above. You can add the results, multiply the results of the two monitors, subtract
the results of the first from the second, divide the second by the first, and so on.
Constant
An operator and a constant to operate on the result of the calculation specified in the
Operation item above.
For example, if an Operation of Add is selected above, entering the characters *8 in
the Constant box multiplies the result of the Add operation by 8. The syntax for this
box should be <operator> <number>.
Valid operators are + (addition), - (subtraction), * (multiplication), and / (division).
Numbers may be integers or decimals.
Result
label
Name for the result of the formula calculation.
Add Items Dialog Box
This dialog box enables you to select the monitors, groups, or both, that you want in the Composite
monitor.
User interface elements are described below:
UI Element
Description
Add
Selected
Items
Click to add the selected groups, monitors, or both, to the Formula Composite
monitor.
Represents the SiteScope root directory.
Represents a SiteScope monitor group or subgroup (with enabled monitors/with
no monitors or no enabled monitors).
If a group alert has been set up for the monitor group or subgroup, the alert
symbol is displayed next to the group icon.
Represents a SiteScope monitor (enabled/disabled).
If an alert has been set up for the monitor, the alert symbol is displayed next to
the monitor icon.
Note: For information on configuring setting panels that are common to all monitors, see
HP SiteScope (11.23)
Page 266 of 926
Monitor Reference
Chapter 32: Formula Composite Monitor
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Tips/Limitations
l
When copying this monitor to a template, the subordinate monitors used to build a Formula
Composite monitor are not copied. Therefore, it is recommended to create this monitor and its
subordinate monitors directly in a template.
l
Use the Formula Composite monitor only for calculations that you consider to be compatible
data types. The monitor does not verify that the data returned by the subordinate monitors are
compatible.
l
You can select two different types of monitors as subordinate monitors of a Formula Composite
monitor. For example, one monitor may be a Script monitor and the other may be a Database
Query monitor.
l
Moving any of the monitors being used by the Formula Composite monitor causes the
composite monitor to report an error. If it is necessary to move either of the underlying monitors,
recreate or edit the Formula Composite monitor to select the monitor from its new location.
HP SiteScope (11.23)
Page 267 of 926
Chapter 33: FTP Monitor
This monitor enables you to log on to an FTP server and retrieve a specified file. A successful file
retrieval indicates that your FTP server is functioning properly. The FTP monitor also supports
secure FTP (SFTP).
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the FTP monitor.
Learn About
This section includes:
l
"FTP Monitor Overview" below
l
"Status" below
l
"Scheduling the Monitor" on the next page
FTP Monitor Overview
If you provide FTP access to files, it is important to check that your FTP server is working properly.
Use the FTP monitor to check FTP servers to ensure the accessibility of FTP files. Each time the
monitor runs (in FTP or SFTP mode), it opens a connection to the FTP server, downloads the
specified file, and then closes the connection.
In addition to retrieving specific files, the FTP monitor can help you verify that the contents of files,
either by matching the contents for a piece of text, or by checking to see if the contents of the file
ever changes compared to a reserve copy of the file.
While you may have many files available for FTP from your site, it is not necessary to monitor every
one. We recommend that you check one small file and one large file.
Status
The reading is the current value of the monitor. Possible values are:
l
OK
l
unknown host name
l
unable to reach server
l
unable to connect to server
l
timed out reading
l
content match error
HP SiteScope (11.23)
Page 268 of 926
Monitor Reference
Chapter 33: FTP Monitor
l
login failed
l
file not found
l
contents changed
l
The status is logged as either good or error. An error status is returned if the current value of the
monitor is anything other than OK.
Scheduling the Monitor
A common strategy is to monitor a small file every 10 minutes or so just to verify that the server is
functioning. Then schedule a separate monitor instance to FTP a large file once or twice a day. You
can use this to test the ability to transfer a large file without negatively impacting your machine's
performance. You can schedule additional monitors that watch files for content and size changes to
run every 15 minutes to half hour. Choose an interval that makes you comfortable.
If you have very important files available, you may also want to monitor them occasionally to verify
that their contents and size do not change. If the file does change, you can create a SiteScope alert
that runs a script to automatically replace the changed file with a back-up file.
Tasks
How to Configure the FTP Monitor
1. Prerequisites
Before you can use this monitor, make sure you know:
n
The relative paths, if any, to the files on the FTP server.
n
An applicable user name and password to access the files.
n
The filenames of one or more files available for FTP transfer.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Tip:
n
The FTP Tool is available when configuring this monitor to access an FTP server and
view the interaction between SiteScope and the FTP server (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions). To use
the tool when configuring or editing a monitor, click the Use Tool button. For details on
the tool, see FTP Tool in the Using SiteScope Guide.
n
The FTP monitor matches text which it has downloaded to the content buffer. By
default, the content buffer size is set to 50000 bytes. You can modify this value, if
HP SiteScope (11.23)
Page 269 of 926
Monitor Reference
Chapter 33: FTP Monitor
necessary, from Preferences > Infrastructure Preferences > Monitor Settings
>FTP Content match maximum size.
UI Descriptions
FTP Monitor Settings
User interface elements are described below:
UI Element
Description
Basic FTP Settings
Protocol
Select a protocol for the monitor:
l
FTP. The monitor supports non-secure sockets only.
l
SFTP. The monitor supports Secure FTP. It typically uses SSH version 2
(TCP port 22) to provide secure file transfer. In this version, only password
authentication is supported.
Note: SFTP protocol does not support Passive mode and SFTP is encrypted,
rendering traditional proxies ineffective for controlling SFTP traffic (the proxy
fields are not available).
FTP server
IP address or the name of the FTP server that you want to monitor.
Example: 206.168.191.22 or ftp.thiscompany.com
(ftp.thiscompany.com:<port number> to specify a different port)
File
File name to retrieve from the FTP server.
Example: /pub/docs/mydoc.txt
You can use a regular expression to insert date and time variables. For details on
using SiteScope's special data and time substitution variables in the file path, see
SiteScope Date Variables in the Using SiteScope Guide.
Example: s/C:\\firstdir\\$shortYear$$0month$$0day$/
User name
Name used to log into the FTP server. A common user name for general FTP
access is user name anonymous.
Password
Password used to log into the FTP server. If using the anonymous login, the
password is also anonymous.
Passive
mode
SiteScope uses FTP passive mode. You use this mode to enable FTP to work
through firewalls. (Not available in SFTP mode.)
Advanced FTP Settings
HP SiteScope (11.23)
Page 270 of 926
Monitor Reference
Chapter 33: FTP Monitor
UI Element
Description
Match
content
Text string to check for in the returned file. If the text is not contained in the file,
the monitor displays no match on content. The search is case sensitive. You
may also perform a regular expression match by enclosing the string in forward
slashes, with an "i" after the trailing slash indicating case-insensitive matching.
Example: "/Size \d\d/" or "/size \d\d/i"
Check for
content
changes
SiteScope records a checksum of the document the first time the monitor runs
and then does a checksum comparison each subsequent time it runs. If the
checksum changes, the monitor has a status of content changed error and go
into error. If you want to check for content changes, you usually want to use
compare to saved contents.
The options for this setting are:
Timeout
(seconds)
l
No content checking (default).SiteScope does not check for content
changes.
l
Compare to last contents. Any changed checksum is recorded as the default
after the change is detected initially. Thereafter, the monitor returns to a status
of OK until the checksum changes again.
l
Compare to saved contents. The checksum is a snapshot of a given page
(retrieved either during the initial or a specific run of the monitor). If the contents
change, the monitor gets a content changed error and stays in error until the
contents return to the original contents, or the snapshot is update by resetting
the saved contents.
l
Reset saved contents. Takes a new checksum of the file and saves the
resulting checksum on the first monitor run after this option is chosen. After
taking the updated checksum, the monitor reverts to compare to saved
contents mode.
Amount of time, in seconds, that the FTP monitor should wait for a file to complete
downloading before timing out. Once this time period passes, the FTP monitor
logs an error and reports an error status.
Default value: 60 seconds
File
encoding
If the file content to be monitored uses an encoding that is different than the
encoding used on the server where SiteScope is running, enter the encoding to
use. This may be necessary if the code page which SiteScope is using does not
support the character sets used in the target file. This enables SiteScope to match
and display the encoded file content correctly.
Default value: windows-1252
HP SiteScope (11.23)
Page 271 of 926
Monitor Reference
Chapter 33: FTP Monitor
UI Element
Description
Connection Amount of time, in seconds, that the FTP monitor should wait to connect to the
timeout
FTP server before timing out. Once this time period passes, the FTP monitor logs
(seconds)
an error and reports an error status.
Default value: 30 seconds
HTTP Proxy Settings
(Not available in SFTP mode)
HTTP
proxy
SiteScope runs the FTP through an HTTP proxy. Generally, if you use an HTTP
proxy you have it set up in your browser. Enter that same information here.
Remember to include the port.
Example: proxy.thiscompany.com:8080
Note: The FTP monitor does not support an FTP Proxy server.
Proxy user
name
Proxy user name if the proxy server requires a name and password to access the
file. The proxy server must support Proxy-Authenticate for these options to
function.
Proxy
password
Proxy password if the proxy server requires a name and password to access the
file. The proxy server must support Proxy-Authenticate for these options to
function.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• GET file transfer time
• GET file transfer rate
• PUT file transfer time
• PUT file transfer rate
HP SiteScope (11.23)
Page 272 of 926
Chapter 34: Generic Hypervisor Monitor
The Generic Hypervisor monitor provides a solution for monitoring Virtual Machines by using the
virsh tool (a command line interface tool for managing guests and the hypervisor) to collect detailed
information on nodes and guest virtual machines running on the host. You can monitor multiple
parameters or counters with a single monitor instance. This enables you to watch key operational
factors that can seriously affect availability and degrade performance. Create a separate monitor
instance for each server you are running.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Generic Hypervisor monitor.
Learn About
This section includes:
l
"Generic Hypervisor Monitor Overview" below
l
"Supported Platforms/Versions" below
Generic Hypervisor Monitor Overview
SiteScope simplifies the monitoring of virtual infrastructure changes in dynamic, virtualized
environments by automatically changing the SiteScope configuration according to changes in the
virtual environment. Generic Hypervisor monitors are dynamically updated over time by adding or
removing counters as virtual machines are added or removed. This enables you to configure the
monitor one time, and leave it to automatically discover changes in the environment and update
itself.
During initial monitor creation, the monitor uses the connection URI configured to access the VM
and dynamically discover the object hierarchy and available performance counters. You can select
from these performance counters to determine which measurements SiteScope should retrieve for
reporting server status.
You can also define the required thresholds for the counter's pattern. In this way, thresholds are
also updated automatically when the counters are updated.
For details on the dynamic monitoring mechanism, see Dynamic Monitoring Mechanism in the
Using SiteScope Guide.
Supported Platforms/Versions
This monitor supports monitoring remote servers running on UNIX remotes only. It has been tested
on a KVM environment.
HP SiteScope (11.23)
Page 273 of 926
Monitor Reference
Chapter 34: Generic Hypervisor Monitor
Tasks
How to Configure the Generic Hypervisor Monitor
1.
2.
Prerequisites
n
The monitored VM server must be directly accessible by the SiteScope server (no proxy
involved).
n
The Virsh command-line tool should be installed on the system. For details, see
https://help.ubuntu.com/community/KVM/Virsh.
Configure the monitor properties
a. Right-click the group into which you want to add the monitor instance, select New >
Monitor, and select Generic Hypervisor. The New Generic Hypervisor Monitor dialog box
opens.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the Generic Hypervisor Monitor Settings panel, select the VM server you want to monitor
(or add a new server) and specify the driver to which you want to connect in the
Connection URI box. For user interface details, see the UI Descriptions section below.
d. Click the Get Counter button, and select the counters you want to monitor from the Select
Counters Form. The counters are added to the Preview tree in the Patterns & Counters
section.
e. For dynamic monitoring, you can add patterns to counters to instruct the monitor which
counters to use, either by:
o
Clicking the Add New Counter
button to add an empty line to the table, and
creating a pattern format using a regular expression.
Tip:
(1). The pattern should always start and end with the forward slash ("/") character.
(2). The "[" and "]" characters which appear as part of counter names should be
escaped (preceded with the backslash ("\") character).
(3). Use ".*" to describe any character any number of times.
For example, /.*/Domains Information/.*/Used Memory/ displays Used Memory
counter for all VMs.
o
Selecting a static counter, and editing the counter to create a pattern format using a
regular expression. For details on using regular expressions, see Regular Expressions
Overview in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 274 of 926
Monitor Reference
Chapter 34: Generic Hypervisor Monitor
Note: For details on the maximum number of counters that can be selected from
the browsable tree and the maximum number of counters that can match the
selected counter patterns when creating and updating dynamic monitors, see
"Maximum Number of Counters That Can be Saved" on page 278. If the maximum
number of counters that can be deployed is exceeded, an error is written to the
RunMonitor.log.
Example:
If you enter the pattern /.*/Domains Information/.*/Used Memory/, the monitor
retrieves the Used Memory counter for all VMs.
f. To view the counters that match a selected pattern, click the View Matches for selected
Pattern
button. The matching counters are highlighted in the Counter Preview tree.
g. Set the frequency for updating counters from the server, and then click Verify & Save or
Save to save your settings. If you use only static counters, they are not affected by the
frequency for updating counters, since the dynamic framework does not run.
h. To display counters that no longer exist after the update mechanism runs, select Continue
displaying counters that no longer exist after update. Any such counters are displayed
as unavailable. This can be useful for keeping track of the counters that were previously
being monitored.
i. In the Threshold Settings tab, you can manually set logic conditions for the dynamic
counters that determine the reported status of each monitor instance. To view thresholds of
all patterns translated to actual current counters, click the Threshold Preview button.
For threshold user interface details, see Threshold Settings in the Using SiteScope Guide.
3.
Results
If you are using the dynamic monitoring mechanism, during each update, the monitor connects
to the VM server and updates the status of each counter that matches the pattern defined by
the regular expression. It also updates the thresholds for the selected counters.
You can check performance of the dynamic monitoring framework in:
n
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details,
see Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
n
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic
Monitoring Page in the Using SiteScope Guide.
For additional troubleshooting suggestions, see "Tips/Troubleshooting" on page 277.
HP SiteScope (11.23)
Page 275 of 926
Monitor Reference
Chapter 34: Generic Hypervisor Monitor
UI Descriptions
Generic Hypervisor Monitor Settings
User interface elements are described below:
UI Element
Description
Server
Name of the VM server that you want to monitor. Select a server from the
server list (only those UNIX remote servers that have been configured in
SiteScope are displayed), or click the Add Remote Server to add a new UNIX
server.
Note:
l
When configuring this monitor on SiteScopes running on UNIX versions,
only remote servers that have been configured with an SSH connection
method are displayed. For details, see How to Configure Remote Windows
Servers for SSH monitoring.
l
When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use
already configured template remote under current template check box.
Add Remote
Server
Opens the Add UNIX Windows Remote Server dialog box, enabling you to
enter the configuration details. For user interface details, see New/Edit UNIX
Remote Server Dialog Box in the Using SiteScope Guide.
Connection
URI
URI of the driver of the VM server that you want to monitor.
Patterns &
Counters
Displays the server performance counters selected for this monitor. Use the
Get Counters button to select counters.
Click the Add New Counter
button to add an empty row at the bottom of
the counters tree, enabling you to manually add a counter.
Click the Delete Counter
button to remove the selected counters from the
list. You can select multiple items using the CTRL or SHIFT keys.
Click the View Matches for Selected Pattern
that match the selected patterns.
button to display counters
Note: SiteScope uses Perl regular expressions for pattern matching.
Get Counters
HP SiteScope (11.23)
Opens a tree of all current counters, enabling you to select the counters you
want to monitor. The tree is opened with no nodes selected. When you make a
selection in the tree, the counters table is updated.
Page 276 of 926
Monitor Reference
Chapter 34: Generic Hypervisor Monitor
UI Element
Description
Counter
Preview
Displays all real counters in the monitor. This includes static counters and
counter patterns that have been translated to real counters.
Frequency of
updating
counters
from server
Time interval at which the counters that are requested by this monitor are
retrieved from the server, and the monitor is updated with counter pattern
matches. Use the drop-down list to specify increments of seconds, minutes,
hours, or days.
Default value: 15 minutes
Note:
Continue
displaying
counters that
no longer
exist after
update
l
The update frequency cannot be less than the monitor run frequency in
Monitor Run Settings.
l
When configuring this setting in a template, the variable value can only be in
time units of seconds.
l
Static counters are never deleted.
When selected, counters that no longer exist after running the update
mechanism to retrieve counters from the monitored server, are not deleted and
are still displayed in the monitor (they are displayed as unavailable). This is
useful, for example, if a disk fails or for keeping track of counters that were
previously being monitored.
When cleared, the counters that no longer exist are removed from the Counter
Preview and Threshold Settings on the next update.
Default value: Not selected
Note: This option is relevant for dynamic counters only (those set using a
regular expression). Static counters that are no longer available are still
displayed even when this check box is cleared.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section includes:
l
"General Notes" on the next page
l
"Maximum Number of Counters That Can be Saved" on the next page
l
"Troubleshooting Logs" on the next page
HP SiteScope (11.23)
Page 277 of 926
Monitor Reference
Chapter 34: Generic Hypervisor Monitor
General Notes
l
When configuring this monitor in template mode, the Add Remote Server button is not
displayed, and some fields that contain drop-down lists may be displayed as text boxes.
l
When deploying these monitors using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
When SiteScope is connected to BSM 9.00 or later, the Indicator State and Severity column is
not displayed in Threshold Settings by default. This is because each counter pattern can affect
more than one measurement, and only static counters and counter patterns are displayed by
default. This column is displayed only when you click the Threshold Preview button
(thresholds of all patterns are translated to actual current counters and are displayed).
l
This monitor supports setting fractional thresholds which are more useful than setting whole
number thresholds when monitoring large disks (such as 1 terabyte and larger).
l
Baseline Settings are not available for dynamic monitors (these monitors configure their own
thresholds).
Maximum Number of Counters That Can be Saved
Browsable monitors are limited by the number of counters they have. The maximum number of
counters is determined by the _browsableContentMaxCounters parameter in the master.config
file (also in Preferences > Infrastructure Preferences > Monitor Settings > Maximum
browsable counters to be selected). If you create or edit a monitor so that it has more counters
than this value, only the number of counters up to this value is saved.
When a browsable monitor is deployed in a template, the number of counters that match the
selected patterns is limited by the _maxCountersForRegexMatch parameter in the master.config
file. If during deployment, the number of counters that match the patterns exceeds this value, only
the number of counters up to this value is saved.
The _maxCountersForRegexMatch parameter is also used to limit the number of counters that
match the selected counter patterns when creating and updating dynamic monitors. We
recommend using the same value for both _browsableContentMaxCounters and _
maxCountersForRegexMatch parameters in the master.config file. The default value for both of
these parameters is 1000.
When upgrading from earlier versions of SiteScope, the value for both of these parameters is set to
the higher of these two parameter values in the previous version, or to 1000 (whichever is greater).
Troubleshooting Logs
1. Check for dynamic framework errors in:
n
<SiteScope root directory>\logs\dynamic_monitoring_changes.log. This log describes
monitor changes made by the dynamic framework (adding/removing counters), including the
monitor name and counter name.
n
<SiteScope root directory>\logs\dynamic_monitoring.log. This log describes all the
HP SiteScope (11.23)
Page 278 of 926
Monitor Reference
Chapter 34: Generic Hypervisor Monitor
tasks being run by the dynamic framework (counters extracted from the server, counters
matched to patterns, and so on).
To check for dynamic monitoring errors, copy the following section from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
###################################################################################
# Dynamic Monitoring
###################################################################################
log4j.category.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=
DEBUG, dynamic.monitoring.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=false
log4j.category.com.mercury.sitescope.entities.monitors.dynamic=DEBUG, dynamic.monitoring
.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.dynamic=false
log4j.appender.dynamic.monitoring.appender=org.apache.log4j.RollingFileAppender
log4j.appender.dynamic.monitoring.appender.File=../${log.file.path}/dynamic_monitoring.l
og
log4j.appender.dynamic.monitoring.appender.MaxFileSize=1000KB
log4j.appender.dynamic.monitoring.appender.MaxBackupIndex=5
log4j.appender.dynamic.monitoring.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.dynamic.monitoring.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p
- %m%n
2. Check for Generic Hypervisor monitor errors in:
n
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific
monitor runs and actions related to managing monitors.
HP SiteScope (11.23)
Page 279 of 926
Chapter 35: Hadoop Monitor
The Hadoop monitor enables you to dynamically monitor the health and performance statistics of
Hadoop Distributed File System (HDFS) and Hadoop MapReduce master nodes of the Hadoop
cluster infrastructure using the standard JMX remoting technology defined by JSR 160 (for details,
see "Applications Supporting JSR 160" on page 233).
You can select measurements on specified Hadoop cluster hosts, or use the dynamic monitoring
mechanism to automatically update counters and thresholds that changed during run-time.
You can create one monitor for each master node in your cluster, or several monitors to monitor the
same master node that analyzes different counters.
Note: SiteScope also provides a solution template that includes a set of predefined monitors to
create a monitoring solution for various aspects of a Hadoop cluster . For details, see Hadoop
Cluster Monitoring Solution Templates in the Using SiteScope Guide.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Hadoop monitor.
Learn About
This section includes:
l
"Hadoop Monitor Overview" below
l
"Supported Platforms/Versions" on the next page
l
"Connection Pool Settings" on the next page
l
"Thread Pool Settings" on page 282
l
"Hadoop Topology" on page 283
Hadoop Monitor Overview
This monitor enables you to:
l
Monitor specific counters on a JMX application using static counters. You can monitor multiple
parameters or counters with a single monitor instance. The counters available vary from
application to application, but normally include both basic JVM performance counters, as well as
counters specific to the application.
l
Select the counter patterns you want to monitor using a regular expression or a static string, and
let the monitor dynamically update MBean counters that match the pattern defined by the regular
expression. Dynamic monitoring enables you to configure the monitor on a one time basis, and
leave it to update itself.
HP SiteScope (11.23)
Page 280 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
When configuring a dynamic monitor, you can define a counter pattern that specifies the MBean
counters you want to monitor. You can also define the required thresholds for the counter's
pattern. The monitor scans the target host periodically, and creates the counters that are aligned
with the given counter pattern.
If a new MBean is added to the machine and part or all of its counters correspond to the counter
pattern, the counters that match the counter pattern are automatically added to the monitor when
the counters are next updated from the server. Similarly, if an MBean that corresponds to the
counter pattern is no longer available, counters for that MBean are removed from the monitor
(unless you choose not to delete them, in which case they are still displayed in the monitor's
counter list).
You can also select counter patterns to be used as threshold conditions. In this way, thresholds
are also updated automatically when the counters are updated.
For more details on the dynamic monitoring mechanism, see Dynamic Monitoring Mechanism in
the Using SiteScope Guide.
Supported Platforms/Versions
This monitor supports monitoring Hadoop 1.x on GNU/Linux.
Connection Pool Settings
The Hadoop monitor uses connection pools to reduce the load on the JMX infrastructure and
SiteScope. Connection pools provide reusable connections by the monitor itself during different
monitor runs, and by several monitors that use the same connection details.
The connection pool is a set of pools per key. A key is the combination of a JMX URL, a user, and a
password. If all JMX monitors are configured with the same JMX URL, user, and password, one
connection pool is created. For two JMX applications and two different users, four connection pools
are created.
The connection pool evicts idle connections according to the maximum number of idle connections
allowed (configurable in Dynamic JMX connection pool: maximum idle connections in pool
(per key)). Connections are evicted based on evictable idle time (configurable in Dynamic JMX
connection pool: minimum evictable idle time (milliseconds)) and running the eviction thread
(configurable in Dynamic JMX connection pool: time between eviction runs (milliseconds)).
Process for Requesting a Connection from the PooI
1. If the connection pool key does not exist yet, a new pool is created for this key.
2. If the pool exists and there is an idle connection, the connection is returned.
3. If there is not an idle connection, a new connection is created until the maximum number of
active connections in the pool is reached (Dynamic JMX connection pool: maximum active
connections in pool (per key)), or until the maximum total connections in the pool is reached
(Dynamic JMX connection pool: total number of connections for whole pool).
4. When the maximum number of active connections in the pool (per key) or maximum total
HP SiteScope (11.23)
Page 281 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
connections is reached, the monitor waits x milliseconds (Dynamic JMX connection pool:
waiting for connection timeout (milliseconds)) for a connection to be freed.
5. If one of the connections is freed in the meantime, it will be returned. Otherwise, the connection
fails.
You can tune the following connection pool properties in Preferences > Infrastructure
Preferences > Monitor Settings, as required:
l
Dynamic JMX connection pool: minimum evictable idle time (milliseconds): The
minimum time that a connection must be idle before the eviction thread can evict it. Note that the
actual amount of time a connection will be idle depends on when the eviction thread runs
(Dynamic JMX connection pool: time between eviction runs (milliseconds)). The default value is
1800000 milliseconds (30 minutes).
l
Dynamic JMX connection pool: time between eviction runs (milliseconds): Interval
between eviction thread runs for closing idle connections. The default value is 600000
milliseconds (10 minutes).
l
Dynamic JMX connection pool: maximum active connections in pool (per key): The
maximum number of active connections that can be open in the connection pool at the same
time per key. (The connection pool is a set of pools per key. A key is the combination of a JMX
URL, a user, and a password). The default value is 10.
l
Dynamic JMX connection pool: maximum idle connections in pool (per key): The
maximum number of idle connections in the connection pool (per key). (The connection pool is a
set of pools per key. A key is the combination of a JMX URL, a user, and a password). When
this value is exceeded, the number of unused connections that exceed this value are closed
rather than kept in the connection pool. The default value is 5.
l
Dynamic JMX connection pool: total number of connections for whole pool: The total
number of dynamic JMX connections available for the JMX connection pool (for all the keys
together). When this number is exceeded, the number of connections that exceed this value are
closed. The default value is 500.
l
Dynamic JMX connection pool: waiting for connection timeout (milliseconds): The
amount of time to wait for a connection from the JMX connection pool before timing out. The
default value is 60000 milliseconds (1 minute).
Thread Pool Settings
The Hadoop monitor always uses a separate thread pool to bring information (counter names and
values) from the JMX server (unlike the JMX monitor which has two modes for using thread pools:
regular mode and sandbox mode).
You can configure JMX thread pool settings in Preferences > Infrastructure Preferences >
Monitor Settings. These settings are only relevant when using additional classpath mode. These
settings are for each thread pool. A new thread pool is created for each additional classpath used by
the Hadoop monitor. The same thread pool is used for all Hadoop monitors that do not use an
additional classpath.
HP SiteScope (11.23)
Page 282 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
l
JMX thread pool core size: Number of threads to keep in the JMX pool that can be created for
JMX tasks, even if they are idle. The default value is 10.
l
JMX thread pool idle time (seconds): When the number of threads is greater than the core,
this is the maximum time that excess idle threads will wait for new JMX tasks before timing out.
The default value is 30 seconds.
l
JMX thread pool maximum size: Maximum number of threads allowed in the pool. If the
number of threads in the pool is greater than the core but less than the maximum, and the queue
is full, then new threads will be created for the JMX tasks until the maximum number of threads
in pool is reached. The default value is 200.
l
JMX thread pool queue size: Maximum number of JMX tasks that can be added to the queue.
If all the core threads are busy now, the new tasks will be added to queue until the max queue
size is reached. The default value is 400.
Hadoop Topology
The Hadoop monitor can identify the topology of the Hadoop cluster infrastructure being monitored.
If Report monitor and related CI topology is selected in HP Integration Settings (the default
setting), the monitor creates the following topology in BSM's RTSM.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
Note:
HP SiteScope (11.23)
Page 283 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
l
Topology reporting for this monitor is only supported in BSM 9.23 and later.
l
The Hadoop monitor does not report the Hadoop Cluster CI type in the topology results. As
a result, the default Hadoop cluster view does not show results reported by SiteScope.
Tasks
How to Configure the Hadoop Monitor
1.
Configure the monitor properties
a. Right-click the group into which you want to add the monitor instance, select New >
Monitor, and select Hadoop. The New Hadoop Monitor dialog box opens.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the Hadoop Monitor Settings panel, enter the required settings as described in "Hadoop
Monitor Settings" on page 287.
d. In the Patterns & Counter section, click the Get Counter button, and select the counters
you want to monitor from the Select Counters Form (the form displays static counters
only). The counters are added to the Counter Preview tree.
e. For dynamic monitoring, you can add patterns to counters to instruct the monitor which
counters to use, either by:
o
Clicking the Add New Counter
button to add an empty line to the table, and then
by creating a pattern format using a regular expression.
Tip:
o
The pattern should always start and end with the forward slash ("/") character.
o
The "[" and "]" characters which appear as part of counter names should be
escaped (preceded with the backslash ("\") character)
o
Use ".*" to describe any character any number of times.
For example, /java.lang/Memory/.*/ shows all memory counters that are exposed
by the java.lang domain.
o
Selecting a static counter, and editing the counter to create a pattern format using a
regular expression. For details on using regular expressions, see Regular Expressions
Overview in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 284 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
Note: For details on the maximum number of counters that can be selected from
the browsable tree and the maximum number of counters that can match the
selected counter patterns when creating and updating dynamic monitors, see
"Tips/Troubleshooting" on page 292. If the maximum number of counters that can
be deployed is exceeded, an error is written to the RunMonitor.log.
Example:
If you enter the pattern /java.lang/ClassLoading/.*/, the monitor retrieves all the
ClassLoading counters in the JMX application, such as TotalLoadedClassCount,
UnloadedClassCount, LoadedClassCount, ObjectName.
f. To view the counters that match a selected pattern, click the View Matches for selected
Pattern
button. The matching counters are highlighted in the Counter Preview tree.
g. Set the frequency for updating counters from the server, and then click Verify & Save or
Save to save your settings. If you use only static counters, they are not affected by the
frequency for updating counters, since the dynamic framework does not run.
h. To display counters that no longer exist after the update mechanism runs, select Continue
displaying counters that no longer exist after update. Any such counters are displayed
as unavailable. This can be useful for keeping track of the counters that were previously
being monitored.
i. In the Threshold Settings tab, you can manually set logic conditions for the dynamic
counters that determine the reported status of each monitor instance. To view thresholds of
all patterns translated to actual current counters, click the Threshold Preview button.
For threshold user interface details, see Threshold Settings in the Using SiteScope Guide.
Note: When configuring threshold settings for the Hadoop monitor:
2.
o
The monitor always(default) counter configured in the Good if section of the
monitor's properties means that the state of the monitor is good, unless one of the
thresholds of any of the other counters is breached.
o
The countersinError counter configured in the Error if section of the monitor's
properties means that the state of the monitor is error if one of the other counters is
unavailable.
Configure connection pool and thread pool settings - optional
You can tune the connection pool and thread pool properties in Preferences > Infrastructure
Preferences > Monitor Settings.
HP SiteScope (11.23)
Page 285 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
For details, see "Connection Pool Settings" on page 281 and "Thread Pool Settings" on page
282.
3.
Enable topology reporting - optional
n
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For user interface details, see
"BSM Integration Data and Topology Settings" in the Using SiteScope Guide. For details on
the Hadoop monitor topology, see "Hadoop Topology" on page 283.
n
To see topology reported by the monitor and Health Indicators assigned to monitor metrics,
you should download and install the following resources from the HP Live Network:
Content Pack for DDM:
i. Navigate to HP Live Network Home > Discovery and Dependency Mapping >
Content Packs for DDM > Content Files (https://hpln.hp.com/node/31/contentfiles).
ii. In the resources tree, select: Downloads > Content Packs for UCMDB 9.03 – 9.05
> DDM Content Pack 11 > Technology Specific Content.
iii. Download the Hadoop zip file and the installation instructions PDF.
iv. Follow the instructions in the PDF for importing the content package into RTSM.
Content Pack for BSM:
i. Navigate to HP Live Network Home > Business Service Management > Content
Packs for BSM > Content Files (https://hpln.hp.com/node/12361/contentfiles).
ii. In the resources tree, select: Downloads > Content > Hadoop > 9.22.
iii. Download the zip file corresponding your BSM platform and the installation instructions
PDF
iv. Follow the instructions in the PDF for installing the content pack.
4.
Results
If you are using the dynamic monitoring mechanism, during each update, the monitor connects
to the server where the JMX performance counters you want to monitor are running and
updates the status of each counter that matches the pattern defined by the regular expression.
It also updates the thresholds for the selected counters.
You can check performance of the dynamic monitoring framework in:
n
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details,
see Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
n
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic
Monitoring Page in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 286 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
UI Descriptions
Hadoop Monitor Settings
User interface elements are described below:
UI Element
Description
JMX URL
URL to gather JMX statistics. This is the hostname of the server which hosts
the Hadoop Distributed File System (HDFS) and Hadoop MapReduce master
nodes.
Enter the URL in the format:
service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi
User name
User name for connection to the JMX application (if required by your JMX
application).
Password
Password for connection to the JMX application (if required by your JMX
application).
Timeout
(seconds)
Amount of time, in seconds, to wait for a response from the server before
timing-out. After this time period passes, the monitor logs an error and reports
an error status.
Default value: 60 seconds (using a value other than the default timeout value
may adversely affect performance)
Patterns &
Counters
Displays the server performance counters selected for this monitor. Use the
Get Counters button to select counters.
Click the Add New Counter
button to add an empty row at the bottom of
the counters tree, enabling you to manually add a counter.
Click the Delete Counter
button to remove the selected counters from the
list. You can select multiple items using the CTRL or SHIFT keys.
Click the View Matches for Selected Pattern Counter
counters that match the selected patterns.
button to display
Note: SiteScope uses Perl regular expressions for pattern matching. For
example, if you enter /cpu.*/ or cpu, any counters with cpu in their name
match this pattern and are added to the counters list.
HP SiteScope (11.23)
Page 287 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
UI Element
Description
Get Counters
Opens a tree of all current counters, enabling you to select the counters you
want to monitor. The tree is opened with no nodes selected. When you make a
selection in the tree, the counters table is updated. For the list of counters that
can be configured for this monitor, see "Monitor Counters" on the next page.
Note when working in template mode: The maximum number of counters
that you can select is 100. If you import a template monitor from an earlier
version of SiteScope, or perform a copy to template action, the number of
counters is not limited.
Counter
Preview
Displays all real counters in the monitor. This includes static counters and
counter patterns that have been translated to real counters.
Frequency of
updating
counters
from server
Time interval at which the counters that are requested by this monitor are
retrieved from the server, and the monitor is updated with counter pattern
matches. Use the drop-down list to specify increments of seconds, minutes,
hours, or days.
Default value: 15 minutes
Note:
Continue
displaying
counters that
no longer
exist after
update
l
The update frequency cannot be less than the monitor run frequency in
Monitor Run Settings.
l
When configuring this setting in a template, the variable value can only be in
time units of seconds.
l
Static counters are never deleted.
When selected, counters that no longer exist after running the update
mechanism to retrieve counters from the monitored server, are not deleted and
are still displayed in the monitor (they are displayed as unavailable). This is
useful, for example, if a disk fails or for keeping track of counters that were
previously being monitored.
When cleared, the counters that no longer exist are removed from the Counter
Preview and Threshold Settings on the next update.
Default value: Not selected
Note: This option is relevant for dynamic counters only (those set using a
regular expression). Static counters that are no longer available are still
displayed even when this check box is cleared.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 288 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
Monitor Counters
Hadoop cluster JMX exposes over 300 metrics.
Below are some of the most valuable metrics for monitoring the HDFS and MapReduce master
nodes of the Hadoop cluster. For a more comprehensive list with descriptions, calculated counters,
and default thresholds, see the Hadoop Solution Template Best Practices guide which can be found
at <SiteScope root directory>\sisdocs\pdfs\SiteScope_Hadoop_Best_Practices.pdf.
Note: Each Hadoop cluster has a different size, workload, and job complexity. This means
that you need to adjust the default threshold values according to your environment specifics,
so as to maximize the benefits of the Hadoop monitor.
HP SiteScope (11.23)
Page 289 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
HDFS Node Metrics
Hadoop/NameNode/FSNamesystemMetrics/CapacityRemainingGB
Hadoop/NameNode/FSNamesystemMetrics/CapacityTotalGB
Hadoop/NameNode/FSNamesystemMetrics/CapacityUsedGB
Hadoop/NameNode/FSNamesystemMetrics/CorruptBlocks
Hadoop/NameNode/FSNamesystemMetrics/ExcessBlocks
Hadoop/NameNode/FSNamesystemMetrics/MissingBlocks
Hadoop/NameNode/FSNamesystemMetrics/PendingDeletionBlocks
Hadoop/NameNode/FSNamesystemMetrics/PendingReplicationBlocks
Hadoop/NameNode/FSNamesystemMetrics/ScheduledReplicationBlocks
Hadoop/NameNode/FSNamesystemMetrics/UnderReplicatedBlocks
Hadoop/NameNode/FSNamesystemState/CapacityRemaining
Hadoop/NameNode/FSNamesystemState/FSState
Hadoop/NameNode/jvm/gcCount Hadoop/NameNode/jvm/gcTimeMillis
Hadoop/NameNode/jvm/memHeapCommittedMHadoop/NameNode/jvm/memHeapUsedM
Hadoop/NameNode/jvm/memNonHeapCommittedM Hadoop/NameNode/jvm/memNonHeapUsedM
Hadoop/NameNode/jvm/threadsBlocked Hadoop/NameNode/jvm/threadsNew
Hadoop/NameNode/jvm/threadsRunnable Hadoop/NameNode/jvm/threadsTerminated
Hadoop/NameNode/jvm/threadsWaiting
Hadoop/NameNode/NameNode/AddBlockOps Hadoop/NameNode/NameNode/blockReport_avg_
time Hadoop/NameNode/NameNode/blockReport_num_ops
Hadoop/NameNode/NameNode/fsImageLoadTime
Hadoop/NameNode/NameNode/JournalTransactionsBatchedInSync
Hadoop/NameNode/NameNodeInfo/NodesData/Dead nodes count
Hadoop/NameNode/NameNodeInfo/NodesData/Decom nodes count
Hadoop/NameNode/NameNodeInfo/NodesData/Live nodes count
Hadoop/NameNode/NameNodeInfo/NodesData/NameDir statuses active count
Hadoop/NameNode/NameNodeInfo/NodesData/NameDir statuses failed count
Hadoop/NameNode/NameNodeInfo/PercentRemaining
Hadoop/NameNode/NameNodeInfo/PercentUsed
MapReduce Node Metrics
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Alive nodes count
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Blacklisted nodes count
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Graylisted nodes count
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Total jobs count
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Total map slots
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Total nodes count
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Total reduce slots
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Used map slots
Hadoop/JobTracker/JobTrackerInfo/JobTrackerDetails/Used reduce slots
Hadoop/JobTracker/JobTrackerInfo/Queues Data/Queues in running state
Hadoop/JobTracker/JobTrackerInfo/Queues Data/Queues in stopped state
Hadoop/JobTracker/JobTrackerInfo/Queues Data/Queues in undefined state
HP SiteScope (11.23)
Page 290 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
Hadoop/JobTracker/JobTrackerInfo/TaskTrackers/.*/Dir failures
Hadoop/JobTracker/JobTrackerInfo/TaskTrackers/.*/Failures
Hadoop/JobTracker/JobTrackerInfo/ThreadCount
Hadoop/JobTracker/JobTrackerMetrics/blacklisted_maps
Hadoop/JobTracker/JobTrackerMetrics/blacklisted_reduces
Hadoop/JobTracker/JobTrackerMetrics/heartbeats
Hadoop/JobTracker/JobTrackerMetrics/jobs_completed
Hadoop/JobTracker/JobTrackerMetrics/jobs_failed
Hadoop/JobTracker/JobTrackerMetrics/jobs_killed
Hadoop/JobTracker/JobTrackerMetrics/jobs_preparing
Hadoop/JobTracker/JobTrackerMetrics/jobs_running
Hadoop/JobTracker/JobTrackerMetrics/jobs_submitted
Hadoop/JobTracker/JobTrackerMetrics/map_slots
Hadoop/JobTracker/JobTrackerMetrics/maps_completed
Hadoop/JobTracker/JobTrackerMetrics/maps_failed
Hadoop/JobTracker/JobTrackerMetrics/maps_killed
Hadoop/JobTracker/JobTrackerMetrics/maps_launched
Hadoop/JobTracker/JobTrackerMetrics/occupied_map_slots
Hadoop/JobTracker/JobTrackerMetrics/occupied_reduce_slots
Hadoop/JobTracker/JobTrackerMetrics/reduce_slots
Hadoop/JobTracker/JobTrackerMetrics/reduces_completed
Hadoop/JobTracker/JobTrackerMetrics/reduces_failed
Hadoop/JobTracker/JobTrackerMetrics/reduces_killed
Hadoop/JobTracker/JobTrackerMetrics/reduces_launched
Hadoop/JobTracker/JobTrackerMetrics/reserved_map_slots
Hadoop/JobTracker/JobTrackerMetrics/reserved_reduce_slots
Hadoop/JobTracker/JobTrackerMetrics/running_maps
Hadoop/JobTracker/JobTrackerMetrics/running_reduces
Hadoop/JobTracker/JobTrackerMetrics/trackers
Hadoop/JobTracker/JobTrackerMetrics/trackers_blacklisted
Hadoop/JobTracker/JobTrackerMetrics/trackers_decommissioned
Hadoop/JobTracker/JobTrackerMetrics/trackers_graylisted
Hadoop/JobTracker/JobTrackerMetrics/waiting_maps
Hadoop/JobTracker/JobTrackerMetrics/waiting_reduces
Hadoop/JobTracker/jvm/gcCount
Hadoop/JobTracker/jvm/gcTimeMillis
Hadoop/JobTracker/jvm/memHeapCommittedM
Hadoop/JobTracker/jvm/memHeapUsedM
Hadoop/JobTracker/jvm/memNonHeapCommittedM
Hadoop/JobTracker/jvm/memNonHeapUsedM
Hadoop/JobTracker/jvm/threadsBlocked
Hadoop/JobTracker/jvm/threadsNew
Hadoop/JobTracker/jvm/threadsRunnable
Hadoop/JobTracker/jvm/threadsTerminated
Hadoop/JobTracker/jvm/threadsTimedWaiting
Hadoop/JobTracker/jvm/threadsWaiting
Hadoop/JobTracker/QueueMetrics/.*/jobs_completed
Hadoop/JobTracker/QueueMetrics/.*/jobs_failed
Hadoop/JobTracker/QueueMetrics/.*/jobs_killed
HP SiteScope (11.23)
Page 291 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
Hadoop/JobTracker/QueueMetrics/.*/jobs_running
Hadoop/JobTracker/QueueMetrics/.*/jobs_submitted
Hadoop/JobTracker/QueueMetrics/.*/maps_completed
Hadoop/JobTracker/QueueMetrics/.*/maps_failed
Hadoop/JobTracker/QueueMetrics/.*/maps_killed
Hadoop/JobTracker/QueueMetrics/.*/maps_launched
Hadoop/JobTracker/QueueMetrics/.*/reduces_completed
Hadoop/JobTracker/QueueMetrics/.*/reduces_failed
Hadoop/JobTracker/QueueMetrics/.*/reduces_killed
Hadoop/JobTracker/QueueMetrics/.*/reduces_launched
Hadoop/JobTracker/QueueMetrics/.*/reserved_map_slots
Hadoop/JobTracker/QueueMetrics/.*/reserved_reduce_slots
Hadoop/JobTracker/QueueMetrics/.*/waiting_maps
Hadoop/JobTracker/QueueMetrics/.*/waiting_reduces
Tips/Troubleshooting
General Notes
l
When deploying these monitors using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
When SiteScope is connected to BSM 9.00 or later, the Indicator State and Severity column is
not displayed in Threshold Settings by default. This is because each counter pattern can affect
more than one measurement, and only static counters and counter patterns are displayed by
default. This column is displayed only when you click the Threshold Preview button
(thresholds of all patterns are translated to actual current counters and are displayed).
l
Baseline Settings are not available for dynamic monitors (these monitors configure their own
thresholds).
l
The Hadoop monitor does not report the Hadoop Cluster CI type in the topology results. As a
result, the default Hadoop cluster view does not show results reported by SiteScope.
Maximum Number of Counters That Can be Saved
Browsable monitors are limited by the number of counters they have. The maximum number of
counters is determined by the _browsableContentMaxCounters parameter in the master.config
file (also in Preferences > Infrastructure Preferences > Monitor Settings > Maximum
browsable counters to be selected). If you create or edit a monitor so that it has more counters
than this value, only the number of counters up to this value is saved.
When a browsable monitor is deployed in a template, the number of counters that match the
selected patterns is limited by the _maxCountersForRegexMatch parameter in the master.config
file. If during deployment, the number of counters that match the patterns exceeds this value, only
the number of counters up to this value is saved.
The _maxCountersForRegexMatch parameter is also used to limit the number of counters that
match the selected counter patterns when creating and updating dynamic monitors. We
recommend using the same value for both _browsableContentMaxCounters and _
HP SiteScope (11.23)
Page 292 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
maxCountersForRegexMatch parameters in the master.config file. The default value for both of
these parameters is 1000.
When upgrading from earlier versions of SiteScope, the value for both of these parameters is set to
the higher of these two parameter values in the previous version, or to 1000 (whichever is greater).
Troubleshooting Logs
1. Check for dynamic framework errors in:
n
<SiteScope root directory>\logs\dynamic_monitoring_changes.log. This log describes
monitor changes made by the dynamic framework (adding/removing counters), including the
monitor name and counter name.
n
<SiteScope root directory>\logs\dynamic_monitoring.log. This log describes all the
tasks being run by the dynamic framework (counters extracted from the server, counters
matched to patterns, and so on).
To check for dynamic monitoring errors, copy the following section from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
###################################################################################
# Dynamic Monitoring
###################################################################################
log4j.category.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=
DEBUG, dynamic.monitoring.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=false
log4j.category.com.mercury.sitescope.entities.monitors.dynamic=DEBUG, dynamic.monitoring
.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.dynamic=false
log4j.appender.dynamic.monitoring.appender=org.apache.log4j.RollingFileAppender
log4j.appender.dynamic.monitoring.appender.File=../${log.file.path}/dynamic_monitoring.l
og
log4j.appender.dynamic.monitoring.appender.MaxFileSize=1000KB
log4j.appender.dynamic.monitoring.appender.MaxBackupIndex=5
log4j.appender.dynamic.monitoring.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.dynamic.monitoring.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p
- %m%n
2. Check for Hadoop monitor errors in:
n
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific
monitor runs and actions related to managing monitors.
n
<SiteScope root directory>\logs\hadoop_monitor.log. This log provides information
about Hadoop monitor errors.
To view Hadoop monitor errors, copy the following sections from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
HP SiteScope (11.23)
Page 293 of 926
Monitor Reference
Chapter 35: Hadoop Monitor
##################################################################################
# Hadoop monitor
##################################################################################
log4j.category.com.mercury.sitescope.monitors.facades.HadoopMonitor=DEBUG, hadoop.append
er
log4j.additivity.com.mercury.sitescope.monitors.facades.HadoopMonitor=false
log4j.category.com.mercury.sitescope.monitors.bigdata.hadoop.utils.HadoopMonitorUtils=DE
BUG, hadoop.appender
log4j.additivity.com.mercury.sitescope.monitors.bigdata.hadoop.utils.HadoopMonitorUtils=
false
log4j.category.com.mercury.sitescope.monitors.bigdata.hadoop.tasks.HadoopMonitorCounterL
oadingTask=DEBUG, hadoop.appender
log4j.additivity.com.mercury.sitescope.monitors.bigdata.hadoop.tasks.HadoopMonitorCounte
rLoadingTask=false
log4j.appender.hadoop.appender=org.apache.log4j.RollingFileAppender
log4j.appender.hadoop.appender.File=../${log.file.path}/hadoop_monitor.log
log4j.appender.hadoop.appender.MaxFileSize=${def.file.max.size}
log4j.appender.hadoop.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.hadoop.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.hadoop.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p - %m%n
log4j.appender.hadoop.appender.encoding=${general.encoding}
HP SiteScope (11.23)
Page 294 of 926
Chapter 36: HAProxy Monitor
Use the HAProxy monitor to provide front- and back-end statistics to check that your HAProxy
server is working properly. HAProxy is a solution that is used to provide high availability, load
balancing, and proxying for TCP and HTTP-based applications. Using the HAProxy monitor
provides a solution for monitoring infrastructures in the cloud.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the HAProxy monitor.
Learn About
Supported Platforms/Versions
This monitor supports monitoring remote servers running on:
l
Linux 2.4 on x86, x86_64, Alpha, SPARC, MIPS, PARISC
l
Linux 2.6 on x86, x86_64, ARM (ixp425), PPC64
l
Solaris 8/9 on UltraSPARC 2 and 3
l
Solaris 10 on Opteron and UltraSPARC
l
FreeBSD 4.10 - 8 on x86
l
OpenBSD 3.1 to -current on i386, amd64, macppc, alpha, sparc64 and VAX (check the ports)
Support for IPv6 Addresses
This monitor supports the IPv6 protocol. If you want your environment to resolve host names to
IPv6, you can select the Prefer IP version 6 addresses option in SiteScope Infrastructure
Settings (Preferences > Infrastructure Preferences > Server Setting). If this option is selected,
whenever a host name is specified for a remote server and the name is resolved to both IPv4 and
IPv6, the IPv6 address is used.
When using IPv6, this monitor supports the HTTP protocol.
If specifying a literal IPv6 address as the name for the monitored remote server when IPv6
addressing is enabled, the IP address must be enclosed in square brackets ("[", "]"). For example:
http://[2004:DB8:2a:1005:230:48ff:fe73:982d]:8080
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the HAProxy Monitor
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 295 of 926
Monitor Reference
Chapter 36: HAProxy Monitor
UI Descriptions
HAProxy Monitor Settings
User interface elements are described below:
UI Element
Description
URL
URL of the stats-CSV report.
Example: http://server:port/haproxy?stats;csv
Credentials
Option to use for authorizing credentials if the URL specified requires a name
and password for access:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password to access the URL in the
User name and Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password for the URL
(default option). Select the credential profile to use from the Credential
profile drop-down list, or click Add Credentials and create a new credential
profile. For details on how to perform this task, see How to Configure
Credential Preferences in the Using SiteScope Guide.
Authorization User name to access the Web server stats page.
user name
Authorization Password for accessing the Web server stats page.
password
HTTP proxy
Domain name and port of an HTTP Proxy Server if a proxy server is used to
access the URL. Remember to include the port.
Example: proxy.thiscompany.com:8080
Proxy server
user name
Proxy user name if the proxy server requires a name and password to access
the URL.
Note: The proxy server must support Proxy-Authenticate for these options to
function.
Proxy server
password
Proxy password if the proxy server requires a name and password to access
the URL.
Note: The proxy server must support Proxy-Authenticate for these options to
function.
HP SiteScope (11.23)
Page 296 of 926
Monitor Reference
Chapter 36: HAProxy Monitor
UI Element
Description
Timeout
(seconds)
Number of seconds (between 1 and 120) that the monitor should wait for a
response from the server before timing-out. After this time period passes, the
monitor logs an error and reports an error status.
Default value: 60 seconds
Counters
Displays the server performance counters you want to check with this monitor.
Use the Get Counters button to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you want
to monitor.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 297 of 926
Chapter 37: HP iLO (Integrated Lights-Out)
Monitor
Use the HP iLO (Integrated Lights-Out) monitor that enables monitoring of hardware health on
supported HP ProLiant servers. You can monitor multiple parameters or counters with a single
monitor instance. This enables you to watch server health status and hardware configuration for
stability monitoring and fast response for critical hardware issues. You can create a separate HP
iLO Monitor instance for each supported server in your environment.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the HP iLO monitor.
Learn About
This section includes:
l
"HP iLO Background" below
l
"Supported Platforms/Versions" below
l
"What to Monitor" on the next page
l
"IPv6 Addressing" on the next page
HP iLO Background
HP Integrated Lights-Out, or iLO, is an embedded server management technology exclusive to
Hewlett-Packard but similar in functionality to the Lights out management (LOM) technology of
other vendors.
iLO makes it possible to perform activities on an HP server from a remote location. iLO is currently
available on all new ProLiant 300/500/blade server models and has a separate network connection
(and its own IP address).
iLO actively participates in monitoring and maintaining server health, referred to as embedded
health. iLO monitors temperatures in the server and sends corrective signals to the fans to maintain
proper server cooling. In addition to temperature monitoring, iLO provides fan status monitoring and
monitoring of the status of the power supplies, voltage regulators, and the internal hard drives.
System Information displays the health of the monitored system. These features are available
without installing and loading the health driver for the installed operating system. The iLO
microprocessor monitors these devices when the server is powered on during server boot,
operating system initialization, and operation.
Supported Platforms/Versions
The HP iLO monitor supports monitoring HP iLO 2, 3, and 4.
HP SiteScope (11.23)
Page 298 of 926
Monitor Reference
Chapter 37: HP iLO (Integrated Lights-Out) Monitor
What to Monitor
The HP iLO monitor makes use of performance counters to measure application server
performance, and can be used to provide the following information:
l
Processors. Displays the available processor slots and a brief status summary of the processor
subsystem. If available, installed processor speed in MHz and cache capabilities are displayed.
l
Memory. Displays the available memory slots and the type of memory, if any, installed in the
slot.
l
Drives. Displays the presence and condition of installed drive bays.
l
Power Supplies. Displays the presence and condition of installed power supplies.
l
Voltage Regulator Modules (VRMs). Displays VRM status. A VRM is required for each
processor in the system. The VRM adjusts the power to meet the power requirements of the
processor supported. A failed VRM prevents the processor from being supported and should be
replaced.
l
Fans. Displays the state of the replaceable fans in the server chassis. This data includes the
area that is cooled by each fan and current fan speeds.
l
Temperatures. Displays the temperature conditions monitored at sensors in various locations in
the server chassis, and the processor temperature. The temperature is monitored to maintain the
location temperature below the caution threshold. If the temperature exceeds the caution
threshold, the fan speed is increased to maximum.
l
Other. Other information about the server, such as firmware version and available slots.
IPv6 Addressing
The HP iLO monitor supports IP version 6 addresses if the network and remote server support this
protocol.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the HP iLO Monitor
1. Prerequisites
The following are important requirements for using the HP iLO monitor:
n
The HP iLO system administrator must configure the service on the ProLiant server so that
it can access a command line interface over SSH.
n
The configuration should be tested by connecting the server to the SSH client using the
configured credentials, and running the following command:
HP SiteScope (11.23)
Page 299 of 926
Monitor Reference
Chapter 37: HP iLO (Integrated Lights-Out) Monitor
show system1 -l 1
The result should contain targets and their properties available on the server.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
HP iLO Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
HP iLO server you want to monitor. Select a server from the server list (only those
HP iLO remote servers that have been configured in SiteScope are displayed), or
click Add Remote Server to add an HP iLO server.
Note: When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Add
Remote
Server
Opens the Add UNIX Remote Server dialog box, enabling you to enter the
configuration details. For user interface details, see New/Edit UNIX Remote Server
Dialog Box in the Using SiteScope Guide.
Counters The server performance counters selected for this monitor. Use the Get Counters
button to select counters.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Note: When working in template mode, the maximum number of counters that you
can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 300 of 926
Monitor Reference
Chapter 37: HP iLO (Integrated Lights-Out) Monitor
Monitor Counters
The list of counters depends on the monitored system, and can differ significantly from system to
system.
Below is a sample set of counters that are available:
• system1/firmware1/date
• system1/firmware1/version
• system1/cpu1/cachememory1
• system1/cpu1/cachememory2
• system1/cpu1/cachememory3
• system1/cpu1/speed
• system1/memory1/location
• system1/memory1/size
• system1/memory1/speed
• system1/slot1/type
• system1/slot1/width
• system1/fan1/DesiredSpeed
• system1/fan1/DeviceID
• system1/fan1/ElementName
• system1/fan1/HealthState
• system1/fan1/OperationalStatus
• system1/fan1/VariableSpeed
• system1/sensor1 : temp1/CurrentReading
• system1/sensor1 : temp1/DeviceID
• system1/sensor1 : temp1/ElementName
• system1/sensor1 : temp1/HealthState
• system1/sensor1 : temp1/OperationalStatus
• system1/sensor1 : temp1/RateUnits
• system1/sensor1 : temp1/SensorType
• system1/sensor1 : temp1/oemhp_CautionValue
• system1/sensor1 : temp1/oemhp_CriticalValue
• system1/powersupply1/ElementName
• system1/powersupply1/HealthState
• system1/powersupply1/OperationalStatus
• system1/properties/enabledstate
• system1/properties/name
• system1/properties/number
• system1/properties/oemhp_powerreg
• system1/properties/oemhp_pwrcap
• system1/properties/oemhp_pwrmode
• system1/properties/oemhp_server_name
• system1/properties/processor_number
• system1/properties/pstate_number
Tips/Troubleshooting
General Tips/Limitations
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
HP SiteScope (11.23)
Page 301 of 926
Chapter 38: HP NonStop Event Log Monitor
Use the HP NonStop Event Log monitor to monitor the Event Logs for added entries on HP
NonStop Operating System servers. The HP NonStop Event Log monitor examines events that
occurred after the time that the monitor was created. Each time the monitor runs thereafter, it
examines only those entries added since the last time it ran. You can choose to filter out messages
that are not important by using the boxes listed under Monitor Settings to specify values that must
appear in the event entry for the entry to match.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the HP NonStop Event Log monitor.
Learn About
Supported Platforms/Versions
l
The minimum officially supported version of the HP NonStop Open System Management (OSM)
Event Viewer is T0682 H02 ABU (released May 2009).
l
All G-Series, H-Series, and J-Series NonStop RVUs are supported.
Tasks
How to Configure the HP NonStop Event Log Monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
HP NonStop Event Log Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
URL
URL of the OSM Event Viewer.
Example: https://<nonstopserver>:9991
HP SiteScope (11.23)
Page 302 of 926
Monitor Reference
Chapter 38: HP NonStop Event Log Monitor
UI Element
Description
Match
content
Text to look for in the log entries. You can also use a regular expression in this
entry to match text patterns. The monitor reports how many times the matched
pattern was found. To match text that includes more than one line of text, add an
s search modifier to the end of the regular expression. For details, see Regular
Expressions Overview in the Using SiteScope Guide. You can also use the
Regular Expression Test tool to check your regular expressions. For details, see
Regular Expression Tool in the Using SiteScope Guide.
Timeout
(seconds)
Amount of time, in seconds, that the monitor should wait for an event before
timing-out. Once this time period passes, the monitor logs an error and reports
an error status.
Default value: 60 seconds
Retries
Number of times that SiteScope should retry the request if a recoverable error
was encountered. A timeout of the request for is a recoverable error.
Default value: 0
Time zone
Appropriate time zone, according to the location of the HP NonStop server.
Filter Settings
Event
sources
Collectors or log file name. You can type more than one collector, separated by
comma. Events from multiple collectors are merged by generation time. You can
also specify a single event log file.
Default value: $ZLOG
Options
Filter options. You can enter more than one option, using commas as
separators.
Example: CPU 0, PIN 253
Owner
Enter an owner in this field (up to 8 characters).
Subsystem
names
Subsystem name. You can enter more than one subsystem, using commas as
separators.
Example: PATHWAY,TMF
You can use the full subsystem name (for example, PATHWAY), an existing
abbreviated subsystem name (for example, PWY), or the subsystem number
(for example, 8).
Event IDs
Event number to filter on a specific event number. You can enter a single event
number, a set of event numbers separated by commas, a range a..b, or a set of
ranges separated by commas. Event numbers may be signed. If you specify
any event numbers, you can only have one subsystem.
HP SiteScope (11.23)
Page 303 of 926
Monitor Reference
Chapter 38: HP NonStop Event Log Monitor
UI Element
Description
Filter files
Filter names. You can enter more than one filter by using commas as
separators. You can add more than one filter file, using commas as separators.
Authentication Settings
Credentials
User name and password required to access the HP NonStop server. Select the
option to use for providing credentials:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password in the User name and
Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default option).
Select the credential profile to use from the Credential profile drop-down
list, or click Add Credentials and create a new credential profile. For details
on how to perform this task, see How to Configure Credential Preferences in
the Using SiteScope Guide.
Pre-emptive
Authorization user name and password option if SiteScope requests the target
authorization UR:
l
Use global preference. SiteScope uses the authenticate setting as
specified in the Pre-emptive authorization section of the General Preferences
page. This is the default value.
l
Authenticate first request. The user name and password are sent on the
first request SiteScope makes for the target URL.
Note: If the URL does not require a user name and password, this option may
cause the URL to fail.
l
Authenticate if requested. The user name and password are sent on the
second request if the server requests a user name and password.
Note: If the URL does not require a user name and password, this option may
be used.
All options use the Authorization user name and Authorization password
entered for this monitor instance. If these are not specified for the individual
monitor, the Default authentication user name and Default authentication
password specified in the Main section of the General Preferences page are
used, if they have been specified.
Note: Pre-emptive authorization does not control if the user name and password
should be sent, or which user name and password should be sent.
HP SiteScope (11.23)
Page 304 of 926
Monitor Reference
Chapter 38: HP NonStop Event Log Monitor
UI Element
Description
Client side
certificate
The certificate file, if using a client side certificate to access the target URL.
Normally, this is a .pfx (.p12) type certificate, which usually requires a
password. You enter the password for the certificate in the Client side
certificate password box.
Note: Client side certificate files must be copied into the <SiteScope root
directory>\templates.certificates directory.
Client side
certificate
password
Password if you are using a client side certificate and a password is required.
Accept
untrusted
certificates
for HTTPS
Select if you need to use certificates that are untrusted in the certificate chain to
access the target URL using Secure HTTP (HTTPS).
Accept
invalid
certificates
for HTTPS
Select if you need to accept an invalid certificate to access the XML URL using
Secure HTTP (HTTPS). This may happen, for example, if the current date is not
in the date ranges specified in the certificate chain.
Default value: Not selected
Default value: Not selected
Proxy Settings
HTTP proxy
Domain name and port of an HTTP Proxy Server if a proxy server can be used to
access the URL.
Proxy server
user name
Proxy server user name if the proxy server requires a name and password to
access the URL.
Note: Your proxy server must support Proxy-Authenticate for these options to
function.
Proxy server
password
Proxy server password if the proxy server requires a name and password to
access the URL.
Note: Your proxy server must support Proxy-Authentication for these options to
function.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Tips/Limitations
When configuring this monitor in template mode, you can use regular expressions to define
counters.
HP SiteScope (11.23)
Page 305 of 926
Chapter 39: HP NonStop Resources Monitor
The HP NonStop Resources monitor enables you to monitor multiple system statistics on a single
HP NonStop Operating System server. The error and warning thresholds for the monitor can be set
on one or more server system statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the HP NonStop Resources monitor.
Learn About
This section includes:
l
"HP NonStop Resources Monitor Overview" below
l
"Supported Platforms/Versions" below
HP NonStop Resources Monitor Overview
Use the HP NonStop Resources monitor to monitor the server system statistics on HP NonStop
Operating System servers. You can monitor multiple parameters or measurements with a single
monitor instance. This enables you to monitor the remote server for loading, performance, and
availability at a basic system level. Create a separate HP NonStop Resources monitor instance for
each HP NonStop Operating System server in your environment.
The HP NonStop Resources monitor queries the list of HP NonStop Servers currently configured in
the UNIX Remote Servers container. To monitor a remote HP NonStop Operating System server,
you must define a NonStop Remote connection profile for the server before you can add an HP
NonStop Resources monitor for that server. For details on configuring a remote server, see How to
Configure SiteScope to Monitor a Remote UNIX Server in the Using SiteScope Guide.
You can also use the Directory, Disk Space, Dynamic Disk Space, File, Log File, and Script
monitors to monitor remote servers running on HP NonStop Operating Systems. Monitors that do
not depend on a remote operating system, such as FTP, Port, SNMP, SNMP by MIB, and URL
family monitors, can also support monitoring on an HP NonStop operating system server.
Supported Platforms/Versions
All G-Series, H-Series, and J-Series NonStop RVUs are supported.
HP SiteScope (11.23)
Page 306 of 926
Monitor Reference
Chapter 39: HP NonStop Resources Monitor
Tasks
How to Configure the HP NonStop Resources Monitor
1. Prerequisites
To enable monitoring of remote servers running on a HP NonStop Operating System (using
either the HP NonStop Resources monitor or the Directory, Disk Space, Dynamic Disk Space,
File, Log File, or Script monitor), you must perform the following on the HP NonStop Operating
System server:
a. Create a user for SiteScope monitoring.
b. In the /etc/profile and .profile files, perform the following:
o
Comment out the string: set –o vi.
o
Set the following parameter: export PS1='$PWD:
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Note: When configuring a remote server for monitoring the HP NonStop server, if the
remote server gives a choice of TACL shell only, select the remote server in Remote
Servers > UNIX Remote Servers, and enter the following in the Main Settings panel:
n
In the Shell name field, enter tacl.
n
In the Login prompt field, enter >.
n
In the Secondary response field, enter OSH.
n
In the User name box in the Credentials section, enter the user name in the format:
logon <user_name>.
HP SiteScope (11.23)
Page 307 of 926
Monitor Reference
Chapter 39: HP NonStop Resources Monitor
UI Descriptions
HP NonStop Resources Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Server where the resources you want to monitor are located. Select a server from
the server list (only UNIX remote servers that have been configured in SiteScope to
run on an HP NonStop operating system are displayed), or click Add Remote
Server to add a UNIX server.
Note when working in template mode: You can use the template remote server (if
one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Add
Remote
Server
Opens the Add UNIX Remote Server dialog box, enabling you to enter the
configuration details (in the Operating System list, you must select NonStopOS).
For user interface details, see New/Edit UNIX Remote Server Dialog Box in the
Using SiteScope Guide.
Available Displays the available measurements for this monitor.
Counters
For each measurement, select the Objects, Instances and Counters you want to
check with the HP NonStop Resources monitor, and click the Add Selected
Counters
button. The selected measurements are moved to the Selected
Counters list.
Note:
l
The performance objects and counters available for the HP NonStop Resources
monitor vary depending on what operating system options and applications are
running on the remote server.
l
When configuring this monitor in template mode, you can use regular expressions
to define counters.
For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Selected
Counters
Displays the measurements currently selected for this monitor, and the total number
of selected counters.
To remove measurements selected for monitoring, select the required
measurements, and click the Remove Selected Counters
measurements are moved to the Available Counters list.
button. The
Note: For information on configuring setting panels that are common to all monitors, see
HP SiteScope (11.23)
Page 308 of 926
Monitor Reference
Chapter 39: HP NonStop Resources Monitor
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
CPU
• PROCESSBUSYTIME
• INTERRUPT TIME
• IDLE TIME
Memory
• ALLOCS (per sec)
• DISKREADS (per sec)
• DISKWRITES (per sec)
• FAULTS (per sec)
• FREE (16KB pages)
• FREEMIN (16KB pages)
HP SiteScope (11.23)
• FREEQUOTA (16KB pages)
• FREERED (16KB pages)
• LOCKED (16KB pages)
• LOCKED (KSEG0) (16KB pages)
• MUTEXCRAX (per sec)
• NONMUTEXCRAX (per sec)
• PHYSCL (16KB pages)
• REDBUSY (per sec)
• REDHIT (per sec)
• REDTASK (per sec)
• SWAPBL (16KB pages)
• UNDUMPED (16KB pages)
Page 309 of 926
Chapter 40: HP Vertica JDBC Monitor
The HP Vertica JDBC monitor enables you to dynamically monitor the health and performance
statistics of key items of the Vertica cluster infrastructure. The monitor gets counters from a Vertica
cluster that provides access to its statistics by using a JDBC driver. Vertica can be monitored by
SNMP trap and System tables.
This monitor is designed to manage large, fast-growing volumes of data and provide fast query
performance when used for data warehouses and other query-intensive applications. Using this
monitor, you can select specific measurements or use the dynamic monitoring mechanism to
automatically update counters and thresholds that changed in Vertica system tables during runtime.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to
create a monitoring solution for various aspects of the Vertica cluster infrastructure. For
details, see HP Vertica Solution Template in the Using SiteScope Guide.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the HP Vertica JDBC monitor.
Learn About
This section includes:
l
"Vertica JDBC Monitor Overview" below
l
"Supported Platforms/Versions" on the next page
l
"Setup Requirements and User Permissions" on the next page
l
"HP Vertica JDBC Topology" on the next page
Vertica JDBC Monitor Overview
This monitor enables you to:
l
Monitor specific counters on a Vertica cluster using static counters. You can monitor multiple
parameters or counters with a single monitor instance.
l
Select the counter patterns you want to monitor using a regular expression or a static string, and
let the monitor dynamically update Vertica counters that match the pattern defined by the regular
expression. Dynamic monitoring enables you to configure the monitor on a one time basis, and
leave it to update itself.
When configuring a dynamic monitor, you can define a counter pattern that specifies the
counters you want to monitor. The monitor scans the target host periodically, and creates the
counters that are aligned with the given counter pattern.
HP SiteScope (11.23)
Page 310 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
If a new Vertica counter is added to the machine and part or all of its counters correspond to the
counter pattern, the counters that match the counter pattern are automatically added to the
monitor when the counters are next updated from the server. Similarly, if a Vertica counter that
corresponds to the counter pattern is no longer available, counters for that metric are removed
from the monitor (unless you choose not to delete them, in which case they are still displayed in
the monitor's counter list).
You can also define the required thresholds for the counter's pattern. In this way, thresholds are
also updated automatically when the counters are updated.
For more details on the dynamic monitoring mechanism, see Dynamic Monitoring Mechanism in
the Using SiteScope Guide.
Supported Platforms/Versions
The HP Vertica monitor supports monitoring on Vertica Community Edition and Vertica Analytics
Platform 6.0.1, 6.1.
Setup Requirements and User Permissions
The following are several key requirements for using the HP Vertica JDBC monitor:
l
You should download the Vertica JDBC driver from the official HP Vertica site and copy it to the
<SiteScope root directory>\WEB-INF\lib subdirectory.
Tip: Many database driver packages are available as compressed (zipped) archive files or
.jar files. If the file is in zip format, unzip the contents to a temporary directory. Stop and
restart the SiteScope service after copying the driver file to the SiteScope machine.
l
The syntax for accessing the database driver is:
jdbc:vertica://<Vertica_host>:<port_number>/<database_name>
For details, see the HP Vertica Analytics Platform Version 6.1.x Documentation
(https://my.vertica.com/docs/6.1.x/HTML/index.htm).
l
Generally, only one instance of each type of JDBC driver client should be installed on the
SiteScope machine. If there is more than one instance installed, SiteScope may report an error
and be unable to connect to the database. For example, installing two Vertica JDBC drivers from
two different versions of Vertica is unlikely to work.
l
You must have a database user login that SiteScope can use to access the database.
SiteScope is only able to run the SQL queries that this user has permission to run on the
database.
HP Vertica JDBC Topology
The HP Vertica JDBC monitor can identify the topology of the database system being monitored. If
Report monitor and related CI topology is selected in HP Integration Settings (the default
setting), the monitor creates the following topology in BSM's RTSM.
HP SiteScope (11.23)
Page 311 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
Note: Topology reporting for this monitor is only supported in BSM 9.23 and later.
Tasks
How to Configure the HP Vertica JDBC Monitor
1.
Prerequisites
Before configuring the monitor, make sure you have the necessary requirements and
permissions. For details, see "Setup Requirements and User Permissions" on the previous
page.
2.
Configure the monitor properties
a. Right-click the group into which you want to add the monitor instance, select New >
Monitor, and select HP Vertica JDBC. The New HP Vertica JDBC Monitor dialog box
opens.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the HP Vertica JDBC Monitor Settings panel, enter the URL of the Vertica cluster you
want to monitor, the driver to which you want to connect, and use credentials. For user
interface details, see the UI Descriptions section below.
d. In the Patterns & Counter section, click the Get Counter button, and select the counters
you want to monitor from the Select Counters Form (the form displays static counters
only). The counters are added to the Counter Preview tree.
e. For dynamic monitoring, you can add patterns to counters to instruct the monitor which
counters to use, either by:
HP SiteScope (11.23)
Page 312 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
o
Clicking the Add New Counter
button to add an empty line to the table, and then
by creating a pattern format using a regular expression.
Tip:
o
The pattern should always start and end with the forward slash ("/") character.
o
Special characters which appear as part of counter names should be escaped
(preceded with the backslash ("\") character).
o
Use ".*" to describe any character any number of times.
For example, /Query Metrics/.*/, shows all query metrics.
o
Selecting a static counter, and editing the counter to create a pattern format using a
regular expression. For details on using regular expressions, see Regular Expressions
Overview in the Using SiteScope Guide.
Note: For details on the maximum number of counters that can be selected from
the browsable tree and the maximum number of counters that can match the
selected counter patterns when creating and updating dynamic monitors, see
"Tips/Troubleshooting" on page 319. If the maximum number of counters that can
be deployed is exceeded, an error is written to the RunMonitor.log.
f. To view the counters that match a selected pattern, click the View Matches for selected
Pattern
button. The matching counters are highlighted in the Counter Preview tree.
g. Set the frequency for updating counters from the server, and then click Verify & Save or
Save to save your settings. If you use only static counters, they are not affected by the
frequency for updating counters, since the dynamic framework does not run.
h. To display counters that no longer exist after the update mechanism runs, select Continue
displaying counters that no longer exist after update. Any such counters are displayed
as unavailable. This can be useful for keeping track of the counters that were previously
being monitored.
i. In the Threshold Settings tab, you can manually set logic conditions for the dynamic
counters that determine the reported status of each monitor instance. To view thresholds of
all patterns translated to actual current counters, click the Threshold Preview button.
For threshold user interface details, see Threshold Settings in the Using SiteScope Guide.
Note: When configuring threshold settings for the HP Vertica JDBC monitor:
HP SiteScope (11.23)
Page 313 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
o
The monitor always(default) counter configured in the Good if section of the
monitor's properties means that the state of the monitor is good, unless one of the
thresholds of any of the other counters is breached.
o
The countersinError counter configured in the Error if section of the monitor's
properties means that the state of the monitor is error if one of the other counters is
unavailable.
Tip: The Database Connection Tool is available when configuring this monitor to
test and verify connectivity between SiteScope and an external ODBC or JDBC
compatible database (provided you are an administrator in SiteScope, or a user
granted Use monitor tools permissions). To use the tool when configuring or editing
a monitor, click the Use Tool button. For details on the tool, see Database Connection
Tool\ in the Using SiteScope Guide.
3.
Enable topology reporting - optional
n
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For user interface details, see
"BSM Integration Data and Topology Settings" in the Using SiteScope Guide. For details on
the HP Vertica JDBC monitor topology, see "HP Vertica JDBC Topology" on page 311.
n
To see topology reported by the monitor and Health Indicators assigned to monitor metrics,
you should download and install the following resources from the HP Live Network:
Content Pack for DDM:
i. Navigate to HP Live Network Home > Discovery and Dependency Mapping >
Content Packs for DDM > Content Files (https://hpln.hp.com/node/31/contentfiles).
ii. In the resources tree, select: Downloads > Content Packs for UCMDB 9.03 – 9.05
> DDM Content Pack 11 > Technology Specific Content.
iii. Download the Vertica zip file and the installation instructions PDF.
iv. Follow the instructions in the PDF for importing the content package into RTSM.
Content Pack for BSM:
i. Navigate to HP Live Network Home > Business Service Management > Content
Packs for BSM > Content Files (https://hpln.hp.com/node/12361/contentfiles).
ii. In the resources tree, select: Downloads > Content > Vertica > 9.22.
iii. Download the zip file corresponding your BSM platform and the installation instructions
HP SiteScope (11.23)
Page 314 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
PDF
iv. Follow the instructions in the PDF for installing the content pack.
4.
Results
If you are using the dynamic monitoring mechanism, during each update, the monitor connects
to the Vertica database where the performance counters you want to monitor are running and
updates the status of each counter that matches the pattern defined by the regular expression.
It also updates the thresholds for the selected counters.
You can check performance of the dynamic monitoring framework in:
n
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details,
see Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
n
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic
Monitoring Page in the Using SiteScope Guide.
UI Descriptions
HP Vertica JDBC Monitor Settings
User interface elements are described below:
UI Element
Description
Database
connection
URL
Connection URL to the Vertica cluster you want to monitor. The syntax is
jdbc:vertica://<host>:<port>/<database>.
Database
driver
Driver used to connect to the Vertica database.
Example: com.vertica.jdbc.Driver
Credentials Option for providing the user name and password to be used to access the Vertica
database server:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password in the User name and
Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default option).
Select the credential profile to use from the Credential profile drop-down list,
or click Add Credentials and create a new credential profile. For details on
how to perform this task, see How to Configure Credential Preferences in the
Using SiteScope Guide.
HP SiteScope (11.23)
Page 315 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
UI Element
Description
Patterns &
Counters
Displays the server performance counters selected for this monitor. Use the Get
Counters button to select counters.
Click the Add New Counter
button to add an empty row at the bottom of the
counters tree, enabling you to manually add a counter.
Click the Delete Counter
button to remove the selected counters from the
list. You can select multiple items using the CTRL or SHIFT keys.
Click the View Matches for Selected Pattern Counter
counters that match the selected patterns.
button to display
Note: SiteScope uses Perl regular expressions for pattern matching. For
example, if you enter /query.*/ or query, any counters with query in their name
match this pattern and are added to the counters list.
Get
Counters
Opens a tree of all current counters, enabling you to select the counters you want
to monitor. The tree is opened with no nodes selected. When you make a
selection in the tree, the counters table is updated. For the list of counters that can
be configured for this monitor, see "Monitor Counters" on the next page.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Counter
Preview
Displays all real counters in the monitor. This includes static counters and counter
patterns that have been translated to real counters.
Frequency Time interval at which the counters that are requested by this monitor are retrieved
of updating from the server, and the monitor is updated with counter pattern matches. Use the
counters
drop-down list to specify increments of seconds, minutes, hours, or days.
from server
Default value: 15 minutes
Note:
l
The update frequency cannot be less than the monitor run frequency in Monitor
Run Settings.
l
When configuring this setting in a template, the variable value can only be in
time units of seconds.
l
Static counters are never deleted.
HP SiteScope (11.23)
Page 316 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
UI Element
Description
Continue
displaying
counters
that no
longer
exist after
update
When selected, counters that no longer exist after running the update mechanism
to retrieve counters from the monitored server, are not deleted and are still
displayed in the monitor (they are displayed as unavailable). This is useful, for
example, if a disk fails or for keeping track of counters that were previously being
monitored.
When cleared, the counters that no longer exist are removed from the Counter
Preview and Threshold Settings on the next update.
Default value: Not selected
Note: This option is relevant for dynamic counters only (those set using a regular
expression). Static counters that are no longer available are still displayed even
when this check box is cleared.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of default counters for this monitor grouped by specified table columns:
Tree Branch
Counters
Active
Events
Event Code, Event Description for each node
Backups
Snapshot Name, Backup Timestamp, Epoch, Node Count, Objects for each
node
Configuration Value and Default Value for each configuration parameter
Parameters
Critical
Hosts
List of critical hosts
Crtical
Nodes
List of critical nodes
Disk
Resource
Rejections
Rejected Reason, Rejected Count for each resource type on each node if
specified rejection was occurred
Disk Storage
Storage Usage, Rank, Throughput, Latency, Storage Status, Disk Block Size
(bytes), Disk Space Used (Blocks), Disk Space Used (MB), Disk Space Free
(Blocks), Disk Space Free(MB), Disk Space Free % for each storage path on
each node
HP SiteScope (11.23)
Page 317 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
Tree Branch
Counters
Host
Resources
Open Files Limit, Threads Limit, Core File Limit Max Size (bytes), Processor
Count, Processor Core Count, Processor Description, Opened File Count,
Opened Socket Count, Opened Nonfile Nonsocket Count, Total Memory (bytes),
Total Memory Free(bytes), Total Buffer Memory (bytes), Total Memory Cache
(bytes), Total Swap Memory (bytes), Total Swap Memory Free (bytes), Disk
Space Free (MB), Disk Space Used (MB), Disk Space Total (MB) on each host
Locks
Lock Duration (sec) for each locked object on each node if lock is longer than 60
sec
Nodes
Node State, Node Address, Export Address, Is Ephemeral for each node
Node
Resources
Host Name, Process Size (bytes), Process Resident Set Size (bytes), Process
Shared Memory Size (bytes), Process Text Memory Size (bytes), Process Data
Memory Size (bytes), Process Library Memory Size (bytes), Process Dirty
Memory Size (bytes), Spread Host, Node Port, Data Port on each node
Projections
Verified Fault Tolerance, Is Up To Date, Has Statistics for each projection
Query
Metrics
Active User Session Count, Active System Session Count, Total User Session
Count, Total System Session Count, Total Active Session Count, Total Session
Count, Running Query Count, Executed Query Count on each node
Query
Performance
Number of Running Queries, Longest Query, Longest Query Duration (sec) on
each node
Recovery
Status
Recover Epoch, Recovery Phase, Splits Completed, Splits Total, Historical
Completed, Historical Total, Current Completed, Current Total, Is Running on
each node
Resource
Pools
Is Internal, Memory Size, Max Memory Size, Execution Parallelism, Priority,
Runtime Priority, Runtime Priority Threshold, Queue Timeout, Planned
Concurrency, Max Concurrency, Runtime Cap, Single Initiator for each exists
resource pool
Resource
Pool Status
Is Internal, Memory Size (KB), Memory Size Actual (KB), Memory In Use (KB),
General Memory Borrowed (KB), Queueing Threshold (KB), Max Memory Size
(KB), Running Query Count, Planned Concurrency, Max Concurrency, Is
Standalone, Queue Timeout (sec), Execution Parallelism, Priority, Runtime
Priority, Runtime Priority Threshold, Single Initiator, Query Budget (Kb) for each
exists resource pool on each node
Resource
Queue
Queue Length, Memory Requested (KB) for each pool on each node if queue
exists
Resource
Rejections
Rejection Count for each reason for each resource type on each node if rejection
was occurred
HP SiteScope (11.23)
Page 318 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
Tree Branch
Counters
Resource
Usage
Request Count, Local Request Count, Request Queue Depth, Active Thread
Count, Open File Handle Count, Memory Requested (KB), Address Space
Requested (KB), WOS Used Bytes, WOS Row Count, ROS Used (bytes), ROS
Row Count, Total Row Count, Total Used (bytes), Resource Request Reject
Count, Resource Request Timeout Count, Resource Request Cancel Count,
Disk Space Request Reject Count, Failed Volume Reject Count, Tokens Used,
Tokens Available on each node
Storage Tiers
Node Count, Location Count, ROS Container Count, Total Occupied Size for
each storage location
System
Current Epoch, AHM Epoch, Last Good Epoch, Refresh Epoch, Designed Fault
Tolerance, Node Count, Node Down Count, Current Fault Tolerance, Catalog
Revision Number, WOS Used (bytes), WOS Row Count, ROS Used (bytes),
ROS Row Count, Total Used (bytes), Total Row Count
System
Resource
Usage
Average Memory Usage %, Average CPU Usage %, Network RX (KBytes Per
Second), Network TX (KBytes Per Second), IO Read (KBytes Per Second), IO
Written (KBytes Per Second) on each node
System
Services
Service Type, Service Group, Service Interval (sec), Is Enabled, Last Run Start,
Last Run End for each service on each node
WOS
Container
Storage
Region Virtual Size (KB), Region Allocated Size (KB), Region In Use Size (KB),
Region Small Release Count, Region Big Release Count, Extra Reserved
(bytes), Extra Used (bytes) for each WOS Allocation Region for each WOS type
on each node
Tips/Troubleshooting
General Tips/Limitations
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
When SiteScope is connected to BSM 9.00 or later, the Indicator State and Severity column is
not displayed in Threshold Settings by default. This is because each counter pattern can affect
more than one measurement, and only static counters and counter patterns are displayed by
default. This column is displayed only when you click the Threshold Preview button
(thresholds of all patterns are translated to actual current counters and are displayed).
l
Baseline Settings are not available for dynamic monitors (these monitors configure their own
thresholds).
Maximum Number of Counters That Can be Saved
Browsable monitors are limited by the number of counters they have. The maximum number of
HP SiteScope (11.23)
Page 319 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
counters is determined by the _browsableContentMaxCounters parameter in the master.config
file (also in Preferences > Infrastructure Preferences > Monitor Settings > Maximum
browsable counters to be selected). If you create or edit a monitor so that it has more counters
than this value, only the number of counters up to this value is saved.
When a browsable monitor is deployed in a template, the number of counters that match the
selected patterns is limited by the _maxCountersForRegexMatch parameter in the master.config
file. If during deployment, the number of counters that match the patterns exceeds this value, only
the number of counters up to this value is saved.
The _maxCountersForRegexMatch parameter is also used to limit the number of counters that
match the selected counter patterns when creating and updating dynamic monitors. We
recommend using the same value for both _browsableContentMaxCounters and _
maxCountersForRegexMatch parameters in the master.config file. The default value for both of
these parameters is 1000.
When upgrading from earlier versions of SiteScope, the value for both of these parameters is set to
the higher of these two parameter values in the previous version, or to 1000 (whichever is greater).
Troubleshooting Logs
1. Check for dynamic framework errors in:
n
<SiteScope root directory>\logs\dynamic_monitoring_changes.log. This log describes
monitor changes made by the dynamic framework (adding/removing counters), including the
monitor name and counter name.
n
<SiteScope root directory>\logs\dynamic_monitoring.log. This log describes all the
tasks being run by the dynamic framework (counters extracted from the server, counters
matched to patterns, and so on).
To check for dynamic monitoring errors, copy the following section from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
###################################################################################
# Dynamic Monitoring
###################################################################################
log4j.category.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=
DEBUG, dynamic.monitoring.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=false
log4j.category.com.mercury.sitescope.entities.monitors.dynamic=DEBUG, dynamic.monitoring
.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.dynamic=false
log4j.appender.dynamic.monitoring.appender=org.apache.log4j.RollingFileAppender
log4j.appender.dynamic.monitoring.appender.File=../${log.file.path}/dynamic_monitoring.l
og
log4j.appender.dynamic.monitoring.appender.MaxFileSize=1000KB
log4j.appender.dynamic.monitoring.appender.MaxBackupIndex=5
log4j.appender.dynamic.monitoring.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.dynamic.monitoring.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p
- %m%n
HP SiteScope (11.23)
Page 320 of 926
Monitor Reference
Chapter 40: HP Vertica JDBC Monitor
2. Check for HP Vertica JDBC monitor errors in:
n
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific
monitor runs and actions related to managing monitors.
n
<SiteScope root directory>\logs\vertica_monitor.log. This log provides information about
HP Vertica JDBC monitor errors.
To view HP Vertica JDBC monitor errors, copy the following sections from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
###################################################################################
# HP Vertica Monitor
###################################################################################
log4j.category.com.mercury.sitescope.monitors.facades.VerticaJDBCMonitor=DEBUG, vertica.
appender
log4j.additivity.com.mercury.sitescope.monitors.facades.VerticaJDBCMonitor=false
log4j.category.com.mercury.sitescope.monitors.vertica=DEBUG, websphere.appender
log4j.additivity.com.mercury.sitescope.monitors.vertica=false
log4j.appender.vertica.appender=org.apache.log4j.RollingFileAppender
log4j.appender.vertica.appender.File=../${log.file.path}/vertica_monitor.log
log4j.appender.vertica.appender.MaxFileSize=${def.file.max.size}
log4j.appender.vertica.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.vertica.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.vertica.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p - %m%n
log4j.appender.vertica.appender.encoding=${general.encoding}
HP SiteScope (11.23)
Page 321 of 926
Chapter 41: IPMI Monitor
The Intelligent Platform Management Interface (IPMI) provides an interface for reporting on device
operations, such as whether fans are turning and voltage flowing within server hardware. You use
the IPMI monitor to monitor server and network element platforms to get a more complete view of
component health and operation statistics for IPMI enabled devices running version 1.5.
You can monitor multiple parameters or counters with a single monitor instance. This enables you
to watch key operational factors that can seriously affect availability and degrade performance.
Create a separate monitor instance for each server you are running.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the IPMI monitor.
Tasks
How to Configure the IPMI Monitor
1. Prerequisites
The following are requirements for using the IPMI monitor:
n
The device you want to monitor has to be IPMI-enabled. In most cases, this means that the
device must be designed for IPMI sensing and include a separate, dedicated IPMI network
adapter. The monitor supports IPMI version 1.5 only.
n
You must know the IP address of the IPMI network adapter for the device you want to
monitor. In many cases, this IP address is different than the IP address used for other
network communication to and from the device. Use an applicable IPMI utility to query for
the IP address or contact the applicable system administrator.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 322 of 926
Monitor Reference
Chapter 41: IPMI Monitor
UI Descriptions
IPMI Monitor Settings
User interface elements are described below:
UI Element
Description
Server
name
IPMI server name or IP address of the IPMI network adapter.
Port
number
Port number of the IPMI device.
Note: The IP address is normally not the same as the ordinary ethernet NIC
adapter address.
Default value: 623
Credentials Option for providing the user name and password to be used to access the IPMI
server:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password in the User name and
Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default option).
Select the credential profile to use from the Credential profile drop-down list,
or click Add Credentials and create a new credential profile. For details on
how to perform this task, see How to Configure Credential Preferences in the
Using SiteScope Guide.
Counters
Displays the server performance counters to check with this monitor. Use the Get
Counters button to select counters.
Get
Counters
Opens the Select Counters Form, enabling you to select the counters you want to
monitor.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Measures various hardware metrics even if the operating system is unresponsive. The list of
available counters is vendor dependant and usually includes CPU and system temperature, system
fans RPM, CPU and system voltage and more.
HP SiteScope (11.23)
Page 323 of 926
Monitor Reference
Chapter 41: IPMI Monitor
Tips/Troubleshooting
General Tips/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 324 of 926
Chapter 42: KVM Monitor
The KVM monitor provides a solution for monitoring Kernel-based Virtual Machines (KVM) on Linux
x86 and x86_64 hardware that contains virtualization extensions. You can monitor multiple
parameters or counters with a single monitor instance. This enables you to watch key operational
factors that can seriously affect availability and degrade performance. Create a separate monitor
instance for each server you are running.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the KVM monitor.
Learn About
This section includes:
l
"KVM Monitor Overview" below
l
"Supported Platforms/Versions" below
KVM Monitor Overview
KVM is a virtualization technology that allows you to run multiple operating systems, including
multiple instances of the same operating system, concurrently on the same physical computer.
SiteScope simplifies the monitoring of virtual infrastructure changes in dynamic, virtualized
environments by automatically changing the SiteScope configuration according to changes in the
virtual environment. KVM monitors are dynamically updated over time by adding or removing
counters as virtual machines are added or removed. This enables you to configure the monitor one
time, and leave it to automatically discover changes in the environment and update itself.
During initial monitor creation, the monitor uses the connection URI configured to access the VM
and dynamically discover the object hierarchy and available performance counters. You can select
from these performance counters to determine which measurements SiteScope should retrieve for
reporting server status.
You can also define the required thresholds for the counter's pattern. In this way, thresholds are
also updated automatically when the counters are updated.
For more details on the dynamic monitoring mechanism, see Dynamic Monitoring Mechanism in the
Using SiteScope Guide.
Supported Platforms/Versions
This monitor supports monitoring remote servers running on UNIX remotes only. It has been tested
on Linux #29-Ubuntu SMP 3.0.0-16-generic.
HP SiteScope (11.23)
Page 325 of 926
Monitor Reference
Chapter 42: KVM Monitor
Tasks
How to Configure the KVM Monitor
1.
2.
Prerequisites
n
The monitored VM server must be directly accessible by the SiteScope server (no proxy
involved).
n
The Virsh and Virt-top command-line tools should be installed on the system. For details,
see:
o
https://help.ubuntu.com/community/KVM/Virsh.
o
http://linux.die.net/man/1/virt-top
o
http://people.redhat.com/~rjones/virt-top/
Configure the monitor properties
a. Right-click the group into which you want to add the monitor instance, select New >
Monitor, and select KVM. The New KVM Monitor dialog box opens.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the KVM Monitor Settings panel, select the VM server you want to monitor (or add a new
server) and specify the driver to which you want to connect in the Connection URI box.
For user interface details, see the UI Descriptions section below.
d. Click the Get Counter button, and select the counters you want to monitor from the Select
Counters Form. The counters are added to the Preview tree in the Patterns & Counters
section.
e. For dynamic monitoring, you can add patterns to counters to instruct the monitor which
counters to use, either by:
o
Clicking the Add New Counter
button to add an empty line to the table, and
creating a pattern format using a regular expression.
Tip:
(1). The pattern should always start and end with the forward slash ("/") character.
(2). The "[" and "]" characters which appear as part of counter names should be
escaped (preceded with the backslash ("\") character).
(3). Use ".*" to describe any character any number of times.
For example, /.*/Domains Information/.*/Used Memory/ displays Used Memory
counter for all VMs.
HP SiteScope (11.23)
Page 326 of 926
Monitor Reference
Chapter 42: KVM Monitor
o
Selecting a static counter, and editing the counter to create a pattern format using a
regular expression. For details on using regular expressions, see Regular Expressions
Overview in the Using SiteScope Guide.
Note: For details on the maximum number of counters that can be selected from
the browsable tree and the maximum number of counters that can match the
selected counter patterns when creating and updating dynamic monitors, see
"Maximum Number of Counters That Can be Saved" on page 331. If the maximum
number of counters that can be deployed is exceeded, an error is written to the
RunMonitor.log.
Example:
If you enter the pattern /.*/Domains Information/.*/Used Memory/, the monitor
retrieves the Used Memory counter for all VMs.
f. To view the counters that match a selected pattern, click the View Matches for selected
Pattern
button. The matching counters are highlighted in the Counter Preview tree.
g. Set the frequency for updating counters from the server, and then click Verify & Save or
Save to save your settings. If you use only static counters, they are not affected by the
frequency for updating counters, since the dynamic framework does not run.
h. To display counters that no longer exist after the update mechanism runs, select Continue
displaying counters that no longer exist after update. Any such counters are displayed
as unavailable. This can be useful if a virtual machine fails or for keeping track of the
counters that were previously being monitored.
i. In the Threshold Settings tab, you can manually set logic conditions for the dynamic
counters that determine the reported status of each monitor instance. To view thresholds of
all patterns translated to actual current counters, click the Threshold Preview button.
For threshold user interface details, see Threshold Settings in the Using SiteScope Guide.
3.
Results
If you are using the dynamic monitoring mechanism, during each update, the monitor connects
to the VM server and updates the status of each counter that matches the pattern defined by
the regular expression. It also updates the thresholds for the selected counters.
You can check performance of the dynamic monitoring framework in:
n
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details,
see Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 327 of 926
Monitor Reference
Chapter 42: KVM Monitor
n
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic
Monitoring Page in the Using SiteScope Guide.
For additional troubleshooting suggestions, see "Tips/Troubleshooting" on page 330.
UI Descriptions
KVM Monitor Settings
User interface elements are described below:
UI Element
Description
Server
Name of the VM server that you want to monitor. Select a server from the
server list (only those UNIX remote servers that have been configured in
SiteScope are displayed), or click the Add Remote Server to add a new
UNIX server.
Note:
l
When configuring this monitor on SiteScopes running on UNIX versions,
only remote servers that have been configured with an SSH connection
method are displayed. For details, see How to Configure Remote Windows
Servers for SSH monitoring.
l
When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use
already configured template remote under current template check
box.
Server to get
(Available in template mode only) Name of any SiteScope remote server from
measurements which you want to get counters.
from
Add Remote
Server
Opens the Add UNIX Windows Remote Server dialog box, enabling you to
enter the configuration details. For user interface details, see New/Edit UNIX
Remote Server Dialog Box in the Using SiteScope Guide.
Connection
URI
URI of the driver of the VM server that you want to monitor.
HP SiteScope (11.23)
Default value: qemu:///system
Page 328 of 926
Monitor Reference
Chapter 42: KVM Monitor
UI Element
Description
Patterns &
Counters
Displays the server performance counters selected for this monitor. Use the
Get Counters button to select counters.
Click the Add New Counter
button to add an empty row at the bottom of
the counters tree, enabling you to manually add a counter.
Click the Delete Counter
button to remove the selected counters from the
list. You can select multiple items using the CTRL or SHIFT keys.
Click the View Matches for Selected Pattern
that match the selected patterns.
button to display counters
Note: SiteScope uses Perl regular expressions for pattern matching.
Get Counters
Opens a tree of all current counters, enabling you to select the counters you
want to monitor. The tree is opened with no nodes selected. When you make a
selection in the tree, the counters table is updated.
Counter
Preview
Displays all real counters in the monitor. This includes static counters and
counter patterns that have been translated to real counters.
Frequency of
updating
counters from
server
Time interval at which the counters that are requested by this monitor are
retrieved from the server, and the monitor is updated with counter pattern
matches. Use the drop-down list to specify increments of seconds, minutes,
hours, or days.
Default value: 15 minutes
Note:
HP SiteScope (11.23)
l
The update frequency cannot be less than the monitor run frequency in
Monitor Run Settings.
l
When configuring this setting in a template, the variable value can only be
in time units of seconds.
l
Static counters are never deleted.
Page 329 of 926
Monitor Reference
Chapter 42: KVM Monitor
UI Element
Description
Continue
displaying
counters that
no longer
exist after
update
When selected, counters that no longer exist after running the update
mechanism to retrieve counters from the monitored server, are not deleted and
are still displayed in the monitor (they are displayed as unavailable). This is
useful, for example, if a disk fails or for keeping track of counters that were
previously being monitored.
When cleared, the counters that no longer exist are removed from the Counter
Preview and Threshold Settings on the next update.
Default value: Not selected
Note: This option is relevant for dynamic counters only (those set using a
regular expression). Static counters that are no longer available are still
displayed even when this check box is cleared.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section includes:
l
"General Notes" below
l
"Maximum Number of Counters That Can be Saved" on the next page
l
"Troubleshooting Logs" on the next page
General Notes
l
When configuring this monitor in template mode, the Add Remote Server button is not
displayed, and some fields that contain drop-down lists may be displayed as text boxes.
l
When deploying these monitors using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
When SiteScope is connected to BSM 9.00 or later, the Indicator State and Severity column is
not displayed in Threshold Settings by default. This is because each counter pattern can affect
more than one measurement, and only static counters and counter patterns are displayed by
default. This column is displayed only when you click the Threshold Preview button
(thresholds of all patterns are translated to actual current counters and are displayed).
l
This monitor supports setting fractional thresholds which are more useful than setting whole
number thresholds when monitoring large disks (such as 1 terabyte and larger).
HP SiteScope (11.23)
Page 330 of 926
Monitor Reference
Chapter 42: KVM Monitor
l
Baseline Settings are not available for dynamic monitors (these monitors configure their own
thresholds).
Maximum Number of Counters That Can be Saved
Browsable monitors are limited by the number of counters they have. The maximum number of
counters is determined by the _browsableContentMaxCounters parameter in the master.config
file (also in Preferences > Infrastructure Preferences > Monitor Settings > Maximum
browsable counters to be selected). If you create or edit a monitor so that it has more counters
than this value, only the number of counters up to this value is saved.
When a browsable monitor is deployed in a template, the number of counters that match the
selected patterns is limited by the _maxCountersForRegexMatch parameter in the master.config
file. If during deployment, the number of counters that match the patterns exceeds this value, only
the number of counters up to this value is saved.
The _maxCountersForRegexMatch parameter is also used to limit the number of counters that
match the selected counter patterns when creating and updating dynamic monitors. We
recommend using the same value for both _browsableContentMaxCounters and _
maxCountersForRegexMatch parameters in the master.config file. The default value for both of
these parameters is 1000.
When upgrading from earlier versions of SiteScope, the value for both of these parameters is set to
the higher of these two parameter values in the previous version, or to 1000 (whichever is greater).
Troubleshooting Logs
1. Check for dynamic framework errors in:
n
<SiteScope root directory>\logs\dynamic_monitoring_changes.log. This log describes
monitor changes made by the dynamic framework (adding/removing counters), including the
monitor name and counter name.
n
<SiteScope root directory>\logs\dynamic_monitoring.log. This log describes all the
tasks being run by the dynamic framework (counters extracted from the server, counters
matched to patterns, and so on).
To check for dynamic monitoring errors, copy the following section from the
log4j.properties.debug file in the <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change
the log level to DEBUG.
###################################################################################
# Dynamic Monitoring
###################################################################################
log4j.category.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=
DEBUG, dynamic.monitoring.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.DynamicBrowsableBase=false
log4j.category.com.mercury.sitescope.entities.monitors.dynamic=DEBUG, dynamic.monitoring
.appender
log4j.additivity.com.mercury.sitescope.entities.monitors.dynamic=false
log4j.appender.dynamic.monitoring.appender=org.apache.log4j.RollingFileAppender
log4j.appender.dynamic.monitoring.appender.File=../${log.file.path}/dynamic_
HP SiteScope (11.23)
Page 331 of 926
Monitor Reference
Chapter 42: KVM Monitor
monitoring.log
log4j.appender.dynamic.monitoring.appender.MaxFileSize=1000KB
log4j.appender.dynamic.monitoring.appender.MaxBackupIndex=5
log4j.appender.dynamic.monitoring.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.dynamic.monitoring.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p
- %m%n
2. Check for KVM monitor errors in:
n
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific
monitor runs and actions related to managing monitors.
HP SiteScope (11.23)
Page 332 of 926
Chapter 43: JMX Monitor
This monitor enables you to monitor the performance statistics of those Java-based applications
that provide access to their statistics by using the standard JMX remoting technology defined by
JSR 160 (remote JMX).
Note: There is also a "Dynamic JMX Monitor" on page 232 which enables you to select the
counter patterns you want to monitor using a regular expression, and the monitor dynamically
updates MBean counters that match the pattern. Dynamic monitoring enables you to configure
the monitor on a one time basis, and leave it to update itself.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the JMX monitor.
Learn About
This section includes:
l
"JMX Monitor Overview" below
l
"Supported Platforms/Versions" on the next page
l
"Applications Supporting JSR 160" on page 335
l
"WebLogic Application Server Topology" on page 336
l
"Thread Pool Settings" on page 337
JMX Monitor Overview
You can monitor multiple parameters or counters with a single monitor instance. The counters
available vary from application to application, but normally include both basic JVM performance
counters, as well as counters specific to the application. You may create one JMX monitor instance
for each application you are monitoring, or several monitors for the same application that analyze
different counters.
Note:
l
WebLogic 11g (10.3.1-10.3.5) servers can be monitored using a JMX monitor only. For
details on how to monitor a WebLogic 11g (10.3.1-10.3.5) server, see "How to create a JMX
Monitor for a WebLogic Server" on page 338.
l
When monitoring a WebLogic Application Server using a t3 or t3s protocol, you need to use
WebLogic's own protocol provider package. For details on how to use the t3 or t3s protocol,
see "How to monitor a WebLogic 11g (10.3.1-10.3.5) server with an SSL connection using
the t3, t3s, iiop or iiops protocol" on page 339.
HP SiteScope (11.23)
Page 333 of 926
Monitor Reference
Chapter 43: JMX Monitor
l
SiteScope also provides a solution template that includes a set of predefined monitors to
create a monitoring solution for various aspects of a WebLogic Application server. For
details, see WebLogic Solution Templates in the Using SiteScope Guide.
Supported Platforms/Versions
This monitor supports monitoring on:
l
WebLogic 11g (10.3.1-10.3.5)
Note: Monitoring WebLogic 9.x and 10.x is no longer supported due to different Java
versions run by SiteScope 11.2x and WebLogic Application Server 9.x and 10.x.
l
Apache Tomcat 5.0, 5.5, 6.0, 6.0.33, 7.0.25
l
Oracle Application Server 10.1.3g
l
JBoss servers 4.0.3, 4.2, 5.0, 5.1, 6.0, 6.1, 7.0, 7.1.x
l
Sun Glassfish Enterprise Server 2.1, 3.1
HP SiteScope (11.23)
Page 334 of 926
Monitor Reference
Chapter 43: JMX Monitor
Applications Supporting JSR 160
Here are some applications that currently support JSR 160 and information about how to monitor
them:
Oracle WebLogic 11g (10.3.1-10.3.5) support JSR 160, which can be enabled on the WebLogic
application server by following instructions found on the Oracle Web site
(http://download.oracle.com/docs/cd/E14571_
01/apirefs.1111/e13952/taskhelp/channels/EnableAndConfigureIIOP.html).
l
Once enabled, the JMX URL for monitoring the server follows the following form:
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime
or
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
where <host> is the server name or IP address that is running your WebLogic application.
For instructions to create a JMX monitor for WebLogic 11g (10.3.1-10.3.5) servers, see "How to
create a JMX Monitor for a WebLogic Server" on page 338.
Tomcat 5.x and 6.0 support JSR 160, by defining the following properties to the JVM on startup:
l
n
Dcom.sun.management.jmxremote
n
Dcom.sun.management.jmxremote.port=9999
n
Dcom.sun.management.jmxremote.ssl=false
n
Dcom.sun.management.jmxremote.authenticate=false
The above properties specify the port as 9999. This value can be changed to any available port.
Also, it specifies no authentication. If authentication is necessary, see the Oracle Web site for
more details (http://download.oracle.com/javase/1.5.0/docs/guide/jmx/tutorial/security.html).
If the above properties are defined when starting Tomcat 5.x on <host>, the following would be
the JMX URL for monitoring it:
service:jmx:rmi:///jndi/rmi://<host>:9999/jmxrmi
Note: SiteScope 8.x runs within Tomcat 5.x, and can be monitored as described above.
l
JBoss 4.0.3 supports JSR 160, by defining the following properties to the JVM on startup:
n
-Dcom.sun.management.jmxremote
n
-Dcom.sun.management.jmxremote.port=9999
HP SiteScope (11.23)
Page 335 of 926
Monitor Reference
Chapter 43: JMX Monitor
l
l
n
-Dcom.sun.management.jmxremote.ssl=false
n
-Dcom.sun.management.jmxremote.authenticate=false
n
-Djboss.platform.mbeanserver
n
Djavax.management.builder.initial=org.jboss.system.server.jmx.MBeanServerBu
ilderImpl
JBoss 6.1 supports JSR 160, by defining the following properties to the JVM on startup:
n
-Dcom.sun.management.jmxremote
n
-Dcom.sun.management.jmxremote.port=9999
n
-Dcom.sun.management.jmxremote.authenticate=false
n
-Dcom.sun.management.jmxremote.ssl=false
n
-Djboss.platform.mbeanserver
n
-Djavax.management.builder.initial=org.jboss.system.server.
jmx.MBeanServerBuilderImpl
n
-Djava.endorsed.dirs="%JBOSS_ENDORSED_DIRS%"
n
-classpath "%JBOSS_CLASSPATH%" org.jboss.Main %*
Other vendors that have released versions of their software that are JSR 160 compliant, include
JBoss, Oracle 10g, and IBM WebSphere.
You can find more information about JSR 160 on the Java Community Process Web site
(http://www.jcp.org/en/jsr/detail?id=160).
WebLogic Application Server Topology
The JMX monitor can identify the topology of WebLogic Application Servers. If Report monitor
and related CI topology is selected in HP Integration Settings (the default setting), the monitor
creates the following topology in BSM's RTSM.
HP SiteScope (11.23)
Page 336 of 926
Monitor Reference
Chapter 43: JMX Monitor
Note: The JMX monitor can report topology data to BSM only when monitoring the WebLogic
application server, not when monitoring any other environment.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
Thread Pool Settings
The JMX monitor has two modes for using thread pools: regular mode which uses the existing
threads to bring information (counter names and values) from the JMX server, and sandbox mode
which uses additional threads taken from thread pool. By default, the JMX monitor uses the regular
mode. If you supply additional classpath, the default is sandbox mode. To enable the monitor to use
a separate thread pool (sandbox mode) even when not using additional classpath, set the_
disableExtraClassPathExecutor parameter to =false in the <SiteScope root
directory>\groups\master.config file.
You can configure JMX thread pool settings in Preferences > Infrastructure Preferences >
Monitor Settings. These settings are only relevant when using a separate thread pool (sandbox
mode). These settings are for each thread pool. A new thread pool is created for each additional
classpath used by the JMX monitor. The same thread pool is used for all JMX monitors that do not
use additional classpath, and for all JMX monitors that use additional classpath if _
disableExtraClassPathExecutor is set to =false.
l
JMX thread pool core size: Number of threads to keep in the JMX pool that can be created for
JMX tasks, even if they are idle. The default value is 10.
l
JMX thread pool idle time (seconds): When the number of threads is greater than the core,
this is the maximum time that excess idle threads will wait for new JMX tasks before timing out.
The default value is 30 seconds.
l
JMX thread pool maximum size: Maximum number of threads allowed in the pool. If the
number of threads in the pool is greater than the core but less than the maximum, and the queue
is full, then new threads will be created for the JMX tasks until the maximum number of threads
in pool is reached. The default value is 200.
HP SiteScope (11.23)
Page 337 of 926
Monitor Reference
Chapter 43: JMX Monitor
l
JMX thread pool queue size: Maximum number of JMX tasks that can be added to the queue.
If all the core threads are busy now, the new tasks will be added to queue until the max queue
size is reached. The default value is 400.
Tasks
How to create a JMX Monitor for an Apache Tomcat, JBoss, Sun Glassfish
Enterprise, or Oracle Application Server
Configure the monitor properties as described in the UI Descriptions section below.
Note: To get counters from a JBoss 7.1.x server, you must:
1. Add the following jars to classpath:
n
jboss-common-core.jar
n
jboss-client.jar
2. Select the Load additional classpath first check box.
How to create a JMX Monitor for a WebLogic Server
1. To monitor a WebLogic 11g (10.3.1-10.3.5) server, create a JMX monitor, and enter the
following in the JMX URL box:
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime or
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
2. (For WebLogic 6.x, 7.x, and 8.x) To help you to select the counters that you require, you can
open a WebLogic monitor for versions prior to WebLogic 9.x and see the counters that were
defined there. Search for these same counters in the counter tree. You can select additional
counters that are available in the JMX monitor and were not available in the WebLogic
monitors.
3. (For WebLogic 11g) To enable monitoring of a WebLogic Application Server 11g, enter the
wlfullclient.jar in the Additional Classpath field in the JMX Monitor Settings. You can
specify the timeout for JMX task execution (mbeans retrieval and conversion into xml) by
modifying the _overallJMXCountersRetrievalTimeout property in the master.config file.
The default value is 15 minutes. This is not an ORB timeout.
Note: For details on creating the wlfullclient.jar, refer to the Oracle documentation on
Using the WebLogic JarBuilder Tool (http://download.oracle.com/docs/cd/E12840_
HP SiteScope (11.23)
Page 338 of 926
Monitor Reference
Chapter 43: JMX Monitor
01/wls/docs103/client/jarbuilder.html).
4. Configure user credentials as required
You only need to specify a User name and Password if you do not want to use the default
setup for iiop. If you leave these fields blank (recommended), WebLogic uses the default iiop
user credentials that have already been configured in the WebLogic application.
You must also configure the security realm of WebLogic to exactly match the configured user
credentials (if specified), or the iiop user credentials (if the User name and Password fields
are left blank).
5. Configure the other monitor properties as required
Configure the other properties as described in the UI Description section below.
6. Enable topology reporting - optional
To enable topology reporting for WebLogic Application Servers, make sure that Report
monitor and related CI topology is selected in HP Integration Settings (the default
setting). For details on the monitor topology, see "WebLogic Application Server Topology" on
page 336.
For user interface details, see BSM Integration Data and Topology Settings in the Using
SiteScope Guide.
How to monitor a WebLogic 11g (10.3.1-10.3.5) server with an SSL
connection using the t3, t3s, iiop or iiops protocol
When monitoring a WebLogic Application Server using a t3, t3s, iiop or iiops protocol, you need to
use WebLogic's own protocol provider package.
Note: When monitoring a WebLogic server with the Administration port enabled, the t3s
protocol must be used.
1. Enter the URL in the following format in the JMX URL box of JMX Monitor Settings:
n
For t3 protocol:
service:jmx:t3://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
where the default port for t3 protocol is 7001
n
For t3s protocol:
service:jmx:t3s://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
HP SiteScope (11.23)
Page 339 of 926
Monitor Reference
Chapter 43: JMX Monitor
where the default port for t3s protocol is 7002
For iiop protocol:
n
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime or
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
For iiops protocol:
n
service:jmx:iiops://host:port/jndi/weblogic.management.
mbeanservers.runtime
2. (For t3 or t3s protocols) Copy the following jars from the WebLogic library to any folder on the
SiteScope server:
n
%WEBLOGIC_HOME%\server\lib\wlclient.jar
n
%WEBLOGIC_HOME%\server\lib\wljmxclient.jar
n
%WEBLOGIC_HOME%\server\lib\weblogic.jar
n
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
n
%WEBLOGIC_HOME%\server\lib\webserviceclient+ssl.jar (for t3s protocol only)
n
%WEBLOGIC_HOME%\server\lib\cryptoj.jar (for t3s protocol only, if this file is present in
WebLogic library)
Specify the full path to the copied jars in the Additional Classpath field in the JMX Monitor
Settings separated by “;”.
Note: For details on creating the wlfullclient.jar, refer to the Oracle documentation on
Using the WebLogic JarBuilder Tool (http://download.oracle.com/docs/cd/E12840_
01/wls/docs103/client/jarbuilder.html).
3. (For iiop or iiops protocols) Copy the following jars from the WebLogic library to any folder on
the SiteScope server:
n
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
n
%WEBLOGIC_HOME%\server\lib\wlcipher.jar (for iiops protocol only)
Specify the full path to wlfullclient.jar in the Additional Classpath field in the JMX Monitor
Settings.
HP SiteScope (11.23)
Page 340 of 926
Monitor Reference
Chapter 43: JMX Monitor
For details on creating the wlfullclient.jar, refer to the Oracle documentation on Using the
WebLogic JarBuilder Tool (http://download.oracle.com/docs/cd/E12840_
01/wls/docs103/client/jarbuilder.html).
4. (For t3s and iiops protocols) Enable SSL on the WebLogic server and import the SSL certificate
into the SiteScope keystore. For details, see Certificate Management Overview.
5. Configure the other monitor settings as required.
For details, see Settings Common to All Monitors in the Using SiteScope Guide.
UI Descriptions
JMX Monitor Settings
User interface elements are described below:
UI Element
Description
JMX URL
URL to gather JMX statistics. Typically the URL begins with
service:jmx:rmi:///jndi, followed by information specific to the application.
Note:
l
When creating a JMX monitor for a WebLogic 11g server, enter the following
URL:
service:jmx:iiop://<host>:<port>//jndi/
weblogic.management.mbeanservers.runtime or
service:jmx:iiop:///jndi/iiop://<host>:<port>/
weblogic.management.mbeanservers.runtime
l
When creating a JMX monitor for a JBoss server, your system administrator
should configure the JBoss server, and then report which ports are enabled for
JMX access.
l
When creating a JMX monitor for a JBoss 7.1.x server, enter the following
URL:
service:jmx:remoting-jmx://<host>:<port>
l
If you are using a t3 or t3s protocol, you need to use WebLogic's own protocol
provider package and the JMX URL is in a different format. For details, see
"How to monitor a WebLogic 11g (10.3.1-10.3.5) server with an SSL
connection using the t3, t3s, iiop or iiops protocol" on page 339.
l
The JMX over RMI protocol is not firewall friendly.
HP SiteScope (11.23)
Page 341 of 926
Monitor Reference
Chapter 43: JMX Monitor
UI Element
Description
Domain
filter
Domain filter to show only those counters existing within a specific domain
(optional). This filter does not have full regular expression support.
You can specify the domain name or full path to MBean. The full path can be taken
from the MBean obectName property using JConsole.
Example: Note that these MBean examples have different node properties in the
path: type-host-path in the first and type-resourcetype-name in the second.
l
For MBean "Catalina/Cache/localhost/SiteScope" specify:
"Catalina:type=Cache,host=localhost,path=/SiteScope"
l
For MBean "Catalina/Environment/Global/simpleValue" specify:
"Catalina:type=Environment,resourcetype=Global,name=simpleValue"
User name
User name for connection to the JMX application (if required by your JMX
application).
Password
Password for connection to the JMX application (if required by your JMX
application).
Timeout
(seconds)
Amount of time, in seconds, to wait for a response from the server before timingout. After this time period passes, the monitor logs an error and reports an error
status.
Default value: 60 seconds (using a value other than the default timeout value
may adversely affect performance)
Additional
Classpath
Specify the classpath library that is used to resolve unknown classes retrieved
from the JMX server. Multiple libraries can be entered separated by a semicolon.
By default, the JMX monitor uses existing thread pools to bring information
(counter names and values) from the JMX server (regular mode). However, if an
additional classpath is specified, the default is the sandbox mode which uses
additional threads taken from thread pool. To enable the monitor to use a separate
thread pool (sandbox mode) even when not using additional classpath, set _
disableExtraClassPathExecutor to =false in the <SiteScope root
directory>\groups\master.config file. For details, see "Thread Pool Settings" on
page 337.
Note: When monitoring a WebLogic Application Server 11g (10.3.1 - 10.3.5), this
field is mandatory, and the wlfullclient.jar must be used. For details on creating
the wlfullclient.jar, refer to Using the WebLogic JarBuilder Tool
(http://download.oracle.com/docs/cd/E12840_
01/wls/docs103/client/jarbuilder.html).
Load
additional
classpath
first
Loads the additional classpath libraries before loading all the existing classpath
libraries. If no additional classpath libraries are found, the other classpaths folders
are loaded.
HP SiteScope (11.23)
Page 342 of 926
Monitor Reference
Chapter 43: JMX Monitor
UI Element
Description
Counters
Server performance counters to check with this monitor. Use the Get Counters
button to select counters. When the server being monitored is a WebLogic 11g
server, see "How to create a JMX Monitor for a WebLogic Server" on page 338 for
further details.
Get
Counters
Opens the Select Counters Form, enabling you to select the counters you want to
monitor. The counters that you can monitor vary according to the target
application.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Arithmetic Counters
Note: The Arithmetic Counters feature was deprecated and replaced by Calculated Metrics. For
details about calculated metrics, see Calculated Metrics Settings in the Using SiteScope Guide.
HP plans to remove the Arithmetic Counters section from the JMX Monitor Settings in the next
version of SiteScope.
Add Arithmetic Counter. Adds a row to the Arithmetic Counters table, enabling
you to add an arithmetic counter.
Note: When working in template mode, you cannot use arithmetic counters that
contain variables in the original counter.
Delete Arithmetic Counter. Deletes the selected arithmetic counter from the
Arithmetic Counters table.
Original
Counters
The path and name of the original counter on which the arithmetic counter is
calculated.
Operator
The operator (Rate) that is performed on the counter. The value in this column is
not editable.
Value
This column is blank, and is not editable for the Rate operator.
Arithmetic
Counter
Name
The name of the arithmetic counter. This is the name of the on original counter on
which the arithmetic counter is calculated with "Rate on" prefix. The value in this
column is not editable.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section includes:
HP SiteScope (11.23)
Page 343 of 926
Monitor Reference
Chapter 43: JMX Monitor
l
"General Notes/Tips" below
l
"Troubleshooting and Limitations" below
General Notes/Tips
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
The maximum number of counters that you can select for the JMX monitor is 100. If you import a
template monitor from an earlier version of SiteScope, or perform a copy to template action, the
number of counters is not limited.
l
The JMX over RMI protocol is not firewall friendly.
l
The Arithmetic Counters feature was deprecated and replaced by Calculated Metrics. For
details about calculated metrics, see Calculated Metrics Settings in the Using SiteScope Guide.
HP plans to remove the Arithmetic Counters section from the JMX Monitor Settings in the next
version of SiteScope.
Troubleshooting and Limitations
l
If you encounter "UnknownHostException" and the host does not match the one provided in the
JMX URL box when monitoring a JBoss server, it is possible that the RMI codebase server
name is set incorrectly. You should set the following java option in the JBoss configuration (for
instance, using "run.config" in JBoss 5):
-Djava.rmi.server.hostname="<FQDN>"
l
SiteScope versions running on Java 1.6 or later do not support JMX monitoring of WebLogic 9.x
because it runs on Java 1.5. For more details, see "RMI/IIOP SDK Error" in the Oracle
documentation (http://docs.oracle.com/cd/A97688_16/unix.903/relnotes/oc4j.htm).
l
When using the JMX monitor to monitor performance statistics on a JBoss server, the Good
status is displayed in the SiteScope Dashboard even when the JBoss server is unavailable.
SiteScope handles the exceptions differently according to the platform.
n
On Windows platforms, each counter is set to n/a.
n
On Linux and Solaris platforms, the counters are not reset, but the no data value is set, and
No Data Availability
is displayed in the SiteScope Dashboard.
A workaround when monitoring JBoss is to change the monitor's properties in Threshold
Settings, by setting If unavailable to Set monitor status to error.
HP SiteScope (11.23)
Page 344 of 926
Chapter 44: LDAP Monitor
This monitor enables you to verify that a Lightweight Directory Access Protocol (LDAP) server is
working correctly by connecting to it and performing a simple authentication. Optionally, it can
check the result for expected content.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the LDAP monitor.
Learn About
This section includes:
l
"LDAP Monitor" above
l
"Supported Platforms/Versions" below
l
"Status" below
LDAP Monitor Overview
If your LDAP server is not working properly, the user is not able to access and update information in
the directory. Most importantly, the user is not able to perform any authentication using the LDAP
server. Use the LDAP monitor to monitor the availability and proper functioning of your LDAP
server. Another reason to monitor the LDAP server is so that you can find performance bottlenecks.
If your end user and LDAP times are both increasing at about the same amount, the LDAP server is
probably the bottleneck.
The most important thing to monitor is the authentication of a specific user on the LDAP server. If
more than one LDAP server is used, monitor each of the servers. You may also want to monitor
round trip time of the authentication process.
LDAP traffic is transmitted unsecured by default. You can make LDAP traffic confidential and
secure by using Secure Sockets Layer (SSL) and installing a properly formatted certificate.
Supported Platforms/Versions
This monitor supports monitoring remote servers running on Windows operating systems. For the
supported Windows versions, see Operating Systems Supported for Monitoring Remote Windows
Servers.
Status
Each time the LDAP monitor runs, it returns a status based on the time it takes to perform the
connection. An error status or warning status is returned if the current value of the monitor is
anything other than good. Errors occur if SiteScope is unable to connect, receives an unknown host
name error, or the IP address does not match the host name.
HP SiteScope (11.23)
Page 345 of 926
Monitor Reference
Chapter 44: LDAP Monitor
Tasks
How to Configure the LDAP Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The LDAP Authentication Tool is available when configuring this monitor to test an
LDAP server can authenticate a user by performing a simple authentication (provided you are
an administrator in SiteScope, or a user granted Use monitor tools permissions). To use the
tool when configuring or editing a monitor, click the Use Tool button. For details on the tool,
see LDAP Authentication Status Tool in the Using SiteScope Guide.
UI Descriptions
LDAP Monitor Settings
User interface elements are described below:
UI
Element
Description
Authentication Settings
LDAP
service
provider
The constant that holds the name of the environment property for specifying
configuration information for the service provider to use. The value of the property
should contain a URL string (for example, ldap://somehost:389). This property
may be specified in the environment, an applet parameter, a system property, or a
resource file. If it is not specified in any of these sources, the default configuration is
determined by the service provider.
Note:
Security
principal
l
By default, LDAP version 2 is used. To use LDAP version 3, type [LDAP-3]
before the URL.
l
To enable LDAP over SSL, type [LDAP-SSL] before the URL.
The constant that holds the name of the environment property for specifying the
identity of the principal for authenticating the caller to the service. The format of the
principal depends on the authentication scheme. If this property is unspecified, the
behavior is determined by the service provider.
Example: uid=testuser,ou=TEST,o=mydomain.com
Note: To prevent binary data appearing in the output of LDAP queries, all binary
attributes should be listed in the LDAP binary attributes field in Preferences >
Infrastructure Preferences > General Settings.
HP SiteScope (11.23)
Page 346 of 926
Monitor Reference
Chapter 44: LDAP Monitor
UI
Element
Description
Security
The constant that holds the name of the environment property for specifying the
credential credentials of the principal for authenticating the caller to the service. The value of
the property depends on the authentication scheme. For example, it could be a
hashed password, clear-text password, key, certificate, and so on. If this property is
unspecified, the behavior is determined by the service provider.
LDAP Settings
Content
match
Text string to check for in the query result. If the text is not contained in the result,
the monitor displays no match on content. The search is case sensitive.
You may also perform a regular expression match by enclosing the string in forward
slashes, with an i after the trailing slash indicating case-insensitive matching.
Example:/href=Doc\d+\.html/ or /href=doc\d+\.html/i
If you want a particular piece of text to be saved and displayed as part of the status,
use parentheses in a Perl regular expression.
Example:/Temperature: (\d+). This would return the temperature as it appears
on the page and this could be used when setting an Error if or Warning if threshold.
Object
query
An object query to look at an LDAP object other than the default user dn object. For
example, enter the mail object to check for an email address associated with the dn
object entered above. You must enter a valid object query in this text box if you are
using a LDAP filter (see the description below).
For more information on LDAP queries, see http://technet.microsoft.com/eses/library/aa996205(EXCHG.65).aspx.
Note: To use LDAP version 3 for a particular monitor, type [LDAP-3] before the
query. If you want to use version 2 and version 3, type [LDAP-ANY].
LDAP
filter
Performs an LDAP search using a filter criteria.
The LDAP filter syntax is a logical expression in prefix notation meaning that logical
operator appears before its arguments. For example, the item sn=Freddie means
that the sn attribute must exist with the attribute value equal to Freddie.
Multiple items can be included in the filter string by enclosing them in parentheses
(such as sn=Freddie) and combined using logical operators such as the & (the
ampersand conjunction operator) to create logical expressions.
Example: The filter syntax (& (sn=Freddie) (mail=*)) requests LDAP entries
that have both a sn attribute of Freddie and a mail attribute.
More information about LDAP filter syntax can be found at
http://www.ietf.org/rfc/rfc2254.txt and also at
http://download.oracle.com/javase/jndi/tutorial/basics/directory/filter.html.
HP SiteScope (11.23)
Page 347 of 926
Monitor Reference
Chapter 44: LDAP Monitor
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Retrieve first entry(s)
• Simple Query
• False Query
• Advanced Query
• Authentication
• Content verification
Tips/Troubleshooting
General Tips/Limitations
The monitor run summary string is limited to 100 characters. If the LDAP response is larger than the
default value, you can increase this limit by adding the property _ldapMaxSummary=<# of
symbols in summary> to the <SiteScope root>\groups\master.config file, and then restart
SiteScope.
HP SiteScope (11.23)
Page 348 of 926
Chapter 45: Link Check Monitor
This monitor checks the internal and external links on a Web page to insure that they can be
reached. SiteScope begins checking links from a URL that you specify, verifies that linked graphics
can be found, and follows HREF links to the referenced URLs. The monitor can be configured to
check all of the links on your site or to check a limited number of hops from the initial URL.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Link Check monitor.
Learn About
Link Check Monitor Overview
Use the Link Check monitor to check the internal and external links on a Web page to insure that
they can be reached. Each time the Link Check monitor runs, it returns a status and writes it in a
link report log file named LinkReport_<group name><number>.log (this should not be confused
with the daily logs). It also writes the total number of link errors, the total number of links, the total
number of graphics, and the average time for retrieving a page.
Monitor the Web site for the availability of key content. This includes checking that image files and
linked HTML files are accessible as referenced within the Web pages. Starting with your home
page, the Link Check monitor branches out and checks every link available on your entire site by
default. If you only want it to check a portion of your site, specify the URL that links into the
targeted area. You can limit the number of linked hops the monitor follows in the Maximum hops
box of the Monitor Settings panel.
You probably only need to run the link monitor once a day to check for external links that have been
moved or no longer work and internal links that have been changed. You can also run it on demand
any time you do a major update of your Web site.
You can use the Link Check Tool to create a report that reports all links and their status. includes
information about the status of the monitor and the links that failed on the monitor run.
Tasks
How to Configure the Link Check Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Link Check Tool is available when configuring this monitor to verify all the internal and
external links on a Web page to ensure that they can be reached, and reports all links and their
status. To use the tool when configuring or editing a monitor (provided you are an administrator
in SiteScope, or a user granted Use monitor tools permissions), click the Use Tool button.
For details on the tool, see Link Check Tool.
HP SiteScope (11.23)
Page 349 of 926
Monitor Reference
Chapter 45: Link Check Monitor
UI Descriptions
Link Check Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
URL
URL that is the starting point for checking links. The link monitor retrieves the
page for this URL and reads the URLs for any links on the page. It continues
until it has checked all of the links on the site. Links to other servers are
checked but it does not continue and check all the links of those other servers.
Example:http://demo.thiscompany.com
Search
external links
The monitor follows all links on each page and not just links that contain the
original base URL.
Warning: Using this option may greatly increase the number of links that are
tested and the amount of time required for the monitor to run. In some cases
this may cause the monitor to run for more than 24 hours without being able to
complete all of the link checks. If you select this option, be sure to limit the total
number of links to test using the Maximum links setting and limit the depth of
the search using the Maximum hops setting.
Default value: Not selected
Pause
Delay, in milliseconds, between each link check. Larger numbers lengthen the
(milliseconds) total time to check links but decrease the load on the server.
Default value: 250 milliseconds
Timeout
(seconds)
Amount of time, in seconds, that the monitor should wait for a page to begin
downloading before timing-out. Once this time period passes, the monitor logs
an error and reports an error status.
Default value: 60 seconds
Maximum
links
Maximum number of links this monitors checks. When the maximum number
of links is reached the monitor stops and reports the results of those links that
were checked. Increase this number if you have a large site and want to check
every link on the site.
Default value: 800
HP SiteScope (11.23)
Page 350 of 926
Monitor Reference
Chapter 45: Link Check Monitor
UI Element
Description
Maximum
hops
Maximum number of internal links that SiteScope should follow from the
starting URL. Limiting the number of links reduces the number of URLs that
SiteScope follows and shortens the time to complete the report. SiteScope
does not follow any links on external pages. Select one of the predefined
choices using the Commonly used values list. To enter your own limit, enter
a numeric value in the Other values box.
Default value: Main page links
Example: If you set the number of hops to 3, SiteScope checks all internal
pages that can be reached within 3 links from the starting URL.
POST data
Form values required for the first page being checked. This is useful if you need
to log on using an HTML form to reach the rest of the site that you are checking.
Enter form values in the format key=value (one on each line).
Authorization Settings
Authorization
user name
User name to access the URL if required.
Authorization
password
Password to access the URL if required.
Proxy Settings
HTTP proxy
Domain name and port of an HTTP Proxy Server if a proxy server is used to
access the URL.
Proxy server
user name
Proxy server user name if the proxy server requires a name to access the URL.
Technical note: your proxy server must support Proxy-Authenticate for these
options to function.
Proxy server
password
Proxy server password if the proxy server requires a name to access the URL.
Technical note: your proxy server must support Proxy-Authenticate for these
options to function.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
.
HP SiteScope (11.23)
Page 351 of 926
Chapter 46: Log File Monitor
The Log File monitor checks for specific entries added to a log file by looking for entries containing a
text phrase or a regular expression.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Log File monitor.
Learn About
This section includes:
l
"Log File Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Customizing Log File Content Matches and Monitor Alerts" below
l
"Support for IPv6 Addresses" on the next page
Log File Monitor Overview
The Log File monitor watches for specific entries added to a log file by looking for entries containing
a text phrase or a regular expression. You can use it to automatically scan log files for error
information. With SiteScope doing this for you at set intervals, you can eliminate the need to scan
the logs manually. In addition, you can be notified of warning conditions that you may have
otherwise been unaware of until something more serious happened.
By default, each time that SiteScope runs this monitor, it starts from the point in the file where it
stopped reading last time it ran. This insures that you are notified only of new entries and speeds
the rate at which the monitor runs. You change this default behavior using the Check from
beginning property. For details, see "Check from beginning" on page 361.
Supported Platforms/Versions
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor also supports monitoring remote servers running on UNIX and HP NonStop
operating systems. For details on enabling the HP NonStop operating system monitoring
environment, see "How to Configure the HP NonStop Resources Monitor" on page 307.
Customizing Log File Content Matches and Monitor Alerts
You can create a Log File monitor that triggers customized alerts for content matches according to
the threshold status of the monitor.
To configure the Log File monitor with custom matches and alerts:
HP SiteScope (11.23)
Page 352 of 926
Monitor Reference
Chapter 46: Log File Monitor
1. In the Log File Monitor Settings, configure the following settings:
n
Run alerts: Select the For each log entry matched option.
n
Content match: Enter the text to look for in the log entries. For example, to find text entries
redflag and disaster in the log file, enter /(redflag|disaster)/.
n
Match value label:. Enter a label name for the matched values found in the target log file.
For example, type matchedValue.
2. In the Threshold Settings, set the error and warning threshold. For example, set Error if
matchedValue == disaster and set Warning if matchedValue == redflag.
3. Configure error, warning, and good alerts for the Log File monitor. The alert that is sent depends
on the threshold that is met for each entry matched. For example, if the error threshold is met,
the error alert is triggered. For details on configuring alerts, see How to Configure an Alert in the
Using SiteScope Guide.
Support for IPv6 Addresses
This monitor supports the IPv6 protocol. If you want your environment to resolve host names to
IPv6, you can select the Prefer IP version 6 addresses option in SiteScope Infrastructure
Settings (Preferences > Infrastructure Preferences > Server Setting). If this option is selected,
whenever a host name is specified for a remote server and the name is resolved to both IPv4 and
IPv6, the IPv6 address is used.
When using IPv6, the following protocols are supported:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
This section includes:
HP SiteScope (11.23)
Page 353 of 926
Monitor Reference
Chapter 46: Log File Monitor
l
"How to Configure the Log File Monitor" below
l
"How to Use the Rules File" below
How to Configure the Log File Monitor
1. Prerequisites
The following configuration requirements must be performed or verified before the Log File
monitor can be used:
n
The log file to be monitored must exist, and be accessible under credentials used for
connecting to the remote server, or under which SiteScope is running (if monitoring a local
file).
n
The remote server should be created with credentials that grant read access on the
monitored file.
n
For reading log files on remote Red Hat Linux machines, the Disable connection caching
check box must be selected in the remote server's Advanced Settings, otherwise the Log
File monitor will not work.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Note:
n
You can schedule your Log File Monitors to run as often as every 15 seconds.
However, depending on the size of the log file, the total number of monitors you have
running, and Check from beginning option selected, the monitor may take 15
seconds or longer to check the file for the desired entries. The default update schedule
of every 10 minutes is a reasonable frequency in most cases.
n
The Regular Expression Tool is available when configuring this monitor. For details
on the tool, see Regular Expression Tool in the Using SiteScope Guide.
How to Use the Rules File
In special cases, it may be necessary to create a custom rules file to specify different alerts for
different log entry matches. When an application log message is read, this file is used to decide
what action to take. An example rules file is located in <SiteScope root
directory>\examples\log_monitor\sample.rules.
To use the sample.rules file:
1. Make a copy of the sample.rules file located in the <SiteScope root
directory>\examples\log_monitor directory, and rename it. There is no required naming
convention.
HP SiteScope (11.23)
Page 354 of 926
Monitor Reference
Chapter 46: Log File Monitor
2. Open the renamed file with an editor of your choice, and edit the file to meet your needs.
Each rule is a line of tab delimited fields in the format:
column<tab>match<tab>continue<tab>action<sp>actionParam1<sp>
actionParam2<sp>...
where:
column is the column number (in ascending order starting from 0) of the log file to read, or ANY,
or RULE to define a rule. Using ANY for the column checks the entire log message.
match is the text to match.
continue determines whether to continue searching the table.
action is the name of the alert action: SNMPTrap, Mailto, Page, Run, DatabaseAlert, Disable,
NTLogEvent, SMS, Sound.
actionParameters are action specific parameters.
Note: Lines starting with "#" are ignored as comments.
Action descriptions:
Action
Parameters
SNMP
The first parameter is the beginning of the SNMP message (use "^" for spaces).
The second parameter is the template file from the templates.snmp directory.
Mailto
The first parameter is the address where the message is sent.
The second parameter is the template file from the templates.mail directory.
Page
The first parameter is added to the beginning of the pager message (use "_" for
spaces).
The second parameter is the template file from the templates.page directory.
HP SiteScope (11.23)
Page 355 of 926
Monitor Reference
Chapter 46: Log File Monitor
Action
Parameters
Run
The first parameter is the machine. If the script is to be run on a local machine,
this parameter should be skipped. For a remote machine, the machine name
should be prefixed with "remote:".
The second parameter is the script file from the scripts directory.
The third parameter is the template file from the templates.script directory.
The fourth parameter is for the parameters.
Use "_" as a separator between each parameter passed to a script.
Use "#" before the property name to pass parameters from a monitor.
You can use any property from the SiteScope Alert Template and Event
Properties Directory. Note that "_" should be replaced with "#" when passed as a
parameter to a script.
Using
counters
Whenever linkCategory is set to a linkError, there is a linkErrorCount that counts
the number of errors found. This is reset only when linkCategory is set to linkOk
(when this occurs, linkOkCount starts counting matches).
3. When you are finished, enter the full path to your rules file.
Examples:
Here are some examples for rules. Note that most of them use SNMP as the action, but you
can define any other action in your rules file.
Sample rule to forward trap if second column of log entry contains ERROR:
2 ERROR n SNMPTrap error^in^column^two LogMessage
Sample rule to forward trap if any part of log entry contains ERROR:
ANY ERROR n SNMPTrap error^in^log LogMessage
Sample rule to forward trap and override default SNMP preferences:
ANY ERROR n SNMPTrap error^in^log LogMessage _snmpHost=206.168.191.19 _
snmpObjectID=.1.3.6.1.4.1.11.2.17.1 _snmpCommunity=public _snmpGeneric=6 _
snmpSpecific=411
HP SiteScope (11.23)
Page 356 of 926
Monitor Reference
Chapter 46: Log File Monitor
Sample rule to send a pager message when first column contains DOWN:
1 DOWN n Page help_help_help
Sample rule to send email when first column contains DOWN:
1 DOWN n Mailto [email protected]
Sample rule to send two alerts when second column contains DEAD:
2 DEAD y SNMPTrap app^is^dead LogMessage
2 DEAD n Mailto [email protected]
Sample default rule to always forward log messages as SNMP traps:
ANY ANY n SNMPTrap default^rule LogMessage
Sample rule to run script when the log file contains ERROR:
ANY Error n Run mailtest.bat
Sample rule that runs a script with default template, and passes as parameters the
value matching the regular expression between the () found in the log file and the log
file name:
ANY /(regularExp)/ y Run LogIt-LF.vbs Default <value>_<#logFile>
Sample matching rules to set link category used by escalation:
ANY LinkDowny SetCategory linkCategory linkError
ANY LinkUp SetCategory linkCategory linkOk
Sample escalation rules for link category:
# first, send trap when problem happens the first time
RULE linkCategory y SNMPTrap first^alert LogMessage linkCategory = linkError and
linkErrorCount = 1
#
HP SiteScope (11.23)
Page 357 of 926
Monitor Reference
Chapter 46: Log File Monitor
# second, after a minute send four traps
RULE linkCategory y SNMPTrap second^alert LogMessage linkCategory = linkError and
linkErrorTimeSinceFirst > 60 and linkErrorAlertCount < 4
#
# third, after five minutes, send five traps, at the rate of no more than one trap per minute
RULE linkCategory y SNMPTrap third^alert LogMessage linkCategory = linkError and
linkErrorTimeSinceFirst > 300 and linkErrorTimeSinceAlert > 60 and linkErrorAlertCount <
5
#
# send trap when problem is fixed
RULE linkCategory y SNMPTrap fourth^alert LogMessage linkCategory = linkOk and
linkOkCount = 1
#
# run script when problem happens the first time
RULE linkCategory y Run mailtest.bat linkCategory = linkError and linkErrorCount = 1
Sample rule to always send a trap:
ANY ANY n SNMPTrap default^rule LogMessage
UI Descriptions
Log File Monitor Settings
User interface elements are described below:
UI Element Description
Main Settings
HP SiteScope (11.23)
Page 358 of 926
Monitor Reference
Chapter 46: Log File Monitor
UI Element Description
Server
Server where the file you want to monitor is located. Select a server from the
server list (only those remote servers that have been configured in SiteScope are
displayed). Alternatively, click the Browse Servers button to select a server from
the local domain, or Add Remote Server to add a new server.
Note: If using NetBIOS to connect to other servers in an Windows domain, use
the UNC format to specify the path to the remote log file.
Note when working in template mode: You can use the template remote server
(if one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in
the local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server (if the monitor does not work for one of
these conditions, the other condition must be fulfilled, since both conditions do not
always work on some machines). For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of
remote you want to add (Windows or UNIX), and enter the configuration details.
For details on the Microsoft Windows Remote Servers user interface, see
New/Edit Microsoft Windows Remote Server Dialog Box in the Using SiteScope
Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX
Remote Server Dialog Box in the Using SiteScope Guide.
Note: For reading log files on remote Red Hat Linux machines, the Disable
connection caching check box must be selected in the remote server's
Advanced Settings, otherwise the Log File monitor will not work.
HP SiteScope (11.23)
Page 359 of 926
Monitor Reference
Chapter 46: Log File Monitor
UI Element Description
Log file
path
Path to the log file you want to monitor.
l
For reading log files on remote Windows servers using the NetBIOS method,
use UNC to specify the path to the remote log file.
Example: \\remoteserver\sharedfolder\filename.log
l
For reading log files on remote Windows servers using the SSH method,
specify the local path of the remote log file on the remote machine.
Example: C:\Windows\System32\filename.log
You must also select the corresponding remote Windows SSH server in the
Servers box. For details on configuring a remote Windows server for SSH, see
How to Configure SiteScope to Monitor a Remote Microsoft Windows Server in
the Using SiteScope Guide.
You can also monitor files local to the server where SiteScope is running.
Example: C:\application\appLogs\access.log
Optionally, you can use special date and time regular expression variables to
match log file names that include date and time information. For example, you can
use a syntax of s/ex$shortYear$$0month$$0day$.log/ to match a current datecoded log file. For details on using regular expressions, refer to SiteScope Date
Variables and Examples for Log File MonitoringPolicies in the Using SiteScope
Guide.
HP SiteScope (11.23)
Page 360 of 926
Monitor Reference
Chapter 46: Log File Monitor
UI Element Description
Run alerts
Method for running alerts for this monitor.
l
For each log entry matched. The monitor triggers alerts according to
thresholds applied to each matching entry found. Since status can change
according to thresholds for each matched entry, each alert action could be
triggered many times within a monitor run.
Example: If you want to send a warning alert on matched text value "power off"
and an error alert if more than one server is turned off, set the following
thresholds:
n
Error if matchCount > 1
n
Warning if value == 'power off'
To send an error alert if only one threshold is matched, set Error if value ==
'power off'.
For details on how to create a Log File monitor that triggers customized alerts
for content matches, see "Customizing Log File Content Matches and Monitor
Alerts" on page 352.
l
Once, after all log entries have been checked. The monitor counts up the
number of matches and then triggers alerts.
Note:
Check
from
beginning
l
The status category is resolved according to the last content that matched the
regular expression. If the last matched content does not meet the threshold
measurement, an alert is not triggered.
l
The For each log entry matched method cannot work if a value greater than 1
is set as the alert setting trigger frequency in Always, after the condition has
occurred at least X times.
File checking option for this monitor instance. This setting controls what
SiteScope looks for and how much of the target file is checked each time that the
monitor is run.
l
Never. Checks newly added records only.
l
First time only. Checks the whole file once, and then newly added records
only.
l
Always. Always checks the whole file.
Default value: Never
HP SiteScope (11.23)
Page 361 of 926
Monitor Reference
Chapter 46: Log File Monitor
UI Element Description
Content
match
Text to look for in the log entries. You can also use a regular expression in this
entry to match text patterns. Unlike the content match function of other SiteScope
monitors, the Log File monitor content match is run repeatedly against the most
recent content of the target log file until all matches are found. This means the
monitor not only reports if the match was found but also how many times the
matched pattern was found. To match text that includes more than one line of text,
add an /s search modifier to the end of the regular expression. The /c search
modifier is not supported when Server-side processing is enabled. For details, see
Regular Expressions Overview in the Using SiteScope Guide.
Note: When you create a report by clicking the monitor title, the report includes up
to 10 values.
Open Tool
Opens the Regular Expression Tool, enabling you to test a regular expression for
content matching against a sample of the content you want to monitor. For details,
see Regular Expression Tool in the Using SiteScope Guide.
Advanced Settings
Log file
encoding
If the log file content to be monitored uses an encoding that is different than the
encoding used on the server where SiteScope is running, select the code page or
encoding to use. This may be necessary if the code page which SiteScope is
using does not support the character sets used in the target log file. This enables
SiteScope to match and display the encoded log file content correctly.
Default value: windows-1252
Rules file
path
Enter the full path to your rules file. In special cases, it may be necessary to create
a custom rules file to specify different alerts for different log entry matches. You
can also set a parameter in the rules file to run script alerts. You can use any of the
properties in the SiteScope Alert Template and Event Properties Directory in the
Using SiteScope Guide.
An example rules file is located in <SiteScope root directory>\examples\log_
monitor\sample.rules. For instructions on how to use the file and example rules,
see "How to Use the Rules File" on page 354, or read the instructions in the file
itself.
HP SiteScope (11.23)
Page 362 of 926
Monitor Reference
Chapter 46: Log File Monitor
UI Element Description
Match
value
labels
Use to enter labels for the matched values found in the target log file. The match
value labels are used as variables to access retained values from the Content
match expression for use with the monitor threshold settings. Separate multiple
labels with a comma (,). The labels are used to represent any retained values from
the Content match regular expression in the parameters available for the status
threshold settings (Error if, Warning if, and Good if). These labels are also
displayed as the text labels in graphs generated for the retained values in
management reports for this monitor.
Note: When you create a report by clicking the monitor title, the report includes up
to 10 match value labels.
Multi-line
match
Runs a regular expression match on multiple lines of text.
Default value: Not selected
HP SiteScope (11.23)
Page 363 of 926
Monitor Reference
Chapter 46: Log File Monitor
UI Element Description
ServerProcesses log file data on the remote server-side. Benefits include low memory
side
usage and low CPU utilization on the SiteScope server, and faster monitor run.
processing Server-side processing does however cause high CPU utilization on the remote
server when processing the file.
Use of this option is only recommended:
l
If SiteScope performance is affected by large amounts of data being appended
to the target log file between monitor runs, and the Log File monitor is
performing badly in regular mode.
l
For a log file that is frequently being written to between monitor runs. This way,
all of the newly appended lines do not have to be copied across the network and
parsed on the SiteScope server (the processing is done on the remote server
and only the required lines would be copied across to SiteScope).
Default value: Not selected
Note:
No error if
file not
found
l
Server-side processing is enabled for remote Linux, Red Hat Enterprise Linux,
and Oracle Solaris servers only. Windows SSH is not supported.
l
To enable server-side processing to work correctly when monitoring on a
Solaris server, open the remote server settings for the monitored host (Remote
Servers > UNIX Remote Servers > Main Settings), and enter a path to the
bash interpreter in the Initialize shell environment field.
l
"Rule files" are not supported in this mode.
l
The /c search modifier is not supported in this mode.
l
The encoding for the remote server must be Unicode, or match the encoding of
the log file (if the remote file is in Unicode charset).
Monitor remains in Good status if the file is not found. The monitor status remains
Good regardless of the monitor threshold configuration.
Default value: Not selected
Timeout Settings
Enable
timeout
If selected, the monitor stops its run after the specified timeout period has been
exceeded.
Default value: Not selected
HP SiteScope (11.23)
Page 364 of 926
Monitor Reference
Chapter 46: Log File Monitor
UI Element Description
After
timeout,
resume
reading
from end
of file
If selected, the monitor resumes reading from the end of the log file during the next
run, instead of from the current location.
Status
after
timeout
The status condition that the monitor goes into if the monitor times out.
Default value: Selected
Note: This setting is only available when Enable timeout is selected.
The status categories include: Error, Warning, Good
Default value: Warning
Note: This setting is only available when Enable timeout is selected.
Timeout
(seconds)
Amount of time, in seconds, that SiteScope should wait before the monitor times
out.
Default value: 60 seconds
Note: This setting is only available when Enable timeout is selected.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Alerts on matching text (for example, error messages)
• Lines
• lines/min
• matches
• matches/min
• value
• value2
• value3
• value4
Tips/Troubleshooting
General Tips/Limitations
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
When monitoring a log file on a FreeBSD remote server, make sure the correct path to the "cat"
HP SiteScope (11.23)
Page 365 of 926
Monitor Reference
Chapter 46: Log File Monitor
command is used in <SiteScope root directory>\templates.os/FreeBSD.config, since the
command was moved in the latest FreeBSD versions.
HP SiteScope (11.23)
Page 366 of 926
Chapter 47: Mail Monitor
The Mail monitor checks to see that the mail server is both accepting and delivering messages.
Use this monitor to verify that all your mail servers, including internal servers where a firewall is
used, are working properly.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Mail monitor.
Learn About
Mail Monitor Overview
The Mail monitor checks that the mail server is accepting requests, and also verifies that a
message can be sent and retrieved. It does this by sending a standard mail message using SMTP
and then retrieving that same message by using a POP user account. Each message that
SiteScope sends includes a unique key that it checks to insure that it does not retrieve the wrong
message and return a false OK reading. Each time the Mail monitor runs, it returns a status and
writes it in the log file. It also writes the total time it takes to send and receive the mail message in
the log file. If SiteScope is unable to complete the entire loop, it generates an error message.
We recommend that you monitor your primary mail server at least every five minutes. The other
mail servers can be monitored less frequently. You may find it useful to set up a special mail
account to receive the test email messages send by SiteScope.
Tasks
How to Configure the Mail Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Mail Round Trip Tool is available when configuring this monitor to verify that the
mail server is accepting requests and that a message can be sent and retrieved (provided you
are an administrator in SiteScope, or a user granted Use monitor tools permissions). To use
the tool when configuring or editing a monitor, click the Use Tool button. For details on the tool,
see Mail Round Trip Tool in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 367 of 926
Monitor Reference
Chapter 47: Mail Monitor
UI Descriptions
Mail Monitor Settings
User interface elements are described below:
UI Element
Description
Action
Action the Mail monitor should take with respect to the mail server:
l
Send and receive. This option enables you to send a test message to an
SMTP server and then to receive it back from the POP3 or IMAP4 server.
This checks that the mail server is up and running.
l
Receive only. This option enables you to check the incoming POP3 or
IMAP4 mail servers for a message that was sent previously. This check is
done by matching the content of the previously sent message.
Note: If this option is selected, the Receive only content match box must
have a value to match against. Also, if this option is selected, use this
monitor for a dedicated mail account that is not being accessed by any other
mail client. If another mail client attempts to retrieve mail messages from
the account that the Mail monitor is monitoring in Receive only mode, the
monitor and the other mail client may lock each other out of the account, and
neither can retrieve the messages.
l
Send only. This option checks that the receiving mail server has accepted
the message.
Sending
email server
(SMTP)
Host name of the SMTP mail server to which the test mail message should be
sent.
Send to
address
Mail address to which the test message should be sent.
Receiving
protocol
Protocol used by the receiving mail server. You use the POP3 option to check
the POP3 mail server for a sent message. You use the IMAP4 option to check
the IMAP mail server for a sent message.
Receiving
email server
Host name of the POP3/IMAP4 mail server that should receive the test
message. This can be the same mail server to which the test message was
sent.
Example: mail.thiscompany.com
Example: mail.thiscompany.com
HP SiteScope (11.23)
Page 368 of 926
Monitor Reference
Chapter 47: Mail Monitor
UI Element
Description
Receiving
email server
user name
POP user account name on the receiving mail server. A test email message is
sent to this account and the Mail monitor logs in to the account and verifies that
the message was received. No other mail in the account is touched; therefore
you can use your own personal mail account or another existing account for
this purpose.
Example: support
Note: If you use a mail reader that automatically retrieves and deletes
messages from the server, there is a chance that the Mail monitor won't see
the mail message and therefore reports an error.
Receiving
email server
password
Password, if necessary, for the receiving mail account.
Receive only
Text string to match against the contents of the incoming message. If the text
content match is not contained in the incoming message, the monitor reports an error. This is
for the receiving only option. The search is case sensitive.
Example: Subject:MySubject
Note:
Attachment
l
HTML tags are part of a text document, so include the HTML tags if they are
part of the text you are searching for (for example, < B> Hello< /B>
World). This works for XML pages as well.
l
You may also perform a regular expression match by enclosing the string in
forward slashes, with an i after the trailing slash indicating case-insensitive
matching. For example, /href=Doc\d+\.html/ or /href=doc\d+\.html/i.
l
If you want a particular piece of text to be saved and displayed as part of the
status, use parentheses in a regular expression. For example,
/Temperature: (\d+)/ would return the temperature as it appears on the
page and this could be used when setting an Error if or Warning if threshold.
Full path of a file to add as an attachment to the email message. Use this
option to check that your email server can accept and forward messages with
attached files. Optionally, you can use a regular expression to insert date and
time variables to create a filename or file path.
Example: s/C:\firstdir\$shortYear$$0month$$0day$/
HP SiteScope (11.23)
Page 369 of 926
Monitor Reference
Chapter 47: Mail Monitor
UI Element
Description
Attachment
encoding
The code page or encoding to use if the attachment file content uses an
encoding that is different than the encoding used on server where SiteScope is
running. This may be necessary if the code page which SiteScope is using
does not support the character sets used in the attachment file.
Default value: windows-1252
Timeout
(seconds)
Amount of time, in seconds, that the Mail monitor should wait for a mail
message to be received before timing-out. Once this time period passes, the
Mail monitor logs an error and reports an error status.
Default value: 300 seconds
POP check
delay
(seconds)
After SiteScope sends the test message, it immediately logs into the mail
account to verify that the message has been received. If the message has not
been received, SiteScope automatically waits 10 seconds before it checks
again. You can adjust this wait time by indicating an alternate number of
seconds to wait in this box.
Default value: 10 seconds
SMTP user
User name required for SMTP authentication if the SMTP server requires
authentication before sending messages.
SMTP
password
Password for the SMTP authentication (if required).
NTLM
NTLM authentication version (1 or 2) if used by the email server.
authentication
Default value: none
SMTP SSL
Enables sending emails securely via SSL SMTP servers. When selected, the
monitor sends all mails via SSL.
Note: SMTP SSL uses port 465 only of the SMTP mail server (the port cannot
be changed).
Default value: Not selected
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Round trip time – email delivery time
• Send time
• Receive time
• Status
• Content match on received email
HP SiteScope (11.23)
Page 370 of 926
Chapter 48: MAPI Monitor
This monitor enables you to monitor the availability of Microsoft Exchange Server. The monitor
checks for email delivery time. This enables you to verify availability of the MAPI server by sending
and receiving a test message in a Microsoft Exchange email account.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the MAPI monitor.
Learn About
This section includes:
l
"MAPI Monitor Overview" below
l
"Supported Platforms/Versions" below
MAPI Monitor Overview
The MAPI monitor checks a Messaging Application Program Interface (MAPI) server to confirm
that email operations can be run. The monitor is designed to test the operation of a Microsoft
Exchange Server 2003/2007, and for Outlook 2007. It verifies that the server is accepting requests,
and also verifies that a message can be sent and retrieved. It does this by sending a standard email
and deleting the mail if the message is successfully sent and received. If the received part of the
monitoring fails (for example, because of a delay in sending the email or due to a short timeout for
receiving the mail) the test mail remains in the mailbox. The error and warning thresholds for the
monitor are set based on the email delivery time. Create a separate MAPI monitor instance for each
Microsoft Exchange server in your environment.
Supported Platforms/Versions
This monitor is supported in SiteScopes that are running on Windows versions only.
Tasks
This section includes:
l
"How to Prepare the System for Using the MAPI Monitor" below
l
"How to Configure the MAPI Monitor" on page 374
How to Prepare the System for Using the MAPI Monitor
Note: The following are definitions that are used in the steps listed below.
l
Local Administrator. An account that has administrative privileges on the local machine.
An account can have this privilege either implicitly by having Domain Admin privileges or
explicitly by adding as a member of the Administrators group on the local machine. Consult
HP SiteScope (11.23)
Page 371 of 926
Monitor Reference
Chapter 48: MAPI Monitor
your system administrator, if necessary, for help with creating accounts.
l
MailBox Owner. This is an "owner" account for which an Exchange mailbox has been set
up. To use the MAPI monitor, this account must be a Local Administrator (see definition
above) on the SiteScope server.
l
SiteScope User. This is the account that is used to run the SiteScope service. This
account must also be a Local Administrator (see definition above).
1.
Create mailbox accounts on each Exchange Server to be monitored
with the MAPI monitor
Exchange mailbox accounts are used by SiteScope to measure the roundtrip time for a
message to originate and arrive in a mailbox account. The MAPI Monitor Settings panel
supports up to two mailboxes per Exchange Server. If only one mailbox is specified in the
MAPI Monitor Settings the same mailbox can be used for the sender and receiver accounts.
Consult your Exchange system administrator for help setting up mailbox accounts for use with
the SiteScope MAPI monitor.
2.
Add each Exchange Mailbox Owner to the Administrators users group
on the SiteScope server
The Mailbox Owner accounts setup in the previous step, which are by definition domain
logons, must be added to the Administrators group on the SiteScope server.
a. Click Start > Settings > Control Panel > Users and Passwords > Advanced tab or
open the Computer Management utility and expand the Local Users and Groups folder in
the left pane and click the Groups folder.
b. Double-click the Administrators group icon to open the Administrators Properties window.
c. Click the Add button to add each Mailbox Owner you expect to use with the MAPI monitor.
Note: Make sure that the domain logon description is of the form domain\logon.
3.
Install Microsoft Outlook or an equivalent MAPI 1.0 Mail Client on the
SiteScope server
The SiteScope server requires a MAPI 1.0 client such as Outlook XP or Outlook 2003 or later.
Consult your system administrator, if necessary, for help installing a compliant MAPI client.
4.
Configure Outlook for the MailBox User
After logging on to the SiteScope server as the MailBox User created in the first step, the
Outlook wizard may start setting up an Outlook profile for the mail box. If an Outlook client is
already installed, you can use that Outlook client and click Tools > E-mail Accounts to
create a profile for the mailbox/logon you intend to use with the MAPI monitor. See your
HP SiteScope (11.23)
Page 372 of 926
Monitor Reference
Chapter 48: MAPI Monitor
Exchange System administrator for help configuring an Outlook client on your SiteScope
server.
Creating an Outlook profile is not necessary, although it may be helpful for the purpose of
troubleshooting. After the wizard prompts you to set up a profile you can cancel to exit the
wizard.
5.
Verify the SiteScope user logon is a member of Administrators group
or a domain administrator account
The SiteScope user account must be a Local Administrator or a member of the domain admins
group. To change the logon account for the SiteScope user:
a. Open the Services control utility on the SiteScope server.
b. Right-click the SiteScope service entry and click Properties. The SiteScope Properties
settings page opens.
c. Click the Log On tab.
d. Verify that the SiteScope user is run as a member of Administrators group or a domain
logon account. To change the logon properties, click the This account radio button and
enter the SiteScope user logon.
e. Restart the SiteScope server after making changes to the SiteScope service logon
account.
6.
Add the SiteScope user account to the "Act as part of the operating
system" Local Security Policy
To add the SiteScope user account to the "Act as part of the operating system" local security
policy.
a. Click Start > Programs > Administrative Tools > Local Security Policy. The Local
Security Policy panel opens.
b. Click the Local Policies folder in the left pane and then click the User Rights
Assignments folder to display the list of policies.
c. Double-click the Act as part of the operating system policy item in the right pane. The
Local Security Policy Setting list opens.
d. If the SiteScope user is not in the list of logons for this security policy setting then it must
be added now. Click the Add button to bring up the Select Users or Groups window.
e. Enter the SiteScope user logon using the domain\logon format if the SiteScope user is a
domain account.
f. After adding the SiteScope service logon, you must reload the security settings. To do this,
HP SiteScope (11.23)
Page 373 of 926
Monitor Reference
Chapter 48: MAPI Monitor
right-click the Security Settings root folder in the left pane and click Reload.
g. Restart the SiteScope service after making changes to security policy.
How to Configure the MAPI Monitor
1. Prerequisites
Before configuring the monitor, make sure the system is prepared for using the MAPI monitor
as described in "How to Prepare the System for Using the MAPI Monitor" on page 371.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
MAPI Monitor Settings
User interface elements are described below:
UI Element
Description
Receiver
server
Host name or address of a Microsoft Exchange Server. The name can be an IP
address or other name that can be resolved by the DNS server. We recommend
that you copy the server name as it appears in the Properties of the email account
you are using with this monitor.
Receiver
mailbox
Name (alias) of the mailbox to be used for this monitor. This is often the email
account name but it may be a different name. We recommend that you copy the
mailbox name as it appears in the E-Mail Account properties for the email account
you are using with this monitor.
Receiver
domain
Domain to which both the owner of the mailbox being used and the Microsoft
Exchange server belong.
Note: The owner of the mailbox to be used by this monitor must also have
administrative account privileges on the machine where SiteScope is running.
SiteScope also needs user account access to the domain where the Microsoft
Exchange server is running.
Receiver
user name
Windows account login name for the user associated with the above email
account.
Receiver
password
Windows account login password for the user name above.
HP SiteScope (11.23)
Page 374 of 926
Monitor Reference
Chapter 48: MAPI Monitor
UI Element
Description
Sender
server
Sender's Microsoft Exchange server name.
Note:
l
The MAPI sender is ignored if an SMTP sender is specified in the Sender box
below.
l
If any of the SMTP sender values are not specified, the receiver values are
used instead.
Sender
mailbox
Alias of the sending mailbox.
Sender
domain
Domain to which both the sending mailbox owner and the sending Microsoft
Exchange server belong.
Sender
user name
Login name for the Windows account of the sending mailbox owner.
Sender
password
Windows account login password for the sender account above.
Transaction Amount of time, in seconds, for the monitor to wait for the message to arrive
timeout
before the monitor should timeout. The monitor reports an error if timeout value is
(seconds)
met before the email message is delivered.
Default value: 25 seconds
SMTP
server
SMTP server through which an outgoing message is sent.
Sender
Email address of the SMTP sender.
Receiver
Email address of the receiver. This must match the Receiver mailbox alias
specified above.
Attachment
Full path of a file to attach to the outgoing SMTP message.
Note: If you set any of the SMTP values (SMTP server, Sender or Receiver)
they override the MAPI sender options.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Round Trip – email delivery time
Note: The round trip time counter is both measured and displayed in the SiteScope
Dashboard in milliseconds; for all other monitors, it is measured in milliseconds and displayed
in seconds.
HP SiteScope (11.23)
Page 375 of 926
Chapter 49: Memcached Statistics Monitor
The Memcached Statistics monitor checks whether a memcached server is responding to a remote
stats request, and stores the values returned in the response to a successful stats request.
Memcached is a high-performance, distributed memory object caching system, intended for use in
speeding up dynamic web applications by alleviating database load. You can create a separate
monitor instance for each Memcached server you are running. You may want to set up multiple
monitors per server if several Memcached services were started on the different ports.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Memcached Statistics monitor.
Learn About
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the TCP protocol.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Memcached Statistics Monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Memcached Statistics Monitor Settings
User interface elements are described below:
UI Element
Description
Host
Name of the Memcached server that you want to monitor.
Port
Port used by the Memcached Statistics server.
Default value: 11211
Timeout
Amount of time, in milliseconds, to wait for the connection to the port, and for
(milliseconds) any sending and receiving to complete.
Once this time period passes, the Memcached Statistics monitor logs an error
and reports an error status.
Default value: 10000 milliseconds
HP SiteScope (11.23)
Page 376 of 926
Monitor Reference
Chapter 49: Memcached Statistics Monitor
UI Element
Description
Counters
Server statistics selected for this monitor. Use the Get Counters button to
select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you want
to monitor.
Note:
l
The counters displayed are those received during the timeout period, and
may not include all the counters available on the server. Specifying a longer
timeout in the Timeout (milliseconds) field may result in receiving more
counters.
l
The total time for receiving the counters may be longer than the timeout
specified, due to additional processing time not part of the request/response
period.
l
The total number of counters that can be monitored is limited to 100.
Note when working in template mode: The maximum number of counters
that you can select is 100. If you import a template monitor from an earlier
version of SiteScope, or perform a copy to template action, the number of
counters is not limited.
You can configure the following counters for this monitor:
Stats (number of connections, bytes
in/out, etc):
• pid
• uptime
• time
• version
• pointer_size
• curr_items
• total_items
• bytes
• curr_connections
• total_connections
• connection_structures
• cmd_get
• cmd_set
• get_hits
• get_misses
• evictions
• bytes_read
• bytes_written
• limit_maxbytes
• threads
stats slabs (Memory statistics):
• active_slabs
• total_malloced
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 377 of 926
Chapter 50: Memory Monitor
This monitor enables you to track how much physical and virtual memory is currently in use on a
server. Running out of memory can cause server applications to fail and excessive paging can have
a drastic effect on performance. Use this page to add a monitor or edit the monitor's properties.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Memory monitor.
Learn About
This section includes:
l
"Memory Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" on the next page
Memory Monitor Overview
Memory is one of the primary factors that can affect your server's performance. Use the Memory
monitor to monitor how much physical and virtual memory (which consists of both physical memory
and swap memory) is currently in use on a server and how much space is free. Use the pages per
second and value of free memory measurements to help detect problems in this area. Each time the
Memory monitor runs, it collects the measurements and displays the status in the SiteScope
Dashboard.
In most environments, the Memory monitor does not put a heavy load on your server. For
monitoring remote UNIX servers, SiteScope needs to open the connection, while getting the data
from the remote server. While the monitor actions generally do not load the either server, managing
a large number of remote connections can results in some performance problems. You can use the
error and warning thresholds to have SiteScope notify you if memory on a remote server starts to
get low.
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH (see SiteScope Monitoring
Using Secure Shell (SSH) in the Using SiteScope Guide).
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
Note: If you are monitoring a Windows remote server using the NetBIOS method, only
HP SiteScope (11.23)
Page 378 of 926
Monitor Reference
Chapter 50: Memory Monitor
virtual memory counters are available.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
Note: Physical memory (free space and used %) can only be monitored on Windows
remote servers using the WMI connection method.
l
Monitoring physical and virtual memory is not supported using the Rlogin connection method on
UNIX remote servers.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Memory Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Performance Counters Tool is available when configuring this monitor to check
performance counters on a specific machine in a Windows network (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions). To use the tool
HP SiteScope (11.23)
Page 379 of 926
Monitor Reference
Chapter 50: Memory Monitor
when configuring or editing a monitor, click the Use Tool button. For details on the tool, see
Performance Counters Tool in the Using SiteScope Guide.
UI Descriptions
Memory Monitor Settings
User interface elements are described below:
UI
Element Description
Server
Server where the memory you want to monitor is running. Select a server from the
server list (only those remote servers that have been configured in SiteScope are
displayed). Alternatively, click the Browse Servers button to select a server from the
local domain, or Add Remote Server to add a new server.
Note: When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of remote
you want to add (Windows or UNIX), and enter the configuration details.
For details on the Microsoft Windows Remote Servers user interface, see New/Edit
Microsoft Windows Remote Server Dialog Box in the Using SiteScope Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX Remote
Server Dialog Box in the Using SiteScope Guide.
Note: For information on configuring setting panels that are common to all monitors, see
HP SiteScope (11.23)
Page 380 of 926
Monitor Reference
Chapter 50: Memory Monitor
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• physical memory used %
• physical memory MB free
• virtual memory used % (previously percent used)
• virtual memory MB free (previously MB free)
• Pages/sec
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Memory monitor.
l
"General Notes/Tips" below
l
"Troubleshooting and Limitations" below
General Notes/Tips
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
To get a detailed list of processes consuming most memory resources, create an Email alert
using the WithDiagnostics template. When the monitor reaches the configured threshold,
memory consumption for each process is sent in the body of the email alert.
Troubleshooting and Limitations
This section describes troubleshooting and limitations for the Memory monitor.
l
"Percentage of Virtual Memory Used Reaches 100%" below
l
"Pages Per Second is Affecting System Performance" on the next page
l
"WMI Returns Incorrect Memory Values" on the next page
Percentage of Virtual Memory Used Reaches 100%
Problem: The number of virtual memory used % reaches 100%, and services that are running may
fail and new ones are unable to start. Virtual memory used % measures the percentage of memory
and paging file space used.
Solution 1: Increase the size of the paging file. This may solve the immediate problem but may
decrease performance by increasing paging. A slow increase in virtual memory used is often
caused by a memory leak in a service. Use the Processes Tool to view the memory used by each
service. For details on using the tool, see Processes Tool in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 381 of 926
Monitor Reference
Chapter 50: Memory Monitor
Solution 2: An interim solution is to use the Service monitor to measure the service size and run a
SiteScope Script Alert to restart the service when it becomes too large. If restarting the service
does not fix the leak, it may be necessary to add a Script Alert to restart the server when memory
usage is too high. For details on using a Script Alert, see Working with Script Alerts in the Using
SiteScope Guide. For details on using the Service monitor, see "Service Monitor" on page 580.
Solution 3: Install an upgraded version of the service without the leak.
Note: When deploying the Memory monitor on a remote UNIX machine, the monitor displays
swap memory usage and not virtual memory usage. To monitor virtual memory usage, deploy
the UNIX Resources monitor. For details, see "UNIX Resources Monitor" on page 650.
Pages Per Second is Affecting System Performance
Problem: The number of pages per second is consistently high (>10 pages/sec) and is affecting
system performance. Pages per second measures the number of virtual memory pages that are
moved between main memory and disk storage.
Solution 1: Add more memory.
Solution 2: Turn off non-critical services that are using memory, or move these services to a
different machine. The SiteScope Service monitor measures the memory usage for each service.
WMI Returns Incorrect Memory Values
WMI returns incorrect values for the memory used % and MB free counters when the WMI
connection method is used on a Windows Server 2008. This is due to an issue with WMI (not
SiteScope).
Monitor running on AIX remote servers does not monitor physical memory usage
Problem: When the Memory monitor is configured to monitor a remote server running on an AIX
operating system, the monitor does not monitor physical memory usage.
Solution: Make sure that the login account used for the remote connection has access to the
svmon command.
HP SiteScope (11.23)
Page 382 of 926
Chapter 51: Microsoft ASP Server Monitor
This monitor enables you to monitor the Active Server Pages (ASP) performance parameters on
Windows systems. The error and warning thresholds for the monitor can be set on one or more ASP
server performance statistics. You can monitor multiple parameters or counters with a single
monitor instance. This enables you to watch server loading for performance, availability, and
capacity planning. Create a separate monitor instance for each ASP Server you are running.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft ASP Server monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
HP SiteScope (11.23)
Page 383 of 926
Monitor Reference
Chapter 51: Microsoft ASP Server Monitor
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Microsoft ASP Server Monitor
1. Prerequisites
The Microsoft ASP Server monitor makes use of performance counters to measure application
server performance. SiteScopes running on Windows platforms need to be running under an
account that has the necessary administrative security privileges to access performance
counter data from remote servers. If the servers you want to monitor are in a different domain,
are governed under a different policy, or require a unique login different than the account
SiteScope is running under, then you must define the connection to these servers under the
Microsoft Windows Remote Servers option in the remote server view. For SiteScopes installed
on UNIX platforms, you only need to define the connection to these servers under the
Microsoft Windows Remote Servers option in the remote server view.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 384 of 926
Monitor Reference
Chapter 51: Microsoft ASP Server Monitor
UI Descriptions
Microsoft ASP Server Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Server where the Microsoft ASP Server you want to monitor is running. Select a
server from the server list (only those Windows remote servers that have been
configured in SiteScope are displayed). Alternatively, click the Browse Servers
button to select a server from the local domain, or Add Remote Server to add a new
server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed in the server list. For details, see Configure the WMI Service for
Remote Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Serverslist because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 385 of 926
Monitor Reference
Chapter 51: Microsoft ASP Server Monitor
UI
Element
Description
Counters Displays the server performance counters selected for this monitor. Use the Get
Counters button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 386 of 926
Monitor Reference
Chapter 51: Microsoft ASP Server Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Active Server Pages – Debugging Requests
• Active Server Pages – Errors During Script
Runtime
• Active Server Pages – Errors From ASP
Preprocessor
• Active Server Pages – Errors From Script
Compilers
• Active Server Pages – Errors/Sec
• Active Server Pages – Request Bytes In Total
• Active Server Pages – Request Bytes Out Total
• Active Server Pages – Request Execution Time
• Active Server Pages – Request Wait Time
• Active Server Pages – Requests Disconnected
• Active Server Pages – Requests Executing
• Active Server Pages – Requests Failed Total
• Active Server Pages – Requests Not Authorized
• Active Server Pages – Requests Not Found
• Active Server Pages – Requests Queued
• Active Server Pages – Requests Rejected
• Active Server Pages – Requests Succeeded
• Active Server Pages – Requests Timed Out
• Active Server Pages – Requests Total
• Active Server Pages – Requests/Sec
• Active Server Pages – Script Engines Cached
• Active Server Pages – Session Duration
• Active Server Pages – Sessions Current
• Active Server Pages – Sessions Timed Out
• Active Server Pages – Sessions Total
• Active Server Pages – Template Cache Hit
Rate
• Active Server Pages – Template Notifications
• Active Server Pages – Templates Cached
• Active Server Pages – Transactions Aborted
• Active Server Pages – Transactions
Committed
• Active Server Pages – Transactions Pending
• Active Server Pages – Transactions Total
• Active Server Pages – Transactions/Sec
Tips/Troubleshooting
General Notes/Limitations
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 387 of 926
Chapter 52: Microsoft Exchange Monitor
This monitor enables you to monitor statistics of Microsoft Exchange Server on Windows platforms
only.
l
This monitor requires the Microsoft Exchange solution template to enable it in the
SiteScope interface. For solution template details, see Microsoft Exchange Solution
Templates. Contact your HP Sales representative for solution template licensing
information.
l
This monitor is available without additional licensing during the free trial period when using a
trial license, and when using SiteScope Freemium.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Exchange Server monitor.
Learn About
This section includes:
l
"Microsoft Exchange Server Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Setup Requirements" on the next page
Microsoft Exchange Server Monitor Overview
Use the Microsoft Exchange monitor to display important statistics about the messaging system
handled by a Microsoft Exchange Server. The statistics are gathered through Exchange
Management Shell, a command-line interface (built on Microsoft Windows PowerShell technology)
that is used for managing and testing Microsoft Exchange servers and objects.
By default, the Microsoft Exchange monitor can run command-lets (cmdlets) to provide health
information about MAPI logons, Mail flow, and Search. You can also retrieve health information for
Outlook Web Access and Web Services by configuring a test mailbox in Exchange Server
2007/2010. For details, see "How to Prepare the System for Using the Microsoft Exchange
Monitor" on page 390.
Create a separate Microsoft Exchange monitor instance for each Microsoft Exchange server in your
environment. The Microsoft Exchange monitor is supported on Windows versions of SiteScope
only.
Supported Platforms/Versions
This monitor supports monitoring Microsoft Exchange Server 2007 with PowerShell v1.0, Microsoft
Exchange Server 2010 with PowerShell v2.0.
HP SiteScope (11.23)
Page 388 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
Setup Requirements
l
To configure Microsoft Exchange monitor, Exchange Management Shell must be installed on
SiteScope server. Windows PowerShell 1.0 or 2.0 must be installed on the computer that runs
the Exchange Management Shell.
l
You must log on to the SiteScope server using a domain account that has the permissions
assigned to the Exchange Server Administrators group. The account must also be a member of
the local Administrators group on that computer. For details, see "How to Prepare the System
for Using the Microsoft Exchange Monitor" on the next page.
l
To deploy the Microsoft Exchange solution template and run all monitors within it, your account
must have permissions to run and receive output from the powershell commands below. For
each comdlet, the account you use must be delegated as follows (according to Microsoft
Exchange Server 2007/2010, Permission Considerations section:
http://technet.microsoft.com/en-us/library/aa996881.aspx):
cmdlet
Description
Test-MAPIConnectivity
To run the Test-MapiConnectivity cmdlet, the account you use
must be delegated the Exchange Server Administrators role and
local Administrators group for the target server.
To run the Test-MapiConnectivity cmdlet on a computer that has
the Mailbox server role installed, you must log on by using a
domain account that has the permissions assigned to the
Exchange Server Administrators group. The account must also
be a member of the local Administrators group on that computer.
Test-ExchangeSearch
To run the Test-ExchangeSearch cmdlet, the account you use
must be delegated the following:
n
Exchange Recipient Administrator role
n
Exchange Server Administrators role and local Administrators
group for the target server
Test-MailFlow
To run the Test-Mailflow cmdlet, the account you use must be
delegated the Exchange Server Administrators role and local
Administrators group for the server where the cmdlet is run.
Test-OWAConnectivity
To run the Test-OwaConnectivity cmdlet to test Outlook Web
Access connectivity for all Exchange 2007/2010 virtual
directories on a Client Access server, the account you use must
be delegated the Exchange Server Administrators role and
membership in the local Administrators group for the target
server.
TestTo run the Test-WebServicesConnectivity cmdlet, the account
WebServicesConnectivity you use must be delegated the Exchange Administrator role and
local Administrators group for the target server.
HP SiteScope (11.23)
Page 389 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
l
To run each cmdlet, the server roles that correspond to the cmdlets you want to run must be
installed on the Microsoft Exchange Server. When monitoring Microsoft Exchange Server 2007
or 2010, the available counters are determined according to the server roles installed. For
example, if the Hub Transport and Mailbox roles are installed, the Test-MailFlow cmdlet
runs. The following table shows the server roles required to run the cmdlets.
Server Role
Cmdlet
Mailbox
n
Test-MAPIConnectivity
n
Test-ExchangeSearch
Hub Transport, Mailbox
Test-MailFlow
Client Access
n
Test-OWAConnectivity
n
Test-WebServicesConnectivity
Tasks
This section includes:
l
"How to Prepare the System for Using the Microsoft Exchange Monitor" below
l
"How to Configure the Microsoft Exchange Monitor" on page 394
How to Prepare the System for Using the Microsoft Exchange Monitor
There are several important configuration requirements that must be performed or verified before the
Microsoft Exchange monitor can be used. This section describes the steps you use to configure
your environment for this monitor. The following are several definitions that are used in the steps
listed below.
Terminology
Description
Exchange
Server
Administrators
An account that has administrative privileges on the Exchange server.
Local
Administrator
An account that has administrative privileges on the local machine. An account
can have this privilege either implicitly by having Domain Admin privileges or
explicitly by adding as a member of the Administrators group on the local
machine. Consult your system administrator, if necessary, for help with
creating accounts.
MailBox
Owner
This is an "owner" account for which an Exchange mailbox has been set up. To
use the Microsoft Exchange monitor, this account must be a Local
Administrator (see definition above) on the SiteScope server.
HP SiteScope (11.23)
Page 390 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
Terminology
Description
SiteScope
User
This is the account that is used to run the SiteScope service. This account must
also be a Local Administrator and delegated the Exchange Server
Administrators role (see definition above).
HP SiteScope (11.23)
Page 391 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
1.
Create mailbox accounts on each Exchange Server to be monitored
with the Microsoft Exchange monitor
Exchange mailbox accounts are used by Microsoft Exchange monitor to measure the
performance counters on the Exchange server. Consult your Exchange system administrator if
you need help setting up mailbox accounts for use with the SiteScope Microsoft Exchange
monitor.
2.
Add each Exchange Mailbox Owner to the Administrators users group
on the SiteScope server
The Mailbox Owner accounts setup in the previous step which are by definition domain logons,
must be added as to the Administrators group on the SiteScope server.
a. Click Start > Settings > Control Panel > Users and Passwords > Advanced tab or
open the Computer Management utility and expand the Local Users and Groups folder in
the left pane and click the Groups folder.
b. Double-click the Administrators group icon to open the Administrators Properties window.
c. Click the Add button to add each Mailbox Owner you expect to use with the Exchange
2007/2010 monitor.
Note: Make sure that the domain logon description is of the form domain\logon.
3.
Verify that the SiteScope user logon is a member of Administrators
group or a domain administrator account and delegated the Exchange
Server Administrators role
For more information about permissions, delegating roles, and the rights that are required for
SiteScope user logon to monitor Microsoft Exchange Server 2007/2010, see "Setup
Requirements" on page 389.
Caution: The SiteScope user account must be a Local Administrator or a member of the
domain admins group and delegated the Exchange Server Administrators role.
To change the logon account for the SiteScope user:
a. Open the Services control utility on the SiteScope server.
a. Right-click the SiteScope service entry and click Properties. The SiteScope Properties
settings page opens.
b. Click the Log On tab.
c. Verify that the SiteScope user is run as a member of Administrators group or a domain
logon account. To change the logon properties, click the This account radio button and
HP SiteScope (11.23)
Page 392 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
enter the SiteScope user logon.
d. Restart the SiteScope server after making changes to the SiteScope service logon
account.
HP SiteScope (11.23)
Page 393 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
How to Configure the Microsoft Exchange Monitor
1.
Prerequisites
n
This monitor requires the Microsoft Exchange solution template to enable it in the SiteScope
interface after the free evaluation period expires, or when not using SiteScope Freemium.
Contact your HP Sales representative for more information.
n
Prepare the system for using the Microsoft Exchange monitor as described in "How to
Prepare the System for Using the Microsoft Exchange Monitor" on page 390.
There are several other key requirements for using this monitor. For details on this topic, see
"Setup Requirements" on page 389.
2.
Enter the PowerShell execute command when using the Microsoft
Exchange monitor on a 64-bit version of Windows 2003, 2008, or XP
To enable use of the Microsoft Exchange monitor on 64-bit version of Windows 2003, Windows
2008, or Windows XP (since a 32-bit application cannot access the system32 folder on a
computer that is running a 64-bit version of Windows Server 2003, 2008, or of Windows XP),
perform the following:
a. Apply the Microsoft hotfix available from http://support.microsoft.com/?scid=kb;enus;942589.
b. In the Power Shell execute command box in Preferences > Infrastructure Preferences
> General Settings, enter the PowerShell execute command. For example:
C:\Windows\Sysnative\WindowsPowerShell\v1.0\powershell.exe
Note: Symlink Sysnative is not available by default on Windows 2003 or Windows
XP.
3.
Configure additional Microsoft Exchange Server counters - optional
You must configure a test mailbox in the Microsoft Exchange Server to retrieve health
information for the Outlook Web Access and Web Services cmdlets.
a. To configure a test mailbox in the Microsoft Exchange Server, run the script NewTestCasConnectivityUser.ps1 in the Exchange Server to create a test mailbox. The
script can be found under <Exchange installation directory>\Scripts.
b. After running the command, define an initial password for this account, and press ENTER to
confirm the process. A new user is created with a name similar to CAS_<16 digits>.
You can run the Get-Mailbox cmdlet to verify that the test mailbox was created. This
cmdlet retrieves a list of mailboxes, which you can use to check for the new test mailbox.
c. Repeat this process for each Exchange Mailbox Server that is to be tested.
HP SiteScope (11.23)
Page 394 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
4.
Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
5.
Schedule the monitor - optional
This monitor computes statistics that do not normally change very rapidly and are not critical to
system availability, so it should be scheduled to run infrequently, or on demand only. We do not
recommend setting monitor run frequency to less than 10 minutes.
UI Descriptions
Microsoft Exchange Server 2007/2010 Monitor Settings
User interface elements are described below:
UI
Element
Description
Exchange Name of the server running Microsoft Exchange Server that you want to monitor.
server
Exchange Domain name and the mailbox of the server running Microsoft Exchange Server that
domain
you want to monitor.
Mailbox
Name (alias) of the mailbox to be used for this monitor. This is often the email
account name but it may be a different name. We recommend that you copy the
mailbox name as it appears in the E-Mail Account properties for the email account
you are using with this monitor.
Exchange Full path to the Microsoft Exchange Server Management Shell console file.
PS
Example:
console
file path
l On Microsoft Exchange 2007: C:\Program Files\Microsoft\Exchange
Server\Bin\ExShell.psc
l
Timeout
(seconds)
On Microsoft Exchange 2010: C:\Program Files\Microsoft\Exchange
Server\V14\Bin\ExShell.psc
Amount of time to wait, in seconds, for getting a response. You can set the timeout
to no less than 1 second and no more than 10 minutes.
Default value: 120 seconds
HP SiteScope (11.23)
Page 395 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
UI
Element
Counters
Description
Displays the server performance counters selected for this monitor. Use the Get
Counters button to select counters.
Each performance counter contains information in the following categories:
Get
Counters
l
Unit\Type. The statistic's units. Some examples of possible types of units
include percent, millisecond, or KB.
l
Component. Components from which the performance counter is collected.
l
Server Role. Indicates the required server role for running the cmdlet.
Opens the Select Counters Form, enabling you to select the counters you want to
monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" below.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• MAPI Connectivity/Result
• MAPI Connectivity/Latency
• Mail Flow/TestMailflowResult
• Mail Flow/MessageLatencyTime• Exchange
Search/ResultFound
• Exchange Search/SearchTime (in Exchange
2007)
• Exchange Search/SearchTimeInSeconds (in
Exchange 2010)
• OWA Connectivity/Result
• OWA Connectivity/Latency
• Web Services Connectivity/CreateItem/Result
• Web Services Connectivity/CreateItem/Latency
HP SiteScope (11.23)
• Web Services
Connectivity/DeleteItem/Result
• Web Services
Connectivity/DeleteItem/Latency
• Web Services
Connectivity/GetFolder/Result
• Web Services
Connectivity/GetFolder/Latency
• Web Services
Connectivity/SyncFolderItems/Result
• Web Services
Connectivity/SyncFolderItems/Latency
Page 396 of 926
Monitor Reference
Chapter 52: Microsoft Exchange Monitor
Tips/Troubleshooting
Unable to Connect to Microsoft Exchange Server 2010 and Receive
Counters
If you are unable to connect to the Microsoft Exchange Server 2010 and receive counters, make
sure you have the correct PowerShell startup parameters.
1. Open PowerShell and type the following to create a default PowerShell profile applicable to all
users and automatically load the Exchange snap-in:
if (!(test-path $profile.AllUsersAllHosts)) {new-item -type file -path
$profile.AllUsersAllHosts –force}
notepad $profile.AllUsersAllHosts
2. Add the following syntax to the $profile.AllUsersAllHosts file:
. $env:ExchangeInstallPath\bin\RemoteExchange.ps1
Connect-ExchangeServer –auto
3. Save your changes and exit PowerShell.
4. Restart the SiteScope service.
5. Go into SiteScopeand define the Microsoft Exchange monitor as described in the UI
Descriptions section above.
HP SiteScope (11.23)
Page 397 of 926
Chapter 53: Microsoft Exchange 2003 Mailbox
Monitor
The Microsoft Exchange 2003 Mailbox monitor enables you to monitor mailbox statistics of
Microsoft Exchange Server 2003. This monitor computes statistics that do not normally change
very rapidly and are not critical to system availability, so it should be scheduled to run infrequently,
or on demand only.
Note:
l
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface. For solution template details, see Microsoft Exchange Solution
Templates in the Using SiteScope Guide. Contact your HP Sales representative for
solution template licensing information.
l
This monitor is available without additional licensing during the free trial period when using a
trial license, and when using SiteScope Freemium.
To access
Select the Templates context. In the template tree, expand the Solution Templates container.
Right-click Microsoft Exchange 2003, and select Deploy Template. Select the SiteScope group
container into which you want to deploy the solution template, and enter the deployment values.
Learn About
Supported Platforms/Versions
l
This monitor is supported in SiteScopes that are running on Windows versions only.
l
This monitor does not work with the 64-bit version of SiteScope, so if you plan to work with this
monitor, it is recommended to install the SiteScope 32-bit version.
Tasks
How to Configure the Microsoft Exchange 2003 Mailbox Monitor
1. Prerequisites
n
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface after the free evaluation period expires, or when not using SiteScope
Freemium. Contact your HP Sales representative for more information.
n
SiteScope must be configured to log on as a user account within the domain when running
as a service, and not as Local System account.
HP SiteScope (11.23)
Page 398 of 926
Monitor Reference
Chapter 53: Microsoft Exchange 2003 Mailbox Monitor
2. Deploy the Microsoft Exchange Solution template
This monitor can only be added by deploying the Microsoft Exchange 2003 solution template.
For information about using templates to deploy monitors, see SiteScope Templates in the
Using SiteScope Guide.
3. Configure the monitor properties
After the monitor has been created, you can edit the monitor configuration in the same way as
other monitors.
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Microsoft Exchange 2003 Mailbox Monitor Settings
User interface elements are described below:
UI
Element
Description
Server
Server running Microsoft Exchange Server 2003 that you want to monitor.
User
name
User name to use when querying the server for mailbox statistics.
The statistics are gathered by using WMI (Windows Management Instrumentation).
The user name entered here must have permissions to read WMI statistics on the
server from WMI namespace root\MicrosoftExchangeV2.
Default value: If this box is left blank, the user that SiteScope is running is used.
Password
Password for the user name entered above, or blank if user name is blank.
N largest
Number (N) of mailboxes to display when reporting the N largest mailboxes.
mailboxes
Default value: 5
Days
since
access
Number of days (N) to use when reporting the number of mailboxes that have not
been accessed in N days.
Reporting
directory
Location for SiteScope to save the results of each execution of this monitor.
Timeout
(seconds)
Number of seconds that the monitor should wait for a response from the server
before timing-out. Once this time period passes, the monitor logs an error and
reports an error status.
Default value: 30
A default location is chosen if this box is left blank.
Default value: 60 seconds
HP SiteScope (11.23)
Page 399 of 926
Monitor Reference
Chapter 53: Microsoft Exchange 2003 Mailbox Monitor
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
Troubleshooting and Limitations
Problem: You encounter one of the following errors when using the Microsoft Exchange 2003
Mailbox monitor (even though the monitor is in Good status):
l
1- Query failed: Cannot send request. Driver is not ready
l
2- Query failed: Request timed out
l
3- Query failed: Could not connect to the server
Solution 1: Enable WMI requests on the Microsoft Exchange 2003 server by setting the Remote
Enable permission in the WMI Control for a namespace. If a user tries to connect to a namespace
they are not allowed access to, they receive an error.
1. On the target server, select Control Panel > Administrative Tools > Computer
Management.
2. Expand Services and Applications.
3. Right-click WMI Control and select Properties.
4. In the Security tab, select the namespace and click Security.
5. Locate the appropriate account and select Remote Enable in the Permissions list.
Solution 2: Enable WMI requests through Windows firewall.
If the target server is running Windows Firewall (also known as Internet Connection Firewall),
enable it to let remote WMI requests through. On the target server, run the following command:
netsh firewall set service RemoteAdmin enable
For more details, see the Microsoft documentation (http://msdn.microsoft.com/enus/library/aa389286.aspx).
HP SiteScope (11.23)
Page 400 of 926
Chapter 54: Microsoft Exchange 5.5 Message
Traffic Monitor
Use the Microsoft Exchange 5.5 Message Traffic monitor to display important statistics about
messages handled by a Microsoft Exchange 5.5 server, such as a count of messages sent that are
larger than a certain size, or sent to a large number of recipients. This monitor computes statistics
that do not normally change very rapidly and are not critical to system availability, so it should be
scheduled to run infrequently, or on demand only.
Note:
l
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface. For solution template details, see Microsoft Exchange Solution
Templates in the Using SiteScope Guide. Contact your HP Sales representative for
solution template licensing information.
l
This monitor is available without additional licensing during the free trial period when using a
trial license, and when using SiteScope Freemium.
To access
Select the Templates context. In the template tree, expand the Solution Templates container.
Right-click Microsoft Exchange 5.5, and select Deploy Template. Select the SiteScope group
container into which you want to deploy the solution template, and enter the deployment values.
Tasks
How to Configure the Microsoft Exchange 5.5 Message Traffic Monitor
1. Prerequisites
n
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface after the free evaluation period expires, or when not using SiteScope
Freemium. Contact your HP Sales representative for more information.
n
The Microsoft Exchange 5.5 Message Traffic monitor requires additional licensing to enable
the monitor type in the SiteScope interface. Contact your HP sales representative for more
information.
2. Deploy the Microsoft Exchange Solution template
This monitor can only be added by deploying the Microsoft Exchange 5.5 solution template. For
information about using templates to deploy monitors, see SiteScope Templates in the Using
SiteScope Guide.
3. Configure the monitor properties
HP SiteScope (11.23)
Page 401 of 926
Monitor Reference
Chapter 54: Microsoft Exchange 5.5 Message Traffic Monitor
After the monitor has been created, you can edit the monitor configuration in the same way as
other monitors.
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Microsoft Exchange 5.5 Message Traffic Monitor Settings
User interface elements are described below:
UI Element
Description
Recipient
limit
Number (N) of recipients to use when computing the number of messages sent
to more than N recipients.
Default value: 10
Query interval
Number of minutes to look back for messages when computing statistics. This
affects how long it takes to run the monitor as a large interval could result in a
large number of messages to be processed.
Default value: 1440 minutes (one day)
Message size
limit
Number (N) of bytes to use when computing the number of messages sent
larger than N bytes.
Default value: 2000
Number of
domains
Number (N) of domains to use for reporting the top N sending domains.
Number of
outgoing
users
Number (N) of users to use for reporting the top N outgoing users.
Log directory
UNC path to the directory where message tracking logs are stored for the
Exchange 5.5 server.
Default value: 5
Default value: 5
Default value: \\<server name>\tracking.log.
Reporting
directory
Location for SiteScope to save the results of each execution of this monitor.
Default value: A default location is chosen if this box is left blank.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 402 of 926
Chapter 55: Microsoft Exchange
2000/2003/2007 Message Traffic Monitor
Use the Microsoft Exchange 2000/2003/2007 Message Traffic monitor to display important
statistics about messages handled by a Microsoft Exchange 2000/2003/2007 server, such as a
count of messages sent that are larger than a certain size, or sent to a large number of recipients.
Note:
l
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface. For solution template details, see Microsoft Exchange Solution
Templates in the Using SiteScope Guide. Contact your HP Sales representative for
solution template licensing information.
l
This monitor is available without additional licensing during the free trial period when using a
trial license, and when using SiteScope Freemium.
To access
Select the Templates context. In the template tree, expand the Solution Templates container.
Right-click the Microsoft Exchange solution template version that you require, and select Deploy
Template. Select the SiteScope group container into which you want to deploy the solution
template, and enter the deployment values.
Learn About
Supported Platforms/Versions
This monitor is supported in SiteScopes that are running on Windows versions only.
Tasks
How to Configure the Microsoft Exchange 2000/2003/2007 Message Traffic
Monitor
1. Prerequisites
n
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface after the free evaluation period expires, or when not using SiteScope
Freemium. Contact your HP Sales representative for more information.
n
SiteScope must be configured to log on as a user account within the domain when running
as a service, and not as Local System account.
2. Deploy the Microsoft Exchange Solution template
HP SiteScope (11.23)
Page 403 of 926
Monitor Reference
Chapter 55: Microsoft Exchange 2000/2003/2007 Message Traffic Monitor
This monitor can only be added by deploying the Microsoft Exchange solution template version
that you require. For information about using templates to deploy monitors, see SiteScope
Templates in the Using SiteScope Guide.
3. Configure the monitor properties
After the monitor has been created, you can edit the monitor configuration in the same way as
other monitors. Since this monitor returns statistics that do not normally change very rapidly
and are not critical to system availability, it should be scheduled to run infrequently, or on
demand only.
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Microsoft Exchange 2000/2003/2007 Message Traffic Monitor Settings
User interface elements are described below:
UI
Element
Description
Recipient
limit
Number (N) of recipients to use when computing the number of messages sent to
more than N recipients.
Default value: 10
Query
interval
Number of minutes to look back for messages when computing statistics. This
affects how long it takes to run the monitor as a large interval could result in a large
number of messages to be processed.
Default value: 1440 minutes (one day)
Message
size limit
Number (N) of bytes to use when computing the number of messages sent larger
than N bytes.
Default value: 2000
Number
of
domains
Number (N) of domains to use for reporting the top N sending domains.
Number
of
outgoing
users
Number (N) of users to use for reporting the top N outgoing users.
Default value: 5
Default value: 5
HP SiteScope (11.23)
Page 404 of 926
Monitor Reference
Chapter 55: Microsoft Exchange 2000/2003/2007 Message Traffic Monitor
UI
Element
Log
directory
Description
UNC path of the messaging tracking log file directory.
Default value:
l
For 2000/2003 versions: \\<server name>\<server name>.log
l
For 2007 version: \\<server name>\MessageTracking
Reporting Location for SiteScope to save the results of each execution of this monitor.
directory
Default value: A default location is chosen if this box is left blank.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 405 of 926
Chapter 56: Microsoft Exchange 2003 Public
Folder Monitor
Use the Microsoft Exchange 2003 Public Folder monitor to display important statistics about public
folders handled by a Microsoft Exchange 2000/2003 server, such as access times, empty folders,
folder sizes, and folders not accessed within some time period.
Note:
l
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface. For solution template details, see Microsoft Exchange Solution
Templates in the Using SiteScope Guide. Contact your HP Sales representative for
solution template licensing information.
l
This monitor is available without additional licensing during the free trial period when using a
trial license, and when using SiteScope Freemium.
To access
Select the Templates context. In the template tree, expand the Solution Templates container.
Right-click Microsoft Exchange 2003, and select Deploy Template. Select the SiteScope group
container into which you want to deploy the solution template, and enter the deployment values.
Learn About
Supported Platforms/Versions
l
This monitor is supported in SiteScopes that are running on Windows versions only.
l
This monitor does not work with the 64-bit version of SiteScope, so if you plan to work with this
monitor, it is recommended to install the SiteScope 32-bit version.
Tasks
How to Configure the Microsoft Exchange 2003 Public Folder Monitor
1. Prerequisites
n
This monitor requires the Microsoft Exchange solution templates to enable it in the
SiteScope interface after the free evaluation period expires, or when not using SiteScope
Freemium. Contact your HP Sales representative for more information.
n
SiteScope must be configured to log on as a user account within the domain when running
as a service, and not as Local System account.
2. Deploy the Microsoft Exchange Solution template
HP SiteScope (11.23)
Page 406 of 926
Monitor Reference
Chapter 56: Microsoft Exchange 2003 Public Folder Monitor
This monitor can only be added by deploying the Microsoft Exchange 2003 solution template
version that you require. For information about using templates to deploy monitors, see
SiteScope Templates in the Using SiteScope Guide.
3. Configure the monitor properties
After the monitor has been created, you can edit the monitor configuration in the same way as
other monitors. Since this monitor returns statistics that do not normally change very rapidly
and are not critical to system availability, it should be scheduled to run infrequently, or on
demand only.
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Microsoft Exchange 2003 Public Folder Monitor Settings
User interface elements are described below:
UI
Element
Description
Server
Name of the server running Microsoft Exchange Server 2003 that you want to
monitor.
User
name
User name to use when querying the server for mailbox statistics.
The statistics are gathered by using WMI (Windows Management Instrumentation),
so the user name entered here must have permissions to read WMI statistics on the
server from WMI namespace root\MicrosoftExchangeV2.
Default value: If this box is left blank, the user that SiteScope is running as is
used.
Password
Password for the user name entered above, or blank if user name is blank.
Days
since
access
Number of days (N) to use when reporting the number of public folders that have not
been accessed in N days.
Timeout
(seconds)
Number of seconds that the monitor should wait for a response from the server
before timing-out. Once this time period passes, the monitor logs an error and
reports an error status.
Default value: 7
Default value: 60
Reporting Location for SiteScope to save the results of each execution of this monitor.
directory
Default value: A default location is chosen if this box is left blank.
HP SiteScope (11.23)
Page 407 of 926
Monitor Reference
Chapter 56: Microsoft Exchange 2003 Public Folder Monitor
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 408 of 926
Chapter 57: Microsoft Hyper-V Monitor
This monitor enables you to monitor performance statistics of the Microsoft Hyper-V infrastructure
for various server applications.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Hyper-V monitor.
Learn About
This section includes:
l
"Microsoft Hyper-V Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" on the next page
Microsoft Hyper-V Monitor Overview
Use the Microsoft Hyper-V monitor to monitor vital performance metrics in Hyper-V environments.
Microsoft Hyper-V is a server virtualization that runs on Windows 2008 or higher. It is a hypervisorbased virtualization system for x64 Windows operating systems. The Microsoft Hyper-V monitor
enables monitoring of Microsoft Hyper-V hosts and virtual machines.
You can monitor multiple parameters or counters with a single monitor instance. This enables you
to watch server loading for performance, availability, and capacity planning. Create a separate
Microsoft Hyper-V monitor instance for each Hyper-V Server in your environment. The error and
warning thresholds for the monitor can be set on one or more Microsoft Hyper-V Server
performance statistics. The Microsoft Hyper-V monitor makes use of performance objects and
counters to measure application server performance.
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports monitoring remote servers running on:
n
Microsoft Hyper-V Server 2008 R2 (stand-alone product)
n
Microsoft Windows Server 2008 (Hyper-V role enabled)
HP SiteScope (11.23)
Page 409 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
n
l
Microsoft Windows Server 2008 R2 (Hyper-V role enabled)
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Microsoft Hyper-V Monitor
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 410 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
UI Descriptions
Microsoft Hyper-V Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Name of server that you want to monitor. Select a server from the server list (only
those Windows remote servers that have been configured in SiteScope are
displayed). Alternatively, click the Browse Servers button to select a server from
the local domain, or Add Remote Server to add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed in the server list. For details, see Configure the WMI Service for
Remote Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 411 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
UI
Element
Description
Counters The server performance counters selected for this monitor. Use the Get Counters
button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 412 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Hyper-V Hypervisor
• Logical Processors
• Monitored Notifications
• Partitions
• Total Pages
• Virtual Processors
Hyper-V Hypervisor Logical
Processor
• % C1 Time
• % C2 Time
• % C3 Time
• % Guest Run Time
• % Hypervisor Run Time
• % Idle Time
• % Total Run Time
• C1 Transitions/sec
• C2 Transitions/sec
• C3 Transitions/sec
• Context Switches/sec
• Hardware Interrupts/sec
• Inter-Processor Interrupts
Sent/sec
• Inter-Processor Interrupts/sec
• Monitor Transition Cost
• Scheduler Interrupts/sec
• Timer Interrupts/sec
• Total Interrupts/sec
Hyper-V Hypervisor Root
Partition
• 1G GPA pages
• 2M GPA pages
• 4K GPA pages
• Address Spaces
• Deposited Pages
• GPA Pages
• GPA Space Modifications/sec
• Recommended Virtual TLB
Size
• Virtual Processors
• Virtual TLB Flush Entires/sec
• Virtual TLB Pages
HP SiteScope (11.23)
Hyper-V Hypervisor Root
Virtual Processor
• % Guest Run Time
• % Hypervisor Run Time
• % Total Run Time
• APIC EOI Accesses/sec
• APIC IPIs Sent/sec
• APIC MMIO Accesses/sec
• APIC Self IPIs Sent/sec
• APIC TPR Accesses/sec
• Address Domain Flushes/sec
• Address Space Evictions/sec
• Address Space Flushes/sec
• Address Space Switches/sec
• CPUID Instructions Cost
• CPUID Instructions/sec
• Control Register Accesses
Cost
• Control Register Accesses/sec
• Debug Register Accesses Cost
• Debug Register Accesses/sec
• Emulated Instructions Cost
• Emulated Instructions/sec
• External Interrupts Cost
• External Interrupts/sec
• GPA Space Hypercalls/sec
• Global GVA Range
Flushes/sec
• Guest Page Table Maps/sec
• HLT Instructions Cost
• HLT Instructions/sec
• Hypercalls Cost
• Hypercalls/sec
• IO Instructions Cost
• IO Instructions/sec
• IO Intercept Messages/sec
• Large Page TLB Fills/sec
• Local Flushed GVA
Ranges/sec
• Logical Processor
Hypercalls/sec
• Logical Processor
Migrations/sec
• Long Spin Wait Hypercalls/sec
• MSR Accesses Cost
• MSR Accesses/sec
• MWAIT Instructions Cost
• MWAIT Instructions/sec
• Memory Intercept Messages/sec
• Other Hypercalls/sec
• Other Intercepts Cost
• Other Intercepts/sec
• Other Messages/sec
• Page Fault Intercepts Cost
• Page Fault Intercepts/sec
• Page Invalidations Cost
• Page Invalidations/sec
• Page Table Allocations/sec
• Page Table Evictions/sec
• Page Table Reclamations/sec
• Page Table Resets/sec
• Page Table Validations/sec
• Page Table Write Intercepts/sec
• Pending Interrupts Cost
• Pending Interrupts/sec
• Reflected Guest Page Faults/sec
• Small Page TLB Fills/sec
• Synthetic Interrupt
Hypercalls/sec
• Synthetic Interrupts/sec
• Total Intercepts Cost
• Total Intercepts/sec
• Total Messages/sec
• Virtual Interrupt Hypercalls/sec
• Virtual Interrupts/sec
• Virtual MMU Hypercalls/sec
• Virtual Processor Hypercalls/sec
Hyper-V Hypervisor Virtual
Processor
• % Guest Run Time
• % Hypervisor Run Time
• % Total Run Time
• APIC EOI Accesses/sec
• APIC IPIs Sent/sec
• APIC MMIO Accesses/sec
• APIC Self IPIs Sent/sec
• APIC TPR Accesses/sec
• Address Domain Flushes/sec
• Address Space Evictions/sec
• Address Space Flushes/sec
• Address Space Switches/sec
• CPUID Instructions Cost
• CPUID Instructions/sec
Page 413 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
• Control Register Accesses
Cost
• Control Register
Accesses/sec
• Debug Register Accesses
Cost
• Debug Register Accesses/sec
• Emulated Instructions Cost
• Emulated Instructions/sec
• External Interrupts Cost
• External Interrupts/sec
• GPA Space Hypercalls/sec
• Global GVA Range
Flushes/sec
• Guest Page Table Maps/sec
• HLT Instructions Cost
• HLT Instructions/sec
• Hypercalls Cost
• Hypercalls/sec
• IO Instructions Cost
• IO Instructions/sec
• IO Intercept Messages/sec
• Large Page TLB Fills/sec
• Local Flushed GVA
Ranges/sec
• Logical Processor
Hypercalls/sec
• Logical Processor
Migrations/sec
• Long Spin Wait
Hypercalls/sec
• MSR Accesses Cost
• MSR Accesses/sec
• MWAIT Instructions Cost
• MWAIT Instructions/sec
• Memory Intercept
Messages/sec
• Other Hypercalls/sec
• Other Intercepts Cost
• Other Intercepts/sec
• Other Messages/sec
• Page Fault Intercepts Cost
• Page Fault Intercepts/sec
• Page Invalidations Cost
• Page Invalidations/sec
• Page Table Allocations/sec
• Page Table Evictions/sec
• Page Table Reclamations/sec
• Page Table Resets/sec
• Page Table Validations/sec
• Page Table Write
Intercepts/sec
HP SiteScope (11.23)
• Reflected Guest Page
Faults/sec
• Small Page TLB Fills/sec
• Synthetic Interrupt
Hypercalls/sec
• Synthetic Interrupts/sec
• Total Intercepts Cost
• Total Intercepts/sec
• Total Messages/sec
• Virtual Interrupt Hypercalls/sec
• Virtual Interrupts/sec
• Virtual MMU Hypercalls/sec
• Virtual Processor
Hypercalls/sec
Hyper-V Task Manager Detail
• Add Resources Virtual
Machine Tasks Completed
• Add Resources Virtual
Machine Tasks Recent Time
• Add Resources Virtual
Machine Tasks in Progress
• Apply Snapshot Virtual
Machine Tasks Completed
• Apply Snapshot Virtual
Machine Tasks Recent Time
• Apply Snapshot Virtual
Machine Tasks in Progress
• Clone Virtual Machine Tasks
Completed
• Clone Virtual Machine Tasks
Recent Time
• Clone Virtual Machine Tasks in
Progress
• Create VSS Snapshot Set
Tasks Completed
• Create VSS Snapshot Set
Tasks Recent Time
• Create VSS Snapshot Set
Tasks in Progress
• Define Virtual Machine Tasks
Completed
• Define Virtual Machine Tasks
Recent Time
• Define Virtual Machine Tasks
in Progress
• Destroy Snapshot Virtual
Machine Tasks Completed
• Destroy Snapshot Virtual
Machine Tasks Recent Time
• Destroy Snapshot Virtual
Machine Tasks in Progress
• Destroy Virtual Machine Tasks
Completed
• Export Virtual Machine Tasks
Completed
• Export Virtual Machine Tasks
Recent Time
• Export Virtual Machine Tasks in
Progress
• Import Virtual Machine Tasks
Completed
• Import Virtual Machine Tasks
Recent Time
• Import Virtual Machine Tasks in
Progress
• Merge Disk Tasks Completed
• Merge Disk Tasks Recent Time
• Merge Disk Tasks in Progress
• Migrate Virtual Machine Tasks
Completed
• Migrate Virtual Machine Tasks
Recent Time
• Migrate Virtual Machine Tasks in
Progress
• Modify Resources Virtual
Machine Tasks Completed
• Modify Resources Virtual
Machine Tasks Recent Time
• Modify Resources Virtual
Machine Tasks in Progress
• Modify Service Settings Tasks
Completed
• Modify Service Settings Tasks
Recent Time
• Modify Service Settings Tasks in
Progress
• Modify Virtual Machine Tasks
Completed
• Modify Virtual Machine Tasks
Recent Time
• Modify Virtual Machine Tasks in
Progress
• Pause Virtual Machine Tasks
Completed
• Pause Virtual Machine Tasks
Recent Time
• Pause Virtual Machine Tasks in
Progress
• Remove Resources Virtual
Machine Tasks Completed
• Remove Resources Virtual
Machine Tasks Recent Time
• Remove Resources Virtual
Machine Tasks in Progress
• Reset Virtual Machine Tasks
Completed
• Reset Virtual Machine Tasks
Page 414 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
• Pending Interrupts Cost
• Pending Interrupts/sec
HP SiteScope (11.23)
• Destroy Virtual Machine Tasks
Recent Time
• Destroy Virtual Machine Tasks
in Progress
Recent Time
• Reset Virtual Machine Tasks in
Progress
Page 415 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
• Restore Virtual Machine
Tasks Completed
• Restore Virtual Machine
Tasks Recent Time
• Restore Virtual Machine
Tasks in Progress
• Resume Virtual Machine
Tasks Completed
• Resume Virtual Machine
Tasks Recent Time
• Resume Virtual Machine
Tasks in Progress
• Save Virtual Machine Tasks
Completed
• Save Virtual Machine Tasks
Recent Time
• Save Virtual Machine Tasks
in Progress
• Shutdown Virtual Machine
Tasks Completed
• Shutdown Virtual Machine
Tasks Recent Time
• Shutdown Virtual Machine
Tasks in Progress
• Snapshot Virtual Machine
Tasks Completed
• Snapshot Virtual Machine
Tasks Recent Time
• Snapshot Virtual Machine
Tasks in Progress
• Start Virtual Machine Tasks
Completed
• Start Virtual Machine Tasks
Recent Time
• Start Virtual Machine Tasks in
Progress
• Waiting to Start Virtual
Machine Tasks Completed
• Waiting to Start Virtual
Machine Tasks Recent Time
• Waiting to Start Virtual
Machine Tasks in Progress
Hyper-V Virtual Switch
• Broadcast Packets
Received/sec
• Broadcast Packets Sent/sec
• Bytes Received/sec
Hyper-V Virtual Machine Health
• Bytes Sent/sec
Summary
• Bytes/sec
• Health Critical
• Directed Packets Received/sec
• Health Ok
• Directed Packets Sent/sec
• Learned Mac Addresses
Hyper-V Virtual Machine
• Learned Mac Addresses/sec
Summary
• Multicast Packets Received/sec
• Applying Snapshot
• Multicast Packets Sent/sec
• Deleting
• Packets Flooded
• Deleting Saved State
• Packets Flooded/sec
• Deleting Snapshot
• Packets Received/sec
• Exporting
• Packets Sent/sec
• Merging Disks
• Packets/sec
• Paused
• Purged Mac Addresses
• Pausing
• Purged Mac Addresses/sec
• Resetting
• Resuming
Hyper-V Virtual Switch Port
• Running
• Broadcast Packets
• Saved
Received/sec
• Saving
• Broadcast Packets Sent/sec
• Starting
• Bytes Received/sec
• Stopping
• Bytes Sent/sec
• Taking Snapshot
• Bytes/sec
• Turned Off
• Directed Packets Received/sec
• Waiting to Start
• Directed Packets Sent/sec
• Multicast Packets Received/sec
Hyper-V Virtual Network
• Multicast Packets Sent/sec
Adapter
• Packets Received/sec
• Broadcast Packets
• Packets Sent/sec
Received/sec
• Packets/sec
• Broadcast Packets Sent/sec
• Broadcast Packets
• Bytes Received/sec
Received/sec
• Bytes Sent/sec
• Broadcast Packets Sent/sec
• Bytes/sec
• Directed Packets Received/sec • Bytes Received/sec
• Bytes Sent/sec
• Directed Packets Sent/sec
• Bytes/sec
• Multicast Packets
• Directed Packets Received/sec
Received/sec
• Directed Packets Sent/sec
• Multicast Packets Sent/sec
Hyper-V VM Vid Numa Node
• Multicast Packets Received/sec
• Packets Received/sec
• PageCount
• Multicast Packets Sent/sec
• Packets Sent/sec
• ProcessorCount
• Packets Received/sec
• Packets/sec
Hyper-V VM Vid Partition
• Packets Sent/sec
Hyper-V Virtual Storage
• Physical Pages Allocated
• Packets/sec
Device
• Preferred NUMA Node Index
• Broadcast Packets
• Error Count
• Remote Physical Pages
Received/sec
• Flush Count
• Broadcast Packets Sent/sec
Hyper-V Virtual IDE Controller • Read Bytes/sec
• Bytes Received/sec
• Read Bytes/sec
• Read Count
• Bytes Sent/sec
• Read Sectors/sec
• Write Bytes/sec
• Bytes/sec
• Write Bytes/sec
• Write Count
HP SiteScope (11.23)
Hyper-V Virtual Machine Bus
• Interrupts Received
• Interrupts Sent
• Throttle Events
Page 416 of 926
Monitor Reference
Chapter 57: Microsoft Hyper-V Monitor
• Written Sectors/sec
• Directed Packets Received/sec
• Directed Packets Sent/sec
• Multicast Packets Received/sec
• Multicast Packets Sent/sec
• Packets Received/sec
• Packets Sent/sec
• Packets/sec
Tips/Troubleshooting
General Notes/Limitations
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 417 of 926
Chapter 58: Microsoft IIS Server Monitor
Use the Microsoft IIS Server monitor to monitor server performance statistics from IIS servers on
Windows systems. You can monitor multiple parameters or counters with a single monitor
instance. This enables you to watch server loading for performance, availability, and capacity
planning. Create a separate IIS Server monitor instance for each IIS server in your environment.
The error and warning thresholds for the monitor can be set on one or more IIS server performance
counters.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to
create a monitoring solution for various services and aspects of an IIS 6 server. For details,
see Microsoft IIS Solution Templates in the Using SiteScope Guide.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft IIS Server monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" on the next page
l
"Microsoft IIS Server Topology" on the next page
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
The Microsoft IIS Server monitor supports monitoring the following:
n
HTTP/HTTPS services on IIS 4.0, 5.0, 7.0, 7.5, and 8.0.
n
HTTP/HTTPS, FTP, NNTP and MSMQ Queue on IIS 6, 7.0, and 8.0.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 418 of 926
Monitor Reference
Chapter 58: Microsoft IIS Server Monitor
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Microsoft IIS Server Topology
The Microsoft IIS Server monitor can identify the topology of the Microsoft IIS Server being
monitored. The monitor creates the following topology in BSM's RTSM.
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 419 of 926
Monitor Reference
Chapter 58: Microsoft IIS Server Monitor
Tasks
How to Configure the Microsoft IIS Server Monitor
1. Prerequisites
The Microsoft IIS Server monitor makes use of performance counters to measure application
server performance. If the servers you want to monitor require a unique login different than the
account SiteScope is running under, you must define the connection to these servers in the
Microsoft Windows Remote Servers container. Alternatively, you can enter the credentials of a
user with administrative permissions on the server in the Default authentication user name
and Default authentication password boxes in Preferences > General Preferences, and
create the monitor without creating a Microsoft Windows Remote Server.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
3. Enable topology reporting - optional
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "Microsoft IIS Server Topology" on the previous page.
For user interface details, see "BSM Integration Data and Topology Settings" in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 420 of 926
Monitor Reference
Chapter 58: Microsoft IIS Server Monitor
UI Descriptions
Microsoft IIS Server Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Name of the server where the Microsoft IIS performance statistics you want to
monitor is running. Select a server from the server list (only those Windows remote
servers that have been configured in SiteScope are displayed). Alternatively, click
the Browse Servers button to select a server from the local domain, or Add
Remote Server to add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 421 of 926
Monitor Reference
Chapter 58: Microsoft IIS Server Monitor
UI
Element
Description
Counters Displays the server performance counters selected for this monitor. Use the Get
Counters button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 422 of 926
Monitor Reference
Chapter 58: Microsoft IIS Server Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Web Service – Anonymous
Users/sec
• Web Service – Bytes
Received/sec
• Web Service – Bytes Sent/sec
• Web Service – Bytes Total/sec
• Web Service – CGI
Requests/sec
• Web Service – Connection
Attempts/sec
• Web Service – Copy
Requests/sec
• Web Service – Current
Anonymous Users
• Web Service – Current
Blocked Async I/O Requests
• Web Service – Current CAL
count for authenticated
users
• Web Service – Current CAL
count for SSL connections
• Web Service – Current CGI
Requests
• Web Service – Current
Connections
• Web Service – Current ISAPI
Extension Requests
• Web Service – Current
NonAnonymous Users
• Web Service – Delete
Requests/sec
• Web Service – Files
Received/sec
• Web Service – Files Sent/sec
• Web Service – Files/sec
• Web Service – Get
Requests/sec
• Web Service – Head
Requests/sec
• Web Service – ISAPI
Extension Requests/sec
• Web Service – Lock
Requests/sec
• Web Service – Locked
Errors/sec
• Web Service – Logon
Attempts/sec
• Web Service – Maximum
Anonymous Users
• Web Service – Maximum CAL
count for authenticated users
HP SiteScope (11.23)
• Web Service – Maximum CAL count
for SSL connections
• Web Service – Maximum CGI
Requests
• Web Service – Maximum
Connections
• Web Service – Maximum ISAPI
Extension Requests
• Web Service – Maximum
NonAnonymous Users
• Web Service – Measured Async I/O
Bandwidth Usage
• Web Service – Mkcol Requests/sec
• Web Service – Move Requests/sec
• Web Service – NonAnonymous
Users/sec
• Web Service – Not Found Errors/sec
• Web Service – Options Requests/sec
• Web Service – Other Request
Methods/sec
• Web Service – Post Requests/sec
• Web Service – Propfind Requests/
sec
• Web Service – Proppatch
Requests/sec
• Web Service – Put Requests/sec
• Web Service – Search Requests/sec
• Web Service – Service Uptime
• Web Service – Total Allowed Async
I/O Requests
• Web Service – Total Anonymous
Users
• Web Service – Total Blocked Async
I/O Requests
• Web Service – Total CGI Requests
• Web Service – Total Connection
Attempts (all instances)
• Web Service – Total Copy Requests
• Web Service – Total count of failed
CAL requests for authenticated users
• Web Service – Total count of failed
CAL requests for SSL connections
• Web Service – Total Delete
Requests
• Web Service – Total Files Received
• Web Service – Total Files Sent
• Web Service – Total Files Transferred
• Web Service – Total Get Requests
• Web Service – Total
Head Requests
• Web Service – Total
ISAPI Extension Requests
• Web Service – Total Lock
Requests
• Web Service – Total
Locked Errors
• Web Service – Total
Logon Attempts
• Web Service – Total
Method Requests
• Web Service – Total
Method Requests/sec
• Web Service – Total
Mkcol Requests
• Web Service – Total
Move Requests
• Web Service – Total
NonAnonymous Users
• Web Service – Total Not
Found Errors
• Web Service – Total
Options Requests
• Web Service – Total
Other Request Methods
• Web Service – Total Post
Requests
• Web Service – Total
Propfind Requests
• Web Service – Total
Proppatch Requests
• Web Service – Total Put
Requests
• Web Service – Total
Rejected Async I/O
Requests
• Web Service – Total
Search Requests
• Web Service – Total
Trace Requests
• Web Service – Total
Unlock Requests
• Web Service – Trace
Requests/sec
• Web Service – Unlock
Requests/sec
Page 423 of 926
Monitor Reference
Chapter 58: Microsoft IIS Server Monitor
Tips/Troubleshooting
General General Notes/Limitations
l
When configuring this monitor in template mode, some fields that contain drop-down lists may
be displayed as text boxes, and the Browse Servers and Add Remote Server buttons are not
displayed.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
Troubleshooting and Limitations
l
Check if the Microsoft IIS server is available and the services that should be monitored are up
and running.
l
If SiteScope is unable to get counters, run a test on the target remote server. If counters do not
contain the required service (for example, FTP or Web Server), check if the corresponding
service is running on the target machine.
HP SiteScope (11.23)
Page 424 of 926
Chapter 59: Microsoft Lync Server 2010
Monitors
Microsoft Lync Server 2010 monitors enable you to monitor performance, availability, and capacity
planning on Microsoft A/V Conferencing Server, Microsoft Archiving Server, Microsoft Director
Server, Microsoft Edge Server, Microsoft Front End Server, Microsoft Mediation Server, Microsoft
Monitoring and CDR Server, and Microsoft Registrar Server.
You can monitor multiple parameters or counters on a single, remote server with each monitor
instance. Create one or more Microsoft Lync Server 2010 monitor instances for each remote server
in your environment. The error and warning thresholds for the monitor can be set on one or more
performance statistics.
Note:
l
These monitors require the Microsoft Lync Server 2010 solution template to enable them in
the SiteScope interface. For details on the solution template, see Microsoft Lync Server
2010 Solution Templates. Contact your HP Sales representative for solution template
licensing information.
l
These monitors are available without additional licensing during the free trial period when
using a trial license, and when using SiteScope Freemium.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the required Microsoft Lync Server 2010 monitor.
Learn About
This section includes:
l
"Microsoft Lync Server 2010 Monitor Overview" below
l
"Supported Platforms/Versions" on page 427
l
"Support for IPv6 Addresses" on page 428
l
"Server-Centric Report" on page 428
l
"Configuring the Monitor to Run on Windows 2008 R2 as a Non-Administrator User" on page 428
Microsoft Lync Server 2010 Monitor Overview
Use the Microsoft Lync Server 2010 monitors to watch server loading for performance, availability,
and capacity planning on the following:
HP SiteScope (11.23)
Page 425 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
l
Microsoft A/V Conferencing Server. Monitors the server performance statistics of the
Microsoft Lync A/V Conferencing Server. A/V conferencing, enables real-time audio and video
A/V communications between your users (that is, provided they have appropriate client devices
such as headsets for audio conferences, and web cams for video conferences). A/V
Conferencing Server provides A/V conferencing functionality to your deployment. It can be
collocated with Front End Server, or deployed separately as a single server or A/V Conferencing
Server pool.
l
Microsoft Archiving Server. Monitors the server performance statistics of the Microsoft Lync
Archiving Server. The Archiving Server enables you to archive instant messaging (IM)
communications and meeting content for compliance reasons. Corporations and other
organizations are subject to an increasing number of industry and government regulations that
require the retention of specific types of communications. With the Archiving Server feature,
Microsoft Lync Server 2010 communications software provides a way for you to archive IM
content, conferencing (meeting) content, or both that is sent through Lync Server 2010. If you
deploy Archiving Server and associate it with Front End pools, you can set it to archive instant
messages and conferences and specify the users for which archiving is enabled.
l
Microsoft Director Server. Monitors the server performance statistics of the Microsoft Lync
Director Server. A Director is a server running Microsoft Lync Server communications software
that authenticates user requests, but does not home any user accounts or provide presence or
conferencing services. Directors are most useful in deployments that enable external user
access, where the Director can authenticate requests before sending them on to internal
servers. Directors can also improve performance in organizations with multiple Front End pools.
l
Microsoft Edge Server. Monitors the server performance statistics of the Microsoft Lync Edge
Server. The Edge Server enables your users to communicate and collaborate with users outside
the organization's firewalls. These external users can include the organization's own users who
are currently working offsite, users from federated partner organizations, and outside users who
have been invited to join conferences hosted on your Lync Server deployment. Edge Server also
enables connectivity to public IM connectivity services, including Windows Live, AOL, and
Yahoo!.
l
Microsoft Front End Server. Monitors the server performance statistics of the Microsoft Lync
Front End Server. The Front End Server is the core server role, and runs many basic Lync
Server functions. The Front End Server, along with the Back End Servers, which provide the
database, are the only server roles required to be in any Lync Server Enterprise Edition
deployment.
A Front End pool is a set of Front End Servers, configured identically, that work together to
provide services for a common group of users. A pool provides scalability and failover capability
your users.
Front End Server includes the following functionality:
n
User authentication and registration
n
Presence information and contact card exchange
HP SiteScope (11.23)
Page 426 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
n
Address book services and distribution list expansion
n
IM functionality, including multiparty IM conferences
n
Web conferencing and application sharing (if deployed)
n
Application hosting services, for both applications included with Lync Server (for example,
Conferencing Attendant and Response Group application) and third-party applications
n
Application services for application hosting and hosts applications (for example, Response
Group application, and several others)
l
Microsoft Mediation Server. Monitors the server performance statistics of the Microsoft Lync
Mediation Server. The Mediation Server is a necessary component for implementing Enterprise
Voice and dial-in conferencing. The Mediation Server translates signaling and, in some
configurations, media between your internal Lync Server infrastructure and a public switched
telephone network (PSTN) gateway, IP-PBX, or a Session Initiation Protocol (SIP) trunk. On the
Lync Server side, Mediation Server listens on a single mutual TLS (MTLS) transport address. On
the gateway side, Mediation Server listens on a single TCP and single TLS transport address or
a single TLS transport address. All qualified gateways must support TLS, but can enable TCP
as well.
l
Microsoft Monitoring and CDR Server. Monitors the server performance statistics of the
Microsoft Lync Monitoring and CDR Server. The Monitoring Server collects data about the
quality of your network media, in both Enterprise Voice calls and A/V conferences. This
information can help you provide the best possible media experience for your users. It also
collects call error records (CERs), which you can use to troubleshoot failed calls. Additionally, it
collects usage information in the form of call detail records (CDRs) about various Lync Server
features, so that you can calculate return on investment of your deployment, and plan the future
growth of your deployment.
l
Microsoft Registrar Server. Monitors the server performance statistics of the Microsoft Lync
Registrar Server. The Lync Server 2010 Registrar is a new server role that enables client
registration and authentication and provides routing services. It resides along with other
components on a Standard Edition Server, Enterprise Front End Server, Director, or Survivable
Branch Appliance. A Registrar pool consists of Registrar Services running on the Lync Server
pool and residing at the same site.
Supported Platforms/Versions
l
This monitor supports monitoring Microsoft Lync Server 2010 servers.
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 427 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
Support for IPv6 Addresses
These monitors support the IPv6 protocol. If you want your environment to resolve host names to
IPv6, you can select the Prefer IP version 6 addresses option in SiteScope Infrastructure
Settings (Preferences > Infrastructure Preferences > Server Setting). If this option is selected,
whenever a host name is specified for a remote server and the name is resolved to both IPv4 and
IPv6, the IPv6 address is used.
When using IPv6, the following protocols are supported:
l
WMI (from SiteScope installed on Windows platforms only)
l
NetBIOS (from SiteScope installed on Windows platforms only)
Note:
l
When using the Direct registry queries collection method with a NetBIOS connection,
counters are not displayed in the Available Counters table. However, you can still use
monitoring process if you modify the counters using the IPv4 protocol, or copy the counters
from an already configured monitor (copy the monitor), and then change back to the IPv6
address or host.
l
When using the Microsoft Windows PDH Library collection method with a NetBIOS
connection, IPv6 does not work if the name of the monitored server is specified as a literal
IPv6 address.
l
When specifying a literal IPv6 address as the name for the monitored remote server when
using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Server-Centric Report
You can create a Server-Centric Report for the Windows server by clicking the server name in the
Target column of the row corresponding to the Microsoft Lync Server 2010 monitor in the SiteScope
Dashboard. For details, see Creating Server-Centric Reports in the Using SiteScope Guide.
Configuring the Monitor to Run on Windows 2008 R2 as a NonAdministrator User
For the Microsoft Lync Server 2010 monitors to monitor a Windows 2008 R2 machine if the
SiteScope user account is not in the Administrators group, you must either:
HP SiteScope (11.23)
Page 428 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
l
Use the same domain account on both the SiteScope and the remote monitored system, or
l
Use local accounts on both systems, provided that the user accounts have the same name and
password and are always synchronized on both systems. You cannot use Local System or
other similar system predefined accounts that do not enable you to specify a password for them.
In addition, you must configure the user account settings on SiteScope and the remote monitored
machine to log on using the selected non-administrator user account (domain or local account). You
can then use a standard Windows perfmon utility to verify that it works. For details on how to
perform this task, see "How to Configure the Microsoft Lync Server 2010 Monitor" below.
Tasks
How to Configure the Microsoft Lync Server 2010 Monitor
1.
Prerequisites
n
These monitors require the Microsoft Lync Server 2010 solution template to enable them in
the SiteScope interface after the free evaluation period expires, or when not using
SiteScope Freemium. Contact your HP Sales representative for more information.
n
SiteScopes running on Windows platforms need to be running under an account that has the
necessary administrative security privileges to access performance counter data from
remote servers. If the servers you want to monitor are in a different domain, are governed
under a different policy, or require a unique login different than the account SiteScope is
running under, then you must define the connection to these servers under the Microsoft
Windows Remote Servers option in the remote server view.
For SiteScopes installed on UNIX platforms, you only need to define the connection to
these servers under the Microsoft Windows Remote Servers option in the remote server
view.
2.
Configure user account settings on SiteScope
The user account settings on SiteScope must be configured to log on using the selected nonadministrator user account.
a. In the Services control panel, right-click the SiteScope service, and then click Properties.
The SiteScope Properties dialog box opens.
b. Click the Log On tab, and configure the user account to log on using the selected nonadministrator user account (domain or local account).
3.
Configure user account settings on the remote monitored machine
The user account settings on the monitored remote server must be configured to log on using
the selected non-administrator user account.
a. Check that you can access the remote machine. Perform a ping test and check DNS
resolves the server name with its IP address.
HP SiteScope (11.23)
Page 429 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
We recommend that you check that there are no other network-related problems by using
the selected user account to map a network drive of the monitored machine to the drive
used on the SiteScope machine.
b. In the Services control panel, check that the RemoteRegistry service is running and that
the selected user account has access to it. You can use the following command from the
Windows 2003 Resource Kit (run it under an administrator account):
subinacl /service RemoteRegistry /grant=tester=f
This command grants Full Access to the RemoteRegistry service for the local user
tester.
c. Add the domain or local user account to be used into the Performance Monitor Users and
Performance Log Users local user groups. Make sure that these groups have at least
read permissions for the following registry key (and all its subkeys):
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\
CurrentVersion\Perflib]
Note: To check read permissions, select Start > Run, and type Regedt32.exe. In the
Registry Editor, select the registry key, click Security, and select Permissions. In
the Name pane, highlight the user SiteScope uses to access the remote machine, and
make sure that the Allow check box for Read is selected in the Permissions pane.
d. Make sure that the domain or local user account to be used has at least read permissions
on the following objects:
o
Registry key: [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\
SecurePipeServers\winreg]
o
Files in %WINDIR%\System32\perf?XXX.dat, where XXX is the basic language ID
for the system. For example, 009 is the ID for the English version.
Note: If the required Performance Counter Library Values are missing or are
corrupted, follow the instructions in Microsoft knowledge base article KB300956
(http://support.microsoft.com/kb/300956/en-us) to manually rebuild them.
4.
Verify that the non-administrator user account works
After configuring the user account settings, verify that they work.
a. Launch a standard Windows perfmon utility. You can either:
o
Launch it interactively when logged on to the SiteScope machine with the selected user
account by typing perfmon, or
HP SiteScope (11.23)
Page 430 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
o
Launch it when logged on to the SiteScope machine with some other account through
the RunAs command, which enables you to launch commands under different user
account. Enter the following command:
runas /env /netonly /user:tester "mmc.exe perfmon.msc"
Then enter the password (in this example, for the tester account), and the command is
run under the tester user account.
b. After the Performance window opens, right-click in the right graph area and select Add
Counters. The Add Counters dialog box opens.
c. Select Choose counters from computer and enter the remote monitored machine name
or its IP address in the box.
Press the TAB key. If the perfmon utility is able to connect to the remote machine, the
Performance object box is filled in with the performance objects that can be monitored from
the remote machine.
5.
Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Microsoft Lync Server 2010 Monitor Settings
User interface elements are described below:
UI Element
Description
Server
Name of the server where the Microsoft Lync Server 2010 performance
statistics you want to monitor is running. Select a server from the server list
(only those Windows remote servers that have been configured in SiteScope
are displayed). Alternatively, click the Browse Servers button to select a
server from the local domain, or Add Remote Server to add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use
already configured template remote under current template check
box.
Default value: SiteScope Server (the server on which SiteScope is installed)
HP SiteScope (11.23)
Page 431 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
UI Element
Description
Server to get
(Available in template mode only) Name of any SiteScope remote server from
measurements which you want to get counters (it must be accessible in the domain using
from
NETBIOS). Any server that is accessible in the domain can be used. If a
server is not in the domain, you must manually add the server to the remote
server tree before adding counters, and then specify the newly created server
name in the Server field.
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select
the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible
in the local domain.
l
Enter server name. If the server you want to monitor does not appear in
the Serverslist because it has not been identified in the network or has not
been configured in Remote Servers, enter the IP address or name of the
server to monitor.
Note: To monitor a remote Windows server, you must have domain privileges
or authenticated access to the remote server. For details on how to configure a
remote Windows server, see How to Configure SiteScope to Monitor a
Remote Microsoft Windows Server in the Using SiteScope Guide.
Add Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to
enter the configuration details. For user interface details, see New/Edit
Microsoft Windows Remote Server Dialog Box in the Using SiteScope Guide.
Collection
method
Select the collection method option. The Available Counters list is dynamically
updated according to the collection method selected. This enables you to see
the counters when creating or editing the monitor instead of when running the
monitor:
l
Microsoft Windows PDH Library. This is the default and most common
option.
l
Use global setting. Instructs the monitor to use the value configured in
Default collection method for Microsoft Windows Resources monitor
in Preferences > Infrastructure Preferences > General Settings. The
default value for this setting is PDH.
l
Direct registry queries. Use this option if Windows PDH library is not
accessible or if the monitor is having trouble using the Windows PDH
library. You must use this option when monitoring Windows servers
configured using SSH.
Note: The collection method option is available only when the target remote
server uses the NetBIOS protocol (not SSH or WMI).
HP SiteScope (11.23)
Page 432 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
UI Element
Description
Enable Server- Enables collecting data specifically for generating the Server-Centric Report.
Centric Report The report displays various measurements for the server being monitored. For
details, see Creating Server-Centric Reports in the Using SiteScope Guide.
Available
Counters
Displays the available measurements for this monitor. For the list of counters
that can be configured for the Microsoft Lync monitors, see "Monitor Counters"
on the next page.
For each measurement, select the Object, Instances and Counters you want
to check with the monitor, and click the Add Selected Counters
button.
The selected measurements are moved to the Selected Counters list.
Selected
Counters
Displays the measurements currently selected for the Microsoft Lync monitor,
and the total number of selected counters.
To remove measurements selected for monitoring, select the required
measurements, and click the Remove Selected Counters
measurements are moved to the Available Counters list.
button. The
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 433 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
Monitor Counters
Below is the list of counters that can be configured for the Microsoft Lync monitors:
Monitor Type
Counters
Microsoft Archiving Server
Archiving Server - Process Memory statistics monitoring
policy
• Working Set
• Private Bytes
• Page Faults/sec
Archiving Server - Process CPU statistics monitoring
policy
• % Processor Time
• Thread Count
Director Server - Process Memory statistics monitoring
policy
• Working Set
• Private Bytes
• Page Faults/sec
Director Server - Process CPU statistics monitoring policy
• % Processor Time
• Thread Count
Replicator - Process Memory statistics monitoring policy
• Working Set
• Private Bytes
• Page Faults/sec
Replicator Server - Process CPU statistics monitoring
policy
• % Processor Time
• Thread Count
Microsoft A/V Conferencing
Server
A/V Server - Process Memory statistics monitoring policy
• Working Set
• Private Bytes
• Page Faults/sec
A/V Server - Process CPU statistics monitoring policy
• % Processor Time
• Thread Count
HP SiteScope (11.23)
Page 434 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
Monitor Type
Counters
Microsoft Director Server
Director Server - Process Memory statistics monitoring
policy
• Working Set
• Private Bytes
• Page Faults/sec
Director Server - Process CPU statistics monitoring policy
• % Processor Time
• Thread Count
Replicator - Process Memory statistics monitoring policy
• Working Set
• Private Bytes
• Page Faults/sec
Replicator Server - Process CPU statistics monitoring
policy
• % Processor Time
• Thread Count
HP SiteScope (11.23)
Page 435 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
Monitor Type
Counters
Microsoft Edge Server
Audio/Video authentication Service - Process CPU
statistics
• % Processor Time
• Thread Count
Audio/Video authentication Service - Process Memory
statistics
• Working Set
• Private Bytes
• Page Faults/sec
Audio/Video Conferencing Service - Process CPU statistics
• % Processor Time
• Thread Count
Audio/Video Conferencing service (group) – Process
Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
Access Edge service (group) – Process CPU statistics
• % Processor Time
• Thread Count
Access Edge service (group) – Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
WebConferencing edge service (group) – Process CPU
statistics
• % Processor Time
• Thread Count
Web conferencing edge service (group) – Process Memory
statistics
• Working Set
• Private Bytes
• Page Faults/sec
HP SiteScope (11.23)
Page 436 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
Monitor Type
Counters
Microsoft Front End Server
Front End server - Process CPU statistics
• % Processor Time
• Thread Count
Front End server - Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
WebConferencing server - Process CPU statistics
• % Processor Time
• Thread Count
Web conferencing server - Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
IM Conferencing server - Process CPU statistics
• % Processor Time
• Thread Count
IM Conferencing server - Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
Microsoft Mediation Server
Mediation Server - Process CPU statistics
• % Processor Time
• Thread Count
Mediation server - Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
HP SiteScope (11.23)
Page 437 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
Monitor Type
Counters
Microsoft Monitoring Server
CDR - Process CPU statistics
• % Processor Time
• Thread Count
CDR - Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
Monitoring Server - Process CPU statistics
• % Processor Time
• Thread Count
Monitoring Server (group) – Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
Replicator (group) – Process CPU statistics
• % Processor Time
• Thread Count
Replicator (group) – Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
Microsoft Registrar Server
Registrar Server (group) – Process CPU statistics
• % Processor Time
• Thread Count
Registrar server (group) – Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
Replicator Server (group) – Process CPU statistics
• % Processor Time
• Thread Count
Replicator server (group) – Process Memory statistics
• Working Set
• Private Bytes
• Page Faults/sec
HP SiteScope (11.23)
Page 438 of 926
Monitor Reference
Chapter 59: Microsoft Lync Server 2010 Monitors
Tips/Troubleshooting
General Notes/Tips
l
When configuring these monitors in template mode, the Browse Servers and Add Remote
Server buttons are not displayed, and some fields that contain drop-down lists may be displayed
as text boxes.
l
When deploying these monitors using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
Troubleshooting and Limitations
This section describes troubleshooting and limitations for the Microsoft Lync Server 2010 monitors.
l
Getting invalid CPU value error message in <SiteScope root
directory>\logs\RunMonitor.log file when using perfmon monitors on VMware host servers.
Workaround: Use the VMWare Performance monitor to measure CPU on VMWare host
servers.
l
If you encounter "Error: Object Processor not found on host" or "Error: Failed to collect the data"
when running the Microsoft Lync Server 2010 monitors, change the collection method to the
Direct registry queries method option.
HP SiteScope (11.23)
Page 439 of 926
Chapter 60: Microsoft SQL Server Monitor
Use the Microsoft SQL Server monitor to monitor the server performance metrics pages for SQL
Servers on Windows systems. You can monitor multiple parameters or counters with a single
monitor instance. This enables you to watch server loading for performance, availability, and
capacity planning. Create a separate monitor instance for each Microsoft SQL Server you are
running. The error and warning thresholds for the monitor can be set on one or more SQL Server
performance statistics.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to
create a monitoring solution for various aspects of a Microsoft SQL Server 2005, 2008, and
2008 R2. For details, see Microsoft SQL Server Solution Templates in the Using SiteScope
Guide.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft SQL Server monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" on the next page
l
"Microsoft SQL Server Topology" on the next page
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
The Microsoft SQL Server monitor supports monitoring Microsoft SQL Server versions 6.5, 7.1,
2000, 2005, 2008, 2008 R2, and 2012.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers in the Using SiteScope Guide.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 440 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Microsoft SQL Server Topology
The Microsoft SQL Server monitor can identify the topology of the Microsoft SQL Servers being
monitored. The monitor creates the following topology in BSM's RTSM.
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 441 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
Tasks
How to Configure the Microsoft SQL Server Monitor
1. Prerequisites
The Microsoft SQL Server monitor uses performance counters to measure application server
performance. SiteScopes running on Windows platforms need to be running under an account
that has the necessary administrative security privileges to access performance counter data
from remote servers. If the servers you want to monitor are in a different domain, are governed
under a different policy, or require a unique login different than the account SiteScope is running
under, then you must define the connection to these servers under the Microsoft Windows
Remote Servers option in the remote server view. For SiteScopes installed on UNIX platforms,
you only need to define the connection to these servers under the Microsoft Windows Remote
Servers option in the remote server view.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
3. Enable topology reporting - optional
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "Microsoft SQL Server Topology" on the previous page.
For user interface details, see BSM Integration Data and Topology Settings in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 442 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
UI Descriptions
Microsoft SQL Server Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Name of the server where the Microsoft SQL Server you want to monitor is running.
Select a server from the server list (only those Windows remote servers that have
been configured in SiteScope are displayed). Alternatively, click the Browse
Servers button to select a server from the local domain, or Add Remote Server to
add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 443 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
UI
Element
SQL
instance
name
Description
The Microsoft SQL server instance you want to monitor from the list of SQL
instances running on the selected server.
Default value: SQLServer (this value is displayed even if SiteScope is unable to get
the instance list).
Counters Displays the server performance counters you want to check with this monitor. All
non-default instances are dynamically loaded and displayed in the drop-down box.
Use the Get Counters button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" on the next page.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 444 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
SQLServer:Access Methods
• AU cleanup batches/sec
• AU cleanups/sec
• By-reference Lob Create
Count
• By-reference Lob Use Count
• Count Lob Readahead
• Count Pull In Row
• Count Push Off Row
• Deferred dropped AUs
• Deferred Dropped rowsets
• Dropped rowset cleanups/sec
• Dropped rowsets skipped/sec
• Extent Deallocations/sec
• Extents Allocated/sec
• Forwarded Records/sec
• FreeSpace Page Fetches/sec
• FreeSpace Scans/sec
• Full Scans/sec
• Index Searches/sec
• LobHandle Destroy Count
• LobSS Provider Create Count
• LobSS Provider Destroy Count
• LobSS Provider Truncation
Count
• Mixed page allocations/sec
• Page Deallocations/sec
• Page Splits/sec
• Pages Allocated/sec
• Probe Scans/sec
• Range Scans/
• Scan Point Revalidations
• Skipped Ghosted Records/sec
• Table Lock Escalations/sec •
Shrink Data Movement
Bytes/sec
• Transactions/sec
• Used leaf page cookie
• Used tree page cookie
• Workfiles Created/sec
• Worktables Created/sec
• Worktables From Cache Ratio
HP SiteScope (11.23)
SQLServer:Backup
Device
• Device Throughput
Bytes/sec
SQLServer:Buffer
Manager
• AWE lookup maps/sec
• AWE stolen maps/sec
• AWE unmap calls/sec
• AWE unmap pages/sec
• AWE write maps/sec
• Buffer cache hit ratio
• Checkpoint pages/sec
• Database pages
• Free list stalls/sec
• Free pages
• Lazy writes/sec
• Page life expectancy
• Page lookups/sec
• Page reads/sec
• Page writes/sec
• Readahead pages/sec
• Reserved pages
• Stolen pages
• Target pages
• Total pages
SQLServer:Buffer
Partition
• Free list empty/sec – 0
• Free list empty/sec -- 1
• Free list requests/sec -0
• Free list requests/sec -1
• Free pages -- 0
• Free pages – 1
SQLServer:CLR
• CLR Execution
SQLServer:Cursor
Manager by Type
(_Total/API Cursor/TSQL
Global Cursor/TSQL
Local Cursor)
• Active cursors
• Cache Hit Ratio
• Cached Cursor Counts
• Cursor Cache Use Counts/sec
• Cursor memory usage
• Cursor Requests/sec
• Cursor worktable usage
• Number of active cursor plans
SQLServer:Cursor Manager Total
• Async population count
• Cursor conversion rate
• Cursor flushes
SQLServer:Database Mirroring
• Bytes Received/sec
• Bytes Sent/sec
• Log Bytes Received/sec
• Log Bytes Sent/sec
• Log Send Queue KB
• Pages Sent/sec
• Receives/sec
• Redo Bytes/sec
• Redo Queue KB
• Send/Receive Ack Time
• Sends/sec
• Transaction Delay
SQLServer:Databases
(_Total/<per database>)
• Active Transactions
• Backup/Restore Throughput/sec
• Bulk Copy Rows/sec
• Bulk Copy Throughput/sec
• Data File(s) Size (KB)
• DBCC Logical Scan Bytes/sec
• Log Bytes Flushed/sec
• Log Cache Hit Ratio
• Log Cache Reads/sec
Page 445 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
• Log File(s) Size (KB)
• Log File(s) Used Size (KB)
• Log Flush Wait Time
• Log Flush Waits/sec
• Log Flushes/sec
• Log Growths
• Log Shrinks
• Log Truncations
• Percent Log Used
• Repl. Pending Xacts
• Repl. Trans. Rate
• Shrink Data Movement
Bytes/sec
• Transactions/sec
SQLServer:Locks
(_
Total/AllocUnit/
Application/Database/
Extent/File/HoBT/
Key/Metadata/
Object/Page/RID)
• Average Wait Time (ms)
-- _Total
• Average Wait Time (ms)
-- Database
• Average Wait Time (ms)
-- Extent
• Average Wait Time (ms)
-- Key
SQLServer:Exec Statistics
• Average Wait Time (ms)
(Average execution time (ms)
-- Page
/Cumulative execution time
• Average Wait Time (ms)
(ms) per second/Execs in
-- RID
progress/Execs started per
• Average Wait Time (ms)
second)
-- Table
• Distributed Query
• Lock Requests/sec -- _
• DTC calls
Total
• Extended Procedures
• Lock Requests/sec -• OLEDB calls
Database
• Lock Requests/sec -SQLServer:General Statistics
Extent
• Active Temp Tables
• Lock Requests/sec -• Event Notifications Delayed
Key
Drop
• HTTP Authenticated Requests • Lock Requests/sec -Page
• Logical Connections
• Lock Requests/sec -• Logins/sec
RID
• Logouts/sec
• Lock Requests/sec -• Mars Deadlocks
Table
• Non-atomic yield rate
• Lock Timeouts/sec -- _
• Processes blocked
Total
• SOAP Empty Requests
• Lock Timeouts/sec -• SOAP Method Invocations
Database
• SOAP Session Initiate
• Lock Timeouts/sec -Requests
Extent
• SOAP Session Terminate
• Lock Timeouts/sec -Requests
Key
• SOAP SQL Requests
• Lock Timeouts/sec -• SOAP WSDL Requests
Page
• SQL Trace IO Provider Lock
• Lock Timeouts/sec -Waits
RID
• Temp Tables Creation Rate
• Lock Timeouts/sec -• Temp Tables For Destruction
• Trace Event Notification Queue Table
• Lock Wait Time (ms) -- _
• Transactions
Total
• User Connections
• Lock Wait Time (ms) -SQLServer:Latches
Database
• Average Latch Wait Time (ms) • Lock Wait Time (ms) --
HP SiteScope (11.23)
• Lock Wait Time (ms) -- Page
• Lock Wait Time (ms) -- RID
• Lock Wait Time (ms) -- Table
• Lock Waits/sec -- _Total
• Lock Waits/sec -- Database
• Lock Waits/sec -- Extent
• Lock Waits/sec -- Key
• Lock Waits/sec -- Page
• Lock Waits/sec -- RID
• Lock Waits/sec -- Table
• Number of Deadlocks/sec -- _Total
• Number of Deadlocks/sec -Database
• Number of Deadlocks/sec -- Extent
• Number of Deadlocks/sec -- Key
• Number of Deadlocks/sec -- Page
• Number of Deadlocks/sec -- RID
• Number of Deadlocks/sec – Table
SQLServer:Memory Manager
• Connection Memory (KB)
• Granted Workspace Memory (KB)
• Lock Blocks
• Lock Blocks Allocated
• Lock Memory (KB)
• Lock Owner Blocks
• Lock Owner Blocks Allocated
• Maximum Workspace Memory
(KB)
• Memory Grants Outstanding
• Memory Grants Pending
• Optimizer Memory (KB)
• SQL Cache Memory (KB)
• Target Server Memory(KB)
• Total Server Memory (KB)
SQLServer:Plan Cache
(_Total/Bound Trees/Extended
Stored Procedures/Object
Plans/SQL Plans/Temporary
Tables & Table Variables)
• Cache Hit Ratio
• Cache Object Counts
• Cache Objects in use
• Cache Pages
SQLServer:Replication
• Agents Running
Page 446 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
• Latch Waits/sec
• Number of SuperLatches
• SuperLatch Demotions/sec
• SuperLatch Promotions/sec•
Total Latch Wait Time (ms)
Extent
• Lock Wait Time (ms) -Key
• Dist
• Logreader
• Snapshot
SQLServer:SQL Errors (_
Total/DB Offline Errors/Info
Errors/Kill Connection
Errors/User Errors)
• Errors/sec SQLServer:SQL
Statistics
• Auto-Param Attempts/sec
• Batch Requests/sec
• Failed Auto-Params/sec
• Forced Parameterizations/sec•
Safe Auto-Params/sec
• SQL Attention rate
• SQL Compilations/sec
• SQL Re-Compilations/sec
• Unsafe Auto-Params/sec
SQLServer:Transactions
• Free Space in tempdb
(KB)
• Longest Transaction
Running Time
• NonSnapshot Version
Transactions
• Snapshot Transactions
• Transactions
• Update conflict ratio
• Update Snapshot
Transactions
• Version Cleanup rate
(KB/s)
• Version Generation rate
(KB/s)
• Version Store Size (KB)
• Version Store unit count
• Version Store unit
creation
• Version Store unit
truncation
SQLServer:Wait Statistics
(Average wait time (ms)
/Cumulative wait time (ms) per
second/Waits in progress/Waits
started per second)
• Lock waits
• Log buffer waits
• Log write waits
• Memory grant queue waits
• Network IO waits
• Non-Page latch waits
• Page IO latch waits
• Page latch waits
• Thread-safe memory objects waits
• Transaction ownership waits
• Wait for the worker
• Workspace synchronization waits
SQLServer:User
Settable
(User counter 1/User
counter 2/User counter
3/User counter 4/
User counter 5/User
counter 6/User
counter 7/User counter
8/User counter 9/User
counter 10)
• Query
Tips/Troubleshooting
General Notes/Tips
l
When configuring this monitor in template mode, some fields that contain drop-down lists may
be displayed as text boxes, and the Browse Servers and Add Remote Server buttons are not
displayed.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 447 of 926
Monitor Reference
Chapter 60: Microsoft SQL Server Monitor
Troubleshooting and Limitations
Problem: SiteScope is unable to retrieve instances and counters from a Microsoft SQL Server
2008 when using the WMI connection method.
Solution:
1. Configure the monitor to use the NetBIOS connection.
2. If this does not work, you can monitor Microsoft SQL Server 2008 using the Microsoft
Windows Resources monitor.
HP SiteScope (11.23)
Page 448 of 926
Chapter 61: Microsoft Windows Dial-up Monitor
The Microsoft Windows Dial-up monitor uses the Windows Remote Access Service to connect to
an Internet Service Provider or Remote Access server and optionally runs a user-defined set of
monitors. The monitor confirms that the dial-up connection can be established, and measures the
performance of the connection and of the network services using the dial-up connection.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Windows Dial-up monitor.
Learn About
This section includes:
l
"Microsoft Windows Dial-up Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Status" on the next page
l
"Scheduling the Monitor" on the next page
Microsoft Windows Dial-up Monitor Overview
Use the Microsoft Windows Dial-up monitor to measure the availability and performance of your
Internet applications from a dial-up user's perspective. The Microsoft Windows Dial-up monitor can
also be used to monitor the availability and performance of remote access servers.
If you are primarily interested in dial-up availability, then you can just have the Microsoft Windows
Dial-up monitor try to connect, and if successful, run one or two low impact monitors to verify that
the connection is operating properly. If you are more interested in the perspective of a dial-up user,
then running a suite of monitors that represent typical user tasks gives you more complete
assessment.
To set up the Remote Access Service on a Windows machine, go to the Network Control Panel,
and add the service. At that time you also have the option of adding one or more modems as
Remote Access modems. At least one of the modems has to have dial out capability for this
monitor to work.
Supported Platforms/Versions
l
This monitor is supported in SiteScopes that are running on Windows versions only.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
HP SiteScope (11.23)
Page 449 of 926
Monitor Reference
Chapter 61: Microsoft Windows Dial-up Monitor
Status
Each time the Microsoft Windows Dial-up monitor runs, it returns a reading and status message
and writes them in the monitoring log file. The reading is the current value returned by the monitor.
For example, "5 of 5 monitors OK in 55 sec", or "The line was busy". The status is logged as either
OK or warning.
For reports, the Microsoft Windows Dial-up Monitors saves the total time taken (to connect and run
the monitors), the connect time (the time for the modem to establish a physical connection), the
authorization time (the time after physical connection is established before the connection can be
used), and the percentage of the monitors run that were OK.
Scheduling the Monitor
The Microsoft Windows Dial-up monitor stops other monitors from running while it is connected, so
take into account the number and kinds of monitors that are running while the connection is
established as well as the number of other monitors that are running. If SiteScope is running only
Microsoft Windows Dial-up Monitors, then you can schedule them more frequently (every 5 or 10
minutes). However, if you are monitoring many other items, choose a large interval (hours), so that
other monitoring is not disrupted.
Only one Microsoft Windows Dial-up monitor can run at a time, so if you have more than one
Microsoft Windows Dial-up monitor, take that into account when scheduling the monitors.
Tasks
How to Configure the Microsoft Windows Dial-up Monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Microsoft Windows Dial-up Monitor Settings
User interface elements are described below:
UI
Element
Description
Account Settings
Phone
number
Phone number for the dial-up account, adding any extra modem digits or pauses that
are required.
Example:9,4432266 includes a "9," for getting an outside line. Insert a comma
wherever you need a short pause.
Account
user
name
Login name for the dial-up account.
Account
Password for the dial-up account.
password
HP SiteScope (11.23)
Page 450 of 926
Monitor Reference
Chapter 61: Microsoft Windows Dial-up Monitor
UI
Element
Description
Advanced Settings
Timeout
Timeout limits the total time that the Microsoft Windows Dial-up monitor takes to
(seconds) connect, authenticate, and run each of it is monitors. If the time ever exceeds this
time, then the connection is hung up, and the monitor completes with a timeout
error.
Default value: 60 seconds
Monitor Settings
Monitor
(s) to run
Groups, monitors, or both, that you want to run while the dial-up connection is
established.
Monitors that are used by Microsoft Windows Dial-up Monitors should not be
scheduled to run by themselves because some of their data would be through the
dial-up connection, and some of their data would be through the local connection.
Make sure that the Frequency box for these monitors is set to 0. For details, see
Monitor Run Settings in the Using SiteScope Guide.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Notes/Tips
This monitor cannot be copied to a template. It must be created directly in a template.
Troubleshooting and Limitations
This section describes troubleshooting and limitations for the Microsoft Windows Dial-up monitor.
l
The Microsoft Windows Dial-up monitor should not be used on a machine that is used for
accessing resources outside of the local network. This is because the monitor uses Remote
Access, which affects the entire machine's network connectivity when it establishes a
connection. For example, if you are using a Web browser on the machine where SiteScope is
running a Microsoft Windows Dial-up monitor, and the Microsoft Windows Dial-up monitor is
connected, all the requests by the browser out to the Internet also use the dial-up connection.
This affects the speed of the browser and the reading from the Microsoft Windows Dial-up
monitor.
l
The Microsoft Windows Dial-up monitor prevents the other SiteScope monitors (those not being
run by this Dial-up monitor) from running while the dial-up connection is established (they are
held up until the Microsoft Windows Dial-up monitor is completed).
HP SiteScope (11.23)
Page 451 of 926
Monitor Reference
Chapter 61: Microsoft Windows Dial-up Monitor
l
No two Microsoft Windows Dial-up Monitors can be run at the same time.
l
The Microsoft Windows Dial-up monitor uses the dial-up connection only for requests outside of
the local network. If you have monitors that access network resources on the local network,
their readings are the same as if the Microsoft Windows Dial-up monitor was not used.
However, monitors that access network resources outside the local network use the dial-up
connection. For example, if you ran two Ping monitors in the Microsoft Windows Dial-up
monitor, one of which was yourserver.com (on the local network), and the other of which was
externalserver.com (on an external network), the yourserver.com Ping would be very fast,
because it would use the LAN, while the externalserver.com Ping would take longer, because
it would go through the dial-up connection.
HP SiteScope (11.23)
Page 452 of 926
Chapter 62: Microsoft Windows Event Log
Monitor
The Microsoft Windows Event Log monitor enables you to monitor the Microsoft Windows Event
Logs (System, Application, or Security) for added entries.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Windows Event Log monitor.
Learn About
This section includes:
l
"Microsoft Windows Event Log Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Configuring SiteScope Alerts" on the next page
l
"Status" on the next page
l
"IPv6 Addressing Supported Protocols" on the next page
Microsoft Windows Event Log Monitor Overview
Use the Microsoft Windows Event Log monitor to monitor added entries in one of the Microsoft
Windows Event Logs (System, Application, or Security). The Microsoft Windows Event Log
monitor examines log entries made only after the time that the monitor is created. Each time the
monitor runs thereafter, it examines only those entries added since the last time it ran. You can
choose to filter out messages that are not important by using the boxes listed under Monitor
Settings to specify values that must appear in the event entry for the entry to match.
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
HP SiteScope (11.23)
Page 453 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
Configuring SiteScope Alerts
When setting up SiteScope alerts for Microsoft Windows Event Log Monitors that are set to alert
For each event matched, it is most useful to select the NTEventLog template for the E-mail,
Pager, SNMP, or Script alert. This alert template sends the alert with the event entry fields broken
out. The type of SiteScope alert triggered depends on the type of the log event entry:
Event Log Entry Type
SiteScope Alert Type
Error
Error
Warning
Warning
Information
OK
Each time the Microsoft Windows Event Log monitor runs, it returns a reading and status message
and writes them in the <SiteScope root directory>\logs\SiteScopeyyyy_mm_dd.log file.
Status
The status for the Microsoft Windows Event Log monitor includes the number of entries examined,
and the number of entries matched. If an interval is specified, the number of events in that interval is
also displayed. Matched entries and interval entries can trigger alerts.
IPv6 Addressing Supported Protocols
This monitor supports the NetBIOS protocol when Prefer IP version 6 addresses is enabled in
SiteScope (Preferences > Infrastructure Preferences > Server Settings).
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Microsoft Windows Event Log Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Event Log Tool is available when configuring this monitor to display portions of the
Windows Event Log (provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions). To use the tool when configuring or editing a monitor, click the
Use Tool button. For details on the tool, see Event Log Tool in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 454 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
UI Descriptions
Microsoft Windows Event Log Monitor Settings
User interface elements are described below:
UI Element
Description
Server
Name of the server where the event log you want to monitor is running. Select a
server from the server list (only those Windows remote servers that have been
configured in SiteScope are displayed). Alternatively, click the Browse Servers
button to select a server from the local domain, or Add Remote Server to add a
new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When configuring this monitor on SiteScopes running on UNIX versions:
n
Only remote servers that have been configured with an SSH connection
method and SSH using preinstalled SiteScope remote Windows SSH
files is selected are displayed. For details, see How to Configure Remote
Windows Servers for SSH monitoring.
n
If you create a new remote server from the Monitor Settings panel, the SSH
using preinstalled SiteScope remote Windows SSH files setting is
automatically selected and cannot be cleared.
l
When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use
already configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
HP SiteScope (11.23)
Page 455 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
UI Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in
the local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a
remote Windows server, see How to Configure SiteScope to Monitor a Remote
Microsoft Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to
enter the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
Log name
Select the event log to monitor. The list of event logs is automatically generated
from the target server (from the registry for NetBIOS/SSH connections, and from
WMI Classes for WMI connections).
Note: When using a NetBIOS or WMI connection, only the IDs (names) are
displayed for independent libraries. For example, if you install Microsoft Office
Diagnostics, only ODiag is displayed as the log name. To display the whole name,
manually add the log name to the event_log_names.properties file in
<SiteScope root directory>\template.applications.
For example:
l
ODiag=Microsoft Office Diagnostics
l
OSession=Microsoft Office Sessions
l
HardwareEvents=Hardware Events
Note:
Reload
Logs List
l
Only add names to event_log_names.properties that are different from the
IDs, otherwise all names will be the same as IDs.
l
Logs are no longer automatically updated after opening the monitor’s
properties. Instead, click the Reload Logs List button to reload the selected
logs.
Reload the selected logs.
HP SiteScope (11.23)
Page 456 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
UI Element
Description
Event type
The event types to match. Select from the following event types:
Run alerts
l
Any
l
Audit Failure
l
Audit Success
l
Warning
l
Error or warning
l
Information
Method for running alerts:
l
For each event matched. The monitor triggers alerts for every matching entry
found regardless of the defined threshold settings and the monitor status
(good, warning, or error). For useful information, see "Configuring SiteScope
Alerts" on page 454.
l
Once, after all events have been checked. The monitor counts up the
number of matches and triggers alerts based on the warning and error threshold
settings.
HP SiteScope (11.23)
Page 457 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
UI Element
Description
Source and
ID match
The match string identifying the source of the event and the event ID in the form:
<Event Source>:<Event ID>.
Event Source depends on the monitor connection method:
l
If WMI is used, Event Source equals Provider Name.
l
If NetBios is used and the event has no EventSourceName, Event Source
equals Provider Name.
l
If NetBios is used and the event has an EventSourceName, Event Source
equals Event Source Name.
Examples:
l
Print:20 matches event source named Print and event ID of 20.
l
To match against all events from a specific source, enter just the event source
name. For example, W3SVC
l
To match an exact event ID from an event source, specify both. For example,
Service Control Mar:7000
Note: You can click the Open Tool button to use the Regular Expression Test
tool to check your regular expressions. For details, see Regular Expression Tool
in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 458 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
UI Element
Description
Source and
ID do not
match
The string identifying the source of the event and the event ID to NOT MATCH in
the form:
<Event Source>:<Event ID>.
Example: Print:20 means an event source named Print and event ID of 20
must not be in the event to have a match.
To not match all events from a particular source, specify just the source name.
Example: W3SVC
To not match an exact event ID from an event source, specify both.
Example: Service Control Mar:7000
You can also use a regular expression for a more complex NOT MATCH.
Example:
l
to not match all Perflib sources from 200 to 299 use:
/Perflib:2\d\d/
l
to not match all events from the Perflib source, use:
Perflib:*
Note: You can click the Open Tool button to use the Regular Expression Test
tool to check your regular expressions. For details, see Regular Expression Tool
in the Using SiteScope Guide.
Description Text string to match against the description text for the event entry. Thresholds
match
that are defined as value/value 2/value3/value4 refer to the matches found in
the event description.
The description text is the same as the description that is displayed when viewing
the detail of an event log entry in the Windows Event Viewer.
Note: You can click the Open Tool button to use the Regular Expression Test
tool to check your regular expressions. For details, see Regular Expression Tool
in the Using SiteScope Guide.
Description Text string description that must not be in the event to have a match.
does not
The description text can be viewed in the detail view of the event log entry by
match
using the Windows Event Viewer.
Note: You can click the Open Tool button to use the Regular Expression Test
tool to check your regular expressions. For details, see Regular Expression Tool
in the Using SiteScope Guide.
Event
category
Matches the category number of the event entry. Leaving this blank matches
events with any category.
HP SiteScope (11.23)
Page 459 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
UI Element
Description
Event
machine
Matches against the machine that added the entry to the log file. Leaving this
blank matches events with any machine.
Interval
(minutes)
Time period for which matching event log entries are totaled. This is useful when
the case you are interested in is a quantity of events happening in a given time
period.
Example: If you wanted to detect a succession of service failures, 3 in the last 5
minutes, you would specify 5 minutes for the interval, and then change the Error If
threshold to matches in interval >= 3.
Note: This field is not available when For each event matched is selected in the
Run alert field.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Microsoft Windows Event Log
monitor.
l
"General Notes/Tips" below
l
"Monitor fails to get data from Windows remote servers with large amounts of log items when
using a WMI connection" below
l
"Unable to monitor custom event logs on a remote Microsoft Windows Server 2008" below
General Notes/Tips
When configuring this monitor in template mode, some fields that contain drop-down lists may be
displayed as text boxes, and the Browse Servers and Add Remote Server buttons are not
displayed.
Monitor fails to get data from Windows remote servers with large amounts
of log items when using a WMI connection
If the Microsoft Event Log monitor fails to get data from Windows remote servers with large
amounts of log items when using the WMI connection type, change the query hour range of the first
monitor run in the Microsoft Windows Event Log monitor WMI query hour range in first run
box in Preferences > Infrastructure Preferences > Custom Settings. The default query range is
the last 168 hours (7 days).
Unable to monitor custom event logs on a remote Microsoft Windows
Server 2008
To make a custom log file accessible:
HP SiteScope (11.23)
Page 460 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
1. Add the file to the registry.
For example, to monitor a custom event log called TaskScheduler
(C:\Windows\System32\winevt\Logs\Microsoft-Windows-TaskScheduler\Operational.evtx),
you must add a registry key Microsoft-Windows-TaskScheduler/Operational under HKEY_
LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\eventlog.
2. After adding the registry key, you can see the log in the list of available log files:
3. The log is automatically displayed in the Microsoft Windows Event Log Monitor Settings:
4. Configure the events to match in the log, and use SiteScope to monitor this log for events.
HP SiteScope (11.23)
Page 461 of 926
Monitor Reference
Chapter 62: Microsoft Windows Event Log Monitor
Example
Matching an exact event ID (200) in the TaskScheduler log file:
HP SiteScope (11.23)
Page 462 of 926
Chapter 63: Microsoft Windows Media Player
Monitor
The Microsoft Windows Media Player monitor enables you to monitor availability and delivery
quality parameters for media files and streaming data compatible with Windows Media Servers.
You can monitor multiple parameters or counters with a single monitor instance. This enables you
to report on delivery performance. Create a separate monitor instance for files or data streams that
are representative of the content available from the site you want to monitor. The error and warning
thresholds for the monitor can be set on one or more Windows Media Player performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Windows Media Player monitor.
Learn About
Supported Platforms/Versions
l
This monitor is supported in SiteScopes that are running on Windows versions only.
l
This monitor does not work with the 64-bit version of SiteScope, so if you plan to work with this
monitor, it is recommended to install the SiteScope 32-bit version.
l
This monitor supports monitoring Windows Media Player 7.x, 9.x, 10.x, 11.0, and 12.
l
Monitor video streams only with this monitor (not audio streams).
l
This monitor does not support the .asx or .mov formats.
Tasks
How to Configure the Microsoft Windows Media Player Monitor
1. Prerequisites
You must have an instance of Windows Media Player installed on the machine where
SiteScope is running to use this monitor.
For a list of the Media Player performance parameters or counters you can check with the
Microsoft Windows Media Player monitor, see "Monitor Counters" on the next page.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 463 of 926
Monitor Reference
Chapter 63: Microsoft Windows Media Player Monitor
Tip: The Microsoft Windows Media Player Tool is available when configuring this
monitor (provided you are an administrator in SiteScope, or a user granted Use monitor
tools permissions). To use the tool when configuring or editing a monitor, click the Use
Tool button. For details on the tool, see Microsoft Windows Media Player Tool in the
Using SiteScope Guide.
UI Descriptions
Microsoft Windows Media Player Monitor Settings
User interface elements are described below:
UI Element
Description
URL
URL of the media file or streaming source you want to monitor. This should be
the URL of the media file.
Example:mms://<servername>/sample.asf for a unicast stream or
http://<servername>/stationid.nsc for a multicast stream using a
Windows Media Server multicast station program.
Note: This monitor does not support the .asx or .mov formats.
Duration
Playback duration that the monitor should use for the media file or streaming
(milliseconds) source. The duration value does not need to match the duration of the media
contained in the file.
If the media content of the file or source you are monitoring is less than the
duration value selected for the monitor, the monitor plays the entire media
content and reports the results, including the time required to play the media
content.
Default value: 15000 milliseconds
Counters
Media player performance parameters or counters to check with the Microsoft
Windows Media Player monitor.
For details on the available parameters or counters, see "Monitor Counters"
below.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that you can check with the Microsoft Windows Media Player monitor:
HP SiteScope (11.23)
Page 464 of 926
Monitor Reference
Chapter 63: Microsoft Windows Media Player Monitor
Buffering
count
Number of times the Player had to buffer incoming media data due to
insufficient media content.
Buffering time
Time spent waiting for sufficient media data to continue playing the media clip.
Interrupts
Number of interruptions encountered while playing a media clip. This includes
buffering and playback errors.
Packets lost
Number of lost packets not recovered (applicable to network playback).
Packets
recovered
Number of lost packets successfully recovered (applicable to network
playback).
Packet quality
Percentage ratio of packets received to total packets.
Ratio
bandwidth
Ratio (as a percentage) of the actual bandwidth used to the recommended
bandwidth.
Example: If the recommended bandwidth is 100 bps and the actual bandwidth
is 50 bps, the ratio bandwidth is 50%. If the recommended bandwidth is 50
bps and the actual bandwidth is 100 bps, the ratio bandwidth is 200%.
Recommended Recommended bandwidth in bits per second.
bandwidth
When a .wmv file is opened in Media Player, the property bitrate is the
recommended bandwidth. This bandwidth is embedded in the stream itself.
Recommended Total duration of the media clip in seconds. This value is not effected by what
duration
was already played.
Sampling rate
Sampling rate in milliseconds, for collecting statistics.
Stream count
Packet count.
Stream max
Maximum number of packets.
Stream min
Minimum number of packets.
Stream rate
Packet rate indicating the speed at which the clip is played: 1 is the actual
speed, 2 is twice the original speed, and so on.
Time quality
Percentage of stream samples received on time (no delays in reception).
HP SiteScope (11.23)
Page 465 of 926
Chapter 64: Microsoft Windows Media Server
Monitor
Use the Microsoft Windows Media Server monitor to monitor the server performance parameters for
Microsoft Windows Media Servers. You can monitor multiple parameters or counters with a single
monitor instance. This enables you to watch server loading for performance, availability, and
capacity planning.
Create a separate monitor instance for each Windows Media Server you are running. The error and
warning thresholds for the monitor can be set on one or more Windows Media server performance
statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Windows Media Server monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports all supported versions of Microsoft Windows Media Server through
perfmon.
Note: Windows Media Server is supported and maintained by Microsoft up to and including
Windows Server 2008 R2 only.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
HP SiteScope (11.23)
Page 466 of 926
Monitor Reference
Chapter 64: Microsoft Windows Media Server Monitor
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Microsoft Windows Media Server Monitor
1. Prerequisites
The Microsoft Windows Media Server monitor uses performance counters to measure
application server performance. SiteScopes running on Windows platforms need to be running
under an account that has the necessary administrative security privileges to access
performance counter data from remote servers.
If the servers you want to monitor are in a different domain, are governed under a different
policy, or require a unique login different than the account SiteScope is running under, then you
must define the connection to these servers under the Microsoft Windows Remote Servers
option in the remote server view.
For SiteScopes installed on UNIX platforms, you only need to define the connection to these
servers under the Microsoft Windows Remote Servers option in the remote server view.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Note: By default, SiteScope monitors the Microsoft Windows Media Server default
services, Windows Media Station Service and Windows Media Unicast Service. To
monitor other services, add the service names (separated by commas) to the Microsoft
Windows Media Server monitor service names box in Preferences > Infrastructure
Preferences > Monitor Settings.
HP SiteScope (11.23)
Page 467 of 926
Monitor Reference
Chapter 64: Microsoft Windows Media Server Monitor
UI Descriptions
Microsoft Windows Media Server Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Name of the server where the Windows Media Server you want to monitor is running.
Select a server from the server list (only those Windows remote servers that have
been configured in SiteScope are displayed). Alternatively, click the Browse
Servers button to select a server from the local domain, or Add Remote Server to
add a new server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 468 of 926
Monitor Reference
Chapter 64: Microsoft Windows Media Server Monitor
UI
Element
Description
Counters Displays the server performance counters you want to check with this monitor. Use
the Get Counters button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" below.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Windows Media Station Service
• Controllers
• Stations
• Streams
Windows Media Unicast Service
• Active Live Unicast Streams
• Active Streams
• Active TCP Streams
• Active UDP Streams
• Aggregate Read Rate
• Aggregate Send Rate
• Allocated Bandwidth
• Authentication Requests
• Authentications Denied
• Authorization Requests
• Authorizations Refused
• Connected Clients
• Connection Rate
• HTTP Streams
• HTTP Streams Reading Header
• HTTP Streams Streaming Body
• Late Reads
• Pending Connections
• Plugin Errors -• Plugin Events
• Scheduling Rate
• Stream Errors
• Stream Terminations
• UDP Resend Requests
• UDP Resends Sent
Tips/Troubleshooting
General Notes/Tips
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 469 of 926
Monitor Reference
Chapter 64: Microsoft Windows Media Server Monitor
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
HP SiteScope (11.23)
Page 470 of 926
Chapter 65: Microsoft Windows Performance
Counter Monitor
The Microsoft Windows Performance Counter monitor enables you to track the values of any
Windows performance statistic. These are the same statistics that can be viewed using the
Microsoft Management Console under Windows.
Each time the Microsoft Windows Performance Counter monitor runs, it returns a reading and a
status message and writes them in the monitoring log file. The status is displayed in the group
details table for the monitor which represents the current value returned by this monitor. The status
is logged as either good, warning, or error. An error occurs if the counter could not be read, or if
measurements are within the error threshold range.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Windows Performance Counter monitor.
Learn About
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
Tasks
How to Configure the Microsoft Windows Performance Counter Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Performance Counters Tool is available when configuring this monitor to check
performance counters on a specific machine in a Windows network (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions). To use the tool
when configuring or editing a monitor, click the Use Tool button. For details on the tool, see
Performance Counters Tool in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 471 of 926
Monitor Reference
Chapter 65: Microsoft Windows Performance Counter Monitor
UI Descriptions
Microsoft Windows Performance Counter Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Name of the server on which you want to monitor Windows performance statistics.
Select a server from the server list (only those Windows remote servers that have
been configured in SiteScope are displayed). Alternatively, click the Browse Servers
button to select a server from the local domain, or Add Remote Server to add a new
server.
When using a settings file from the Microsoft Windows Performance Counter
monitor, all counters are measured on the server specified by this entry.
Note when working in template mode: You can use the template remote server (if
one was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft Windows
Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 472 of 926
Monitor Reference
Chapter 65: Microsoft Windows Performance Counter Monitor
UI
Element
Description
PerfMon The Microsoft Windows Performance Counter monitor setting file you want to use for
chart
your settings. These files can be saved in the Microsoft Management Console
file
(perfmon) and have either a .pmc or .pmw extension. The files in this list all reside in
the <SiteScope root directory>\templates.perfmon directory. There are a number
of default files in the standard SiteScope distribution.
Note: If you make your own settings file, it must be placed in the <SiteScope
root directory>\
templates.perfmon directory. You can optionally specify the settings directly for a
single counter in the Counter box below.
If you create your own .pmc file, any server specified in the .pmc file is ignored by
SiteScope. The queried server is the one in the Server box (see above). Therefore, do
not include identical counters directed at different servers in a single .pmc file. One
.pmc file can be used by more than one Microsoft Management Console instance, but
any single instance of the Microsoft Management Console only queries one server
regardless of the servers assigned in the .pmc.
If you have specified the settings directly in the Object box below, this list displays
(Custom object).
Object
Name of the high level item that is being measured, such as Processor or Server. It is
the same as the Object in the Microsoft Management Console. The object name is
case sensitive. If you are using a Performance monitor file for counter settings, leave
this item blank.
Counter
The specific aspect of the Object that is measured, such as Interrupts/sec. It is the
same as the Counter in the Microsoft Windows Performance monitor application. The
counter name is case sensitive. If you are using a Microsoft Windows Performance
monitor file for counter settings, leave this item blank.
For the list of counters that can be configured for this monitor, see "Monitor Counters"
on the next page.
Units
The units to be displayed with the counter's values to make them more readable.
Instance The instance in the Microsoft Windows Performance monitor application. The
instance name is case sensitive. Some counters can have multiple instances, for
example, on machines with two CPUs, there are two instances of the Processor
object. If you are using a Microsoft Windows Performance monitor file for counter
settings, leave this item blank. If you leave this blank and there are multiple
instances, the first instance in the list is selected.
HP SiteScope (11.23)
Page 473 of 926
Monitor Reference
Chapter 65: Microsoft Windows Performance Counter Monitor
UI
Element
Scale
Description
If you want the raw performance counter value scaled to make it more readable,
select one of the predefined choices using the Commonly used values list, or enter
a numeric value in the Other values box.
The raw value of the counter is multiplied by the scale to determine the value of the
monitor. The kilobytes option divides the raw value by 1,024 (the number of bytes in 1
K), and the megabytes option divides the raw value by 1,048,576 (the number of
bytes in 1 MB). If there are multiple counters specified by using a Microsoft Windows
Performance monitor file, this scaling applies to all counters.
Default value: 1
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
System
• % Total Processor Time
• File Data Operations/sec
• Processor Queue Length
• Total Interrupts/sec
Processor
• % Processor Time
Objects
• Threads
Process
• Private Bytes
Physical Disk
• % Disk Time
Memory
• Page Faults/sec
• Pages/sec
• Pool Nonpaged Bytes
Tips/Troubleshooting
General Notes/Limitations
When configuring this monitor in template mode, some fields that contain drop-down lists may be
displayed as text boxes, and the Browse Servers and Add Remote Server buttons are not
displayed.
HP SiteScope (11.23)
Page 474 of 926
Chapter 66: Microsoft Windows Resources
Monitor
The Microsoft Windows Resources monitor enables you to monitor system performance data on
Windows systems. This enables you to watch server loading for performance, availability, and
capacity planning. You can monitor multiple parameters or counters on a single, remote server with
each monitor instance. Create one or more Microsoft Windows Resources monitor instances for
each remote server in your environment. The error and warning thresholds for the monitor can be set
on one or more performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Windows Resources monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"Support for IPv6 Addresses" below
l
"Server-Centric Report" on the next page
l
"Configuring the Monitor to Run on Windows 2003 as a Non-Administrator User" on the next
page
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor supports WMI (Windows Management Instrumentation) as a method for gathering
statistics. For details, see Configure the WMI Service for Remote Monitoring in the Using
SiteScope Guide.
Support for IPv6 Addresses
This monitor supports the IPv6 protocol. If you want your environment to resolve host names to
IPv6, you can select the Prefer IP version 6 addresses option in SiteScope Infrastructure
Settings (Preferences > Infrastructure Preferences > Server Setting). If this option is selected,
whenever a host name is specified for a remote server and the name is resolved to both IPv4 and
IPv6, the IPv6 address is used.
HP SiteScope (11.23)
Page 475 of 926
Monitor Reference
Chapter 66: Microsoft Windows Resources Monitor
When using IPv6, the following protocols are supported:
l
WMI (from SiteScope installed on Windows platforms only)
l
NetBIOS (from SiteScope installed on Windows platforms only)
Note:
l
When using the Direct registry queries collection method with a NetBIOS connection,
counters are not displayed in the Available Counters table. However, you can still use
monitoring process if you modify the counters using the IPv4 protocol, or copy the counters
from an already configured monitor (copy the monitor), and then change back to the IPv6
address or host.
l
When using the Microsoft Windows PDH Library collection method with a NetBIOS
connection, IPv6 does not work if the name of the monitored server is specified as a literal
IPv6 address.
l
When specifying a literal IPv6 address as the name for the monitored remote server when
using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Server-Centric Report
You can create a Server-Centric Report for the Windows server by clicking the server name in the
Target column of the row corresponding to the Microsoft Windows Resources monitor in the
SiteScope Dashboard. For details, see Creating Server-Centric Reports in the Using SiteScope
Guide.
Configuring the Monitor to Run on Windows 2003 as a Non-Administrator
User
For the Microsoft Windows Resources monitor to monitor a Windows 2003 machine if the
SiteScope user account is not in the Administrators group, you must either:
l
Use the same domain account on both the SiteScope and the remote monitored system, or
l
Use local accounts on both systems, provided that the user accounts have the same name and
password and are always synchronized on both systems. You cannot use Local System or
other similar system predefined accounts that do not enable you to specify a password for them.
HP SiteScope (11.23)
Page 476 of 926
Monitor Reference
Chapter 66: Microsoft Windows Resources Monitor
In addition, you must configure the user account settings on SiteScope and the remote monitored
machine to log on using the selected non-administrator user account (domain or local account). You
can then use a standard Windows perfmon utility to verify that it works. For details on how to
perform this task, see "How to Configure the Microsoft Windows Resources Monitor" below.
Tasks
How to Configure the Microsoft Windows Resources Monitor
1.
Prerequisites
SiteScopes running on Windows platforms need to be running under an account that has the
necessary administrative security privileges to access performance counter data from remote
servers. If the servers you want to monitor are in a different domain, are governed under a
different policy, or require a unique login different than the account SiteScope is running under,
then you must define the connection to these servers under the Microsoft Windows Remote
Servers option in the remote server view.
For SiteScopes installed on UNIX platforms, you only need to define the connection to these
servers under the Microsoft Windows Remote Servers option in the remote server view.
2.
Configure user account settings on SiteScope
The user account settings on SiteScope must be configured to log on using the selected nonadministrator user account.
a. In the Services control panel, right-click the SiteScope service, and then click Properties.
The SiteScope Properties dialog box opens.
b. Click the Log On tab, and configure the user account to log on using the selected nonadministrator user account (domain or local account).
3.
Configure user account settings on the remote monitored machine
The user account settings on the monitored remote server must be configured to log on using
the selected non-administrator user account.
a. Check that you can access the remote machine. Perform a ping test and check DNS
resolves the server name with its IP address.
We recommend that you check there are no other network-related problems by using the
selected user account to map a network drive of the monitored machine to the drive used
on the SiteScope machine.
b. In the Services control panel, check that the RemoteRegistry service is running and that
the selected user account has access to it. You can use the following command from the
Windows 2003 Resource Kit (run it under an administrator account):
subinacl /service RemoteRegistry /grant=tester=f
HP SiteScope (11.23)
Page 477 of 926
Monitor Reference
Chapter 66: Microsoft Windows Resources Monitor
This command grants Full Access to the RemoteRegistry service for the local user
tester.
c. Add the domain or local user account to be used into the Performance Monitor Users and
Performance Log Users local user groups. Make sure that these groups have at least
read permissions for the following registry key (and all its subkeys):
[HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\
CurrentVersion\Perflib]
Note: To check read permissions, select Start > Run, and type Regedt32.exe. In the
Registry Editor, select the registry key, click Security, and select Permissions. In
the Name pane, select the user that SiteScope uses to access the remote machine,
and make sure that the Allow check box for Read is selected in the Permissions
pane.
d. Make sure that the domain or local user account to be used has at least read permissions
on the following objects:
o
Registry key: [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\
SecurePipeServers\winreg]
o
Files in %WINDIR%\System32\perf?XXX.dat, where XXX is the basic language ID
for the system. For example, 009 is the ID for the English version.
Note: If the required Performance Counter Library Values are missing or are
corrupted, follow the instructions in Microsoft knowledge base article KB300956
(http://support.microsoft.com/kb/300956/en-us) to manually rebuild them.
4.
Verify that the non-administrator user account works
After configuring the user account settings, verify that they work.
a. Launch a standard Windows perfmon utility. You can either:
o
launch it interactively when logged on to the SiteScope machine with the selected user
account by typing perfmon, or
o
launch it when logged on to the SiteScope machine with some other account through the
RunAs command, which enables you to launch commands under different user account.
Enter the following command:
runas /env /netonly /user:tester "mmc.exe perfmon.msc"
Then enter the password (in this example, for the tester account), and the command is
run under the tester user account.
HP SiteScope (11.23)
Page 478 of 926
Monitor Reference
Chapter 66: Microsoft Windows Resources Monitor
b. After the Performance window opens, right-click in the right graph area and select Add
Counters. The Add Counters dialog box opens.
c. Select Choose counters from computer and enter the remote monitored machine name
or its IP address in the box.
Press the TAB key. If the perfmon utility can connect to the remote machine, the
Performance object box is filled in with the performance objects that can be monitored from
the remote machine.
5.
Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Microsoft Windows Resources Monitor Settings
User interface elements are described below:
UI Element
Description
Server
Name of the server that you want to monitor. Select a server from the server
list (only those Windows remote servers that have been configured in
SiteScope are displayed). Alternatively, click the Browse Servers button to
select a server from the local domain, or Add Remote Server to add a new
server.
Note:
l
Remote servers that have been configured with the WMI method are also
displayed here. For details, see Configure the WMI Service for Remote
Monitoring in the Using SiteScope Guide.
l
When configuring this monitor on SiteScopes running on UNIX versions,
only remote servers that have been configured with an SSH connection
method are displayed. For details, see How to Configure Remote Windows
Servers for SSH monitoring.
l
When working in template mode, you can use the template remote server (if
one was created) without having to enter its name, by selecting the Use
already configured template remote under current template check
box.
Default value: SiteScope Server (the server on which SiteScope is installed)
HP SiteScope (11.23)
Page 479 of 926
Monitor Reference
Chapter 66: Microsoft Windows Resources Monitor
UI Element
Description
Server to get
(Available in template mode only) Name of any SiteScope remote server from
measurements which you want to get counters (it must be accessible in the domain using
from
NETBIOS). Any server that is accessible in the domain can be used. If a
server is not in the domain, you must manually add the server to the remote
server tree before adding counters, and then specify the newly created server
name in the Server field.
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select
the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible
in the local domain.
l
Enter server name. If the server you want to monitor does not appear in
the Servers list because it has not been identified in the network or has not
been configured in Remote Servers, enter the IP address or name of the
server to monitor.
Note: To monitor a remote Windows server, you must have domain privileges
or authenticated access to the remote server. For details on how to configure a
remote Windows server, see How to Configure SiteScope to Monitor a
Remote Microsoft Windows Server in the Using SiteScope Guide.
Add Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to
enter the configuration details. For user interface details, see New/Edit
Microsoft Windows Remote Server Dialog Box in the Using SiteScope Guide.
Collection
method
Select the collection method option. The Available Counters list is dynamically
updated according to the collection method selected. This enables you to see
the counters when creating or editing the monitor instead of when running the
monitor:
l
Microsoft Windows PDH Library Uses the Windows PDH library which
is the most common option.
l
Use global setting. Instructs the monitor to use the value configured in
Default collection method for Microsoft Windows Resources monitor
in Preferences > Infrastructure Preferences > General Settings. The
default value for this setting is PDH. This is the default option.
l
Direct registry queries. Use this option if Windows PDH library is not
accessible or if the monitor is having trouble using the Windows PDH
library.
Note: The collection method option is available only when the target remote
server uses the NetBIOS protocol (not SSH or WMI).
HP SiteScope (11.23)
Page 480 of 926
Monitor Reference
Chapter 66: Microsoft Windows Resources Monitor
UI Element
Description
Enable Server- Enables collecting data specifically for generating the Server-Centric Report.
Centric Report The report displays various measurements for the server being monitored. For
details, see Creating Server-Centric Reports in the Using SiteScope Guide.
Available
Counters
Displays the available measurements for this monitor.
For each measurement, select the Objects, Instances and Counters you
want to check with the Microsoft Windows Resources monitor, and click the
Add Selected Counters
button. The selected measurements are moved
to the Selected Counters list.
For the list of counters that can be configured for this monitor, see "Monitor
Counters" below.
Note: Objects are no longer automatically updated after opening the monitor’s
properties. Instead, click the Reload Objects button to reload data for the
selected objects.
Selected
Counters
Displays the measurements currently selected for this monitor, and the total
number of selected counters.
To remove measurements selected for monitoring, select the required
measurements, and click the Remove Selected Counters button
measurements are moved to the Available Counters list.
Reload
objects
. The
Reloads data for the selected objects.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
System
• % Total Processor Time
• File Data Operations/sec
• Processor Queue Length
• Total Interrupts/sec
Processor
• % Processor Time
Objects
• Threads
HP SiteScope (11.23)
Process
• Private Bytes
Physical Disk
• % Disk Time
Memory
• Page Faults/sec
• Pages/sec
• Pool Nonpaged Bytes
Page 481 of 926
Monitor Reference
Chapter 66: Microsoft Windows Resources Monitor
Tips/Troubleshooting
General Notes/Tips
l
The performance parameters or counters available for the Microsoft Windows Resources
monitor vary depending on what operating system options and applications are running on the
remote server.
l
When monitoring Windows servers configured using SSH, you must use the Direct registry
queries option for the Collection method.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
l
When configuring this monitor in template mode:
n
You can use regular expressions to define counters.
n
The Add Remote Server button is not displayed.
Troubleshooting and Limitations
l
Getting invalid CPU value error message in <SiteScope root
directory>\logs\RunMonitor.log file when using perfmon monitors on VMware host servers.
Workaround: Use the VMWare Performance monitor to measure CPU on VMWare host
servers.
l
If you encounter "Error: Object Processor not found on host" or "Error: Failed to collect the data"
when running the Microsoft Windows Resources monitor, change the collection method to the
Direct registry queries method option.
l
If you encounter inconsistent data when configuring Microsoft Windows Resources monitors
with many counters on a loaded network environment, you can specify a timeout value for the
monitor (for example, 300 seconds) in Preferences > Infrastructure Preferences > Monitor
Settings > Perfex options.
HP SiteScope (11.23)
Page 482 of 926
Chapter 67: Microsoft Windows Services State
Monitor
The Microsoft Windows Services State monitor enables you to monitor a list of services running on
Windows systems and report changes in the number of services that are running and list the
services that changed state.
By default, the monitor returns a list of all of the services that are set to be run automatically on the
remote server. You can filter the list of services returned by the monitor using regular expressions.
The monitor displays the number of services running and related statistics along with a summary
listing of the services installed on the remote server.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Microsoft Windows Services State monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
Supported Platforms/Versions
l
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
HP SiteScope (11.23)
Page 483 of 926
Monitor Reference
Chapter 67: Microsoft Windows Services State Monitor
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Microsoft Windows Services State Monitor
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 484 of 926
Monitor Reference
Chapter 67: Microsoft Windows Services State Monitor
UI Descriptions
Microsoft Windows Services State Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
The name of the server you want to monitor. Select a server from the server list (only
those remote servers that have been configured in SiteScope are displayed).
Alternatively, click the Browse Servers button to select a server from the local
domain, or Add Remote Server to add a new server.
Note:
l
This monitor supports WMI (Windows Management Instrumentation) as a method
for gathering statistics. Remote servers that have been configured with the WMI
method are also displayed in the server list. For details, see Configure the WMI
Service for Remote Monitoring in the Using SiteScope Guide.
l
When configuring this monitor on SiteScopes running on UNIX versions:
l
n
Only remote servers that have been configured with an SSH connection method
and SSH using preinstalled SiteScope remote Windows SSH files is
selected are displayed. For details, see How to Configure Remote Windows
Servers for SSH monitoring.
n
If you create a new remote server from the Monitor Settings panel, the SSH
using preinstalled SiteScope remote Windows SSH files setting is
automatically selected and cannot be cleared.
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
HP SiteScope (11.23)
Page 485 of 926
Monitor Reference
Chapter 67: Microsoft Windows Services State Monitor
UI
Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add New Microsoft Windows Remote Server dialog box, enabling you to
enter the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
Services Optional regular expression to filter the list of services returned by the monitor. When
to
you use a regular expression to filter the list of services, the monitor calculates
include changes in state (that is, running or not running) based only on the services matched
by the regular expression.
Default value: /(.*)/ (All of the services detected on the remote machine)
Examples:/.*Network.*/ includes all services that contain the word Network.
Services Optional regular expression to filter the list of services matched by the expression
to
used in the Services to include setting. When you use a Services to ignore regular
ignore
expression to filter the list of Services to include, the monitor calculates changes in
state (that is, running or not running) based only on the services matched by the
Services to ignore regular expression.
Capabilities include monitoring services added, services changed to running/not
running, services currently running/not running, services deleted, services last
running, number of services added, number of services changed to not running,
number of services currently running/not running, number of services deleted.
Examples: /.*Remote.*/ ignores all services that contain the word Remote (the
services that are ignored are listed in the Services Deleted field).
Include
driver
services
Includes all low-level driver services in the monitor. This generally increases the size
of the list. You use the Services to include and Service to ignore options to filter the
list of services returned using this option.
Note: For information on configuring setting panels that are common to all monitors, see
HP SiteScope (11.23)
Page 486 of 926
Monitor Reference
Chapter 67: Microsoft Windows Services State Monitor
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Services added
• Services changed to not running
• Services changed to running
• Services currently not running
• Services currently running
• Services deleted
• Services last running
• Number of services added
• Number changed to not running
• Number of services currently not running
• Number of services currently running
• Number of services deleted
Tips/Troubleshooting
General Notes/Limitations
l
The Microsoft Windows Services State monitor only retrieves a list of installed services. It does
not query the list of processes that may be running on the remote machine (use the Service
monitor for this).
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
To use this monitor to create event alerts, configure alert definitions associated with this monitor
to alert Once, after the condition has occurred exactly 1 times. This is because the
Microsoft Windows Services State monitor only signals a change in state for services relative to
the previous run of the monitor. For example, if the monitor is set to signal an error if a service
has changed from running to not running, the monitor only signals an error status for one monitor
run cycle. The number of services running and not running is reset for each monitor run and this
number is used for comparison with the next monitor run.
HP SiteScope (11.23)
Page 487 of 926
Chapter 68: Multi Log Monitor
The Multi Log monitor checks for specific entries added to log files in given log directories by
looking for entries containing a text phrase or a regular expression.
To access
In a SiteScope configured with System Health, select the Monitors context. In the monitor tree,
right-click a group, select New > Monitor, and select the Multi Log monitor.
Learn About
This section includes:
l
"Multi Log Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Support for IPv6 Addresses" below
Multi Log Monitor Overview
The Multi Log monitor watches for specific entries added to multiple log files in given log directories
by looking for entries containing a text phrase or a regular expression. You can use it to
automatically scan log files for error information. With SiteScope doing this for you at set intervals,
you can eliminate the need to scan the logs manually. In addition, you can be notified of warning
conditions that you may have otherwise been unaware of until something more serious happened.
By default, each time that SiteScope runs this monitor, it starts from the point in the file where it
stopped reading last time it ran. This insures that you are notified only of new entries and speeds
the rate at which the monitor runs. You can change this default behavior using the Search from
start setting.
Supported Platforms/Versions
l
This monitor supports monitoring remote servers running on Windows operating systems. For
the supported Windows versions, see Operating Systems Supported for Monitoring Remote
Windows Servers.
l
This monitor also supports monitoring remote servers running on UNIX and HP NonStop
operating systems. For details on enabling the HP NonStop operating system monitoring
environment, see "How to Configure the HP NonStop Resources Monitor" on page 307.
Support for IPv6 Addresses
This monitor supports the IPv6 protocol. If you want your environment to resolve host names to
IPv6, you can select the Prefer IP version 6 addresses option in SiteScope Infrastructure
Settings (Preferences > Infrastructure Preferences > Server Setting). If this option is selected,
whenever a host name is specified for a remote server and the name is resolved to both IPv4 and
IPv6, the IPv6 address is used.
HP SiteScope (11.23)
Page 488 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
When using IPv6, the following protocols are supported:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
SSH (from SiteScope installed on UNIX platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Multi Log Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Note: For reading log directories on remote Red Hat Linux machines, the Disable connection
caching check box must be selected in the remote server's Advanced Settings, otherwise the
Multi Log monitor will not work.
UI Descriptions
Multi Log Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
HP SiteScope (11.23)
Page 489 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
UI Element
Description
Server
Name of the server where the files you want to monitor are located. Select a
server from the server list (only those remote servers that have been
configured in SiteScope are displayed). Alternatively, click the Browse
Servers button to select a server from the local domain, or Add Remote
Server to add a new server.
Note: If using NetBIOS to connect to other servers in an Windows domain, you
can use the UNC format to specify the path to the remote log directory. You
can also use a local file system path, such as C:\logDir.
Note when working in template mode: You can use the template remote
server (if one was created) without having to enter its name, by selecting the
Use already configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select
the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible
in the local domain.
l
Enter server name. If the server you want to monitor does not appear in
the Servers list because it has not been identified in the network or has not
been configured in Remote Servers, enter the IP address or name of the
server to monitor.
Note: To monitor a remote Windows server, you must have domain privileges
or authenticated access to the remote server. For details on how to configure a
remote Windows server, see How to Configure SiteScope to Monitor a Remote
Microsoft Windows Server in the Using SiteScope Guide.
Add Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of
remote you want to add (Windows or UNIX), and enter the configuration
details.
For details on the Microsoft Windows Remote Servers user interface, see
New/Edit Microsoft Windows Remote Server Dialog Box in the Using
SiteScope Guide.
For details on the UNIX Remote Servers user interface, see New/Edit UNIX
Remote Server Dialog Box in the Using SiteScope Guide.
Note: For reading log directories on remote Red Hat Linux machines, the
Disable connection caching check box must be selected in the remote
server's Advanced Settings, otherwise the Multi Log File monitor will not work.
HP SiteScope (11.23)
Page 490 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
UI Element
Description
Log file
directories
Path to the log file directories you want to monitor. The monitor runs on all files
in the directory. For example, C:\logDir for a Windows remote server, or
/tmp/logDirs for a UNIX remote server.
To monitor multiple directories, enter the log file directory names separated by
a semi-colon (;). For example, C:\logdir1;C:\logdir2.
For Windows remote servers:
l
l
For reading log files using the NetBIOS method:
n
You can use UNC to specify the path to the remote log file directory,
such as \\remoteserver\sharedfolder\logdir. You can also use a
local file system path, such as C:\logDir.
n
All ":" characters will automatically be replaced by "$".
n
There is no need to specify the full name of the host.
For reading log files using the SSH method, specify the local path of the
remote log file on the remote machine. For example:
C:\Windows\System32\logdir
Note: On some SSH servers for Windows (such as Cygwin), the path might
need to be specified in UNIX style. For example, /cygwin/C/logDir.
You must also select the corresponding remote Windows SSH server in the
Servers box. For details on configuring a remote Windows server for SSH,
see How to Configure SiteScope to Monitor a Remote Microsoft Windows
Server in the Using SiteScope Guide.
l
You can also monitor files local to the server where SiteScope is running.
For example
C:\application\appLogs\logDir
For UNIX remote servers:
l
For reading log directories on remote UNIX machines, it is recommended to
use the absolute path to the directory of the UNIX user account being used
to log into the remote machine. For example, /etc or /tmp.
l
UNIX remotes support bash patterns. Patterns only work if the path
contains the asterisk character (*); otherwise, they will not be triggered. For
example:
/root/test* will recursively find all directories in dir /root/test/.
HP SiteScope (11.23)
Page 491 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
UI Element
Description
Optionally, you can use special date and time regular expression variables to
match folders and log file names that include date and time information. For
details, see "Date/Time Regular Expression Variables" in the File name
match description below.
File name
match
File name to look for in the specified log directories. You must use a regular
expression in this entry to match text patterns, otherwise a verification error
will be shown. Note that this option matches the full file path (with parent
directories).
Date/Time Regular Expression Variables
Optionally, you can use special date and time regular expression variables to
match folders and log file names that include date and time information. For
example, you can use a syntax of s/ex$shortYear$$0month$$0day$.log/ to
match a current date-coded log file. For details on using regular expressions,
see SiteScopeBSM Connector Date Variables and Examples for Log File
MonitoringPolicies in the Using SiteScope Guide.
Examples for Windows remote servers:
s/c:\app\logs\$year$\$monthName$/;s/d:\app2\logs\$year$\$monthNa
me$/ - Log files directories
s/$hour$.log/ - File name match
Examples for UNIX remote servers:
s//opt/app/logs/$year$/$monthName$/;s//opt/app2/logs/$year$/$mon
thName$ - Log files directories
s/$hour$.log/ - File name match
Content
match
Text to match in the log entries. You must use a regular expression in this entry
to match text patterns, otherwise a verification error will be shown.
Unlike the content match function of other SiteScope monitors, the Multi Log
File monitor content match is run repeatedly against the most recent content of
the target log file until all matches are found. This means the monitor not only
reports if the match was found but also how many times the matched pattern
was found. To match text that includes more than one line of text, add an s
search modifier to the end of the regular expression. For details, see Regular
Expressions in the Using SiteScope Guide.
Note: There is a limit of 10 content match values. When creating a report by
clicking the monitor title, the report includes only the first 10 values, if more
than 10 were entered.
HP SiteScope (11.23)
Page 492 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
UI Element
Description
Match value
labels
Use to enter labels for the matched values found in the target log directories.
The match value labels are used as variables to access retained values from
the Content match expression for use with the monitor threshold settings.
Separate multiple labels with a comma (,).
The labels are used to represent any retained values from the Content match
regular expression in the parameters available for the status threshold settings
(Error if, Warning if, and Good if). These labels are also displayed as the text
labels in graphs generated for the retained values in Management Reports (not
in Quick Reports) for this monitor. The order of labels is the same as the order
of matches.
Note: When you create a report by clicking the monitor title, the report includes
up to 10 match value labels.
Search from
start
If selected, it searches for the specified content from the beginning of the
directory. If not selected, it starts from the point in the file where it stopped
reading the last time it ran.
Default value: Cleared
Run alerts
l
For each log entry matched. The monitor triggers associated alerts
according to thresholds applied to each matching entry found. Since status
can change according to thresholds for each matched entry, each alert
action could be triggered many times within a monitor run. For example, if 5
matches are found in each file and the total matched files is 100. then 500
alerts are triggered.
Example: If you want to send a warning alert on matched text value "power
off" and an error alert if more than one server is turned off, set the following
thresholds:
n
Error if matchCount > 1
n
Warning if value == 'power off'
To send an error alert if only one threshold is matched, set Error if value
== 'power off'.
l
Once, after all log entries have been checked. The monitor counts up
the number of matches and then triggers one alert.
Default value: Once, after all log entries have been checked.
Note: Selecting For each log entry matched reduces monitor performance.
Advanced Settings
HP SiteScope (11.23)
Page 493 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
UI Element
Description
Log file
encoding
If the log file content to be monitored uses an encoding that is different than the
encoding used on the server where SiteScope is running, select the code page
or encoding to use. This may be necessary if the code page which SiteScope
is using does not support the character sets used in the target log file. This
enables SiteScope to match and display the encoded log file content correctly.
Default value: windows-1252
Max File Limit Limits the number of files in a given directory that can be processed. Files are
processed in alphabetical order.
Default value: 100
Note: If this value exceeds the global limit set in the _
multiLogGlobalMaxFileLimit property in the <SiteScope root
directory>\groups\master.config file, then the global limit will be used
instead. By default, the global limit is set to 1000.
Multi-line
match
Runs a regular expression match on multiple lines of text. The monitor
processes the file with a line buffer. For example, if the file contains two lines
“line1” “line2”, the monitor processes them as line1=”line1\r\n”,line2=”
line1\r\nline2\r\n”). The buffer size can be modified by changing the _
logFileMonitorMultiLineBufferedLines value in the <SiteScope root
directory>\groups\master.config file (the default value is 100).
Default value: Not selected
HP SiteScope (11.23)
Page 494 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
UI Element
Description
Server-side
processing
Processes log file data on the remote server-side. Benefits include low
memory usage and low CPU utilization on the SiteScope server, and faster
monitor run. Server-side processing does however cause high CPU utilization
on the remote server when processing the file.
Use of this option is only recommended:
l
If SiteScope performance is affected by large amounts of data being
appended to the target log file between monitor runs, and the Log File
monitor is performing badly in regular mode.
l
For a log file that is frequently being written to between monitor runs. This
way, all of the newly appended lines do not have to be copied across the
network and parsed on the SiteScope server (the processing is done on the
remote server and only the required lines would be copied across to
SiteScope).
Default value: Not selected
Note:
l
Server-side processing is enabled for remote Linux, Red Hat Enterprise
Linux, and Oracle Solaris servers only. Windows SSH is not supported.
l
To enable server-side processing to work correctly when monitoring on a
Solaris server, open the remote server settings for the monitored host
(Remote Servers > UNIX Remote Servers > Main Settings), and enter a
path to the bash interpreter in the Initialize shell environment field.
l
"Rule files" are not supported in this mode.
l
The /c search modifier is not supported in this mode.
l
The encoding for the remote server must be Unicode, or match the encoding
of the log file (if the remote file is in Unicode charset).
Timeout Settings
Enable
timeout
If selected, the monitor stops its run after the specified timeout period has been
exceeded.
Default value: Selected
Timeout
(seconds)
Amount of time, in seconds, that SiteScope should wait before the monitor
times out.
Default value: 120 seconds
Note: This setting is only available when Enable timeout is selected.
HP SiteScope (11.23)
Page 495 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
UI Element
Description
Rules Script
Enable Rules
If selected, the files are processed using rules. If cleared, the Rules Script box
is not available (grayed out).
Default value: Not selected
<Rules
script>
The rules script for processing files is displayed in this box.
Define the rules to specify different alerts for different log entry matches. You
can also set a parameter in the rules file to run script alerts. You can use any of
the properties in the SiteScope Alert Template and Event Properties Directory
in the Using SiteScope Guide.
An example rules file is located in <SiteScope root
directory>\examples\log_monitor\sample.rules. For instructions on how to
use the file and example rules, see "How to Use the Rules File" on page 354,
or read the instructions in the file itself.
Counters
You can view details (and configure threshold settings) for the following counters:
l
fileCount – Count of total files that matched filename regular expression.
l
filesWithMatches – Count of files that matched search regular expression.
l
fileNames – List of absolute file paths that match file regular expression separated by “;”. By
default, the first 100 file path matches are displayed.
l
filesNamesWithMatches - List of absolute file paths separated by “;” that matched search
regular expression “;”. By default, the first 100 file path matches are displayed.
l
notProcessedFilesByTimeOut – Files that were not processed due to timeout.
l
notProcessedFilesByLimit – Files that were not processed by Limit.
l
values – Matched values form regular expression. This shows only the first matched values
from first file with matches.
l
matchCount - Total matches in all files.
Note: You can change the number of fileNames and fileNamesWithMatches matches shown
by modifying the value of the _multiLogFileNamesLimit property in the <SiteScope root
directory>\groups\master.config file. By default, the limit is set to 100. It is not recommended
to increase the limit, because it significantly impacts SiteScope user interface performance.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 496 of 926
Monitor Reference
Chapter 68: Multi Log Monitor
Tips/Troubleshooting
General Tips/Troubleshooting
If you encounter "Error: Can't read files." or "Error: Can't read directory." in the summary field, you
should check the following:
l
There was not a connection timeout.
l
You have rights to read file.
l
The file exists.
HP SiteScope (11.23)
Page 497 of 926
Chapter 69: Network Bandwidth Monitor
This monitor enables you to monitor SNMP-enabled network appliances such as routers and
switches. The error and warning thresholds for the monitor can be set on one or more different
objects. This monitor type also provides a Real-time metrics report, available as a link in the More
column on the Group Detail Page.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Network Bandwidth monitor.
Learn About
This section includes:
l
"Network Bandwidth Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Performing Sanity Checks" below
l
"IPv6 Addressing Supported Protocols" on the next page
Network Bandwidth Monitor Overview
Use the Network Bandwidth monitor to monitor SNMP-enabled network appliances such as routers
and switches. The Network Bandwidth monitor operates like many other browsable monitors to
gather information from a source and enable the user to choose which items in the tree it should
monitor. It works by connecting to the specified network component and returning a list of
interfaces.
The MIB files in <SiteScope root directory>\templates.mib are used to create a browsable tree
that contains names and descriptions of the objects found during a traversal. Note that an object
may or may not be displayed with a textual name and description, depending on the MIBs available
in <SiteScope root directory>\templates.mib. SiteScope does not display objects for user
selection when it has no knowledge of how to display those objects. For example, a plain
OctetString may contain binary or ascii data, but SiteScope has no way to decode and display this
data correctly without more information.
Supported Platforms/Versions
This monitor supports monitoring remote servers running on Windows operating systems. For the
supported Windows versions, see Operating Systems Supported for Monitoring Remote Windows
Servers.
Performing Sanity Checks
By default, SiteScope performs a sanity check for every run of the monitor. This checks that the
values returned by the monitor are in the valid range. You can also choose to disable these sanity
checks.
HP SiteScope (11.23)
Page 498 of 926
Monitor Reference
Chapter 69: Network Bandwidth Monitor
To disable the sanity checks, clear the Network Bandwidth monitor sanitycheck box in the
Infrastructure Settings Preferences page (Preferences > Infrastructure Settings Preferences >
Monitor Settings).
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the SNMP protocol.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Network Bandwidth Monitor
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Network Bandwidth Monitor Settings
User interface elements are described below:
UI Element
Description
Basic SNMP Settings
Server
Name of the server you want to monitor.
Port
Port to use when requesting data from the SNMP agent.
Default value: 161
SNMP Connection Settings
Timeout
(seconds)
Amount of time, in seconds, that SiteScope should wait for all SNMP requests
(including retries) to complete.
Default value: 5 seconds
Number of
retries
Number of times each SNMP GET request should be retried before SiteScope
considers the request to have failed.
Default value: 1
Community
Community string (valid only for version 1 or 2 connections).
Default value: public
HP SiteScope (11.23)
Page 499 of 926
Monitor Reference
Chapter 69: Network Bandwidth Monitor
UI Element
Description
SNMP version
Version of SNMP to use when connecting. SiteScope supports SNMP
versions 1, 2, and 3. Selecting V3 enables you to enter V3 settings in the
SNMP V3 settings fields below.
Default value: V1
Authentication Authentication algorithm to use for version 3 connections.
algorithm
Default value: MD5
Note: This field is available only if SNMP V3 is selected.
User name
User name for version 3 connections.
Note: This field is available only if SNMP V3 is selected.
Password
Authentication password to use for version 3 connections.
Note: This field is available only if SNMP V3 is selected.
Privacy
algorithm
The privacy algorithmused for authentication for SNMP version 3 (DES,128Bit AES,192-Bit AES, 256-Bit AES).
Default value: DES
Note: This field is available only if SNMP V3 is selected.
Privacy
password
Privacy password for version 3 connections. Leave blank if you do not want
privacy.
Note: This field is available only if SNMP V3 is selected.
Context
engine ID
Hexadecimal string representing the Context Engine ID to use for this
connection.
Note: This field is available only if SNMP V3 is selected.
Context name
Context Name to use for this connection.
Note: This field is available only if SNMP V3 is selected.
Network Counters
Counters
HP SiteScope (11.23)
Displays the server performance counters you want to check with this monitor.
Use the Get Counters button to select counters.
Page 500 of 926
Monitor Reference
Chapter 69: Network Bandwidth Monitor
UI Element
Description
Get Counters
Opens the Select Counters Form, enabling you to select the counters you
want to monitor. For the list of counters that can be configured for this monitor,
see "Monitor Counters" on the next page below.
Note:
l
The counters displayed are those received during the timeout period, and
may not include all the counters available on the server. Specifying a longer
timeout in the Timeout (seconds) field in the SNMP Connection Settings
panel may result in receiving more counters.
l
The total time for receiving the counters may be longer than the timeout
specified, due to additional processing time not part of the
request/response period.
Advanced Network Settings
Device type
Optional device type for device specific monitoring. By specifying a device
type, you enable the Network Bandwidth monitor to watch certain devicespecific metrics. For information about controlling the metrics associated with
these device types and on adding new device types, see the section entitled
Device Specific Metrics Config File.
Default value: Do not monitor device-specific metrics
Duplex or
half-duplex
Duplex state (Half-duplex or Full-duplex) to use when calculating percent
bandwidth utilized for all selected interfaces on this device.
Default value: Full-duplex
HP SiteScope (11.23)
Page 501 of 926
Monitor Reference
Chapter 69: Network Bandwidth Monitor
UI Element
Description
Interface index Metrics for network interfaces on an SNMP-enabled device are presented as a
table of management information (the ifTable). Each row corresponds to a
different interface. There is no requirement that the mappings from interface-torow in this table remain constant across device reboots. The Interface Index
parameter may help prevent the interfaces SiteScope is monitoring from
becoming confused after a device restarts.
The three possible options are:
l
Indexed by interface name. The ifDescr field of the ifTable is used to
maintain monitoring consistency across device reboots.
l
Indexed by physical address. The ifPhysAddr field of the ifTable is used
to maintain monitoring consistency across device reboots.
l
Indexed by ifTable row number.SiteScope assumes that the interfaces
remain in the same row in the ifTable across device reboots.
Note: Some devices (for example, Cisco) may have a configuration option to
not jumble the position of interfaces in the ifTable during reboot. This may be
the safest option, as not all interfaces may always have a unique ifDescr, and
not all interfaces may have an ifPhysAddr (loopback interfaces do not typically
have a physical address).
Default value: Indexed by ifTable row number.
Show bytes
in/out
Displays a graph for bytes in/out along with the percent bandwidth utilized on
the Real-Time Metrics page.
Default value: Not selected
Real-Time
data vertical
axis
Maximum value on the vertical axis for real-time graphs (leave blank to have
this automatically calculated by SiteScope).
Real-Time
data time
window
(hours)
Number of hours for which real-time graph data should be stored.
Default value: 24 hours
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Bytes in
• Bytes out
• Packet in
HP SiteScope (11.23)
Page 502 of 926
Monitor Reference
Chapter 69: Network Bandwidth Monitor
• Packets out
• Incoming discarded packets
• Outgoing discarded packets
• Incoming packets in error
• Outgoing packets in error
• Out queue length
• % bandwidth utilization
Tips/Troubleshooting
General Notes/Limitations
l
When working in template mode, the monitor's non-default thresholds are not copied properly to
a template.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 503 of 926
Chapter 70: News Monitor
The News monitor verifies that a News server can be connected to, and is responding. It also
measures how long it takes to make a connection, and how many articles are currently in the
specified news groups. This enables you to manage the number of articles that can queue up, and
delete them before they cause disk space problems.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the News monitor.
Learn About
Status
Each time the News monitor runs, it returns a status message and writes it in the monitoring log file.
It also writes the total time it takes to receive a response from the news server, and the number of
articles available for each of the specified news groups.
The reading is the current value of the monitor. The possible values for the News monitor are:
l
OK.
l
unknown host name.
l
unable to reach server.
l
unable to connect to server.
l
timed out reading.
l
<news group> not found. The given news group was not found on the news server.
l
permission denied for connection. The connection could not be made, probably because the
news server was configured to enable connections from a limited range of addresses.
l
login expected. The news server expected a user name and password, but none were provided.
In this case, enter a user name and password under the Monitor Settings section of the monitor.
l
login failed, unauthorized. The user name and password were not accepted by the news server.
The status is logged as either good or error. An error status is returned if the current value of the
monitor is anything other than good.
Tasks
How to Configure the News Monitor
Configure the monitor properties as described in the UI Descriptions section below.
HP SiteScope (11.23)
Page 504 of 926
Monitor Reference
Chapter 70: News Monitor
Tip: The News Server Tool is available when configuring this monitor to access a news
server and view the NNTP interaction between SiteScope and the news server (provided you
are an administrator in SiteScope, or a user granted Use monitor tools permissions). To use
the tool when configuring or editing a monitor, click the Use Tool button. For details on the tool,
see News Server Tool in the Using SiteScope Guide.
UI Descriptions
News Monitor Settings
User interface elements are described below:
UI
Element
Description
Main Settings
News
server
IP address or the name of the news server that you want to monitor.
Example: 206.168.191.21 or news.thiscompany.com.
If the port is not the standard news port, add the port after the server with a colon.
Example: news.thiscompany.com:7777
News
groups
News groups to be checked, separated by commas. Each of these news groups are
checked for the current number of articles available in that news group. The reading
of the monitor is the sum of articles available for each of the specified news groups.
User
name
User name if your News server requires authorization.
Password Password if your News server requires authorization.
Advanced Settings
Connect
from
Name or IP address of the server that connects to the News monitor.
Timeout
(seconds)
Amount of time, in seconds, that the News monitor should wait for all of news
transactions to complete before timing-out. Once this time period passes, the News
monitor logs an error and reports an error status.
Default value: 60 seconds
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• number of articles
• round trip time
HP SiteScope (11.23)
Page 505 of 926
Monitor Reference
Chapter 70: News Monitor
• status
HP SiteScope (11.23)
Page 506 of 926
Chapter 71: Oracle 10g Application Server
Monitor
Use the Oracle 10g Application Server monitor to monitor the server performance data for Oracle
10g and 10g R3 application servers. You can monitor multiple parameters or counters with a single
monitor instance. This enables you to watch server loading for performance, availability, and
capacity planning.
Create a separate monitor instance for each Oracle 10g Application Server in your environment.
The error and warning thresholds for the monitor can be set on one or more Oracle 10g server
performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Oracle 10g Application Server monitor.
Tasks
How to Configure the Oracle 10g Application Server Monitor
1. Prerequisites
By default, the Oracle 10g metrics servlet is visible only to the local host. To enable monitoring
the Oracle 10g Application Server, the servlet must be accessible from other IP addresses.
You must edit the dms.conf file in the <Oracle 10g installation
path>infra/Apache/Apache/conf directory. For details on editing the file and making this
change, refer to the Oracle 10g Application Server documentation. Once configured properly,
you should see the following URL: http://<Oracle 10g machine
URL>:7201/dmsoc4j/Spy?format=xml.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Oracle 10g Application Server Monitor Settings
User interface elements are described below:
UI Element
Description
Authorization User name to access the server if required.
user name
HP SiteScope (11.23)
Page 507 of 926
Monitor Reference
Chapter 71: Oracle 10g Application Server Monitor
UI Element
Description
Authorization Password to access the server if required.
password
Proxy server
Domain name and port of an HTTP Proxy Server if a proxy server is used to
access the server.
Proxy server
user name
Proxy server user name if the proxy server requires a name and password to
access the server. Your proxy server must support Proxy-Authenticate for
these options to function.
Proxy server
password
Proxy server password if the proxy server requires a name and password to
access the server. Your proxy server must support Proxy-Authenticate for
these options to function.
Host name
Server administration URL for the server you want to monitor.
Metric type
The type of metrics to monitor. Options are App Server (OC4J) and Web Server
(DMS).
Port
Server port for the server you want to monitor.
Default value: 7201 (configured in the dms.conf file)
Secure server Select to use a secure server.
Timeout
(seconds)
Amount of time, in seconds, that the monitor should wait for a response from
the server before timing-out. Once this time period passes, the monitor logs an
error and reports an error status.
Default value: 60 seconds
Counters
Displays the server performance counters selected for this monitor. Use the
Get Counters to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you want
to monitor. For the list of counters that can be configured for this monitor, see
"Monitor Counters" on the next page.
Note when working in template mode: The maximum number of counters
that you can select is 100. If you import a template monitor from an earlier
version of SiteScope, or perform a copy to template action, the number of
counters is not limited.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 508 of 926
Monitor Reference
Chapter 71: Oracle 10g Application Server Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Oracle HTTP Server Metrics
• connection.active
• connection.avg
• connection.maxTime
• connection.minTime
• connection.time
• handle.active
• handle.avg
• handle.maxTime
• handle.minTime
• handle.time
• request.active
• request.avg
• request.completed
• request.maxTime
• request.minTime
• request.time
JVM Metrics
• activeThreadGroups.value
• activeThreadGroups.minValue
• activeThreadGroups.maxValue
• activeThreads.value
• activeThreads.minValue
• activeThreads.maxValue
• upTime.value
• freeMemory.value
• freeMemory.minValue
• freeMemory.maxValue
• totalMemory.value
• totalMemory.minValue
• totalMemory.maxValue
JDBC Metrics
• ConnectionCloseCount.count
• ConnectionCreate.active
• ConnectionCreate.avg
• ConnectionCreate.completed
• ConnectionCreate.maxTime
• ConnectionCreate.minTime
• ConnectionCreate.time
• ConnectionOpenCount.count
OC4J Metrics Web Module
• parseRequest.active
• parseRequest.avg
• parseRequest.completed
• parseRequest.maxActive
• parseRequest.maxTime
HP SiteScope (11.23)
• parseRequest.minTime
• parseRequest.time
• processRequest.active
• processRequest.avg
• processRequest.completed
• processRequest.maxActive
• processRequest.maxTime
• processRequest.minTime
• processRequest.time
• resolveContext.active
• resolveContext.avg
• resolveContext.completed
• resolveContext.maxActive
• resolveContext.maxTime
• resolveContext.minTime
• resolveContext.time
Web Context
• resolveServlet.time
• resolveServlet.completed
• resolveServlet.minTime
• resolveServlet.maxTime
• resolveServlet.avg
• sessionActivation.active
• sessionActivation.time
• sessionActivation.completed
• sessionActivation.minTime
• sessionActivation.maxTime
• sessionActivation.avg
• service.time
• service.completed
• service.minTime
• service.maxTime
• service.avg
• service.active
Servlet
• service.active
• service.avg
• service.completed
• service.maxActive
• service.maxTime
• service.minTime
• service.time
JSP Name
• activeInstances.value
• availableInstances.value
• service.active
• service.avg
• service.completed
• service.maxTime
• service.minTime
• service.time
Session Bean
• session-type.value
• transaction-type.value
EJB Bean
• transaction-type.value
• session-type.value
• bean-type.value
• exclusive-writeaccess.value
• isolation.value
• persistence-type.value
EJB Method
• client.active
• client.avg
• client.completed
• client.maxActive
• client.maxTime
• client.minTime
• client.time
• ejbPostCreate.active
• ejbPostCreate.avg
• ejbPostCreate.completed
• ejbPostCreate.maxTime
• ejbPostCreate.minTime
• ejbPostCreate.time
• trans-attribute.value
• wrapper.active
• wrapper.avg
• wrapper.completed
• wrapper.maxActive
• wrapper.maxTime
• wrapper.minTime
• wrapper.time
JSP Runtime
• processRequest.time
• processRequest.completed
• processRequest.minTime
• processRequest.maxTime
• processRequest.avg
• processRequest.active
Page 509 of 926
Monitor Reference
Chapter 71: Oracle 10g Application Server Monitor
OPMN Info
• default_application_log.value
• ias_cluster.value
• ias_instance.value
• jms_log.value
• oc4j_instance.value
• oc4j_island.value
• opmn_group.value
• opmn_sequence.value
• rmi_log.value
• server_log.value
JMS
• JMSStats
• JMSRequestHandlerStats
• JMSConnectionStats
• JMSSessionStats
• JMSMessageProducerStats
• JMSMessageBrowserStats
• JMSMessageConsumerStats
• JMSDurableSubscriberStats
• JMSDestinationStats
• JMSTemporaryDestinationStats
• JMSStoreStats
• JMSPersistenceStats
JMS Stats Metric
• address.value
• connections.count
• host.value
• oc4j.jms.computeMsgsize.value
• oc4j.jms.debug.value
• oc4j.jms.doGc.value
• oc4j.jms.expirationInterval
• oc4j.jms.forceRecovery.value
• oc4j.jms.intraSession.value
• oc4j.jms.j2ee14.value
• oc4j.jms.lazySync.value
• oc4j.jms.listenerAttempts.
• oc4j.jms.maxOpenFiles.value
• oc4j.jms.messagePoll.value
• oc4j.jms.noDms.value
• oc4j.jms.pagingThreshold.
• oc4j.jms.saveAllExpired.val
• oc4j.jms.serverPoll.value
• oc4j.jms.socketBufsize.val
• oc4j.jms.usePersistence.val
• oc4j.jms.useSockets.value
• oc4j.jms.useUUID.value
• port.value
• requestHandlers.count
• startTime.value
• taskManagerInterval.value
• method-name
HP SiteScope (11.23)
JMS Request Handler Stats
• address.value
• connectionID.value
• host.value
• port.value
• startTime.value
JMS Connection Stats
• address.value
• clientID.value
• domain.value
• exceptionListener.value
• host.value
• isLocal.value
• isXA.value
• port.value
• startTime.value
• user.value
• method-name
JMS Session Stats
• acknowledgeMode.value
• domain.value
• isXA.value
• sessionListener.value
• startTime.value
• transacted.value
• txid.value
• xid.value
• method-name
JMS Message Producer Stats
• deliveryMode.value
• destination.value
• disableMessageID.value
•
disableMessageTimestamp.valu
e
• domain.value
• priority.value
• startTime.value
• timeToLive.value
• method-name
JMS Message Browser Stats
• destination.value
• selector.value
• startTime.value
• method-name
JMS Message Consumer
Stats
• destination.value
• domain.value
• messageListener.value
• name.value
• noLocal.value
• selector.value
• startTime.value
• method-name
JMS Durable Subscription
Stats
• clientID.value
• destination.value
• isActive.value
• name.value
• noLocal.value
• selector.value
JMS Destination Stats
• domain.value
• name.value
• locations.value
• method-name
JMS Temporary Destination
Stats
• connectionID.value
• domain.value
• method-name
JMS Store Stats
• destination.value
• messageCount.value
• messageDequeued.count
• messageDiscarded.count
• messageEnqueued.count
• messageExpired.count
• messagePagedIn.count
• messagePagedOut.count
• messageRecovered.count
•
pendingMessageCount.valu
e
• storeSize.value
• method-name
JMS Persistence Stats
• destination.value
• holePageCount.value
• isOpen.value
• lastUsed.value
• persistenceFile.value
• usedPageCount.value
• method-name
Page 510 of 926
Monitor Reference
Chapter 71: Oracle 10g Application Server Monitor
Taskmanager
• interval.value
• run().active
• run().avg
• run().completed
• run().maxActive
• run().maxTime
• run().minTime
• run().time
mod_plsql Metrics
Session Cache
• cacheStatus.value
• newMisses.count
• staleMisses.count
• hits.count
• requests.count
Content Cache
• cacheStatus.value
• newMisses.count
• staleMisses.count
• hits.count
• requests.count
SQLErrorGroups
• lastErrorDate.value
• lastErrorRequest.value
• lastErrorText.value
• error.count
LastNSQLErrors
• errorDate.value
• errorRequest.value
• errorText.value
NonSSOConnectionPool
• connFetch.maxTime
• connFetch.minTime
• connFetch.avg
• connFetch.active
• connFetch.time
• connFetch.completed
• newMisses.count
• staleMisses.count
• hits.count
RequestOwnerConnectionPool
• connFetch.maxTime
• connFetch.minTime
• connFetch.avg
• connFetch.active
• connFetch.time
• connFetch.completed
• newMisses.count
• staleMisses.count
• hits.count
HP SiteScope (11.23)
SuperUserConnectionPool
• connFetch.maxTime
• connFetch.minTime
• connFetch.avg
• connFetch.active
• connFetch.time
• connFetch.completed
• newMisses.count
• staleMisses.count
• hits.count
Portal Metrics
Witness/PageEngine
• pageRequests.value
• cacheEnabled.value
• cachePageHits.value
• cachePageRequests.value
•
pageMetadataWaitTimeAvg.valu
e
•
pageMetadataWaitTimeAvg.cou
nt
• pageMetadataWaitTime.value
• pageMetadataWaitTime.count
•
pageMetadataWaitTime.minValu
e
•
pageMetadataWaitTime.maxVal
ue
• pageElapsedTimeAvg.value
• pageElapsedTimeAvg.count
• pageElapsedTime.value
• pageElapsedTime.count
• pageElapsedTime.minValue
• pageElapsedTime.maxValue
• pageMetadataFetchTimeAvg.
value
• pageMetadataFetchTimeAvg.
count
• pageMetadataFetchTime.value
• pageMetadataFetchTime.count
• pageMetadataFetchTime.min
Value
• pageMetadataFetchTime.
maxValue
• queueTimeout.value
• queueStayAvg.value
• queueStayAvg.count
• queueStay.value
• queueStay.count
• queueStay.minValue
• queueStay.maxValue
• queueLengthAvg.value
• queueLengthAvg.count
• queueLength.value
• queueLength.count
• queueLength.minValue
• queueLength.maxValue
Witness/PageUrl
• lastResponseDate.value
• lastResponseCode.value
• cacheHits.value
• httpXXX.value
• executeTime.maxTime
• executeTime.minTime
• executeTime.avg
• executeTime.active
• executeTime.time
• connFetch.completed
WitnessLoginUrl
• lastResponseDate.value
• lastResponseCode.value
• cacheHits.value
• httpXXX.value
• executeTime.maxTime
• executeTime.minTime
• executeTime.avg
• executeTime.active
• executeTime.time
• connFetch.completed
WitnessVersionUrl
• lastResponseDate.value
• lastResponseCode.value
• cacheHits.value
• httpXXX.value
• executeTime.maxTime
• executeTime.minTime
• executeTime.avg
• executeTime.active
• executeTime.time
• connFetch.completed
WitnessXSLUrl
• lastResponseDate.value
• lastResponseCode.value
• cacheHits.value
• httpXXX.value
• executeTime.maxTime
• executeTime.minTime
• executeTime.avg
• executeTime.active
• executeTime.time
• connFetch.completed
Page 511 of 926
Monitor Reference
Chapter 71: Oracle 10g Application Server Monitor
WitnessPlsqlDad-provider
• cacheHits.value
• offline.value
• httpXXX.value
• executeTime.maxTime
• executeTime.minTime
• executeTime.avg
• executeTime.active
• executeTime.time
• connFetch.completed
WitnessWebDad-provider
• cacheHits.value
• offline.value
• httpXXX.value
• executeTime.maxTime
• executeTime.minTime
• executeTime.avg
• executeTime.active
• executeTime.time
• connFetch.completed
WitnessWebDad-providerPorlet
• lastResponseDate.value
• lastResponseCode.value
• cacheHits.value
• httpXXX.value
• executeTime.maxTime
• executeTime.minTime
• executeTime.avg
• executeTime.active
• executeTime.time
• connFetch.completed
JServ Metrics
Overall Jserv
• port.value
• readRequest.active
• readRequest.avg
• readRequest.maxTime
• readRequest.minTime
• readRequest.completed
• readRequest.time
• maxConnections.value
• activeConnections.maxValue
• activeConnections.value
• idlePeriod.maxTime
• idlePeriod.minTime
• idlePeriod.completed
• idlePeriod.time
• host.value
• maxBacklog.value
HP SiteScope (11.23)
Jserv Zone
• checkReload.active
• checkReload.avg
• checkReload.maxTime
• checkReload.minTime
• checkReload.completed
• checkReload.time
• activeSessions.value
• readSession.count
• writeSession.count
• loadFailed.count
Jserv Servlet
• processRequest.active
• processRequest.avg
• processRequest.maxTime
• processRequest.minTime
• processRequest.completed
• processRequest.time
• serviceRequest.active
• serviceRequest.avg
• serviceRequest.maxTime
• serviceRequest.minTime
• serviceRequest.completed
• serviceRequest.time
• loadServlet.avg
• loadServlet.maxTime
• loadServlet.minTime
• loadServlet.completed
• loadServlet.time
• loadServletClasses.active
• loadServletClasses.avg
• loadServletClasses.maxTime
• loadServletClasses.minTime
• loadServletClasses.completed
• loadServletClasses.time
• loadServlet.avg
• createSession.active
• createSession.avg
• createSession.maxTime
• createSession.minTime
• createSession.completed
• createSession.time
• maxSTMInstances.value
• activeSTMInstances.maxValue
• activeSTMInstances.value
Jserv JSP
• processRequest.active
• processRequest.avg
• processRequest.maxTime
• processRequest.minTime
• processRequest.completed
• processRequest.time
• serviceRequest.active
• serviceRequest.avg
• serviceRequest.maxTime
• serviceRequest.minTime
• serviceRequest.completed
• serviceRequest.time
• loadServlet.avg
• loadServlet.maxTime
• loadServlet.minTime
• loadServlet.completed
• loadServlet.time
• loadServletClasses.active
• loadServletClasses.avg
•
loadServletClasses.maxTime
•
loadServletClasses.minTime
•
loadServletClasses.complete
d
• loadServletClasses.time
• loadServlet.avg
• createSession.active
• createSession.avg
• createSession.maxTime
• createSession.minTime
• createSession.completed
• createSession.time
• maxSTMInstances.value
•
activeSTMInstances.maxVal
ue
• activeSTMInstances.value
Oracle Process
Manager/Notification Server
Metrics
OPMN_PM Metrics
• jobWorkerQueue.value
• lReq.count
• procDeath.count
• procDeathReplace.count
• reqFail.count
• reqPartialSucc.count
• reqSucc.count
• rReq.count
• workerThread.value
Page 512 of 926
Monitor Reference
Chapter 71: Oracle 10g Application Server Monitor
OPMN_HOST_STATISTICS
Metrics
• cpuIdle.value
• freePhysicalMem.value
• numProcessors.value
• timestamp.value
• totalPhysicalMem.value
OPMN_IAS_INSTANCE Metrics
• iasCluster.value
OPMN_PROCESS_TYPE Metrics
• moduleId.value
OPMN_PROCESS_SET Metrics
• numProcConf.value
• reqFail.count
• reqPartialSucc.count
• reqSucc.count
• restartOnDeath.value
OPMN_PROCESS Metrics
• cpuTime.value
• heapSize.value
• iasCluster.value
• iasInstance.value
• indexInSet.value
• memoryUsed.value
• pid.value
• privateMemory.value
• sharedMemory.value
• startTime.value
• status.value
• type.value
• uid.value
• upTime.value
OPMN_CONNECT Metrics
• desc.value
• host.value
• port.value
OPMN_ONS Metrics
• notifProcessed.value
• notifProcessQueue.value
• notifReceived.value
• notifReceiveQueue.value
• workerThread.value
OPMN_ONS_LOCAL_PORT
Metrics
• desc.value
• host.value
• port.value
OPMN_ONS_REMOTE_
PORT Metrics
• desc.value
• host.value
• port.value
OPMN_ONS_REQUEST_
PORT Metrics
• desc.value
• host.value
• port.value
Tips/Troubleshooting
General Notes/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 513 of 926
Chapter 72: Oracle 9i Application Server
Monitor
Use the Oracle 9i Application Server monitor to monitor the server performance data for Oracle 9i
servers. You can monitor multiple parameters or counters with a single monitor instance. This
enables you to watch server loading for performance, availability, and capacity planning.
Create a separate monitor instance for each Oracle 9i Application server in your environment. The
error and warning thresholds for the monitor can be set on one or more Oracle 9i server performance
statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Oracle 9i Application Server monitor.
Tasks
How to Configure the Oracle 9i Application Server Monitor
1. Prerequisites
You must enable Web caching on the Oracle 9i Application Server to use the Oracle 9i
Application Server monitor.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The URL Tool is available when configuring this monitor to request a URL from a
server, print the returned data, and test network routing (provided you are an administrator
in SiteScope, or a user granted Use monitor tools permissions). To use the tool when
configuring or editing a monitor, click the Use Tool button. For details on the tool, see
URL Tool in the Using SiteScope Guide.
UI Descriptions
Oracle 9i Application Server Monitor Settings
User interface elements are described below:
UI Element
Description
URL
Server administration URL for the server you want to monitor. The URL is
usually in the format: http://server:port/webcacheadmin?SCREEN_
ID=CGA.Site.Stats&ACTION=Show.
HP SiteScope (11.23)
Page 514 of 926
Monitor Reference
Chapter 72: Oracle 9i Application Server Monitor
UI Element
Description
Counters
Displays the server performance counters selected for this monitor. Use the
Get Counters button to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you want
to monitor. For the list of counters that can be configured for this monitor, see
"Monitor Counters" below.
Authorization User name if the server you want to monitor requires a name and password for
user name
access.
Authorization password if the server you want to monitor requires a name and password for
password
access.
HTTP Proxy
Domain name and port of an HTTP Proxy Server. if a proxy server is used to
access the server.
Proxy user
name
Proxy server user name if the proxy server requires a name and password to
access the server. Technical note: your proxy server must support ProxyAuthenticate for these options to function.
Proxy
password
Proxy server password if the proxy server requires a name and password to
access the server. Technical note: your proxy server must support ProxyAuthenticate for these options to function.
Timeout
(seconds)
Amount of time, in seconds, that the monitor should wait for a response from
the server before timing-out. Once this time period passes, the monitor logs an
error and reports an error status.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Interface: HTTP
• Active Sessions(max)
• Active Sessions(now)
• Apology Pages Served(Network Error - number this
second)
• Apology Pages Served(Network Error - total)
• Apology Pages Served(Site Busy - number this second)
• Apology Pages Served(Site Busy - total)
• Application Web Server Backlog(max)
HP SiteScope (11.23)
• Application Web Server Backlog
(now)
• Completed Requests(avg/sec)
• Completed Requests(max/sec)
• Completed Requests(number/sec)
• Completed Requests(total)
• Latency(avg since start)
• Latency(avg this interval)
• Load(max)
• Load(now)
• Up/Down Time(up/down)
Page 515 of 926
Monitor Reference
Chapter 72: Oracle 9i Application Server Monitor
Tips/Troubleshooting
General Notes/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 516 of 926
Chapter 73: Oracle Database Monitor
Use the Oracle Database monitor to monitor the server performance statistics from Oracle
Database servers. You can monitor multiple parameters or counters with a single monitor instance.
This enables you to watch server loading for performance, availability, and capacity planning.
Create a separate Oracle Database monitor instance for each Oracle database server in your
environment. The error and warning thresholds for the monitor can be set on one or more Oracle
server performance statistics.
Note: SiteScope also provides a solution template that includes a set of predefined monitors to
create a monitoring solution for various aspects of an Oracle database server. For details, see
Oracle Database Solution Templates in the Using SiteScope Guide.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Oracle Database monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
l
"Oracle Database Topology" below
Supported Platforms/Versions
The monitor supports monitoring server performance statistics from Oracle Database 8i, 9i, 10g,
11i, and 11g R2 (11.2.0.1) servers.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the TCP (JDBC) protocol. Support for IPv6
might also depend on the JDBC driver being used.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Oracle Database Topology
The Oracle Database monitor can identify the topology of the Oracle databases being monitored.
The monitor creates the following topology in BSM's RTSM.
HP SiteScope (11.23)
Page 517 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
For details on enabling topology reporting, see the task below.
To ensure that the topology is reported accurately, enter the values for the Database machine
name and the SID. These fields appear in the BSM Integration Data and Topology Settings
section of HP Integration Settings.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
Tasks
This section includes:
l
"How to Configure the Oracle Database Monitor" below
l
"How to Access Oracle Databases Using OCI Driver" on page 520
How to Configure the Oracle Database Monitor
1.
Prerequisites
The following are key requirements for using the Oracle Database monitor:
n
You must have a copy of the applicable Oracle JDBC database driver file (for example,
classes12.zip) on the SiteScope server. Copy the downloaded driver file into the
<SiteScope root directory>\WEB-INF\lib subdirectory. Do not unzip the file. Stop and
restart the SiteScope service after copying the driver file to the SiteScope machine.
Note: More than one driver file is available for download. Some drivers support more
than one version of Oracle database (for example, the classes12.zip Oracle JDBC
thin driver) while others only support a particular version. If you are monitoring a recent
version of Oracle database, download the latest version of the database driver.
n
You must supply the correct Database connection URL, a database user name and
password when setting up the monitor. When using the Oracle thin driver, the database
connection URL has the form of:
jdbc:oracle:thin:@<server name or IP address>:<port>:<database sid>.
HP SiteScope (11.23)
Page 518 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
For example, to connect to the ORCL database on a machine using port 1521 you would
use:
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
Note: The colon (:) and the at (@) symbols must be included as shown.
You must know the syntax for accessing the Oracle Database driver that was installed on
the SiteScope server. Examples of common database driver strings are:
n
2.
o
oracle.jdbc.driver.OracleDriver.SiteScope supports the following categories of JDBC
driver that are supplied by Oracle: JDBC thin driver for Oracle 7 and 8 databases, and
JDBC OCI (thick) driver. For details on accessing Oracle databases using OCI driver, see
"How to Access Oracle Databases Using OCI Driver" on the next page.
o
com.mercury.jdbc.oracle.OracleDriver. A driver for Oracle databases. This driver is
deployed with SiteScope. When using the Oracle mercury driver, the database connection
URL has the form of: jdbc:mercury:oracle://<server name or IP
address>:<database server port>;sid=<sid>
n
Only one version of each driver may be installed on the SiteScope machine. If there is more
that version is installed, SiteScope may report an error and be unable to connect to the
database.
n
The user specified in the Credentials section must be granted the permission to execute
SELECT queries to the following tables:
o
V$INSTANCE
o
V$STATNAME
o
V$SYSSTAT
o
V$SESSION
o
V$SESSTAT
o
V$PROCESS
o
DBA_DATA_FILES
o
DBA_FREE_SPACE
o
DBA_DATA_FILES
o
DBA_DATA_FILES
Configure the monitor properties
HP SiteScope (11.23)
Page 519 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Enable topology reporting - optional
3.
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "Oracle Database Topology" on page 517.
For user interface details, see "BSM Integration Data and Topology Settings" in the Using
SiteScope Guide.
How to Access Oracle Databases Using OCI Driver
You can monitor an Oracle database using an OCI driver. If the port or SID are changed, you only
need to make the change in the tnsnames.ora file (the SiteScope Oracle monitors remain
unchanged).
1. On the SiteScope server, install the version of Oracle client that you are using.
2. Connect to the Oracle database using the Oracle OCI driver.
n
Set ORACLE_HOME environment variable (ORACLE_HOME is the folder where the Oracle
client or database has been installed).
n
Add ORACLE_HOME\lib to System PATH (on Windows platforms), or LD_LIBRARY_
PATH env variable (on UNIX platforms).
n
Set CLASSPATH environment variable to use Oracle JDBC driver from ORACLE_
HOME\jdbc\lib.
3. In the \oracle\oraX\network\admin\tnsnames.ora file, configure the service name. You can
test this using a SQL+ tool or the SiteScope Database Connection tool (see Database
Connection Tool in the Using SiteScope Guide).
4. Add a database monitor within SiteScope, and configure the following settings in the Monitor
Settings panel:
n
Database connection URL: jdbc:oracle:oci8:@<service name>
n
Database driver: oracle.jdbc.driver.OracleDriver
n
Enter the database user credentials in the Database user name and Database password
boxes
HP SiteScope (11.23)
Page 520 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
UI Descriptions
Database Connection Settings
The Database Connection Settings enable you to retrieve, share, and reuse database connections
for database monitors that use any JDBC-compliant driver. When multiple database monitors use
the same database, using a connection pool instead of an open connection for each monitor
improves monitor performance and optimizes database server resource utilization.
Connections can be shared regardless of monitor type. For example, SiteScope database logger,
database tools (Database Connection, Database Information), database alerts, and database
monitors (Oracle Database, Database Counter, Database Query, DB2 8 and 9, Technology
Database Integration, and so forth) can share and reuse database connections in a connection pool.
User interface elements are described below:
UI Element
Description
Physically close if
idle connection
count exceeds
Maximum number of unused SQL connections in the SQL connection
pool. When this number is exceeded, unused connections are closed
rather than returned to the connection pool.
Default value: 10
Query timeout
Amount of time, in seconds/minutes/hours/days, to wait for execution of a
SQL statement. Not all SQL drivers have this function. If your SQL driver
does not support this function, this parameter is ignored.
Default value: 1 minute
Idle connection
timeout
Maximum amount of time, in seconds/minutes/hours/days, that a SQL
connection remains unused after it has been returned to the SQL
connection pool. When the time is exceeded, the connection is
automatically closed.
Default value: 5 minutes
Use connection
pool
Enables SQL connection sharing. This means that you use a connection
pool rather than open and close a new connection for each monitor query.
Default value: Selected
HP SiteScope (11.23)
Page 521 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
Oracle Database Monitor Settings
User interface elements are described below:
UI Element
Description
Database
connection URL
Connection URL to the database you want to connect to. The syntax is
jdbc:oracle:thin:@<server name or IP address>:<database
server port>;sid=<sid>.
Example: To connect to the ORCL database on a machine using port
1521, use:
jdbc:oracle:thin:@206.168.191.19:1521:ORCL.
Note: The colon (:) symbol must be included as shown.
Database driver
Driver used to connect to the database.
Example: oracle.jdbc.driver.OracleDriver
Credentials
Option for providing the user name and password to be used to access the
database server:
l
Use user name and password. Select this option to manually enter
user credentials. Enter the user name and password in the User name
and Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default
option). Select the credential profile to use from the Credential profile
drop-down list, or click Add Credentials and create a new credential
profile. For details on how to perform this task, see How to Configure
Credential Preferences in the Using SiteScope Guide.
Counters
Displays the server performance counters you want to check with this
monitor. Use the Get Counters button to select counters.
Get Counters
Opens the Select Counters Form, enabling you to select the counters you
want to monitor. For the list of counters that can be configured for this
monitor, see "Monitor Counters" on the next page.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 522 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
Monitor Counters
Below is the list of counters that can be configured for this monitor:
V$SYSSTAT and V$SESSTAT
supported using JDBC driver.
• active txn count during cleanout
• background checkpoints
completed
• background checkpoints started
• background timeouts
• branch node splits
• buffer is not pinned count
• buffer is pinned count
• bytes received via SQL*Net from
client
• bytes received via SQL*Net from
dblink
• bytes sent via SQL*Net to client
• bytes sent via SQL*Net to dblink
• Cached Commit SCN referenced
• calls to get snapshot scn:
kcmgss
• calls to kcmgas
• calls to kcmgcs
• calls to kcmgrs
• change write time
• cleanout - number of ktugct calls
• cleanouts and rollbacks consistent read gets
• cleanouts only - consistent read
gets
• cluster key scan block gets
• cluster key scans
• cold recycle reads
• commit cleanout failures: block
lost
• commit cleanout failures: buffer
being written
• commit cleanout failures:
callback failure
• commit cleanout failures: cannot
pin
• commit cleanout failures: hot
backup in progress
• commit cleanout failures: write
disabled
HP SiteScope (11.23)
• commit cleanouts
• commit cleanouts successfully
completed
• Commit SCN cached
• commit txn count during
cleanout
• consistent changes
• consistent gets
• consistent gets - examination
• CPU used by this session
• CPU used when call started
• CR blocks created
• current blocks converted for CR
• cursor authentications
• data blocks consistent reads undo records applied
• db block changes
• db block gets
• DBWR buffers scanned
• DBWR checkpoint buffers
written
• DBWR checkpoints
• DBWR cross instance writes
• DBWR free buffers found
• DBWR fusion writes
• DBWR lru scans
• DBWR make free requests
• DBWR revisited being-written
buffer
• DBWR summed scan depth
• DBWR transaction table writes
• DBWR undo block writes
• DDL statements parallelized
• deferred (CURRENT) block
cleanout applications
• deferred CUR cleanouts (index
blocks)
• DFO trees parallelized
• dirty buffers inspected
• DML statements parallelized
• enqueue conversions
• enqueue deadlocks
• enqueue releases
• enqueue requests
• enqueue timeouts
• enqueue waits
• exchange deadlocks
• execute count
• free buffer inspected
• free buffer requested
• gcs messages sent
• ges messages sent
• global cache blocks corrupt
• global cache blocks lost
• global cache claim blocks
lost
• global cache convert time
• global cache convert
timeouts
• global cache converts •
global cache cr block build
time
• global cache cr block flush
time
• global cache cr block receive
time
• global cache cr block send
time
• global cache cr blocks
received
• global cache cr blocks
served
• global cache current block
flush time
• global cache current block
pin time
• global cache current block
receive time
• global cache current block
send time
• global cache current blocks
received
• global cache current blocks
served
• global cache defers
• global cache freelist waits
• global cache get time
• global cache gets
• global cache prepare failures
• global cache skip prepare
failures
Page 523 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
• global lock async converts
• global lock async gets
• global lock convert time
• global lock get time
• global lock releases
• global lock sync converts
• global lock sync gets
• hot buffers moved to head of
LRU
• immediate (CR) block cleanout
applications
• immediate (CURRENT) block
cleanout applications
• immediate CR cleanouts
(index blocks)
• index fast full scans (direct read)
• index fast full scans (full)
• index fast full scans (rowid
ranges)
• index fetch by key
• index scans kdiixs1
• instance recovery database
freeze count
• kcmccs called get current scn
• kcmgss read scn without going
to GES
• kcmgss waited for batching
• leaf node 90-10 splits
• leaf node splits
• logons cumulative
• logons current
• messages received
• messages sent
• native hash arithmetic execute
• native hash arithmetic fail
• next scns gotten without going to
GES
• no buffer to keep pinned count
• no work - consistent read gets
• number of map misses
• number of map operations
• opened cursors cumulative
• opened cursors current
• opens of replaced files
• opens requiring cache
replacement
• OS All other sleep time
• OS Chars read and written
• OS Data page fault sleep time
• OS Input blocks
• OS Involuntary context switches
• OS Kernel page fault sleep time
• OS Major page faults
• OS Messages received
HP SiteScope (11.23)
• OS Swaps
• OS System call CPU time
• OS System calls
• OS Text page fault sleep time
• OS User level CPU time
• OS User lock wait sleep time
• OS Voluntary context switches •
OS Wait-cpu (latency) time
• OTC commit optimization
attempts
• OTC commit optimization
failure - setup
• OTC commit optimization hits
• Parallel operations
downgraded 1 to 25 pct
• Parallel operations
downgraded 25 to 50 pct
• Parallel operations
downgraded 50 to 75 pct
• Parallel operations
downgraded 75 to 99 pct
• Parallel operations
downgraded to serial
• Parallel operations not
downgraded
• parse count (failures)
• parse count (hard)
• parse count (total)
• parse time cpu
• parse time elapsed
• physical reads
• physical reads direct
• physical reads direct (lob)
• physical writes
• physical writes direct
• physical writes direct (lob)
• physical writes non checkpoint
• pinned buffers inspected
• prefetch clients - 16k
• prefetch clients - 2k
• prefetch clients - 32k
• prefetch clients - 4k
• prefetch clients - 8k
• prefetch clients - default
• prefetch clients - keep
• prefetch clients - recycle
• prefetched blocks
• prefetched blocks aged out
before use
• process last non-idle time
• PX local messages recv'd
• PX local messages sent
• PX remote messages recv'd
• PX remote messages sent
• redo blocks written
• redo buffer allocation retries
• redo entries
• redo log space requests
• redo log space wait time
• redo log switch interrupts
• redo ordering marks
• redo size
• redo synch time
• redo synch writes
• redo wastage
• redo write time
• redo writer latching time
• redo writes
• remote instance undo block
writes
• remote instance undo
header writes
• rollback changes - undo
records applied
• rollbacks only - consistent
read gets
• RowCR - row contention
• RowCR attempts
• RowCR hits
• rows fetched via callback
• serializable aborts
• session connect time
• session cursor cache count
• session cursor cache hits
• session logical reads
• session pga memory
• session pga memory max
• session stored procedure
space
• session uga memory
• session uga memory max
• shared hash latch upgrades no wait
• shared hash latch upgrades wait
• sorts (disk)
• sorts (memory)
• sorts (rows)
• SQL*Net roundtrips to/from
client
• SQL*Net roundtrips to/from
dblink
• summed dirty queue length
• switch current to new buffer
• table fetch by rowid
• table fetch continued row
• table lookup prefetch client
Page 524 of 926
Monitor Reference
Chapter 73: Oracle Database Monitor
• OS Messages sent
• OS Minor page faults
• OS Other system trap CPU time
• OS Output blocks
• OS Process heap size
• OS Process stack size
• OS Signals received
• queries parallelized
• recovery array read time
• recovery array reads
• recovery blocks read
• recursive calls
• recursive cpu usage
• transaction lock background get • transaction tables consistent
time
reads - undo records applied
• transaction lock background gets • Unnecesary process cleanup
for SCN batching • user calls
• transaction lock foreground
• user commits
requests
• user rollbacks
• transaction lock foreground wait • workarea executions time
multipass
• transaction rollbacks
• workarea executions - onepass
• transaction tables consistent
read rollbacks
• workarea executions - optimal
count
• table scan blocks gotten
• table scan rows gotten • table
scans (cache partitions)
• workarea memory allocated
• write clones created in
background
• write clones created in
foreground
• table scans (direct read)
• table scans (long tables)
• table scans (rowid ranges)
• table scans (short tables)
• total file opens
• total number of slots
Tips/Troubleshooting
General Notes/Limitations
l
If you are using a third-party database driver and you upgrade SiteScope, you must deploy the
driver to SiteScope again, since the driver configuration data is not saved during an upgrade.
l
For information about troubleshooting the Oracle Database monitor, refer to the HP Software
Self-solve Knowledge Base (http://support.openview.hp.com/selfsolve/document/KM189298).
To enter the knowledge base, you must log on with your HP Passport ID.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 525 of 926
Chapter 74: Ping Monitor
The Ping monitor enables you to check the availability of a host by using ICMP (Internet Control
Message Protocol). Use this monitor to check network connectivity and response time.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Ping monitor.
Learn About
This section includes:
l
"Ping Monitor Overview" below
l
"What to Monitor" below
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" on the next page
Ping Monitor Overview
The Ping monitor obtains two of the most common measurements used to determine if your
network connection is congested: Round Trip Time and Loss Percentage. An increase of either of
these suggests that you are experiencing problems.
In the case of Loss Percentage, you want to see a 0% reading. A 100% reading indicates your link
is completely down. Some loss may happen occasionally, but if it becomes common, either some
packets are being lost or the router is exceptionally busy and dropping packets.
Each time the Ping monitor runs, it returns a reading and a status message and writes them in the
monitoring log file. It also writes the total time it takes to receive a response from the designated
host in the log file.
What to Monitor
We recommend that you set up monitors that test your connection to the Internet at several
different points. For example, if you have a T1 connection to a network provider who in turn has a
connection to the backbone, you would want to set up a Ping monitor to test each of those
connections. The first monitor would ping the router on your side of the T1. The second would ping
the router on your provider's side of the T1. The third monitor would ping your provider's connection
to the backbone.
In addition to these monitors, it is also a good idea to have a couple of other monitors ping other
major network providers. These monitors do not really tell you whether the other provider is having a
problem, but it does tell you if your network provider is having trouble reaching them.
Supported Platforms/Versions
This monitor supports monitoring remote servers running on Windows operating systems. For the
supported Windows versions, see Operating Systems Supported for Monitoring Remote Windows
HP SiteScope (11.23)
Page 526 of 926
Monitor Reference
Chapter 74: Ping Monitor
Servers.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the ICMP protocol.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Ping Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Ping Tool is available when configuring this monitor to check if the host can be
reached, and the round-trip time along the path (provided you are an administrator in SiteScope,
or a user granted Use monitor tools permissions). To use the tool when configuring or editing
a monitor, click the Use Tool button. For details on the tool, see Ping Tool in the Using
SiteScope Guide.
UI Descriptions
Ping Monitor Settings
User interface elements are described below:
UI Element
Description
Host name to resolve
IP address or the name of the host that you want to monitor.
Example: 206.168.191.21 or demo.thiscompany.com
Note: You can monitor only one IP or host name at a time for each
monitor instance.
Packet size (bytes)
The size, in bytes (including the IP and ICMP headers), of the ping
packets sent. To change the threshold, enter the new value in the text
box.
Default value: 32 bytes
Time to wait for
replies before ping
timeouts
Amount of time, in milliseconds, that should pass before the ping times
out. To change the threshold, enter the new value in the text box.
Default value: 5000 milliseconds
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 527 of 926
Monitor Reference
Chapter 74: Ping Monitor
Tips/Troubleshooting
General Notes/Tips
You can monitor your own router as often as every two minutes without compromising system
performance. The monitors that watch your provider's connection to your line and to the backbone
should only be run every ten minutes or so. This minimizes traffic while still providing you with
sufficient coverage.
Troubleshooting and Limitations
If you are unable to ping a remote machine, there are several possible causes:
l
If you are trying to ping a host name, make sure the name you are pinging is fully qualified.
l
If pinging the fully qualified host name does not work, try pinging the IP address of the
destination machine. If ping fails when you try the name of the site, but works when you try the
IP address, it is a problem with DNS.
l
If pinging both the name and the IP address fail, it might be because they are administratively
denied by an access control list. Sometimes routers block ping with an access list. Try a
traceroute instead, or if it is a Web site, try browsing it.
l
If the traceroute shows multiple hops between you and the destination, try pinging each host in
the path. Start pinging the host closest to you, and work your way towards the destination until
you find the host that fails to respond to ping. Use a traceroute to get a list of the hosts between
you and the destination for this purpose.
l
The round trip time counter is both measured and displayed in the SiteScope Dashboard in
milliseconds; for all other monitors, it is measured in milliseconds and displayed in seconds.
HP SiteScope (11.23)
Page 528 of 926
Chapter 75: Port Monitor
The Port monitor verifies that a connection can be made to a network port and measures the length
of time it takes to make the connection. Optionally, it can look for a string of text to be returned or
send a string of text after the connection is made. You can use the Port monitor for monitoring
network applications that none of the other SiteScope monitors watch such as Gopher and IRC
services, some media services, or other custom network applications.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Port monitor.
Learn About
This section includes:
l
"Status" below
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" on the next page
Status
Each time the Port monitor runs, it returns a status message and writes it in the monitoring log file.
It also writes the total time it takes to receive a response from the remote service.
The reading is the current value of the monitor. The possible values for the Port monitor are:
l
OK
l
unknown host name
l
unable to reach server
l
unable to connect to server
l
timed out reading
l
match error
The status is logged as either good or error. An error status is returned if the current value of the
monitor is anything other than OK.
Supported Platforms/Versions
This monitor supports monitoring remote servers running on Windows operating systems. For the
supported Windows versions, see Operating Systems Supported for Monitoring Remote Windows
Servers.
HP SiteScope (11.23)
Page 529 of 926
Monitor Reference
Chapter 75: Port Monitor
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the TCP and UDP protocols.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
Tasks
How to Configure the Port Monitor
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Ping Tool is available when configuring this monitor to check if the host can be
reached, and the round-trip time along the path (provided you are an administrator in SiteScope,
or a user granted Use monitor tools permissions). To use the tool when configuring or editing
a monitor, click the Use Tool button. For details on the tool, see Ping Tool in the Using
SiteScope Guide.
UI Descriptions
Port Monitor Settings
User interface elements are described below:
UI
Element
Description
Host
name
IP address or the name of the host that you want to monitor.
Port
number
Port number to connect to from the list of Commonly used ports, or enter a port
number in the Other ports text box.
Example: 206.168.191.21 or demo.thiscompany.com
Additional entries can be added to the list by editing the <SiteScope root
directory>\groups\master.config file.
Timeout
Amount of time, in seconds, to wait for the connection to the port, and for any
(seconds) sending and receiving to complete. Once this time period passes, the Port monitor
logs an error and reports an error status.
Default value: 60 seconds
Send
string
Customizes the string sent to the host after a connection is made.
HP SiteScope (11.23)
Page 530 of 926
Monitor Reference
Chapter 75: Port Monitor
UI
Element
Description
Match
string
Checks for a string of text after a connection is made. If the text is not received, the
monitor displays the message no match on content.
Note:
l
The search is case sensitive.
l
You cannot use regular expressions in this field.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Supports both TCP and UDP (UDP requires additional configuration)
• Connection to port
• Connection time
Tips/Troubleshooting
Tips
Scheduling Port monitors depends on the application or system you are monitoring. The Port
monitor does not use many resources, so you can schedule it to run as often as every 15 seconds if
necessary. Monitoring most systems every 10 minutes is normally sufficient.
HP SiteScope (11.23)
Page 531 of 926
Chapter 76: Radius Monitor
The Radius (Remote Authentication Dial In User Service) monitor checks that a RADIUS server is
working correctly by sending an authentication request and checking the result. A RADIUS server
is used to authenticate users, often connecting through a remote connection such as a dialup
modem or a DSL line. If the RADIUS server fails, any users that try to use it are unable to log on
and access any services.
Create a separate monitor instance for each server you are running. You may want to set up
multiple monitors per server if you want to test different kinds of login accounts.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Radius monitor.
Learn About
Status
Each time the Radius monitor runs, it returns a status message and writes it in the monitoring log
file. It also writes the total time it takes to receive a authentication response. The reading is the
current value of the monitor. The possible values for the Radius monitor are:
l
OK
l
unknown host name
l
timed out reading
l
match error
The status is logged as either good or error. An error status is returned if the current value of the
monitor is anything other than OK.
Tasks
How to Configure the Radius Monitor
1. Prerequisites
n
For SiteScope to monitor your RADIUS server, you must first add the IP address of your
SiteScope server to the list of clients that the RADIUS server can communicate with. This
must be done for the Radius Server to take requests from SiteScope. Failure to do this
results in Unknown Client errors on the RADIUS server.
n
The Radius monitor currently supports Password Authentication Procedure (PAP)
authentication but not the Challenge Handshake Authentication Protocol (CHAP) or
HP SiteScope (11.23)
Page 532 of 926
Monitor Reference
Chapter 76: Radius Monitor
Microsoft Challenge Handshake Authentication Protocol (MS-CHAP). Your RADIUS server
must be configured to accept PAP requests to use this monitor.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
UI Descriptions
Radius Monitor Settings
User interface elements are described below:
UI
Element
Description
Radius
server
IP address or the name of the RADIUS server that you want to monitor.
Secret
phrase
Secret used to encrypt all requests to this RADIUS server.
User
name
User name to authenticate.
Example: 206.168.191.21 or radius.thiscompany.com
Password Password to authenticate.
Called
Station Id
Telephone number on which the call was received. For virtual private network (VPN)
connections, the IP address of the VPN server.
Calling
Station Id
Telephone number from which the call was made. For virtual private network (VPN)
connections, the IP address of the VPN client.
Port
UDP port used by the RADIUS server.
Default value: 1812
Timeout
(seconds)
Amount of time, in seconds, to wait for the connection to the port, and for any
sending and receiving to complete.
Once this time period passes, the Radius monitor logs an error and reports an error
status.
Default value: 30 seconds
HP SiteScope (11.23)
Page 533 of 926
Monitor Reference
Chapter 76: Radius Monitor
UI
Element
Description
Match
content
Text string to check for in the response. If the text is not contained in the response,
the monitor displays the message no match on content.
You can also perform a regular expression match by enclosing the string in forward
slashes, with an i after the trailing slash indicating case-insensitive matching.
Example: / \d\d/ or /size \d\d/i
Note: The search is case sensitive.
Open
Tool
Opens the Regular Expression Tool, enabling you to test a regular expression for
content matching against a sample of the content you want to monitor. For details,
see Regular Expression Tool in the Using SiteScope Guide.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
Authentication request
• match value
• round trip time
• status
HP SiteScope (11.23)
Page 534 of 926
Chapter 77: Real Media Player Monitor
Use the Real Media Player monitor to monitor availability and delivery quality parameters for media
files and streaming data compatible with RealNetworks Real Media Player.
You can monitor multiple parameters or counters with a single monitor instance. This enables you
to report on delivery performance. Create a separate monitor instance for files or data streams that
are representative of the content available from the site you want to monitor. The error and warning
thresholds for the monitor can be set on one or more Real Media Player performance statistics.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Real Media Player monitor.
Learn About
Supported Platforms/Versions
l
This monitor is supported in SiteScopes that are running on Windows versions only.
l
This monitor does not work with the 64-bit version of SiteScope, so if you plan to work with this
monitor, it is recommended to install the SiteScope 32-bit version.
l
This monitor supports monitoring RealNetworks Real Media Player versions 7.x, 8.x, 9.x, and
10.x
l
This monitor does not support metadata files such as the .smi format.
Tasks
How to Configure the Real Media Player Monitor
1. Prerequisites
Before you can use the Real Media Player monitor, Real Media Player client libraries must be
installed on the server where SiteScope is running. Normally, it is sufficient to download and
install a Real Media Player client on the server.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Tip: The Real Media Player Tool is available when configuring this monitor (provided
you are an administrator in SiteScope, or a user granted Use monitor tools permissions).
To use the tool when configuring or editing a monitor, click the Use Tool button. For
details on the tool, see Real Media Player Tool in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 535 of 926
Monitor Reference
Chapter 77: Real Media Player Monitor
UI Descriptions
Real Media Player Monitor Settings
User interface elements are described below:
UI Element
Description
URL
URL of the media file or streaming source you want to monitor. This should be
the URL of the media file.
Note:
Counters
l
Only monitor video, not audio, streams with this monitor.
l
This monitor does not support metadata files such as the .smi format.
Select the server performance counters you want to check with this monitor.
For the list of counters that can be configured for this monitor, see "Monitor
Counters" below.
Duration
Playback duration that the monitor should use for the media file or source. The
(milliseconds) duration value does not need to match the duration of the media contained in
the file.
If the media content of the file or source you are monitoring is less than the
duration value selected for the monitor, the monitor plays the entire media
content and reports the results, including the time required to play the media
content.
Default value: 15,000 milliseconds
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• bandwidth
• buffering congestion num
• buffering congestion time
• buffering num
• buffering seek num
• buffering seek time
• buffering time
• first frame time
• late packets
• live pause num
• live pause time
• lost packets
• network performance
HP SiteScope (11.23)
Page 536 of 926
Monitor Reference
Chapter 77: Real Media Player Monitor
• recovered packets
• stream quality
HP SiteScope (11.23)
Page 537 of 926
Chapter 78: Real Media Server Monitor
Use the Real Media Server monitor to monitor the server performance parameters for
RealNetworks Real Media Servers. You can monitor multiple parameters or counters with a single
monitor instance. This enables you to watch server loading for performance, availability, and
capacity planning. Create a separate monitor instance for each RealSystem Server you are
running.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the Real Media Server monitor.
Learn About
This section includes:
l
"Supported Platforms/Versions" below
l
"IPv6 Addressing Supported Protocols" below
Supported Platforms/Versions
This monitor is supported in SiteScopes running on Windows platforms, and on UNIX versions if
the remote server being monitored has been configured for SSH. For details, see SiteScope
Monitoring Using Secure Shell (SSH) in the Using SiteScope Guide.
IPv6 Addressing Supported Protocols
When Prefer IP version 6 addresses is enabled in SiteScope (Preferences > Infrastructure
Preferences > Server Settings), this monitor supports the following protocols:
l
NetBIOS (from SiteScope installed on Windows platforms only)
l
WMI (from SiteScope installed on Windows platforms only)
Note: When specifying a literal IPv6 address as the name for the monitored remote server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text ".ipv6-literal.net" to the IP address.
For example, the IPv6 address: 2004:DB8:2a:1005:230:48ff:fe73:982d
would be: 2004-DB8-2a-1005-230-48ff-fe73-982d.ipv6-literal.net
Alternatively, you can switch to the WMI connection method, and avoid having to make
changes to the IPv6 address.
For details on using IPv6, see Support for IP Version 6 in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 538 of 926
Monitor Reference
Chapter 78: Real Media Server Monitor
Tasks
How to Configure the Real Media Server Monitor
1. Prerequisites
The Real Media Server monitor makes use of Performance Counters to measure application
server performance. SiteScopes running on Windows platforms need to be running under an
account that has the necessary administrative security privileges to access performance
counter data from remote servers. If the servers you want to monitor are in a different domain,
are governed under a different policy, or require a unique login different than the account
SiteScope is running under, then you must define the connection to these servers under the
Microsoft Windows Remote Servers option in the remote server view. For SiteScopes installed
on UNIX platforms, you only need to define the connection to these servers under the
Microsoft Windows Remote Servers option in the remote server view.
2. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Note: By default, SiteScope monitors the Real Media Server default service, RMServer.
To monitor other services, add the service names (separated by commas) to the Real
Media Server monitor service names box in Preferences > Infrastructure
Preferences > Monitor Settings.
HP SiteScope (11.23)
Page 539 of 926
Monitor Reference
Chapter 78: Real Media Server Monitor
UI Descriptions
Real Media Server Monitor Settings
User interface elements are described below:
UI
Element
Server
Description
Name of the server you want to monitor. Select a server from the server list (only
those Windows remote servers that have been configured in SiteScope are
displayed). Alternatively, click the Browse Servers button to select a server from
the local domain, or Add Remote Server to add a new server.
Note:
l
This monitor supports WMI (Windows Management Instrumentation) as a
method for gathering statistics. Remote servers that have been configured with
the WMI method are also displayed in the server list. For details, see Configure
the WMI Service for Remote Monitoring in the Using SiteScope Guide.
l
When working in template mode, you can use the template remote server (if one
was created) without having to enter its name, by selecting the Use already
configured template remote under current template check box.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the
server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor.
Note: To monitor a remote Windows server, you must have domain privileges or
authenticated access to the remote server. For details on how to configure a remote
Windows server, see How to Configure SiteScope to Monitor a Remote Microsoft
Windows Server in the Using SiteScope Guide.
Add
Remote
Server
Opens the Add Microsoft Windows Remote Server dialog box, enabling you to enter
the configuration details. For user interface details, see New/Edit Microsoft
Windows Remote Server Dialog Box in the Using SiteScope Guide.
HP SiteScope (11.23)
Page 540 of 926
Monitor Reference
Chapter 78: Real Media Server Monitor
UI
Element
Description
Counters Displays the server performance counters you want to check with this monitor. Use
the Get Counters button to select counters.
Note when working in template mode: To update counters in template browsable
monitors that need a target server, click the Select measurement from button and
add the required server and counters. Any server that is accessible in the domain
can be used. If a server is not in the domain, you must manually add the server to the
remote server tree before adding counters, and then specify the newly created server
name in the Server field.
Get
Opens the Select Counters Form, enabling you to select the counters you want to
Counters monitor. For the list of counters that can be configured for this monitor, see "Monitor
Counters" below.
Note: For information on configuring setting panels that are common to all monitors, see
Common Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
• Encoder Connections
• HTTP Clients
• Monitor Connections
• Multicast Connections
• PNA Clients
• RTSP Clients
• Splitter Connections
• TCP Connections
• Total Bandwidth
• Total Clients
• UDP Clients
Tips/Troubleshooting
General Notes/Limitations
l
When configuring this monitor in template mode, the Browse Servers and Add Remote Server
buttons are not displayed, and some fields that contain drop-down lists may be displayed as text
boxes.
l
When deploying this monitor using a template, an error message is displayed if you clear the
Verify monitor properties with remote server check box in the Deployment Values dialog
box.
HP SiteScope (11.23)
Page 541 of 926
Chapter 79: SAP CCMS Monitor
The SAP CCMS monitor enables you to monitor the performance of your SAP R/3 System
landscape in a centralized manner using SAP's centralized monitoring architecture, CCMS
(Computer Center Management System).
Note:
l
This monitor requires the SAP R/3 Application Server solution template to enable it in the
SiteScope interface. For solution template details, see SAP Solution Templates. Contact
your HP Sales representative for solution template licensing information.
l
This monitor is available without additional licensing during the free trial period when using a
trial license, and when using SiteScope Freemium.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the SAP CCMS monitor.
Learn About
This section includes:
l
"SAP CCMS Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"SAP CCMS Topology" on the next page
SAP CCMS Monitor Overview
Use the SAP CCMS monitor to retrieve and report metrics using SAP's centralized monitoring
architecture, CCMS. With CCMS, a SAP administrator can monitor all servers, components and
resources in the SAP landscape from a single centralized server, greatly facilitating not only
problem discovery but also problem diagnosis.
Using the SAP CCMS monitor, you can also enable reporting of the host topology to BSM. If
enabled, BSM automatically populates the RTSM with CIs based on the monitored hardware in
SiteScope.
Using SAP's advanced CCMS interface BC-XAL 1.0, the SiteScope SAP CCMS monitor exposes
hundreds of performance and availability metrics. The error and warning thresholds for the monitor
can be set for one or more of the nearly 120 SAP server performance statistics available by using
the CCMS interface.
Supported Platforms/Versions
This monitor supports monitoring all servers, components and resources in the R/3 4.6B, R/3 4.6C,
R/3 4.7E, SAP ECC5 and SAP ECC6 landscape.
HP SiteScope (11.23)
Page 542 of 926
Monitor Reference
Chapter 79: SAP CCMS Monitor
SAP CCMS Topology
The SAP CCMS monitor can identify the topology of the SAP System being monitored. The monitor
creates the following topology in BSM's RTSM.
The CIs are created only for the monitored entities according to the counters that you select. The
monitors are represented in the RTSM as SiteScope Measurement Groups and SiteScope
Measurement CIs.
Note:
l
This direct integration between SiteScope and BSM is available only when the Application
Management for SAP license is installed.
l
When you add a new application server to the SAP System, you must clear the Report
monitor and related CI topology option, save the monitor definition, and then select the
HP SiteScope (11.23)
Page 543 of 926
Monitor Reference
Chapter 79: SAP CCMS Monitor
option again and save the monitor definition, in order for the monitor to recognize the new
application server.
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to BSM, see Reporting Discovered
Topologies to BSM in the Using SiteScope Guide.
For information about the SAP topology, see SAP Systems View in the BSM User Guide in the
BSM Help.
Tasks
How to Configure the SAP CCMS Monitor
1. Prerequisites
n
This monitor requires the SAP R/3 Application Server solution template to enable it in the
SiteScope interface after the free evaluation period expires, or when not using SiteScope
Freemium. Contact your HP Sales representative for more information.
n
Before configuring the monitor, make sure you have the necessary setup requirements and
user privileges to log on to the CCMS server and retrieve metrics.
o
Consult your SAP documentation to determine if your R/3 landscape components
requires additional software installed to run or work with CCMS.
Note: The BC-XAL 1.0 interface is supported on R/3 systems 4.5B and later only.
o
You must have SAP authorization of the remote system user. For details on the
minimum SAP permission required by SiteScope, see the sections on “AAAB - Crossapplication Authorization Objects” and “BC_A - Basis: Administration” in SAP RFC User
privileges in the SAP documentation (http://help.sap.com/saphelp_
nw73/helpdata/de/49/bb35b8623a489aa63abd9f5ebf2448/content.htm).
Alternatively, you can set certain privileges for SAP user to read CCMS metrics. When
defining a SAP CCMS monitor in SiteScope you must specify a user who has XMI
authorization to be able to log on to the CCMS server and retrieve metrics. The user
should have one or more of the profiles listed below assigned to it. Authorizations are
collected in SAP profiles, and the following profiles include XMI authorization:
o
S_A.SYSTEM
o
PD_CHICAGO
HP SiteScope (11.23)
Page 544 of 926
Monitor Reference
Chapter 79: SAP CCMS Monitor
o
S_WF_RWTEST
o
SAP_ALL
One test to see if a user has such authorization is to try and issue transaction RZ20 in
the SAP user interface and see if the CCMS monitor sets can be displayed.
n
The compat-libstdc++ package is required for Amazon Linux to resolve dependencies
between SAP and Amazon Linux system libraries.
2. Download the SAP Java Connector
The SAP Java Connector (SAP JCo version 2.1.5 or later) component must be downloaded
and installed on the same server where SiteScope is running (or at least be accessible on a
shared or remote location).
a. To download SAP Java Connector, go to the SAP Software Distribution Web site
(http://www.service.sap.com/connectors).
Note: You need a valid Service Marketplace login to access the SAP Web site
b. After you log on, select SAP NetWeaver > SAP NetWeaver in Detail > Application
Platform > Connectivity > Connectors > SAP Java Connector, and then click Tools
and Services.
3. Enable the SAP CCMS monitor
The SAP CCMS monitor uses SAP JCo libraries to connect to the SAP R/3 system. A user
must have the required license granted by SAP to receive and use these libraries.
a. Download the following .jar file and .dll files from the SAP support Web site
(http://www.service.sap.com/connectors):
On a Windows environment:
File
Copy to...
sapjco.jar
<SiteScope root directory>\WEB-INF\lib
librfc32.dll
<SiteScope root directory>\bin
sapjcorfc.dll Note: If the .dll files already exist in the
<Windows installation directory>\system32 directory (they may have
been copied into this directory as part of the SAP client installation), you
must overwrite them with these .dll files before copying them into the
SiteScope directory.
HP SiteScope (11.23)
Page 545 of 926
Monitor Reference
Chapter 79: SAP CCMS Monitor
On a UNIX environment:
File
Copy to...
sapjco.jar
<SiteScope root directory>/WEB-INF/lib
Note: JCO native libraries must be copied to /usr/lib for 32-bit
platforms and to /usr/lib64 for 64-bit platforms. To check that a JCO
connector is installed correctly, run the following command:
/opt/HP/SiteScope/java/bin/java -jar
/opt/HP/SiteScope/WEB-INF/lib/sapjco.jar
librfccm.so
o
For Sun installations:
<SiteScope root directory>/java/lib/sparc
o
For Linux installations:
libsapjcorfc.so
/usr/lib for 32-bit platforms and /usr/lib64 for 64-bit platforms.
b. Restart SiteScope.
4. Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
5. Enable topology reporting - optional
To enable topology reporting, make sure that Report monitor and related CI topology is
selected in HP Integration Settings (the default setting). For details on the monitor topology,
see "SAP CCMS Topology" on page 543.
For user interface details, see BSM Integration Data and Topology Settings in the Using
SiteScope Guide.
UI Descriptions
SAP CCMS Monitor Settings
User interface elements are described below:
UI Element
Description
Application Address of the SAP server you want to monitor.
server
SAP client
Client to use for connecting to SAP.
System
number
System number for the SAP server.
HP SiteScope (11.23)
Page 546 of 926
Monitor Reference
Chapter 79: SAP CCMS Monitor
UI Element
Description
SAP router
string
Router address string if your connection is being made through a router (otherwise
leave it blank).
You can find the router address using the SAP Logon tool from the SAP Client
software. Open the Logon console, select the server you want to monitor and then
select Properties to view the router address.
Credentials
Option for providing the user name and password to access the SAP server:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password to access the SAP server in
the User name and Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default option).
Select the credential profile to use from the Credential profile drop-down list,
or click Add Credentials and create a new credential profile. For details on
how to perform this task, see How to Configure Credential Preferences in the
Using SiteScope Guide.
CCMS
monitor
sets match
Enter a regular expression to match the SAP CCMS monitor sets you want to
view (top level nodes of the CCMS tree). Only counters of matched tree sets are
requested from SAP and displayed in the counter tree. To change the match, you
must reload the counters. If the field is empty, all monitor sets are shown.
Collect all
types of
counters
Select to enable the monitor to collect all other types of counters in addition to
collecting SAP performance counters.
Counters
Displays the server performance counters selected for this monitor. Use the Get
Counters button to select counters.
Get
Counters
Opens the Select Counters Form, enabling you to select the counters you want to
monitor. This tree displays the hierarchy of Monitoring Tree Elements that is
shown in the SAP user interface with transaction RZ20. The information in the
SiteScope browse tree may differ slightly from that in RZ20 depending on the
authorization level of the user name you specified for this monitor. For details, see
http://help.sap.com/saphelp_
nw04/helpdata/en/6b/e14d3bf5d70c30e10000000a11402f/content.htm.
Note: If this option is selected, it is recommended to use CCMS monitor sets
match to prevent performance capacity problems.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Note: For information on configuring setting panels that are common to all monitors, see
HP SiteScope (11.23)
Page 547 of 926
Monitor Reference
Chapter 79: SAP CCMS Monitor
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Notes/Tips
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
Troubleshooting and Limitations
l
The SAP CCMS monitor only retrieves and displays numeric metrics (Performance attributes).
Status, Log and Information attributes are not supported. Also, presentation and management of
SAP CCMS Alerts in SiteScope are not supported at this time.
l
The compat-libstdc++ package is required for Amazon Linux to resolve dependencies between
SAP and Amazon Linux system libraries
l
Due to the large amount of metrics that are retrieved when displaying the entire SAP metrics
browse tree during monitor definition, there could be a delay in opening the Choose Counters
page. However, after a browse tree has been successfully retrieved, it is cached to file
automatically, so that the next time you retrieve metrics from the same server/user name, the
wait time is greatly reduced.
HP SiteScope (11.23)
Page 548 of 926
Chapter 80: SAP CCMS Alerts Monitor
Use the SAP CCMS Alerts monitor to retrieve and report alerts from the SAP CCMS monitors
using SAP's centralized monitoring architecture, CCMS (Computer Center Management System).
The SAP CCMS Alerts monitor retrieves alerts using SAP's advanced CCMS interface BC-XAL
1.0.
Note:
l
This monitor requires the SAP R/3 Application Server solution template to enable it in the
SiteScope interface. For solution template details, see SAP Solution Templates. Contact
your HP Sales representative for solution template licensing information.
l
This monitor is available without additional licensing during the free trial period when using a
trial license, and when using SiteScope Freemium.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select the SAP CCMS monitor.
Learn About
Supported Platforms/Versions
This monitor enables supports monitoring alerts for various components of your SAP R/3 4.6B, R/3
4.6C, R/3 4.7E, and SAP ECC5 and ECC6 landscape.
Tasks
How to Configure the SAP Alerts CCMS Monitor
1.
Prerequisites
n
This monitor requires the SAP R/3 Application Server solution template to enable it in the
SiteScope interface after the free evaluation period expires, or when not using SiteScope
Freemium. Contact your HP Sales representative for more information.
n
Before configuring the monitor, make sure you have the necessary setup requirements and
user privileges to log on to the CCMS server and retrieve metrics.
o
The SAP Java Connector (SAP JCo 2.1.5 and later) component must be downloaded
from the SAP Service Marketplace Software Distribution Center, and installed on the
same server where SiteScope is running (or at least be accessible on a shared or remote
location).
o
The BC-XAL 1.0 interface is supported on R/3 systems 4.5B and later only.
HP SiteScope (11.23)
Page 549 of 926
Monitor Reference
Chapter 80: SAP CCMS Alerts Monitor
o
Consult your SAP documentation to determine if your R/3 landscape components
requires additional software installed to run or work with CCMS.
o
You must have SAP authorization of the remote system user. For details on the
minimum SAP permission required by SiteScope, see the sections on “AAAB - Crossapplication Authorization Objects” and “BC_A - Basis: Administration” in SAP RFC User
privileges in the SAP documentation (http://help.sap.com/saphelp_
nw73/helpdata/de/49/bb35b8623a489aa63abd9f5ebf2448/content.htm).
Alternatively, you can set privileges to enable a SAP user to read CCMS metrics. When
defining a SAP CCMS monitor in SiteScope you must specify a user who has XMI
authorization to be able to log on to the CCMS server and retrieve metrics. The user
should have one or more of the profiles listed below assigned to it. Authorizations are
collected in SAP profiles, and the following profiles include XMI authorization:
o
S_A.SYSTEM
o
PD_CHICAGO
o
S_WF_RWTEST
o
SAP_ALL
One test to see if a user has such authorization is to try and issue transaction RZ20 in
the SAP user interface and see if the CCMS monitor sets can be displayed.
n
2.
The compat-libstdc++ package is required for Amazon Linux to resolve dependencies
between SAP and Amazon Linux system libraries.
Download the SAP Java Connector
The SAP Java Connector (SAP JCo version 2.0.6 or later) component must be downloaded
and installed on the same server where SiteScope is running (or at least be accessible on a
shared or remote location).
a. To download SAP Java Connector, go to the SAP Software Distribution Web site
(http://www.service.sap.com/connectors).
Note: You need a valid Service Marketplace login to access the SAP Web site
b. After you log on, select SAP NetWeaver > SAP NetWeaver in Detail > Application
Platform > Connectivity > Connectors > SAP Java Connector, and then click Tools
and Services.
3.
Enable the SAP CCMS Alerts monitor
The SAP CCMS Alerts monitor uses SAP JCo libraries to connect to the SAP R/3 system. A
user must have the required license granted by SAP to receive and use these libraries.
HP SiteScope (11.23)
Page 550 of 926
Monitor Reference
Chapter 80: SAP CCMS Alerts Monitor
a. Download the following files from the SAP support Web site
(http://www.service.sap.com/connectors):
On a Windows environment:
File
Copy to...
sapjco.jar
<SiteScope root directory>\WEB-INF\lib
librfc32.dll
<SiteScope root directory>\bin
sapjcorfc.dll Note: If the .dll files already exist in the
<Windows installation directory>\system32 directory (they may have
been copied into this directory as part of the SAP client installation), you
must overwrite them with these .dll files before copying them into the
SiteScope directory.
On a UNIX environment:
File
Copy to...
sapjco.jar
<SiteScope root directory>/WEB-INF/lib
Note: JCO native libraries must be copied to /usr/lib for 32-bit
platforms and to /usr/lib64 for 64-bit platforms. To check that a JCO
connector is installed correctly, run the following command:
/opt/HP/SiteScope/java/bin/java -jar
/opt/HP/SiteScope/WEB-INF/lib/sapjco.jar
librfccm.so
o
For Sun installations:
<SiteScope root directory>/java/lib/sparc
o
For Linux installations:
libsapjcorfc.so
/usr/lib for 32-bit platforms and /usr/lib64 for 64-bit platforms.
b. Restart SiteScope.
4.
Configure the monitor properties
Configure the monitor properties as described in the UI Descriptions section below.
Note: Although you can change the run schedule for this monitor using the Frequency
setting in Monitor Run Settings (the default is every 10 minutes), CCMS metrics are
generally only updated once every 5 minutes.
HP SiteScope (11.23)
Page 551 of 926
Monitor Reference
Chapter 80: SAP CCMS Alerts Monitor
UI Descriptions
SAP CCMS Alerts Monitor Settings
User interface elements are described below:
UI Element
Description
Application Host name/IP address of the SAP server you want to monitor.
server
SAP client
Client to use for connecting to SAP.
System
number
System number for the SAP server.
SAP router
string
Router address string if your connection is being made through a router (otherwise
leave it blank).
You can find the router address using the SAP Logon tool from the SAP Client
software. Open the Logon console, select the server you want to monitor and then
select Properties to view the router address.
Credentials
Option for providing the user name and password to access the SAP CCMS
metrics:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password to access the SAP server in
the User name and Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password (default option).
Select the credential profile to use from the Credential profile drop-down list,
or click Add Credentials and create a new credential profile. For details on
how to perform this task, see How to Configure Credential Preferences in the
Using SiteScope Guide.
Counters
Displays the server performance counters selected for this monitor. Use the Get
Counters button to select counters.
Get
Counters
Opens the Select Counters Form, enabling you to select the counters you want to
monitor. For details, see http://help.sap.com/saphelp_
nw04/helpdata/en/6b/e14d3bf5d70c30e10000000a11402f/content.htm.
Note when working in template mode: The maximum number of counters that
you can select is 100. If you import a template monitor from an earlier version of
SiteScope, or perform a copy to template action, the number of counters is not
limited.
Note: For information on configuring setting panels that are common to all monitors, see
HP SiteScope (11.23)
Page 552 of 926
Monitor Reference
Chapter 80: SAP CCMS Alerts Monitor
Common Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Notes/Limitations
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server check box in the Deployment Values dialog box.
HP SiteScope (11.23)
Page 553 of 926
Chapter 81: SAP Java Web Application Server
Monitor
Use the SiteScope SAP Java Web Application Serve