HPE SiteScope - Monitor Reference

HPE SiteScope - Monitor Reference
HPE SiteScope
Software Version: 11.33
Monitor Reference
Document Release Date: April 2017
Software Release Date: December 2016
Monitor Reference
Legal Notices
Warranty
The only warranties for Hewlett Packard Enterprise 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. HPE 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 HPE 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 - 2017 Hewlett Packard Enterprise Development LP
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
Software Version number, which indicates the software version.
l
Document Release Date, which changes each time the document is updated.
l
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:
https://softwaresupport.hpe.com/group/softwaresupport/search-result?keyword=.
This site requires an HPE Passport account. If you do not have one, click the Create an account button on the HPE
Passport Sign in page.
Support
Visit the HPE Software Support website at: https://softwaresupport.hpe.com
This website provides contact information and details about the products, services, and support that HPE Software
offers.
HPE Software 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 website to:
l
Search for knowledge documents of interest
l
Submit and track support cases and enhancement requests
l
Download software patches
l
Manage support contracts
l
Look up HPE support contacts
l
Review information about available services
l
Enter into discussions with other software customers
l
Research and register for software training
HPE SiteScope (11.33)
Page 2 of 924
Monitor Reference
Most of the support areas require that you register as an HPE Passport user and sign in. Many also require a
support contract. To register for an HPE Passport ID, go to https://softwaresupport.hpe.com and click Register.
To find more information about access levels, go to:
https://softwaresupport.hpe.com/web/softwaresupport/access-levels
HPE Software Integrations and Solutions
Visit the Integrations and Solutions Catalog at https://softwaresupport.hpe.com/km/KM01702731 to explore how
the products in the HPE Software catalog work together, exchange information, and solve business needs.
HPE SiteScope (11.33)
Page 3 of 924
Monitor Reference
Contents
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
18
Chapter 4: Supported Versions and Platforms
34
Part 2: SiteScope Monitors (A-Z)
49
Chapter 5: Active Directory Replication Monitor
50
Chapter 6: Amazon Web Services Monitor
53
Chapter 7: Apache Server Monitor
60
Chapter 8: Azure Monitor
65
Chapter 9: BroadVision Application Server Monitor
73
Chapter 10: Browsable Windows Performance Counter Monitor
77
Chapter 11: Check Point Monitor
79
Chapter 12: Cisco Works Monitor
81
Chapter 13: Citrix Monitor
86
Chapter 14: ColdFusion Server Monitor
91
Chapter 15: COM+ Server Monitor
95
Chapter 16: Composite Monitor
98
Chapter 17: CPU Monitor
101
Chapter 18: Custom Monitor
105
Chapter 19: Custom Database Monitor
118
Chapter 20: Custom Log File Monitor
136
Chapter 21: Custom WMI Monitor
158
Chapter 22: Database Counter Monitor
174
Chapter 23: Database Query Monitor
182
Chapter 24: DB2 JDBC Monitor
195
Chapter 25: DHCP Monitor
201
Chapter 26: Directory Monitor
203
Chapter 27: Disk Space Monitor (Deprecated)
207
Chapter 28: DNS Monitor
211
Chapter 29: Dynamic Disk Space Monitor
214
Chapter 29: Dynamic Docker Monitor
223
Chapter 30: Dynamic JMX Monitor
249
Chapter 31: e-Business Transaction Monitor
264
Chapter 32: F5 Big-IP Monitor
268
HPE SiteScope (11.33)
Page 4 of 924
Monitor Reference
Chapter 33: File Monitor
274
Chapter 34: Formula Composite Monitor
279
Chapter 35: FTP Monitor
283
Chapter 36: Generic Hypervisor Monitor
288
Chapter 37: Hadoop Monitor
295
Chapter 38: HAProxy Monitor
308
Chapter 39: HP iLO (Integrated Lights-Out) Monitor
311
Chapter 40: HP NonStop Event Log Monitor
315
Chapter 41: HP NonStop Resources Monitor
319
Chapter 42: HP Vertica JDBC Monitor
323
Chapter 43: IPMI Monitor
334
Chapter 44: JMX Monitor
336
Chapter 45: KVM Monitor
347
Chapter 46: LDAP Monitor
356
Chapter 47: Link Check Monitor
360
Chapter 48: Log File Monitor
363
Chapter 49: Mail Monitor
375
Chapter 50: MAPI Monitor
379
Chapter 51: Memcached Statistics Monitor
384
Chapter 52: Memory Monitor
386
Chapter 53: Microsoft ASP Server Monitor
391
Chapter 54: Microsoft Exchange Monitor
396
Chapter 55: Microsoft Exchange Base Monitor
403
Chapter 56: Microsoft Exchange 2000/2003/2007 Message Traffic Monitor
421
Chapter 57: Microsoft Exchange 5.5 Message Traffic Monitor (Deprecated)
424
Chapter 58: Microsoft Exchange 2003 Mailbox Monitor (Deprecated)
426
Chapter 59: Microsoft Exchange 2003 Public Folder Monitor (Deprecated)
429
Chapter 60: Microsoft Hyper-V Monitor
431
Chapter 61: Microsoft IIS Server Monitor
438
Chapter 62: Microsoft Lync Server 2010 Monitors
445
Chapter 63: Microsoft SQL Server Monitor
459
Chapter 64: Microsoft Windows Dial-up Monitor (Deprecated)
466
Chapter 65: Microsoft Windows Event Log Monitor
470
Chapter 66: Microsoft Windows Media Player Monitor (Deprecated)
479
Chapter 67: Microsoft Windows Media Server Monitor
482
Chapter 68: Microsoft Windows Performance Counter Monitor
486
Chapter 69: Microsoft Windows Resources Monitor
490
Chapter 70: Microsoft Windows Services State Monitor
497
Chapter 71: Multi Log Monitor
502
Chapter 72: Network Bandwidth Monitor
511
Chapter 73: News Monitor
516
HPE SiteScope (11.33)
Page 5 of 924
Monitor Reference
Chapter 74: Oracle 10g Application Server Monitor
519
Chapter 75: Oracle 9i Application Server Monitor(This monitor is not supported for 9i running on
Tru64 Unix operating system)
526
Chapter 76: Oracle Database Monitor
529
Chapter 77: Ping Monitor
538
Chapter 78: Port Monitor
541
Chapter 79: Radius Monitor
544
Chapter 80: Real Media Player Monitor (Deprecated)
547
Chapter 81: Real Media Server Monitor
549
Chapter 82: REST API Monitor
553
Chapter 83: SAP CCMS Monitor
561
Chapter 84: SAP CCMS Alerts Monitor
567
Chapter 85: SAP Java Web Application Server Monitor
571
Chapter 86: SAP MAI Alert Monitor
575
Chapter 87: SAP Performance Monitor
582
Chapter 88: SAP Work Processes Monitor
588
Chapter 89: Script Monitor
594
Chapter 90: Service Monitor
603
Chapter 91: Siebel Application Server Monitor
609
Chapter 92: Siebel Log File Monitor
618
Chapter 93: Siebel Web Server Monitor
622
Chapter 94: SNMP Monitor
629
Chapter 95: SNMP by MIB Monitor
636
Chapter 96: SNMP Trap Monitor
642
Chapter 97: Solaris Zones Monitor
645
Chapter 98: SunONE Web Server Monitor
652
Chapter 99: Sybase Monitor (Deprecated)
656
Chapter 100: Syslog Monitor
659
Chapter 101: Tuxedo Monitor (Deprecated)
665
Chapter 102: UDDI Monitor
669
Chapter 103: UNIX Resources Monitor
670
Chapter 104: URL Monitor
675
Chapter 105: URL Content Monitor
689
Chapter 106: URL List Monitor
702
Chapter 107: URL Sequence Monitor
711
Chapter 108: VMware Datastore Monitor
735
Chapter 109: VMware Host Monitors
746
Chapter 110: VMware Performance Monitor
768
Chapter 111: Web Script Monitor
785
Chapter 112: Web Server Monitor
796
Chapter 113: Web Service Monitor
799
HPE SiteScope (11.33)
Page 6 of 924
Monitor Reference
Chapter 114: WebLogic Application Server Monitor
809
Chapter 115: WebSphere Application Server Monitor
815
Chapter 116: WebSphere MQ Status Monitor
838
Chapter 117: WebSphere Performance Servlet Monitor
847
Chapter 118: XML Metrics Monitor
851
Part 3: Integration Monitors (A-Z)
855
Chapter 119: HP OM Event Monitor
856
Chapter 120: HP Service Manager Monitor
866
Chapter 121: NetScout Event Monitor
872
Chapter 122: Technology Database Integration Monitor
876
Chapter 123: Technology Log File Integration Monitor
889
Chapter 124: Technology SNMP Trap Integration Monitor
900
Chapter 125: Technology Web Service Integration Monitor
910
Send Documentation Feedback
HPE SiteScope (11.33)
924
Page 7 of 924
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 49
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 855
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 HPE SiteScope and Application Performance Management (APM):
l
SiteScope/APM administrators
l
SiteScope/APM application administrators
l
SiteScope/APM data collector administrators
l
SiteScope/APM 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 APM should
be familiar with APM and enterprise monitoring and management concepts.
Part 1: SiteScope Monitor Reference
Overview
HPE SiteScope (11.33)
Page 9 of 924
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 18.
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
l
l
l
Application Monitors. Monitors in this category monitor third-party applications. These monitors enable
SiteScope to access and retrieve data from the monitored applications.
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.
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.
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
l
Virtualization and Cloud Monitors. Monitors in this category monitor virtualized environments and
cloud infrastructures.
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 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 HPE Live Network for sharing with other SiteScope users. For more
details on using Custom monitors, see Creating Custom Monitors in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 10 of 924
Monitor Reference
Chapter 1: SiteScope Monitor Categories
Dynamic Monitors
Dynamic monitors automatically adjust the SiteScope monitoring configuration based on changes that are
happening in your IT environment.
SiteScope provides various dynamic monitors that automatically update themselves over time by adding and
removing counters and thresholds as virtual machines move from one host system to another. In addition,
baselining is supported, where thresholds are dynamically changed based on historical monitoring data.
Dynamic monitors include:
l
AWS Monitor
l
Dynamic Disk Space Monitor
l
Dynamic Docker Monitor
l
Dynamic JMX Monitor
l
Generic Hypervisor Monitor
l
Hadoop Monitor
l
HP Vertica JDBC Monitor
l
KVM Monitor
l
REST API Monitor
l
VMware Datastore Monitor
l
VMware Host 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 APM.
These monitor types require additional licensing and may only be available as part of another HPE product.
For more information about Integration Monitor capabilities, see Integration Monitors in the Using SiteScope
Guide.
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. After deploying solution templates, you can edit or delete them using the same
steps as with other monitor types. For more information, see Deploying Solution Templates in the Using
SiteScope Guide.
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
Apache Cassandra
l
Apache Tomcat
l
Hadoop Cluster Monitoring
l
HP Quality Center
HPE SiteScope (11.33)
Page 11 of 924
Monitor Reference
Chapter 1: SiteScope Monitor Categories
l
HP QuickTest Professional
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
l
Microsoft SQL Server
l
Microsoft Windows Host
l
.NET
l
Oracle Database
l
Postgres Database
l
SAP Application Server
l
Siebel Application/Gateway/Web Server (for UNIX and Windows)
l
Solaris Host
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
HPE SiteScope (11.33)
Page 12 of 924
Chapter 2: Monitor Categories List
This section displays the SiteScope monitors in each monitor category.
l
"Application Monitors" below
l
"Big Data" on the next page
l
"Customizable Monitors" on the next page
l
"Database Monitors" on the next page
l
"Generic Monitors" on page 15
l
"Integration Monitors" on page 15
l
"Media Monitors" on page 15
l
"Network Monitors" on page 15
l
"Server Monitors" on page 16
l
"Virtualization and Cloud Monitors" on page 16
l
"Web Transaction Monitors" on page 16
Application Monitors
l
"Active Directory Replication Monitor" on page 50
l
"Apache Server Monitor" on page 60
l
"BroadVision Application Server Monitor" on page 73
l
"Check Point Monitor" on page 79
l
"Cisco Works Monitor" on page 81
l
"Citrix Monitor" on page 86
l
"ColdFusion Server Monitor" on page 91
l
"COM+ Server Monitor" on page 95
l
"Dynamic Docker Monitor" on page 223
l
"F5 Big-IP Monitor" on page 268
l
"HAProxy Monitor" on page 308
l
"Mail Monitor" on page 375
l
"MAPI Monitor" on page 379
l
"Memcached Statistics Monitor" on page 384
l
"Microsoft ASP Server Monitor" on page 391
l
"Microsoft Exchange Monitor" on page 396
l
"Microsoft Exchange Base Monitor" on page 403
l
"Microsoft Exchange 2000/2003/2007 Message Traffic Monitor" on page 421
l
"Microsoft Exchange 5.5 Message Traffic Monitor (Deprecated)" on page 424
l
"Microsoft Exchange 2003 Mailbox Monitor (Deprecated)" on page 426
l
"Microsoft Exchange 2003 Public Folder Monitor (Deprecated)" on page 429
l
"Microsoft IIS Server Monitor" on page 438
HPE SiteScope (11.33)
Page 13 of 924
Monitor Reference
Chapter 2: Monitor Categories List
l
l
"News Monitor" on page 516
"Oracle 9i Application Server Monitor(This monitor is not supported for 9i running on Tru64 Unix operating
system)" on page 526
l
"Oracle 10g Application Server Monitor" on page 519
l
"Radius Monitor" on page 544
l
"SAP CCMS Monitor" on page 561
l
"SAP CCMS Alerts Monitor" on page 567
l
"SAP Java Web Application Server Monitor" on page 571
l
"SAP MAI Alert Monitor" on page 575
l
"SAP Performance Monitor" on page 582
l
"SAP Work Processes Monitor" on page 588
l
"Siebel Application Server Monitor" on page 609
l
"Siebel Log File Monitor" on page 618
l
"Siebel Web Server Monitor" on page 622
l
"SunONE Web Server Monitor" on page 652
l
"Tuxedo Monitor (Deprecated)" on page 665
l
"UDDI Monitor" on page 669
l
"WebLogic Application Server Monitor" on page 809
l
"Web Server Monitor" on page 796
l
"WebSphere Application Server Monitor" on page 815
l
"WebSphere MQ Status Monitor" on page 838
l
"WebSphere Performance Servlet Monitor" on page 847
Big Data
l
"Hadoop Monitor" on page 295
l
"HP Vertica JDBC Monitor" on page 323
Customizable Monitors
l
"Custom Monitor" on page 105
l
"Custom Database Monitor" on page 118
l
"Custom Log File Monitor" on page 136
l
"Custom WMI Monitor" on page 158
Database Monitors
l
"Database Counter Monitor" on page 174
l
"Database Query Monitor" on page 182
l
"DB2 JDBC Monitor" on page 195
l
"LDAP Monitor" on page 356
l
"Microsoft SQL Server Monitor" on page 459
l
"Oracle Database Monitor" on page 529
HPE SiteScope (11.33)
Page 14 of 924
Monitor Reference
Chapter 2: Monitor Categories List
l
"Sybase Monitor (Deprecated)" on page 656
Generic Monitors
l
"Composite Monitor" on page 98
l
"Directory Monitor" on page 203
l
"Dynamic JMX Monitor" on page 249
l
"File Monitor" on page 274
l
"Formula Composite Monitor" on page 279
l
"JMX Monitor" on page 336
l
"Log File Monitor" on page 363
l
"Multi Log Monitor" on page 502
l
"Script Monitor" on page 594
l
"Syslog Monitor" on page 659
l
"Web Service Monitor" on page 799
l
"XML Metrics Monitor" on page 851
Integration Monitors
l
"HP OM Event Monitor" on page 856
l
"HP Service Manager Monitor" on page 866
l
"NetScout Event Monitor" on page 872
l
"Technology Database Integration Monitor" on page 876
l
"Technology Log File Integration Monitor" on page 889
l
"Technology SNMP Trap Integration Monitor" on page 900
l
"Technology Web Service Integration Monitor" on page 910
Media Monitors
l
"Microsoft Lync Server 2010 Monitors" on page 445 (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 (Deprecated)" on page 479
l
"Microsoft Windows Media Server Monitor" on page 482
l
"Real Media Player Monitor (Deprecated)" on page 547
l
"Real Media Server Monitor" on page 549
Network Monitors
l
"DNS Monitor" on page 211
l
"FTP Monitor" on page 283
l
"Microsoft Windows Dial-up Monitor (Deprecated)" on page 466
l
"Network Bandwidth Monitor" on page 511
l
"Ping Monitor" on page 538
HPE SiteScope (11.33)
Page 15 of 924
Monitor Reference
Chapter 2: Monitor Categories List
l
"Port Monitor" on page 541
l
"SNMP Monitor" on page 629
l
"SNMP Trap Monitor" on page 642
l
"SNMP by MIB Monitor" on page 636
Server Monitors
l
"Browsable Windows Performance Counter Monitor" on page 77
l
"CPU Monitor" on page 101
l
"Disk Space Monitor (Deprecated)" on page 207
l
"DHCP Monitor" on page 201
l
"Dynamic Disk Space Monitor" on page 214
l
"HP iLO (Integrated Lights-Out) Monitor" on page 311
l
"HP NonStop Event Log Monitor" on page 315
l
"HP NonStop Resources Monitor" on page 319
l
"IPMI Monitor" on page 334
l
"Memory Monitor" on page 386
l
"Microsoft Windows Event Log Monitor" on page 470
l
"Microsoft Windows Performance Counter Monitor" on page 486
l
"Microsoft Windows Resources Monitor" on page 490
l
"Microsoft Windows Services State Monitor" on page 497
l
"Service Monitor" on page 603
l
"UNIX Resources Monitor" on page 670
Virtualization and Cloud Monitors
l
l
"Amazon Web Services Monitor" on page 53
"Azure Monitor" on page 65
l
"Generic Hypervisor Monitor" on page 288
l
"KVM Monitor" on page 347
l
"Microsoft Hyper-V Monitor" on page 431
l
"Solaris Zones Monitor" on page 645
l
"VMware Datastore Monitor" on page 735
l
l
"VMware Host Monitors" on page 746 (VMware Host CPU, VMware Host Memory, VMware Host
Network, VMware Host State, and VMware Host Storage)
"VMware Performance Monitor" on page 768
Web Transaction Monitors
l
"e-Business Transaction Monitor" on page 264
l
"Link Check Monitor" on page 360
l
REST API Monitor
l
"URL Monitor" on page 675
HPE SiteScope (11.33)
Page 16 of 924
Monitor Reference
Chapter 2: Monitor Categories List
l
"URL Content Monitor" on page 689
l
"URL List Monitor" on page 702
l
"URL Sequence Monitor" on page 711
l
"Web Script Monitor" on page 785
HPE SiteScope (11.33)
Page 17 of 924
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.
Protocol /
Technology
User Permissions and
Credentials
Amazon Web
Services
HTTPS
AWS AccessKey ID, AWS
SecretKey
Azure
HTTPS
Subscription ID, Client ID,
Domain ID
Apache Server
HTTP,
HTTPS
None needed unless
required to access the
server statistics page.
BroadVision
Proprietary
CheckPoint
Firewall-1
SNMP
Community string.
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).
Cisco Works
SNMP
Community string or user
name/password,
depending on SNMP
version.
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.
Monitor Name
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.
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.
HPE SiteScope (11.33)
Page 18 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Protocol /
Technology
User Permissions and
Credentials
Citrix Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
ColdFusion
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
COM+
HTTP,
HTTPS
CPU (Windows)
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
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.
Monitor Name
Notes
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/164018/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
Database Counter JDBC
HPE SiteScope (11.33)
Need shell access to the
remote server. It is also
necessary for the loggedin 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.
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.
Page 19 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor Name
Protocol /
Technology
User Permissions and
Credentials
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 32).
Disk Space
(Solaris/ Linux)
Telnet, SSH,
rlogin
Need shell access to the
remote server. It is also
necessary for the loggedin user to have permission
to run specific executable
programs.
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 32).
Dynamic Disk
Space (Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to the
remote server. It is also
necessary for the loggedin 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.
HPE SiteScope (11.33)
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.
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 20 of 924
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.
Generic
Hypervisor
Telnet, SSH,
and rlogin
Need shell access to the
remote server. It is also
necessary for the loggedin user to have permission
to run specific executable
programs.
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 LightsOut)
SSH
Should be configured by
the HP iLO system
administrator.
HPE SiteScope (11.33)
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.
When configuring the remote server, select SSH
version 2 only in the Advanced Settings pane (to
make it work faster).
Page 21 of 924
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
None needed for
SiteScope. The server
may require a valid user
name and password.
KVM
Telnet, SSH,
and rlogin
Need shell access to the
remote server. It is also
necessary for the loggedin user to have permission
to run specific executable
programs.
HPE SiteScope (11.33)
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 22 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor Name
Protocol /
Technology
User Permissions and
Credentials
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 loggedin 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.
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 loggedin user to have
permissions to run specific
executable programs.
Memcached
Statistics
TCP
None needed.
Microsoft
Archiving Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
HPE SiteScope (11.33)
Notes
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.
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.
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Page 23 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Protocol /
Technology
User Permissions and
Credentials
Microsoft A/V
Conferencing
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft ASP
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft Director
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft Edge
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft
Exchange
PowerShell
v1.0 (for
Microsoft
Exchange
Server
2007)
SiteScope must be run by
administrator on local
machine and this
administrator must be in
Exchange Server
administrators group.
Monitor Name
Notes
PowerShell
v2.0 (for
Microsoft
Exchange
Server
2010)
Microsoft
Exchange Base
HPE SiteScope (11.33)
PowerShell
v2
SiteScope must be run by
administrator on local
machine and this
administrator must be in
Exchange Server
administrators group.
This monitor can monitor:
l
l
Microsoft Exchange Server 2010 (with
SiteScope on an operating system with
PowerShell v.2)
Microsoft Exchange Server 2013 (with
SiteScope on operating system operating
system with PowerShell v.2)
Page 24 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor Name
Protocol /
Technology
User Permissions and
Credentials
Microsoft Front
End Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft IIS
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft
Mediation Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft
Monitoring and
CDR Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft
Registrar Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft SQL
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft
Windows Event
Log
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
HPE SiteScope (11.33)
Notes
Page 25 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Protocol /
Technology
User Permissions and
Credentials
Microsoft
Windows Media
Player
Telnet, SSH,
rlogin
Read-only file permission
to the target file system.
Microsoft
Windows Media
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft
Windows
Performance
Counter
NetBIOS
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Microsoft
Windows
Resources
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
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 loggedin user to have
permissions to run specific
executable programs.
Read-only file
permissions to the target
file system.
Monitor Name
HPE SiteScope (11.33)
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 26 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor Name
Network
Bandwidth
Protocol /
Technology
User Permissions and
Credentials
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
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.
Oracle 9i
HTTP/
Application Server HTTPS
Oracle Database
JDBC
An Oracle user logs in
with the ability to execute
all the SQL statements
found in <SiteScope root
directory>\
templates.applications\
commands.oraclejdbc.
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.
HPE SiteScope (11.33)
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.
Page 27 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor Name
Protocol /
Technology
User Permissions and
Credentials
Real Media
Server
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
REST API
HTTP/
HTTPS
None needed for
SiteScope. The server
may require a valid user
name and password.
SAP MAI Alert
Proprietary
RFC authorization.
/HPOV/*
SAP CCMS
Proprietary
XMI authorization.
Profiles that have XMI authorization are S_
A.SYSTEM, PD_CHICAGO, S_WF_RWTEST,
and SAP_ALL.
SAP CCMS Alert
Proprietary
SAP Performance
or SAP Work
Processes
Proprietary
Script (Windows)
Telnet, SSH,
rlogin
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Script (Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to the
remote server. It is also
necessary for the loggedin 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.
Script on local
machine (Solaris,
Linux and
Windows)
Telnet, SSH,
rlogin/
NetBIOS
Read-only file permission
to the target file system.
Service
(Windows)
NetBIOS,
WMI
Specific access
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on page 32).
HPE SiteScope (11.33)
Notes
See notes in "Monitoring Performance Objects
on Windows" on page 32.
See notes in "Monitoring Performance Objects
on Windows" on page 32.
Page 28 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor Name
Protocol /
Technology
User Permissions and
Credentials
Service (Solaris/
Linux)
Telnet, SSH,
rlogin
Need shell access to the
remote server. It is also
necessary for the loggedin 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.
Siebel Application
Server (previously
Siebel Server
Manager)
CmdLine
User account must have
Siebel Administrator
Responsibility privileges
to issue Siebel server
manager (srvrmgr)
commands.
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.
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 User must have permission to retrieve the Siebel
are needed if target Siebel SWE page.
Extensions Page is
behind third-party, HTML,
form-based authentication
software.
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.
HPE SiteScope (11.33)
Page 29 of 924
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
SNMP
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.
SunONE
HTTP/
HTTPS
None, unless using a
proxy that requires
authentication.
Syslog
Telnet, SSH,
rlogin
Need shell access to the
remote server. It is also
necessary for the loggedin 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.
HPE SiteScope (11.33)
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.
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 30 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Protocol /
Technology
User Permissions and
Credentials
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.
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
CPU/ Memory/
Storage/ Network/
State
HTTPS
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
permissions are required
for monitoring
performance objects on
Windows (see "Monitoring
Performance Objects on
Windows" on the next
page).
See notes in "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.
Monitor Name
WebLogic
SNMP
Application Server
5.x
HPE SiteScope (11.33)
Notes
Community string
credential must match the
string in the SNMP agent.
Page 31 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
Monitor Name
Protocol /
Technology
User Permissions and
Credentials
WebLogic
RMI
Application Server
6.x and later
Requires a user that
belongs to a group with at
least monitor role
privilege.
WebSphere
HTTP/
Application Server HTTPS
(SOAP over
HTTP)
Requires a user that has
or belongs to a group with
at least the monitor role
privilege.
WebSphere MQ
Status
SiteScope account must
be a member of mqm
group in the MQ Windows
server.
Proprietary
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.
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:
HPE SiteScope (11.33)
Page 32 of 924
Monitor Reference
Chapter 3: Monitor Permissions and Credentials
l
l
Configure the SiteScope user to be a domain user that is also a user on the remote machines.
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.
HPE SiteScope (11.33)
Page 33 of 924
Chapter 4: Supported Versions and Platforms
This section contains a table of SiteScope monitors. Each monitor is listed with the versions of the
applications and operating systems that are supported for monitoring.
Monitor
Supported Versions and Platforms
Active Directory
Replication
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003, 2003
R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
Amazon Web
Services
This monitor supports monitoring on Amazon CloudWatch API
version 2010-08-01.
Apache Server
This monitor supports monitoring remote servers running on Apache
1.3.9, 1.3.12, 2.0, 2.2, 2.4, and 2.4.10 servers.
BroadVision
Application
Server
This monitor supports monitoring remote servers running on
BroadVision 4.1, 5.x, and 6.0 servers.
Cisco Works
This monitor supports monitoring on Cisco Works 2000 servers and
later.
Citrix
l
This monitor supports monitoring remote servers running on:
l
l
l
l
l
HPE SiteScope (11.33)
Citrix MetaFrame 1.8 Service Pack 3
Citrix MetaFrame XP(s,a,e) Feature Release 1/Service Pack
1
Citrix MetaFrame XP(s,a,e) Feature Release 2/Service Pack
2
l
Citrix Presentation Server 3.5, 4.x
l
Citrix XenApp 4.6, 5.0, 6.0, 6.5, 7.6
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.
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.
Page 34 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
ColdFusion
Supported Versions and Platforms
l
l
COM+ Server
CPU
This monitor supports monitoring ColdFusion 4.5.x, 9, 10, and 11
servers.
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.
This monitor supports monitoring COM+ software components
running on Microsoft Windows Server 2003, 2008, 2008 R2, 2012,
2012 R2 Update 1.
l
l
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).
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
Database
Counter
This monitor supports monitoring on any database with a valid JDBC
driver that supports SQL queries.
Database Query
This monitor supports monitoring on any database with a valid JDBC
driver that supports SQL queries.
DB2 JDBC
l
l
Directory
l
l
l
HPE SiteScope (11.33)
This monitor supports monitoring DB2 8.x, 9.x, and 10.1 servers.
It supports all operating systems with a supported JDBC driver
and DB2 snapshot feature.
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
Page 35 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Dynamic Disk
Space
Supported Versions and Platforms
l
l
l
l
Dynamic JMX
l
File
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
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.
This monitor supports monitoring on:
l
F5 Big-IP
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.
WebLogic 11g (10.3.1-10.3.5), 12c
Apache Tomcat 5.0, 5.5, 6.0, 6.0.33, 7.0.25, 7.0.50, 7.0.61,
7.0.62, 8.0.23
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
JBoss EAP 6.1.x - 6.2.x, 6.3.0
l
Sun Glassfish Enterprise Server 2.1, 3.1
l
WildFly 8.0.0, 8.1.0, 8.2.0
This monitor supports monitoring F5 Big-IP 4.0, 10.x, 11.x.
l
l
l
This monitor supports monitoring UNIX remote servers that have
been configured in SiteScope and the local SiteScope machine
only.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
Generic
Hypervisor
This monitor supports monitoring remote servers running on UNIX
remotes only. It has been tested on a KVM environment.
Hadoop
This monitor supports monitoring Hadoop 1.x on GNU/Linux.
HPE SiteScope (11.33)
Page 36 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Supported Versions and Platforms
HAProxy
This monitor supports monitoring HAProxy 1.3, 1.4, and 1.5.10 on
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)
HP iLO
(Integrated
Lights-Out)
(missing or bad snippet)
HP NonStop
Event Log
(missing or bad snippet)
HP NonStop
Resources
(missing or bad snippet)
HP Vertica JDBC
(missing or bad snippet)
JMX
This monitor supports monitoring on:
l
WebLogic 11g (10.3.1-10.3.5), 12c
Note: Monitoring WebLogic 9.x and 10.x is no longer
supported due to different Java versions run by SiteScope
11.2x or later, and WebLogic Application Server 9.x and 10.x.
l
Apache Tomcat 5.0, 5.5, 6.0, 6.0.33, 7.0.25, 7.0.50, 7.0.61,
7.0.62, 8.0.23
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
JBoss EAP 6.1.x - 6.2.x, 6.3.0
l
Sun Glassfish Enterprise Server 2.1, 3.1
l
WildFly 8.0.0, 8.1.0, 8.2.0
KVM
This monitor supports monitoring remote servers running on UNIX
remotes only. It has been tested on Linux #29-Ubuntu SMP 3.0.0-16generic.
LDAP
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003, 2003
R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
HPE SiteScope (11.33)
Page 37 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Log File
Supported Versions and Platforms
l
l
MAPI
Memory
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
This monitor is supported in SiteScopes that are running on Windows
versions only.
l
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).
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
Note: If you are monitoring a Windows remote server using
the NetBIOS method, only 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
HPE SiteScope (11.33)
Monitoring physical and virtual memory is not supported using the
Rlogin connection method on UNIX remote servers.
Page 38 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Microsoft ASP
Server
Supported Versions and Platforms
l
l
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
Microsoft
Exchange
This monitor supports monitoring Microsoft Exchange Server 2007
with PowerShell v1.0, and Microsoft Exchange Server 2010 with
PowerShell v2.0.
Microsoft
Exchange Base
Microsoft Exchange Server 2010 and 2013 on Windows platforms
only.
Note: PowerShell v2.0 must be used on the SiteScope-side.
Microsoft
Exchange 2003
Mailbox
(Deprecated)
This monitor is supported in SiteScopes that are running on Windows
versions only.
Microsoft
This monitor is supported in SiteScopes that are running on Windows
Exchange
versions only.
2000*/2003*/2007
Message Traffic
(*Deprecated)
Microsoft
Exchange 2003
Public Folder
(Deprecated)
HPE SiteScope (11.33)
This monitor is supported in SiteScopes that are running on Windows
versions only.
Page 39 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Microsoft HyperV
Supported Versions and Platforms
l
l
l
Microsoft IIS
Server
l
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1. All these
supported operating systems should be with 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.
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.
The Microsoft IIS Server monitor supports monitoring the
following:
l
l
l
l
Microsoft Lync
Server 2010
l
l
l
HPE SiteScope (11.33)
HTTP/HTTPS services on IIS 4.0, 5.0, 7.0, 7.5, 8.0, 8.5.
HTTP/HTTPS, FTP, NNTP and MSMQ Queue on IIS 6, 7.0,
8.0, 8.5.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
This monitor supports monitoring Microsoft Lync Server 2010
servers.
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.
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.
Page 40 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Microsoft SQL
Server
Supported Versions and Platforms
l
l
l
l
Microsoft
Windows Dial-up
(Deprecated)
Microsoft
Windows Event
Log
l
l
l
l
l
Microsoft
Windows Media
Player
(Deprecated)
HPE SiteScope (11.33)
l
l
The Microsoft SQL Server monitor supports monitoring Microsoft
SQL Server versions 6.5, 7.1, 2000, 2005, 2008, 2008 R2, 2012,
and 2014.
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012.
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.
This monitor is supported in SiteScopes that are running on
Windows versions only.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012.
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
This monitor is supported in SiteScopes that are running on
Windows versions only.
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.
Page 41 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Microsoft
Windows Media
Server
Supported Versions and Platforms
l
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.
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
Microsoft
Windows
Performance
Counter
l
l
Microsoft
Windows
Resources
l
l
l
Microsoft
Windows
Services State
l
l
HPE SiteScope (11.33)
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.
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
Page 42 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Multi Log
Supported Versions and Platforms
l
l
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
Network
Bandwidth
This monitor supports monitoring remote SNMP-enabled network
appliances.
Oracle 10g
Application
Server
This monitor supports monitoring Oracle 10g and 10g R3 application
servers.
Oracle 9i
Application
Server
This monitor supports monitoring Oracle 9i application servers.
Oracle Database
The monitor supports monitoring server performance statistics from
Oracle Database 10g, 11i, 11g R2 (11.2.0.1), 11g R2 Real
Application Clusters (RAC), and 12c (12.1.0.1) servers.
Real Media
Player
(Deprecated)
l
l
l
This monitor is supported in SiteScopes that are running on
Windows versions only.
This monitor supports monitoring RealNetworks Real Media
Player versions 7.x, 8.x, 9.x, and 10.x
This monitor does not support metadata files such as the .smi
format.
Real Media
Server
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.
SAP CCMS
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.
SAP CCMS
Alerts
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.
SAP Java Web
Application
Server
This monitor supports monitoring:
HPE SiteScope (11.33)
l
SAP Java Web Application Server 6.40, 7.00, 7.01, 7.02, 7.3
l
SAP Enterprise Portal 5.0, 6.0
l
SAP NetWeaver Portal 7.0, 7.3
Page 43 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Supported Versions and Platforms
SAP MAI Alerts
This monitor supports monitoring on SAP Solution Manager 7.1.
SAP
Performance
This monitor supports monitoring SAP Application Servers R/3 4.6B,
R/3 4.6C, R/3 4.7E, SAP ECC5 and SAP ECC6.
SAP Work
Processes
This monitor supports monitoring SAP Application Servers R/3 4.6B,
R/3 4.6C, R/3 4.7E, SAP ECC5 and SAP ECC6.
Script
l
l
l
Service
l
l
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
The Script 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 320.
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.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
Siebel
Application
Server
This monitor uses the Siebel Server Manager client to monitor Object
Manager components and task information on Siebel 7.03, 7.04,
7.5.3, 7.7, 8.0, 8.1, 8.2 - 8.2.2.4 application servers.
Siebel Log File
This monitor supports monitoring remote servers running on Siebel
Application Server 7.03, 7.04, 7.5.3, 7.7, 8.0, 8.1, 8.2 - 8.2.2.4.
Siebel Web
Server
This monitor supports monitoring remote servers running on Siebel
Application Server 7.03, 7.04, 7.5.3, 7.7, 8.0, 8.1, 8.2 - 8.2.2.4.
SNMP
l
l
HPE SiteScope (11.33)
This monitor supports monitoring agents of SNMP versions 1.0,
2.0, and 3.0 MD5 and SHA.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012.
Page 44 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
SNMP by MIB
Supported Versions and Platforms
l
l
This monitor supports monitoring agents of SNMP versions 1, 2,
and 3 MD5.
This monitor supports monitoring remote servers running on the
following Windows operating systems: Windows Server 2003,
2003 R2, 2008, 2008 R2, 2012.
SNMP Trap
The monitor supports monitoring traps of SNMP versions 1, 2, and 3.
Solaris Zones
This monitor supports monitoring machines that are running on the
following Solaris operating systems: Solaris 10 update 7 (5/09) Solaris 10 update 11 (01/13), Solaris 11.2.
SunONE Web
Server
This monitor supports monitoring SunONE or iPlanet 6.x or 7.0
servers.
Sybase
l
l
l
Tuxedo
l
l
l
UDDI
HPE SiteScope (11.33)
This monitor supports monitoring the server performance data for
Sybase 11.0, 11.5, 11.92, 12.x, and 15.5 database servers.
This monitor is supported in SiteScopes that are running on
Windows versions only.
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.
This monitor supports monitoring server performance data for
Oracle Tuxedo 6.5, 7.1, 8.0, 8.1, 9.0, and 9.1 servers.
This monitor is supported in SiteScopes that are running on
Windows versions only. However, this monitor can monitor
remote servers running on any platform/operating system.
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.
This monitor supports monitoring of the UDDI 2.0 server.
Page 45 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Supported Versions and Platforms
UNIX Resources
This monitor supports monitoring UNIX remote servers running on:
l
Solaris 2.7, 2.8, 2.9, 5.10, 7, 8, 9, 10, 10 8/11 ("U10"), 10 1/13
("U11"), 11, 11.2
l
Red Hat Linux 7.x, 8.x, 9.x
l
Red Hat Linux AS/ES Linux 3.x, 4.x, 5.2, 5.4 - 5.10, 6.0 - 6.5, 7
l
Oracle Enterprise Linux 6.4, 6.5, 7.0
l
HP-UX 11iv1 (B.11.11) on HP 9000 series:
l
l
HP-UX B.11.11 U 9000/800 4030070275 unlimited-user
license
l
HP-UX B.11.31 U ia64 4005705783 unlimited-user license
l
HP-UX 11i v3
AIX 5.2, 5.3, 6.1, 7.0, 7.1
Note: The UNIX Resources monitor does not support monitoring
remote servers running on HP NonStop operating systems; use
the "HP NonStop Resources Monitor" on page 319 instead.
URL
The URL monitor supports monitoring HTTP versions 1.0 and 1.1.
URL Content
The URL Content monitor supports monitoring HTTP versions 1.0
and 1.1.
URL List
The URL List monitor supports monitoring HTTP versions 1.0 and
1.1.
VMware
Datastore
This monitor supports monitoring remote servers running on VMware
vSphere 4.0, 4.1, 5.0, 5.1, 5.5, 6.0.
VMware Host
This monitor supports monitoring remote servers running on:
l
VMware VirtualCenter 2.x
l
VMware ESX 3.x, 4.0, 4.1
l
VMware ESXi 3.5, 4.0, 4.1, 5.0, 5.1, 5.5, 6.0
l
VMware ESX 2.5 via VirtualCenter 2.x
l
VMware ESX 3.x via VirtualCenter 3.x
l
VMware vSphere 4.0, 4.1, 5.0, 5.1 (also supported with SSO
login), 5.5, 6.0
Note: Monitoring VMware ESX(i) is not supported when
Lockdown mode is enabled.
HPE SiteScope (11.33)
Page 46 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Supported Versions and Platforms
VMware
Performance
This monitor supports monitoring remote servers running on:
l
VMware VirtualCenter 2.x
l
VMware ESX 3.x, 4.0, 4.1
l
VMware ESXi 3.5, 4.0, 4.1, 5.0, 5.1, 5.5, 6.0
l
VMware ESX 2.5 via VirtualCenter 2.x
l
VMware ESX 3.x via VirtualCenter 3.x
l
VMware vSphere 4.0, 4.1, 5.0, 5.1 (also supported with SSO
login), 5.5, 6.0
Note: Monitoring VMware ESX(i) is not supported when
Lockdown mode is enabled.
Web Script
l
l
l
This monitor is supported in SiteScopes running on Windows and
Linux 64-bit environments (SiteScope is no longer supported on
32-bit operating systems).
This monitor supports scripts created in VuGen version 12.53
(scripts created in VuGen versions 9.51 and earlier are retained
for backward compatibility).
From SiteScope 11.30 onwards: To use the Web Script monitor,
you must install HPE Load Generator 12.53 on the SiteScope
server to run web scripts.
For details on downloading VuGen 12.53 and HP Load Generator
12.53, see "How to Configure the Web Script Monitor" on page 791.
HPE SiteScope (11.33)
Page 47 of 924
Monitor Reference
Chapter 4: Supported Versions and Platforms
Monitor
Supported Versions and Platforms
Web Service
The following specification features are currently supported:
l
WSDL 1.1, 2.0
l
SOAP 1.1, 1.2
l
Simple and Complex Types based on XML Schema 2001
l
SOAP binding with the HTTP(S) protocol only
l
SOAP with Attachments is not supported
l
Nested WSDL
l
WSDL with multi-ports and multi-services
Note:
l
l
WSS (Web Services Security) is currently not supported.
SOAP and WSDL technologies are evolving. As a result,
some WSDL documents may not parse accurately and some
SOAP requests may not interact with all Web service
providers. When SiteScope is unable to generate the correct
skeleton code, for example, if the WSDL file has errors or the
complexType element uses schema syntax that is not
supported, you can modify the XML argument as necessary.
For example, if an argument is displayed like this:
parameters[COMPLEX] =<pPatientSSN
xsi:type="xs:string">***</pPatientSSN>
you can modify it by deleting the xs: and xsi: as follows:
parameters[COMPLEX] =<pPatientSSN
type="string">***</pPatientSSN>
WebLogic
Application
Server
This monitor supports monitoring WebLogic Application Servers
version 6 through 8. To monitor a WebLogic Application Server 11g
(10.3.1-10.3.5) or 12c, use a JMX monitor.
WebSphere
Application
Server
This monitor supports monitoring server performance statistics from
WebSphere 5.x, 6.0x, 6.1x, 7.0x, 8.0x, and 8.5x servers.
WebSphere MQ
Status
l
l
WebSphere
Performance
Servlet
HPE SiteScope (11.33)
This monitor supports monitoring on WebSphere MQ (formerly
known as MQSeries) Servers 5.2, 5.3, 5.3.1, 6.0, 7.0, 7.0.1,
7.0.1.3, 7.1, 7.1.0.5, 7.5, 8.0, 8.0.0.2, and 8.0.0.4.
This monitor is indifferent to the platform on which the
WebSphere MQ server is installed, whether it is Windows, z/OS,
HP-UX, Linux, AIX, or Sun Solaris.
This monitor supports monitoring WebSphere 3.0x, 3.5, 3.5.x, 4.0, 5.
0, 5.1, 5.1.1, 6.0, 6.0.1, 6.0.2, 6.1, 7.0, 7.0.0.19, 7.0.0.21, 8.0,
8.0.0.1, and 8.0.0.2 servers.
Page 48 of 924
Part 2: SiteScope Monitors (A-Z)
HPE SiteScope (11.33)
Page 49 of 924
Chapter 5: 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.
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
l
"License Consumption" 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 the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
License Consumption
Points-based Usage
Capacity-based Usage
Active Directory with Global Catalog - 34 points
Requires Active Directory Solution Template.
Active Directory with no Global Catalog - 33 points
Not available with Community edition.
License point usage is based on the solution template
cost.
HPE SiteScope (11.33)
Page 50 of 924
Monitor Reference
Chapter 5: Active Directory Replication Monitor
Tasks
How to Configure the Active Directory Replication Monitor
1. Prerequisites
l
l
This monitor is only displayed in the user interface after deploying an Active Directory solution
template. To enable the monitor, you must have an Operating System Instance (OSi) license with
sufficient available capacity. For license purchase inquiries (or if you require additional capacity),
contact your HPE sales representative or use the “Contact Us” link in the HPE SiteScope Product
page.
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 required.
For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 51 of 924
Monitor Reference
Chapter 5: 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.
HPE SiteScope (11.33)
Page 52 of 924
Chapter 6: 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
l
"License Consumption" 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.
Supported Platforms/Versions
This monitor supports monitoring on Amazon CloudWatch API version 2010-08-01.
License Consumption
Points-based Usage
Capacity-based Usage
One point per 15
metrics
One OSi per monitored host + One OSi if any of the aggregate counters are
selected
Note: This monitor is not available when using Community edition.
Tasks
How to Configure the Amazon Web Services Monitor
1. Prerequisites
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
HPE SiteScope (11.33)
Page 53 of 924
Monitor Reference
Chapter 6: Amazon Web Services Monitor
l
l
This monitor is available with all editions except Community edition. Contact your HPE sales
representative for more information.
The Amazon CloudWatch Service is required to monitor Amazon Web Services.
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
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 data
timeout
request. After the socket timeout period elapses, the monitor logs an error and reports the
(milliseconds) error status. A value of zero means there is no timeout used.
Default value: 120 milliseconds
HPE SiteScope (11.33)
Page 54 of 924
Monitor Reference
Chapter 6: Amazon Web Services Monitor
UI Element
Description
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:
l
Get Regions
ap-south-1 for Asia Pacific (Mumbai)
l
ap-northeast-2 for Asia Pacific (Seoul)
l
ap-southeast-1 for Asia Pacific (Singapore)
l
ap-southeast-2 for Asia Pacific (Sydney)
l
ap-northeast-1 for Asia Pacific (Tokyo)
l
ca-central-1 for Canada (Central)
l
eu-central-1 for EU (Frankfurt)
l
eu-west-1 for EU (Ireland)
l
eu-west-2 for EU (London)
l
sa-east-1 for South America (Sao Paulo)
l
us-east-1 for US East (Northern Virginia)
l
us-east-2 for US East (Ohio)
l
us-west-2 for US West (Oregon)
l
us-west-1 for US West (Northern California)
l
us-gov-west-1 for AWS GovCloud
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: Asia Pacific (Mumbai), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia
Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), EU (Frankfurt), EU (Ireland),
EU (London), South America (Sao Paulo), US East (Northern Virginia), US East (Ohio),
US West (Oregon), US West (Northern California) 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
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
page 57.
HPE SiteScope (11.33)
Page 55 of 924
Monitor Reference
Chapter 6: Amazon Web Services Monitor
UI Element
Description
Patterns &
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.
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
that match the selected patterns.
button to display counters
By default, the following regular expressions are available:
l
/.*/By Instance Id/.*/NetworkPacketsIn\(Average\)/
l
/.*/By Instance Id/.*/State/
l
/.*/By Instance Id/.*/NetworkIn\(Average\)/
l
/.*/By Instance Id/.*/StatusCheckFailed_Instance\(Average\)/
l
/.*/By Instance Id/.*/StatusCheckFailed_System\(Average\)/
l
/.*/By Instance Id/.*/CPUUtilization\(Average\)/
l
/.*/By Instance Id/.*/NetworkOut\(Average\)/
l
/.*/By Instance Id/.*/DiskReadOps\(Average\)/
l
/.*/By Instance Id/.*/StatusCheckFailed\(Average\)/
l
/.*/By Instance Id/.*/DiskWriteOps\(Average\)/
l
/.*/By Instance Id/.*/NetworkPacketsOut\(Average\)/
l
/.*/By Instance Id/.*/DiskWriteBytes\(Average\)/
l
/.*/By Instance Id/.*/DiskReadBytes\(Average\)/
l
/.*/By Instance Id/.*/CPUCreditBalance\(Average\)/
l
/.*/By Instance Id/.*/CPUCreditUsage\(Average\)/
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
HPE SiteScope (11.33)
Page 56 of 924
Monitor Reference
Chapter 6: Amazon Web Services Monitor
UI Element
Description
Continue
displaying
counters that
no longer
exist after
update
When selected, counters that no longer exist after the monitor periodically scans the
AWS Management Console, are still displayed in the monitor (they are displayed as
stopped). This is useful, for example, 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
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
The Amazon Web Services monitor provides the ability to get statistics for all available metrics stored for the
AWS account owner which you can see in the Amazon CloudWatch Management Console. It might be
metrics from different Amazon services such as EC2, billing, or your own custom metrics (for example,
metrics which SiteScope can send to Amazon using Amazon integration). If you want to monitor Amazon
EC2 instances, you can select the AWS/EC2 group of counters. Below is the list of counters that can be
obtained:
HPE SiteScope (11.33)
Page 57 of 924
Monitor Reference
Chapter 6: Amazon Web Services Monitor
EC2 (By Image Id )
EC2 (Per Instance)
EC2 (By Instance Type) EC2 (All Instance)
l
DiskWriteBytes
l
CPUCreditBalance
l
DiskWriteBytes
l
DiskWriteytes
l
NetworkIn
l
CPUCreditUsage
l
NetworkIn
l
NetworkIn
l
DiskReadBytes
l
CPUUtilization8
l
DiskReadBytes
l
DiskReadBytes
l
DiskWriteOps
l
DiskReadBytes
l
DiskWriteOps
l
DiskWriteOps
l
NetworkOut
l
DiskReadOps
l
NetworkOut
l
NetworkOut
l
DiskReadOps
l
DiskWriteBytes
l
DiskReadOps
l
DiskReadOps
l
CPUUtilization
l
DiskWriteOps
l
CPUUtilization
l
CPUUtilization
l
NetworkIn
l
NetworkOut
l
NetworkPacketsIn
l
NetworkPacketsOut
l
StatusCheckFailed
l
l
AWS Logs
StatusCheckFailed_
Instance
StatusCheckFailed_
System
EBS (Per Volume)
AWS/EFS
l
IncomingBytes
l
BurstBalance
l
l
IncomingLogEvents
l
VolumeWriteOps
l
l
VolumeReadBytes
l
VolumeTotalReadTime
l
VolumeWriteBytes
l
VolumeTotalWriteTime
l
VolumeIdleTime
l
VolumeQueueLength
l
VolumeReadOps
Events Log Metrics
l
ec2net(Maximum)
BurstCreditBalance
PermittedThroughpu
t
The average, maximum and minimum values for each of these counters is fetched.
Notes/Tips/Troubleshooting
General Notes/Tips/Limitations
l
Amazon instances that are stopped from the AWS Management Console are listed on the SiteScope
Dashboard with status as "Stopped". Instances that are terminated from the AWS Management Console
are not listed any more on the SiteScope Dashboard.
HPE SiteScope (11.33)
Page 58 of 924
Monitor Reference
Chapter 6: Amazon Web Services Monitor
Note: The AWS Management Console is refreshed only after about an hour or later after terminating
an instance. Therefore, the terminated instances continue to be displayed on the AWS Management
Console and the SiteScope Dashboard during this time.
l
l
l
l
Amazon instances that are stopped are not displayed in the Counters tree when you either reload the
counters or fetch the counters. However, an exception to this is the "State" counter of the stopped
instances that continue to be displayed in the Counters tree and the SiteScope Dashboard.
When you upgrade to SiteScope 11.33, you must reload the counters to view the statistics such as
maximum, minimum, and average for each metric.
If you downgrade SiteScope from 11.33 and reload the counters, the average value of the counters are
displayed; the maximum and minimum values that are supported in version 11.33 are not displayed.
The Amazon Web Services monitor does not get counters from isolated regions such as AWS GovCloud
and China.
Workaround: Create the Amazon Web Services monitor using a template, and set the region Id. Make
changes to this monitor through the template only, and publish the changes using the Publish Template
Changes Wizard.
l
The Amazon Web Services Monitor gets data from instances that have detailed monitoring enabled in the
AWS Management Console. It can also get data from instances with basic monitoring enabled, but you
must add the _amazonCloudWebServiceMonitorPeriod key with a value in minutes to the <SiteScope
root directory>\groups\master.config file (it is recommended to set value to =10 or greater).
Note that detailed monitoring aggregates metrics data by image ID, instance ID, instance type, and so
forth, while basic monitoring aggregates metrics data by Instance ID only.
l
l
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.
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.
Deploying an Amazon Web Services monitor in a template might cause SiteScope to crash if the template
is deployed against an environment with a large number of counters available.
Workaround:
(1) Add the _browsableCountersFilter property to the <SiteScope root
directory>\groups\master.config file, and include any comma-separated strings that can be found in the
required counter names. For example, Custom dimensions,By LoadBalancer Name.
(2). Restart SiteScope.
HPE SiteScope (11.33)
Page 59 of 924
Chapter 7: 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
This section includes:
l
"Supported Platforms/Versions" below
l
"License Consumption" below
l
"Template Properties" below
Supported Platforms/Versions
This monitor supports monitoring remote servers running on Apache 1.3.9, 1.3.12, 2.0, 2.2, 2.4, and 2.4.10
servers.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Template Properties
name
label
status
status
value0
Counter 1 Value
value1
Counter 2 Value
value2
Counter 3 Value
value3
Counter 4 Value
value4
Counter 5 Value
value5
Counter 6 Value
HPE SiteScope (11.33)
Page 60 of 924
Monitor Reference
Chapter 7: Apache Server Monitor
name
label
value6
Counter 7 Value
value7
Counter 8 Value
value8
Counter 9 Value
value9
Counter 10 Value
value10
Counter 11 Value
value11
Counter 12 Value
value12
Counter 13 Value
value13
Counter 14 Value
value14
Counter 15 Value
value15
Counter 16 Value
value16
Counter 17 Value
value17
Counter 18 Value
value18
Counter 19 Value
value19
Counter 20 Value
_counters
Counters
_url
URL
_frequency
Update every
_name
Title
_timeout
Timeout
_disabled
Disable
_OS
Server OS
_proxy
HTTP Proxy
_username
Authorization User Name
_password
Authorization Password
_proxyusername
Proxy Server User Name
_proxypassword
Proxy Server Password
_verifyError
Verify Error
_errorFrequency
Update every (on errors)
HPE SiteScope (11.33)
Page 61 of 924
Monitor Reference
Chapter 7: Apache Server Monitor
name
label
_schedule
Schedule
_notLogToTopaz
Stop Logging To Mercury Business Availability Center
_monitorDescription
Monitor Description
_onlyStatusChanges
_onlyStatusChanges
_logOnlyThresholdMeas _logOnlyThresholdMeas
_description
Report Description
_logOnlyMonitorData
_logOnlyMonitorData
__template
Monitor Template
_dependsOn
Depends On
_dependsCondition
Depends Condition
_thresholdNew
_thresholdNew
_defaultStatus
Default status
_updateMonitorAndRun
_updateMonitorAndRun
Tasks
How to Configure the Apache Server Monitor
1. Prerequisites
l
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
Before you can use the Apache Server monitor, you must do the following:
o
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.
o
Enable extended status (ExtendedStatus On) in the configuration file.
o
Know the URL of the server statistics page for the server you want to monitor.
o
Know the user name and password for accessing the counters of the Apache server you want to
monitor, if required.
o
If using a proxy server to access the server, get the domain name and port of an HTTP Proxy
Server from your network administrator.
o
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
HPE SiteScope (11.33)
Page 62 of 924
Monitor Reference
Chapter 7: Apache Server Monitor
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
Configure the monitor properties as required.
For a description of each setting, see 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 server
URL
statistics URL which usually has the form of http://<servername>:<port>/serverstatus?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.
HPE SiteScope (11.33)
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 63 of 924
Monitor Reference
Chapter 7: 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
HPE SiteScope (11.33)
Page 64 of 924
Monitor Reference
Chapter 8: Azure Monitor
Chapter 8: Azure Monitor
The Azure monitor enables monitoring of Microsoft Azure infrastructure and retrieves performance metrics for
the infrastructure. The current implementation of the monitor retrieves metrics from categories such as Virtual
Machines (classic) and Storage services (classic and non-classic).
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and select the
Azure monitor.
Learn About
This section includes:
l
"Azure Monitor" above
l
"Azure Monitor" above
l
"Authentication Certificate" below
License Consumption
Points-based Usage
Capacity-based Usage
One point per 15 metrics
One OSi per monitored host for VMs.
Note: This monitor is not available when using Community edition.
Authentication Certificate
Create authentication certificate and upload it on Azure classic portal. See the Java documentation for more
details about key and certificate management tool.
Perform the following steps to create the certificate:
1. Generate a PFX file representing your client certificate using the following command:
<java-install-dir>/bin/keytool -genkey -alias <keystore-id>
-keystore <cert-store-dir>/<cert-file-name>.pfx -storepass <password>
-validity 3650 -keyalg RSA -keysize 2048 -storetype pkcs12
-dname "CN=Self Signed Certificate 20141118170652
2. Create a management certificate (CER file) from the PFX file using the command:
<java-install-dir>/bin/keytool -export -alias <keystore-id>
-storetype pkcs12 -keystore <cert-store-dir>/<cert-file-name>.pfx
-storepass <password> -rfc -file <cert-store-dir>/<cert-file-name>.cer
3. Convert the PFX file into JKS format using the command. Before you run the command, change directory
to the one containing the certificates.
<java-install-dir>/bin/keytool.exe -importkeystore
-srckeystore <cert-store-dir>/<cert-file-name>.pfx
HPE SiteScope (11.33)
Page 65 of 924
Monitor Reference
Chapter 8: Azure Monitor
-destkeystore <cert-store-dir>/<cert-file-name>.jks
-srcstoretype pkcs12 -deststoretype JKS
The command prompts you to enter the destination keystore password. Enter the password, which is
the password for the JKS file.
l
The commands prompts to enter the source keystore password. Enter the password you specified for
the PFX file.
l
Note: The two passwords do not have to be the same. You can also choose to not enter a
password. However, this is not recommended as it is not a good practice.
In each of the commands in step (1), (2), and (3)
<java-install-dir>/bin/keytool is the location where JDK is installed on the system where you
are running the command.
<keystore-id> is the keystore entry identifier, for example, AzureRemoteAccess.
<cert-store-dir> is the path to the directory in which you want to store certificates, for example
C:/Certificates.
<cert-file-name> is the name of the certificate file, for example, AzureWebDemoCert.
<password> is the password you choose to protect the certificate; it must be at least 6 characters
long. You can enter no password, although this is not recommended.
<dname> is the X.500 Distinguished Name to be associated with alias, and is used as the issuer and
subject fields in the self-signed certificate.
Save the PFS/JKS file in <SiS HomePath>/ install /multi/SiteScope/ templates.certificates folder.
Keep both the passwords handy.
4. Upload the management certificate to the Azure portal. To upload the certificate on the classic portal, go
to Settings > Management Certificates tab and click Upload and navigate to the location of the CER
file.
Tasks
How to Configure the Azure Monitor
1. Prerequisites
l
l
l
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
This monitor is available with all editions except Community edition. Contact your HPE sales
representative for more information.
A valid subscription to Azure service.
Upload the authentication certificate on Azure portal. See Authentication Certificate for details on how
to create the certificate.
HPE SiteScope (11.33)
Page 66 of 924
Monitor Reference
Chapter 8: Azure Monitor
2. Perform the following configuration tasks on the Azure Dashboard.
a. Create an Active Directory or use the default directory.
b. Create a user under the Active Directory and assign the role as Global Administrator.
c. Add the user to the Application Services group under the default directory and assign permissions to
the services. For the Service Management API, you must assign one delegated permission and for
Windows Azure Directory you must assign eight delegated permissions.
3. Configure the monitor properties. See the UI descriptions for details.
UI Descriptions
Azure Monitor Settings
User interface elements are described below:
UI Element
Description
HTTP Request Settings
Subscription ID
The unique alphanumeric token that is provided when you subscribe to the Azure
service.
Client ID
The ID assigned to you when you sign up for an Azure account. Used for request
authentication.
Domain ID
The domain ID of the Azure service for which you are subscribed.
Application Service Settings
Time Interval
Time interval is the period at which a metric is retrieved. For example, the API count
can be measured for a period like count of last 5 minutes or last one hour or similarly.
Time interval is applicable only for the Application Services category.
Default Value: 1 hour
Proxy Settings
HTTP Proxy
Domain name and port of an HTTP Proxy Server if required by the proxy server is to
access the server.
Proxy server user
name
Proxy server user name if required to access the Azure services.
Proxy server
password
Proxy server password if required to access the Azure services.
Note: Your proxy server must support Proxy-Authenticate for these options to
function.
Note: Your proxy server must support Proxy-Authentication for these options to
function.
Authentication Settings
HPE SiteScope (11.33)
Page 67 of 924
Monitor Reference
Chapter 8: Azure Monitor
UI Element
Description
Credentials
Use user name and password: Provide the user name and password to
authenticate to the Azure service.
Select predefined credentials: Select credentials that are already predefined to
authenticate to the Azure service.
Pre-emptive
authorization
Option for sending Authorization user name and Authorization password if SiteScope
requests the target Azure service:
l
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.
Authenticate first request. Sends the user name and password on the first
request SiteScope makes for the Azure service.
Note: If the service does not require a user name and password, this option may
cause the URL to fail.
l
Authenticate if requested. Sends the user name and password on the second
request if the server requests a user name and password.
Note: If the service 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.
Client side
certificate
Select the certificate (JKS or PFS file) required for the REST API request
authentication.
Client side
certificate
password
Password that is to be used while creating the JKS or PFS file.
Get Resource Group
Get Resource
Group
HPE SiteScope (11.33)
Select the Resource Group from the drop-down list or click Get Resource Group to
add a new resource group from the Azure portal. Resource Groups are automatically
created for any asset managed by Azure for monitoring, control access, billing and
other purposes.
Page 68 of 924
Monitor Reference
Chapter 8: Azure Monitor
UI Element
Description
Patterns &
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 "Azure
Monitor" on page 65.
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
By default, the following regular expressions are available:
l
/.*/Virtual Machine/.*/*Disk Read Operations\/.*\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Network In\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Disk Write Operation\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Disk Read Bytes\/.*\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Disk Write Bytes\(.*\)/Average/
l
/.*/Virtual Machine/.*/*CPU.*\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Disk Write Bytes\/.*\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Disk Read Operation\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Disk Write Operations\/.*\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Disk Read Bytes\(.*\)/Average/
l
/.*/Virtual Machine/.*/*Network Out\(.*\)/Average/
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.
Continue
displaying
counters that no
longer exist after
update
When selected, counters that no longer exist after the monitor periodically scans the
AWS Management Console, are still displayed in the monitor (they are displayed as
stopped). This is useful, for example, for keeping track of counters that were
previously being monitored.
Default value: 15 minutes
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
HPE SiteScope (11.33)
Page 69 of 924
Monitor Reference
Chapter 8: Azure 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
Virtual Machine
l
Disk Read Bytes
l
Disk Read Operations/Sec
l
Disk Write Bytes
l
Disk Write Operations/Sec
l
Network In
l
Network Out
l
Percentage CPU
AppServices
l
l
CPU Percentage(Percent)
l
Network In(Bytes)
l
Network Out(Bytes)
l
l
Disk Read Bytes/sec
(BytesPerSecond)
Disk Write Bytes/sec
(BytesPerSecond)
Average memory
working set
l
Blocked by Firewall
l
CPU percentage
l
DTU limit
l
CPU Time
l
DTU percentage
l
Data In
l
DTU used
l
Data Out
l
Data IO percentage
l
Http 101
l
Database size percentage
l
Http 2xx
l
Deadlocks
l
Http 3xx
l
Failed Connections
l
Http 401
l
In-Memory OLTP storage percent
l
Http 403
l
Log IO percentage
l
Http 404
l
Sessions percentage
l
Http 406
l
Successful Connections
l
Http 4xx
l
Total database size
l
Http Server Errors
l
Workers percentage
l
Memory working set
l
Requests
Virtual Machine(Classic)
l
Average Response
Time
Database Service (classic and nonclassic)
Storage
l
Id
l
Type
l
Location
HPE SiteScope (11.33)
Page 70 of 924
Monitor Reference
Chapter 8: Azure Monitor
Blob Metrics
Queue Metrics
Table Metrics
l
Timestamp
l
Timestamp
l
Timestamp
l
TotalRequests
l
TotalRequests
l
TotalRequests
l
TotalBillableRequests
l
TotalBillableRequests
l
TotalBillableRequests
l
TotalIngress(Bytes)
l
TotalIngress(Bytes)
l
TotalIngress(Bytes)
l
TotalEgress(Bytes)
l
TotalEgress(Bytes)
l
TotalEgress(Bytes)
l
Availability(Percent)
l
Availability(Percent)
l
Availability(Percent)
AverageE2ELatency
(milliseconds)
l
AverageServerLatency
(milliseconds)
l
l
l
AverageE2ELatency
(milliseconds)
AverageServerLatency
(milliseconds)
l
l
AverageE2ELatency
(milliseconds)
AverageServerLatency
(milliseconds)
l
PercentSuccess
l
PercentSuccess
l
PercentSuccess
l
PercentThrottlingError
l
PercentThrottlingError
l
PercentThrottlingError
l
PercentTimeoutError
l
PercentTimeoutError
l
PercentTimeoutError
l
PercentServerOtherError
l
PercentServerOtherError
l
PercentServerOtherError
l
PercentClientOtherError
l
PercentClientOtherError
l
PercentClientOtherError
l
PercentAuthorizationError
l
PercentAuthorizationError
l
PercentAuthorizationError
l
PercentNetworkError
l
PercentNetworkError
l
PercentNetworkError
l
PartitionKey
l
PartitionKey
l
PartitionKey
l
Success
l
Success
l
Success
l
AnonymousSuccess
l
AnonymousSuccess
l
AnonymousSuccess
l
SASSuccess
l
SASSuccess
l
SASSuccess
l
ThrottlingError
l
ThrottlingError
l
ThrottlingError
l
AnonymousThrottlingError
l
AnonymousThrottlingError
l
AnonymousThrottlingError
l
SASClientTimeoutError
l
SASClientTimeoutError
l
SASClientTimeoutError
l
ServerTimeoutError
l
ServerTimeoutError
l
ServerTimeoutError
l
AnonymousServerTimeoutError
l
AnonymousServerTimeoutError
l
AnonymousServerTimeoutError
l
SASServerTimeoutError
l
SASServerTimeoutError
l
SASServerTimeoutError
l
ClientOtherError
l
ClientOtherError
l
ClientOtherError
l
SASClientOtherError
l
SASClientOtherError
l
SASClientOtherError
l
AnonymousClientOtherError
l
AnonymousClientOtherError
l
AnonymousClientOtherError
l
ServerOtherError
l
ServerOtherError
l
ServerOtherError
l
AnonymousServerOtherError
l
AnonymousServerOtherError
l
AnonymousServerOtherError
l
SASServerOtherError
l
SASServerOtherError
l
SASServerOtherError
l
NetworkError
l
NetworkError
l
NetworkError
l
AnonymousNetworkError
l
AnonymousNetworkError
l
AnonymousNetworkError
l
SASNetworkError
l
SASNetworkError
l
SASNetworkError
HPE SiteScope (11.33)
Page 71 of 924
Monitor Reference
Chapter 8: Azure Monitor
HPE SiteScope (11.33)
Page 72 of 924
Chapter 9: 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.
License Consumption
Points-based Usage Capacity-based License
One point per metric
One OSi license per monitored host
Tasks
How to Configure the BroadVision Application Server Monitor
1. Prerequisites
l
l
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
You must know the Object Request Broker (ORB) port number for the BroadVision server you are
trying to monitor.
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 required.
HPE SiteScope (11.33)
Page 73 of 924
Monitor Reference
Chapter 9: BroadVision Application Server Monitor
For a description of each setting, see the UI Descriptions section below.
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 monitor. For
Counters 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.
HPE SiteScope (11.33)
Page 74 of 924
Monitor Reference
Chapter 9: 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_CACHE-MAX
• BV_GDBQUERY_CACHE-MISS
• BV_GDBQUERY_CACHE-SIZE
• BV_GDBQUERY_CACHE-SWAP
• BV_QUERY_CACHE-HIT
• BV_QUERY_CACHE-MAX
• BV_QUERY_CACHE-MISS
• BV_QUERY_CACHE-SIZE
• BV_QUERY_CACHE-SWAP
HPE SiteScope (11.33)
• 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_CONTENT-MAX
• CNT-CATEGORY_CONTENT-MISS
• CNT-CATEGORY_CONTENT-SIZE
• CNT-CATEGORY_CONTENT-SWAP
• 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-MSGSCHED-SWAP
• CNT-MSGSCRIPT-HIT
• CNT-MSGSCRIPT-MAX
• CNT-MSGSCRIPT-MISS
• CNT-MSGSCRIPT-SIZE
• CNT-MSGSCRIPT-SWAP
• 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-SECURITIES-MISS
• CNT-SECURITIES-SIZE
• CNT-SECURITIES-SWAP
• CNT-TEMPLATE-HIT
• CNT-TEMPLATE-MAX
• CNT-TEMPLATE-MISS
Page 75 of 924
Monitor Reference
Chapter 9: 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.
HPE SiteScope (11.33)
Page 76 of 924
Chapter 10: 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.
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
l
l
This monitor is only displayed in the user interface after deploying a Microsoft Exchange solution
template (requires Trial, Premium, Ultimate, or System Collector edition).
To enable the monitor, you must have an Operating System Instance (OSi) license with sufficient
available capacity. For license purchase inquiries (or if you require additional capacity), contact your
HPE sales representative or use the “Contact Us” link in the HPE SiteScope Product page.
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 required.
For a description of each setting, see the UI Descriptions section below.
HPE SiteScope (11.33)
Page 77 of 924
Monitor Reference
Chapter 10: 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 drop-down 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 to monitor.
Counters
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.
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.
HPE SiteScope (11.33)
Page 78 of 924
Chapter 11: 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the Check Point monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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
HPE SiteScope (11.33)
Page 79 of 924
Monitor Reference
Chapter 11: Check Point Monitor
UI Element
Description
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
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
HPE SiteScope (11.33)
Page 80 of 924
Chapter 12: 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
l
"License Consumption" below
Supported Platforms/Versions
This monitor supports monitoring on 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the Cisco Works Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see the UI Descriptions
section below.
Tip: The SNMP Browser Tool is available when configuring this monitor to verify the connection
HPE SiteScope (11.33)
Page 81 of 924
Monitor Reference
Chapter 12: Cisco Works Monitor
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.
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
l
CISCOWORKS-MIB file causes only those objects that are described within that
MIB file to be displayed.
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
l
l
Calculate delta. Calculates a simple delta of the current value from the previous
value.
Calculate rate. Calculates a rate calculation using the delta of current value from
previous value, divided by the time elapsed between measurements.
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.
HPE SiteScope (11.33)
Page 82 of 924
Monitor Reference
Chapter 12: 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.
Privacy
algorithm
The privacy algorithm used for authentication for SNMP version 3 (DES,128-Bit
AES,192-Bit AES, 256-Bit AES).
Default value: DES
Note: This field is available only if SNMP V3 is selected.
HPE SiteScope (11.33)
Page 83 of 924
Monitor Reference
Chapter 12: Cisco Works Monitor
UI Element
Description
Privacy
password
Privacy password for version 3 connections. Leave blank if you do not want privacy.
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.
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" below.
Note:
l
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.
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.
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
HPE SiteScope (11.33)
Page 84 of 924
Monitor Reference
Chapter 12: Cisco Works Monitor
• 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.
HPE SiteScope (11.33)
Page 85 of 924
Chapter 13: 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
l
"License Consumption" 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.5 Administrator's Guide (http://support.citrix.com/article/CTX106319), and about the
Terminal Services Session Object at http://msdn.microsoft.com/en-us/library/ms804500.aspx.
Supported Versions/Platforms
l
This monitor supports monitoring remote servers running on:
l
Citrix MetaFrame 1.8 Service Pack 3
l
Citrix MetaFrame XP(s,a,e) Feature Release 1/Service Pack 1
l
Citrix MetaFrame XP(s,a,e) Feature Release 2/Service Pack 2
l
Citrix Presentation Server 3.5, 4.x
l
Citrix XenApp 4.6, 5.0, 6.0, 6.5, 7.6
HPE SiteScope (11.33)
Page 86 of 924
Monitor Reference
Chapter 13: Citrix Monitor
l
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.
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)
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 Enable SiteScope to Prefer IP Version 6 Addresses in the Using SiteScope
Guide.
License Consumption
Points-based Usage Capacity Type License Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the Citrix Monitor
1. Prerequisites
The following are important requirements for using the Citrix monitor:
l
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
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
HPE SiteScope (11.33)
Page 87 of 924
Monitor Reference
Chapter 13: Citrix Monitor
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.
l
l
l
The Citrix Resource Manager must be available, installed, and running on the Citrix servers you want
to monitor.
One or more Citrix vusers must have established a connection with the Citrix server to enable viewing
of ICA Session object.
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 491.
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see 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
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 Windows Monitoring in
the Using SiteScope Guide.
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)
HPE SiteScope (11.33)
Page 88 of 924
Monitor Reference
Chapter 13: 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
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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
Configure SiteScope to Monitor Remote Windows Servers 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 monitor. For
Counters the list of counters that can be configured for this monitor, see "Monitor Objects" 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.
HPE SiteScope (11.33)
Page 89 of 924
Monitor Reference
Chapter 13: Citrix Monitor
Monitor Objects
Below is the list of Perfmon objects that can be configured for this monitor (if they are persist on the target
machine):
Citrix IMA Networking
Citrix MetaFrame Presentation Server
Citrix MetaFrame XP
ICA Session
Terminal Services Session
Terminal Services
Citrix Broker Service
Citrix Credential Wallet
Citrix Dazzle Resources Controller
Citrix Delegated Directory Claim Factory
Citrix Delegated Explicit Authentication
Citrix Delegated Kerberos Authentication
Citrix Delivery Services Web Application
Citrix Explicit Core Citrix Receiver for Web
Citrix Resource Subscription
Citrix Resources Common
Citrix Saml11 Tokens
Citrix Subscription Store
Citrix Subscription Store Synchronization
Citrix XML Service
Citrix Xml Service Communication
CitrixAdldentityService
CitrixAnalytics
CitrixConfigurationLogging
CitrixConfigurationService
CitrixDelegatedAdmin
CitrixEnvTest
CitrixHostService
CitrixMachineCreationService
CitrixMonitor
CitrixStorefront
Citrix CPU Utilization Mgmt User
Citrix Licensing
Tips/Troubleshooting
General Tips/Limitations
l
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.
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.
HPE SiteScope (11.33)
Page 90 of 924
Chapter 14: 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
l
"License Consumption " on the next page
Supported Platforms/Versions
l
l
This monitor supports monitoring ColdFusion 4.5.x, 9, 10, and 11 servers.
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
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.
HPE SiteScope (11.33)
Page 91 of 924
Monitor Reference
Chapter 14: ColdFusion Server Monitor
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the ColdFusion Server Monitor
1. Prerequisites
l
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
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 required.
For a description of each setting, see the UI Descriptions section below.
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: 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)
HPE SiteScope (11.33)
Page 92 of 924
Monitor Reference
Chapter 14: ColdFusion Server Monitor
UI
Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the server to be
monitored:
l
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
Version
Version of the ColdFusion Server you are monitoring (4.5x, 9, 10, 11).
Default value: 4.5x
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 monitor. For
Counters 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
HPE SiteScope (11.33)
Page 93 of 924
Monitor Reference
Chapter 14: ColdFusion Server Monitor
• 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.
HPE SiteScope (11.33)
Page 94 of 924
Chapter 15: 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.
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, 2008 R2, 2012, 2012 R2 Update 1.
License Consumption
Points-based Usage
Capacity-based Usage
One point per metric
One OSi license per monitored host.
Note: Additional licensing is required to enable this monitor type
in the
SiteScope interface after the free trial period expires.
Note: Not available with Community
edition.
Tasks
How to Configure the COM+ Monitor
1. Prerequisites
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 HPE Software Support site (you need to enter your HPE user name and password).
b. In the Search box, enter COM+ and click Search.
c. Download the COM+ probe from the results.
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
HPE SiteScope (11.33)
Page 95 of 924
Monitor Reference
Chapter 15: COM+ Server Monitor
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
Credentials Option for providing the user name and password authorization to the COM+ probe:
l
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.
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.
HPE SiteScope (11.33)
Page 96 of 924
Monitor Reference
Chapter 15: COM+ Server Monitor
UI Element
Description
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 timingout. 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" 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:
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.
HPE SiteScope (11.33)
Page 97 of 924
Chapter 16: 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.
License Consumption
This monitor requires no additional licensing beyond the licensing requirements of the member monitors which
it contains.
Tasks
How to Configure the Composite Monitor
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
HPE SiteScope (11.33)
Page 98 of 924
Monitor Reference
Chapter 16: 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" below. 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:
l
l
Run
monitors
The monitors that you add to the Composite monitor are placeholders. They become real
monitors when you deploy the Composite monitor.
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 is
delay
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).
Add Items Dialog Box
This dialog box enables you to select the monitors, groups, or both, that you want in the Composite monitor.
HPE SiteScope (11.33)
Page 99 of 924
Monitor Reference
Chapter 16: 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
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.
This monitor cannot be copied to a template. It must be created directly in a template.
HPE SiteScope (11.33)
Page 100 of 924
Chapter 17: 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" below
l
"Scheduling the Monitor" on the next page
l
"License Consumption" on the next page
Supported Platforms/Versions
l
l
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).
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
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:
HPE SiteScope (11.33)
Page 101 of 924
Monitor Reference
Chapter 17: CPU Monitor
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.
License Consumption
Points-based Usage
Capacity-based Usage
One point per monitor
One OSi license per monitored host
Note: No points are consumed by this monitor if it is running on a
host covered by the OS Instance Advanced license.
Tasks
How to Configure the CPU Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 102 of 924
Monitor Reference
Chapter 17: 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
l
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.
When configuring this monitor on SiteScopes running on UNIX versions, only remote
servers that have been configured with an SSH connection method are displayed.
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
l
Browse servers. Select a server from the drop-down list of servers in the local domain.
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.
Notes:
l
Add
Remote
Server
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.
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.
HPE SiteScope (11.33)
Page 103 of 924
Monitor Reference
Chapter 17: CPU Monitor
Tips/Troubleshooting
General Tips/Limitations
l
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.
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
l
If unable to monitor CPU usage on a Linux installation, check the sysstat package is deployed on the
target Linux system.
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.
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.
HPE SiteScope (11.33)
Page 104 of 924
Chapter 18: 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 HPE 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 111.
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
HPE SiteScope (11.33)
Page 105 of 924
Monitor Reference
Chapter 18: Custom Monitor
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 HPE
Live Network (https://hpln.hpe.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.
License Consumption
Points-based Usage
Capacity-based Usage
One point for every 10 metrics.
One OSi per 15 monitors of this type.
For example, 41 metrics consume 5 points.
Tasks
This section includes:
l
"How to Develop a Custom Monitor" below
l
"How to Debug a Custom Monitor Offline" on page 111
l
"How to Access the Monitor Configuration Parameters Exposed in the Script" on page 112
l
"How to Import and Use a Customizable Monitor" on page 113
How to Develop a Custom Monitor
1.
2.
Prerequisites
l
You must be an advanced user SiteScope with knowledge of JavaScript.
l
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.
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
HPE SiteScope (11.33)
Page 106 of 924
Monitor Reference
Chapter 18: Custom Monitor
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 112.
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:
l
l
A sample Custom monitor script is provided in the Data Processing Script box. To use it, you
need to uncomment the script.
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 113.
Note:
l
l
l
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.
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)
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
HPE SiteScope (11.33)
Page 107 of 924
Monitor Reference
Chapter 18: Custom Monitor
directory>\logs\custom_monitors. For details on changing the log to DEBUG mode, see
"Custom Monitor Logs" on page 117.
l
l
5.
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.
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:
packages\workspace\package_<>\lib. Used for storing external jar files used by the monitor script.
l
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note that they
should be copied with the entire package folder structure.
l
packages\workspace\package_<>\conf. Used for storing configuration files, documentation, and
XML files.
l
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).
l
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:
l
l
6.
Restart SiteScope for the changes to take effect, or
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 APM'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
HPE SiteScope (11.33)
Page 108 of 924
Monitor Reference
Chapter 18: Custom Monitor
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:
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:
l
11.
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.
l
Check status and values of the metrics in the SiteScope Dashboard.
l
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 in the Using SiteScope Guide.
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
HPE SiteScope (11.33)
Page 109 of 924
Monitor Reference
Chapter 18: Custom Monitor
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.
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.
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.
HPE SiteScope (11.33)
Page 110 of 924
Monitor Reference
Chapter 18: Custom Monitor
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:
l
l
Sending it to individual SiteScope users.
Sharing it with other SiteScope users by uploading it to the Community Content for SiteScope page
on HPE Live Network (https://hpln.hpe.com/group/sitescope). HPE 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 HPE Software portfolio.
For task details, see How to Publish Content to the HPE 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:
l
l
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
The Community Content for SiteScope page on the HPE 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 (SISProxy-2.0.min.js).
5. Import the Custom Monitor Debugging project into Eclipse IDE
HPE SiteScope (11.33)
Page 111 of 924
Monitor Reference
Chapter 18: Custom Monitor
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
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):
l
monitorName.
The name of the monitor.
l
monitorDescription. A description of the monitor.
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:
HPE SiteScope (11.33)
Page 112 of 924
Monitor Reference
Chapter 18: Custom Monitor
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 HPE Live Network (https://hpln.hpe.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
l
l
If a content package zip file was sent to you, skip to the next step.
If a content package was made available to the Community Content for SiteScope page on HPE Live
Network, download the content package to your SiteScope machine. HPE Live Network is an online
community providing a central location for HPE customers to share information and learn about addon content, extensions and related activities across the HPE Software portfolio.
For task details, see How to download a template or content package from the HPE 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
HPE SiteScope (11.33)
Page 113 of 924
Monitor Reference
Chapter 18: Custom Monitor
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:
l
l
l
l
\META-INF. Contains the manifest file where information about the content package is stored.
\templates. Contains files from which templates in this content package were imported into
SiteScope.
<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.
<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.
HPE SiteScope (11.33)
Page 114 of 924
Monitor Reference
Chapter 18: Custom Monitor
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
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.
HPE SiteScope (11.33)
Page 115 of 924
Monitor Reference
Chapter 18: Custom Monitor
UI Element
Description
Configuration
File
Use the Browse button to select the configuration file. The configuration file must be a
valid XML file. If it is not, then an error message is displayed. The XML configuration file
is copied into the conf folder of the monitor.
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 112.
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
l
l
l
lib. (Optional) Used for storing external jar files used by the monitor script. Note that
you can use this monitor without external jars.
classes. (Optional) Used for storing Java compiled classes; note that they should be
copied with the entire package folder structure.
conf. (Optional) Used for storing configuration files, documentation, and XML files.
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.
Enable monitor debugging: Select the checkbox to enable sending debugging logs for
custom monitors to a remote debugging server. Note that custom monitor debugging
must also be enabled in Infrastructure Preferences. (Infrastructure Preferences >
Custom Monitor Settings > Enable custom monitor debugging).
Checksum
Click Calculate Checksum to calculate the MD5 checksum of a specific folder and the
script.
Note: For information on configuring setting panels that are common to all monitors, see Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 116 of 924
Monitor Reference
Chapter 18: Custom Monitor
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Custom monitor.
l
"General Tips/Limitations" below
l
"Custom Monitor Logs" below
General Tips/Limitations
l
l
l
l
l
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.
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.
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.
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.
Setting status thresholds using a baseline is not supported on user-defined metrics.
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
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.
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
HPE SiteScope (11.33)
Page 117 of 924
Chapter 19: 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 third-party to process the data.
You can share custom monitors by publishing them to the HPE 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
l
"License Consumption" 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
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
HPE SiteScope (11.33)
Page 118 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
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 125.
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 HPE
Live Network (https://hpln.hpe.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.
License Consumption
Points-based Usage
Capacity-based Usage
One point for every 10 metrics.
One OSi license per monitored host.
For example, 41 metrics consume 5 points.
Tasks
This section includes:
l
"How to Develop a Custom Database Monitor" on the next page
l
"How to Debug a Custom Monitor Offline" on page 125
l
"How to Access the Monitor Configuration Parameters Exposed in the Script" on page 126
l
"How to Import and Use a Custom Database Monitor" on page 127
HPE SiteScope (11.33)
Page 119 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
How to Develop a Custom Database Monitor
1.
Prerequisites
l
You must be an advanced SiteScope user with knowledge of JavaScript.
l
Knowledge of SQL and the database systems being monitored.
l
2.
The database monitoring environment must be configured as described in "How to Configure the
Database Query Monitoring Environment" on page 185 (ignore the last step in the referenced 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.
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.
HPE SiteScope (11.33)
Page 120 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
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 126.
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:
l
l
A sample Custom Database monitor script is provided in the Data Processing Script box. To
use it, you need to uncomment the script.
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 Database
Monitor" on page 127.
Note:
l
l
l
l
l
5.
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.
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)
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 134.
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.
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
HPE SiteScope (11.33)
Page 121 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
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:
packages\workspace\package_<>\lib. Used for storing external jar files used by the monitor script.
l
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note that they
should be copied with the entire package folder structure.
l
packages\workspace\package_<>\conf. Used for storing configuration files, documentation, and
XML files.
l
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).
l
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:
l
l
6.
Restart SiteScope for the changes to take effect, or
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 APM'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:
HPE SiteScope (11.33)
Page 122 of 924
Monitor Reference
Chapter 19: 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:
l
11.
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.
l
Check status and values of the metrics in the SiteScope Dashboard.
l
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 in the Using SiteScope Guide.
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
HPE SiteScope (11.33)
Page 123 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
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.
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.
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.
HPE SiteScope (11.33)
Page 124 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
13.
Share the custom monitor with other SiteScope users - optional
You can distribute a content package zip file by:
l
l
Sending it to individual SiteScope users.
Sharing it with other SiteScope users by uploading it to the Community Content for SiteScope page
on HPE Live Network (https://hpln.hpe.com/group/sitescope). HPE 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 HPE Software portfolio.
For task details, see How to Publish Content to the HPE 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:
l
l
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
The Community Content for SiteScope page on the HPE 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 (SISProxy-2.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.
HPE SiteScope (11.33)
Page 125 of 924
Monitor Reference
Chapter 19: 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):
l
monitorName. The name of
l
monitorDescription.
the monitor.
A description of the monitor.
The following monitor properties are exposed to the script for the Custom Database monitor only:
l
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:
HPE SiteScope (11.33)
Page 126 of 924
Monitor Reference
Chapter 19: Custom Database 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 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 HPE Live Network (https://hpln.hpe.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
l
l
If a content package zip file was sent to you, skip to the next step.
If a content package was made available to the Community Content for SiteScope page on HPE Live
Network, download the content package to your SiteScope machine. HPE Live Network is an online
community providing a central location for HPE customers to share information and learn about addon content, extensions and related activities across the HPE Software portfolio.
For task details, see How to download a template or content package from the HPE 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:
HPE SiteScope (11.33)
Page 127 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
l
l
l
l
\META-INF. Contains the manifest file where information about the content package is stored.
\templates. Contains files from which templates in this content package were imported into
SiteScope.
<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.
<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
HPE SiteScope (11.33)
Page 128 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
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). 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.
Database
driver
Java class name of the JDBC database driver. 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.
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.
HPE SiteScope (11.33)
Page 129 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
UI Element
Description
Database
user name
User name used to log on to the database.
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.
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.
With Windows Authentication, SiteScope connects using the login account of the
SiteScope service.
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
HPE SiteScope (11.33)
Page 130 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
UI Element
Description
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.
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
field
Enumeration means the monitor retrieves the rows that were added to the 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
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
HPE SiteScope (11.33)
Page 131 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
UI Element
Description
Initial
enumerating
value
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
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.
Configuration Use the Browse button to select the configuration file. The configuration file must be a
File
valid XML file. If it is not, then an error message is displayed. The XML configuration file is
copied into the conf folder of the monitor.
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 126.
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.
HPE SiteScope (11.33)
Page 132 of 924
Monitor Reference
Chapter 19: 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
l
l
l
lib. (Optional) Used for storing external jar files used by the monitor script. Note that
you can use this monitor without external jars.
classes. (Optional) Used for storing Java compiled classes; note that they should be
copied with the entire package folder structure.
conf. (Optional) Used for storing configuration files, documentation, and XML files.
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.
Enable monitor debugging: Select the checkbox to enable sending debugging logs for
custom monitors to a remote debugging server. Note that custom monitor debugging must
also be enabled in Infrastructure Preferences. (Infrastructure Preferences > Custom
Monitor Settings > Enable custom monitor debugging).
Checksum
Click Calculate Checksum to calculate the MD5 checksum of a specific folder and the
script.
Use Tool
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 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.
(Lower left
side of the
New Custom
Database
Monitor dialog
box)
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.
l
"General Tips/Limitations" on the next page
l
"Custom Monitor Logs" on the next page
HPE SiteScope (11.33)
Page 133 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
l
"Possible Errors Using the Oracle Thin Driver" below
l
"Possible Errors Using the MySQL Driver" on the next page
l
"Possible Errors with Sybase Database Monitoring" on the next page
General Tips/Limitations
l
l
l
l
l
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.
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.
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.
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.
Setting status thresholds using a baseline is not supported on user-defined metrics.
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
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.
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
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.
HPE SiteScope (11.33)
Page 134 of 924
Monitor Reference
Chapter 19: Custom Database Monitor
l
l
l
l
l
l
l
l
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.
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.
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.
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.
String Index out of range: -1: in Database connection URL, check for the database server address, port,
and the database SID.
error, driver connect error, oracle.jdbc.driver.OracleDriver: check syntax in Database driver.
error, driver connect error, oracle.jdbc.driver.OracleDriver: check that driver is loaded in correct
place.
error, connect error, No suitable driver: check driver specified in Database driver.
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
l
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.
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.
connect error, JZ006: Caught IOException: java.net.UnknownHostException: dbservername.
Verify the name of the database server in Database connection URL is correct.
HPE SiteScope (11.33)
Page 135 of 924
Chapter 20: 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 HPE 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 the next page
l
"Support for IPv6 Addresses" on page 138
l
"License Consumption" on page 138
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.
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.
HPE SiteScope (11.33)
Page 136 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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 146.
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 HPE
Live Network (https://hpln.hpe.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 152 property.
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:
l
l
l
Run alerts: Select the For each log entry matched option.
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)/.
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.
HPE SiteScope (11.33)
Page 137 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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.
License Consumption
Points-based Usage
Capacity-based Usage
One point for every 10 metrics.
One OSi license per monitored host.
For example, 41 metrics consume 5 points.
Tasks
This section includes:
l
"How to Develop the Custom Log File Monitor" below
l
"How to Debug a Custom Monitor Offline" on page 146
l
"How to Access the Monitor Configuration Parameters Exposed in the Script" on page 147
l
"How to Import and Use a Custom Log File Monitor" on page 148
How to Develop the Custom Log File Monitor
1.
Prerequisites
l
l
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.
The following configuration requirements must be performed or verified before the Custom Log File
HPE SiteScope (11.33)
Page 138 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
monitor can be used:
2.
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" below.
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 values (grouping)" on
the next page.
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 141.
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
l
Configure the following properties in Custom Log File Monitor Settings:
Content match: /ERROR/
l
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
HPE SiteScope (11.33)
Page 139 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
Example B - Configuring a Custom Log File monitor with matching custom values
(grouping)
l
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
l
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
HPE SiteScope (11.33)
Total Memory=496MB
Total Memory=496MB
Page 140 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
Example C - Configuring a Custom Log File monitor to run on a remote UNIX server
l
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
l
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 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.
HPE SiteScope (11.33)
Page 141 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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 147.
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:
l
l
A sample Custom Log File monitor script is provided in the Data Processing Script box. To use
it, you need to uncomment the script.
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 148.
Note:
l
l
l
l
l
5.
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.
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)
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 156.
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.
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
HPE SiteScope (11.33)
Page 142 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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:
packages\workspace\package_<>\lib. Used for storing external jar files used by the monitor script.
l
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note that they
should be copied with the entire package folder structure.
l
packages\workspace\package_<>\conf. Used for storing configuration files, documentation, and
XML files.
l
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).
l
You can copy the required files to these folders at this stage, or when performing "Custom Log File
Monitor" on page 136.
Note: If you add or modify jars/classes after the first monitor run, you must either:
l
l
6.
Restart SiteScope for the changes to take effect, or
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 APM'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:
HPE SiteScope (11.33)
Page 143 of 924
Monitor Reference
Chapter 20: Custom Log File 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:
l
11.
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.
l
Check status and values of the metrics in the SiteScope Dashboard.
l
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 in the Using SiteScope Guide.
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
HPE SiteScope (11.33)
Page 144 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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.
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.
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.
HPE SiteScope (11.33)
Page 145 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
13.
Share the custom monitor with other SiteScope users - optional
You can distribute a content package zip file by:
l
l
Sending it to individual SiteScope users.
Sharing it with other SiteScope users by uploading it to the Community Content for SiteScope page
on HPE Live Network (https://hpln.hpe.com/group/sitescope). HPE 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 HPE Software portfolio.
For task details, see How to Publish Content to the HPE 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:
l
l
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
The Community Content for SiteScope page on the HPE 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 (SISProxy-2.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.
HPE SiteScope (11.33)
Page 146 of 924
Monitor Reference
Chapter 20: Custom Log File 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 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):
l
monitorName.
The name of the monitor.
l
monitorDescription. A description of the monitor.
The following monitor properties are exposed to the script for the Custom Log File monitor only:
l
l
server.
The name of the server where the log file you want to monitor is located.
l
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
HPE SiteScope (11.33)
Page 147 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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 HPE Live Network (https://hpln.hpe.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
l
l
If a content package zip file was sent to you, skip to the next step.
If a content package was made available to the Community Content for SiteScope page on HPE Live
Network, download the content package to your SiteScope machine. HPE Live Network is an online
community providing a central location for HPE customers to share information and learn about addon content, extensions and related activities across the HPE Software portfolio.
For task details, see How to download a template or content package from the HPE 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:
HPE SiteScope (11.33)
Page 148 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
l
l
l
l
\META-INF. Contains the manifest file where information about the content package is stored.
\templates. Contains files from which templates in this content package were imported into
SiteScope.
<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.
<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
HPE SiteScope (11.33)
Page 149 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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 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)
HPE SiteScope (11.33)
Page 150 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
UI Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the server
to be monitored:
l
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
Log file path
Path to the log file you want to monitor.
l
l
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.
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
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 date-coded log file. For
details on using regular expressions, refer to SiteScope Date Variables in the Using
SiteScope Guide.
HPE SiteScope (11.33)
Page 151 of 924
Monitor Reference
Chapter 20: 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:
l
Error if matchCount > 1
l
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 137.
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
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
HPE SiteScope (11.33)
Page 152 of 924
Monitor Reference
Chapter 20: Custom Log File 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
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 365, 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.
Server-side
processing
Processes log file data on the 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.
Default value: Not selected
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
l
l
Return
matching raw
data from
server-side
Server-side processing is available for remote Linux, Red Hat Enterprise Linux, and
Oracle Solaris servers only. Windows SSH is not supported.
Rule files are not supported in this mode.
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).
Returns the whole row of raw data with matching patterns from the server-side when a
match is found.
Default value: Not selected
Note: This setting is only available when Server-side processing is selected.
HPE SiteScope (11.33)
Page 153 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
UI Element
Description
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
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.
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.
HPE SiteScope (11.33)
Page 154 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
UI Element
Description
Configuration Use the Browse button to select the configuration file. The configuration file must be a
File
valid XML file. If it is not, then an error message is displayed. The XML configuration file is
copied into the conf folder of the monitor.
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 147.
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
l
l
l
lib. (Optional) Used for storing external jar files used by the monitor script. Note that
you can use this monitor without external jars.
classes. (Optional) Used for storing Java compiled classes; note that they should be
copied with the entire package folder structure.
conf. (Optional) Used for storing configuration files, documentation, and XML files.
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.
Enable monitor debugging: Select the checkbox to enable sending debugging logs for
custom monitors to a remote debugging server. Note that custom monitor debugging must
also be enabled in Infrastructure Preferences. (Infrastructure Preferences > Custom
Monitor Settings > Enable custom monitor debugging).
Checksum
Click Calculate Checksum to calculate the MD5 checksum of a specific folder and the
script.
Note: For information on configuring setting panels that are common to all monitors, see Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 155 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
Tips/Troubleshooting
This section describes troubleshooting and limitations for the Custom Log File monitor.
l
"General Tips/Limitations" below
l
"Custom Monitor Logs" below
General Tips/Limitations
l
l
l
l
l
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.
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.
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.
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.
Setting status thresholds using a baseline is not supported on user-defined metrics.
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
l
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 320.
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.
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.
Custom Monitor Logs
l
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.
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
HPE SiteScope (11.33)
Page 156 of 924
Monitor Reference
Chapter 20: Custom Log File Monitor
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
HPE SiteScope (11.33)
Page 157 of 924
Chapter 21: 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 HPE 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 YouTube:
l
l
Custom WMI Monitor Creation Process and Packaging http://www.youtube.com/watch?v=bB6NlTGdd88
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.
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
HPE SiteScope (11.33)
Page 158 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
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 HPE
Live Network (https://hpln.hpe.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.
License Consumption
Points-based Usage
Capacity-based Usage
1 point for every 10 metrics.
One OSi license per monitored host
For example, 41 metrics consume 5 points.
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 166
l
"How to Import and Use a Custom WMI Monitor" on page 167
How to Develop the Custom WMI Monitor
1.
Prerequisites
l
l
You should be an advanced SiteScope user with knowledge of writing scripts in JavaScript, and have
knowledge of WMI and WQL.
The following are requirements for using SiteScope to collect performance measurements on a
HPE SiteScope (11.33)
Page 159 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
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/en-us/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 172.
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 > 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
HPE SiteScope (11.33)
Page 160 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
> 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 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 166.
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:
l
l
A sample Custom WMI monitor script is provided in the Data Processing Script box. To use it,
you need to uncomment the script.
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 167.
Note:
l
l
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.
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)
HPE SiteScope (11.33)
Page 161 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
(requires Read permissions).
o
l
l
l
5.
<SiteScope root directory>\logs\custom_monitors\* (all permissions)
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 173.
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.
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:
packages\workspace\package_<>\lib. Used for storing external jar files used by the monitor script.
l
packages\workspace\package_<>\classes. Used for storing compiled Java classes; note that they
should be copied with the entire package folder structure.
l
packages\workspace\package_<>\conf. Used for storing configuration files, documentation, and
XML files.
l
packages\workspace\package_<>\template. Used for storing the template files that contain the
custom monitor (you perform this in "Custom WMI Monitor" on page 158).
l
You can copy the required files to these folders at this stage, or when performing "Custom WMI Monitor"
on page 158.
Note: If you add or modify jars/classes after the first monitor run, you must either:
l
l
6.
Restart SiteScope for the changes to take effect, or
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 APM'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
HPE SiteScope (11.33)
Page 162 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
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:
l
11.
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.
l
Check status and values of the metrics in the SiteScope Dashboard.
l
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 in the Using SiteScope Guide.
12.
Create a content package - optional
a. Copy the files used for creating the monitor to the predefined content package subfolders:
HPE SiteScope (11.33)
Page 163 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
<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.
o
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 158). 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.
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
HPE SiteScope (11.33)
Page 164 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
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.
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:
l
l
Sending it to individual SiteScope users.
Sharing it with other SiteScope users by uploading it to the Community Content for SiteScope page
on HPE Live Network (https://hpln.hpe.com/group/sitescope). HPE 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 HPE Software portfolio.
For task details, see How to Publish Content to the HPE 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:
l
<SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject.
HPE SiteScope (11.33)
Page 165 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
l
The Community Content for SiteScope page on the HPE 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 (SISProxy-2.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
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):
HPE SiteScope (11.33)
Page 166 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
l
monitorName.
The name of the monitor.
l
monitorDescription.
A description of the monitor.
The following monitor properties are exposed to the script for the Custom WMI monitor only:
server.
l
l
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:
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 HPE Live Network (https://hpln.hpe.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
l
l
If a content package zip file was sent to you, skip to the next step.
If a content package was made available to the Community Content for SiteScope page on HPE Live
Network, download the content package to your SiteScope machine. HPE Live Network is an online
community providing a central location for HPE customers to share information and learn about addon content, extensions and related activities across the HPE Software portfolio.
For task details, see How to download a template or content package from the HPE 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
HPE SiteScope (11.33)
Page 167 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
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:
l
l
l
l
\META-INF. Contains the manifest file where information about the content package is stored.
\templates. Contains files from which templates in this content package were imported into
SiteScope.
<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.
<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.
HPE SiteScope (11.33)
Page 168 of 924
Monitor Reference
Chapter 21: 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
HPE SiteScope (11.33)
Page 169 of 924
Monitor Reference
Chapter 21: 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.
Configuration Use the Browse button to select the configuration file. The configuration file must be a
File
valid XML file. If it is not, then an error message is displayed. The XML configuration file is
copied into the conf folder of the monitor.
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.
HPE SiteScope (11.33)
Page 170 of 924
Monitor Reference
Chapter 21: 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 166.
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.
HPE SiteScope (11.33)
Page 171 of 924
Monitor Reference
Chapter 21: 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
l
l
l
lib. (Optional) Used for storing external jar files used by the monitor script. Note that
you can use this monitor without external jars.
classes. (Optional) Used for storing Java compiled classes; note that they should be
copied with the entire package folder structure.
conf. (Optional) Used for storing configuration files, documentation, and XML files.
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.
Enable monitor debugging: Select the checkbox to enable sending debugging logs for
custom monitors to a remote debugging server. Note that custom monitor debugging must
also be enabled in Infrastructure Preferences. (Infrastructure Preferences > Custom
Monitor Settings > Enable custom monitor debugging).
Checksum
Click Calculate Checksum to calculate the MD5 checksum of a specific folder and the
script.
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 the next page
General Tips/Limitations
l
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.
When setting custom monitor metrics with a string (non-numeric) value, the maximum and average values
HPE SiteScope (11.33)
Page 172 of 924
Monitor Reference
Chapter 21: Custom WMI Monitor
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
l
l
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.
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.
Setting status thresholds using a baseline is not supported on user-defined metrics.
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
l
l
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.
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.
If running a dynamic query from within a data processing script fails, an exception is thrown.
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.
Custom Monitor Logs
l
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.
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
HPE SiteScope (11.33)
Page 173 of 924
Chapter 22: Database Counter Monitor
Use the Database Counter monitor to make SQL queries for performance metrics from any JDBC-accessible
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 176
l
"Database Counter Topology" on page 176
l
"License Consumption" on page 177
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:
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:
l
l
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/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.
HPE SiteScope (11.33)
Page 174 of 924
Monitor Reference
Chapter 22: Database Counter Monitor
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.
l
com.mercury.jdbc.oracle.OracleDriver. A driver for Oracle databases. When using the driver deployed
with SiteScope, the database connection URL has the form of: jdbc:mercury:oracle://<server
name or IP address>:<database server port>;sid=<sid>
Note: The URL format may differ if you are using another JDBC driver, since the JDBC URL
depends on the driver.
l
l
oracle.jdbc.driver.OracleDriver. SiteScope supports the following categories of JDBC driver supplied
by Oracle that are compatible with Java 7:
o
JDBC thin driver for Oracle 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 177.
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:
l
l
jdbc:mercury:sqlserver://<hostname or
FQDN>:1433;DatabaseName=master;AuthenticationMethod=type2
where <hostname or FQDN> is the name of the host where the database is running.
jdbc:oracle:thin:@<hostname or FQDN>:<port>/<service>
where <hostname or FQDN> is the name of the host where the database is running, <port> is the port on
which the database interfaces with the driver, and <service> is the Oracle service name.
When monitoring Oracle RAC databases, the database connection URL has the form of:
jdbc:oracle:thin:@<SCAN (Single Client Access Name) listener>:<port>/<database
service name>
l
l
l
jdbc:postgresql://<hostname or FQDN>:<port>/<dbname>
where <hostname or FQDN> 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 Postgresql database.
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 ojdbc6.jar files from two different versions of
Oracle is unlikely to work.
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).
HPE SiteScope (11.33)
Page 175 of 924
Monitor Reference
Chapter 22: Database Counter Monitor
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:
l
l
l
Database connection URL: jdbc:mercury:sqlserver://<server name or
IP address>:1433;DatabaseName=<database name>;
AuthenticationMethod=type2.
Database driver: com.mercury.jdbc.sqlserver.SQLServerDriver.
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 APM's RTSM.
HPE SiteScope (11.33)
Page 176 of 924
Monitor Reference
Chapter 22: Database Counter Monitor
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host.
Tasks
This section includes:
l
"How to Configure the Database Counter Monitor" below
l
"How to access Oracle databases using OCI driver" below
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 174.
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see 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 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
HPE Integration Settings (the default setting). For details on the monitor topology, see "Database
Counter Topology" on the previous page.
For user interface details, see "APM 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.
l
Set ORACLE_HOME environment variable (ORACLE_HOME is the folder where the Oracle client or
database has been installed).
HPE SiteScope (11.33)
Page 177 of 924
Monitor Reference
Chapter 22: Database Counter Monitor
l
l
Add ORACLE_HOME\lib to System PATH (on Windows platforms), or LD_LIBRARY_PATH env
variable (on UNIX platforms).
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:
l
Database connection URL: jdbc:oracle:oci8:@<service name>
l
Database driver: oracle.jdbc.driver.OracleDriver
l
Enter the database user credentials in the Database user name and Database password boxes.
5. Copy the ocijdbc11.dll into ORACLE_HOME\java\lib and ojdbc5.jar into ORACLE_HOME\Java\lib\ext
or ORACLE_HOME\Web-INF\lib. You must manually copy these if the OS environment PATH does not
load them.
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.
HPE SiteScope (11.33)
Page 178 of 924
Monitor Reference
Chapter 22: Database Counter Monitor
UI Element
Description
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 monitorbased timeout.
Database
machine
name
Identifier for the target database server, as it should be reported to APM.
Database
port
Port number, for the target database server, as it should be reported to APM. 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.
Note: This field is used only for topology reporting.
Database
instance
name
Name of the database instance, as it should be reported to APM.
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:
l
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.
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.
HPE SiteScope (11.33)
Page 179 of 924
Monitor Reference
Chapter 22: Database Counter Monitor
UI Element
Description
No divide
counters
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.
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 Common
HPE SiteScope (11.33)
Page 180 of 924
Monitor Reference
Chapter 22: Database Counter Monitor
Monitor Settings in the Using SiteScope Guide.
Tips/Troubleshooting
General Tips/Limitations
l
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.
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.
HPE SiteScope (11.33)
Page 181 of 924
Chapter 23: 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 e-commerce
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 184
l
"Database Query Topology" on page 184
l
"License Consumption" on page 185
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 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
HPE SiteScope (11.33)
Page 182 of 924
Monitor Reference
Chapter 23: Database Query Monitor
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.
You must know the syntax for accessing the database driver. Examples of common database driver
strings are:
l
l
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.
l
com.mercury.jdbc.oracle.OracleDriver. A driver for Oracle databases. When using the driver deployed
with SiteScope, the database connection URL has the form of: jdbc:mercury:oracle://<server
name or IP address>:<database server port>;sid=<sid>
Note: The URL format may differ if you are using another JDBC driver, since the JDBC URL
depends on the driver.
l
l
oracle.jdbc.driver.OracleDriver.SiteScope supports the following categories of JDBC driver supplied
by Oracle that are compatible with Java 7:
o
JDBC thin driver for Oracle 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 186.
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:
l
l
l
jdbc:mercury:sqlserver://<hostname or
FQDN>:1433;DatabaseName=master;AuthenticationMethod=type2
where <hostname or FQDN> is the name of the host where the database is running.
jdbc:oracle:thin:@<hostname or FQDN>:<port>/<service>
where <hostname or FQDN> is the name of the host where the database is running, <port> is the port on
which the database interfaces with the driver, and <service> is the Oracle service name.
The database you want to monitor needs to be running, have a database name defined, and have at least
HPE SiteScope (11.33)
Page 183 of 924
Monitor Reference
Chapter 23: Database Query Monitor
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.
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.
l
Note: When Windows authentication is used to connect to the database, configure SiteScope using the
following settings:
l
l
l
Database connection URL: jdbc:mercury:sqlserver://<server name or
IP address>:1433;DatabaseName=<database name>;
AuthenticationMethod=type2.
Database driver: com.mercury.jdbc.sqlserver.SQLServerDriver.
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 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 APM's RTSM.
HPE SiteScope (11.33)
Page 184 of 924
Monitor Reference
Chapter 23: Database Query Monitor
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license per monitored host.
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 Using JDBC" on page 187
l
"How to Enable SiteScope to Monitor an Informix Database" on page 188
l
"How to Enable SiteScope to Monitor a MySQL Database" on page 188
l
"How to Enable SiteScope to Monitor a Sybase Database" on page 189
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 182.
HPE SiteScope (11.33)
Page 185 of 924
Monitor Reference
Chapter 23: Database Query Monitor
2. Configure the database driver
You can monitor an Oracle database using an OCI driver. For details, see "How to Access Oracle
Databases Using OCI Driver" below.
l
You can monitor an Oracle database using the Oracle Thin JDBC Driver. For details, see "How to
Access Oracle Databases Using JDBC" on the next page.
l
3. Enable SiteScope to monitor the database
For details on enabling SiteScope to monitor an Informix database, see "How to Enable SiteScope to
Monitor an Informix Database" on page 188.
l
For details on enabling SiteScope to monitor a MySQL database, see "How to Enable SiteScope to
Monitor a MySQL Database" on page 188.
l
For details on enabling SiteScope to monitor a Sybase database, see "How to Enable SiteScope to
Monitor a Sybase Database" on page 189.
l
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 193.
5. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
Tip:
l
l
l
l
The Database Connection Tool is available when configuring this monitor to test and verify
connectivity between SiteScope and an external 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.
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.
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.
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.
HPE SiteScope (11.33)
Page 186 of 924
Monitor Reference
Chapter 23: Database Query Monitor
l
l
l
Set ORACLE_HOME environment variable (ORACLE_HOME is the folder where the Oracle client or
database has been installed).
Add ORACLE_HOME\lib to System PATH (on Windows platforms), or LD_LIBRARY_PATH env
variable (on UNIX platforms).
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:
l
Database connection URL: jdbc:oracle:oci8:@<service name>
l
Database driver: oracle.jdbc.driver.OracleDriver
l
Enter the database user credentials in the Database user name and Database password boxes
5. Copy the ocijdbc11.dll into ORACLE_HOME\java\lib and ojdbc5.jar into ORACLE_HOME\Java\lib\ext
or ORACLE_HOME\Web-INF\lib. You must manually copy these if the OS environment PATH does not
load them.
How to Access Oracle Databases Using JDBC
You can use the Oracle Thin JDBC Drivers to monitor an Oracle database using JDBC.
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:
l
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
When monitoring Oracle RAC databases, the database connection URL has the form of:
jdbc:oracle:thin:@<SCAN (Single Client Access Name) listener>:<port>/<database
service name>
Note: After the word thin is a colon (:) and an at (@) symbol.
l
Database driver. Enter the following string: oracle.jdbc.driver.OracleDriver.
HPE SiteScope (11.33)
Page 187 of 924
Monitor Reference
Chapter 23: Database Query Monitor
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:
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:
l
Database connection URL. The format for the Informix JDBC driver is:
jdbc:informix-sqli://<database hostname>:<tcp port><database
server>:INFORMIXSERVER=<database>
l
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:informix-sqli://pond.thiscompany.com:1526/sysmaster:INFORMIXSERVER=maindbase;
l
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:
l
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
If you are using a different port to connect to the database, include that port number as part of the IP
HPE SiteScope (11.33)
Page 188 of 924
Monitor Reference
Chapter 23: Database Query Monitor
address.
l
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:
l
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
l
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
l
Database driver. Enter com.sybase.jdbc.SybDriver (for Sybase version 4.x) or
com.sybase.jdbc2.jdbc.SybDriver (for Sybase version 5.x).
l
Enter the Database user name and Database password.
l
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
HPE SiteScope (11.33)
Page 189 of 924
Monitor Reference
Chapter 23: 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 JDBC to create a
named connection to a database.
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.
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.
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.
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.
With Windows Authentication, SiteScope connects using the login
account of the SiteScope service.
HPE SiteScope (11.33)
Page 190 of 924
Monitor Reference
Chapter 23: Database Query Monitor
UI Element
Description
Query
SQL query to test.
Example: select * from sysobjects
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
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.
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
Text identifier describing the database server that this monitor is
monitoring if you are reporting monitor data to an installation of APM.
Note: This field is used only for topology reporting.
HPE SiteScope (11.33)
Page 191 of 924
Monitor Reference
Chapter 23: Database Query Monitor
UI Element
Description
Database port
Port number, for the target database server, as it should be reported to
APM. 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 APM.
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.
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
HPE SiteScope (11.33)
Page 192 of 924
Monitor Reference
Chapter 23: Database Query Monitor
UI Element
Description
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.
General Tips
l
l
l
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.
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).
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.
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
l
l
l
l
l
error, connect error, No suitable driver: check for syntax errors in Database connection URL, such as
dots instead of colons.
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.
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.
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.
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.
String Index out of range: -1: in Database connection URL, check for the database server address, port,
HPE SiteScope (11.33)
Page 193 of 924
Monitor Reference
Chapter 23: Database Query Monitor
and the database SID.
l
l
l
l
error, driver connect error, oracle.jdbc.driver.OracleDriver: check syntax in Database driver.
error, driver connect error, oracle.jdbc.driver.OracleDriver: check that driver is loaded in correct
place.
error, connect error, No suitable driver: check driver specified in Database driver.
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
l
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.
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.
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.
HPE SiteScope (11.33)
Page 194 of 924
Chapter 24: 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
l
"License Consumption" on the next page
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 APM's RTSM.
HPE SiteScope (11.33)
Page 195 of 924
Monitor Reference
Chapter 24: DB2 JDBC Monitor
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the DB2 JDBC Monitor
1. Prerequisites
l
l
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.
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 required.
For a description of each setting, see 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 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
HPE SiteScope (11.33)
Page 196 of 924
Monitor Reference
Chapter 24: DB2 JDBC Monitor
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 195.
For user interface details, see APM 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
Option for providing the user name and password to be used to access
the DB2 database server:
l
l
Partition
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.
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
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.
HPE SiteScope (11.33)
Page 197 of 924
Monitor Reference
Chapter 24: DB2 JDBC Monitor
UI Element
Description
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 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.
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
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.
HPE SiteScope (11.33)
Page 198 of 924
Monitor Reference
Chapter 24: 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
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.
When deploying this monitor using a template, an error message is displayed if you clear the Verify
monitor properties with remote server option in the Deployment Values dialog box.
HPE SiteScope (11.33)
Page 199 of 924
Monitor Reference
Chapter 24: DB2 JDBC Monitor
l
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.
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.
HPE SiteScope (11.33)
Page 200 of 924
Chapter 25: 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license per monitored host
Tasks
How to Configure the DHCP Monitor
1. Prerequisites
This monitor requires that a third-party Java DHCP library (version 1.1.1) 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>\WEB-INF\lib
directory.
c. After installing the JDHCP.jar file, restart the SiteScope service.
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
HPE SiteScope (11.33)
Page 201 of 924
Monitor Reference
Chapter 25: DHCP Monitor
UI Descriptions
DHCP Monitor Settings
User interface elements are described below:
UI Element
Description
Requested
client
address
IPv4
IPv4 address of the client to request from the DHCP server (optional).
Timeout
(seconds)
Amount of time, in seconds, to wait for a response from a DHCP server.
DHCP
Server IPv4
IPv4 address of the DHCP server for monitoring (optional).
MAC
address
MAC address of the network adapter on the SiteScope server.
Default value: 10 seconds
The DHCP server can be located on the same or a different subnet to the SiteScope server,
according to the MAC address option selected below.
l
l
<MAC addresses>. Lists the available MAC addresses. When a listed MAC address is
selected, the DHCP monitor can monitor a DHCP server located on the same subnet, or
on a different subnet to the SiteScope server.
Random address. When selected, the DHCP monitor can only monitor a DHCP server
that is located on the same subnet as the SiteScope server.
Note: For information on configuring setting panels that are common to all monitors, see Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 202 of 924
Chapter 26: 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
l
"License Consumption" on the next page
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
l
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.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
HPE SiteScope (11.33)
Page 203 of 924
Monitor Reference
Chapter 26: Directory Monitor
License Consumption
Points-based Usage
Capacity-based Usage
One point per monitor
One OSi license per monitored host
Note: No points are consumed by this monitor if it is running on a
host covered by the OS Instance Advanced license.
Tasks
How to Configure the Directory Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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)
HPE SiteScope (11.33)
Page 204 of 924
Monitor Reference
Chapter 26: Directory Monitor
UI Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the server
to be monitored:
l
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
Directory path
Directory that you want to monitor.
l
l
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.
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.
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
HPE SiteScope (11.33)
Page 205 of 924
Monitor Reference
Chapter 26: Directory Monitor
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
• 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.
HPE SiteScope (11.33)
Page 206 of 924
Chapter 27: 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 214. 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 214.
Supported Platforms/Versions
l
l
l
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.
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 320.
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.
To monitor Microsoft Windows Server 2008 using WMI, install the Microsoft hot fix
HPE SiteScope (11.33)
Page 207 of 924
Monitor Reference
Chapter 27: Disk Space Monitor (Deprecated)
(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
l
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
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 required.
For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 208 of 924
Monitor Reference
Chapter 27: Disk Space Monitor (Deprecated)
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
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.
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
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
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.
HPE SiteScope (11.33)
Page 209 of 924
Monitor Reference
Chapter 27: Disk Space Monitor (Deprecated)
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.
HPE SiteScope (11.33)
Page 210 of 924
Chapter 28: 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license for 10 monitors
Tasks
How to Configure the DNS Monitor
Configure the monitor properties as required.
For a description of each setting, see 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
HPE SiteScope (11.33)
Page 211 of 924
Monitor Reference
Chapter 28: DNS Monitor
editing a monitor, click the Use Tool button. For details on the tool, see DNS Tool in the Using SiteScope
Guide.
UI Descriptions
DNS Monitor Settings
User interface elements are described below:
UI Element
Description
IP address of
DNS server to
monitor
IP address of the DNS server that you want to 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: 206.168.191.1
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
l
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.
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.
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.
HPE SiteScope (11.33)
Page 212 of 924
Monitor Reference
Chapter 28: DNS Monitor
This situation can be due to a number of issues, including the following (should be managed by network
administrator):
l
l
l
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.
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.
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.
HPE SiteScope (11.33)
Page 213 of 924
Chapter 29: 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.
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
"Monitor Run Frequency" on the next page
l
"IPv6 Addressing Supported Protocols" on the next page
l
"Dynamic Disk Space Monitor Topology" on the next page
l
"License Consumption" on page 216
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
l
Monitor specific disks and counters on a host server using static counters. You can select one or multiple
disks to monitor.
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.
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.
HPE SiteScope (11.33)
Page 214 of 924
Monitor Reference
Chapter 29: Dynamic Disk Space Monitor
Supported Platforms/Versions
l
l
l
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.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
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)
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 APM's RTSM.
HPE SiteScope (11.33)
Page 215 of 924
Monitor Reference
Chapter 29: Dynamic Disk Space Monitor
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
License Consumption
Points-based Usage
Capacity-base Usage
One point per disk
One OSi license per monitored host
Note: No points are consumed by this monitor if it is running
on a host covered by the OS Instance Advanced license.
Tasks
How to Configure the Dynamic Disk Space Monitor
1.
Prerequisites
l
l
l
2.
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
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 -T <disk>).
Configure the monitor properties
HPE SiteScope (11.33)
Page 216 of 924
Monitor Reference
Chapter 29: Dynamic Disk Space Monitor
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 219.
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:
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 in the Frequency of updating counters
from server box. If you use only static counters, they are not affected by the frequency for updating
counters, since the dynamic framework does not run.
HPE SiteScope (11.33)
Page 217 of 924
Monitor Reference
Chapter 29: Dynamic Disk Space Monitor
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. Click Verify & Save or Save to save your settings.
j. 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:
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 215.
For user interface details, see "APM 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:
l
l
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details, see
Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic Monitoring Page in
the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 218 of 924
Monitor Reference
Chapter 29: 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
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.
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
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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 Opens the Add Remote Server dialog box, enabling you to select the type of remote you
Server
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: To avoid a timeout when monitoring a UNIX remote server using an SSH connection
(if the external drives mounted by NFS are unavailable for the target remote), use
the"umount -a -t nfs" command to unmount all NFS drives, or use "umount -n <nodename>"
to unmount all the drives from the particular remote node that is unavailable. Use the
"mount | grep nfs" command to get a list of NFS drives.
HPE SiteScope (11.33)
Page 219 of 924
Monitor Reference
Chapter 29: Dynamic Disk Space Monitor
UI Element
Description
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
match the selected patterns.
button to display counters that
Notes:
l
l
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.
To avoid error or null value in case the counter name contains "harddisk", replace the
default regular expression with any of the following:
l
/^(?!.*Harddisk).*/MB free/
l
/^(?!.*Harddisk).*/percent full/
l
/^(?!.*Harddisk).*/MB total/
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
l
l
HPE SiteScope (11.33)
The update frequency cannot be less than the monitor run frequency in Monitor Run
Settings.
When configuring this setting in a template, the variable value can only be in time units
of seconds.
Static counters are never deleted.
Page 220 of 924
Monitor Reference
Chapter 29: Dynamic Disk Space 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
l
l
l
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.
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.
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).
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).
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
"Monitor does not send an individual alert for each disk space being monitored" below
l
"Unable to retrieve disk information on a UNIX remote server" on the next page
l
"WMI Returns Incorrect Disk Space Values" on the next page
l
"Unable to get counters from Red Hat Enterprise Linux about network file systems" on the next page
l
"Maximum Number of Counters That Can be Saved" on the next page
Monitor does not send an individual alert for each disk space being monitored
HPE SiteScope (11.33)
Page 221 of 924
Monitor Reference
Chapter 29: Dynamic Disk Space Monitor
If an error is encountered in one of the monitored disk spaces, the monitor status changes to Error and an alert
is triggered. If another disk encounters an error, no additional notification is sent out because the monitor is
already in Error status.
Workaround: Define a separate monitor for each disk. This way, an alert is triggered even if other disks (and
monitors) are already in Error status.
Unable to retrieve disk information on a UNIX remote server
When monitoring a UNIX remote server using an SSH connection, unable to retrieve disk information if the
external drives mounted by NFS are unavailable for the target remote.
Workaround: Use the"umount -a -t nfs" command to unmount all NFS drives, or use "umount -n <nodename>"
to unmount all the drives from the particular remote node that is unavailable. Use the "mount | grep nfs"
command to get a list of NFS drives.
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:
l
l
Search for "id=disks".
Add the following to the bottom of the "id=disks" section (the lines between the #s define each
section):
noNameFilter=true
startLine=2
#
l
Save the file.
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.
HPE SiteScope (11.33)
Page 222 of 924
Monitor Reference
Chapter 29: Dynamic Docker 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:
l
l
<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.
<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.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 Dynamic Disk Space monitor errors in:
l
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific monitor runs
and actions related to managing monitors.
Chapter 29: Dynamic Docker Monitor
The Dynamic Docker monitor enables you to monitor the health and performance statistics of a Docker
environment, from the cluster manager level through the Docker daemon layer, to the container level and
applications which run inside the containers. It also monitors the health of the cluster manager and each
Docker node. You can choose to monitor a single Docker node, a full cluster, or several nodes on a cluster.
After selecting the measurements you want to monitor, the dynamic monitoring mechanism automatically
update counters and thresholds that changed during run-time on Docker nodes and clusters. The Dynamic
Docker monitor also includes a mechanism that enables it to discover applications running in new containers
detected on the Docker node or cluster, and to automatically create a monitor, or set of monitors, for each new
application. The monitor automatically retrieves metrics for every new container that is created on the node or
HPE SiteScope (11.33)
Page 223 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
cluster and adds them to the monitor. Similarly, if a container is removed, metrics for that container are
automatically removed from the monitor. Dynamic monitoring enables you to configure the monitor on a one
time basis, and leave it to update itself.
Using the Unified Console in SiteScope, you can see a consolidated view of all monitored Docker metrics at
the same level in a flattened view as a set of nested rectangles. The hierarchical relationship between the data
is retained, enabling drill down/up to different levels.
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and select the
Dynamic Docker monitor.
Learn About
This section includes:
l
"Dynamic Docker Monitor Overview" below
l
"Docker Counters" on the next page
l
"SSL Connectivity" on the next page
l
"Supported Platforms/Versions" on page 226
l
"License Consumption" on page 226
Dynamic Docker Monitor Overview
Docker is an open source container technology that uses containers to wrap software in a complete file
system that contains everything it needs to run. These containers use shared operating systems on top of a
single machine, making disk usage and image downloads much more efficient.
Dynamic Monitoring
The SiteScope Dynamic Docker monitor enables you to monitor specific Docker containers and counters on
defined Docker nodes, or on a cluster. During initial monitor creation, the monitor scans the target Docker
node or cluster to dynamically discover the 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 configuring the Dynamic Docker monitor, see "Dynamic Docker Monitor" on the previous page.
Automatic Discovery Mechanism
The Dynamic Docker monitor also includes a mechanism that enables it to discover applications running in
new containers detected on the Docker node or cluster, and to automatically create a monitor or set of
monitors for each new application. For each application type, you need to create a unique config file (for
example, one for Tomcat and another for mySQL, Postgres, and so forth), and a template to deploy a monitor
or set of monitors for each container application that you want to monitor.
Each time the monitor requests counters from the server (according to the Frequency of updating counters
from server value), the discovery mechanism checks the list of containers supplied by the monitor and
searches for a config file that matches the container image. If it finds a matching config file, it automatically
creates and deploys a new monitor or set of monitors for each application using a predefined template (listed
in the config file).
HPE SiteScope (11.33)
Page 224 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
For details on configuring the discovery mechanism, see "How to Configure Automatic Docker Application
Discovery" on page 231.
Monitor Run
Dynamic monitors automatically adjust the SiteScope monitoring configuration based on changes that are
happening in your IT environment. When the monitor runs, it accesses the Docker node or the cluster API,
checks its availability, collects health counters and specific metrics on the Linux host for every registered
Docker node and on the Docker daemon.
If automatic discovery is enabled, the monitor also activates a process which deploys a template (containing
a new monitor or set of monitors) on the application level, for applications detected on the node or cluster. It
also removes the deployed application monitors and counters when a container is removed. This enables you
to configure the monitor one time, and leave it to automatically discover changes in the environment and
update itself.
The Dynamic Docker monitor monitors running containers. If a container stops running or is deleted from the
Docker, the monitor stops monitoring the container, unless Continue displaying counters that no longer
exist after update is selected, in which case, the container's counters are displayed as unavailable. If a
container stops running, the group that was deployed to monitor it is disabled; it is enabled once the container
continues to run again. If a container is deleted, the group that was deployed to monitor it is also deleted.
These actions take affect each time counters are requested from the server according to the Frequency of
updating counters from server value set for the monitor.
Note: If the server is changed to another Docker node, all the deployed application groups are deleted.
Docker Counters
The following counter types are available on the Dynamic Docker monitor:
l
l
l
Cluster and Docker Node Counters for measuring availability and performance of Daemon counters on the
Docker cluster manager and Docker nodes.
Container Counters for measuring the health of each of the containers on the Docker nodes.
Health Counters (CPU, memory, and disk space) for measuring the performance and operational health of
the cluster manager and each Docker node. Health counters for Docker nodes are only displayed if a
remote server has been configured on the Docker node.
These counters are displayed in the Counters tree after connecting to the remote server of the Docker node or
cluster machine to be monitored. For the list of counters, see "Monitor Counters" on page 244.
SSL Connectivity
The Docker REST APIs are generally configured to use SSL encryption to protect the Docker API endpoint
from unauthorized access. Monitoring a Docker that uses an encrypted connection requires you to import the
server certificate. Monitoring a Web server which uses an encrypted connection, requires either:
l
l
Selecting the Accept untrusted certificates for HTTPS option in the Authentication Settings section of
the Monitor Settings panel as described in "Dynamic Docker Monitor" on page 223.
Importing the server certificate. For details on how to perform this task, see "How to Configure the
Dynamic Docker Monitor" on the next page.
The following cryptographic protocols are supported (on IPv6 and IPv4):
HPE SiteScope (11.33)
Page 225 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Protocol/HTTP Client used by
SiteScope
Java ("Use WinInet" is not
selected)
WinInet ("Use WinInet" is
selected)
SSLv2
x
x
SSLv3
√
√
TLSv1.0, TLSv1.1, TLSv1.2
√
√
Supported Platforms/Versions
l
l
l
l
This monitor supports monitoring
l
Docker CS Engine 1.10.x, 1.11.x and 1.12.x.
l
UCP 1.1.x.
This monitor supports Dockers running on Linux operating systems only.
This monitor supports Docker Swarm (a Docker-native clustering system) for monitoring a cluster of
Docker containers.
This monitor supports Docker Kubernetes versions 1.3 – 1.5 for monitoring a cluster of Docker containers.
License Consumption
Pointsbased
Usage
One
point
per 15
metrics.
Capacity-based Usage
One OS instance license per monitored host and one OS instance license for each monitored
virtual machine. As a result, OSi capacity consumption for Dynamic Docker monitors can
change during the monitor run according to the number of discovered VMs.
Tasks
How to Configure the Dynamic Docker Monitor
1.
Prerequisites
l
You must configure a UNIX remote server for each Docker cluster and node that you want to monitor.
Health counters for Docker nodes are only displayed if a remote server has been configured on the
Docker node.
For details, see Configure SiteScope to Monitor Remote UNIX Servers in the Using SiteScope Guide.
Tip: When configuring the remote server name in the Server field of the UNIX Remote Server
dialog box, you should use the same name that is configured in the Docker or cluster. For
example, if the Docker uses an IP address to identify the server, then an IP address should be
used in the remote server name.
l
If you want to monitor a Swarm cluster or a Docker node directly, make sure the REST API is open to
HPE SiteScope (11.33)
Page 226 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
the SiteScope machine (you will need to specify the port when creating the monitor below).
l
l
l
l
2.
If you want to monitor a Kubernetes cluster, install cAdvisor on the Kubernetes machine and open
both the Kubernetes REST API and the cAdvisor port to the SiteScope machine (you will need to
specify the ports when creating the monitor below).
If you plan on using automatic application discovery to have SiteScope search for new Docker
applications and automatically create new application monitors using predefined templates, follow the
steps in "How to Configure Automatic Docker Application Discovery" on page 231.
Performance
o
To avoid unnecessarily monitoring containers (those that are dropped after a short period of time),
containers must be running for a minimum amount of time before they are monitored. By default,
containers must be running for a minimum of one minute. You can change the minimum running
period for containers in the _DockerMinimumContainerRunningTimeInMinute property in the
<SiteScope root directory>\groups\master.config file. Note that the monitor will not monitor
containers that run for less the configured time.
o
You can configure the number of threads for the monitor run using the parameter _
dynamicDockerCheckContainersStatsThreadPullSize. Each thread handles a set of
containers on the Docker cluster/daemon. The parameter is available in the master.config file
(<SiteScope root directory>\groups\master.config). Default value of the parameter is 15
threads.
o
For faster performance, you can exclude monitoring the health of the cluster or docker node. It is
recommended that you use other SiteScope monitors such as Dynamic Disk
Space/CPU/Memory monitors to monitor the health of the docker node or cluster.
If you plan to connect to the remote server using a secure connection, the user name and password
specified in the Credentials section (in Authentication Settings) must have sufficient permissions to
complete the HTTP request that the monitor is configured to perform.
Import the server certificates (if the Docker server is configured to use SSL
encryption)
If the Docker REST API is configured to use SSL encryption, then you need to import the server
certificate. Use one of the following methods for importing server certificates:
l
l
3.
Import the server certificates using SiteScope Certificate Management. For details, see How to
Import Server Certificates Using Certificate Management in the Using SiteScope Guide.
Import the server certificates manually. For details, see "How to Manually Import Server Certificates "
on page 237.
Configure the monitor properties
a. Right-click the group into which you want to add the monitor instance, select New > Monitor, and
select Dynamic Docker. The New Dynamic Docker Monitor dialog box opens.
b. In the General Settings panel, enter a name and description for the monitor.
c. In the Dynamic Docker Monitor Settings panel, configure the monitor properties as required. For a
description of each setting, see the Main Settings UI descriptions.
d. In the Patterns & Counter section, click the Get Counter button, and select the relevant counters
you want to monitor on the Docker cluster or node (the form displays static counters only). The
HPE SiteScope (11.33)
Page 227 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
counters are added to the Counter Preview tree. You can click the Reload Objects button to reload
data for the selected cluster or node.
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, or you can use the following out-of-the box regular expressions
that are created by default:
Counter Pattern
Description
/.*/memory%/
Measures the total amount of free memory (in percentage).
/.*/cpu usage/
Measures the CPU usage.
/.*/disk usage I\/O write \(bytes\)/ Measures the disk usage in bytes.
/.*/state/
Checks the state of the Docker container.
/.*/network usage transmitted/
Measures the network usage (transmitted data).
/.*/network usage received/
Measures the network usage (received data).
/.*/availability/
Checks the availability of the Docker container.
/.*/disk usage I\/O read \(bytes\)/
Measures the disk usage in bytes.
Tip:
l
l
l
The pattern should always start and end with the forward slash ("/") character.
Special characters which appear as part of counter names should be escaped (preceded
with the backslash ("\") character).
Use ".*" to describe any character any number of times.
Example:/.*\/cpu usage%/, shows CPU usage for all the currently running containers on
the Dockers connected to Swarm that you are monitoring.
If you have two virtual machines (Docker 1 and Docker 2), this pattern finds for the Docker:
Swarm1/Docker1/Health Counters/CPU/.*
Swarm1/Docker2/Health Counters/CPU/.*
and for the containers on Docker1 connected to Swarm1:
Swarm1/Docker1/Container1/cpu usage%
Swarm1/Docker1/Container2/cpu usage%
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 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
HPE SiteScope (11.33)
Page 228 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
page 245. 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. You can change the frequency for updating counters from the server in the Frequency of updating
counters from server box (the default value is one hour). This determines the time interval at which
counters that are requested by this monitor are retrieved from the server, and the monitor is updated
with counter pattern matches.
Tip: For obtaining more up-to-date data with the Docker monitors, the suggested value for
Frequency of updating counters from server and the monitor frequency is 1 minute (60
seconds) or higher.
The monitor also checks the list of containers that was supplied by the monitor and searches for new
containers. If it finds a new container monitored by the Docker monitor, it searches the container for
known applications (ones that have been matched to a config file in <SiteScope root
directory>\templates.docker\applications), and it automatically creates and deploys a new
monitor or set of monitors for the applications using predefined templates (mentioned in the config
file). The monitor deploys a new template for every new container that is created on the node or
cluster, and removes the deployed monitors and counters when a container is removed.
Note:
o
Each application type that has a different template should have a unique config file (for
example, one for Tomcat and another for mySQL Postgres, and so forth).
o
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.
Note: When using this option, application groups are deleted only when the Check Containers
Still Exist schedule is activated. For details on schedulers, see "How to Configure the
Automatic Discovery Mechanism Schedulers" on page 234.
For details on the counters and patterns settings, see Dynamic Docker Counter Settings.
i. If you want to enable SiteScope to connect to the Docker nodes using a secure connection, select
Enable secure connection, and configure the proxy and authentication settings as required. See
the proxy and authentication UI settings for details.
Tip: Common case scenario is to use the TLS protocol for the Docker REST API
communication. To use TLS, you have to import your CA certificate into SiteScope
(Preferences > Certificates). Copy the client certificate and key (PFX file) into the directory
<SiteScope_Dir>/SiteScope/templates.certificates on your SiteScope system. In the
Authentication Settings pane, select the certificate file in the Client Side certificate and enter
password, if any. Choose the option Prefer TLS to SSL from the list of Preferred Protocols.
See the Authentication Settings for more details.
HPE SiteScope (11.33)
Page 229 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
j. Click Verify & Save or Save to save your settings.
k. In the Threshold Settings tab, you can manually set logic conditions for the dynamic counters that
determine the reported status of each monitor instance, or use the out-of-the box threshold settings.
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 Docker monitor:
4.
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.
Results
During each update, the monitor connects to the server where the Docker or cluster manager and its
connected Dockers 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.
If a new Docker or container is added to the cluster or Docker, the monitor retrieves the list of counters
from the cluster or Docker (which also contains the new added container). If the new Docker or container
contains counters that correspond to any of the defined counter patterns, these counters are added to the
counter list.
If you enabled automatic application discovery, the monitor searches for new containers. If it finds a new
container, it searches the container for known applications (ones that have been matched to a config file
on <SiteScope root directory>\templates.docker), and it automatically creates and deploys a new
monitor or set of monitors for the application using a predefined template. The new monitors
automatically retrieve metrics for every new container.
Note: Application groups created by the discovery mechanism are automatically deleted by the
Dynamic Docker monitor in the following cases:
a. If the main Dynamic Docker monitor was deleted, provided Dynamic Docker: Delete
monitors created by discovery mechanism when Docker monitor deleted is selected in
Preferences > Infrastructure Preferences > Monitor Settings. If this setting is cleared, only
the Dynamic Docker monitor is deleted; the discovered application groups remain.
b. If the Docker node was disconnected from the cluster in which it is monitored.
c. If all the counters on one of the containers were removed from the Dynamic Docker monitor.
d. If the server of the Docker monitor was changes to a different remote server that represents a
different Docker node.
5.
Troubleshoot / Check Monitor Performance (if required)
l
l
You can use the log files to troubleshoot monitor and automatic discovery issues. For information on
troubleshooting the Dynamic Docker monitor see "Troubleshooting Dynamic Docker Monitor Logs" on
page 246. For information on troubleshooting the application discovery mechanism, see
"Troubleshooting Dynamic Docker Application Discovery Logs" on page 246.
You can check the performance of the dynamic monitoring framework in:
HPE SiteScope (11.33)
Page 230 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
6.
o
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details, see
Dynamic Monitoring Statistics Monitor in the Using SiteScope Guide.
o
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic Monitoring
Page in the Using SiteScope Guide.
Delete Dynamic Docker / Auto Discovery Application Monitors (if required)
You can delete the application monitors at any time without restrictions.
When deleting the Dynamic Docker monitor, the application monitors dependent on the Docker monitor
are also deleted provided Dynamic Docker: Delete monitors created by discovery mechanism
when Docker monitor deleted is selected in Preference > Infrastructure Preferences > Monitor
Settings (it is selected by default). If this setting is cleared, only the Dynamic Docker monitor is deleted
and the application monitors remain.
Note: You cannot delete the Dynamic Docker monitor if other monitors depend on it without first
removing the dependency.
How to Configure Automatic Docker Application Discovery
1. Prerequisites.
For each Docker node or cluster application you want to monitor, make sure that a public facing port is
associated with each application you want to monitor.
2. Enable the Dynamic Docker application discovery mechanism in Infrastructure Preferences.
In Preference > Infrastructure Preferences > Monitor Settings, make sure that Dynamic Docker:
Enable automatic application discovery is selected (it is selected by default).
Note: You must restart SiteScope if you change this setting.
3. Configure the other Dynamic Docker application discovery settings - optional
l
l
To automatically delete application monitors created by the automatic discovery mechanism when
deleting a Dynamic Docker monitor, make sure that Dynamic Docker: Delete monitors created by
discovery mechanism when Docker monitor deleted is selected in Preference > Infrastructure
Preferences > Monitor Settings (it is selected by default).
To avoid unnecessarily monitoring containers (those that are dropped after a short period of time),
containers must be running for a minimum amount of time before they are monitored. By default,
containers must be running for a minimum of one minute. You can change the minimum running period
for containers in the _DockerMinimumContainerRunningTimeInMinute property in the
<SiteScope root directory>\groups\master.config file.
4. Configure the scheduler parameters that are used by the automatic discovery mechanism - optional
You can fine tune the scheduler parameters used by the automatic discovery mechanism in the
<SiteScope root directory>\groups\master.config file. For parameter details, see "How to Configure
the Automatic Discovery Mechanism Schedulers" on page 234.
5. Navigate to the <SiteScope root directory>\examples\monitors\dynamic_docker_monitor folder,
and extract the contents of the TomcatOnDockerExample.zip file to a location of your choice. The zip
file contains an example template and config file to help you set up application discovery.
6. Create a template for each application you want to monitor on the Docker nodes.
HPE SiteScope (11.33)
Page 231 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
To automatically monitor container applications running on the Docker node, you can use the example
template as described below (the recommended method), or you can create a new template as described
in Create Templates in the Using SiteScope Guide.
a. In SiteScope, select the Templates context.
b. In the template tree, right-click the SiteScope root container, and select Import > Template.
c. Navigate to the example Dynamic Docker files you downloaded, and select the
DockerizedTomcatApplicationTemplate file.
d. After importing the template, modify the template objects as required to suit your monitoring
requirements.
Tip: You can test the template by deploying it manually on the container application and making sure
the template objects are added to the monitor tree.
7. Create a unique config file for each application type you want to monitor. For example, one for Tomcat
and another for mySQL Postgres, and so forth.
The config file is used to automatically deploy a monitor or set of monitors (from the template created in
the previous step) for each container application that you want to monitor on the Docker nodes.
a. Navigate to the sample Dynamic Docker files you downloaded, and open the Tomcat.config file.
b. Edit the file to meet your configuration needs by following the instructions and using the examples
supplied in the file.
The file includes the following:
o
A regular expression to match the container applications you want to monitor (app_pattern_
identifier). The regular expression in the config file should be matched to the container image.
Note:
l
l
o
Use an appropriate regular expression to ensure that each container image is matched to
only one config file. If more than one config file is matched to the same container image,
one of the config files will be chosen at random.
If you plan on deploying several monitors on the same Docker application, each group
path name should be unique. You can do this by using an identifying variable in the group
path name (as in the example on the example Tomcat.config file), or change the root
group name on the template to be unique (as in the template example
(DockerizedTomcatApplicationTemplate).
(optional) A regular expression to match the container name (container_name_pattern_
identifier).
Note: The container_name_pattern_identifier key is an option to specify the config file
containers in addition to the app_pattern_identifier. If this value is not specified, then a
general regular expression such as '.*' is used as the key value.
o
The path to the template that will be deployed (template_full_path). You can use the following
keys (taken from the Docker and container data) in the template path:
<CLUSTER_SERVER_NAME>,<DOCKER_SERVER_NAME>,<IMAGE_NAME>,<CONTAINER_
NAME>,<CONTAINER_ID>,<APP_EXPOSED_PORT>
For a Kubernetes cluster, you can use the following keys:
HPE SiteScope (11.33)
Page 232 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
<CLUSTER_KUBERNETES_POD_NAME>,<CLUSTER_KUBERNETES_POD_ID>,<CLUSTER_KUBERNETES_
NAMESPACE_NAME>
o
(Optional) The path to the target group in the deployed template (target_group_full_path).
o
The internal port and type for the container application (internal_port_binding_key).
o
The template variables required to deploy the template. You can use known keys for the
templates variables as:
<CLUSTER_SERVER_NAME>,<DOCKER_SERVER_NAME>,<IMAGE_NAME>,<CONTAINER_
NAME>,<CONTAINER_ID>,<APP_EXPOSED_PORT>
For Kubernetes cluster, you can use:
<CLUSTER_KUBERNETES_POD_NAME>,<CLUSTER_KUBERNETES_POD_ID>,<CLUSTER_KUBERNETES_
NAMESPACE_NAME>
c. Save the config file with an appropriate name, and copy it to the <SiteScope root
directory>\templates.docker\applications folder (it must have the .config extension).
8. When configuring the monitor settings (in the previous task), for each Dynamic Docker monitor on which
you want to use automatic application discovery, make sure Enable automatic application discovery
is selected (this is the default setting).
You can also modify the time interval used by the monitor for retrieving and updating counters from the
server in the Frequency of updating counters from server box. During the interval, the application
discovery mechanism searches for newly monitored or deleted containers, existing containers which
stop or are restarted, and it adds/removes/disables/enables (respectively) the application group
according to the config files.
For details of UI settings, see "Dynamic Docker Monitor" on page 223.
HPE SiteScope (11.33)
Page 233 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
How to Configure the Automatic Discovery Mechanism Schedulers
The Dynamic Docker monitor includes scheduler parameters that you can use to tune the automatic
discovery mechanism.
You configure these parameters in the <SiteScope root directory>\groups\master.config file:
Scheduler
Parameter Name / Description
Redeploy /
Publish
Templates
Due to
Config File
Changes
Parameter: _
dynamicDockerAppDiscoverReDeployTemplatesRateDueToConfigFileChangesInMinute
s
Description: Amount of time, in minutes, to wait between checking whether the config files
were updated. If config files were updated, the discovery mechanism searches for all groups
that were deployed by the config files and attempts to redeploy templates or publish template
changes.
Differences between types of changes:
l
l
l
If the internal_port_binding_key variable or one of the template variables changes,
the scheduler tries to publish this change to all groups that were deployed by the
template.
If the template itself changes (template_full_path), the scheduler deletes all groups that
were deployed by the template and tries to redeploy the template.
If the path to the target group in the deployed template (target_group_full_path)
changes, nothing happens to previously deployed groups, but a new group will be
deployed to the new path.
What happens if redeployment or publish changes fails?
l
l
When redeploying the template, the mechanism deletes the previous group and attempts
to redeploy the template on this container the number of times specified in the _
dynamicDockerAppDiscoverDeployTemplateAttempts parameter. The frequency of
attempts is determine by the value in the _
dynamicDockerAppDiscoverDeployTemplateRetriesRateInMinutes scheduler
below.
When publishing template changes, the mechanism attempts to publish the template on
this container the number of times specified in the _
dynamicDockerAppDiscoverDeployTemplateAttempts parameter. If all attempts fail,
the previously deployed group will remain unchanged.
If all attempts to redeploy or publish the template fail, the container is removed from the
waiting list.
Default Value: 15 minutes (minimum value is 5 minutes)
HPE SiteScope (11.33)
Page 234 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Scheduler
Parameter Name / Description
Retry
Template
Deploymen
t/
Publishing
Parameter: _dynamicDockerAppDiscoverDeployTemplateRetriesRateInMinutes
Description: Amount of time, in minutes, to wait before attempting to deploy template or
publish template changes after the previous attempt failed.
Possible reasons for templates failing to deploy:
1. There is no matched config file for the container image.
2. The container is not running.
3. There are no exposed ports on the container. This will occur, for example, if the user
used the <APP_EXPOSED_PORT> key on the config file.
4. The discovery mechanism fails to find the internal_port_binding_key in the
container internal ports list that was selected in the config file.
5. Unable to find the template from the template_full_path in the config file.
6. Template variables are incorrect (key or value) in the config file.
7. Template deployment failed for some specific reason.
The mechanism attempts to deploy the template on this container the number of times
specified in the _dynamicDockerAppDiscoverDeployTemplateAttempts parameter. If all
attempts fail, the container is removed from the waiting list.
Default Value: 30 minutes (minimum value is 5 minutes)
Check
Containers
Still Exist
Parameter: _dynamicDockerAppDiscoverCheckContainersExistencesRateInMinutes
Description: Amount of time, in minutes, to wait before checking for the state of groups that
were deployed on containers that are stopped/restarted/deleted. When a container is
stopped/restarted/deleted , the discovery mechanism automatically
disables/enables/deletes any groups that are deployed on the container.
Default Value: 1440 minutes (24 hours). The minimum value is 5 minutes.
The <SiteScope root directory>\groups\master.config file also includes the following additional discovery
mechanism parameters that influence the schedulers:
l
_dynamicDockerAppDiscoverConfigFilesSampleRateInSeconds. Frequency, in seconds, for
checking the config file directory for changes. The default value is 30 seconds (minimum value is 30
seconds). If a new config file is added, or an existing file is deleted, the config file list is updated.
l
l
l
If a config file is modified by updating the container identifiers (app_pattern_identifier and
container_name_pattern_identifier), the config file is considered a new file.
If a config file is modified by changing the internal_port_binding_key, or the template variables, the
file is marked to be published, and is handled according to the _
dynamicDockerAppDiscoverReDeployTemplatesRateDueToConfigFileChangesInMinutes
scheduler.
If a config file is modified by changing the template path (template_full_path), the file is marked to
be redeployed, and is handled according to the _
dynamicDockerAppDiscoverReDeployTemplatesRateDueToConfigFileChangesInMinutes
scheduler.
HPE SiteScope (11.33)
Page 235 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
If a config file is modified by changing the group path (target_group_full_path), nothing happens to
previously deployed groups, but a new group will be deployed to the new path.
l
If a config file is deleted, groups that were previously deployed according to this config file are not
deleted, but new containers which arrive will fail due to the config file for their image no longer existing.
l
_dynamicDockerAppDiscoverDeployTemplateAttempts. The number of attempts to redeploy
templates or publish template changes on some container. This variable influences the _
dynamicDockerAppDiscoverReDeployTemplatesRateDueToConfigFileChangesInMinutes and _
dynamicDockerAppDiscoverDeployTemplateRetriesRateInMinutes schedulers. The default value is
3 attempts (minimum 1 attempt).
l
_dynamicDockerAppDiscoverThreadPullSize. Amount of thread handlers that handle Docker monitor
deletion, application group deletion, and docker monitor configuration updates from Dynamic Docker
monitors. The default value is 25 thread handlers (minimum 1 thread handler).
l
For achieving better performance, it is recommended to keep this value roughly equal to the result of the
formula – ( ((Number of Docker nodes to be monitored) * 10) / (frequency of updating counters from server
in minutes) ). For example, if number of Docker nodes is 20, update counter frequency is desired to be set
to 5 minutes, then the value of this parameter should be ((20 * 10)/5) = 40.
l
_dynamicDockerAppDiscoverMaxNumberOfContainersPerThread. Number of containers handled
by 1 thread. That is, if an update was made on the Docker like new containers being created or if existing
containers were stopped, deleted, or started (if already stopped) which influence the Docker monitor
counters list during the process of updating the counters list from the server.
The default value is 50 containers per thread. (Minimum value is 1 container per thread).
For achieving better performance, it is suggested to keep this value as equal to the maximum number of
containers expected to run on any of the Docker nodes to be monitored using SiteScope.
Tip: To improve application discovery performance, we recommend increasing the number of
handlers and decreasing the number of counters per thread. In addition, you can separate the Docker
containers between several monitors. You can separate the containers to several groups by using the
regular expression field.
Examples regular expressions to separate containers into groups:
l
l
Use /Cluster/host1/Containers/*/ to monitor all containers on a specific host.
Use /Cluster/host1/Containers/jdk*/ to monitor all containers on a specific host with a name
starting with ‘jdk’.
How to Implement Changes Immediately Using JConsole
If you made changes to a config file and you want these changes to take affect without waiting for the
scheduler, you can use JConsole to implement theses changes immediately. You can also use JConsole to
check scheduler progress.
1. To access the JConsole tool, run <SiteScope root directory>/java/bin/jconsole binary file on UNIX
platforms.
2. Depending on which SiteScope you want to monitor, select Local Process, or Remote Process with
port 28006 (the default JMX port).
3. Select the MBeans tab, and open
com.mercury.sitescope/Core/Platform/Monitors/DynamicDockerJmxMBean. To check scheduler
HPE SiteScope (11.33)
Page 236 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
progress, select the relevant scheduler under Attributes and click the scheduler refresh button. To run a
scheduler, select the relevant scheduler under Operations and click the invoke scheduler button.
How to Manually Import Server Certificates
Instead of using Certificate Management, you can manually import certificates using the keytool method, if
preferred. Certificates imported this way can still be managed using Certificate Management. For details on
Certificate Management, see Certificate Management in the Using SiteScope Guide.
1. Check the certificates already in the keystore, from the <SiteScope root directory>\java\lib\security
directory, by entering:
../../bin/keytool -list -keystore cacerts
2. Import the certificate, into <SiteScope root directory>\java\lib\security, by entering:
../../bin/keytool -import -file myCert.cer -alias myalias -keystore cacerts
where myCert.cer is the certificate file name and myalias is the certificate alias.
Make sure that you specify a unique alias for every certificate you add. If you do not, the keytool uses an
automatic alias and once you attempt to add more than one custom certificate, the new certificate
overwrites the old and keeps the default alias.
The word changeit is the default password for the cacerts file.
Note: The default cacerts file is overwritten every time SiteScope is upgraded or re-installed.
Therefore, you should create a copy of the cacerts file with a different name before SiteScope is
upgraded or re-installed so that the file is not overwritten when new certificates are imported.
3. In SiteScope, select Preferences > Certificate Management, and click the Reload Certificate List
button to reload the keystore certificates from the cacerts file. This enables you to manually reload
keystore changes without having to restart SiteScope.
How to View Docker Counters and Application Groups/Monitors in the Unified
Console
1. Prerequisites
The groups displayed in the Unified Console are those that can be accessed by the user profile logged on
to SiteScope. Similarly, the actions that can be performed on groups and monitors are dependent on the
action permissions assigned to the user account. For details on user accounts, see User Management
Preferences.
2. Open Multi-View or Ops View in the Unified Console.
l
In a Web browser, enter:
http://<server_name>:<port>/SiteScope/WebMain#/multiview for Multi-View, or
http://<Server_name>:<port>/SiteScope/WebMain#/consolidatedview for Ops View.
l
From the SiteScope Dashboard: Select the Monitors context, click the Dashboard tab, and then
click the Unified Console button. The Unified Console opens in Ops View, which displays both
Multi-View and the Event Console. To display only Multi-View, click Multi-View.
3. To display a consolidated view of all Docker containers being monitored:
a. In Multi-View/Ops View, click the arrow next to the drop-down list on the upper left side of the
window, and select Hierarchy Monitors. The name in the adjacent drop-down list changes to
HPE SiteScope (11.33)
Page 237 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Docker.
b. Click Apply. SiteScope displays all Dynamic Docker monitors at the same level. It includes the
Docker cluster manager (if selected for monitoring), all Docker nodes, container groups with
application monitors, Daemon counters, and Health Counters in a flattened view as a set of nested
rectangles. The hierarchical relationship between the data is retained, enabling drill down/up to
different levels.
Example: Multi-View showing all Dynamic Docker monitors that are being monitored at the root
level
c. In addition, you can filter items in the Hierarchy tree according to their status (Good, Warning, or
Error) using the Status filter.
For more details on using the Unified Console, see How to Select and Configure a View in the Using
SiteScope Guide.
How to Monitor Docker UCP
You can monitor the nodes and container metrics of a Docker UCP using the Dynamic Docker monitor.
Perform the following steps to monitor Docker UCP:
1. Add the Swarm Manager host as a remote server.
2. Configure the monitor properties.
Note: Select Cluster type as Swarm to monitor Docker UCP.
3. Save and run the monitor.
HPE SiteScope (11.33)
Page 238 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
UI Descriptions
Dynamic Docker Monitor Settings
User interface elements are described below:
Main Settings
UI Element
Description
Server
Name of the server where the Docker cluster or node you want to monitor is running.
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
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 Configure SiteScope to Monitor Remote UNIX Servers in the Using
SiteScope Guide.
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.
Cluster
Select to monitor all Dockers in the cluster. Select the cluster type Swarm or Kubernetes
from the drop-down list.
Docker
Select to monitor a specific Docker node.
Port
API port for the selected cluster or Docker node.
Note: If you want to monitor a cluster or a Docker node directly, make sure the REST API
is open to the SiteScope machine.
cAdvisor
Port
If you selected the cluster type as Kubernetes, enter the cAdvisor API port for the Docker
Kubernetes cluster.
Enable
automatic
application
discovery
Select to use the discovery mechanism to search for applications running in new
containers on the Docker node or cluster, and to automatically create a new monitor or set
of monitors for each application detected (provided the application is matched to some
config file) using a predefined template.
Note: This check box is inactive if the global application discovery setting Dynamic
Docker: Enable automatic application discovery has been disabled in Preference >
Infrastructure Preferences > Monitor Settings (it is selected by default).
HPE SiteScope (11.33)
Page 239 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Main Settings
UI Element
Description
Monitor all
containers
Monitors all containers irrespective of their state. If unchecked, only running containers
are monitored.
Default value: Selected
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.
For the list of counters that can be configured for this monitor, see "Monitor Counters" on
page 244.
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
that match the selected patterns.
button to display counters
Note:
l
l
l
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.
By default, when creating a Docker monitor there are out-of-the box Thresholds
Settings for the default /.*/memory%/ and /. */cpu usage%/ counters.
By default, the following regular expressions are available:
l
/.*/disk usage I\/O write \(bytes\)
l
/.*/state
l
/.*/network usage transmitted/
l
Counter
Preview
/.*/network usage received/
l
/.*/availability/
l
/.*/disk usage I\/O read \(bytes\)/
Displays all real counters in the monitor. This includes static counters and counter
patterns that have been translated to real counters.
HPE SiteScope (11.33)
Page 240 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Main Settings
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.
Tip: For obtaining more up-to-date data with the Docker monitors, the suggested
value for Frequency of updating counters from server is 1 minute (60 seconds) or
higher.
Default value: 1 hour
Note:
l
l
l
The update frequency cannot be less than the monitor run frequency in Monitor Run
Settings.
When configuring this setting in a template, the variable value can only be in time units
of seconds.
Static counters are never deleted.
For more details, see "Dynamic Docker Monitor Overview" on page 224.
Continue
displaying
counters that
no longer
exist after
update
When selected, counters that no longer exist after the monitor periodically scans the
cluster manager and it’s connected Docker nodes, are still displayed in the monitor (they
are displayed as unavailable). Counters might no longer exist when a Docker node is
disconnected from the cluster in which it is monitored, or the container is removed from
the Docker node.
This is useful, for example, 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. For more details, see "Dynamic Docker Monitor Overview" on
page 224.
Enable
secure
connection
Enables SiteScope to connect to Docker REST APIs using a secure connection.
Default value: Not selected
Proxy Settings
HTTP Proxy
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 user name to access the server.
Note: Your proxy server must support Proxy-Authenticate for these options to function.
HPE SiteScope (11.33)
Page 241 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Main Settings
UI Element
Description
Proxy server
password
Proxy server password if the proxy server requires a user name to access the server.
Proxy NTLM
V2
Select if the proxy requires authentication using NTLM version 2.
Note: Your proxy server must support Proxy-Authenticate for these options to function.
Authentication Settings
Credentials
Option to use for authorizing credentials if the Docker REST API specified requires a
name and password for access:
l
l
Pre-emptive
authorization
Use user name and password. Select this option to manually enter user credentials.
Enter the user name and password to access the Docker REST API in the User name
and Password box.
Select predefined credentials. Select this option to have SiteScope automatically
supply a predefined user name and password for the Docker REST API (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.
Option for sending authorization credentials if SiteScope requests the target Docker
REST API:
l
l
Use global preference. Select to have SiteScope use the setting specified in the
Pre-emptive authorization section of the General Preferences page.
Authenticate first request. Select to send the user name and password on the first
request SiteScope makes for the target Docker REST API.
Note: If the Docker REST API does not require a user name and password, this option
may cause the Docker REST API to fail.
l
Authenticate if requested. Select to send the user name and password on the
second request if the Docker REST API requests a user name and password.
Note: If the Docker REST API does not require a user name and password, this option
may be used.
All options use the User name and 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.
HPE SiteScope (11.33)
Page 242 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Main Settings
UI Element
Description
Client side
certificate
The certificate file, if you need to use a client side certificate to access the target Docker
REST API. 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 that certificate requires a password.
Authorization Domain for NT LAN Manager (NTLM) authorization if required to access the Docker
NTLM
REST API.
domain
Accept
untrusted
certificates
for HTTPS
If you are accessing a target server using Secure HTTP (HTTPS) and SiteScope does not
have the required server certificates, you can either select this option or import the related
certificates. For details on importing server certificates, see "SSL Connectivity" on
page 225.
Accept
invalid
certificates
for HTTPS
Select this option if you are accessing a target server using Secure HTTP (HTTPS) and
SiteScope has invalid server certificates. This may happen, for example, if the current
date is not in the date ranges specified in the certificate chain.
NTLM V2
Select if the Docker REST API you are accessing requires authentication using NTLM
version 2.
Preferred
protocols
Select the preferred protocol option to use for the handshake process.
l
l
Any supported protocol. Enables any supported protocol to be used for the
handshake process (this is the default setting). Since this option uses SSL protocols,
SSL must be enabled on the Web server to use this option.
Prefer SSL to TLS. Select if the server you are accessing cannot handle
authentication using TLS. This enables encrypted handshake messages to be sent
using SSL.
Note: This option is ignored (if selected) when SiteScope is running in FIPS 140-2
mode, since authentication using TLS is mandatory with FIPS 140-2. For details on
FIPS 140-2, see the Running SiteScope Securely section of the SiteScope
Deployment Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_
Documentation.htm).
l
Prefer TLS to SSL. Select if you prefer to use TLS for encrypting handshake
messages or if the server you are accessing cannot handle authentication using SSL.
TLS is the latest cryptographic protocol. TLS 1.0, 1.1, and 1.2 are supported.
Note: For information on configuring setting panels that are common to all monitors, see Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 243 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Monitor Counters
Below is a list of counters that can be configured when monitoring a cluster or a Docker node:
Cluster
Docker
Cluster Counters
Docker Node Counters
l
Daemon Counters
- Connect
l
l
Health Counters (for Cluster machine):
l
l
l
CPU
- Utilization
- Utilization<#> (for each CPU)
l
Disks
- Disk/File System percent full
- Disk/File System MB free
- Disk/File System MB total
Memory
- MB free
- physical memory MB free
- physical memory MB used%
- swap space MB free
- swap space used%
l
Docker Counters
All the counters in the Docker column for
each Docker node in the cluster.
l
List of Containers
Counters for all containers
- state
- availability
Counters for each running container:
- availability
- cpu usage%
- disk usage I/O read (bytes)
- disk usage I/O read count
- disk usage I/O write (bytes)
- disk usage I/O write count
- memory%
- memory limit
- memory usage
- network usage received (bytes)
- network usage transmitted (bytes)
- state
Daemon Counters (for each Docker node):
- Connect
- Containers Amount
- CPUs
- Memory
Health Counters for each Docker node (these counters are
available only if there is a remote on the Docker node):
l
l
l
HPE SiteScope (11.33)
CPU
- Utilization
- Utilization<#> (for each CPU)
Disks
- Disk/File System percent full
- Disk/File System MB free
- Disk/File System MB total
Memory
- MB free
- physical memory MB free
- physical memory MB used%
- swap space MB free
- swap space used%
Page 244 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
Tips/Troubleshooting
This section includes:
l
"General Notes/Limitations" below
l
"Maximum Number of Counters That Can be Saved" below
l
"Troubleshooting Dynamic Docker Monitor Logs" on the next page
l
"Troubleshooting Dynamic Docker Application Discovery Logs" on the next page
General Notes/Limitations
l
l
l
l
l
l
l
l
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.
When configuring the remote server name in the Server field of the UNIX Remote Server dialog box, you
should use the same name that is configured in the Docker or cluster. For example, if the Docker uses an
IP address to identify the server, then an IP address should be used in the remote server name. Failure to
do this when monitoring a cluster results in the Docker nodes being displayed in a different hierarchy to the
cluster when viewing the monitor in the Unified Console (Hierarchy Monitors > Docker).
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.
You cannot move (cut and paste) a Dynamic Docker monitor if it has any dependencies, including auto
discovered application monitor dependencies. Note that if you move an auto discovered application
monitor, the link between the Dynamic Docker monitor and the application monitor is retained. If you make
a copy of a Dynamic Docker monitor, any links between the copied Dynamic Docker monitor and the
application monitors will be removed, and the discover mechanism will try to deploy a template on the
monitored containers (of the copied monitor) as if it is a new monitor.
Baseline Settings are not available for dynamic monitors (these monitors configure their own thresholds).
APM Integration is partially supported; the monitor sends data and simple monitor CI topology to APM.
The monitor does not report the full Docker topology model to APM.
Operations Manager Integration is not supported. As a result, the monitor does not report events and
metrics data to HPOM or OMi.
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).
Unable to obtain CPU and Memory Health counters for nodes on Kubernetes version 1.4. As a
workaround, you can create a CPU and Memory monitor on the Kubernetes node to get the counters.
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.
HPE SiteScope (11.33)
Page 245 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
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 Dynamic Docker Monitor Logs
1. Check for dynamic framework errors in:
l
l
<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.
<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 in <SiteScope root
directory>\logs\docker_monitor\docker_monitor.log.
###################################################################################
# Dynamic Docker Monitor
###################################################################################
log4j.category.com.mercury.sitescope.monitors.facades.DynamicDockerMonitor=DEBUG, docker.appender
log4j.additivity.com.mercury.sitescope.monitors.facades.DynamicDockerMonitor=false
log4j.category.com.mercury.sitescope.monitors.docker.counterEntities=DEBUG, docker.appender
log4j.additivity.com.mercury.sitescope.monitors.docker.counterEntities=false
log4j.category.com.mercury.sitescope.monitors.docker.DockerSwarmInfo=DEBUG, docker.appender
log4j.additivity.com.mercury.sitescope.monitors.docker.DockerSwarmInfo=false
log4j.appender.docker.appender=org.apache.log4j.RollingFileAppender
log4j.appender.docker.appender.File=../${log.file.docker_monitor.path}/docker_monitor.log
log4j.appender.docker.appender.MaxFileSize=${def.file.max.size}
log4j.appender.docker.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.docker.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.docker.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p - %m%n
log4j.appender.docker.appender.encoding=${general.encoding}
2. Check for Dynamic Docker monitor errors in:
l
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific monitor runs
and actions related to managing monitors.
Troubleshooting Dynamic Docker Application Discovery Logs
1. Check for Docker application discovery mechanism errors.
l
To check for errors in the automatic Docker application discovery mechanism, copy the following
section from the log4j.properties.debug file in the <SiteScope root
HPE SiteScope (11.33)
Page 246 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
directory>\conf\core\Tools\log4j\PlainJava folder to the log4j.properties file, and change the log
level to DEBUG in <SiteScope root directory>\logs\docker_monitor\app_discover_listener.log,
app_discover_scheduler.log, app_discover_config_file_updater.log, or app_discover_web_ui_
requests.log.
###################################################################################
# Dynamic Docker App Discover Appenders and loggers
###################################################################################
log4j.category.AppDiscoverLinstener=DEBUG, app_discover_listener.appender
log4j.additivity.AppDiscoverLinstener=false
#
# app_discover_listener appender
#
log4j.appender.app_discover_listener.appender=org.apache.log4j.RollingFileAppender
log4j.appender.app_discover_listener.appender.File=../${log.file.docker_monitor.path}/app_
discover_listener.log
log4j.appender.app_discover_listener.appender.MaxFileSize=${def.file.max.size}
log4j.appender.app_discover_listener.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.app_discover_listener.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.app_discover_listener.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p %m%n
log4j.appender.app_discover_listener.appender.encoding=${general.encoding}
log4j.category.AppDiscoverScheduler=DEBUG, app_discover_scheduler.appender
log4j.additivity.AppDiscoverScheduler=false
#
# app_discover_scheduler appender
#
log4j.appender.app_discover_scheduler.appender=org.apache.log4j.RollingFileAppender
log4j.appender.app_discover_scheduler.appender.File=../${log.file.docker_monitor.path}/app_
discover_scheduler.log
log4j.appender.app_discover_scheduler.appender.MaxFileSize=${def.file.max.size}
log4j.appender.app_discover_scheduler.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.app_discover_scheduler.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.app_discover_scheduler.appender.layout.ConversionPattern=%d [%t] (%F:%L) %-5p %m%n
log4j.appender.app_discover_scheduler.appender.encoding=${general.encoding}
log4j.category.AppDiscoverConfigFileUpdater=DEBUG, app_discover_config_file_updater.appender
log4j.additivity.AppDiscoverConfigFileUpdater=false
#
# app_discover_config_file_updater appender
#
log4j.appender.app_discover_config_file_updater.appender=org.apache.log4j.RollingFileAppender
log4j.appender.app_discover_config_file_updater.appender.File=../${log.file.docker_
monitor.path}/app_discover_config_file_updater.log
log4j.appender.app_discover_config_file_updater.appender.MaxFileSize=${def.file.max.size}
log4j.appender.app_discover_config_file_updater.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.app_discover_config_file_updater.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.app_discover_config_file_updater.appender.layout.ConversionPattern=%d [%t] (%F:%L)
%-5p - %m%n
log4j.appender.app_discover_config_file_updater.appender.encoding=${general.encoding}
HPE SiteScope (11.33)
Page 247 of 924
Monitor Reference
Chapter 29: Dynamic Docker Monitor
#
# app_discover_web_ui_requests appender
#
log4j.appender.app_discover_web_ui_requests.appender=org.apache.log4j.RollingFileAppender
log4j.appender.app_discover_web_ui_requests.appender.File=../${log.file.docker_monitor.path}/app_
discover_web_ui_requests.log
log4j.appender.app_discover_web_ui_requests.appender.MaxFileSize=${def.file.max.size}
log4j.appender.app_discover_web_ui_requests.appender.MaxBackupIndex=${def.files.backup.count}
log4j.appender.app_discover_web_ui_requests.appender.layout=org.apache.log4j.PatternLayout
log4j.appender.app_discover_web_ui_requests.appender.layout.ConversionPattern=%d [%t] (%F:%L) %5p - %m%n
log4j.appender.app_discover_web_ui_requests.appender.encoding=${general.encoding}
2. Check the following logs in the <SiteScope root directory>\logs\docker_monitor folder:
l
<SiteScope root directory>\logs\docker_monitor\app_discover_listener.log. This log contains
information about:
i. Dynamic Docker monitor configuration changes, for example, if monitored containers are added
to or deleted from the monitor, or if an existing container stops or is restarted.
ii. Dynamic Docker monitor deletion.
iii. Application group deletion.
l
l
l
<SiteScope root directory>\logs\docker_monitor\app_discover_scheduler.log. This log
contains information about all of the discovery schedulers. For more details on the schedulers, see
"How to Configure the Automatic Discovery Mechanism Schedulers" on page 234.
<SiteScope root directory>\logs\docker_monitor\app_discover_config_file_updater.log. This
log contains information about new and updated config files. Check this file to ensure that the
configuration loaded properly. This is dependent on the frequency that the config file is checked for
changes, which is determined by the _
dynamicDockerAppDiscoverConfigFilesSampleRateInSeconds property in the SiteScope
root\groups\master.config file. For details, see the "How to Configure the Automatic Discovery
Mechanism Schedulers" on page 234.
<SiteScope root directory>\logs\docker_monitor\app_discover_web_ui_requests.log. This log
contains information about requests to the applications discovered from the Unified Console (Web user
interface).
HPE SiteScope (11.33)
Page 248 of 924
Chapter 30: 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 251
l
"Connection Pool Settings" on page 252
l
"Thread Pool Settings" on page 253
l
"License Consumption" on page 254
Dynamic JMX Monitor Overview
This monitor enables you to:
l
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.
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.
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
HPE SiteScope (11.33)
Page 249 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
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
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 11g (10.3.110.3.5) or 12c server with an SSL connection using the t3, t3s, iiop or iiops protocol" on page 257.
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), 12c
l
Apache Tomcat 5.0, 5.5, 6.0, 6.0.33, 7.0.25, 7.0.50, 7.0.61, 7.0.62, 8.0.23
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
JBoss EAP 6.1.x - 6.2.x, 6.3.0
l
Sun Glassfish Enterprise Server 2.1, 3.1
l
WildFly 8.0.0, 8.1.0, 8.2.0
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) and 12c 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.
Tomcat 5.x and 6.0 support JSR 160, by defining the following properties to the JVM on startup:
l
l
Dcom.sun.management.jmxremote
l
Dcom.sun.management.jmxremote.port=9999
HPE SiteScope (11.33)
Page 250 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
l
Dcom.sun.management.jmxremote.ssl=false
l
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:
l
-Dcom.sun.management.jmxremote
l
-Dcom.sun.management.jmxremote.port=9999
l
-Dcom.sun.management.jmxremote.ssl=false
l
-Dcom.sun.management.jmxremote.authenticate=false
l
-Djboss.platform.mbeanserver
l
l
JBoss 6.1 supports JSR 160, by defining the following properties to the JVM on startup:
l
-Dcom.sun.management.jmxremote
l
-Dcom.sun.management.jmxremote.port=9999
l
-Dcom.sun.management.jmxremote.authenticate=false
l
-Dcom.sun.management.jmxremote.ssl=false
l
-Djboss.platform.mbeanserver
l
l
-Djavax.management.builder.initial=org.jboss.system.server.jmx.
MBeanServerBuilderImpl
-Djavax.management.builder.initial=org.jboss.system.server.jmx.
MBeanServerBuilderImpl
l
-Djava.endorsed.dirs="%JBOSS_ENDORSED_DIRS%"
l
-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
HPE SiteScope (11.33)
Page 251 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
and related CI topology is selected in HP Integration Settings (the default setting), the monitor creates the
following topology in APM's RTSM.
Note: By default, the Dynamic JMX monitor reports topology data to APM when monitoring the
WebLogic application server only. To report topology data when monitoring any other environment (such
as JBoss or Oracle), you need to type the server name and hostname into the CI type key attributes fields
in HP Integration Settings > Topology Settings.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM 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.
HPE SiteScope (11.33)
Page 252 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
You can tune the following connection pool properties in Preferences > Infrastructure Preferences >
Monitor Settings, as required:
l
l
l
l
l
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).
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).
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.
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.
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.
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. Additional classpath is used if your MBean classes are not part of SiteScope
classpath.
l
l
l
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.
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.
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.
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.
HPE SiteScope (11.33)
Page 253 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
License Consumption
Points-based Usage
Capacity-based Usage
One point per monitored object.
One OSi license per monitored host
An object is a path in the tree (not containing the counter name itself)
for which at least one direct counter is selected.
Tasks
This section includes the following tasks:
l
l
l
"How to Configure the Dynamic JMX Monitor" below
"How to create a Dynamic JMX Monitor for JBoss 7.1, JBoss EAP 6.1.x - 6.2.x, or WildFly 8.0.0" on
page 256
"How to monitor a WebLogic 11g (10.3.1-10.3.5) or 12c server with an SSL connection using the t3, t3s,
iiop or iiops protocol" on page 257
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 259.
o
For a WebLogic 11g (10.3.1-10.3.5) or 12c server, enter the following when configuring the
monitor:
l
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
l
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 11g or 12c using a t3 or t3s protocol: You need to use WebLogic's own
protocol provider package as described in "How to monitor a WebLogic 11g (10.3.1-10.3.5) or 12c
server with an SSL connection using the t3, t3s, iiop or iiops protocol" on page 257.
HPE SiteScope (11.33)
Page 254 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
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:
l
l
l
The pattern should always start and end with the forward slash ("/") character.
The "[" and "]" characters which appear as part of counter names should be escaped
(preceded with the backslash ("\") character)
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:
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 in the Frequency of updating counters
from server box. 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. Click Verify & Save or Save to save your settings.
HPE SiteScope (11.33)
Page 255 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
j. 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 251.
For user interface details, see "APM 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.
For details, see "Connection Pool Settings" on page 252 and "Thread Pool Settings" on page 253.
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:
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details, see
Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
l
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic Monitoring Page in
the Using SiteScope Guide.
l
How to create a Dynamic JMX Monitor for JBoss 7.1, JBoss EAP 6.1.x - 6.2.x, or
WildFly 8.0.0
Configure the monitor properties as described in the UI Descriptions section below.
Note: To get counters from a JBoss 7.1.x, JBoss EAP 6.1.x - 6.2.x, or WildFly 8.0.0 server, you must:
1. Add the following jars to classpath:
l
jboss-common-core.jar
HPE SiteScope (11.33)
Page 256 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
jboss-client.jar
l
2. Select the Load additional classpath first check box.
How to monitor a WebLogic 11g (10.3.1-10.3.5) or 12c 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:
This task is part of a higher-level task. For details, see "How to Configure the Dynamic JMX Monitor"
on page 254.
l
When monitoring a WebLogic server with the Administration port enabled, the t3s protocol must be
used.
l
1. Enter the URL in the following format in the JMX URL box of JMX Monitor Settings:
For t3 protocol:
l
service:jmx:t3://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
where the default port for t3 protocol is 7001
For t3s protocol:
l
service:jmx:t3s://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
where the default port for t3s protocol is 7002
For iiop protocol:
l
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:
l
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:
l
%WEBLOGIC_HOME%\server\lib\wlclient.jar
l
%WEBLOGIC_HOME%\server\lib\wljmxclient.jar
l
%WEBLOGIC_HOME%\server\lib\weblogic.jar
l
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
HPE SiteScope (11.33)
Page 257 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
l
l
%WEBLOGIC_HOME%\server\lib\webserviceclient+ssl.jar (for t3s protocol only)
%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:
l
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
l
%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.
HPE SiteScope (11.33)
Page 258 of 924
Monitor Reference
Chapter 30: 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 11g or 12c 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
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.
When creating a JMX monitor for a JBoss 7.1 or JBoss EAP 6.1.x - 6.2.x server,
enter the following URL:
service:jmx:remoting-jmx://<host>:<port>
l
When creating a JMX monitor for a WildFly 8.0.0 server, enter the following URL:
service:jmx:http-remoting-jmx://<host>:<port>
l
l
Domain filter
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) or 12c server with an SSL connection using
the t3, t3s, iiop or iiops protocol" on page 257.
The JMX over RMI protocol is not firewall friendly.
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
l
HPE SiteScope (11.33)
For MBean "Catalina/Cache/localhost/SiteScope" specify:
"Catalina:type=Cache,host=localhost,path=/SiteScope"
For MBean "Catalina/Environment/Global/simpleValue" specify:
"Catalina:type=Environment,resourcetype=Global,name=simpleValue"
Page 259 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
UI Element
Description
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)
Additional
classpath
The classpath library that is used to resolve unknown classes retrieved from the JMX
server. Use additional classpath if your MBean classes are not part of SiteScope
classpath. 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 253.
Note: When monitoring a WebLogic Application Server 11g (10.3.1 - 10.3.5) or 12c, 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.
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
that match the selected patterns.
button to display counters
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.
HPE SiteScope (11.33)
Page 260 of 924
Monitor Reference
Chapter 30: Dynamic JMX 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: 1 hour
Note:
l
l
l
Continue
displaying
counters that
no longer exist
after update
The update frequency cannot be less than the monitor run frequency in Monitor Run
Settings.
When configuring this setting in a template, the variable value can only be in time
units of seconds.
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
General Notes
l
l
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.
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).
Baseline Settings are not available for dynamic monitors (these monitors configure their own thresholds).
HPE SiteScope (11.33)
Page 261 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
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:
l
l
<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.
<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.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 Dynamic JMX monitor errors in:
l
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific monitor runs
and actions related to managing monitors.
HPE SiteScope (11.33)
Page 262 of 924
Monitor Reference
Chapter 30: Dynamic JMX Monitor
l
<SiteScope root directory>\logs\dynamic_monitoring.log\dynamic_jmx_monitor.log. This log
provides information about Dynamic JMX monitor errors.
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,
dynamicjmx.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}
HPE SiteScope (11.33)
Page 263 of 924
Chapter 31: 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 eBusiness 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
l
"License Consumption" 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 711).
l
Check that the order status was updated (see "URL Sequence Monitor" on page 711).
l
Check that a confirmation email was received (see "Mail Monitor" on page 375).
l
Check that the order was added to the order database (see "Database Query Monitor" on page 182).
l
Check that the order was transferred to a legacy system (see "Script Monitor" on page 594).
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.
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.
HPE SiteScope (11.33)
Page 264 of 924
Monitor Reference
Chapter 31: e-Business Transaction Monitor
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.
License Consumption
Points-based
Usage
Capacity-based Usage
One point per
monitor
This is a free monitor that does not require any particular license type or available
capacity.
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 711).
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.
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.
HPE SiteScope (11.33)
Page 265 of 924
Monitor Reference
Chapter 31: e-Business Transaction Monitor
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see 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
Error handling option during the sequence:
l
l
l
Single
session
Continue to run the remainder of the monitors. This runs every monitor no matter
what the status of a given monitor is.
Stop and do not run any of the remaining monitors. This stops running the list of
monitors immediately, if a monitor returns an error.
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
Items
Using the control key or equivalent, double-click the set of monitors that make up the eBusiness Transaction monitor to move them to the Selected column.
Note:
l
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 the previous page.
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" 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.
HPE SiteScope (11.33)
Page 266 of 924
Monitor Reference
Chapter 31: e-Business Transaction Monitor
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.
HPE SiteScope (11.33)
Page 267 of 924
Chapter 32: 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, 11.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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the F5 Big-IP Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 268 of 924
Monitor Reference
Chapter 32: 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
F5 Big IP
version
Select the version of the monitored F5 Big IP system (4.x, 10.x, 11.x).
Default value: 4.x
HPE SiteScope (11.33)
Page 269 of 924
Monitor Reference
Chapter 32: F5 Big-IP Monitor
UI Element
Description
MIB file
MIB file option:
l
l
l
l
l
l
l
l
l
LOAD-BAL-SYSTEM-MIBS file displays only those objects which are related to the
4.x version monitoring.
F5-BIGIP-APM-MIB file displays APM objects, such as access and connectivity
statistics, pool statistics, and general APM information. Related to 10.x and 11.x
versions monitoring.
F5-BIGIP-COMMON-MIB file displays common information for which all other BIGIP MIB files reference, as well as the F5-specific SNMP traps. Related to 10.x and
11.x versions monitoring.
F5-BIGIP-GLOBAL-MIB file displays GTM objects, such as wide IPs, virtual
servers, pools, links, servers, and datacenters. Related to 10.x and 11.x versions
monitoring.
F5-BIGIP-LOCAL-MIB file displays LTM objects, such as virtual servers, pools,
nodes, profiles, SNATs, health monitors, and iRules. Related to 10.x and 11.x
versions monitoring.
F5-BIGIP-SYSTEM-MIB file displays BIG-IP system information, such as global
statistic data, network information, and platform information. Related to 10.x and 11.x
versions monitoring.
F5-BIGIP-WAM-MIB file displays WebAccelerator traffic objects, such as
WebAccelerator specific statistic data, connection stats, or build information.
Related to 10.x and 11.x versions monitoring.
F5-BIGIP-EM-MIB file displays Enterprise Manager objects, such as Device Lists,
Device Groups and Images available on the system. Related to 11.x version
monitoring.
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. Related to 11.x version monitoring.
Default value: All MIBs
Counter
calculation
mode
Performs a calculation on objects of type Counter, Counter32, or Counter64. The
available calculations are:
l
l
l
Calculate delta. Calculates a simple delta of the current value from the previous
value.
Calculate rate Calculates a rate calculation using the delta of current value from
previous value, divided by the time elapsed between measurements.
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.
HPE SiteScope (11.33)
Page 270 of 924
Monitor Reference
Chapter 32: 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.
Privacy
algorithm
The privacy algorithm used for authentication for SNMP version 3 (DES,128-Bit
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.
HPE SiteScope (11.33)
Page 271 of 924
Monitor Reference
Chapter 32: F5 Big-IP Monitor
UI Element
Description
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.
HPE SiteScope (11.33)
Page 272 of 924
Monitor Reference
Chapter 32: 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.
HPE SiteScope (11.33)
Page 273 of 924
Chapter 33: 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
l
"License Consumption" on the next page
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
l
l
This monitor supports monitoring UNIX remote servers that have been configured in SiteScope and the
local SiteScope machine only.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
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:
l
OK
l
content match error
l
file not found
l
contents changed
HPE SiteScope (11.33)
Page 274 of 924
Monitor Reference
Chapter 33: File Monitor
An error status is returned if the current value of the monitor is anything other than OK.
License Consumption
Points-based Usage
Capacity-based Usage
One point per monitor
One OSi license per monitored host
Note: No points are consumed by this monitor if it is running
on a host covered by the OS Instance Advanced license.
Tasks
How to Configure the File Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see the UI Descriptions
section below.
Note: The Regular Expression Tool is available when configuring this monitor. For details on the tool,
see Regular Expression Tool in the Using SiteScope Guide.
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
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)
HPE SiteScope (11.33)
Page 275 of 924
Monitor Reference
Chapter 33: File Monitor
UI
Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the server to be
monitored:
l
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
File
name
Path and name to the file you want to monitor.
Note:
l
l
l
l
l
It may be necessary to provide the full path to the target file. For example,
/opt/application/logs/user.log.
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.
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.
You can also monitor files local to the server where SiteScope is running. For example,
C:\application\appLogs\access.log.
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.
HPE SiteScope (11.33)
Page 276 of 924
Monitor Reference
Chapter 33: File Monitor
UI
Element
Description
File
File content is monitored using an encoding that is different than the encoding used on server
encoding 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
Match
content
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
l
l
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.
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.
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".
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.
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.
HPE SiteScope (11.33)
Page 277 of 924
Monitor Reference
Chapter 33: 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:
l
l
l
l
No error
if file not
found
No content checking (default). SiteScope does not check for content changes.
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.
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.
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
HPE SiteScope (11.33)
Page 278 of 924
Chapter 34: 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.
License Consumption
Points-based
Usage
Capacity-based Usage
One point per
monitor
Requires no additional licensing beyond the licensing requirements of the member
monitors which it contains.
Tasks
How to Configure the Formula Composite Monitor
1. Prerequisites
l
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
HPE SiteScope (11.33)
Page 279 of 924
Monitor Reference
Chapter 34: Formula Composite Monitor
monitors. For details, see:
o
"Database Query Monitor" on page 182.
o
"Microsoft Windows Performance Counter Monitor" on page 486.
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.
l
o
"Script Monitor" on page 594.
o
"SNMP Monitor" on page 629.
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 required.
For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 280 of 924
Monitor Reference
Chapter 34: 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 Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 281 of 924
Monitor Reference
Chapter 34: Formula Composite Monitor
Tips/Troubleshooting
General Tips/Limitations
l
l
l
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.
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.
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.
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.
HPE SiteScope (11.33)
Page 282 of 924
Chapter 35: 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
l
"License Consumption" 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
l
login failed
l
file not found
l
contents changed
HPE SiteScope (11.33)
Page 283 of 924
Monitor Reference
Chapter 35: FTP Monitor
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.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license for 10 monitors
Tasks
How to Configure the FTP Monitor
1. Prerequisites
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
l
Before you can use this monitor, make sure you know:
l
o
The relative paths, if any, to the files on the FTP server.
o
An applicable user name and password to access the files.
o
The filenames of one or more files available for FTP transfer.
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
Tip:
l
l
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.
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 necessary, from
HPE SiteScope (11.33)
Page 284 of 924
Monitor Reference
Chapter 35: FTP Monitor
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
l
FTP. The monitor supports non-secure sockets only.
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
HPE SiteScope (11.33)
Page 285 of 924
Monitor Reference
Chapter 35: 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:
l
l
l
l
Timeout
(seconds)
No content checking (default).SiteScope does not check for content changes.
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.
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.
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
Connection Amount of time, in seconds, that the FTP monitor should wait to connect to the FTP server
timeout
before timing out. Once this time period passes, the FTP monitor logs an error and reports an
(seconds)
error status.
Default value: 30 seconds
HTTP Proxy Settings
(Not available in SFTP mode)
HPE SiteScope (11.33)
Page 286 of 924
Monitor Reference
Chapter 35: FTP Monitor
UI Element
Description
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
HPE SiteScope (11.33)
Page 287 of 924
Chapter 36: 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
l
"License Consumption" 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.
License Consumption
Points-based Usage
Capacity-based Usage
One point per host and one point per guest One OSi license per monitored host
HPE SiteScope (11.33)
Page 288 of 924
Monitor Reference
Chapter 36: Generic Hypervisor Monitor
Tasks
How to Configure the Generic Hypervisor Monitor
1.
Prerequisites
l
l
l
2.
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
The monitored VM server must be directly accessible by the SiteScope server (no proxy involved).
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.
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 293. If the maximum number of counters that can be deployed
is exceeded, an error is written to the RunMonitor.log.
HPE SiteScope (11.33)
Page 289 of 924
Monitor Reference
Chapter 36: Generic Hypervisor Monitor
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 in the Frequency of updating counters
from server box. 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. Click Verify & Save or Save to save your settings.
j. 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:
l
l
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details, see
Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
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 292.
HPE SiteScope (11.33)
Page 290 of 924
Monitor Reference
Chapter 36: 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
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.
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
the selected patterns.
button to display counters that match
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.
HPE SiteScope (11.33)
Page 291 of 924
Monitor Reference
Chapter 36: Generic Hypervisor 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: 15 minutes
Note:
l
l
l
Continue
displaying
counters that
no longer exist
after update
The update frequency cannot be less than the monitor run frequency in Monitor Run
Settings.
When configuring this setting in a template, the variable value can only be in time
units of seconds.
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" below
l
"Maximum Number of Counters That Can be Saved" on the next page
l
"Troubleshooting Logs" on the next page
General Notes
l
l
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.
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.
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
HPE SiteScope (11.33)
Page 292 of 924
Monitor Reference
Chapter 36: Generic Hypervisor Monitor
displayed only when you click the Threshold Preview button (thresholds of all patterns are translated to
actual current counters and are displayed).
l
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).
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:
l
l
<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.
<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.log
log4j.appender.dynamic.monitoring.appender.MaxFileSize=1000KB
log4j.appender.dynamic.monitoring.appender.MaxBackupIndex=5
HPE SiteScope (11.33)
Page 293 of 924
Monitor Reference
Chapter 36: Generic Hypervisor Monitor
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:
l
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific monitor runs
and actions related to managing monitors.
HPE SiteScope (11.33)
Page 294 of 924
Chapter 37: 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 250).
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.
Tip: 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 297
l
"Hadoop Topology" on page 297
l
"License Consumption" on page 298
Hadoop Monitor Overview
This monitor enables you to:
l
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.
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. 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
HPE SiteScope (11.33)
Page 295 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
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 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
l
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).
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).
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
HPE SiteScope (11.33)
Page 296 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
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
l
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.
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.
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.
l
l
l
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.
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.
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.
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 APM's RTSM.
HPE SiteScope (11.33)
Page 297 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
Note:
l
l
Topology reporting for this monitor is only supported in BSM 9.23 and later.
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.
License Consumption
Points-based Usage
Capacity-based Usage
One point per monitored object.
One OSi license per monitored host
An object is a path in the tree (not containing the counter name itself)
for which at least one direct counter is selected).
Tasks
How to Configure the Hadoop Monitor
1.
Configure the monitor properties
a. Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
b. 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.
c. In the General Settings panel, enter a name and description for the monitor.
d. In the Hadoop Monitor Settings panel, enter the required settings as described in "Hadoop Monitor
Settings" on page 301.
e. In the Patterns & Counter section, click the Get Counter button, and select the counters you want
HPE SiteScope (11.33)
Page 298 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
to monitor from the Select Counters Form (the form displays static counters only). The counters are
added to the Counter Preview tree.
f. 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:
l
l
l
The pattern should always start and end with the forward slash ("/") character.
The "[" and "]" characters which appear as part of counter names should be escaped
(preceded with the backslash ("\") character)
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 "Tips/Troubleshooting" on
page 306. 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.
g. 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.
h. Set the frequency for updating counters from the server in the Frequency of updating counters
from server box. If you use only static counters, they are not affected by the frequency for updating
counters, since the dynamic framework does not run.
i. 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.
j. Click Verify & Save or Save to save your settings.
k. 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.
HPE SiteScope (11.33)
Page 299 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
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.
For details, see "Connection Pool Settings" on page 296 and "Thread Pool Settings" on page 297.
3.
Enable topology reporting - optional
l
l
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 "APM Integration
Data and Topology Settings" in the Using SiteScope Guide. For details on the Hadoop monitor
topology, see "Hadoop Topology" on page 297.
To see topology reported by the monitor and Health Indicators assigned to monitor metrics, you
should download and install the following resources from the HPE Live Network:
Content Pack for DDM:
i. Navigate to HPE 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 APM:
i. Navigate to HPE 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:
l
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details, see
Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 300 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
l
In Server Statistics using the Dynamic Monitoring page. For details, see Dynamic Monitoring Page in
the Using SiteScope Guide.
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
Domain filter
Domain that is used to gather Hadoop statistics (optional). If this field is left blank, the
default Hadoop domain filter is used.
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
that match the selected patterns.
button to display counters
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.
HPE SiteScope (11.33)
Page 301 of 924
Monitor Reference
Chapter 37: 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" 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.
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:
l
l
l
Continue
displaying
counters that
no longer exist
after update
The update frequency cannot be less than the monitor run frequency in Monitor Run
Settings.
When configuring this setting in a template, the variable value can only be in time
units of seconds.
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.
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.
HPE SiteScope (11.33)
Page 302 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
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.
HPE SiteScope (11.33)
Page 303 of 924
Monitor Reference
Chapter 37: 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
Hadoop/JobTracker/JobTrackerInfo/TaskTrackers/.*/Dir failures
Hadoop/JobTracker/JobTrackerInfo/TaskTrackers/.*/Failures
Hadoop/JobTracker/JobTrackerInfo/ThreadCount
HPE SiteScope (11.33)
Page 304 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
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
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
HPE SiteScope (11.33)
Page 305 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
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
l
l
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.
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).
Baseline Settings are not available for dynamic monitors (these monitors configure their own thresholds).
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 _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:
l
<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.
HPE SiteScope (11.33)
Page 306 of 924
Monitor Reference
Chapter 37: Hadoop Monitor
l
<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.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 Hadoop monitor errors in:
l
l
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific monitor runs
and actions related to managing monitors.
<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.
##################################################################################
# Hadoop monitor
##################################################################################
log4j.category.com.mercury.sitescope.monitors.facades.HadoopMonitor=DEBUG, hadoop.appender
log4j.additivity.com.mercury.sitescope.monitors.facades.HadoopMonitor=false
log4j.category.com.mercury.sitescope.monitors.bigdata.hadoop.utils.HadoopMonitorUtils=DEBUG,
hadoop.appender
log4j.additivity.com.mercury.sitescope.monitors.bigdata.hadoop.utils.HadoopMonitorUtils=false
log4j.category.com.mercury.sitescope.monitors.bigdata.hadoop.tasks.HadoopMonitorCounterLoadingTas
k=DEBUG, hadoop.appender
log4j.additivity.com.mercury.sitescope.monitors.bigdata.hadoop.tasks.HadoopMonitorCounterLoadingT
ask=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}
HPE SiteScope (11.33)
Page 307 of 924
Chapter 38: 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 HAProxy 1.3, 1.4, and 1.5.10 on 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
HPE SiteScope (11.33)
One OSi license per monitored host
Page 308 of 924
Monitor Reference
Chapter 38: HAProxy Monitor
Tasks
How to Configure the HAProxy Monitor
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
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
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.
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.
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.
Note: The proxy server must support Proxy-Authenticate for these options to function.
HPE SiteScope (11.33)
Page 309 of 924
Monitor Reference
Chapter 38: 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.
HPE SiteScope (11.33)
Page 310 of 924
Chapter 39: 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
l
"License Consumption" on the next page
HP iLO Background
HP Integrated Lights-Out, or iLO, is an embedded server management technology exclusive to HewlettPackard 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
(missing or bad snippet)
HPE SiteScope (11.33)
Page 311 of 924
Monitor Reference
Chapter 39: 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
l
l
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.
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.
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.
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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the HP iLO Monitor
1. Prerequisites
The following are important requirements for using the HP iLO monitor:
l
l
l
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
The HP iLO system administrator must configure the service on the ProLiant server so that it can
access a command line interface over SSH.
The configuration should be tested by connecting the server to the SSH client using the configured
credentials, and running the following command:
HPE SiteScope (11.33)
Page 312 of 924
Monitor Reference
Chapter 39: 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 required.
For a description of each setting, see 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 monitor. For
Counters 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.
HPE SiteScope (11.33)
Page 313 of 924
Monitor Reference
Chapter 39: 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
l
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.
Problem: Intermittent issue with connection to HP-ILO remote server; periodically the Test Connection
for this remote fails with a timeout error.
Solution:
1. Open the master.config file in <SiteScope root directory>\groups, and add the property _
hpILOConnectionDelay=200 (the value is measured in milliseconds).
2. Save the master.config file and restart SiteScope.
HPE SiteScope (11.33)
Page 314 of 924
Chapter 40: 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
(missing or bad snippet)
License Consumption
Points-based Usage
One point per monitor
Note: No points are consumed by this monitor if it is running on a host covered by
the OS Instance Advanced license.
Capacity-based
Usage
One OSi license per
monitored host
Tasks
How to Configure the HP NonStop Event Log Monitor
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
UI Descriptions
HP NonStop Event Log Monitor Settings
User interface elements are described below:
UI Element
Description
Main Settings
HPE SiteScope (11.33)
Page 315 of 924
Monitor Reference
Chapter 40: HP NonStop Event Log Monitor
UI Element
Description
URL
URL of the OSM Event Viewer.
Example: https://<nonstopserver>:9991
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.
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
HPE SiteScope (11.33)
Page 316 of 924
Monitor Reference
Chapter 40: HP NonStop Event Log Monitor
UI Element
Description
Credentials
User name and password required to access the HP NonStop server. Select the option to
use for providing credentials:
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.
l
Pre-emptive
Authorization user name and password option if SiteScope requests the target UR:
authorization
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.
Authenticate first request. The user name and password are sent on the first request
SiteScope makes for the target URL.
l
Note: If the URL does not require a user name and password, this option may cause the
URL to fail.
Authenticate if requested. The user name and password are sent on the second
request if the server requests a user name and password.
l
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.
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).
Default value: Not selected
HPE SiteScope (11.33)
Page 317 of 924
Monitor Reference
Chapter 40: HP NonStop Event Log Monitor
UI Element
Description
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
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.
HPE SiteScope (11.33)
Page 318 of 924
Chapter 41: 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
l
"License Consumption" 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
(missing or bad snippet)
License Consumption
Points-based Usage
Capacity-based Usage
One point per object instance
One OSi license per monitored host
Note: No points are consumed by this monitor if it is running on a
host covered by the OS Instance Advanced license.
HPE SiteScope (11.33)
Page 319 of 924
Monitor Reference
Chapter 41: 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 required.
For a description of each setting, see 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:
l
In the Shell name field, enter tacl.
l
In the Login prompt field, enter >.
l
In the Secondary response field, enter OSH.
l
In the User name box in the Credentials section, enter the user name in the format: logon
<user_name>.
HPE SiteScope (11.33)
Page 320 of 924
Monitor Reference
Chapter 41: 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
selected measurements are moved to the Selected Counters list.
button. The
Note:
l
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.
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" below.
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
Available Counters list.
button. The measurements are moved to the
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:
HPE SiteScope (11.33)
Page 321 of 924
Monitor Reference
Chapter 41: HP NonStop Resources 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)
HPE SiteScope (11.33)
• 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 322 of 924
Chapter 42: 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 run-time.
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
l
"License Consumption" on page 325
Vertica JDBC Monitor Overview
This monitor enables you to:
l
l
Monitor specific counters on a Vertica cluster using static counters. You can monitor multiple parameters
or counters with a single monitor instance.
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.
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).
HPE SiteScope (11.33)
Page 323 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
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
(missing or bad snippet)
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
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.
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 APM's RTSM.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 324 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
Note: Topology reporting for this monitor is only supported in BSM 9.23 and later.
License Consumption
Points-based Usage
Capacity-based Usage
One point per monitored group.
HP Vertica JDBC monitor consumes one OS
instance per monitored server and one OS instance
per monitored node.
A group is a path in the tree (not containing the
counter name itself) for which at least one direct
counter is selected).
Note: This monitor is not available with Community
Edition.
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:
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:
l
l
l
The pattern should always start and end with the forward slash ("/") character.
Special characters which appear as part of counter names should be escaped (preceded
with the backslash ("\") character).
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
HPE SiteScope (11.33)
Page 325 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
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 331. 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 in the Frequency of updating counters
from server box. 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. Click Verify & Save or Save to save your settings.
j. 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:
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 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
l
l
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 "APM 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 324.
To see topology reported by the monitor and Health Indicators assigned to monitor metrics, you
should download and install the following resources from the HPE Live Network:
Content Pack for DDM:
i. Navigate to HPE Live Network Home > Discovery and Dependency Mapping > Content
Packs for DDM > Content Files (https://hpln.hp.com/node/31/contentfiles).
HPE SiteScope (11.33)
Page 326 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
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 HPE 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 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:
l
l
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details, see
Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
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
HPE SiteScope (11.33)
Page 327 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
UI Element
Description
Credentials
Option for providing the user name and password to be used to access the Vertica
database server:
l
l
Patterns &
Counters
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.
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.
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
match the selected patterns.
button to display counters that
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.
HPE SiteScope (11.33)
Page 328 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC 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: 15 minutes
Note:
l
l
l
Continue
displaying
counters
that no
longer exist
after update
The update frequency cannot be less than the monitor run frequency in Monitor Run
Settings.
When configuring this setting in a template, the variable value can only be in time units
of seconds.
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.
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
HPE SiteScope (11.33)
Page 329 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
Tree Branch
Counters
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
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
HPE SiteScope (11.33)
Page 330 of 924
Monitor Reference
Chapter 42: 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
l
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.
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).
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,
HPE SiteScope (11.33)
Page 331 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
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:
l
l
<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.
<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.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 HP Vertica JDBC monitor errors in:
l
l
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific monitor runs
and actions related to managing monitors.
<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
HPE SiteScope (11.33)
Page 332 of 924
Monitor Reference
Chapter 42: HP Vertica JDBC Monitor
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}
HPE SiteScope (11.33)
Page 333 of 924
Chapter 43: 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.
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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
(Maximum: 120)
One OSi license per monitored host.
Supported Versions
IPMI-enabled devices running version 1.5 and 2.0 Rev 1.1.
Tasks
How to Configure the IPMI Monitor
1. Prerequisites
The following are requirements for using the IPMI monitor:
l
l
The device you want to monitor must 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.
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 required.
For a description of each setting, see the UI Descriptions section below.
HPE SiteScope (11.33)
Page 334 of 924
Monitor Reference
Chapter 43: 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
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.
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.
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.
HPE SiteScope (11.33)
Page 335 of 924
Chapter 44: 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:
l
There is also a "Dynamic JMX Monitor" on page 249 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" below
l
"Applications Supporting JSR 160" on page 338
l
"WebLogic Application Server Topology" on page 339
l
"Thread Pool Settings" on page 339
l
"License Consumption" on page 340
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
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) or 12c server with an SSL connection using the t3, t3s, iiop
or iiops protocol" on page 341.
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:
HPE SiteScope (11.33)
Page 336 of 924
Monitor Reference
Chapter 44: JMX Monitor
l
WebLogic 11g (10.3.1-10.3.5), 12c
Note: Monitoring WebLogic 9.x and 10.x is no longer supported due to different Java versions run by
SiteScope 11.2x or later, and WebLogic Application Server 9.x and 10.x.
l
Apache Tomcat 5.0, 5.5, 6.0, 6.0.33, 7.0.25, 7.0.50, 7.0.61, 7.0.62, 8.0.23
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
JBoss EAP 6.1.x - 6.2.x, 6.3.0
l
Sun Glassfish Enterprise Server 2.1, 3.1
l
WildFly 8.0.0, 8.1.0, 8.2.0
HPE SiteScope (11.33)
Page 337 of 924
Monitor Reference
Chapter 44: JMX Monitor
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) and 12c 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).
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) and 12c servers, see "How to
create a JMX Monitor for a WebLogic Server" on page 340.
l
Tomcat 5.x and 6.0 support JSR 160, by defining the following properties to the JVM on startup:
Dcom.sun.management.jmxremote
Dcom.sun.management.jmxremote.port=9999
Dcom.sun.management.jmxremote.ssl=false
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:
-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=9999
-Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false
-Djboss.platform.mbeanserver
-Djavax.management.builder.initial=org.jboss.system.server.jmx.
MBeanServerBuilderImpl
l
JBoss 6.1 supports JSR 160, by defining the following properties to the JVM on startup:
-Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=9999
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
-Djboss.platform.mbeanserver
-Djavax.management.builder.initial=org.jboss.system.server.jmx.
MBeanServerBuilderImpl
-Djava.endorsed.dirs="%JBOSS_ENDORSED_DIRS%"
-classpath "%JBOSS_CLASSPATH%" org.jboss.Main %*
l
Other vendors that have released versions of their software that are JSR 160 compliant, include JBoss,
Oracle 10g, and IBM WebSphere.
HPE SiteScope (11.33)
Page 338 of 924
Monitor Reference
Chapter 44: JMX Monitor
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 APM's RTSM.
Note:
l
l
By default, the JMX monitor reports topology data to APM when monitoring the WebLogic application
server only. To report topology data when monitoring any other environment (such as JBoss or
Oracle), you need to type the server name and hostname into the CI type key attributes fields in HP
Integration Settings > Topology Settings.
When the JMX monitor reports topology for a WebLogic cluster, if all counters in the monitor belong to
one server, SiteScope reports the server name to APM. Where all counters in the monitor are from
different servers, SiteScope reports the server cluster name to APM.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM 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
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.
JMX thread pool idle time (seconds): When the number of threads is greater than the core, this is the
HPE SiteScope (11.33)
Page 339 of 924
Monitor Reference
Chapter 44: JMX Monitor
maximum time that excess idle threads will wait for new JMX tasks before timing out. The default value is
30 seconds.
l
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.
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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
This section includes the following tasks:
l
l
l
"How to create a JMX Monitor for an Apache Tomcat, JBoss, Sun Glassfish Enterprise, Oracle
Application Server, or WildFly" below
"How to create a JMX Monitor for a WebLogic Server" below
"How to monitor a WebLogic 11g (10.3.1-10.3.5) or 12c server with an SSL connection using the t3, t3s,
iiop or iiops protocol" on the next page
How to create a JMX Monitor for an Apache Tomcat, JBoss, Sun Glassfish
Enterprise, Oracle Application Server, or WildFly
Configure the monitor properties as described in the UI Descriptions section below.
Note: To get counters from a JBoss 7.1.x, JBoss EAP 6.1.x - 6.2.x, or WildFly 8.0.0 server, you must:
1. Add the following jars to classpath:
l
jboss-common-core.jar
l
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) or 12c 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
HPE SiteScope (11.33)
Page 340 of 924
Monitor Reference
Chapter 44: JMX Monitor
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 or 12c) 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_
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 339.
For user interface details, see APM Integration Data and Topology Settings in the Using SiteScope
Guide.
How to monitor a WebLogic 11g (10.3.1-10.3.5) or 12c 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:
l
For t3 protocol:
service:jmx:t3://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
where the default port for t3 protocol is 7001
l
For t3s protocol:
service:jmx:t3s://<host>:<port>/jndi/weblogic.management.
mbeanservers.runtime
where the default port for t3s protocol is 7002
HPE SiteScope (11.33)
Page 341 of 924
Monitor Reference
Chapter 44: JMX Monitor
For iiop protocol:
l
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:
l
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:
l
%WEBLOGIC_HOME%\server\lib\wlclient.jar
l
%WEBLOGIC_HOME%\server\lib\wljmxclient.jar
l
%WEBLOGIC_HOME%\server\lib\weblogic.jar
l
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
l
%WEBLOGIC_HOME%\server\lib\webserviceclient+ssl.jar (for t3s protocol only)
l
%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:
l
%WEBLOGIC_HOME%\server\lib\wlfullclient.jar
l
%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 Settings Common to All Monitors in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 342 of 924
Monitor Reference
Chapter 44: JMX Monitor
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 or 12c 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
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.
When creating a JMX monitor for a JBoss 7.1.x or JBoss EAP 6.1.x - 6.2.x
server, enter the following URL:
service:jmx:remoting-jmx://<host>:<port>
l
When creating a JMX monitor for a WildFly 8.0.0 server, enter the following
URL:
service:jmx:http-remoting-jmx://<host>:<port>
l
l
HPE SiteScope (11.33)
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) or 12c server with an SSL
connection using the t3, t3s, iiop or iiops protocol" on page 341.
The JMX over RMI protocol is not firewall friendly.
Page 343 of 924
Monitor Reference
Chapter 44: 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
l
For MBean "Catalina/Cache/localhost/SiteScope" specify:
"Catalina:type=Cache,host=localhost,path=/SiteScope"
For MBean "Catalina/Environment/Global/simpleValue" specify:
"Catalina:type=Environment,resourcetype=Global,name=simpleValu
e"
Username
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 339.
Note: When monitoring a WebLogic Application Server 11g (10.3.1 - 10.3.5) or
12c, 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
HPE SiteScope (11.33)
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.
Page 344 of 924
Monitor Reference
Chapter 44: 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 or
12c server, see "How to create a JMX Monitor for a WebLogic Server" on
page 340 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. If you created
Arithmetic Counters in an earlier version of SiteScope and performed a SiteScope upgrade, you need to
recreate the counters in the Calculated Metrics panel, and then delete the Arithmetic Counters. For details
on calculated metrics, see Calculated Metrics Settings in the Using SiteScope Guide. HPE plans to
remove the Arithmetic Counters section from the JMX Monitor Settings in the next version of SiteScope.
Add Arithmetic Counter. (Deprecated - no longer available)
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:
l
"General Notes/Tips" on the next page
l
"Troubleshooting and Limitations" on the next page
HPE SiteScope (11.33)
Page 345 of 924
Monitor Reference
Chapter 44: JMX Monitor
General Notes/Tips
l
l
l
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.
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.
The JMX over RMI protocol is not firewall friendly.
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. HPE 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
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).
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.
l
l
On Windows platforms, each counter is set to n/a.
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.
HPE SiteScope (11.33)
Page 346 of 924
Chapter 45: 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
l
"License Consumption" 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.
License Consumption
HPE SiteScope (11.33)
Page 347 of 924
Monitor Reference
Chapter 45: KVM Monitor
Points-based Usage
Capacity-based Usage
One point per host and one point per guest One OSi license per monitored host
Tasks
How to Configure the KVM Monitor
1.
Prerequisites
l
2.
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
l
The monitored VM server must be directly accessible by the SiteScope server (no proxy involved).
l
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.
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.
HPE SiteScope (11.33)
Page 348 of 924
Monitor Reference
Chapter 45: KVM 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 354. 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 in the Frequency of updating counters
from server box. 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. Click Verify & Save or Save to save your settings.
j. 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:
l
l
The SiteScope Health group, using the Dynamic Monitoring Statistics monitor. For details, see
Dynamic Monitoring Statistics Page in the Using SiteScope Guide.
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 354.
HPE SiteScope (11.33)
Page 349 of 924
Monitor Reference
Chapter 45: KVM Monitor
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
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.
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
measurements
from
(Available in template mode only) Name of any SiteScope remote server from which you
want to get counters.
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.
Default value: qemu:///system
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
the selected patterns.
button to display counters that match
Note: SiteScope uses Perl regular expressions for pattern matching.
HPE SiteScope (11.33)
Page 350 of 924
Monitor Reference
Chapter 45: KVM 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"
below.
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:
l
l
l
Continue
displaying
counters that
no longer exist
after update
The update frequency cannot be less than the monitor run frequency in Monitor Run
Settings.
When configuring this setting in a template, the variable value can only be in time
units of seconds.
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.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
HPE SiteScope (11.33)
Page 351 of 924
Monitor Reference
Chapter 45: KVM Monitor
KVM Host Information
Virsh Management/Node Information/Core(s) per socket
Virsh Management/Node Information/CPU(s)
Virsh Management/Node Information/CPU frequency
Virsh Management/Node Information/CPU model
Virsh Management/Node Information/CPU socket(s)
Virsh Management/Node Information/Memory size
Virsh Management/Node Information/NUMA cell(s)
Virsh Management/Node Information/Thread(s) per core
KVM virtual machines information
Virsh Management/Domains Information/vm1/Autostart
Virsh Management/Domains Information/vm1/CPU(s)
Virsh Management/Domains Information/vm1/CPU time
Virsh Management/Domains Information/vm1/Id
Virsh Management/Domains Information/vm1/Max
memory
Virsh Management/Domains Information/vm1/Name
Virsh Management/Domains Information/vm1/OS Type
Virsh Management/Domains Information/vm1/Persistent
Virsh Management/Domains Information/vm1/Security
DOI
Virsh Management/Domains Information/vm1/Security
label
Virsh Management/Domains Information/vm1/Security
model
Virsh Management/Domains Information/vm1/State
Virsh Management/Domains Information/vm1/Used
memory
Virsh Management/Domains Information/vm1/UUID
Virsh Management/Domains Information/vm2/Autostart
Virsh Management/Domains Information/vm2/CPU(s)
Virsh Management/Domains Information/vm2/Id
Virsh Management/Domains Information/vm2/Max
memory
Virsh Management/Domains Information/vm2/Name
Virsh Management/Domains Information/vm2/OS Type
Virsh Management/Domains Information/vm2/Persistent
Virsh Management/Domains Information/vm2/Security
DOI
Virsh Management/Domains Information/vm2/Security
model
Virsh Management/Domains Information/vm2/State
Virsh Management/Domains Information/vm2/Used
memory
Virsh Management/Domains Information/vm2/UUID
KVM Domains Statistics Information
KVM Statistics/Domains/kvm_ack_irq
KVM Statistics/Domains/kvm_age_page
KVM Statistics/Domains/kvm_apic
KVM Statistics/Domains/kvm_apic_accept_irq
HPE SiteScope (11.33)
KVM Statistics/Domains/kvm_fpu
KVM Statistics/Domains/kvm_hv_hypercall
KVM Statistics/Domains/kvm_hypercall
KVM Statistics/Domains/kvm_inj_exception
KVM Statistics/Domains/kvm_inj_virq
KVM Statistics/Domains/kvm_invlpga
KVM Statistics/Domains/kvm_ioapic_set_irq
KVM Statistics/Domains/kvm_mmio
KVM Statistics/Domains/kvm_msi_set_irq
KVM Statistics/Domains/kvm_msr
KVM Statistics/Domains/kvm_nested_intercepts
KVM Statistics/Domains/kvm_nested_intr_vmexit
KVM Statistics/Domains/kvm_nested_vmexit
KVM Statistics/Domains/kvm_nested_vmexit_inject
KVM Statistics/Domains/kvm_nested_vmrun
KVM Statistics/Domains/kvm_page_fault
KVM Statistics/Domains/kvm_pic_set_irq
KVM Statistics/Domains/kvm_pio
KVM Statistics/Domains/kvm_set_irq
KVM Statistics/Domains/kvm_skinit
KVM Statistics/Domains/kvm_try_async_get_page
KVM Statistics/Domains/kvm_userspace_exit
KVM Statistics/Node/kvm_ack_irq
KVM Statistics/Node/kvm_age_page
KVM Statistics/Node/kvm_apic
KVM Statistics/Node/kvm_apic_accept_irq
KVM Statistics/Node/kvm_apic_ipi
KVM Statistics/Node/kvm_async_pf_completed
KVM Statistics/Node/kvm_async_pf_doublefault
KVM Statistics/Node/kvm_async_pf_not_present
KVM Statistics/Node/kvm_async_pf_ready
KVM Statistics/Node/kvm_cpuid
KVM Statistics/Node/kvm_cr
KVM Statistics/Node/kvm_emulate_insn
KVM Statistics/Node/kvm_entry
KVM Statistics/Node/kvm_exit
KVM Statistics/Node/kvm_exit(APIC_ACCESS)
KVM Statistics/Node/kvm_exit(CPUID)
KVM Statistics/Node/kvm_exit(CR_ACCESS)
KVM Statistics/Node/kvm_exit(DR_ACCESS)
KVM Statistics/Node/kvm_exit(EPT_MISCONFIG)
KVM Statistics/Node/kvm_exit(EPT_VIOLATION)
KVM Statistics/Node/kvm_exit(EXCEPTION_NMI)
KVM Statistics/Node/kvm_exit(EXTERNAL_
INTERRUPT)
KVM Statistics/Node/kvm_exit(HLT)
KVM Statistics/Node/kvm_exit(INVALID_STATE)
KVM Statistics/Node/kvm_exit(INVLPG)
KVM Statistics/Node/kvm_exit(IO_INSTRUCTION)
KVM Statistics/Node/kvm_exit(MCE_DURING_
VMENTRY)
Page 352 of 924
Monitor Reference
Chapter 45: KVM Monitor
KVM Statistics/Domains/kvm_apic_ipi
KVM Statistics/Domains/kvm_async_pf_completed
KVM Statistics/Domains/kvm_async_pf_doublefault
KVM Statistics/Domains/kvm_async_pf_not_present
KVM Statistics/Domains/kvm_async_pf_ready
KVM Statistics/Domains/kvm_cpuid
KVM Statistics/Domains/kvm_cr
KVM Statistics/Domains/kvm_emulate_insn
KVM Statistics/Domains/kvm_entry
KVM Statistics/Domains/kvm_exit
KVM Statistics/Domains/kvm_exit(APIC_ACCESS)
KVM Statistics/Domains/kvm_exit(CPUID)
KVM Statistics/Domains/kvm_exit(CR_ACCESS)
KVM Statistics/Domains/kvm_exit(DR_ACCESS)
KVM Statistics/Domains/kvm_exit(EPT_MISCONFIG)
KVM Statistics/Domains/kvm_exit(EPT_VIOLATION)
KVM Statistics/Domains/kvm_exit(EXCEPTION_NMI)
KVM Statistics/Domains/kvm_exit(EXTERNAL_
INTERRUPT)
KVM Statistics/Domains/kvm_exit(HLT)
KVM Statistics/Domains/kvm_exit(INVALID_STATE)
KVM Statistics/Domains/kvm_exit(INVLPG)
KVM Statistics/Domains/kvm_exit(IO_INSTRUCTION)
KVM Statistics/Domains/kvm_exit(MCE_DURING_
VMENTRY)
KVM Statistics/Domains/kvm_exit(MONITOR_
INSTRUCTION)
KVM Statistics/Domains/kvm_exit(MSR_READ)
KVM Statistics/Domains/kvm_exit(MSR_WRITE)
KVM Statistics/Domains/kvm_exit(MWAIT_
INSTRUCTION)
KVM Statistics/Domains/kvm_exit(NMI_WINDOW)
KVM Statistics/Domains/kvm_exit(PAUSE_
INSTRUCTION)
KVM Statistics/Domains/kvm_exit(PENDING_
INTERRUPT)
KVM Statistics/Domains/kvm_exit(RDPMC)
KVM Statistics/Domains/kvm_exit(RDTSC)
KVM Statistics/Domains/kvm_exit(TASK_SWITCH)
KVM Statistics/Domains/kvm_exit(TPR_BELOW_
THRESHOLD)
KVM Statistics/Domains/kvm_exit(TRIPLE_FAULT)
KVM Statistics/Domains/kvm_exit(VMCALL)
KVM Statistics/Domains/kvm_exit(VMCLEAR)
KVM Statistics/Domains/kvm_exit(VMLAUNCH)
KVM Statistics/Domains/kvm_exit(VMOFF)
KVM Statistics/Domains/kvm_exit(VMON)
KVM Statistics/Domains/kvm_exit(VMPTRLD)
KVM Statistics/Domains/kvm_exit(VMPTRST)
KVM Statistics/Domains/kvm_exit(VMREAD)
KVM Statistics/Domains/kvm_exit(VMRESUME)
KVM Statistics/Domains/kvm_exit(VMWRITE)
KVM Statistics/Domains/kvm_exit(WBINVD)
KVM Statistics/Domains/kvm_exit(XSETBV)
HPE SiteScope (11.33)
KVM Statistics/Node/kvm_exit(MONITOR_
INSTRUCTION)
KVM Statistics/Node/kvm_exit(MSR_READ)
KVM Statistics/Node/kvm_exit(MSR_WRITE)
KVM Statistics/Node/kvm_exit(MWAIT_
INSTRUCTION)
KVM Statistics/Node/kvm_exit(NMI_WINDOW)
KVM Statistics/Node/kvm_exit(PAUSE_
INSTRUCTION)
KVM Statistics/Node/kvm_exit(PENDING_
INTERRUPT)
KVM Statistics/Node/kvm_exit(RDPMC)
KVM Statistics/Node/kvm_exit(RDTSC)
KVM Statistics/Node/kvm_exit(TASK_SWITCH)
KVM Statistics/Node/kvm_exit(TPR_BELOW_
THRESHOLD)
KVM Statistics/Node/kvm_exit(TRIPLE_FAULT)
KVM Statistics/Node/kvm_exit(VMCALL)
KVM Statistics/Node/kvm_exit(VMCLEAR)
KVM Statistics/Node/kvm_exit(VMLAUNCH)
KVM Statistics/Node/kvm_exit(VMOFF)
KVM Statistics/Node/kvm_exit(VMON)
KVM Statistics/Node/kvm_exit(VMPTRLD)
KVM Statistics/Node/kvm_exit(VMPTRST)
KVM Statistics/Node/kvm_exit(VMREAD)
KVM Statistics/Node/kvm_exit(VMRESUME)
KVM Statistics/Node/kvm_exit(VMWRITE)
KVM Statistics/Node/kvm_exit(WBINVD)
KVM Statistics/Node/kvm_exit(XSETBV)
KVM Statistics/Node/kvm_fpu
KVM Statistics/Node/kvm_hv_hypercall
KVM Statistics/Node/kvm_hypercall
KVM Statistics/Node/kvm_inj_exception
KVM Statistics/Node/kvm_inj_virq
KVM Statistics/Node/kvm_invlpga
KVM Statistics/Node/kvm_ioapic_set_irq
KVM Statistics/Node/kvm_mmio
KVM Statistics/Node/kvm_msi_set_irq
KVM Statistics/Node/kvm_msr
KVM Statistics/Node/kvm_nested_intercepts
KVM Statistics/Node/kvm_nested_intr_vmexit
KVM Statistics/Node/kvm_nested_vmexit
KVM Statistics/Node/kvm_nested_vmexit_inject
KVM Statistics/Node/kvm_nested_vmrun
KVM Statistics/Node/kvm_page_fault
KVM Statistics/Node/kvm_pic_set_irq
KVM Statistics/Node/kvm_pio
KVM Statistics/Node/kvm_set_irq
KVM Statistics/Node/kvm_skinit
KVM Statistics/Node/kvm_try_async_get_page
KVM Statistics/Node/kvm_userspace_exit
Page 353 of 924
Monitor Reference
Chapter 45: KVM Monitor
Tips/Troubleshooting
This section includes:
l
"General Notes" below
l
"Maximum Number of Counters That Can be Saved" below
l
"Troubleshooting Logs" below
General Notes
l
l
l
l
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.
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.
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).
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).
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:
l
<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.
HPE SiteScope (11.33)
Page 354 of 924
Monitor Reference
Chapter 45: KVM Monitor
l
<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.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:
<SiteScope root directory>\logs\RunMonitor.log. Contains information about specific monitor runs
and actions related to managing monitors.
HPE SiteScope (11.33)
Page 355 of 924
Chapter 46: 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 Overview" below
l
"Supported Platforms/Versions" below
l
"Status" below
l
"License Consumption" on the next page
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 the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
HPE SiteScope (11.33)
Page 356 of 924
Monitor Reference
Chapter 46: LDAP Monitor
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license per monitored host
Tasks
How to Configure the LDAP Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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:
l
l
By default, LDAP version 2 is used. To use LDAP version 3, type [LDAP-3] before the
URL.
To enable LDAP over SSL, type [LDAP-SSL] before the URL.
HPE SiteScope (11.33)
Page 357 of 924
Monitor Reference
Chapter 46: LDAP Monitor
UI
Element
Security
principal
Description
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.
Security
The constant that holds the name of the environment property for specifying the credentials of
credential 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].
HPE SiteScope (11.33)
Page 358 of 924
Monitor Reference
Chapter 46: LDAP Monitor
UI
Element
LDAP
filter
Description
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.
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.
HPE SiteScope (11.33)
Page 359 of 924
Chapter 47: 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 want to check only a
portion of your site without checking the entire site, then you can limit the search by specifying the exact URL
that links to 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 need to run the link monitor only 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 export the result data from the last monitor run. To do this, you can select
the "Use Monitor Run Result Data" from the properties tab of the monitor. If this option is not selected, the tool
runs independently and displays all links and their status irrespective of the monitor configurations.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license per monitored host
Tasks
How to Configure the Link Check Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
HPE SiteScope (11.33)
Page 360 of 924
Monitor Reference
Chapter 47: Link Check Monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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.
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
External links are links that have different host in comparison to that of the original base
URL. 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 total time
(milliseconds) 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
HPE SiteScope (11.33)
Page 361 of 924
Monitor Reference
Chapter 47: Link Check Monitor
UI Element
Description
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
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.
HPE SiteScope (11.33)
Page 362 of 924
Chapter 48: 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
l
"License Consumption" 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 371.
Supported Platforms/Versions
l
l
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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 320.
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:
HPE SiteScope (11.33)
Page 363 of 924
Monitor Reference
Chapter 48: Log File Monitor
1. In the Log File Monitor Settings, configure the following settings:
l
l
l
Run alerts: Select the For each log entry matched option.
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)/.
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.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license per monitored host
Tasks
This section includes:
l
"How to Configure the Log File Monitor" on the next page
l
"How to Use the Rules File" on the next page
HPE SiteScope (11.33)
Page 364 of 924
Monitor Reference
Chapter 48: Log File Monitor
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:
Make sure you have the user permissions and credentials required for this monitor as specified in
Permissions and Credentials.
l
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).
l
The remote server should be created with credentials that grant read access on the monitored file.
l
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.
l
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
Note:
l
l
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.
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.
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:
HPE SiteScope (11.33)
Page 365 of 924
Monitor Reference
Chapter 48: Log File Monitor
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.
The third parameter is the number of SNMP preferences or "default" (default SNMP
preferences). This parameter must start with _id, and should be in the format: _
id="preference_id"
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.
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:
HPE SiteScope (11.33)
Page 366 of 924
Monitor Reference
Chapter 48: Log File Monitor
2 ERROR n SNMPTrap error^in^column^two LogMessage _id="default"
Sample rule to forward trap if any part of log entry contains ERROR:
ANY ERROR n SNMPTrap error^in^log LogMessage _id="default"
Sample rule to forward trap with default SNMP preferences(SNMPDefaultPreferences_)
ANY ERROR n SNMPTrap error^in^log LogMessage _id="default"
Sample rule to forward trap and override default SNMP preferences by
SNMPDefaultPreferences_2
ANY ERROR n SNMPTrap error^in^log LogMessage _id="2"
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 _id="default"
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:
HPE SiteScope (11.33)
Page 367 of 924
Monitor Reference
Chapter 48: Log File Monitor
# first, send trap when problem happens the first time
RULE linkCategory y SNMPTrap first^alert LogMessage linkCategory = linkError and linkErrorCount
=1
#
# 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
HPE SiteScope (11.33)
Page 368 of 924
Monitor Reference
Chapter 48: 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
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
Log File
Max Size
(MB)
Maximum size of the log file that you want to monitor.
HPE SiteScope (11.33)
Page 369 of 924
Monitor Reference
Chapter 48: Log File Monitor
UI Element Description
Log file
path
Path to the log file you want to monitor.
l
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
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 date-coded log file. For details
on using regular expressions, refer to SiteScope Date Variables and Examples for Log File
MonitoringPolicies in the Using SiteScope Guide.
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:
l
Error if matchCount > 1
l
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 363.
l
Once, after all log entries have been checked. The monitor counts up the number of
matches and then triggers alerts.
Note:
l
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.
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.
HPE SiteScope (11.33)
Page 370 of 924
Monitor Reference
Chapter 48: Log File Monitor
UI Element Description
Check
from
beginning
Content
match
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.
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 365, or read the instructions in the file itself.
HPE SiteScope (11.33)
Page 371 of 924
Monitor Reference
Chapter 48: 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
ServerProcesses log file data on the remote 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.
Use of this option is only recommended:
l
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.
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
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
No error if
file not
found
Server-side processing is enabled for remote Linux, Red Hat Enterprise Linux, and Oracle
Solaris servers only. Windows SSH is not supported.
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
HPE SiteScope (11.33)
Page 372 of 924
Monitor Reference
Chapter 48: Log File Monitor
UI Element Description
Enable
timeout
If selected, 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.
Status
after
timeout
The status condition that the monitor goes into if the monitor times out.
Default value: Not selected
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
• size
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.
HPE SiteScope (11.33)
Page 373 of 924
Monitor Reference
Chapter 48: Log File Monitor
l
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.
If you use a single quote (') in a match command to retrieve log content and match keywords when using
the Server-side processing option, you must replace the single quote with \x27 or ‘"’"’(single quote,
double quote, single quote, double quote, single quote), otherwise the single quote breaks the match
command. Other special characters used in the regular expression should be escaped (in the usual way) if
you want the characters to have their normal meaning. For more details, see Match String Literals.
HPE SiteScope (11.33)
Page 374 of 924
Chapter 49: 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license per monitored host
Tasks
How to Configure the Mail Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 375 of 924
Monitor Reference
Chapter 49: 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
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.
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. Select one of the following options:
Receiving
email server
Example: mail.thiscompany.com
l
IMAP4 to use an IMAP4 mail server for receiving mail.
l
IMAP4S to use a secure IMAP4 mail server for receiving mail.
l
POP3 to use a POP3 mail server for receiving mail.
l
POP3S to use a secure POP3 mail server for receiving mail.
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
HPE SiteScope (11.33)
Page 376 of 924
Monitor Reference
Chapter 49: 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 is not
content match 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:
l
l
l
Attachment
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.
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.
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$/
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
HPE SiteScope (11.33)
Page 377 of 924
Monitor Reference
Chapter 49: Mail Monitor
UI Element
Description
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/TLS
Enables sending emails securely via SSL/TLS SMTP servers. When selected, the
monitor sends all mails via SSL/TLS.
Note: By default, mail is sent via port 465 of the SMTP mail server unless you specify a
different port in Custom SMTP Port (see below).
Default value: Not selected
Custom
SMTP Port
Enables sending emails via a user-specified port. If this box is left empty, the default port
for sending mail is used (465 for the SMTP mail server).
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
HPE SiteScope (11.33)
Page 378 of 924
Chapter 50: 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
l
"License Consumption" 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
2007/2013, 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per monitor
One OSi license per monitored host
Tasks
This section includes:
l
"How to Prepare the System for Using the MAPI Monitor" on the next page
l
"How to Configure the MAPI Monitor" on page 381
HPE SiteScope (11.33)
Page 379 of 924
Monitor Reference
Chapter 50: MAPI Monitor
How to Prepare the System for Using the MAPI Monitor
Note: The following are definitions that are used in the steps listed below.
l
l
l
1.
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 MAPI monitor, this account must be a Local Administrator (see definition above) on the SiteScope
server.
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).
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 Exchange System administrator for help configuring an
Outlook client on your SiteScope server.
HPE SiteScope (11.33)
Page 380 of 924
Monitor Reference
Chapter 50: MAPI Monitor
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, rightclick 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 the previous page.
2. Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
HPE SiteScope (11.33)
Page 381 of 924
Monitor Reference
Chapter 50: MAPI Monitor
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.
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.
HPE SiteScope (11.33)
Page 382 of 924
Monitor Reference
Chapter 50: MAPI Monitor
UI Element
Description
Transaction Amount of time, in seconds, for the monitor to wait for the message to arrive before the
timeout
monitor should timeout. The monitor reports an error if timeout value is met before the email
(seconds)
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.
HPE SiteScope (11.33)
Page 383 of 924
Chapter 51: 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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the Memcached Statistics Monitor
Configure the monitor properties as required.
For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 384 of 924
Monitor Reference
Chapter 51: Memcached Statistics Monitor
UI Element
Description
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 any sending
(milliseconds) 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
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
l
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.
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.
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.
HPE SiteScope (11.33)
Page 385 of 924
Chapter 52: 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
l
"License Consumption" 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
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).
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
Note: If you are monitoring a Windows remote server using the NetBIOS method, only 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.
HPE SiteScope (11.33)
Page 386 of 924
Monitor Reference
Chapter 52: Memory Monitor
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.
License Consumption
Points-based Usage
One point per monitor
Note: No points are consumed by this monitor if it is running on a host covered by
the OS Instance Advanced license.
Capacity-based
Usage
One OSi license per
monitored host
Tasks
How to Configure the Memory Monitor
1. Make sure you have the user permissions and credentials on the remote server that you want to monitor
as specified in Permissions and Credentials.
2. Configure the monitor properties as required. For a description of each setting, see 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,
HPE SiteScope (11.33)
Page 387 of 924
Monitor Reference
Chapter 52: Memory 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
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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 Common
Monitor Settings in the Using SiteScope Guide.
Monitor Counters
Below is the list of counters that can be configured for this monitor:
HPE SiteScope (11.33)
Page 388 of 924
Monitor Reference
Chapter 52: Memory Monitor
• physical memory used %
• physical memory MB free*
• virtual memory used % (previously percent used)
• virtual memory MB free (previously MB free)
• Pages/sec
* By default, Physical memory MB free = Free + buffer + cache (obtained from free -b output). If you need to
change the value Physical memory MB free = Free (obtained from free -b), add the following parameter in the
master.config file:
_freeMemWithBufferAndCache=false
This is applicable for RHEL, CentOS, and Ubuntu.
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
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.
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.
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 603.
HPE SiteScope (11.33)
Page 389 of 924
Monitor Reference
Chapter 52: Memory Monitor
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 670.
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.
HPE SiteScope (11.33)
Page 390 of 924
Chapter 53: 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
l
"License Consumption" on the next page
Supported Platforms/Versions
l
l
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.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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)
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
HPE SiteScope (11.33)
Page 391 of 924
Monitor Reference
Chapter 53: Microsoft ASP Server Monitor
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.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the Microsoft ASP Server Monitor
1. Prerequisites
l
l
Make sure you have the specific access permissions required for this monitor as specified in
Permissions and Credentials.
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 required.
For a description of each setting, see the UI Descriptions section below.
HPE SiteScope (11.33)
Page 392 of 924
Monitor Reference
Chapter 53: 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
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.
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
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
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.
HPE SiteScope (11.33)
Page 393 of 924
Monitor Reference
Chapter 53: Microsoft ASP Server Monitor
UI
Element
Description
Get
Opens the Select Counters Form, enabling you to select the counters you want to monitor. For
Counters 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.
HPE SiteScope (11.33)
Page 394 of 924
Monitor Reference
Chapter 53: 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
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.
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.
HPE SiteScope (11.33)
Page 395 of 924
Chapter 54: Microsoft Exchange Monitor
This monitor enables you to monitor statistics of Microsoft Exchange Server on Windows platforms only.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to create a
monitoring solution for various aspects of Microsoft Exchange Server monitoring. For details, see
Microsoft Exchange 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 Exchange monitor.
Learn About
This section includes:
l
"Microsoft Exchange Monitor Overview" below
l
"Supported Platforms/Versions" below
l
"Setup Requirements" below
l
"License Consumption" on page 398
Microsoft Exchange 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 commandline 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 398.
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, and Microsoft
Exchange Server 2010 with PowerShell v2.0.
Setup Requirements
l
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.
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
HPE SiteScope (11.33)
Page 396 of 924
Monitor Reference
Chapter 54: Microsoft Exchange Monitor
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:
l
l
Exchange Recipient Administrator role
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 you use
WebServicesConnectivity must be delegated the Exchange Administrator role and local
Administrators group for the target server.
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
Mailbox
HPE SiteScope (11.33)
Cmdlet
l
Test-MAPIConnectivity
l
Test-ExchangeSearch
Page 397 of 924
Monitor Reference
Chapter 54: Microsoft Exchange Monitor
Server Role
Cmdlet
Hub Transport, Mailbox
Test-MailFlow
Client Access
l
Test-OWAConnectivity
l
Test-WebServicesConnectivity
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Note: This monitor is not available when using Community edition.
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 400
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.
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).
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
HPE SiteScope (11.33)
Page 398 of 924
Monitor Reference
Chapter 54: Microsoft Exchange Monitor
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.
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.
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 > Administrative Tools > Server Manager.
b. Expand the Configuration > Local Users and Groups folder in the left pane and click the Groups
folder.
c. Double-click the Administrators group icon to open the Administrators Properties window.
d. Click the Add button to add each Mailbox Owner you expect to use with the Exchange 2007/2010
monitor.
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 396.
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.
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.
HPE SiteScope (11.33)
Page 399 of 924
Monitor Reference
Chapter 54: Microsoft Exchange Monitor
How to Configure the Microsoft Exchange Monitor
1.
Prerequisites
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 398.
There are several other key requirements for using this monitor. For details on this topic, see "Setup
Requirements" on page 396.
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;en-us;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 the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
4.
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 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 you want
domain
to monitor.
HPE SiteScope (11.33)
Page 400 of 924
Monitor Reference
Chapter 54: Microsoft Exchange Monitor
UI
Element
Mailbox
Description
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
l
On Microsoft Exchange 2007: C:\Program Files\Microsoft\Exchange
file path
Server\Bin\ExShell.psc1
l
On Microsoft Exchange 2010: C:\Program Files\Microsoft\Exchange
Server\V14\Bin\ExShell.psc1
Note: For Microsoft Exchange 2010, we recommend using the RemoteExchange.ps1 file
instead of ExShell.psc1 (located in the same folder), especially if you encounter issues
receiving counter values. When using RemoteExchange.ps1, we recommend setting a
timeout value in the range of 3-5 minutes (180-300 seconds) instead of using the default
timeout value of 120 seconds.
Timeout
(seconds)
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
Counters
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:
l
Get
Counters
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:
HPE SiteScope (11.33)
Page 401 of 924
Monitor Reference
Chapter 54: Microsoft Exchange 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
• 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
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.
HPE SiteScope (11.33)
Page 402 of 924
Chapter 55: Microsoft Exchange Base Monitor
This monitor enables you to monitor statistics of Microsoft Exchange Server 2010 and 2013 on Windows
platforms only. This monitor provides monitoring for Client Access and Mailbox server roles, improved
scalability, and an extended set of performance metrics from Microsoft Exchange Server 2013.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to create a
monitoring solution for various aspects of Microsoft Exchange Server monitoring. For details, see
Microsoft Exchange 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 Exchange Base monitor.
Learn About
This section includes:
l
"Microsoft Exchange Base Monitor Overview" below
l
"Supported Platforms/Versions" on the next page
l
"Exchange Cmdlets Used by the Monitor" on the next page
l
"License Consumption" on page 413
Microsoft Exchange Base Monitor Overview
Use the Microsoft Exchange Base monitor to display important statistics about the messaging system
handled by a Microsoft Exchange 2010 or 2013 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.
The Microsoft Exchange Base monitor runs command-lets (cmdlets) to provide health information.
For Microsoft Exchange Server 2013, it can run the following cmdlets:
Cmdlets
Health Information
Get-StoreUsageStatistics
Store usage statistics data
Test-ActiveSyncConnectivity
Results of Exchange ActiveSync tests
Test-AssistantHealth
Mailbox Assistance performance data
Test-CalendarConnectivity
Results of anonymous calendar sharing tests
Test-ExchangeSearch
Results of Exchange search test
Test-ImapConnectivity
Results of IMAP4 service test
HPE SiteScope (11.33)
Page 403 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
Cmdlets
Health Information
Test-Mailflow
Results of end to end mail delivery test
Test-MAPIConnectivity
Results of mailbox databases tests
Test-MRSHealth
Results of mailbox replication service test
Test-OutlookWebServices
Results of web services functionality tests
Test-PopConnectivity
Results of POP3 service test
Test-PowerShellConnectivity
Results of PowerShell remoting test
Test-ReplicationHealth
Results of DAG members tests
Test-ServiceHealth
Results of required services are running test
Test-WebServicesConnectivity
Results of web services functionality tests
For Microsoft Exchange Server 2010, it can run the following cmdlets:
Cmdlets
Health Information
Test-ExchangeSearch
Results of Exchange search test
Test-Mailflow
Results of end to end mail delivery test
Test-MAPIConnectivity
Results of mailbox databases tests
Test-OWAConnectivity
Results of Microsoft Office Outlook Web Access test
Test-WebServicesConnectivity
Results of web services functionality tests
Create a separate Microsoft Exchange Base monitor instance for each Microsoft Exchange server in your
environment. The Microsoft Exchange Base monitor is supported on Windows versions of SiteScope only.
Supported Platforms/Versions
Microsoft Exchange Server 2010 and 2013 on Windows platforms only.
Note: PowerShell v2.0 must be used on the SiteScope-side.
Exchange Cmdlets Used by the Monitor
The following table includes a list of cmdlets that the monitor uses to gather information from the Exchange
Server. To see what permissions you need in the Microsoft Exchange Server, refer to Important: Update for
Permissions in Exchange 2010 (for Microsoft Exchange Server 2010), or http://technet.microsoft.com/enus/library/dd638127(v=exchg.150).aspx (for Microsoft Exchange Server 2013).
HPE SiteScope (11.33)
Page 404 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
Test-AssigmentHealth
Verifies that the Microsoft Exchange Mailbox Assistants service
(MSExchangeMailboxAssistants) is healthy, to recover from health issues,
and to report the status of the diagnosis or recovery action.
The Mailbox Assistants service runs on all servers that have the Mailbox
server role installed. This service is responsible for scheduling and
dispatching several assistants that ensure mailboxes function correctly.
By default, when you run this cmdlet, it returns the RunspaceId, events, and
performance counters in a table format.
For details, see http://technet.microsoft.com/en-gb/library/ff829911
(v=exchg.150).aspx.
This monitor collects Performance Counters only.
Get-StoreUsageStatistics
Aids in diagnosing performance issues with your servers or databases.
The Microsoft Exchange Information Store service collects per-user
information on latency, input/output (I/O), page counts, processor usage, and
TimeInServer. The TimeInServer metric represents the total time that
synchronous and asynchronous requests spend in the Microsoft Exchange
Information Store service for a user's mailbox. You can retrieve this resource
information in the Microsoft Exchange Information Store service for the 25
highest usage accounts on a specified database. Usage of a mailbox is
defined as the amount of server time spent in performing operations for that
mailbox. The cmdlet reports the top 25 users for every one-minute period for
the last 10 minutes (250 objects per ten-minute interval). The resource usage
is an indicator of the load that different users are placing on the server.
For details, see http://technet.microsoft.com/en-gb/library/dd876852
(v=exchg.150).aspx.
This monitor gets the arithmetic average of values for selected counters.
HPE SiteScope (11.33)
Page 405 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
TestCalendarConnectivity
Verifies that anonymous calendar sharing is enabled and working properly.
The Calendar virtual directory is a subdirectory of the Microsoft Office
Outlook Web App virtual directory. When you run this command without any
parameters, the command tests against all Outlook Web App calendar virtual
directories.
To test virtual directories on a Client Access server, there must be a test
Active Directory account. There must also be a test mailbox in each Active
Directory site that hosts mailboxes that can be accessed through the virtual
directories being tested. You can create the test account by running the NewTestCasConnectivityUser.ps1 script. The default location for this file is:
\\Program Files\Microsoft\Exchange Server\V15\Scripts.
If the test environment wasn't created during the Mailbox server setup, you're
prompted to run the script that creates the test mailboxes and test users
when you run this command.
If the server hosting the test mailbox isn't available, the command returns an
error that might not clearly identify the problem. To avoid this, use the TestMapiConnectivity cmdlet to verify that the server that hosts the test mailbox
is running and that the mailbox is available before you run this command.
For details, see http://technet.microsoft.com/en-gb/library/ff607308
(v=exchg.150).aspx.
The TestType parameter specifies whether the command tests internal or
external URLs. Values are Internal and External. If you don't specify this
parameter, the default is TestType:Internal.
This monitor uses Internal TestType.
Test-ExchangeSearch
Tests that Exchange Search is currently enabled and is indexing new email
messages in a timely manner.
This cmdlet creates a hidden message and an attachment visible only to
Exchange Search. Unless a mailbox is specified in the Identity parameter,
the hidden message is stored in the System Attendant mailbox. The
command waits for the message to be indexed and then searches for the
content. It reports success or failure depending on whether the message is
found after the interval set in the IndexingTimeoutInSeconds parameter has
elapsed.
You can use the Verbose switch to get detailed information about each step
performed by the cmdlet as part of the test.
For details, see http://technet.microsoft.com/en-us/library/bb124733
(v=exchg.150).aspx.
The “Latency” counter is converted to seconds.
HPE SiteScope (11.33)
Page 406 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
Test-ImapConnectivity
Verifies that the IMAP4 service is running as expected. This cmdlet can be
used to test the IMAP4 functionality for a specified Client Access server for
all mailboxes on servers running Microsoft Exchange Server 2013 in the
same Active Directory site.
For details, see http://technet.microsoft.com/en-gb/library/bb738126
(v=exchg.150).aspx.
The following parameters are used in the exchange command:
1. LightMode parameter. This instructs the command to perform a test
logon only to the server using the IMAP4 protocol. If you do not use this
parameter, the test also checks the sending and receiving of a message
using the IMAP4 protocol.
2. PortClientAccessServer parameter. This specifies the port to use to
connect to the Client Access server. The default port is 143 for Plain
Text/TLS or 993 for SSL. The valid range is from 0 through 65,535.
You can change the port in the IMAP4 service port field in the monitor
settings.
The “Latency” counter is converted to seconds.
Test-PopConnectivity
Use the Test-PopConnectivity cmdlet to verify that the POP3 service is
running as expected. The Test-PopConnectivity cmdlet can be used to test
the POP3 functionality for a specified Client Access server for all mailboxes
on servers running Microsoft Exchange Server 2013 in the same Active
Directory site.
For details, see http://technet.microsoft.com/en-gb/library/bb738143
(v=exchg.150).aspx.
The following parameters are used in the exchange command:
1. LightMode parameter. This instructs the command to perform a test
logon only to the server using the POP3 protocol. If you do not use this
parameter, the test also checks the sending and receiving of a message
using the POP3 protocol.
2. PortClientAccessServer parameter. This specifies the port to use to
connect to the Client Access server. The default port is 110 for Plain
Text/TLS or 995 for SSL. The valid range is from 0 through 65,535.
You can change the port in the POP3 service port field in the monitor
settings.
The “Latency” counter is converted to seconds.
HPE SiteScope (11.33)
Page 407 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
TestPowerShellConnectivity
Tests whether Windows PowerShell remoting on the target Client Access
server is functioning correctly.
The Test-PowerShellConnectivity cmdlet connects to a Client Access
server to test whether Windows PowerShell remoting on that server is
working correctly and whether the Client Access server can perform
commands against a remote Mailbox server.
When you run this cmdlet, you must specify either the fully qualified domain
name (FQDN) of the Client Access server to connect to by using the
ClientAccessServer parameter, or the Uniform Resource Identifier (URI) of a
Client Access server by using the ConnectionUri parameter. You can't use
both the ClientAccessServer and ConnectionUri parameters in the same
command.
The first time you use the Test-PowerShellConnectivity cmdlet with the
ClientAccessServer parameter, you might be required to create a test user.
To create a test user, use the New-TestCasConnectivityUser.ps1 script.
For details, see http://technet.microsoft.com/en-gb/library/dd335166
(v=exchg.150).aspx.
This monitor uses the VirtualDirectoryName parameter in the exchange
command . This parameter specifies the virtual directory on the Client
Access server to test. The VirtualDirectoryName parameter can only be
used with the ClientAccessServer parameter. If the VirtualDirectoryName
parameter is not specified, all virtual directories on the Client Access server
are tested.
This monitor uses the “PowerShell (Default Web Site)” value by default. You
can change this in the PowerShell virtual directory name field in the
monitor settings.
The “Latency” counter is converted to seconds.
Test-MRSHealth
Tests the health of an instance of the Microsoft Exchange Mailbox
Replication service.
The Microsoft Exchange Mailbox Replication service runs on Client Access
servers. This command ensures that the Mailbox Replication service is
running and that it responds to a remote procedure call (RPC) ping check.
For details, see http://technet.microsoft.com/en-us/library/ee332325
(v=exchg.150).aspx.
This monitor uses “Passed” counters for different checks.
HPE SiteScope (11.33)
Page 408 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
Test-ReplicationHealth
Checks all aspects of replication and replay, and provides status for a
specific Mailbox server in a database availability group (DAG).
This cmdlet is designed for the proactive monitoring of continuous replication
and the continuous replication pipeline, the availability of Active Manager,
and the health and status of the underlying cluster service, quorum, and
network components. The Test-ReplicationHealth cmdlet can be run locally
or remotely against any Mailbox server in a DAG.
For details, see http://technet.microsoft.com/en-gb/library/bb691314
(v=exchg.150).aspx.
This monitor uses “Result” counters for different checks. Counters can have
the following values: “Passed”, “*FAILED*”.
Test-ServiceHealth
Tests whether all the Microsoft Windows services that Exchange requires on
a server have started. The cmdlet returns an error for any service required by
a configured role when the service is set to start automatically and isn't
currently running.
For details, see http://technet.microsoft.com/en-gb/library/aa998852
(v=exchg.150).aspx.
This monitor combines all “ServicesNotRunning” list values in a common list,
as follows: {serviceName1, serviceName2, serviceName3}. An empty list is
displayed as: {}
TestPerforms basic operations to verify the functionality of Exchange Web
WebServicesConnectivity Services on a server running Microsoft Exchange Server 2013.
The cmdlet tests the functionality of Exchange Web Services, and performs
basic operations to verify the functionality of Outlook Anywhere. The results
of each test are returned by the Exchange Management Shell.
For details, see http://technet.microsoft.com/en-us/library/aa998328
(v=exchg.150).aspx.
The “Latency” counter is converted to seconds.
HPE SiteScope (11.33)
Page 409 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
Test-MAPIConnectivity
Verifies server functionality by logging on to the mailbox that you specify (or
to the SystemMailbox if you don't specify the Identity parameter) and
retrieving a list of items in the Inbox. Logging on to the mailbox tests two
critical protocols used when a client connects to a Mailbox server: MAPI and
LDAP. During authentication, the cmdlet indirectly verifies that the MAPI
server, Exchange store, and Directory Service Access (DSAccess) are
working.
The cmdlet logs on to the mailbox that you specify using the credentials of
the account with which you are logged on to the local computer. After a
successful authentication, the cmdlet accesses the mailbox to verify that the
database is working. If a successful connection to a mailbox is made, the
cmdlet also determines the time that the logon attempt occurred.
There are three distinct parameters that you can use with the command:
l
l
l
Database. The Database parameter takes a database identity and tests
the ability to log on to the system mailbox on the specified database.
Identity. The Identity parameter takes a mailbox identity and tests the
ability to log on to a specific mailbox.
Server. The Server parameter takes a server identity and tests the ability
to log on to each system mailbox on the specified server.
For details, see http://technet.microsoft.com/en-us/library/bb123681
(v=exchg.150).aspx.
The “Latency” counter is an arithmetic average of “Latency” database
counters, converted to seconds.
The “Result” counter is a composite value, that might contain the following
values: “Success”, “Failure”, or “Failure for Databases: database1,
database2,…”
HPE SiteScope (11.33)
Page 410 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
Test-Mailflow
Diagnoses whether mail can be successfully sent from and delivered to the
system mailbox on a Mailbox server. It also verifies that email is sent
between Mailbox servers within a defined latency threshold.
This cmdlet tests mail submission, transport, and delivery. The cmdlet
verifies that each Mailbox server can successfully send itself a message.
You can also use this cmdlet to verify that the system mailbox on one
Mailbox server can successfully send a message to the system mailbox on
another Mailbox server.
If more than one of these parameters is specified, the
AutoDiscoverTargetMailboxServer parameter takes precedence over the
TargetEmailAddress and TargetMailboxServer parameters. The
TargetMailboxServer parameter takes precedence over the
TargetEmailAddress parameter. A system mailbox must be present on all
servers involved in the test.
For details, see http://technet.microsoft.com/en-us/library/aa995894
(v=exchg.150).aspx.
The “MessageLatencyTime” counter is converted to seconds.
TestActiveSyncConnectivity
Performs a full synchronization against a specified mailbox to test the
configuration of Microsoft Exchange ActiveSync.
For details, see http://technet.microsoft.com/en-us/library/bb123540
(v=exchg.150).aspx.
The “Latency” counters are converted to seconds.
TestOutlookWebServices
Verifies the Autodiscover service settings for Microsoft Outlook on a
computer running Microsoft Exchange Server 2010 that has the Client
Access server role installed.
The cmdlet uses a specified email address to verify that the Outlook provider
is configured correctly.
For details, see http://technet.microsoft.com/en-us/library/bb124509
(v=exchg.141).aspx.
The “Latency” counters are converted to seconds.
HPE SiteScope (11.33)
Page 411 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
Test-OWAConnectivity
Verifies that Microsoft Office Outlook Web App is running as expected. The
Test-OwaConnectivity cmdlet can be used to test Outlook Web App
connectivity for all Microsoft Exchange Server 2010 virtual directories on a
specified Client Access server for all mailboxes on servers running
Exchange that are in the same Active Directory site. The TestOwaConnectivity cmdlet can also be used to test the connectivity for an
individual Exchange Outlook Web App URL.
(for Microsoft Exchange
Server 2010 only)
To test all Exchange Outlook Web App virtual directories on a Client Access
server, there must be a test Active Directory account. There must also be a
test mailbox in each Active Directory site that hosts mailboxes that can be
accessed through the virtual directories being tested. If the test environment
wasn't created during the Mailbox server setup, you are prompted to run the
script that creates the test mailboxes and test users when you run the TestOwaConnectivity cmdlet.
If the server that is hosting the test mailbox is not available, the TestOWAConnectivity cmdlet will return an error that might not clearly identify
the problem. To avoid this, check that the server that hosts the test mailbox
is running and that the mailbox is available before you run the TestOWAConnectivity cmdlet.
If the server hosting the test mailbox isn't available, the TestOwaConnectivity cmdlet returns an error that might not clearly identify the
problem. To avoid this, check that the server that hosts the test mailbox is
running and that the mailbox is available before you run the TestOwaConnectivity cmdlet. You can use the Test-MapiConnectivity cmdlet to
do this.
If you run the Test-OwaConnectivity cmdlet on a Client Access server
without using either the ClientAccessServer parameter or the URL
parameter, the cmdlet tests the server on which you run the cmdlet. To test a
specific Client Access server, use the ClientAccessServer parameter.
To test a single URL, run the Test-OwaConnectivity cmdlet with the URL
parameter and credentials for an existing Exchange mailbox. If the URL is
behind a load balancer, you can't predict which Client Access server the
command will test. Because credentials are required as part of the
parameters when you use the URL parameter, you can use any account to
run the Test-OwaConnectivity cmdlet when you use the URL parameter.
If the command encounters a virtual directory that doesn't require Secure
Sockets Layer (SSL), the command skips that directory unless the
AllowUnsecureAccess parameter is used. If the AllowUnsecureAccess
parameter is used, communications between servers are sent in clear text for
purposes of the test.
The Test-OwaConnectivity cmdlet can be run as a one-time interactive task
or as a scheduled task under Microsoft System Center Operations Manager
2007 control. To run the Test-OwaConnectivity cmdlet as a System Center
Operations Manager 2007 task, the Client Access test mailbox must be
HPE SiteScope (11.33)
Page 412 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
cmdlets
Description
available on the Mailbox servers that the cmdlet tests against.
For details, see http://technet.microsoft.com/enus/library/aa997682%28v=exchg.141%29.aspx.
License Consumption
Points-base Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Note: This monitor is not available when using Community Edition.
Tasks
This section includes:
l
"How to Prepare the System for Using the Microsoft Exchange Base Monitor" below
l
"How to Configure the Microsoft Exchange Base Monitor" on the next page
How to Prepare the System for Using the Microsoft Exchange Base Monitor
There are several important configuration requirements that must be performed or verified before the Microsoft
Exchange Base 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.
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).
1.
Create mailbox accounts on each Exchange Server to be monitored with the
Microsoft Exchange Base monitor
Exchange mailbox accounts are used by Microsoft Exchange Base monitor to measure the performance
counters on the Exchange server. Consult your Exchange system administrator if you need help setting
HPE SiteScope (11.33)
Page 413 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
up mailbox accounts for use with the SiteScope Microsoft Exchange monitor.
You must configure a test mailbox in the Microsoft Exchange Server to retrieve health information for the
Outlook Web Access, Web Services, Calendar, and PowerShell 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.
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 > Administrative Tools > Server Manager.
b. Expand the Configuration > Local Users and Groups folder in the left pane, and click the Groups
folder.
c. Double-click the Administrators group icon to open the Administrators Properties window.
d. Click the Add button to add each Mailbox Owner you expect to use with the Exchange monitor.
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
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.
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.
How to Configure the Microsoft Exchange Base Monitor
1.
Prerequisites
l
Make sure you prepared the system for using the Microsoft Exchange monitor as described in "How
to Prepare the System for Using the Microsoft Exchange Base Monitor" on the previous page.
HPE SiteScope (11.33)
Page 414 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
l
l
Exchange Management Shell must be installed on the SiteScope server. Windows PowerShell 2.0
must be installed on the computer that runs the Exchange Management Shell.
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 2010 or 2013, 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.
For Microsoft Exchange Server 2013:
Server Role
Mailbox
Mailbox, Client Access
Client Access
Cmdlet
o
Get-StoreUsageStatistics
o
Test-AssistantHealth
o
Test-ExchangeSearch
o
Test-MailFlow
o
Test-MapiConnectivity
o
Test-ReplicationHealth
Test-ServiceHealth
o
Test-MRSHealth
o
Test-CalendarConnectivity
o
Test-WebServicesConnectivity
o
Test-ImapConnectivity
o
Test-PopConnectivity
o
Test-PowerShellConnectivity
o
Test-ActiveSyncConnectivity
o
Test-OutlookWebServices
For Microsoft Exchange Server 2010:
Server Role
Mailbox
Hub Transport, Mailbox
Client Access
2.
Cmdlet
o
Test-MAPIConnectivity
o
Test-ExchangeSearch
Test-MailFlow
o
Test-OWAConnectivity
o
Test-WebServicesConnectivity
Configure the monitor properties
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
3.
Schedule the monitor - optional
HPE SiteScope (11.33)
Page 415 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
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 15 minutes.
UI Descriptions
Microsoft Exchange Base Server Monitor Settings
User interface elements are described below:
UI Element
Description
Exchange
server
Name of the server running Microsoft Exchange Server that you want to monitor.
Exchange
domain
Domain name and the mailbox of the server running Microsoft Exchange Server that 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.
Remote
Exchange
script file
path
Full path to the Microsoft Exchange Server Management Shell script file.
Timeout
(seconds)
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 15 minutes.
Example: C:\Program Files\Microsoft\Exchange Server\V15\Bin\RemoteExchange.ps1
Default value: 600 seconds
PowerShell Name of the PowerShell virtual directory that is used by Test-PowerShellConnectivity
virtual
cmdlet.
directory
Default value: Power Shell (Default Web Site)
name
POP3
service
port
POP3 service port is used by the Test-POPConnectivity cmdlet.
IMAP4
service
port
IMAP4 service port is used by the Test-ImapConnectivity cmdlet.
Default value: 995 SSL or 110 for plain text /TLS.
Default value: 993 for SSL or 143 for plain text /TLS.
HPE SiteScope (11.33)
Page 416 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
UI Element
Description
Counters
Displays the server performance counters selected for this monitor. Use the Get Counters
button to select counters.
Counters are displayed in the counters tree if the role (required for the corresponding cmdlet)
is installed on the monitored server. For role details, see “Prerequisites” in "How to Configure
the Microsoft Exchange Base Monitor" on page 414.
Counter values are calculated from the output of the corresponding cmdlet. Cmdlet output
processing can be as follows:
Get
Counters
l
Normalization of found value (for example, move to another units)
l
Summation of the found values with same name.
l
Average value from found values with the same name.
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:
HPE SiteScope (11.33)
Page 417 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
For Microsoft Exchange Server 2013 only:
Test-AssistantHealth
Assistant Performance Counters\EventsInDatabaseQueues
Assistant Performance Counters\CrashDumpCount
Get-StoreUsageStatistics
Store Usage Statistics\TimeInCPU
Store Usage Statistics\TimeInServer
Test-CalendarConnectivity
Calendar Connectivity\Logon\Result
Calendar Connectivity\Logon\Latency
Calendar Connectivity\CalendarHTML\Result
Calendar Connectivity\CalendarHTML\Latency
Calendar Connectivity\CalendarICS\Result
Calendar Connectivity\CalendarICS\Latency
Test-ImapConnectivity
IMAP4 Connectivity\Result
IMAP4 Connectivity\Latency
Test-PopConnectivity
POP3 Connectivity\Result
POP3 Connectivity\Latency
Test-PowerShellConnectivity
PowerShell Connectivity\Result
PowerShell Connectivity\Latency
Test-MRSHealth
Test MRS Health\ServiceCheckPassed
Test MRS Health\RPCPingCheckPassed
Test MRS Health\QueueScanCheckPassed
Test-ReplicationHealth
Replication Health\ClusterServiceCheckResult
Replication Health\ReplayServiceCheckResult
Replication Health\ActiveManagerCheckResult
Replication Health\TasksRpcListenerCheckResult
Replication Health\TcpListenerCheckResult
Replication Health\ServerLocatorServiceCheckResult
Replication Health\DagMembersUpCheckResult
Replication Health\ClusterNetworkCheckResult
Replication Health\QuorumGroupCheckResult
Replication Health\DatabaseRedundancyCheckResult
Replication Health\DatabaseAvailabilityCheckResult
Replication Health\DBCopySuspendedCheckResult
Replication Health\DBCopyFailedCheckResult
Replication Health\DBInitializingCheckResult
Replication Health\DBDisconnectedCheckResult
Replication Health\DBLogCopyKeepingUpCheckResult
Replication Health\DBLogReplayKeepingUpCheckResult
Test-ServiceHealth
Service Health\ServicesNotRunning
Test-WebServicesConnectivity
Web Services Connectivity\EwsGetFolder\Result
Web Services Connectivity\EwsGetFolder\Latency
Web Services Connectivity\AutoDiscoverSoapProvider\Result
HPE SiteScope (11.33)
Page 418 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base Monitor
Web Services Connectivity\AutoDiscoverSoapProvider\Latency
Test-ActiveSyncConnectivity
Active Sync Connectivity\Options\Result
Active Sync Connectivity\Options\Latency
Active Sync Connectivity\FolderSync\Result
Active Sync Connectivity\FolderSync\Latency
Active Sync Connectivity\First Sync\Result
Active Sync Connectivity\First Sync\Latency
Active Sync Connectivity\GetItemEstimate\Result
Active Sync Connectivity\GetItemEstimate\Latency
Active Sync Connectivity\Sync Data\Result
Active Sync Connectivity\Sync Data\Latency
Active Sync Connectivity\Ping\Result
Active Sync Connectivity\Ping\Latency
Active Sync Connectivity\Sync Test Item\Result
Active Sync Connectivity\Sync Test Item\Latency
Test-OutlookWebServices
Outlook Web Services\AutoDiscoverOutlookProvider\Result
Outlook Web Services\AutoDiscoverOutlookProvider\Latency
Outlook Web Services\ExchangeWebServices\Result
Outlook Web Services\ExchangeWebServices\Latency
Outlook Web Services\AvailabilityService\Result
Outlook Web Services\AvailabilityService\Latency
Outlook Web Services\OfflineAddressBook\Result
Outlook Web Services\OfflineAddressBook\Latency
For Microsoft Exchange Server 2010 and 2013:
Test-ExchangeSearch
Exchange Search\ResultFound
Exchange Search\SearchTimeInSeconds
Test-Mailflow
Mail Flow\TestMailflowResult
Mail Flow\MessageLatencyTime
Test-MAPIConnectivity
MAPI Connectivity\Result
MAPI Connectivity\Latency
For Microsoft Exchange Server 2010 only:
Test-WebServicesConnectivity
Web Services Connectivity\GetFolder\Result
Web Services Connectivity\GetFolder\Latency
Web Services Connectivity\SyncFolderItems\Result
Web Services Connectivity\SyncFolderItems\Latency
Web Services Connectivity\CreateItem\Result
Web Services Connectivity\CreateItem\Latency
Web Services Connectivity\DeleteItem\Result
Web Services Connectivity\DeleteItem\Latency
Test-OWAConnectivity
OWA Connectivity\Result
OWA Connectivity\Latency
Test-OWAConnectivity
OWA Connectivity\Result
OWA Connectivity\Latency
HPE SiteScope (11.33)
Page 419 of 924
Monitor Reference
Chapter 55: Microsoft Exchange Base 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 2013 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.
Microsoft Exchange Base Monitor might not work on 64-bit version of Windows
Server 2008
In some cases, the Microsoft Exchange Base Monitor might not work on a 64-bit version of Windows Server
2008. This can occur when a 32-bit application is unable to access the system32 folder on a computer running
a 64-bit version of Windows Server 2008.
Workaround: In Preferences > Infrastructure Preferences > General Settings, make sure you entered the
correct PowerShell execute command in the Power Shell execute command box. For example:
C:\Windows\Sysnative\WindowsPowerShell\v1.0\powershell.exe
HPE SiteScope (11.33)
Page 420 of 924
Chapter 56: Microsoft Exchange
2000/2003/2007 Message Traffic Monitor
Note: The Microsoft Exchange 2000 and 2003 Message Traffic monitors were deprecated, and the
Microsoft Exchange 2000 and 2003 solution templates are no longer available. If these monitors were
configured in a previous version of SiteScope, they will still work after performing a SiteScope upgrade
(but we do not recommend using them). We recommend migrating to the Microsoft Exchange 2007
monitor.
Use the Microsoft Exchange Message Traffic monitor to display important statistics about messages handled
by a Microsoft Exchange 2007 server, such as a count of messages sent that are larger than a certain size, or
sent to a large number of recipients.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to create a
monitoring solution for various aspects of Microsoft Exchange Server monitoring. For details, see
Microsoft Exchange Solution Templates in the Using SiteScope Guide.
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.
License Consumption
Points-based Usage
Capacity-based Usage
Five points per monitor One OSi license per monitored host
Note: This monitor is not available when using Community edition.
Tasks
How to Configure the Microsoft Exchange Message Traffic Monitor
1. Prerequisites
l
This monitor requires the Microsoft Exchange solution templates to enable it in the SiteScope
interface.
HPE SiteScope (11.33)
Page 421 of 924
Monitor Reference
Chapter 56: Microsoft Exchange 2000/2003/2007 Message Traffic Monitor
l
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
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 required.
For a description of each setting, see the UI Descriptions section below.
UI Descriptions
Microsoft Exchange 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
HPE SiteScope (11.33)
Page 422 of 924
Monitor Reference
Chapter 56: Microsoft Exchange 2000/2003/2007 Message Traffic Monitor
UI Element
Description
Log
directory
UNC path of the messaging tracking log file directory.
Reporting
directory
Default value: \\<server name>\MessageTracking
l
For 2000/2003 versions: \\<server name>\<server name>.log
l
For 2007 version: \\<server name>\MessageTracking
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.
HPE SiteScope (11.33)
Page 423 of 924
Chapter 57: Microsoft Exchange 5.5 Message
Traffic Monitor (Deprecated)
Note: The Microsoft Exchange 5.5 Message Traffic monitor was deprecated, and the Microsoft
Exchange 5.5 solution template is no longer available. If this monitor was configured in a previous version
of SiteScope, it will still work after performing a SiteScope upgrade (but we do not recommend using it).
We recommend migrating to the Microsoft Exchange 2007 Message Traffic monitor or later.
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
l
This monitor is not available when using Community edition.
To use the monitor, you must have an Operating System Instance (OSi) license with sufficient
available capacity. For license purchase inquiries (or if you require additional capacity), contact your
HPE sales representative or use the “Contact Us” link in the HPE SiteScope Product page.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to create a
monitoring solution for various aspects of Microsoft Exchange Server monitoring. For details, see
Microsoft Exchange Solution Templates in the Using SiteScope Guide.
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
l
l
This monitor requires the Microsoft Exchange solution templates to enable it in the SiteScope
interface.
The Microsoft Exchange 5.5 Message Traffic monitor requires additional licensing to enable the
monitor type in the SiteScope interface. For license purchase inquiries (or if you require additional
capacity), contact your HPE sales representative or use the “Contact Us” link in the HPE SiteScope
Product page.
2. Deploy the Microsoft Exchange Solution template
HPE SiteScope (11.33)
Page 424 of 924
Monitor Reference
Chapter 57: Microsoft Exchange 5.5 Message Traffic Monitor (Deprecated)
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
After the monitor has been created, you can edit the monitor configuration in the same way as other
monitors.
Configure the monitor properties as required.
For a description of each setting, see 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.
HPE SiteScope (11.33)
Page 425 of 924
Chapter 58: Microsoft Exchange 2003 Mailbox
Monitor (Deprecated)
Note: The Microsoft Exchange 2003 Mailbox monitor was deprecated, and the Microsoft Exchange 2003
solution template is no longer available. If this monitor was configured in a previous version of SiteScope,
it is still displayed in SiteScope after performing an upgrade (but will not work). We recommend migrating
to a Microsoft Exchange 2007 or later 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: This monitor is not available when using Community edition.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to create a
monitoring solution for various aspects of Microsoft Exchange Server monitoring. For details, see
Microsoft Exchange Solution Templates in the Using SiteScope Guide.
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
This monitor is supported in SiteScopes that are running on Windows versions only.
Tasks
How to Configure the Microsoft Exchange 2003 Mailbox Monitor
1. Prerequisites
l
l
This monitor requires the Microsoft Exchange solution templates to enable it in the SiteScope
interface.
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
HPE SiteScope (11.33)
Page 426 of 924
Monitor Reference
Chapter 58: Microsoft Exchange 2003 Mailbox Monitor (Deprecated)
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 required.
For a description of each setting, see 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 timingout. 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
Note: For information on configuring setting panels that are common to all monitors, see Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 427 of 924
Monitor Reference
Chapter 58: Microsoft Exchange 2003 Mailbox Monitor (Deprecated)
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/en-us/library/aa389286.aspx).
HPE SiteScope (11.33)
Page 428 of 924
Chapter 59: Microsoft Exchange 2003 Public
Folder Monitor (Deprecated)
Note: The Microsoft Exchange 2003 Public Folder monitor was deprecated, and the Microsoft Exchange
2003 solution template is no longer available. If this monitor was configured in a previous version of
SiteScope, it is still displayed in SiteScope after performing an upgrade (but will not work). We
recommend migrating to a Microsoft Exchange 2007 or later 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: This monitor is not available when using Community edition.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to create a
monitoring solution for various aspects of Microsoft Exchange Server monitoring. For details, see
Microsoft Exchange Solution Templates in the Using SiteScope Guide.
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
This monitor is supported in SiteScopes that are running on Windows versions only.
Tasks
How to Configure the Microsoft Exchange 2003 Public Folder Monitor
1. Prerequisites
l
l
This monitor requires the Microsoft Exchange solution templates to enable it in the SiteScope
interface.
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
HPE SiteScope (11.33)
Page 429 of 924
Monitor Reference
Chapter 59: Microsoft Exchange 2003 Public Folder Monitor (Deprecated)
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 required.
For a description of each setting, see 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 timingout. 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.
Note: For information on configuring setting panels that are common to all monitors, see Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 430 of 924
Chapter 60: 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" below
l
"License Consumption" 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 hypervisor-based 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
l
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.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1. All these supported operating
systems should be with 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:
HPE SiteScope (11.33)
Page 431 of 924
Monitor Reference
Chapter 60: Microsoft Hyper-V Monitor
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.
License Consumption
Points-based Usage
One point per metric
Note: No points are consumed by this monitor if it is running on a host covered by
the OS Instance Advanced license.
Capacity-based
Usage
One OSi license per
monitored host
Tasks
How to Configure the Microsoft Hyper-V Monitor
Configure the monitor properties as required.
For a description of each setting, see the UI Descriptions section below.
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
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.
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)
HPE SiteScope (11.33)
Page 432 of 924
Monitor Reference
Chapter 60: Microsoft Hyper-V Monitor
UI
Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the server to be
monitored:
l
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
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 monitor. For
Counters 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.
HPE SiteScope (11.33)
Page 433 of 924
Monitor Reference
Chapter 60: 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
HPE SiteScope (11.33)
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 434 of 924
Monitor Reference
Chapter 60: 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
• Pending Interrupts Cost
• Pending Interrupts/sec
HPE SiteScope (11.33)
• 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
• Destroy Virtual Machine Tasks Recent
Time
• Destroy Virtual Machine Tasks in
Progress
• 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 Recent Time
• Reset Virtual Machine Tasks in Progress
Page 435 of 924
Monitor Reference
Chapter 60: 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
Hyper-V Virtual Machine Bus
• Interrupts Received
• Interrupts Sent
• Throttle Events
Hyper-V Virtual Machine Health
Summary
• Health Critical
• Health Ok
Hyper-V Virtual Machine Summary
• Applying Snapshot
• Deleting
• Deleting Saved State
• Deleting Snapshot
• Exporting
• Save Virtual Machine Tasks Recent
• Merging Disks
Time
• Save Virtual Machine Tasks in Progress • Paused
• Pausing
• Resetting
• Shutdown Virtual Machine Tasks
• Resuming
Completed
• Running
• Shutdown Virtual Machine Tasks
• Saved
Recent Time
• Saving
• Shutdown Virtual Machine Tasks in
• Starting
Progress
• Stopping
• Snapshot Virtual Machine Tasks
• Taking Snapshot
Completed
• Turned Off
• Snapshot Virtual Machine Tasks
• Waiting to Start
Recent Time
• Snapshot Virtual Machine Tasks in
Hyper-V Virtual Network Adapter
Progress
• Broadcast Packets Received/sec
• Start Virtual Machine Tasks Completed • Broadcast Packets Sent/sec
• Start Virtual Machine Tasks Recent
• Bytes Received/sec
Time
• Bytes Sent/sec
• Start Virtual Machine Tasks in Progress • Bytes/sec
• Waiting to Start Virtual Machine Tasks
Completed
• Waiting to Start Virtual Machine Tasks
Recent Time
• Waiting to Start Virtual Machine Tasks
in Progress
• Directed Packets Received/sec
• Directed Packets Sent/sec
• Multicast Packets Received/sec
• Multicast Packets Sent/sec
• Packets Received/sec
• Packets Sent/sec
• Packets/sec
Hyper-V VM Vid Numa Node
• PageCount
• ProcessorCount
Hyper-V VM Vid Partition
• Physical Pages Allocated
• Preferred NUMA Node Index
• Remote Physical Pages
Hyper-V Virtual Storage Device
• Error Count
• Flush Count
• Read Bytes/sec
• Read Count
• Write Bytes/sec
• Write Count
Hyper-V Virtual IDE Controller
• Read Bytes/sec
• Read Sectors/sec
• Write Bytes/sec
• Written Sectors/sec
HPE SiteScope (11.33)
Hyper-V Virtual Switch
• Broadcast Packets Received/sec
• Broadcast Packets Sent/sec
• Bytes Received/sec
• Bytes Sent/sec
• Bytes/sec
• Directed Packets Received/sec
• Directed Packets Sent/sec
• Learned Mac Addresses
• Learned Mac Addresses/sec
• Multicast Packets Received/sec
• Multicast Packets Sent/sec
• Packets Flooded
• Packets Flooded/sec
• Packets Received/sec
• Packets Sent/sec
• Packets/sec
• Purged Mac Addresses
• Purged Mac Addresses/sec
Hyper-V Virtual Switch Port
• Broadcast Packets Received/sec
• Broadcast Packets Sent/sec
• Bytes Received/sec
• Bytes Sent/sec
• Bytes/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
• Broadcast Packets Received/sec
• Broadcast Packets Sent/sec
• Bytes Received/sec
• Bytes Sent/sec
• Bytes/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
• Broadcast Packets Received/sec
• Broadcast Packets Sent/sec
• Bytes Received/sec
• Bytes Sent/sec
• Bytes/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
Page 436 of 924
Monitor Reference
Chapter 60: Microsoft Hyper-V Monitor
Tips/Troubleshooting
General Notes/Limitations
l
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.
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.
HPE SiteScope (11.33)
Page 437 of 924
Chapter 61: 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
l
"License Consumption" on page 440
Supported Platforms/Versions
l
l
l
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.
The Microsoft IIS Server monitor supports monitoring the following:
l
HTTP/HTTPS services on IIS 4.0, 5.0, 7.0, 7.5, 8.0, 8.5.
l
HTTP/HTTPS, FTP, NNTP and MSMQ Queue on IIS 6, 7.0, 8.0, 8.5.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012, 2012 R2 Update 1.
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.
HPE SiteScope (11.33)
Page 438 of 924
Monitor Reference
Chapter 61: 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)
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.
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 APM's RTSM.
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 439 of 924
Monitor Reference
Chapter 61: Microsoft IIS Server Monitor
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the Microsoft IIS Server Monitor
1. Prerequisites
l
l
Make sure you have the specific access permissions required for this monitor as specified in
Permissions and Credentials.
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 required.
For a description of each setting, see 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 APM Integration Data and Topology Settings in the Using SiteScope
Guide.
HPE SiteScope (11.33)
Page 440 of 924
Monitor Reference
Chapter 61: 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
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.
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
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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 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.
HPE SiteScope (11.33)
Page 441 of 924
Monitor Reference
Chapter 61: Microsoft IIS Server Monitor
UI
Element
Description
Get
Opens the Select Counters Form, enabling you to select the counters you want to monitor. For
Counters 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.
HPE SiteScope (11.33)
Page 442 of 924
Monitor Reference
Chapter 61: 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
• 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
Tips/Troubleshooting
General General Notes/Limitations
l
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.
When deploying this monitor using a template, an error message is displayed if you clear the Verify
HPE SiteScope (11.33)
Page 443 of 924
Monitor Reference
Chapter 61: Microsoft IIS Server Monitor
monitor properties with remote server check box in the Deployment Values dialog box.
Troubleshooting and Limitations
l
l
Check if the Microsoft IIS server is available and the services that should be monitored are up and running.
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.
HPE SiteScope (11.33)
Page 444 of 924
Chapter 62: 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.
Tip: SiteScope also provides a solution template that includes a set of predefined monitors to create a
monitoring solution for various aspects of Microsoft Lync server monitoring. For details, see Microsoft
Lync Server 2010 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
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 447
l
"Support for IPv6 Addresses" on page 447
l
"Server-Centric Report" on page 448
l
"Configuring the Monitor to Run on Windows 2008 R2 as a Non-Administrator User" on page 448
l
"License Consumption" on page 448
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:
l
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.
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.
HPE SiteScope (11.33)
Page 445 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
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
l
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.
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!.
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:
l
User authentication and registration
l
Presence information and contact card exchange
l
Address book services and distribution list expansion
l
IM functionality, including multiparty IM conferences
l
Web conferencing and application sharing (if deployed)
l
l
l
l
Application hosting services, for both applications included with Lync Server (for example,
Conferencing Attendant and Response Group application) and third-party applications
Application services for application hosting and hosts applications (for example, Response Group
application, and several others)
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.
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
HPE SiteScope (11.33)
Page 446 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
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.
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.
l
Supported Platforms/Versions
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.
l
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
l
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.
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.
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.
HPE SiteScope (11.33)
Page 447 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
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 Non-Administrator 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:
l
l
Use the same domain account on both the SiteScope and the remote monitored system, or
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.
License Consumption
Points-based Usage
Capacity-based Usage
106 points for one instance of each Lync Server role.
One OSi license per monitored host
(Additional points are used when deploying subtemplates for
different machines with the same role.)
Note: This monitor is not available when
using Community edition.
Tasks
How to Configure the Microsoft Lync Server 2010 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.
HPE SiteScope (11.33)
Page 448 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
b. Click the Log On tab, and configure the user account to log on using the selected non-administrator
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 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
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:
HPE SiteScope (11.33)
Page 449 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
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 required.
For a description of each setting, see 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
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.
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)
Server to get
(Available in template mode only) Name of any SiteScope remote server from which you
measurements want to get counters (it must be accessible in the domain using NETBIOS). Any server
from
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.
HPE SiteScope (11.33)
Page 450 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
UI Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the server
to be monitored:
l
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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
l
l
Microsoft Windows PDH Library. This is the default and most common option.
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.
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).
Enable Server- Enables collecting data specifically for generating the Server-Centric Report. The report
Centric 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 page 453.
For each measurement, select the Object, Instances and Counters you want to check
with the monitor, and click the Add Selected Counters
measurements are moved to the Selected Counters list.
Selected
Counters
button. The selected
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
the Available Counters list.
HPE SiteScope (11.33)
button. The measurements are moved to
Page 451 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
Note: For information on configuring setting panels that are common to all monitors, see Common
Monitor Settings in the Using SiteScope Guide.
HPE SiteScope (11.33)
Page 452 of 924
Monitor Reference
Chapter 62: 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
HPE SiteScope (11.33)
Page 453 of 924
Monitor Reference
Chapter 62: 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
HPE SiteScope (11.33)
Page 454 of 924
Monitor Reference
Chapter 62: 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
HPE SiteScope (11.33)
Page 455 of 924
Monitor Reference
Chapter 62: 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
HPE SiteScope (11.33)
Page 456 of 924
Monitor Reference
Chapter 62: 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
HPE SiteScope (11.33)
Page 457 of 924
Monitor Reference
Chapter 62: Microsoft Lync Server 2010 Monitors
Tips/Troubleshooting
General Notes/Tips
l
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.
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
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.
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.
HPE SiteScope (11.33)
Page 458 of 924
Chapter 63: 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" below
l
"Microsoft SQL Server Topology" on the next page
l
"License Consumption" on the next page
Supported Platforms/Versions
l
l
l
l
The Microsoft SQL Server monitor supports monitoring Microsoft SQL Server versions 6.5, 7.1, 2000,
2005, 2008, 2008 R2, 2012, and 2014.
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.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012.
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)
HPE SiteScope (11.33)
Page 459 of 924
Monitor Reference
Chapter 63: Microsoft SQL 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.
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 APM's RTSM.
For details on enabling topology reporting, see the task below.
For information about retrieving topologies and reporting them to APM, see Reporting Discovered Topologies
to APM in the Using SiteScope Guide.
License Consumption
Points-based Usage Capacity-based Usage
One point per metric
One OSi license per monitored host
Tasks
How to Configure the Microsoft SQL Server Monitor
1. Prerequisites
l
l
Make sure you have the specific access permissions required for this monitor as specified in
Permissions and Credentials.
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
HPE SiteScope (11.33)
Page 460 of 924
Monitor Reference
Chapter 63: Microsoft SQL Server Monitor
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 required.
For a description of each setting, see 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.
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
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.
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)
HPE SiteScope (11.33)
Page 461 of 924
Monitor Reference
Chapter 63: Microsoft SQL Server Monitor
UI
Element
Description
Browse
Servers
Opens the HP SiteScope Discover Servers dialog box, enabling you to select the server to be
monitored:
l
l
Browse servers. Select a server from the drop-down list of servers visible in the local
domain.
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.
SQL
instance
name
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 monitor. For
Counters 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.
HPE SiteScope (11.33)
Page 462 of 924
Monitor Reference
Chapter 63: 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
HPE SiteScope (11.33)
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 463 of 924
Monitor Reference
Chapter 63: 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:Exec Statistics
(Average execution time
(ms)/Cumulative execution time (ms)
per second/Execs in progress/Execs
started per second)
• Distributed Query
• DTC calls
• Extended Procedures
• OLEDB calls
SQLServer:General Statistics
• Active Temp Tables
• Event Notifications Delayed Drop
• HTTP Authenticated Requests
• Logical Connections
• Logins/sec
• Logouts/sec
• Mars Deadlocks
• Non-atomic yield rate
• Processes blocked
• SOAP Empty Requests
• SOAP Method Invocations
• SOAP Session Initiate Requests
• SOAP Session Terminate Requests
• SOAP SQL Requests
• SOAP WSDL Requests
• SQL Trace IO Provider Lock Waits
• Temp Tables Creation Rate
• Temp Tables For Destruction
• Trace Event Notification Queue
• Transactions
• User Connections
SQLServer:Latches
• Average Latch Wait Time (ms)
• Latch Waits/sec
• Number of SuperLatches
• SuperLatch Demotions/sec
• SuperLatch Promotions/sec• Total
Latch Wait Time (ms)
HPE SiteScope (11.33)
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
• Average Wait Time (ms)
-- Page
• Average Wait Time (ms)
-- RID
• Average Wait Time (ms)
-- Table
• Lock Requests/sec -- _
Total
• Lock Requests/sec -Database
• Lock Requests/sec -Extent
• Lock Requests/sec -Key
• Lock Requests/sec -Page
• Lock Requests/sec -RID
• Lock Requests/sec -Table
• Lock Timeouts/sec -- _
Total
• Lock Timeouts/sec -Database
• Lock Timeouts/sec -Extent
• Lock Timeouts/sec -Key
• Lock Timeouts/sec -Page
• Lock Timeouts/sec -RID
• Lock Timeouts/sec -Table
• Lock Wait Time (ms) -- _
Total
• Lock Wait Time (ms) -Database
• Lock Wait Time (ms) -Extent
• Lock Wait Time (ms) --
• 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
• Dist
• Logreader
• Snapshot
Page 464 of 924
Monitor Reference
Chapter 63: Microsoft SQL Server Monitor
Key
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: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
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
Tips/Troubleshooting
General Notes/Tips
l
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.
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
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.
HPE SiteScope (11.33)
Page 465 of 924
Chapter 64: Microsoft Windows Dial-up
Monitor (Deprecated)
Note: The Microsoft Windows Dial-up monitor was deprecated, and is currently not planned for future
versions of SiteScope. If this monitor was configured in a previous version of SiteScope, it will still work
after performing a SiteScope upgrade (but we do not recommend using it). This monitor is supported in
SiteScope 11.24 and earlier versions.
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.
Note:
l
l
This monitor requires an Operating System Instance (OSi) license with sufficient available capacity to
create it in the SiteScope interface. For license purchase inquiries (or if you require additional
capacity), contact your HPE sales representative or use the “Contact Us” link in the HPE SiteScope
Product page.
Microsoft Windows Dial-up monitors consume one OS instance per 15 monitors.
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" on the next page
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.
HPE SiteScope (11.33)
Page 466 of 924
Monitor Reference
Chapter 64: Microsoft Windows Dial-up Monitor (Deprecated)
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
l
This monitor is supported in SiteScopes that are running on Windows versions only.
This monitor supports monitoring remote servers running on the following Windows operating systems:
Windows Server 2003, 2003 R2, 2008, 2008 R2, 2012.
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