HP SiteScope - Using SiteScope

HP SiteScope - Using SiteScope
HP SiteScope
For the Windows, Solaris, and Linux operating systems
Software Version: 11.23
Using SiteScope
Document Release Date: December 2013
Software Release Date: December 2013
Using SiteScope
Legal Notices
Warranty
The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be
construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Restricted Rights Legend
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer
Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial
license.
Copyright Notice
© Copyright 2005 - 2013 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
Intel®, Pentium®, and Intel® Xeon® are trademarks of Intel Corporation in the U.S. and other countries.
iPod is a trademark of Apple Computer, Inc.
Java is a registered trademark of Oracle and/or its affiliates.
Microsoft®, Windows®, Windows NT®, and Windows® XP are U.S registered trademarks of Microsoft Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.
UNIX® is a registered trademark of The Open Group.
Documentation Updates
The title page of this document contains the following identifying information:
l
l
l
Software Version number, which indicates the software version.
Document Release Date, which changes each time the document is updated.
Software Release Date, which indicates the release date of this version of the software.
To check for recent updates or to verify that you are using the most recent edition of a document, go to: http://h20230.www2.hp.com/selfsolve/manuals
This site requires that you register for an HP Passport and sign in. To register for an HP Passport ID, go to: http://h20229.www2.hp.com/passport-registration.html
Or click the New users - please register link on the HP Passport login page.
You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details.
Support
Visit the HP Software Support Online web site at: http://www.hp.com/go/hpsoftwaresupport
This web site provides contact information and details about the products, services, and support that HP Software offers.
HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage
your business. As a valued support customer, you can benefit by using the support web site to:
l
l
l
l
l
l
l
l
Search for knowledge documents of interest
Submit and track support cases and enhancement requests
Download software patches
Manage support contracts
Look up HP support contacts
Review information about available services
Enter into discussions with other software customers
Research and register for software training
Most of the support areas require that you register as an HP Passport user and sign in. Many also require a support contract. To register for an HP Passport ID, go to:
http://h20229.www2.hp.com/passport-registration.html
To find more information about access levels, go to:
http://h20230.www2.hp.com/new_access_levels.jsp
HP Software Solutions Now accesses the HPSW Solution and Integration Portal Web site. This site enables you to explore HP Product Solutions to meet your
business needs, includes a full list of Integrations between HP Products, as well as a listing of ITIL Processes. The URL for this Web site is
http://h20230.www2.hp.com/sc/solutions/index.jsp
HP SiteScope (11.23)
Page 2 of 1293
Using SiteScope
Contents
Contents
Introducing SiteScope
3
22
Chapter 1: SiteScope Overview
23
SiteScope Monitoring Model
23
Key Features of SiteScope
24
Chapter 2: SiteScope Freemium Overview
29
Chapter 3: SiteScope Failover Overview
30
Part 1: Getting Started
Chapter 4: Log into SiteScope
31
32
Learn About
32
Tasks
32
Chapter 5: Navigate SiteScope
36
Learn About
36
UI Descriptions
38
Monitor Tree
43
Remote Server Tree
55
Template Tree
56
Preferences Menu
64
Server Statistics Menu
66
Tools Menu
67
Alerts Tab
70
Reports Tab
71
Chapter 6: Set Up and Administer SiteScope
73
Restrict Access to SiteScope
75
Use the JMX Console
76
Chapter 7: Create a Basic Monitoring Structure
77
Chapter 8: Create a Monitoring Structure Using a Template
79
Part 2: General and Administration
Chapter 9: Search SiteScope Objects
HP SiteScope (11.23)
87
88
Page 3 of 1293
Using SiteScope
Learn About
88
Tasks
89
UI Descriptions
91
New/Edit Tag Dialog Box
93
Chapter 10: Filter SiteScope Objects
95
Learn About
95
Tasks
95
UI Descriptions
96
Filter Monitor Types Dialog Box
98
Filter Target Servers Dialog Box
99
Filter Tags Dialog Box
Chapter 11: Perform Actions on Multiple Groups and Monitors
UI Descriptions
100
101
101
Chapter 12: Copy and Move SiteScope Objects
104
Chapter 13: Global Search and Replace
106
Learn About
106
Tasks
107
UI Descriptions
113
Chapter 14: SiteScope Tools
123
Learn About
123
Tasks
124
Tips/Troubleshooting
127
Database Connection Tool
127
Database Information Tool
130
DNS Tool
131
Event Log Tool
132
FTP Tool
134
LDAP Authentication Status Tool
136
Link Check Tool
138
Log Analysis Tool
141
Mail Round Trip Tool
144
HP SiteScope (11.23)
Page 4 of 1293
Using SiteScope
Microsoft Windows Media Player Tool
146
Network Status Tool
147
News Server Tool
148
Performance Counters Tool
149
Ping Tool
151
Processes Tool
152
Real Media Player Tool
153
Regular Expression Tool
154
Services Tool
156
SiteScope Log Grabber Tool
157
SNMP Browser Tool
159
SNMP Tool
161
SNMP Trap Tool
165
Trace Route Tool
166
URL Tool
167
Web Service Tool
170
XSL Transformation Tool
176
Chapter 15: SiteScope Public APIs
178
Learn About
178
Tasks
180
Tips/Troubleshooting
188
Chapter 16: SiteScope Mobile Apps
189
Learn About
189
Tasks
190
Tips/Troubleshooting
190
Chapter 17: Regular Expressions
192
Define a Regular Expression
192
Match String Literals
193
Match Patterns with Metacharacters
194
Search Mode Modifiers
197
Retain Content Match Values
198
HP SiteScope (11.23)
Page 5 of 1293
Using SiteScope
SiteScope Date Variables
199
Examples for Log File Monitoring
202
Problems Working with Regular Expressions
206
Part 3: Integrations
209
Chapter 18: Integrations Overview
210
Chapter 19: Integrating with Other Applications
213
Chapter 20: Connecting to a BSM Server
225
Configure the Connection
227
Integrate SiteScope Data with BSM's Configuration Items
228
Report Discovered Topologies to BSM
233
CI Downtime
235
How to Configure SiteScope to Communicate with BSM
236
How to Configure SiteScope to Send Bulk Data to the Run-Time Service Model
241
How to Connect SiteScope to a BSM Server That Requires a Secure Connection
241
How to Configure Topology Reporting
242
How to Configure Topology Reporting for a Custom Monitor
244
How to Configure Custom Topology for a Custom Monitor
247
Monitors Not Reporting Topology Data By Default
254
Monitors Reporting CI Per Metric
255
Chapter 21: Integrating with HP Load Testing Products
Learn About
Chapter 22: Integrating with HP Application Lifecycle Management
Learn About
Part 4: Monitors and Groups
Chapter 23: Create Groups in SiteScope
257
257
259
259
261
262
Learn About
262
Tasks
263
UI Descriptions
265
Chapter 24: Create Monitors in SiteScope
269
Learn About
269
Tasks
277
HP SiteScope (11.23)
Page 6 of 1293
Using SiteScope
UI Descriptions
280
Tips/Troubleshooting
282
Reference Information: Monitors
283
Monitor Categories List
283
Monitors Supported in SiteScopes Installed on Windows Environments Only
289
Monitors Supporting Windows Management Instrumentation (WMI)
290
Server Monitors that Support Monitoring Amazon EC2 Instances From
SiteScopes Not Installed on EC2
290
Ports Used for SiteScope Monitoring
291
List of Deprecated SiteScope Monitors
296
SiteScope Monitors User Interface
297
Common Monitor Settings
298
General Settings
300
Monitor Run Settings
302
Dependencies
304
Threshold Settings
305
HP Integration Settings
311
Event Mapping Settings
322
Enable/Disable Monitor
323
Enable/Disable Associated Alerts
325
Search/Filter Tags
326
Baseline Settings
327
Logging Settings
328
Select Depends On Monitor Dialog Box
330
Select Template Dialog Box
331
Copy to Template Tree Dialog Box
331
Chapter 25: Create Custom Monitors
333
Learn About
333
Tasks
338
Tips/Troubleshooting
338
Chapter 26: Set Monitor Thresholds Using a Baseline
Learn About
HP SiteScope (11.23)
340
340
Page 7 of 1293
Using SiteScope
Tasks
341
Tips/Troubleshooting
348
Additional Information: Understanding Baseline Calculations
350
Baseline Thresholds User Interface
353
Calculate Baseline Dialog Box
354
Fine-Tune Adherence Levels/Set Boundary Dialog Box
356
Percentile Range Mapping Table
357
Backup Configuration Dialog Box
359
Baseline Monitor Measurement Graphs Dialog Box
360
Annotation Tool
363
Remove Baseline Dialog Box
367
Baseline Status Report
368
Activate Baseline Dialog Box
370
Chapter 27: Create Calculated Metrics
374
Learn About
374
Tasks
376
UI Descriptions
378
Tips/Troubleshooting
385
Chapter 28: Dynamic Monitoring Mechanism
387
Learn About
387
Chapter 29: Monitor XML Documents
390
Learn About
390
Part 5: Integration Monitors
393
Chapter 30: Integration Monitors Overview
394
Chapter 31: Field Mapping Structure
398
CI Resolution Hint Formats
398
Chapter 32: Topology Settings for Technology Integration Monitors
400
Chapter 33: How to Migrate Technology Integration Monitors to BSM Connector
406
Chapter 34: How to Deploy Integration Monitors
408
Chapter 35: Event Handler Structure and Syntax
409
Chapter 36: Troubleshooting and Limitations
418
HP SiteScope (11.23)
Page 8 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
420
Integration Monitor Field Mapping for Metrics Samples
420
How to Configure Integration Monitors to Collect Metrics Data With Computer Monitor Topology
421
Example – Create a Metrics Flow With Computer - Monitor Topology
425
How to Configure Integration Monitors to Collect Metrics Data With Custom
Topology
429
Example – Create a Metrics Flow With Custom Topology
433
How to Configure Integration Monitors to Collect Metrics Data With No Topology
Example – Create a Metrics Flow With No Topology
441
447
Configure Field Mapping for Metrics Samples
454
Chapter 38: Configure Integration Monitors to Collect Event Data
457
Integration Monitor Field Mapping for Event Samples
457
How to Configure Integration Monitors to Collect Data on Common Events
459
How to Configure Integration Monitors to Collect Data on Legacy Events
463
Configure Field Mapping for Common Event Samples
466
Configure Field Mapping for Legacy Event Samples
471
Troubleshooting and Limitations
475
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
476
Integration Monitor Field Mapping for Ticketing Samples
476
How to Configure Integration Monitors to Collect Ticketing Data
477
Configure Field Mapping for Ticket Samples
480
Troubleshooting and Limitations
483
Chapter 40: Report Topology Without Data
Tasks
Chapter 41: Network Node Manager Integration
485
485
487
Learn About
487
Tasks
488
Part 6: Remote Servers
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
489
490
Learn About
490
Tasks
490
HP SiteScope (11.23)
Page 9 of 1293
Using SiteScope
UI Descriptions
495
Tips/Troubleshooting
501
Chapter 43: Configure the WMI Service for Remote Windows Monitoring
507
Learn About
507
Tasks
508
Tips/Troubleshooting
509
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
510
Learn About
510
Tasks
510
UI Descriptions
512
Tips/Troubleshooting
518
Chapter 45: Extend UNIX Monitoring Using Operating System Adapters
519
Learn About
519
Tasks
524
Chapter 46: Enable SiteScope to Prefer IP Version 6 Addresses
526
Learn About
526
Tasks
530
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
531
Monitor Remote Windows Servers Using SSH
533
How to Configure Remote UNIX Servers for SSH monitoring
534
How to Configure Remote Windows Servers for SSH monitoring
535
Install Cygwin OpenSSH on Windows
536
Install OpenSSH for Windows
542
Install SiteScope Remote Windows SSH Files
543
SSH Configuration Requirements for UNIX Remote Servers
545
Monitors Supporting Windows SSH (Agentless or Using the SiteScope Remote
Windows SSH Files)
545
Troubleshooting and Limitations
546
Chapter 48: Integrated Java SSH Client
548
How to Configure the Integrated Java SSH Client
549
How to Set Up Key-Based Authentication
549
Chapter 49: Remote Servers Properties Page
554
HP SiteScope (11.23)
Page 10 of 1293
Using SiteScope
Part 7: Preferences
Chapter 50: Certificate Management
556
557
Learn About
557
Tasks
557
UI Descriptions
558
Import Certificates Dialog Box
559
Certificate Details Dialog Box
560
Chapter 51: Common Event Mappings
562
Learn About
562
Tasks
563
UI Descriptions
564
New/Edit Event Mappings Dialog Box
565
Chapter 52: Credential Preferences
572
Learn About
572
Tasks
574
UI Descriptions
576
Tips/Troubleshooting
576
New/Edit Credential Profile Dialog Box
577
Chapter 53: Email Preferences
580
Learn About
580
UI Descriptions
580
New/Edit Email Recipient Dialog Box
581
Email Preferences Default Settings Dialog Box
583
Chapter 54: General Preferences
586
Learn About
586
UI Descriptions
587
Chapter 55: HTTP Preferences
596
Tasks
596
UI Descriptions
596
New/Edit HTTP Recipient Dialog Box
597
Chapter 56: High Availability Preferences
604
HP SiteScope (11.23)
Page 11 of 1293
Using SiteScope
Learn About
604
UI Descriptions
605
New/Edit Failover Profile Dialog Box
606
Default Failover Server Settings Dialog Box
613
Chapter 57: Infrastructure Preferences
615
Learn About
615
UI Descriptions
615
Chapter 58: Integration Preferences
Amazon CloudWatch Integration Preferences
657
657
Learn About
658
UI Descriptions
658
Tips/Troubleshooting
661
BSM Integration Preferences
662
Learn About
662
Tasks
664
UI Descriptions
665
Tips/Troubleshooting
668
Diagnostics Integration Preferences
668
Learn About
668
Tasks
669
UI Descriptions
669
HP Operations Manager Integration Preferences
673
Learn About
673
Tasks
674
UI Descriptions
674
Generic Data Integration Preferences
681
Learn About
682
UI Descriptions
682
Generic Event Integration Preferences
686
Learn About
686
Tasks
687
HP SiteScope (11.23)
Page 12 of 1293
Using SiteScope
UI Descriptions
690
XML Tag Reference for Generic Data and Diagnostics Integrations
691
Integration Preferences Page
695
Chapter 59: Log Preferences
697
Learn About
697
Tasks
698
UI Descriptions
700
Tips/Troubleshooting
702
Chapter 60: Pager Preferences
703
Learn About
703
UI Descriptions
703
New/Edit Pager Recipient Dialog Box
704
Chapter 61: Schedule Preferences
708
Learn About
708
UI Descriptions
709
Absolute Schedule Page
709
Range Schedule User Page
711
Chapter 62: Search/Filter Tags
714
Tasks
Chapter 63: SNMP Preferences
714
717
Learn About
717
UI Descriptions
717
Send/Receive SNMP Trap Dialog Box
719
Chapter 64: User Management Preferences
726
Learn About
726
Tasks
729
UI Descriptions
730
Tips/Troubleshooting
732
User Management Settings Dialog Box
732
New/Edit User Profile Dialog Box
735
New/Edit User Role Profile Dialog Box
747
HP SiteScope (11.23)
Page 13 of 1293
Using SiteScope
Save SiteScope LDAP Users in CSV File Dialog Box
748
Select User's Allowed Groups Dialog Box
749
Chapter 65: Internationalization in SiteScope
751
Learn About
751
Tasks
753
Tips/Troubleshooting
755
Chapter 66: Authentication Strategies
758
Learn About
758
Tasks
762
Tips/Troubleshooting
767
Part 8: User-Defined Content
Chapter 67: SiteScope Templates
770
771
Learn About
771
Tips/Troubleshooting
773
Template Objects
776
Template Examples
776
Planning Templates
777
Template Variables
778
Variable Syntax
779
Syntax for User-Defined Variables
780
Syntax for System Variables
780
Referencing Template Variables
781
How to Create a Monitoring Structure Using a Template
782
How to Create a Template by Copying Existing Configurations
790
Select Browsable Monitor Counters in Monitor Templates
791
Reserved Template Group Types
795
SiteScope Templates User Interface
796
SiteScope Templates Page
796
Templates Tree - Properties Page
797
Templates Tree - Alerts Tab
798
New Template Container Dialog Box
799
HP SiteScope (11.23)
Page 14 of 1293
Using SiteScope
New Template Dialog Box
801
New Variable Dialog Box
802
New Template Remote Server Dialog Box
804
New Template Group Dialog Box
806
New Template Monitor Dialog Box
811
New Alert Dialog Box
813
Search/Filters Tag Dialog Box
814
Chapter 68: SiteScope Content Packages
815
Learn About
815
Tasks
815
Chapter 69: Export and Import SiteScope Content
816
Learn About
816
Tasks
816
Import/Export Content User Interface
827
Export Template Dialog Box
828
Export Content Package Wizard
829
Create Manifest Page
830
Select Templates Page
831
Select Files Page
831
Export Page
833
Summary Page
834
Content Import Dialog Box
834
Chapter 70: Deploy Templates
836
Learn About
836
Tasks
837
Tips/Troubleshooting
842
Deploy Templates User Interface
842
Select Group Dialog Box
843
Deploy Multiple Templates Dialog Box
843
Deployment Values Dialog Box
845
Select CSV File Box Dialog Box
847
HP SiteScope (11.23)
Page 15 of 1293
Using SiteScope
Chapter 71: Publish Changes to User-Defined Templates
849
Learn About
849
Tasks
850
Tips/Troubleshooting
854
Publish Template Changes Wizard
855
Select Deployed Groups Page
856
Review Compliancy Page
856
Content Changes Dialog Box
858
Modify Variables Page
858
Publish Results Summary Page
859
Publish Template Changes Summary Report
859
Chapter 72: Automatic Template Deployment Using an XML File
862
Learn About
862
Tasks
864
UI Descriptions
868
Tips/Troubleshooting
869
XML File Example and Variables
871
XML Validator
874
XML Tag Reference
874
Chapter 73: Share Content on the HP Live Network
878
Learn About
878
Tasks
878
Part 9: Solution Templates
Chapter 74: Deploy Solution Templates
881
882
Learn About
882
Tasks
887
UI Descriptions
889
Tips/Troubleshooting
889
Chapter 75: Active Directory Solution Templates
891
Chapter 76: AIX Host Solution Template
894
Chapter 77: Failover Monitoring Solution Templates
897
HP SiteScope (11.23)
Page 16 of 1293
Using SiteScope
Chapter 78: Hadoop Cluster Monitoring Solution Templates
903
Chapter 79: HP Quality Center Solution Templates
907
Chapter 80: HP Service Manager Solution Templates
918
Chapter 81: HP Vertica Solution Template
924
Chapter 82: JBoss Application Server Solution Template
926
Chapter 83: Linux Host Solution Template
929
Chapter 84: Microsoft Exchange Solution Templates
932
Chapter 85: Microsoft IIS Solution Templates
937
Chapter 86: Microsoft Lync Server 2010 Solution Templates
941
Chapter 87: Microsoft SharePoint 2010 Solution Templates
945
Chapter 88: Microsoft SQL Server Solution Templates
948
Chapter 89: Microsoft Windows Host Solution Template
953
Chapter 90: .NET Solution Templates
956
Chapter 91: Oracle Database Solution Templates
959
Chapter 92: SAP Solution Templates
965
Chapter 93: Siebel Solution Templates
969
Chapter 94: Solaris Host Solution Templates
977
Chapter 95: VMware Capacity Management Solution Templates
980
Chapter 96: VMware Host Solution Template
987
Chapter 97: VMware Host For Performance Troubleshooting Solution Template
991
Chapter 98: WebLogic Solution Templates
996
Chapter 99: WebSphere Solution Templates
Part 10: View Data in SiteScope
Chapter 100: SiteScope Dashboard
1001
1005
1006
Learn About
1006
Tasks
1009
Acknowledge Monitors In Group Dialog Box
1013
Dashboard Settings Dialog Box
1014
Dashboard Filter Dialog Box
1016
Save to Dashboard Favorites Dialog Box
1019
Delete Dashboard Favorites Dialog Box
1020
HP SiteScope (11.23)
Page 17 of 1293
Using SiteScope
SiteScope Dashboard - Current Status View
1020
SiteScope Dashboard - Monitor History View
1028
Enable/Disable Monitors in Group Dialog Box
1029
Chapter 101: SiteScope Multi-View
1031
Learn About
1032
Tasks
1035
UI Descriptions
1041
Tips/Troubleshooting
1051
Chapter 102: SiteScope Server Health
1052
Learn About
1052
Tasks
1054
Tips/Troubleshooting
1057
BAC Integration Configuration Monitor
1058
Tasks
1058
UI Descriptions
1059
Tips/Troubleshooting
1060
BAC Integration Statistics Monitor
1060
Tasks
1060
UI Descriptions
1061
Connection Statistics Monitor
1061
Tasks
1061
UI Descriptions
1062
Dynamic Monitoring Statistics Monitor
1064
Tasks
1064
UI Descriptions
1064
Health of SiteScope Server Monitor
1066
Tasks
1066
UI Descriptions
1066
Tips/Troubleshooting
1071
License Usage Monitor
Tasks
HP SiteScope (11.23)
1071
1072
Page 18 of 1293
Using SiteScope
UI Descriptions
Log Event Checker Monitor
1072
1072
Tasks
1073
UI Descriptions
1073
Monitor Load Checker Monitor
1075
Tasks
1075
UI Descriptions
1076
SSL Certificates State Monitor
1076
Tasks
1076
UI Descriptions
1077
Chapter 103: SiteScope Server Statistics
1078
Learn About
1078
Tasks
1082
Audit Log File
1082
Learn About
1083
Tasks
1089
Tips/Troubleshooting
1089
Dynamic Monitoring Page
1090
General Page
1092
Log Files Page
1093
Perfex Process Pool Page
1099
Running Monitors Page
1101
SSH Connections Page
1102
Telnet Connections Page
1104
WMI Statistics Page
1105
Monitor Specific Log Column Content
1106
Part 11: Alerts
Chapter 104: Configure SiteScope Alerts
1139
1140
Learn About
1140
Tasks
1144
Tips/Troubleshooting
1145
HP SiteScope (11.23)
Page 19 of 1293
Using SiteScope
Understand When SiteScope Alerts Are Sent
1146
Database Alerts
1148
Disable or Enable Monitor Alerts
1149
Email Alerts
1150
Log Event Alerts
1151
Pager Alerts
1152
Post Alerts
1153
Script Alerts
1154
SMS Alerts
1157
SNMP Trap Alerts
1159
Sound Alerts
1159
Trigger Alert
1160
SiteScope Alerts User Interface
1160
SiteScope Alerts Page
1160
New/Edit Alert Dialog Box
1162
Action Type Dialog Box
1169
Alert Action Dialog Box
1170
Action Type Settings Panel
1171
Status Trigger Panel
1187
Trigger Frequency Panel
1188
Chapter 105: Customize Alert Templates
1190
Learn About
1190
Tasks
1191
Tips/Troubleshooting
1194
Chapter 106: Write Scripts for Script Alerts
1195
Learn About
1195
Tasks
1196
Chapter 107: Properties Available in Alerts, Templates, and Events
Part 12: Reports
Chapter 108: Create SiteScope Reports
Learn About
HP SiteScope (11.23)
1199
1210
1211
1211
Page 20 of 1293
Using SiteScope
Tasks
1213
Tips/Troubleshooting
1214
SiteScope Reports User Interface
1214
Reports Page
1215
New/Edit SiteScope Management Report Dialog Box
1216
Graph Metrics Options
1225
New SiteScope Quick Report Dialog Box
1226
New SiteScope Monitor Report Dialog Box
1231
Mail Details Dialog Box
1235
New SiteScope Alert Report Dialog Box
1236
Management Report
1241
Quick Report
1244
Monitor Summary Report
1247
Alert Report
1250
Chapter 109: Create Server-Centric Reports
1251
Learn About
1251
Tasks
1252
UI Descriptions
1256
Part 13: Predictive Analytics
Chapter 110: Configure Predictive Analytics
1260
1261
Learn About
1261
Tasks
1271
New Predictive Analytics Dialog Box
1275
Analytics Tab
1278
Glossary
1285
We appreciate your feedback!
1293
HP SiteScope (11.23)
Page 21 of 1293
Introducing SiteScope
HP SiteScope is an agentless monitoring solution designed to help you ensure the availability and
performance of distributed IT infrastructure and applications. SiteScope continually monitors IT
components through a web-based architecture that does not require installing data collection agents
on your production systems. For details, see "SiteScope Overview" on page 23.
Tip: You can view a guided and narrated overview of the SiteScope application in the HP
Video Gallery: http://h20621.www2.hp.com/video-gallery/us/en/sss/20308EBD-0975-4C429671-DF922B64E6D2/r/video/.
In addition to the full edition, SiteScope is also available in the following editions:
l
SiteScope Freemium
This edition enables you to use SiteScope with partial functionality for an unlimited period of time
for free. For details, see "SiteScope Freemium Overview" on page 29.
l
SiteScope Failover
This edition enables you to implement failover capability for infrastructure monitoring. It
automatically switches the functions of a primary system to a standby server if the primary
system fails or is temporarily taken out of service. For details, see "SiteScope Failover
Overview" on page 30.
HP SiteScope (11.23)
Page 22 of 1293
Chapter 1: SiteScope Overview
SiteScope monitors collect key performance measurements and report topology on a wide range of
back-end infrastructure components. The monitors are individually configured to automatically test
performance and availability of systems and services in the network environment.
SiteScope monitoring includes alerting and reporting capabilities, along with a dashboard for a realtime picture of the monitored environments. SiteScope can be configured to send alerts whenever it
detects a problem in the IT infrastructure. In addition, SiteScope can create reports for monitors or
monitor groups that display information about how the servers and applications you are monitoring
have performed over time. For details, see "SiteScope Monitoring Model" below.
To help you deploy monitors with similar monitoring configuration criteria across the enterprise, you
can define templates, or use preconfigured SiteScope solution templates. The use of templates
enables you to develop and maintain a standardized set of monitor types and configurations in a
single structure that can be repeatedly deployed and easily updated using global change and
replace capabilities, without having to update each object individually.
SiteScope also includes alert template types that you can use to communicate and record event
information in a variety of media. You can customize alert templates to meet the needs of your
organization.
For a list of features in SiteScope, see "Key Features of SiteScope" on the next page.
Tip: You can view a guided and narrated overview of the SiteScope application in the HP
Video Gallery: http://h20621.www2.hp.com/video-gallery/us/en/sss/20308EBD-0975-4C429671-DF922B64E6D2/r/video/.
SiteScope Monitoring Model
SiteScope's Web-enabled architecture enables the creation and ongoing administration of a
centralized, scalable monitoring environment. It consists of the following key components:
l
Browser-based interface. Manages end user status information requests, configuration change
requests, and access control.
l
Scheduler. Coordinates the running of monitors, alert creation, and report generation. For
details, see "Schedule Preferences" on page 708.
l
Groups. A group is a container for monitoring assets. Groups may contain subgroups and are
used to organize monitors. Groups are created prior to monitors. For details, see "Create Groups
in SiteScope" on page 262.
l
Monitors. A monitor collects performance and availability information about the system being
monitored. It checks the status of server components, key application processes, log files, or
network devices, to name a few. It also collects data based on selected metrics and displays a
status of good, warning, or error with respect to the configured thresholds. For details, see
"Create Monitors in SiteScope" on page 269.
HP SiteScope (11.23)
Page 23 of 1293
Using SiteScope
Chapter 1: SiteScope Overview
l
Alerts. An alert is an action triggered by a change in the status of a monitored asset. Alerts
notify required users when negative events or failures occur. An alert can be sent to a variety of
media including email, pager, Short Message Service (SMS) messages, or an SNMP trap. For
details, see "Configure SiteScope Alerts" on page 1140.
l
Reports. A report is a historical representation of monitored data for trending and analysis
purposes. SiteScope offers a variety of reports from quick monitor reports to detailed
management reports. Reports enable you to track trends and operational performance and to
troubleshoot problems. For details, see "Reports" on page 1210.
l
Analytics. Using Analytics, SiteScope can anticipate potential problems on business monitors
and alert users of issues in critical applications before they occur. Analytics uses a run-time
analytics engine that can predict IT problems by analyzing abnormal system behavior, and
alerting IT managers of business flow degradation before an issue impacts their business. For
details, see "Configure Predictive Analytics" on page 1261.
Key Features of SiteScope
SiteScope has the following features:
Agentless, Enterprise-Ready Architecture
l
Enterprise-ready architecture. SiteScope provides simultaneous monitoring of a large number
of systems, and support for secure connections.
l
Agentless monitoring. SiteScope monitors without the deployment of agent software on the
servers to be monitored. This function makes deployment and maintenance of SiteScope
relatively simple compared to other performance monitoring solutions.
l
Simple installation and deployment. SiteScope is installed on a single server running as a
service or a process. This results in quick installation and easy monitoring configuration.
Web-Based User Interface
l
Intuitive administration. SiteScope reduces the time spent managing a monitoring
environment by providing a user friendly browser-based interface for viewing and administering
of the monitoring platform. For details, see "Navigate SiteScope" on page 36.
l
Multi-View. Enables you to see the status of everything that is being monitored in your IT
infrastructure in a single view. You can group objects in various different ways to fit the
perspective of different personas. For example, you can use it to display SiteScope groups and
monitors in a hierarchical tree map as a set of nested rectangles, without losing the relationship
between the data; you can display monitors grouped by target remote server; or you can display
monitors grouped by custom search/filter tags. Multi-View is ideal for displaying enterprise-wide
monitoring status in a network operations setting. For details, see "SiteScope Multi-View" on
page 1031.
HP SiteScope (11.23)
Page 24 of 1293
Using SiteScope
Chapter 1: SiteScope Overview
Standardized Monitor Deployments and Updates Using Templates
l
User-defined templates. SiteScope supports the ability to create and publish reusable
templates, enabling you to set up and deploy multiple IT elements with similar monitoring
configuration criteria. Using the Publish Template Changes wizard, you can rapidly update your
monitoring environment across the entire enterprise, without the need for extensive manual
updates. For details, see "SiteScope Templates" on page 771.
l
Solution Templates. SiteScope offers solution templates that feature built-in domain expertise
in the form of specialized monitors, default metrics and thresholds, proactive tests, and best
practices for a given application or component being monitored. For details, see "Deploy
Solution Templates" on page 882.
l
Automated deployment with XML. SiteScope enables you to bypass the user interface and
deploy templates using an XML file. This saves your IT organization time and money by enabling
the introduction of a large number of monitors in a single operation. For details, see "Automatic
Template Deployment Using an XML File" on page 862.
Infrastructure Performance and Availability Monitoring
l
Out-of-the-box monitors. SiteScope provides more than 100 out-of-the-box monitors covering
aspects such as utilization, response time, usage, and resource availability. For details, see
"Monitors and Groups" on page 261.
l
Customizable monitors. SiteScope provides custom monitors that enable you to extend your
SiteScope environment by creating new monitor types and customizing existing monitors. By
using custom monitors, HP customers and partners have the ability to develop solutions for
environments not supported by existing SiteScope monitors. Custom monitors can also be
shared with other users by publishing them to the HP SiteScope community on the HP Live
Network. For details, see "Create Custom Monitors" on page 333.
l
Elastic configuration. Elastic configuration is a way to 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 VMware Host Monitors,
VMware Datastore Monitor, Generic Hypervisor Monitor, Hadoop Monitor, HP Vertica JDBC
Monitor, KVM Monitor, Dynamic Disk Space Monitor and Dynamic JMX Monitor.
l
Baseline management. SiteScope can be used to create baselines and schedule specific
thresholds based on a time period or date. The baseline calculated for your configuration can be
tested against actual performance conditions to view the errors and warnings that would have
been reduced by the calculated baseline. Graphs can be used to compare your calculated
baseline with current threshold settings to determine potential performance improvements. For
details, see "Set Monitor Thresholds Using a Baseline" on page 340.
l
Customization capabilities. SiteScope permits the display of customizations of groups and
monitors by using custom data fields and HTML-sensitive description tags. In addition,
HP SiteScope (11.23)
Page 25 of 1293
Using SiteScope
Chapter 1: SiteScope Overview
SiteScope permits the customization of alert text and report configurations by using templates
and user-defined variables. For details, see "Properties Available in Alerts, Templates, and
Events" on page 1199.
l
Self-monitoring. SiteScope monitors key aspects of its own operability and identifies monitor
configuration problems and critical server load. It also monitors its own integration and data
events when configured to report to Business Service Management. For details, see "SiteScope
Server Health" on page 1052.
Alerts, Notifications, Predictive Analytics, and Reports
l
Proactive alerting. Provides alerting capabilities, based on customizable thresholds, so that
you can fix problems before end users experience them. Alerts are sent to IT administrators
based on configured thresholds and defined schedules. There are several types of alert actions,
such as sending email messages, Simple Network Management Protocol (SNMP) traps, or
executing a script. For details, see "Configure SiteScope Alerts" on page 1140.
l
Server-based reporting. SiteScope can collect multiple pre-selected metrics from a specific
server and combine them into a single graph—giving you quick access to key performance
monitoring data for any server in your environment. One of the key benefits of server-based
reporting is the ability to drill down into reports to troubleshoot server related issues. For details,
see "Reports" on page 1210.
l
Predictive Analytics. Predictive Analytics helps protect businesses from the impact of IT
issues by predicting potential problems in critical applications and informing you of issues that
can affect the business flow. SiteScope uses baseline and correlation calculations to analyze
system problems and provide details to assist with root cause analysis so that you can
anticipate issues before business flows are impacted. For details, see "Configure Predictive
Analytics" on page 1261.
Integrate SiteScope With a Wide Variety of HP Software and Third Party
Products
SiteScope can be integrated with a variety of HP software and third party products, including:
l
HP Business Service Management. SiteScope can be used as a data collector for HP
Business Service Management (BSM). BSM receives data about end-users, business
processes, and systems and uses the data in reports and analysis. SiteScope monitor data can
be sent to BSM for all monitors, or for selected monitors only. For details, see "Connecting to a
BSM Server" on page 225.
l
HP Operations Manager and Operations Management: combining agentless and agentbased monitoring. SiteScope can be used in conjunction with HP Operations Manager
(HPOM) or Operations Management (OMi), such that a single console acts as a central
repository for all discovered events.SiteScope collects events and then logs it to an agent data
store using the HP Operations agent which resides on the SiteScope server. This information is
then forwarded to HPOM/Operations Management. For details, see Integrating SiteScope with
HP Operations Manager Products in the SiteScope Help.
HP SiteScope (11.23)
Page 26 of 1293
Using SiteScope
Chapter 1: SiteScope Overview
l
HP Performance Manager and Performance Graphing: view both agentless and agentbased data when monitoring performance. Using the HP Operations agent that resides on
the SiteScope server or a profile database in BSM (for reporting to Performance Graphing only),
you have visibility of SiteScope metrics in HP Performance Manager as well as the graphing
component of Operations Management. For details, see Integrating SiteScope with HP
Operations Manager Products in the SiteScope Help.
l
Other HP software products. Data integration enables SiteScope reports to be displayed and
the SiteScope user interface to be hosted—all within HP Performance Center. You can also
view SiteScope system level performance and availability information within HP Diagnostics.
Other integrations include the ability to send SiteScope events and metrics to Network Node
Manager (NNMi) and the automatic creation of monitors in SiteScope through its integration with
HP Operations Orchestration. SiteScope also integrates with HP Application Lifecycle
Management (ALM) to share monitoring data and templates from the production environment to
enable load testing engineers to plan performance tests and application deployment. Lastly,
SiteScope serves as the monitoring foundation for HP LoadRunner and Performance Center
software, to better identify bottlenecks during the load testing phase. For details, see
"Integrations" on page 209.
l
Amazon CloudWatch. SiteScope can be used to report SiteScope monitor measurement data
to an Amazon CloudWatch service. This integration enables customers who use SiteScope for
monitoring their AWS-hosted applications to report any SiteScope metrics to Amazon
CloudWatch service. SiteScope metrics data can be used for AWS AutoScaling, reporting, and
alerting. For details, see "Amazon CloudWatch Integration Preferences" on page 657.
For an overview of SiteScope integrations, see "Integrations Overview" on page 210. For a diagram
illustrating the various SiteScope integrations, see "Integrating with Other Applications" on page
213.
Monitor IT Health From Anywhere
l
Mobile access. Using HP SiteScope’s mobile access capabilities, you can access SiteScope
from a mobile device using SiteScope’s free downloadable apps (supported on iPhone, iPad,
iPod touch, and Android phones or tablets). With this capability, you can search HP SiteScope
servers to view individual monitors and group statistics, perform actions on search results to
mitigate issues, respond to email alerts when a problem is detected in the IT infrastructure, add
selected monitors and groups to a favorites list, and generate ad hoc reports for monitors,
groups, or alerts for specific time periods. For details, see "SiteScope Mobile Apps" on page
189.
Failover Capability for Monitoring Mission-Critical Applications in High
Availability Environments
l
Failover capabilities. SiteScope offers failover support to give you added redundancy and
automatic failover protection if a SiteScope server experiences availability issues. When the
primary HP SiteScope server becomes unavailable, a secondary server takes over, providing
uninterrupted monitoring. This capability does not require additional hardware and takes
advantage of mirroring operations that enables rollback capabilities in the event of interruption.
HP SiteScope (11.23)
Page 27 of 1293
Using SiteScope
Chapter 1: SiteScope Overview
For details, see "SiteScope Failover Overview" on page 30.
HP SiteScope (11.23)
Page 28 of 1293
Chapter 2: SiteScope Freemium Overview
The SiteScope Freemium edition enables you to try SiteScope for an unlimited period of time for
free. It provides 250 SiteScope points, and enables you to use SiteScope with a restricted set of
features for as long as you want.
SiteScope Freemium uses a Freemium license. You can download and install SiteScope Freemium
from the HP SiteScope Product page (http://www.hp.com/go/sitescope).
For more information about the features available in SiteScope Freemium, licensing, and the
SiteScope Freemium installation flow, see the SiteScope Deployment Guide (<SiteScope root
directory>\sisdocs\doc_lib\Get_Documentation.htm).
You can upgrade SiteScope Freemium to a full SiteScope license at any time to expand the
monitoring capacity of your initial deployment and to enjoy all the features offered by SiteScope.
This provides an efficient and flexible way to scale SiteScope to your environment. For more
information on licensing the full version of HP SiteScope, contact your HP Software Sales
Representative or visit http://www.hp.com/go/sitescope.
HP SiteScope (11.23)
Page 29 of 1293
Chapter 3: SiteScope Failover Overview
The SiteScope Failover solution enables you to implement failover capability for infrastructure
monitoring by provisioning for backups, redundancy, and failover mechanisms. It automatically
switches the functions of a primary system to a standby server if the primary system fails or is
temporarily taken out of service.
The SiteScope Failover (automated mirroring) solution was reinstated as a replacement for the
SiteScope Failover Manager (shared drive architecture) solution which was introduced in SiteScope
11.00. SiteScope Failover is a more robust solution which is easy to install and configure, and it
does not require additional hardware (you do not need a network drive to store SiteScope
configuration data). For details on installing and using SiteScope Failover, see the HP SiteScope
Failover Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_Documentation.htm).
While SiteScope Failover Manager is supported for this release, we might stop supporting it in the
future. If you are using the SiteScope Failover Manager solution, we recommend that you evaluate
a move to the SiteScope Failover solution. For details on the SiteScope Failover Manager solution,
see the HP SiteScope Failover Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_
Documentation.htm).
Note:
l
A valid SiteScope Failover license file is required to use SiteScope Failover. If you do not
have a valid license file, you can submit a request to renew or upgrade your license using
the HP Licensing for Software Portal
(https://h30580.www3.hp.com/poeticWeb/portalintegration/hppWelcome.htm).
l
If you want to configure HP Operations Manager Integration for SiteScope with High
Availability option, the SiteScope Failover solution is recommended.
HP SiteScope (11.23)
Page 30 of 1293
Part 1: Getting Started
This section explains how to access SiteScope ("Log into SiteScope" on page 32) and how to
navigate the SiteScope user interface ("Navigate SiteScope" on page 36). It also provides a
recommended flow for setting up and administering your monitoring solution ("Set Up and
Administer SiteScope" on page 73).
To help you get started with SiteScope, see the suggested workflows:
l
"Create a Basic Monitoring Structure" on page 77. Use this workflow for creating a simple
monitoring structure in SiteScope.
l
"Create a Monitoring Structure Using a Template" on page 79. Use this workflow for creating
standardized templates for mass (enterprise) deployments.
HP SiteScope (11.23)
Page 31 of 1293
Chapter 4: Log into SiteScope
You can access SiteScope from any computer with a network connection (intranet or Internet) to
the SiteScope server using a supported Web browser or from the Start menu on Windows
platforms. Alternatively, you can use a silent login URL which enables you to go directly to the
specified SiteScope server without showing the SiteScope login page (for details, see "Silent
Login" below).
For details on browser requirements, as well as minimum requirements to successfully view
SiteScope, see the System Requirements section in the SiteScope Deployment Guide
(<SiteScope root directory>\sisdocs\doc_lib\Get_Documentation.htm).
Learn About
Silent Login
You can access SiteScope using a silent login URL. This enables you to skip the login page and
directly open the user account for the given user name and password using the silent login address.
In addition, you can use silent login in conjunction with a page option view that you saved in your
browser's list of Favorites to open SiteScope directly to a particular group or view. For details on
configuring a favorite page option view, see Page Options in "Common Toolbar" on page 38.
To start SiteScope using silent login, you must encrypt the user login name and password using the
SiteScope Encryption Tool, and enter the encrypted information in the silent login URL. For task
details, see "How to access SiteScope using silent login" on the next page.
Tasks
How to access SiteScope from a browser or from the Start menu
l
To access SiteScope from a browser, enter the SiteScope address in a Web browser. The
default address is: http://<server name>:8080/SiteScope.
l
To access SiteScope from the Start menu (Windows platforms only), click Start > Programs >
HP SiteScope > Open HP SiteScope.
The first time SiteScope is deployed, there is a delay for initialization of the interface elements.
When you connect to a SiteScope, the SiteScope opens to the Dashboard view.
Tip:
l
To restrict access to this account and its privileges, you should edit the Administrator
account profile to include a user login name and login password. SiteScope then displays a
login dialogue before SiteScope can be accessed. If no user name and password are
defined for the Administrator user, SiteScope skips the login page and automatically logs in.
For details on editing the Administrator account profile, see "User Management
Preferences" on page 726.
HP SiteScope (11.23)
Page 32 of 1293
Using SiteScope
Chapter 4: Log into SiteScope
l
It is also recommended to change the Integration Viewer account profile to include a user
login name and login password.
How to access SiteScope using silent login
This task describes how to create a silent login URL, and how to access the specified SiteScope
server directly without showing the SiteScope login page.
1.
Create a user profile
In the Preferences context, click the User Management Preferences menu and create a user
account.
For user interface details, see "User Management Preferences Page" on page 730.
Note:
n
The Administrator account is the default account that is active when the product is
installed. To create other accounts, you must first edit the Administrator account profile
to include a user login name and password.
n
Silent login is not supported for users that contain any of the following special
characters in the password: ‘ (apostrophe), “ (double quote), or / (backslash).
Example:
A user profile with the displayed name Regular User was added with login name Regular
and password Regular.
HP SiteScope (11.23)
Page 33 of 1293
Using SiteScope
Chapter 4: Log into SiteScope
2.
Configure user permissions - optional
Configure the user action permissions in the Permissions section of the New/Edit User dialog
box. By default, a new user has full permissions except for the permission to modify or delete
other user preferences.
For user interface details, see "Permissions" on page 738.
3.
Encrypt the user profile
Encrypt the user login name and password.
a. In a command prompt, run the following command for the login name:
<SiteScope root directory>\tools\AutoDeployment\
encrypt_password.bat <login name>
For example:
C:\SiteScope\tools\AutoDeployment\encrypt_password.bat Regular
The encrypted value for Regular is (sisp)uq1zrGl1Ims=.
b. Encode any non-standard URL characters according to the list in
http://www.blooberry.com/indexdot/html/topics/urlencoding.htm. Note that URL encoding
of a character consists of a % symbol, followed by the two-digit representation for the
character.
HP SiteScope (11.23)
Page 34 of 1293
Using SiteScope
Chapter 4: Log into SiteScope
In this example, = is a reserved character, and should be replaced by %3D. Thus, the
encoded value for Regular is (sisp)uq1zrGl1Ims%3D.
c. Save the encrypted value so that you can add it to the silent login URL.
d. Repeat the encryption process for the login password (if different from the login name).
4.
Enter the SiteScope silent login URL in a browser
Create a SiteScope silent login URL for the user profile, and enter the URL in a Web browser.
The URL should be in the format:
http://<server_name>:8080/SiteScope?sis_silent_login_type=encrypted&login=
<encrypted_login_name>&password=<encrypted_password>
where <encrypted_login_name> and <encrypted_password> are replaced by the encrypted
login name and password.
5.
Results
SiteScope skips the login page and directly opens the user account for the given user name
and password.
Note: If values entered for the login name and password parameters do not exist, are not
found, or if authentication fails, then the SiteScope login page is displayed.
HP SiteScope (11.23)
Page 35 of 1293
Chapter 5: Navigate SiteScope
When you connect to a SiteScope, the SiteScope opens to the Dashboard view as shown below. If
you enter a user name to log on to SiteScope, it appears on the upper-right side of the window.
Learn About
This section contains:
l
"Key Navigation Elements" below
l
"Navigating and Performing Actions in the Context Tree" on the next page
l
"SiteScope Keyboard Shortcuts" on the next page
Key Navigation Elements
The SiteScope window contains the following key elements:
l
SiteScope common toolbar. Provides access to page options, documentation, and additional
resources. This toolbar is located on the upper part of the window. For more details, see
"Common Toolbar" on page 38.
l
SiteScope context toolbar. Contains buttons for frequently-used commands in the selected
SiteScope context. For more details, see "Context Toolbar Buttons" on page 39.
l
SiteScope context tree. Enables you to create and manage SiteScope objects in a tree
structure. For details, see "Monitor Tree" on page 43, "Remote Server Tree" on page 55, and
"Template Tree" on page 56.
l
SiteScope context buttons. Provide access to the SiteScope Monitors, Remote Servers,
Templates, Preferences, Server Statistics, and Diagnostic Tools. For more details, see
"Context Buttons" on page 43.
HP SiteScope (11.23)
Page 36 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Note: The SiteScope Classic interface that was available in earlier SiteScope versions
using the URL http://<sitescope_host>:8888 is no longer available for managing
SiteScope. For more information, see SiteScope Classic Interface in the SiteScope
Deployment Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_Documentation.htm).
Navigating and Performing Actions in the Context Tree
There are several ways to navigate the context tree, perform actions, and edit object properties.
You can perform actions using the context toolbar, or you can select any object within the context
tree itself, and right-click the object to access a menu of options for that object. For example, if you
right-click the SiteScope node in the monitor tree, you select from a menu listing only those actions
that can performed on the SiteScope node. You can also perform actions on multiple groups and
monitors. For details, see "Perform Actions on Multiple Groups and Monitors" on page 101.
For details of the context tree objects and context menu options available for each object in the tree,
see "Monitor Tree" on page 43, "Remote Server Tree" on page 55, "Template Tree" on page 56,
"Preferences Menu" on page 64, "Server Statistics Menu" on page 66, and "Tools Menu" on page
67.
SiteScope Keyboard Shortcuts
You can perform the following commands in the monitor tree, template tree, and remote server tree
by pressing the corresponding shortcut keys:
Shortcut
Key
Description
CTRL+A
Opens the New Alert dialog box, enabling you to create a new alert. For user
interface details, see "New/Edit Alert Dialog Box" on page 1162.
CTRL+C
Copies the selected item and puts it on the Clipboard.
CTRL+D
Deletes the selected item.
CTRL+F
Opens the New Filter dialog box, enabling you to create a new filter. For user
interface details, see "New/Edit Filter Dialog Box" on page 96.
CTRL+G
Opens the New Group dialog box, enabling you to create a new group. For user
interface details, see "New SiteScope Group Dialog Box" on page 265.
CTRL+J
Opens the Select Template/Group dialog box, enabling you to select the template
that you want to deploy or the group to which you want to deploy a template. For
details on the Select Template user interface, see "Select Template Dialog Box" on
page 331. For details on the Select Group user interface, see "Select Group Dialog
Box" on page 843.
CTRL+M
Opens the New Monitor dialog box, enabling you to add a new monitor. For user
interface details, see "New Monitor Dialog Box" on page 280.
HP SiteScope (11.23)
Page 37 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Shortcut
Key
Description
CTRL+R
Clears the filter configured in the Filter dialog box. For user interface details, see
"New/Edit Filter Dialog Box" on page 96.
CTRL+V
Pastes the contents of the Clipboard to the selected location.
CTRL+X
Cuts the selected item and puts it on the Clipboard.
DELETE
Deletes the selection.
F5
Refreshes the tree.
UI Descriptions
Common Toolbar
The SiteScope common toolbar, located at the top of the SiteScope window, is accessible from all
contexts, and contains the following buttons:
UI Element
Description
Enables you to select the following page options:
l
Add to Favorites. Enables you to add the current SiteScope view to your
list of Favorites in your browser.
l
Save Layout to User Preferences. Enables you to save the current view
as the default layout for the specific SiteScope user.
Enables you to access SiteScope Help, context-sensitive help for specific
windows, and other additional online resources.
You can also see descriptions of user interface elements in most pages or
dialog boxes. To enable this feature, click the Quick Help
button in the
specific page or dialog box, and rest the mouse pointer on the element box to
display a Tool Tip description. To make this feature unavailable, click the
Quick Help button again.
Logs you out of your SiteScope session.
You can customize your view of the monitor tree to list only those SiteScope elements with which
you are working. You can also assign search/filter tags to your groups, monitors, reports, and alerts
to further refine your selection. For details on this topic, see "Filter SiteScope Objects" on page 95.
SiteScope enables you to change monitor configurations across multiple monitors, groups, or
multiple SiteScopes using Global Replace. For details on the Global Replace user interface, see
"Global Search and Replace" on page 106.
HP SiteScope (11.23)
Page 38 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Context Toolbar Buttons
The context toolbar enables you to perform common functions in the different SiteScope views.
To access
Select the Monitors, Remote Servers, or Templates context. The context
toolbar is displayed above the upper left pane.
Important
information
Some toolbar buttons are not available in all SiteScope views
See also
l
"Monitor Tree" on page 43
l
"Remote Server Tree" on page 55
l
"Template Tree" on page 56
User interface elements are described below:
UI
Element
Description
New. Adds SiteScope objects (groups, monitor, alerts, remote servers, and
templates) to the relevant tree. The objects that you can add depend on the context.
Edit. Enables you to select one of the following editing options:
l
Copy. Makes a copy of the selected object.
l
Paste. Copies or moves an object to the selected location in the tree.
l
Cut. Moves the selected object to another location in the tree.
l
Delete. Deletes the selected object from the tree.
Delete. Deletes the selected remote server from the tree.
Note: Available in the remote server tree toolbar only.
Test. Tests the connection to the server.
Note: Available in the remote server tree toolbar only.
DetailedTest. Runs a test that displays the result of running commands on the
remote server. This enables checking the permissions for the defined user.
Note: Available in the remote server tree toolbar for UNIX servers only.
HP SiteScope (11.23)
Page 39 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI
Element
Description
Filter. Filters the monitor tree to display only those SiteScope objects that meet the
criteria that you define.
Select a filter option:
l
New Filter. Opens the New Filter dialog box which enables you to create a filter.
For user interface details, see "New/Edit Filter Dialog Box" on page 96.
l
Clear Filter. Clears the filter settings.
l
<List of existing filters>. Displays a list of existing filters. The following options
are available:
n
Apply. Applies the filter to the left tree pane.
n
Edit. Opens the Edit Filter dialog box which enables you to edit the filter. For user
interface details, see "New/Edit Filter Dialog Box" on page 96.
n
Delete. Deletes the filter from the filter list.
Note: Available in the monitor tree toolbar only.
Manage Monitors and Groups. Enables you to perform an action (copy, move,
delete, run monitors, enable/disable monitors, enable/disable associated alerts) on
multiple groups and monitors in the monitor tree. You can also filter the list of objects
in the monitor tree. For details on the Manage Monitors and Groups dialog box, see
"Perform Actions on Multiple Groups and Monitors" on page 101.
Note: Available in the monitor tree toolbar only.
Collapse All. Collapses all branches in the tree.
Note: Available in the monitor and template tree toolbar only.
Expand All. Expands all branches in the tree.
Note: Available in the monitor and template tree toolbar only.
Refresh. Refreshes the data in the tree.
Show all. Displays hidden toolbar buttons.
HP SiteScope (11.23)
Page 40 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI
Element
Description
Quick Search. Enables you to search configuration objects (groups, monitors,
remote servers, templates, or counters) for a specific property name or value in the
monitor, template, remote server, or counters tree (in the monitor properties for some
browsable counter monitors).
Click the left end of the box to open the drop-down menu of filter options:
l
Select Case sensitive to search for the filter string exactly as entered. Select
Case insensitive to ignore the case of the filter string.
l
Select Use wild cards to use the wildcard symbol * in the filter string. Enables
you to use asterisk (*) characters in your search string in order to type only part of
the item.
l
Select Match from start to search for the filter string at the beginning of a property
name or value. Select Match exactly to search for the exact filter string. Select
Match anywhere to search for the filter string anywhere in the properties.
l
Select Match leaf node only to search for the filter string in leaf nodes (monitors
and empty groups only) in the tree. Clear to search all nodes.
l
Select Hide nodes without children to hide groups that have no leaf nodes that
match the filter string (empty groups).
l
Select Keep the children if any of their ancestors match to display all child
nodes of groups that match the filter string, even though the child does not match
the search string.
l
Select Use auto filter to search automatically after a letter is entered in the
search text field. You can configure a delay before the auto filter runs in
Preferences > Infrastructure Preferences > General Settings > Quick search
auto filter delay (milliseconds). The default delay is 800 milliseconds (0.8
seconds). If Use auto filter is not selected, you must press the Enter key every
time you want to run the search.
Tip: In a loaded environment, it is recommended to increase the delay time in
Quick search auto filter delay time, or to disable the Use auto filter option.
Note:
l
Quick search is only available in the following tree toolbars: monitor, template,
remote server, and counters tree (in monitor properties) .
l
If a filter is applied to a tree, the search is restricted to the records currently
displayed.
HP SiteScope (11.23)
Page 41 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI
Element
Description
Show/Hide Pane. (Between left and right panes) Shows or hides the tree, and
expands or contracts the right pane.
(Below context menus) Click to configure the context button display. The following
options are available:
l
Show More Buttons. Click to show the next highest ranking SiteScope context
button in the left pane. This button is available only if not all the context buttons
are displayed.
l
Show Fewer Buttons. Click to hide the lowest ranking SiteScope context button
from the left pane. This button is available only if at least one context button is
displayed.
l
Option. Choose the order in which the SiteScope context buttons are displayed.
Use the Move Up and Move Down buttons to rearrange the order. To hide a
button from the left pane, clear the check box for the context. By default, all the
context buttons are selected (displayed in the left pane).
l
Add or Remove Buttons. Shows the show/hide status of the context buttons.
By default, all the context buttons are selected (displayed in the left pane). To hide
a button, clear the check mark for the context.
Context Trees and Menu Options
l
"Monitor Tree" on the next page
l
"Remote Server Tree" on page 55
l
"Template Tree" on page 56
l
"Preferences Menu" on page 64
l
"Server Statistics Menu" on page 66
l
"Tools Menu" on page 67
Tabs
l
Dashboard Tab (see "SiteScope Dashboard" on page 1006)
l
Properties Tab (see "Common Monitor Settings" on page 298)
l
"Analytics Tab" on page 1278
l
"Alerts Tab" on page 70
HP SiteScope (11.23)
Page 42 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
l
"Reports Tab" on page 71
Context Buttons
SiteScope has the following contexts that are available from the left pane:
UI
Element Description
Enables you to create and manage SiteScope groups and monitors in a hierarchy
represented by a monitor tree. For user interface details, see "Monitor Tree" below.
Enables you to set up the connection properties so that SiteScope can monitor
systems and services running in remote Windows and UNIX environments. For user
interface details, see "Remote Server Tree" on page 55.
Enables you to use templates to deploy a standardized pattern of monitoring to
multiple elements in your infrastructure. You can use preconfigured SiteScope
solution template or create and manage your own templates. For user interface
details, see "Template Tree" on page 56.
Enables you to configure specific properties and settings related to most of the
administrative tasks within SiteScope. For user interface details, see "Preferences
Menu" on page 64.
Enables you to view key SiteScope server performance metrics. For user interface
details, see "Server Statistics Menu" on page 66.
Displays diagnostic tools that can help you troubleshoot problems in SiteScope and
facilitate monitor configuration. For details on the available tools, see "SiteScope
Tools" on page 123.
Monitor Tree
The monitor tree represents the organization of systems and services in your network environment.
The tree includes containers and objects within your infrastructure. The shortcut menu options
include descriptions of the context menu options available for each object in the monitor tree.
To access
Select the Monitors context. The monitor tree appears in the left pane.
Important
information
l
The root node of the tree is the SiteScope container. Only one SiteScope node
exists in the monitor tree. You add all other elements to the tree under the
SiteScope node.
l
You can search for objects in the monitor tree by selecting a node and typing
the characters you want to search in the popup search box. Click the ESC key
to close the search box.
See also
"Monitors and Groups" on page 261
HP SiteScope (11.23)
Page 43 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Monitor Tree Objects
User interface elements are described below:
UI
Element Description
Represents an individual SiteScope server.
Parent: Enterprise node or container.
Add to tree by: Importing or adding an empty SiteScope profile.
Represents a SiteScope monitor group or subgroup (with enabled monitors/with no
monitors or no enabled monitors).
If an alert has been set up for the monitor group or subgroup, the alert
appears next to the group icon.
symbol
If a Management report has been set up for the monitor group or subgroup, the report
symbol appears next to the group icon.
Parent: SiteScope or SiteScope group.
Add to tree by: Creating, or importing with a SiteScope that has groups defined.
Represents a SiteScope monitor (enabled/disabled).
If an alert has been set up for the monitor, the alert
monitor icon.
symbol appears next to the
If a Management report has been set up for the monitor, the report symbol appears
next to the monitor icon.
Parent: SiteScope group or subgroup, template, or solution template.
Add to tree by: Creating, or importing with a SiteScope that has monitors configured.
Represents the collection of available health monitors that are deployed to check
proper functioning of SiteScope monitors.
Parent: SiteScope.
Add to tree by: Automatically added with SiteScope object.
HP SiteScope (11.23)
Page 44 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
SiteScope Shortcut Menu Options
User interface elements are described below:
Menu Item (A-Z)
Description
Baselining
Enables you to create a baseline for monitoring variations
in response times and performance in the infrastructure for
all monitors under SiteScope.
l
Calculate. Enables you to select monitors, and specify
the relevant time and schedule to be used for
calculating the baseline. It also enables you to select
and fine-tune the baseline adherence level and define
boundaries.
l
Review & Activate. Displays a summary of calculated
monitors and baseline data. It also enables you to save
the current monitor configuration, view and retry failed
operations, view baseline measurement graphs, and
apply the baseline configuration.
l
Remove. Enables you to remove the baseline
threshold or recalculate the baseline after a baseline
has been calculated.
l
Status Report. Displays information about the
baseline status for all monitors under SiteScope.
For details on this topic, see "Set Monitor Thresholds
Using a Baseline" on page 340.
Deploy Template
Opens the Select Template dialog box that enables you to
select a template to deploy to the group. For user interface
details, see "Select Template Dialog Box" on page 331.
Deploy Template Using CSV
Opens the Select Template dialog box which enables you
to select a template to deploy to the group using a CSV
file. For user interface details, see "Select Template
Dialog Box" on page 331.
Expand All
Opens all the subtrees under SiteScope.
Global Search and Replace
Opens the Global Search and Replace Wizard, which
enables you to run a global search and replace for monitor,
alert, group, preferences, alert action, and report
properties. For details on this topic, see "Global Search
and Replace" on page 106.
HP SiteScope (11.23)
Page 45 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu Item (A-Z)
Description
Monitor Deployment Wizard
This menu item is available only to those users accessing
SiteScope from System Availability Management (SAM)
Administration in BSM. Opens the Monitor Deployment
Wizard. For details on this topic, see "Monitor Deployment
Wizard" in the BSM Application Administration Guide in
the BSM Help.
New > Alert
Opens the New Alert window which enables you to define
a new alert for SiteScope. For details on this topic, see
"Configure SiteScope Alerts" on page 1140.
New > Group
Opens the New Group window which enables you to
define a new SiteScope group. For user interface details,
see "New SiteScope Group Dialog Box" on page 265.
Paste
Pastes the selected SiteScope object (that was previously
copied or cut) to the SiteScope node.
Paste from other SiteScope
This menu item is available only through SAM
Administration when there is more than one SiteScope
connected to BSM. Pastes the selected SiteScope object
(that was previously copied or cut) from another SiteScope
to the SiteScope node.
Reports >
Enables you to select the type of SiteScope report you
Management/Quick/Monitor/Alert want to define. For details on these reports, see "Create
SiteScope Reports" on page 1211.
Note: The Monitor and Alert legacy reports also appear in
this menu if showlegacyReports is set to true in
Preferences > Infrastructure Preferences > Custom
Settings.
Reports > Server-Centric
Enables you to generate a Server-Centric report for any
remote server being monitored by a Microsoft Windows
Resources or UNIX Resources monitor, provided the
monitor has the Enable Server-Centric Report check
box selected. For details, see "Create Server-Centric
Reports" on page 1251.
Reports > BSM Configuration
Changes
This menu item is available only through SAM
Administration when the SiteScope is connected to BSM.
Displays a log of configuration changes made to BSM. For
details, see "Create SiteScope Reports" on page 1211.
HP SiteScope (11.23)
Page 46 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu Item (A-Z)
Description
Tools
Available when configuring or editing specific monitors
(provided you are an administrator in SiteScope, or a user
granted Use monitor tools permissions). If a tool is
available, click to open and run the tool with the monitor's
existing data as its input. The test results appear in the
Results pane. For details on the available tools, see
"SiteScope Tools" on page 123.
HP SiteScope (11.23)
Page 47 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Group Shortcut Menu Options
User interface elements are described below:
Menu Item (A-Z)
Description
Baselining
Enables you to create a baseline for monitoring variations
in response times and performance in the infrastructure for
all monitors in the group.
l
Calculate. Enables you to select monitors from the
group and specify the relevant time and schedule to be
used for calculating the baseline. It also enables you to
select and fine-tune the baseline adherence level and
define boundaries.
l
Review & Activate. Displays a summary of calculated
monitors and baseline data for the group. It also
enables you to save the current monitor configuration,
view and retry failed operations, view baseline
measurement graphs, and apply the baseline
configuration.
l
Remove. Enables you to remove the baseline
threshold or recalculate the baseline after a baseline
has been calculated.
l
Status Report. Displays information about the
baseline status for all monitors in the group.
For details on this topic, see "Set Monitor Thresholds
Using a Baseline" on page 340.
Copy
Copies the group and its contents (monitors, alerts, and
reports) to a monitor group or template.
Note: When copying a group that contains monitors with
baseline thresholds, the baseline thresholds are replaced
with static thresholds (which are the current percentile
values), and the monitors are no longer in baseline mode.
HP SiteScope (11.23)
Page 48 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu Item (A-Z)
Description
Copy to other SiteScope
This menu item is available only through SAM
Administration when there is more than one SiteScope
connected to BSM. Copies the group and its contents
(monitors, alerts, and reports) from another SiteScope to a
monitor group or template in the SiteScope node.
Note: When copying several monitors which have
dependencies between them to other SiteScopes, copy
them together with the group container in case it is
required to keep the dependency between them.
Copy to Template
Copies the group and its contents (monitors, alerts, and
reports) to a template group. For details on this topic, see
"How to Create a Template by Copying Existing
Configurations" on page 790.
Cut
Moves the group and its contents (monitors, alerts, and
reports) or a monitor and its contents (alerts and reports) to
a monitor group.
Note: When moving a group that contains monitors with
baseline thresholds, the baseline thresholds are replaced
with static thresholds (which are the current percentile
values), and the monitors are no longer in baseline mode.
Delete
Deletes the group.
Note: You cannot delete a group if it has dependent alerts
or reports at the container level. To delete a group with
dependencies, you must remove the group from Alert
Targets and Report Targets for each dependency, and
then delete the group. You can delete groups that have
dependencies at the child level.
Deploy Template
Opens the Select Template dialog box that enables you to
select a template to deploy to the group. For user interface
details, see "Select Template Dialog Box" on page 331.
Deploy Template Using CSV
Opens the Select Template dialog box which enables you
to select a template to deploy to the group using a CSV
file. For user interface details, see "Select Template
Dialog Box" on page 331.
HP SiteScope (11.23)
Page 49 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu Item (A-Z)
Description
Enable/Disable Monitor
Opens the Enable/Disable Monitors in Group dialog box
which enables you to enable or disable monitors in the
group, regardless of the setting in the monitor properties. If
you select Disable, the monitors are disabled until you
return to this dialog box and select Enable. For details on
the Enable/Disable Monitor user interface, see
"Enable/Disable Monitors in Group Dialog Box" on page
1029.
Expand All
Opens all the subtrees under the group.
Global Search and Replace
Opens the Global Search and Replace Wizard, which
enables you to run a global search and replace for monitor,
alert, group, preferences, alert action, and report
properties. For details on this topic, see "Global Search
and Replace" on page 106.
Monitor Deployment Wizard
This menu item is available only to those users accessing
SiteScope from SAM Administration in BSM. Opens the
Monitor Deployment Wizard. For details on this topic, see
"Monitor Deployment Wizard" in the BSM Application
Administration Guide in the BSM Help.
New > Alert
Opens the New Alert window which enables you to define
a new alert for the group. For details on this topic, see
"Configure SiteScope Alerts" on page 1140.
New > Group
Opens the New Group window which enables you to
define a new SiteScope group. For user interface details,
see "New SiteScope Group Dialog Box" on page 265.
New > Monitor
Opens the New Monitor window which enables you to
define a new SiteScope monitor. For user interface details,
see "New Monitor Dialog Box" on page 280.
Paste
Pastes the selected group and its contents (monitors,
alerts, and reports) or a monitor and its contents (alerts
and reports) to the specified monitor group.
Paste from other SiteScope
This menu item is available only through SAM
Administration when there is more than one SiteScope
connected to BSM. Pastes the selected group and its
contents (monitors, alerts, and reports) or a monitor and its
contents (alerts and reports) from another SiteScope to the
specified monitor group.
HP SiteScope (11.23)
Page 50 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu Item (A-Z)
Description
Reports >
Enables you to select the type of SiteScope report you
Management/Quick/Monitor/Alert want to define. For details on this topic, see "Create
SiteScope Reports" on page 1211.
Note: The Monitor and Alert legacy reports also appear in
this menu if showlegacyReports is set to true in
Preferences > Infrastructure Preferences > Custom
Settings.
Reports > Server-Centric
Enables you to generate a Server-Centric report for any
remote server being monitored by a Microsoft Windows
Resources or UNIX Resources monitor within the
specified monitor group, provided the monitor has the
Enable Server-Centric Report check box selected. For
details, see "Create Server-Centric Reports" on page
1251.
Run Monitors
Runs any monitors configured in the group, and opens an
information window with the results.
HP SiteScope (11.23)
Page 51 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Monitor Shortcut Menu Options
User interface elements are described below:
Menu Item (A-Z)
Description
Baselining
Enables you to create a baseline for monitoring variations
in response times and performance in the infrastructure for
the specific monitor.
l
Calculate. Enables you to select the monitor and
specify the relevant time and schedule to be used for
calculating the baseline. It also enables you to select
and fine-tune the baseline adherence level and define
boundaries.
l
Review & Activate. Displays a summary of the
calculated monitor's baseline data. It also enables you
to save the current monitor configuration, view and
retry failed operations, view baseline measurement
graphs, and apply the baseline configuration.
l
Remove. Enables you to remove the baseline
threshold or recalculate the baseline after a baseline
has been calculated.
l
Status Report. Displays information about the
monitor's baseline status.
For details on this topic, see "Set Monitor Thresholds
Using a Baseline" on page 340.
Copy
Copies the monitor and its contents (alerts and reports) to
a monitor group or template.
Note: When copying a monitor with baseline thresholds,
the baseline thresholds are replaced with static thresholds
(which are the current percentile values), and the monitor
is no longer in baseline mode.
Copy to other SiteScope
This menu item is available only through SAM
Administration when there is more than one SiteScope
connected to BSM. Copies the monitor and its contents
(alerts and reports) from another SiteScope to a monitor
group or template.
Note: When copying several monitors which have
dependencies between them to other SiteScopes, copy
them together with the group container in case it is
required to keep the dependency between them.
HP SiteScope (11.23)
Page 52 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu Item (A-Z)
Description
Copy to Template
Copies the monitor and its contents (alerts and reports) to
a template group. For details on this topic, see "How to
Create a Template by Copying Existing Configurations" on
page 790.
Cut
Moves the monitor and its contents (alerts and reports) to
a monitor group.
Note: When moving a monitor with baseline thresholds,
the baseline thresholds are replaced with static thresholds
(which are the current percentile values), and the monitor
is no longer in baseline mode.
Delete
Deletes the monitor.
Note: You cannot delete a monitor if it has dependent
alerts or reports at the container level. To delete a monitor
with dependencies, you must remove the monitor from
Alert Targets and Report Targets for each dependency,
and then delete the monitor. You can delete monitors that
have dependencies at the child level.
Enable/Disable Monitor
Opens the Enable/Disable Monitors in Group dialog box
which enables you to enable or disable the monitor,
regardless of the setting in the monitor properties. If you
select Disable, the monitor is disabled until you return to
this dialog box and select Enable. For details on the
Enable/Disable Monitor user interface, see
"Enable/Disable Monitors in Group Dialog Box" on page
1029.
Global Search and Replace
Opens the Global Search and Replace Wizard, which
enables you to run a global search and replace for monitor,
alert, group, preferences, alert action, and report
properties. For details on this topic, see "Global Search
and Replace" on page 106.
New > Alert
Opens the New Alert window which enables you to define
a new alert for the monitor. For details on this topic, see
"Configure SiteScope Alerts" on page 1140.
Paste
Pastes the selected monitor context object to the
specified monitor.
Paste from other SiteScope
This menu item is available only through SAM
Administration when there is more than one SiteScope
connected to BSM. Pastes the selected monitor context
object from another SiteScope to the specified monitor.
HP SiteScope (11.23)
Page 53 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu Item (A-Z)
Description
Predictive Analytics
l
l
New Predictive Analytics. Enables you to configure
analytics for the selected monitor. This menu item is
available only if:
n
Analytics is enabled in Infrastructure Preferences
> Analytics Settings > Analytics enabled (this is
the default setting).
n
The monitor is not of an excluded type that is listed
in Infrastructure Preferences > Analytics
Settings > Excluded monitor types.
Delete Predictive Analytics. Enables you to remove
predictive analytics from the selected monitor. This
menu item is available only if analytics have been
configured for the selected monitor.
For details on this topic, see "Configure Predictive
Analytics" on page 1261.
Reports >
Enables you to select the type of SiteScope report you
Management/Quick/Monitor/Alert want to define. For details on this topic, see "Create
SiteScope Reports" on page 1211.
Note: The Monitor and Alert legacy reports also appear in
this menu if showlegacyReports is set to true in
Preferences > Infrastructure Preferences > Custom
Settings.
Reports > Server-Centric
Enables you to generate a Server-Centric report for any
remote server being monitored by a Microsoft Windows
Resources or UNIX Resources, provided the monitor has
the Enable Server-Centric Report check box selected.
For details, see "Create Server-Centric Reports" on page
1251.
Run Monitor
Runs the monitor and opens an information window with
the results.
HP SiteScope (11.23)
Page 54 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
SiteScope Health Shortcut Menu Options
User interface elements are described below:
Menu Item
(A-Z)
Description
Disable
Logging
Disables logging SiteScope server health data to the daily log file. For details
on SiteScope server health, see "SiteScope Server Health" on page 1052.
Enable
Logging
Enables logging SiteScope server health data to the daily log file. For details
on SiteScope server health, see "SiteScope Server Health" on page 1052.
Expand All
Opens all the subtrees under SiteScope Health.
New > Alert
Opens the New Alert window which enables you to define a new alert for
Health. For details on this topic, see "Configure SiteScope Alerts" on page
1140.
New > Group
Opens the New Group window which enables you to define a new SiteScope
group. For user interface details, see "New SiteScope Group Dialog Box" on
page 265.
New > Monitor
Opens the New Monitor window which enables you to define a new SiteScope
monitor. For user interface details, see "New Monitor Dialog Box" on page
280.
Paste
Pastes monitors and monitor groups into the Health container.
Recreate
missing health
monitors
Enables you to restore health monitors that have been deleted from the
Health container.
Reports
Enables you to select the type of SiteScope report you want to define. For
details on this topic, see "Create SiteScope Reports" on page 1211.
Run Monitors
Runs the health monitors and opens an information window with the results.
Remote Server Tree
The remote server tree represents the remote servers configured in your network environment. The
shortcut menu options include descriptions of the context menu options available for each object in
the remote server tree.
To
access
Select the Remote Servers context. The remote server tree appears in the left
pane.
See also
"Remote Servers Properties Page" on page 554
HP SiteScope (11.23)
Page 55 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Remote Server Tree Objects
User interface elements are described below:
UI Element Description
Represents the Windows/UNIX remote server container in the remote server
view.
Represents a Windows/UNIX remote server.
Parent: Windows/UNIX Remote Server container.
Add by: Creating in the Windows/UNIX Remote Server container or template
tree.
Remote Servers Shortcut Menu Options
User interface elements are described below:
Menu Item (A-Z)
Description
New Microsoft
Windows/UNIX Remote
Server
Opens the New Server window which enables you to define a
new Microsoft Windows or UNIX server.
Remote Server Shortcut Menu Options
User interface elements are described below:
Menu
Item
(A-Z)
Description
Copy to
Copies the remote server to a template group. For details on this topic, see "How to
Template Create a Template by Copying Existing Configurations" on page 790.
Delete
Deletes the remote server
Detailed
Test
Enables you to test the running commands on the remote host and check the
permissions for the defined user. Available for UNIX servers only.
Test
Enables you to test the connection to the remote server.
Template Tree
The template tree represents user-defined templates, SiteScope solution template sets, template
examples, and Monitor Deployment Wizard templates that are available for deployment to monitor
groups. The shortcut menu options include descriptions of the context menu options available for
each object in the template tree.
To access
Select the Templates context. The template tree appears in the left pane.
HP SiteScope (11.23)
Page 56 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
See also
l
"SiteScope Templates" on page 771
l
"Deploy Solution Templates" on page 882
l
"SiteScope Templates Page" on page 796
l
"Templates Tree - Alerts Tab" on page 798
Template Tree Objects
User interface elements are described below:
UI
Element
Description
Represents an individual SiteScope server.
Parent: Enterprise node or container.
Add to tree by: Importing or adding an empty SiteScope profile.
Represents a solution template container (available/unavailable). Only licensed
solution templates that have the available icon are configurable solution templates.
Parent: SiteScope.
Represents a template container. A template container is used to organize
configuration deployment templates.
Parent: SiteScope.
Add to template tree by: Creating, or importing with a SiteScope that has
template containers defined.
Represents a template configuration for deploying SiteScope objects.
Parent: Template container.
Add to template tree by: Creating.
Represents a SiteScope template group or subgroup (with enabled monitors/with
no monitors or no enabled monitors).
If an alert has been set up for the template group or subgroup, the alert
appears next to the group icon.
symbol
If a Management report has been set up for the template group or subgroup, the
report symbol appears next to the group icon.
Parent: Template.
Add to tree by: Creating, or importing with a SiteScope that has template groups
defined.
HP SiteScope (11.23)
Page 57 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI
Element
Description
Represents a SiteScope template monitor (enabled/disabled).
If an alert has been set up for the template monitor, the alert
to the monitor icon.
symbol appears next
If a Management report has been set up for the template monitor, the report
symbol appears next to the monitor icon.
Parent: Template group or subgroup, template, or solution template.
Add to tree by: Creating, or importing with a SiteScope that has template monitors
configured.
Represents a Windows/UNIX remote server.
Parent: Template.
Add by: Creating in the remote server tree or template tree.
Represents a variable used as placeholder to prompt for input when deploying a
template.
Parent: Template.
Add to template tree by: Creating.
SiteScope Root - Shortcut Menu Options
User interface elements are described below:
Menu
Item (A-Z) Description
Expand
All
Opens all the subtrees under SiteScope.
Import
Opens the Content Import dialog box which enables you to import a template file, or
a content package that can include one or more templates and their dependencies
(for example, templates.os files, .jar files, and .conf files). For details, see "Content
Import Dialog Box" on page 834.
New >
Opens the New Template Container window which enables you to define a new
Template template container.
Container
Paste
Pastes a template container under the SiteScope root.
HP SiteScope (11.23)
Page 58 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Solution Template Container - Shortcut Menu Options
User interface elements are described below:
Menu Item (A-Z)
Description
Expand All
Expands the solution templates container to display all the solution
templates within the container.
Solution Template - Shortcut Menu Options
User interface elements are described below:
Menu
Item
(A-Z)
Description
Copy
Copies a solution template. You can paste the solution template to a template
container in the template tree.
Deploy
Template
Opens the Select Group dialog box which enables you to select the group to which
to deploy the solution template. For user interface details, see "Select Group Dialog
Box" on page 843.
Deploy
Template
Using
CSV
Opens the Select Group dialog box which enables you to select the group to which
to deploy the template using a CSV file. For user interface details, see "Select
Group Dialog Box" on page 843.
Expand
All
Expands the solution templates container to display all the solution templates within
the container.
Generate
XML
Opens the Generate Auto Deployment XML window which enables you to create an
XML file to use for automatically deploying the solution template. For details, see
"Automatic Template Deployment Using an XML File" on page 862.
Template Container - Shortcut Menu Options
User interface elements are described below:
Menu
Item (A-Z) Description
Copy
Copies the template container and its contents. You can paste the template
container under the SiteScope root or a selected template container in the template
tree.
Cut
Moves the template container and its contents. You can paste the template
container under the SiteScope root or a selected template container in the template
tree.
Delete
Deletes the template container.
HP SiteScope (11.23)
Page 59 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu
Item (A-Z) Description
Deploy
Template
Opens the Select Group dialog box which enables you to select the group to which
to deploy one or multiple templates. For user interface details, see "Select Group
Dialog Box" on page 843.
Expand
All
Expands the templates container to display all the template objects within the
container.
Export >
Template
Opens the Export Template window which enables you to export a template file. For
details, see "Export Template Dialog Box" on page 828.
Export >
Content
Package
Opens the Export Content Package Wizard which enables you to export one or
more templates and their dependencies to a content package file. Content
packages are required for sharing Custom monitors, or monitors with extension files
like scripts or alert files, with other SiteScope users. For details, see "Export
Content Package Wizard" on page 829.
Generate
XML
Opens the Generate Auto Deployment XML window which enables you to create an
XML file to use for automatically deploying the templates in the container.
Import
Opens the Content Import dialog box which enables you to import a template file, or
a content package that can include one or more templates and their dependencies
(for example, templates.os files, .jar files, and .conf files). For details, see "Content
Import Dialog Box" on page 834.
New >
Template
Opens the New Container window which enables you to define a new template.
New >
Opens the New Template Container window which enables you to define a new
Template template container.
Container
Paste
Pastes a template or template container into the template container.
Template - Shortcut Menu Options
User interface elements are described below:
Menu
Item
(A-Z)
Description
Copy
Copies the template and its contents. You can paste the template to a template
container in the template tree.
Cut
Moves the template and its contents. You can paste the template to a template
container in the template tree.
Delete
Deletes the template.
HP SiteScope (11.23)
Page 60 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu
Item
(A-Z)
Description
Deploy
Template
Opens the Select Group dialog box which enables you to select the group to which to
deploy the template. For user interface details, see "Select Group Dialog Box" on
page 843.
Deploy
Template
Using
CSV
Opens the Select Group dialog box which enables you to select the group to which to
deploy the template using a CSV file. For user interface details, see "Select Group
Dialog Box" on page 843.
Expand
All
Opens all the subtrees under the template.
Export >
Template
Opens the Export Template window which enables you to export a template file. For
details, see "Export Template Dialog Box" on page 828.
Export >
Content
Package
Opens the Export Content Package Wizard which enables you to export one or more
templates and their dependencies to a content package file. Content packages are
required for sharing Custom monitors, or monitors with extension files like scripts or
alert files, with other SiteScope users. For details, see "Export Content Package
Wizard" on page 829.
Export to
OM
Exports the template to Operations Manager (HPOM). This enables SiteScope
templates and monitors to be configured through the HPOM policy assignment and
deployment. For more details, see the section on Centralized Template
Management from HPOM in Integrating SiteScope with HP Operations Manager
Products in the SiteScope Help. You can check the HP Software Integrations site to
see if a more updated version of this guide is available (for Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39; for UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
Note: This menu option is available only if:
l
HPOM and SiteScope are installed on the same machine, and SiteScope is
connected to a supported version of HPOM. For the HPOM versions supported in
this SiteScope release, refer to the HP SiteScope Support Matrices section in the
SiteScope Deployment Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_
Documentation.htm).
l
The HP Operations agent is installed on the SiteScope server. It can be installed
either during SiteScope installation or by using the SiteScope Configuration Tool.
For details, see SiteScope Deployment Guide.
l
HP Operations Manager integration is configured in SiteScope and the Enable
exporting templates to HP Operations Manager check box is selected in HP
Operations Manager Integration Main Settings.
HP SiteScope (11.23)
Page 61 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Menu
Item
(A-Z)
Description
New >
Group
Opens the New Group window, which enables you to define a new template group.
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
Note: This menu item is available only if the template does not already contain a
template group.
New >
UNIX
Server
Opens the New UNIX Remote Server window, which enables you to define a new
remote UNIX template.
New >
Variable
Opens the New Variable window, which enables you to define a new template
variable.
Note: This menu item is available only if the template does not already contain a
remote server.
New >
Opens the New Microsoft Windows Remote Server window, which enables you to
Microsoft define a new remote Windows template.
Windows
Note: This menu item is available only if the template does not already contain a
Server
remote server.
Paste
Pastes a template group, monitor, or alert to a template.
Publish
Changes
Opens the Publish Template Changes wizard, which enables you to check deployed
groups for template compliancy and to update SiteScope objects deployed by
templates whenever the template is updated.
Template Variable - Shortcut Menu Options
User interface elements are described below:
Menu Item
(A-Z)
Description
Copy
Copies the template variable. You can paste the template variable to a template
in the template tree.
Cut
Moves the template variable. You can paste the template variable to a template
in the template tree.
Delete
Deletes the template variable.
HP SiteScope (11.23)
Page 62 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Template Remote - Shortcut Menu Options
User interface elements are described below:
Menu
Item
(A-Z)
Copy
Description
Copies the template remote server. You can paste the template remote server to a
template in the template tree.
Note: You can add only one template remote server to a template. This does not
apply to templates created in older versions of SiteScope.
Cut
Moves the template remote server. You can paste the template remote server to a
template in the template tree.
Note: You can add only one template remote server to a template. This does not
apply to templates created in older versions of SiteScope.
Delete
Deletes the template remote.
Template Group - Shortcut Menu Options
User interface elements are described below:
Menu
Item
(A-Z)
Description
Copy
Copies the template group and its contents (monitors, alerts, and subgroups). You can
paste the template group to a template in the template tree.
Cut
Moves the template group and its contents (monitors, alerts, and subgroups). You can
paste the template group to a template in the template tree.
Delete
Deletes the template group.
Expand
All
Opens all the subtrees under the template group.
New >
Alert
Opens the New Alert window which enables you to define a new alert for the template
group. For details on this topic, see "Configure SiteScope Alerts" on page 1140.
New >
Group
Opens the New Group window which enables you to define a new template subgroup.
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
New >
Opens the New Monitor window which enables you to define a new SiteScope monitor
Monitor for the template group. For user interface details, see "New Monitor Dialog Box" on
page 280.
Paste
Pastes the selected template group and its contents (monitors, alerts, and subgroups)
to a template.
HP SiteScope (11.23)
Page 63 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Template Monitor - Shortcut Menu Options
User interface elements are described below:
Menu
Item
(A-Z)
Description
Copy
Copies the template monitor and its contents (alerts). You can paste the template
monitor to a template group in the template tree.
Cut
Moves the template monitor and its contents (alerts). You can paste the template
monitor to a template group in the template tree.
Delete
Deletes the template monitor.
New >
Alert
Opens the New Template Alert window which enables you to define a new alert for the
template monitor. For details on this topic, see "Configure SiteScope Alerts" on page
1140.
Paste
Pastes the selected template monitor and its contents (alerts) to a template group.
Preferences Menu
The Preferences menu represents the preference types that enable you to configure specific
properties and settings related to most of the administrative tasks available within SiteScope.
To access
Select the Preferences context. The Preferences menu options are displayed in
the left pane.
Important
Only an administrator, or a user granted Edit <preference type> permissions,
information can create or make changes to SiteScope Preferences. For details on user
permissions, see "User Management Preferences" on page 726.
HP SiteScope (11.23)
Page 64 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI Element
Description
<Preference
types>
l
Certificate Management. Use to add and remove server certificates and
reload the keystore, without having to restart SiteScope after each certificate
change operation. For details, see "Certificate Management" on page 557.
l
Common Event Mappings. Use to create event mapping instances between
SiteScope runtime data and the event attribute values that are sent to the
HPOM/BSM server. For details, see "Common Event Mappings" on page 562.
l
Credential Preferences. Use to create and manage credentials for SiteScope
resources. For details, see "Credential Preferences" on page 572.
l
Email Preferences. Use to define email server settings and profiles for
SiteScope emails alert and status reports. For details, see "Email
Preferences" on page 580.
l
General Preferences. Use to perform post-configuration tasks, such as enter
standard and optional SiteScope license keys, control display functions, and
set security options. For details, see "General Preferences" on page 586.
l
High Availability Preferences. Use to configure behavior for SiteScope
Failover, a separate installation of SiteScope that is designed to automatically
assume the functions of a SiteScope system if the system fails or is
temporarily taken out of service. For details, see "High Availability
Preferences" on page 604.
l
HTTP Preferences. Use to define settings that are used by SiteScope when
sending event data to management consoles using the Generic Events
integration. For details, see "HTTP Preferences" on page 596.
l
Infrastructure Preferences. Use to define the values of global settings in
SiteScope. For details, see "Infrastructure Preferences" on page 615.
l
Integration Preferences. Use to configure SiteScope as a data collector for
BSM. For details, see "Integration Preferences" on page 657.
l
Log Preferences. Use to controls the accumulation and storage of monitor
data logs. For details, see "Log Preferences" on page 697.
l
Pager Preferences. Use to configure settings and additional pager profiles
that SiteScope uses for sending Pager alerts. For details, see "Pager
Preferences" on page 703.
l
Schedule Preferences. Use for customizing the operation of SiteScope
monitors and alerts to run only at specific times or during specific time periods.
For details, see "Schedule Preferences" on page 708.
l
Search/Filter Tags. Use to manage the Search/Filter tags defined in
SiteScope. You can assign tags to one or more items in the context trees and
HP SiteScope (11.23)
Page 65 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI Element
Description
preference profiles, and then use the tags as an object for a filter. For details,
see "Search/Filter Tags" on page 714.
l
SNMP Preferences. Use to define settings that are used by SiteScope
SNMP Trap alerts when sending data to management consoles. For details,
see "SNMP Preferences" on page 717.
l
User Management Preferences. Use to define and manage user login
profiles that control how others access SiteScope. For details, see "User
Management Preferences" on page 726.
Server Statistics Menu
The Server Statistics menu enables you to view an overview of several key SiteScope server
performance statistics. This includes the load on the SiteScope server, a list of currently running
monitors and the most recently run monitors, perfex pool summary and statistics, WMI statistics,
SSH connections, Telnet connections, and dynamic monitoring statistics. It also displays the
SiteScope log files.
To access
Select the Server Statistics context. The Server Statistics menu options appear
in the left pane.
Important
Only an administrator, or a user granted View server statistics permissions, can
information view the monitor performance data pages. For details on user permissions, see
"User Management Preferences" on page 726.
Relevant
tasks
"How to Analyze SiteScope Server Statistics" on page 1082
See also
"SiteScope Server Statistics" on page 1078
HP SiteScope (11.23)
Page 66 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
User interface elements are described below:
UI
Element
Description
<Menu
The following are the available monitor performance data options in SiteScope:
options>
l Dynamic Monitoring Statistics. Displays statistics when using the dynamic
monitoring mechanism to automatically update dynamic monitoring counters and
thresholds. For details of the user interface, see "Dynamic Monitoring Page" on
page 1090.
l
General. Displays SiteScope server statistics, including the load on the
SiteScope server (number of running monitors, waiting monitors, monitor runs per
minute), and a list of running monitors by type. For details, see "General Page" on
page 1092.
l
Log Files. Displays the list of log files in SiteScope that are useful for
understanding SiteScope performance issues, for troubleshooting monitor and
alert problems, and for reviewing SiteScope management actions. For details of
the user interface, see "Log Files Page" on page 1093.
l
Perfex Processes Pool. Displays the process manager summary, and pool
statistics and status tables for each pool. For details, see "Perfex Process Pool
Page" on page 1099.
l
Running Monitors. Displays a list of which SiteScope monitors are running, and
which monitors have run recently, at what time, and what was the returned status.
For details, see "Running Monitors Page" on page 1101.
l
SSH Connections. Displays Secure Shell (SSH) statistics and a summary of
SSH connections when using SSH to connect to remote UNIX or Windows
servers. For details, see "SSH Connections Page" on page 1102.
l
Telnet Connections. Displays telnet statistics when using telnet to connect to
remote UNIX or Windows servers. For details of the user interface, see "Telnet
Connections Page" on page 1104.
l
WMI Statistics. Displays the process manager summary for Windows
Management Instrumentation (WMI) statistics. For details, see "WMI Statistics
Page" on page 1105.
Tools Menu
The Tools menu displays a list of diagnostic tools that can help you troubleshoot problems in
SiteScope and facilitate monitor configuration.
To access
HP SiteScope (11.23)
Select the Tools context. The Tools menu options are displayed in the left
pane.
Page 67 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
Important
information
l
To view or use the tools in the Tools context in the left pane, you must be
an administrator in SiteScope, or a user granted Use tools permissions.
For details on user permissions, see "User Management Preferences" on
page 726.
l
Some tools are also available when configuring or editing specific monitors
(provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions). If a tool is available when configuring or
editing a monitor (see "Testing Monitor Configuration Using Diagnostic
Tools" on page 1008), you can access the tool by:
l
See also
n
Clicking the Use Tool
button in the new monitor dialog box when
configuring a new monitor, or in the monitor Properties tab when
configuring an existing monitor.
n
Clicking the Tools button in the SiteScope Dashboard toolbar when
running the test tool for an existing monitor. This opens and runs the tool
with the monitor's existing data as its input, and displays test results in the
Results pane.
To avoid character set problems when the SiteScope client uses a
multibyte locale different from the SiteScope server, set the value in the
<SiteScope root directory>\groups\master.config file for the _
httpCharset setting to UTF-8. By default, the _httpCharset value is
empty, which means that the default server locale is used.
"SiteScope Tools" on page 123
The following tools are included (unlabeled elements are shown in angle brackets):
UI Element
Description
Application Tools
Microsoft
Windows
Media Player
Tool
Tests Microsoft Windows Media Player streaming. For more information, see
"Microsoft Windows Media Player Tool" on page 146.
News Server
Tool
Checks whether a News Server is operational. For more information, see
"News Server Tool" on page 148.
Real Media
Player Tool
Tests Real Media Player streaming. For more information, see "Real Media
Player Tool" on page 153.
Common Utility Tools
Regular
Expression
Tool
HP SiteScope (11.23)
Tests a regular expression for content matching against a sample of the
content you want to monitor. For more information, see "Regular Expression
Tool" on page 154.
Page 68 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI Element
Description
XSL
Tests custom XSL transformation of XML data to be monitored with the
Transformation Browsable XML Monitor. For more information, see "XSL Transformation
Tool
Tool" on page 176.
Log Analysis
Tool
Analyze patterns in a log file and provides a list of all reoccurring patterns.
Each pattern can be transferred into a regular expression that can be used in
the Log File monitor. For more information, see "Log Analysis Tool" on page
141.
SiteScope Log
Grabber Tool
Retrieves and displays the SiteScope log and configuration files. For more
information, see "SiteScope Log Grabber Tool" on page 157.
Database Tools
Database
Connection
Tool
Checks connectivity and configuration of JDBC or ODBC database
connections. For more information, see "Database Connection Tool" on page
127.
Database
Information
Tool
Retrieves and displays database server metadata such as product and driver
version, SQL compatibility level information, and supported SQL functions.
For more information, see "Database Information Tool" on page 130.
LDAP
Authentication
Status Tool
Tests an LDAP server by requesting a user authentication. For more
information, see "Link Check Tool" on page 138.
Mail Tools
Mail Round
Trip Tool
Tests a mail server by sending and retrieving a test message. For more
information, see "Mail Round Trip Tool" on page 144.
Network Tools
DNS Tool
Tests a DNS server to verify that it can resolve a domain name. For more
information, see "DNS Tool" on page 131.
Network Status
Tool
Displays the server's network interface status and active connections. For
more information, see "Network Status Tool" on page 147.
Note: This tool is not supported on SiteScopes installed on UNIX platforms.
Ping Tool
Performs a round-trip Ping test across the network. For more information, see
"Ping Tool" on page 151.
Trace Route
Tool
Performs a traceroute from your server to another location. For more
information, see "Trace Route Tool" on page 166.
Operating System Tools
HP SiteScope (11.23)
Page 69 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
UI Element
Description
Event Log Tool Displays portions of the Windows Event Log locally or on a remote server. For
more information, see "Event Log Tool" on page 132.
Note: This tool is not supported on SiteScopes installed on UNIX platforms.
Performance
Counters Tool
Checks connectivity to and values in Windows Performance Counter
registries. For more information, see "Performance Counters Tool" on page
149.
Note: This tool is not supported on SiteScopes installed on UNIX platforms.
Processes
Tool
Shows a list of currently running processes either locally or on a remote
server. For more information, see "Processes Tool" on page 152.
Services Tool
Shows a list of currently running Windows Services. For more information,
see "Services Tool" on page 156.
Note: This tool is not supported on SiteScopes installed on UNIX platforms.
SNMP Tools
SNMP Browser Browses an SNMP MIB and displays available OIDs. For more information,
Tool
see "SNMP Browser Tool" on page 159.
SNMP Tool
Performs a SNMP get command to a specified SNMP host to retrieve a list of
OIDs. For more information, see "SNMP Tool" on page 161.
SNMP Trap
Tool
Displays the log of SNMP Traps received by SiteScope from SNMP-enabled
devices. For more information, see "SNMP Trap Tool" on page 165.
Web Tools
FTP Tool
Checks the availability of an FTP server and whether a file can be retrieved.
For more information, see "FTP Tool" on page 134.
Link Check
Tool
Checks the availability of all internal and external links on a Web page to
ensure that they can be reached. For more information, see "Link Check Tool"
on page 138.
URL Tool
Requests a URL from a server and prints the returned data. For more
information, see "URL Tool" on page 167.
Web Service
Tool
Tests the availability of SOAP enabled Web Services. For more information,
see "Web Service Tool" on page 170.
Alerts Tab
The Alerts tab displays information about the alerts associated with the selected monitor or group.
Use this tab to add, edit, or delete alert definitions.
The Alerts tab shortcut menu options include descriptions of the context menu options available for
alerts.
HP SiteScope (11.23)
Page 70 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
To access
Select the Monitors or Templates context, and then click the Alerts tab in the
right pane.
See also
"Configure SiteScope Alerts" on page 1140
User interface elements are described below:
Menu Item
(A-Z)
Description
Copy
Copies the alert to the selected location in the monitor tree.
Note: Available for alerts in the Alerts on Monitor/Group table only.
Copy to
other
SiteScope
This menu item is available only through SAM Administration when there is more
than one SiteScope connected to BSM. Copies the alert from another SiteScope
to the selected location in the monitor tree.
Delete
Deletes the alert.
Disable
Alert
Disables the alert.
Edit Alert
Opens an editing window for the alert, which enables you to edit its settings.
Enable
Alert
Enables the alert.
New Alert
Opens the New Alert dialog box, which enables you to create a new alert
definition. For details on how to perform this task, see "Configure SiteScope
Alerts" on page 1140.
Note: Available for alerts in the Alerts on Monitor/Group table only.
Paste
Pastes the selected alert.
Note: Available for alerts in the Alerts on Monitor/Group table only.
Show All
Displays all descendent alerts of the selected node.
Descendant
Alerts
Show Child Displays only those alerts that are direct children of the selected node.
Alerts
Test
Opens the Test Alert dialog box which enables you to test the alert.
Reports Tab
The Reports tab displays information about the reports defined in SiteScope. Use this page to add,
edit, or delete report definitions.
The Reports tab shortcut menu options include descriptions of the options available for
Management reports in the monitor tree.
HP SiteScope (11.23)
Page 71 of 1293
Using SiteScope
Chapter 5: Navigate SiteScope
To access
Select the Monitors or Templates context, and then click the Reports tab in
the right pane.
See also
"Create SiteScope Reports" on page 1211
User interface elements are described below:
Menu Item (A-Z) Description
Clear Selection
Clears the selection.
Copy Report
Copies the report to the selected location in the monitor tree.
Note: Available for reports in the Reports on Monitor/Group table only.
Create New
Report
Enables you to select the type of SiteScope report you want to create. For
details on this topic, see "SiteScope Report Types" on page 1211.
Note:
l
Available for reports in the Reports on Monitor/Group table only.
l
Only Management reports are added to the Reports tab.
Delete Report
Deletes the report.
Edit Report
Opens an editing window for the report, which enables you to edit its settings.
Generate
Report
Generates the report.
Paste Report
Pastes the selected report.
Note: Available for reports in the Reports on Monitor/Group table only.
Select All
Selects all the listed reports.
Show All
Descendant
Reports
Displays all descendent reports of the selected node.
Show Child
Reports
Displays only those reports that are direct children of the selected node.
HP SiteScope (11.23)
Page 72 of 1293
Chapter 6: Set Up and Administer SiteScope
This task describes a suggested working order for preparing to use SiteScope.
Note: If you are using SiteScope Failover to provide backup infrastructure monitoring
availability, for a suggested working order, see the HP SiteScope Failover Guide ((<SiteScope
root directory>\sisdocs\doc_lib\Get_Documentation.htm).
1.
Log on to SiteScope
Enter the SiteScope address in a Web browser. The default address is:
http://localhost:8080/SiteScope.
2.
Enter your SiteScope license
If you did not enter your SiteScope license information during installation, enter it in
Preferences > General Preferences > Licenses.
For user interface details, see "Licenses" on page 589.
3.
Create a SiteScope user account - optional
The Administrator account is the default account that is active when the product is installed. It
has full privileges to manage SiteScope and is the account that all users who access the
product use unless you restrict the account. Therefore, it is recommended to create and
configure other user accounts based on the requirements of the organization. For task details,
see "How to Create a SiteScope User Profile" on page 729.
Note:
4.
n
If no user name and password are defined for the administrator user, SiteScope skips
the login page and automatically logs in.
n
You can restrict access to the SiteScope user interface for a given IP address or host
name. For details, see "Restrict Access to SiteScope" on page 75.
Configure SiteScope preferences (as required)
Configure specific properties and settings related to administrative tasks within SiteScope.
a. Configure the SiteScope Email Preferences server. Configure an administrators email
address and specify a mail server that SiteScope can use to forward email messages and
alerts to users. For user interface details, see "Email Preferences Page" on page 580.
b. Adjust Log Preferences. Set the number of days of monitor data that are retained on the
SiteScope server. By default, SiteScope deletes logs older than 40 days. If you plan to
have monitor data exported to an external database, prepare the database, the necessary
HP SiteScope (11.23)
Page 73 of 1293
Using SiteScope
Chapter 6: Set Up and Administer SiteScope
drivers, and configure the Log Preferences as applicable. For user interface details, see
"Log Preferences" on page 697.
c. Configure credentials for SiteScope objects. Use Credential Preferences to store and
mange credentials for SiteScope objects that require user authentication. For task details,
see "Credential Preferences" on page 572.
d. In addition, you can configure any of the other SiteScope preferences as required. For
details, see "Preferences Menu" on page 64.
5.
Configure SiteScope to integrate with other applications - optional
SiteScope can be used as a data collector for various other applications, including:
6.
n
BSM. Enables logging of SiteScope monitor data and topology reporting to BSM. For task
details, see "How to Configure SiteScope to Communicate with BSM" on page 236.
n
Operations Manager (HPOM). Enables sending SiteScope events and reporting metrics
data to HPOM and BSM products. For task details on enabling SiteScope to send events to
HPOM or OMi, and enabling SiteScope to report metrics using the HP Operations agent,
see Integrating SiteScope with HP Operations Manager Products in the SiteScope Help.
You can check the HP Software Integrations site to see if a more updated version of this
guide is available (for Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39; for UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
n
Network Node Manager i (NNMi). Enables sending SiteScope events and reporting metrics
data to NNMi. For task details, see Integrating SiteScope with HP NNMi in the SiteScope
Help. You can check the HP Software Integrations site to see if a more updated version of
this guide is available
(http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=483).
n
HP Diagnostics. Enables you to see a more complete view of the application servers that
are monitored by Diagnostics. For user interface details, see Integrating SiteScope with HP
Diagnostics in the SiteScope Help. You can check the HP Software Integrations site to see
if a more updated version of this guide is available
(http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=665).
n
Generic data integration. Enables forwarding SiteScope metrics to an application for which a
direct integration does not exist. For user interface details, see "Generic Data Integration
Preferences" on page 681.
n
Generic event integration. Enables forwarding events to a third-party application or
management console for which a direct integration does not exist. For user interface details,
see "Generic Event Integration Preferences" on page 686.
Configure connection profiles for remote servers
Specify the connection method for the remote servers you want to monitor in accordance with
HP SiteScope (11.23)
Page 74 of 1293
Using SiteScope
Chapter 6: Set Up and Administer SiteScope
your security requirements.
For details on enabling SiteScope to monitor data on remote Windows servers, see "Configure
SiteScope to Monitor Remote Windows Servers" on page 490.
For details on enabling SiteScope to monitor data on remote UNIX servers, see "Configure
SiteScope to Monitor Remote UNIX Servers" on page 510.
7.
Install middleware drivers (if required)
Install middleware drivers for connectivity with remote databases and applications for those
monitors that require drivers.
For details, see the help for the specific monitor.
8.
Enable JMX server password protection - optional
To prevent unauthorized entry to the JMX server embedded in SiteScope, enable password
protection by setting the following system property when you start the JVM:
-Dcom.sun.management.jmxremote.authenticate=true
n
On Windows platforms, add or replace this argument in the Windows registry setting
HKEY_LOCAL_MACHINE\SYSTEM\
CurrentControlSet\Services\SiteScope\serviceParam.
By default, the -Dcom.sun.management.jmxremote.authenticate parameter is set to
false in serviceParam.
n
On UNIX platforms, add this argument to the <SiteScope root directory>/bin/startmonitor script.
For details on configuring the JVM, see the Java Oracle documentation,
http://download.oracle.com/javase/1.5.0/docs/guide/management/agent.html.
For details on the JMX Console, see "Use the JMX Console" on the next page.
Start using SiteScope
You are now ready to use SiteScope.
9.
n
For details on creating a basic monitoring structure in SiteScope, see "Create a Basic
Monitoring Structure" on page 77.
n
For details on using templates for standardizing the monitoring of the different elements in
your enterprise, see "How to Create a Monitoring Structure Using a Template" on page 782.
Restrict Access to SiteScope
This task describes how to restrict access to the SiteScope user interface for a given IP address or
host name.
HP SiteScope (11.23)
Page 75 of 1293
Using SiteScope
Chapter 6: Set Up and Administer SiteScope
1. Open the server.xml file that is located in the <SiteScope root directory>\Tomcat\conf
directory.
2. Locate the RemoteAddress and RemoteHost values, and configure them to allow or deny IP
addresses or host names as required. For details on configuring these values, see the
explanations and examples in the server.xml file. By default, any host is allowed access.
3. To log the IP addresses and host names from which requests are sent to SiteScope through
the user interface (and the access status of these hosts), uncomment the Fast Common
Access Log value.
4. To restrict access to SiteScope's reports on port 8888, set the following properties in the
<SiteScope root directory>\groups\master.config file:
n
_checkAddressAndLogin. Set the value to =true.
n
_authorizedIP. Provide a comma-separated list of all IP addresses that are allowed to
access the reports. By default, any host is allowed access to the SiteScope reports.
Use the JMX Console
SiteScope includes the Java monitoring and management instrumentation (JConsole) tool. This
tool uses Java Management Extension (JMX) technology to provide information on performance
and resource consumption of applications running on the Java platform.
You can use JConsole to perform remote management operations, view performance of processes,
and troubleshoot problematic areas of SiteScope. This tool may help in debugging difficult issues
related to memory consumption, threading, and other issues in the production environment.
How to access the JConsole tool
1. To access the JConsole tool, run <SiteScope root directory>\java\bin\jconsole.exe on
Windows platforms (and <SiteScope root directory>/java/bin/jconsole binary file on UNIX
platforms).
2. Depending on which SiteScope you want to monitor, select Local, or Remote with port 28006
(the default JMX port).
Tips/Troubleshooting JConsole
l
Because access to the JMX server is not password protected (JConsole password
authentication is disabled by default in SiteScope), we recommend that you enable JMX
password authentication to prevent unauthorized entry. For details, see "Enable JMX server
password protection - optional" on the previous page.
l
We recommend not changing any other JConsole settings.
HP SiteScope (11.23)
Page 76 of 1293
Chapter 7: Create a Basic Monitoring Structure
This task describes the working order for creating a basic monitoring structure in SiteScope by
adding monitors individually into the groups you created.
Tip: Alternatively, you can use SiteScope templates, solution templates, the Publish Template
Changes wizard, or automatic template deployment for standardizing the monitoring of the
different IT elements in your enterprise. These methods are more efficient than the basic
monitoring method for mass deployments. For details on the template workflow, see "How to
Create a Monitoring Structure Using a Template" on page 782.
1.
Create groups and subgroups
Create groups according to the monitor hierarchy which you want to implement. This enables
you to make deployment of monitors and associated alerts manageable and effective for your
environment and organization. For example, you can create groups of locations, server types,
network resources, and so forth.
For task details, see "How to Manage a Group" on page 263.
2.
Create monitor instances
Select the monitor instances you want to add to the group.
For task details, see "How to Create and Deploy a Monitor" on page 277.
3.
Set monitor dependencies - optional
Build dependencies between groups and key monitors to help control redundant alerting.
For concept details, see "Monitoring Group Dependencies" on page 272.
4.
Set monitor thresholds - optional
Set thresholds for one or multiple monitors using a baseline, or manually set logic conditions
that determine the reported status of each monitor instance.
5.
n
For task details on how to set monitor thresholds using a baseline, see "How to Set Monitor
Thresholds Using a Baseline" on page 341.
n
For user interface details for setting monitor thresholds manually, see "Threshold Settings"
on page 305.
Configure analytics - optional
Configure analytics which enables SiteScope to anticipate potential problems on business
monitors and alert users of issues in critical applications before they occur. Analytics is also
able to provide details to assist with root cause analysis to help expedite problem resolution.
HP SiteScope (11.23)
Page 77 of 1293
Using SiteScope
Chapter 7: Create a Basic Monitoring Structure
For details. see "Configure Predictive Analytics" on page 1261.
6.
Set up monitor and group alerts - optional
Create alerts to send notification of an event or change of status in some element or system in
your infrastructure.
For task details, see "Configure SiteScope Alerts" on page 1140.
7.
Set up monitor and group reports - optional
Create reports to display information about how the servers and applications you are
monitoring have performed over time.
For task details, see "Create SiteScope Reports" on page 1211.
8.
Results
SiteScope adds the monitors, alerts, and reports to the specified container in the monitor tree.
HP SiteScope (11.23)
Page 78 of 1293
Chapter 8: Create a Monitoring Structure Using
a Template
This task describes the steps for creating and publishing reusable templates, enabling you to
deploy multiple IT elements with similar monitoring configuration criteria. It also includes steps for
publishing changes across the entire enterprise to all SiteScope objects deployed by templates,
without the need for extensive manual updates.
Flowchart of this task:
HP SiteScope (11.23)
Page 79 of 1293
Using SiteScope
Chapter 8: Create a Monitoring Structure Using a Template
Tip: We recommend that you create template objects in the order listed. You can skip the
steps for any template objects that you do not require. To help you get started with templates,
use the example templates provided for monitoring in Windows and UNIX environments. For
details, see "Template Examples" on page 776.
1.
2.
Prerequisites
n
To be able to add, edit, and delete templates, you must have the View templates and Add,
edit or delete templates permissions.
n
To deploy a template, regardless of its content, you must have edit permissions on the
deployment target group. You do not need edit permissions on the template objects
(monitors, remotes, and alerts). For details on user permissions, see "Permissions" on page
738.
Create a template container
Create a template container to enable you to manage your monitoring solution.
For user interface details, see "New Template Container Dialog Box" on page 799.
3.
Create a template
Add a template to the template container. This is the container for your monitoring solution, in
which you create groups, monitors, remote server, variables, and alerts for the monitoring
solution. You can create multiple templates in a template container.
For user interface details, see "New Template Dialog Box" on page 801.
Note: You can also copy an existing group and monitor hierarchy from a SiteScope to the
template and edit the elements for use as a template. For task details, see "How to Create
a Template by Copying Existing Configurations" on page 790.
4.
Create template variables
You can create template variables in the template that enable you to specify a different name
for an object every time that you deploy the template. Variables should be the first objects you
create in a template, because they are referred to when you create groups, monitors, servers,
and alerts.
a. Create the template variable in the template. For more information on the user interface,
see "New Variable Dialog Box" on page 802.
b. Reference the variable in one or more configuration objects in the template. For more
information on this topic, see "Referencing Template Variables" on page 781.
HP SiteScope (11.23)
Page 80 of 1293
Using SiteScope
Chapter 8: Create a Monitoring Structure Using a Template
Note:
5.
o
If a remote server is specified with a variable name with no additional characters
prefixed or suffixed to it (for example, %%hostname%%), and the same variable is
specified for any field in a monitor, after deployment the value appears as Remote## on UNIX and \\<variable_value> on Windows, instead of just the variable value
that was specified on deployment. To avoid this, where a variable name is used for
a remote server, additional characters should be prefixed or suffixed to the name.
o
User-defined and pre-defined system variables are available in all the text fields
and text table cells when configuring templates. To display the list of available
variables, type either %% or $$ in the field, and select the relevant variable. The
variable is then displayed in the field.
Create a template remote server
In the template, you can define a remote Windows or UNIX server where the monitored objects
are located. A template monitor may run on servers that are defined by template servers at the
time of template deployment or on servers defined manually in Remote Servers. Template
servers are added to the remote server tree under Microsoft Windows Remote Servers or
UNIX Remote Servers when the template is deployed.
For user interface details, see "New Template Remote Server Dialog Box" on page 804.
Note: You can add only one remote server to a template.
Example: A Windows template remote server has been created with the name %%host%%
remote windows.
HP SiteScope (11.23)
Page 81 of 1293
Using SiteScope
Chapter 8: Create a Monitoring Structure Using a Template
6.
Create a template group
In the template, create a template group to make the deployment of monitors and associated
alerts manageable and effective for your organization.
For user interface details, see "New Template Group Dialog Box" on page 806.
Note:
7.
n
By default, monitors must be created in a template group. You can override this setting
in Preferences > Infrastructure Preferences > Template Settings by selecting
Allow creation of template monitors directly under a template entity.
n
You can also define a template subgroup so that its content is not a part of the template,
and is ignored, when publishing changes to deployed groups. This enables deploying
templates inside different deployed groups. For details, see "Ignore group when
publishing changes" on page 807 in General Settings.
n
A template can have only one template group directly under it (the parent group).
Create template monitor instances
a. Select the monitor instances you want to add to the template group. For user interface
details, see "New Template Monitor Dialog Box" on page 811.
HP SiteScope (11.23)
Page 82 of 1293
Using SiteScope
Chapter 8: Create a Monitoring Structure Using a Template
b. Enter values for the monitor properties.
o
If you are using template variables, enter the variable syntax for all fields whose values
are to be replaced with a variable. This includes use of the $$SERVER_LIST$$ system
variable. For concept details, see "Syntax for System Variables" on page 780.
o
To enter a variable, type either %% or $$. The list of available variables of that type is
displayed automatically. Click the relevant variable to select it (using the keyboard to
navigate through the list of available variables is not supported). The variable is then
displayed in the field.
Example: Using a variable when configuring a monitor. In this example, the template
monitor (a SiteScope CPU monitor) is configured to run on the template remote
server, %%host%% remote windows.
Note:
o
A template monitor can run on servers that are defined by template servers at the
time of template deployment or on servers defined manually in the Remote
Servers container of the remote server tree. Whichever is the case, the value in
the Server box must match the host name of an actual server at the time that the
template is deployed after values have been substituted for the template
variables. If the server name does not match the host name of a real server, the
monitor fails. To automatically retrieve the template remote server name (if one
was created), select the Use already configured template remote under
current template check box in the Monitor Settings field. For user interface
details, see "New Template Monitor Dialog Box" on page 811.
o
Do not use "\\" in the monitor Server field, and in the remote server Name and
HP SiteScope (11.23)
Page 83 of 1293
Using SiteScope
Chapter 8: Create a Monitoring Structure Using a Template
Server fields.
o
You can add monitor instances directly to the template entity if you select Allow
creation of template monitors directly under a template entity in
Preferences > Infrastructure Preferences > Template Settings.
c. For monitors with browsable counters, select counters to monitor measurements specific
to the target system.
o
Click the Get Counters button, and select a server or enter the connection information
for a server that is running the service or application that you want to monitor.
o
Click the Get Counters button again to retrieve the available counters. The counter
selection dialog box is updated.
o
Select the measurements or counters that you want to monitor. If the specific counters
on the target system vary from one deployment to another, you can use a regular
expression to match a pattern that represents the type or category of counter you want
to monitor. For task details, see "How to Modify Counter Selection Strings to Use
Regular Expressions" on page 794.
d. Configure other monitor settings in the Properties tab, such as:
o
Manually set thresholds for monitors by setting logic conditions that determine the
reported status of each monitor instance. For user interface details, see "Threshold
Settings" on page 305.
Note: After deploying a template, you can also set thresholds for one or multiple
monitors using a baseline. For task details, see "How to Set Monitor Thresholds
Using a Baseline" on page 341.
o
Manually configure calculated metrics to calculate the relation between two or more
metrics for one or more monitors. For user interface details, see "Calculated Metrics
Settings" on page 378.
o
Build dependencies between groups and key monitors to help control redundant alerting.
For concept details, see "Monitoring Group Dependencies" on page 272.
o
For the complete list of common user settings, see "Common Monitor Settings" on page
298.
Note: If you copy, move, or delete a template containing custom monitors, this affects
the content package folder (created in the <SiteScope root
directory>\packages\workspace directory) as follows:
HP SiteScope (11.23)
Page 84 of 1293
Using SiteScope
Chapter 8: Create a Monitoring Structure Using a Template
8.
o
Copy. Makes a copy of the content package folder in the <SiteScope root
directory>\packages\workspace folder.
o
Cut. No change.
o
Delete. If you delete the custom monitor template, the content package folder is
removed from the <SiteScope root directory>\packages\workspace folder of the
SiteScope file system.
Set up monitor and group alerts
Create alerts to send notification of an event or change of status in some element or system in
your infrastructure.
For task details, see "Configure SiteScope Alerts" on page 1140.
9.
Deploy the template
After creating a SiteScope monitoring template, you can deploy templates to a group.
n
You can deploy a single template, or multiple templates simultaneously to a group from the
user interface. For task details, see "How to Deploy Templates Using the User Interface" on
page 837.
n
You can perform mass deployments of a single template using a CSV file external to the
SiteScope user interface. A CSV file is better suited for performing mass deployments,
since it is easier to enter and update all the template variable values in one CSV file. For
details, see "Deploy a Template Using a CSV File" on page 836.
n
You can deploy a template using an XML file external to the SiteScope user interface. For
details, see "Automatic Template Deployment Using an XML File" on page 862.
Note: If you deploy a template containing a custom monitor, the template and the
deployed monitor both point to the same monitor. 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.
10.
Results
SiteScope adds the groups, monitors, and alerts to the specified group in the monitor tree.
For troubleshooting and limitations when configuring user-defined templates, see
Troubleshooting SiteScope Templates.
Example: The template example, Windows basic template, was deployed to a group
container named Lab Test. It contains a CPU monitor and Memory monitor, and was
HP SiteScope (11.23)
Page 85 of 1293
Using SiteScope
Chapter 8: Create a Monitoring Structure Using a Template
deployed to monitor resource usage on a server named doors.
11.
Set up monitor and group reports in the monitor view - optional
Create reports to display information about how the servers and applications you are
monitoring have performed over time.
For task details, see "Create SiteScope Reports" on page 1211.
12.
Publish changes to the monitoring solution - optional
You can make changes to deployed templates, for example, by adding or removing monitors or
modifying monitor properties. You do this by editing the template and using the Publish
Template Changes Wizard to publish the changes to all the relevant objects deployed by the
template.
For task details, see "How to Publish Template Updates to Related Group Deployments" on
page 850.
13.
Share the template with other SiteScope users - optional
You can share templates by sending them to individual SiteScope users, or by publishing them
to the HP Live Network. The HP Live network is an online community providing a central
location for HP customers to share information and learn about add-on content, extensions and
related activities across the HP Software portfolio.
For task details, see "Share Content on the HP Live Network" on page 878.
HP SiteScope (11.23)
Page 86 of 1293
Part 2: General and Administration
This section includes using the SiteScope search and filter, performing mass operations on
SiteScope objects , copying/moving SiteScope objects to different locations , Global Search and
Replace, SiteScope diagnostic tools, using regular expressions, SiteScope mobile apps, and using
SiteScope configuration and data acquisition APIs
HP SiteScope (11.23)
Page 87 of 1293
Chapter 9: Search SiteScope Objects
You can assign search/filter tags to any object in the context tree, and use those tags to search or
filter the display. For example, you can define a tag for all monitors running on a specific operating
system. Keyword tags are used to search and filter SiteScope objects (groups, monitors, remote
servers, templates, and preference profiles). Alternatively, you can use the quick search to search
for SiteScope objects.
To access
l
Search using tags. Select a SiteScope object (group, monitor, template, or preference profile),
and open the Search/Filter Tags panel in the monitor properties tab or Search/Filter Tags
preference page. Click the Add Tag button. You can edit existing tags in the Preferences
context (Preferences > Search/Filter Tags).
l
Quick search. In the monitor, template, remote server, or counters tree (in the monitor
properties for some browsable counter monitors), enter the characters you want to search in the
popup search box or in the Quick Search
box.
Learn About
Search and Filter Overview
You create custom search/filter tags for use in filtering the display of the left tree pane for SiteScope
objects (groups, monitors, templates, target servers, alerts, and preference profiles). You define the
tags and their values, and assign these to the different elements in your enterprise.
For example, you define a tag called Priority with the possible values of Critical, High,
Medium, and Low. You assign these tag values to different elements in the infrastructure. Monitors
of Web servers and databases that support 24x7 customer access could be assigned a category
value of Priority: Critical. While adding a new filter setting, you select Tags in the Filter
Options section, enter Priority:Critical as the value of the object, and click Save. This filter
displays only those elements to which you assigned this tag and value.
Tags can also be used in alert templates using the <tag> attribute. Using the <tag:[tagName]>
property, you can include values in the filter tag as parameters in alerts. This provides similar
functionality to the custom properties mechanism that was removed in SiteScope 10.00.
For example, you have a tag named AppServer with value Apache assigned to a monitor, and you
include <tag:AppServer> in the alert template configured for that monitor. If an alert is triggered,
the new property is replaced with Apache in the alert text. For details on alert template properties,
see "Properties Available in Alerts, Templates, and Events" on page 1199.
If no tags have been created for the SiteScope, this section appears but is empty. If tags have been
created, they are listed here and you can select them as required.
Using the SiteScope filter, you can then select which objects in the trees you want to view, based
on filter criteria. You can define multiple filters with different conditions that can be applied for
varying configuration tasks.
For task details, see "Search SiteScope Objects" above.
HP SiteScope (11.23)
Page 88 of 1293
Using SiteScope
Chapter 9: Search SiteScope Objects
Quick Search Overview
There is a quick search that enables you to search configuration objects (groups, monitors, remote
servers, templates, counters) for a specific property name or value. Quick search is available in the
monitor, template, remote server, and counters tree (in the monitor properties for some browsable
counter monitors). Enter a string in the Quick search box to filter the property names and values.
The tree expands all nodes containing the given string text.
The quick search provides options that enable filtering the search by case sensitivity, wildcards,
match options, and node/child options. It also includes an automatic filter that if selected, enables
the search to be performed automatically after typing the search word, without having to press the
Enter key every time you want to run the search.
For task details, see "How to use the quick search" on the next page.
Tasks
This section includes:
l
"How to search for objects using Search/Filter Tags" below
l
"How to use the quick search" on the next page
How to search for objects using Search/Filter Tags
This task describes the steps involved in defining a Search/Filter tag and assigning it to one or more
elements in the context tree, and then using those tags to search or filter the display.
1. Create a search/filter tag.
Use the Search/Filter Tags panel of the SiteScope object to add search/filter tags. For user
interface details, see "Search/Filter Tags Panel" on page 91.
2. Assign search/filter tags to SiteScope tree elements.
Before you can use a tag as part of a view filter, you must assign it to one or more elements in
the context tree or to preference profiles. You can assign tags to any item in the tree, including
any container, monitor, group, or alert.
You assign tags while adding, importing, or editing context tree objects or preference profiles.
Tags are included as properties for every type of object in the context tree.
For details on the objects in the monitor tree, see "Monitor Tree" on page 43.
For details on the objects in the template tree, see "Template Tree" on page 56.
3. Define a tag for a filter setting.
After you have assigned the tag to one or more items in the context tree or preference profiles,
you can use the tag as an object for a filter.
For details on filtering in the user interface, see "Filter SiteScope Objects" on page 95.
HP SiteScope (11.23)
Page 89 of 1293
Using SiteScope
Chapter 9: Search SiteScope Objects
Example: Create a tag indicating the type of operating system on which the monitors are
running. The tag Operating Systems would have values such as Windows 2008,
Windows XP, Solaris, Linux, and so forth.
To assign the tag to a monitor tree element, such as a group, open the Search/Filter
Settings for the group, and select Windows 2008 as the value under the Operating
Systems tag.
Using this new tag, you could define a filter setting for the monitor tree to display only
those monitors running on Windows machines.
How to use the quick search
In the monitor, template, remote server,or counters tree (in the monitor properties for some
HP SiteScope (11.23)
Page 90 of 1293
Using SiteScope
Chapter 9: Search SiteScope Objects
browsable counter monitors), click the left end of the Quick Search
box to open the dropdown menu of filter options, and enter your search string. For details on the quick search options,
see "Quick Search" on the next page.
Related Tasks: "Filter SiteScope Objects" on page 95
UI Descriptions
Search/Filter Tags Panel
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Description
<Tag
name
and
values>
Displays the tag names and tag values if tags have been created. Select the tags or
tag values that you want to assign to the object. If no tags have been created for the
SiteScope, this section appears but is empty.
Add
Tag
Opens the New Tag dialog box, enabling you to add new keyword tags. For user
interface details, see "New/Edit Tag Dialog Box" on page 93.
HP SiteScope (11.23)
Page 91 of 1293
Using SiteScope
Chapter 9: Search SiteScope Objects
Quick Search
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Description
Quick Search. Enables you to search configuration objects (groups, monitors,
remote servers, templates, or counters) for a specific property name or value in the
monitor, template, remote server, or counters tree (in the monitor properties for some
browsable counter monitors).
Click the left end of the box to open the drop-down menu of filter options:
l
Select Case sensitive to search for the filter string exactly as entered. Select
Case insensitive to ignore the case of the filter string.
l
Select Use wild cards to use the wildcard symbol * in the filter string. Enables
you to use asterisk (*) characters in your search string in order to type only part of
the item.
l
Select Match from start to search for the filter string at the beginning of a property
name or value. Select Match exactly to search for the exact filter string. Select
Match anywhere to search for the filter string anywhere in the properties.
l
Select Match leaf node only to search for the filter string in leaf nodes (monitors
and empty groups only) in the tree. Clear to search all nodes.
l
Select Hide nodes without children to hide groups that have no leaf nodes that
match the filter string (empty groups).
l
Select Keep the children if any of their ancestors match to display all child
nodes of groups that match the filter string, even though the child does not match
the search string.
l
Select Use auto filter to search automatically after a letter is entered in the
search text field. You can configure a delay before the auto filter runs in
Preferences > Infrastructure Preferences > General Settings > Quick search
auto filter delay (milliseconds). The default delay is 800 milliseconds (0.8
seconds). If Use auto filter is not selected, you must press the Enter key every
time you want to run the search.
Tip: In a loaded environment, it is recommended to increase the delay time in
Quick search auto filter delay time, or to disable the Use auto filter option.
Note:
l
Quick search is only available in the following tree toolbars: monitor, template,
remote server, and counters tree (in monitor properties) .
l
If a filter is applied to a tree, the search is restricted to the records currently
displayed.
HP SiteScope (11.23)
Page 92 of 1293
Using SiteScope
Chapter 9: Search SiteScope Objects
New/Edit Tag Dialog Box
This dialog box enables you to add a new search/filter tag.
To access
Select a SiteScope object (group, monitor, template, or preference profile), and
open the Search/Filter Tags panel in the Properties tab or preference profile
page. Click the Add Tag button.
Important
information
l
You can edit existing tags in the Preferences context (Preferences >
Search/Filter Tags). For details on this topic, see "Search/Filter Tags" on
page 714.
l
Only a SiteScope administrator user, or a user granted the appropriate tags
permissions can view, add or edit tags. For details on user permissions, see
"Permissions" on page 738.
l
You cannot delete a Search/Filter tag or tag value if it is referenced by a
SiteScope object. You must remove the tag or tag value from all SiteScope
objects before you can delete it.
l
Tags can also be used in alert templates using the <tag> attribute. For details,
see "Properties Available in Alerts, Templates, and Events" on page 1199.
Relevant
tasks
"Search SiteScope Objects" on page 88
User interface elements are described below:
UI Element
Description
New. Adds a tag value. A new row is added at the bottom of the list of tag values.
Delete. Deletes the selected value from the tag.
Move up tag value. Moves the selected tag value up the list of tag values. This
enables you to sort the tag values order, instead of ordering alphabetically.
Move down tag value. Moves the selected tag value down the list of tag values.
This enables you to sort the tag values order, instead of ordering alphabetically.
Tag name
The name of the search/filter tag.
Maximum length: 255 characters
Tag
description
Description of the search/filter tag.
Values
Values included in the tag.
HP SiteScope (11.23)
Page 93 of 1293
Using SiteScope
Chapter 9: Search SiteScope Objects
UI Element
Description
Value
Name
Name for the value to be included in the tag. Each tag must include at least one
value. Each value appears as a child object of the tag name when defining or
editing tag settings for all objects in the monitor tree.
Value
Description for each value. This description appears only when editing the tag.
Description
HP SiteScope (11.23)
Page 94 of 1293
Chapter 10: Filter SiteScope Objects
The SiteScope filter enables you to filter the monitor tree to display only those SiteScope objects
that meet the criteria that you define.
To access
1. In the Monitor tree context toolbar (above the left pane), click the arrow next to the Filter
button.
2. Select New Filter, or select an existing filter and click Edit.
Note: The filter options are also available from the Manage Monitors and Groups dialog box.
For details, see "Perform Actions on Multiple Groups and Monitors" on page 101.
Learn About
Global Filter Overview
When administrating monitor deployment, extensive trees displaying every object added to them
could prove difficult to manage. SiteScope enables you to select which objects in the trees you
want to view, based on filter criteria. You can define multiple filters with different conditions that can
be applied for varying configuration tasks.
For example, you can create a filter to display only SiteScope monitors that are monitoring CPU
utilization and Disk Space. The result of this filter displays a tree with all CPU and Disk Space
monitor types directly under the enterprise node.
You can also create custom search/filter tags for use in filtering the display of the left tree pane for
SiteScope objects. You define the tags and their values, assign these to the different elements in
your enterprises, and then use those tags to search or filter the display. For details on assigning
search/filter tags, see "Search SiteScope Objects" on page 88.
Note: To create a filter based on specific common properties, use Global Search and Replace.
For details, see "Global Search and Replace" on page 106.
Tasks
How to filter SiteScope objects
Use the Filter to search for specific object types and property values in SiteScope. You can select
predefined filters, create new filters, or edit values in existing filters.
If you have any filters defined, they appear in the drop-down filter list above the monitor tree. You
select the filter from the list and the tree displays only those objects defined in your filter selection.
After applying a filter, the filter icon appears as
HP SiteScope (11.23)
.
Page 95 of 1293
Using SiteScope
Chapter 10: Filter SiteScope Objects
For user interface details, see "New/Edit Filter Dialog Box" below.
Note: Before you can use a search/filter tag as part of a view filter, you must create the tag and
assign it to one or more elements in the context tree or to preference profiles. You can assign
tags to any item in the tree, including any container, monitor, group, or alert. For details on
creating search/filter tags, see "Search SiteScope Objects" on page 88.
UI Descriptions
New/Edit Filter Dialog Box
The Filter button is located in the context toolbar of the Monitor Tree.
User interface elements are described below:
UI Element
Description
General Settings
(This panel does not appear when accessing the filter from the Manage Monitors and Groups
dialog box)
Filter name
Filter name. This name appears in the list of available filters when you click
the Filter arrow.
Filter
description
Description for the filter. This description appears only when editing the filter.
Public filter
Describes the permissions of the filter. If the filter is public, all users can see,
use, and edit the filter, but only the public filter owner can change this filter to a
private filter.
Note: This field is optional.
If the filter is not public, only the current user can see and use it.
Filter Options
Regular
expression
Enables using standard regular expressions to filter the monitor tree.
When selected, you cannot select monitor names, monitor types, or tag
values from the filter lists. The filter uses the POSIX regular expression format
when the check box is cleared.
Default value: Selected
HP SiteScope (11.23)
Page 96 of 1293
Using SiteScope
Chapter 10: Filter SiteScope Objects
UI Element
Description
Monitor name
To filter the objects appearing in the tree by the monitor name, type a monitor
name.
l
The monitor name is the string entered in the Name box in the General
Settings panel during monitor configuration.
l
You can enter a regular expression to widen the filter. This is done by using
wild card ("*") and or expressions to filter SiteScope objects appearing in
the tree by the monitor name.
The monitor tree displays only those monitors, within their groups, matching
the string entered and only those groups containing these monitors.
Example: The expression /URL Monitor.* \.gov/ matches all monitor
names containing the string URL Monitor with addresses containing the
domain .gov.
Note: This field is case sensitive.
Monitor type
To filter the objects appearing in the tree by the monitor type, enter the monitor
type, or click the Browse
button and select the monitor types by
which you want to filter in the Monitors list.
For example, you can define a filter that includes all CPU monitors, regardless
of their properties. In this view, the monitor tree lists all the CPU monitors
defined in the SiteScope.
For details on the Filter Monitor Types user interface, see "Filter Monitor
Types Dialog Box" on the next page.
Note:
l
When entering multiple monitors, separate them with a comma (",").
l
When entering a monitor type, you can enter a regular expression.
Example: SAP* or CPU*
HP SiteScope (11.23)
Page 97 of 1293
Using SiteScope
Chapter 10: Filter SiteScope Objects
UI Element
Description
Target server
To filter the objects appearing in the tree by the target server, type a server
name or click the Browse
button and select the remote servers by
which you want to filter from the Targets list.
l
The target is the string entered in the Server box in the Monitor Settings
panel during monitor configuration.
l
You can enter a regular expression to widen the filter.
The tree displays only those monitors, within their groups, whose target server
matches the string entered and only those groups containing these monitors.
For details on the Filter Target Server user interface, see "Filter Target
Servers Dialog Box" on the next page.
Note: When entering multiple targets, separate them with a comma (",").
Tags
Enables you to define a filter that includes all SiteScope objects that have a
specific tag value. For example, if there is a platform tag with values
Windows, Linux, AIX, and Solaris, you can filter for all objects that have the
AIX tag value assigned to them.
Enter tag values, or click the Browse
button and select the tag
values by which you want to filter in the Tags list. For details on the Filter Tags
user interface, see "Filter Tags Dialog Box" on page 100.
Note:
l
When entering multiple tag values, separate them with a comma (",").
l
You can use the wild card character ("*") and the and or or expressions to
filter tag values.
Enable/Disable Enables you to define a filter that includes only enabled or disabled SiteScope
Monitor
monitors.
Default value: None
Enable/Disable Status (enabled/disabled) of associated alerts by which you want to filter.
Associated
Default value: None
Alerts
HP BSM
Logging
Enables you to define a filter that includes monitors based on their settings for
reporting data to BSM.
For details on the logging options, see "HP Integration Settings" on page 311.
Filter Monitor Types Dialog Box
This dialog box enables you to select the monitor type by which you can filter SiteScope objects.
HP SiteScope (11.23)
Page 98 of 1293
Using SiteScope
Chapter 10: Filter SiteScope Objects
To
In the context toolbar, click the arrow next to the Filter
button, and select New
access
Filter, or select an existing filter and click Edit. In the New/Edit Filter dialog box, click
the Browse
See
also
button next to Monitor Type.
"Filter SiteScope Objects" on page 95
User interface elements are described below:
UI
Element
Description
Available
Monitor
Types
Displays the available monitor types.
Selected
Monitor
Types
Displays the monitor types currently selected for this filter.
Select the monitor types you want to include in the filter and click the Move to
Selected Monitor Types button. The selected monitor types are moved to the
Selected Monitor Types list.
To remove monitor types from this list, select the monitor types and click the Move
to Available Monitor Types button. The measurements are moved to the
Available Monitor Types list.
Filter Target Servers Dialog Box
This dialog box enables you to filter SiteScope objects by the selected server targets configured in
SiteScope.
To
In the context toolbar, click the arrow next to the Filter
button, and select New
access
Filter, or select an existing filter and click Edit. In the New/Edit Filter dialog box, click
the Browse
See
also
button next to Target Server.
"Filter SiteScope Objects" on page 95
User interface elements are described below:
UI
Element
Available
Target
Servers
Description
Displays the remote servers available in SiteScope.
Select the remote servers you want to include in the filter and click the Move to
Selected Target Servers button. The selected remote servers are moved to the
Selected Target Servers list.
HP SiteScope (11.23)
Page 99 of 1293
Using SiteScope
Chapter 10: Filter SiteScope Objects
UI
Element
Description
Selected
Target
Servers
Displays the remote servers currently selected for this filter.
To remove remote servers from this list, select the remote servers and click the
Move to Available Target Servers button. The measurements are moved to the
Available Target Servers list.
Filter Tags Dialog Box
This dialog box enables you to select the tag values by which you can filter SiteScope objects.
To
In the context toolbar, click the arrow next to the Filter
button, and select New
access
Filter, or select an existing filter and click Edit. In the New/Edit Filter dialog box, click
the Browse
See
also
button next to Tags.
"Filter SiteScope Objects" on page 95
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
<Tag name
and
values>
Displays the tag names and tag values if tags have been created. Select the
check box next to the tags that you want to include in the filter, and click Save.
Tree Filter
Select an operator to define tag tree filter conditions:
For concept details, see "Search SiteScope Objects" on page 88.
l
and. Displays all objects that have all the tags selected.
l
or. Displays all objects that have at least one of the tags selected.
Note: You can select only one type of operator (mixed conditions cannot be
used).
HP SiteScope (11.23)
Page 100 of 1293
Chapter 11: Perform Actions on Multiple Groups
and Monitors
You can perform mass operations on SiteScope objects using the Manage Groups and Monitors
feature. Using the Manage Monitors and Groups dialog box, you can select one or more groups,
monitors, or both from an expandable hierarchical view of the organization, and select the action
you want to perform (copy, move, delete, run monitors, enable/disable monitors, enable/disable
associated alerts).
You can also use the filter options to create a filtered list of groups and monitors based on a filter
criterion, or select an existing filter previously defined in the monitor tree filter.
To access
Select the Monitors context. In the monitor tree toolbar, click the Manage Monitors and Groups
button.
UI Descriptions
Manage Monitors and Groups Dialog Box
Important
information
Relevant tasks
HP SiteScope (11.23)
l
The toolbar actions are available according to the user permissions and
the objects selected.
l
The Health container cannot be deleted.
l
"How to Manage a Group" on page 263
l
"How to Create and Deploy a Monitor" on page 277
l
"Search SiteScope Objects" on page 88
Page 101 of 1293
Using SiteScope
Chapter 11: Perform Actions on Multiple Groups and Monitors
User interface elements are described below:
UI Element
Description
Filter. Enables you to filter the monitor tree to display only those SiteScope
objects that meet the criteria that you define. After applying a filter, the name of
the filter is displayed in the button (custom, if the filter was created in the
Manage Monitors and Groups dialog box; otherwise, the name of the filter
defined in the monitor tree filter).
Click the Filter button arrow and select a filter option:
l
New Filter. Opens the New Filter dialog box which enables you to create a
filter. For user interface details, see "New/Edit Filter Dialog Box" on page 96.
l
Clear Filter. Clears the filter settings.
l
<List of existing filters>. Displays a list of existing filters previously
defined in the monitor tree filter.
Select All. Selects all listed SiteScope objects.
Clear Selection. Clears the selection.
Cut. Moves the selected objects to the destination group.
Note:
l
Any alerts defined for a specific monitor are transferred with the monitor.
l
Moving a monitor restarts its history and any reports generated for the
monitor are started from the time that the monitor was moved. The history
data is still in the log files, but it is inaccessible from the reports for the
monitor after it has been moved. Moving groups has no effect on history.
l
Moving a monitor may break group-to-monitor dependencies. If you have one
or more groups dependent on the status of the monitor you are moving,
update that dependency after moving the monitor.
Copy. Makes a copy of the selected objects for pasting to the destination
group.
Paste. Pastes the selected objects to the destination group. If you make a copy
of a SiteScope object and it has the same name as an existing object in the
container, SiteScope automatically adds a suffix (number) to the end of the
object's name.
Example: If you create a copy of monitor Mail Flow and paste it in the same
monitor group, SiteScope automatically renames it Mail Flow(1).
HP SiteScope (11.23)
Page 102 of 1293
Using SiteScope
Chapter 11: Perform Actions on Multiple Groups and Monitors
UI Element
Description
Delete. Deletes the selected objects from the monitor tree.
Run Monitors. Runs the monitor or any monitors configured in the group. This
opens an information window with the results.
Enable/Disable Monitor. Opens the Enable/Disable Monitor dialog box which
enables you to enable or disable the monitor or all the monitors in the group,
regardless of the setting in the monitor properties. If you select Disable, the
monitors are disabled until you return to this dialog box and select Enable. For
user interface details, see "Enable/Disable Monitors in Group Dialog Box" on
page 1029.
Enable/Disable Associated Alerts. Open the Enable/Disable Associated
Alerts dialog box which enables you to enable or disable all alerts associated
with the monitor or all monitors in the group. For more details, see
"Enable/Disable Associated Alerts" on page 325.
<SiteScope
objects>
Actions are applied to all monitors and groups that are selected using the check
box selections in the tree. The display of the tree is saved across visits to the
dialog box and the actions associated with it.
l
To select an object, select the check box to the left of the object name. Any
combination of groups or monitors can be selected. A icon displayed to
the left of a group indicates that not all monitors and subgroups contained
within that group have been selected.
l
To select a destination for copying or moving an object, click the object
name (not the check box).
Default value: The top level groups are shown, but no objects are selected.
HP SiteScope (11.23)
Page 103 of 1293
Chapter 12: Copy and Move SiteScope Objects
You can copy SiteScope objects to different locations within a context tree. In addition, you can
copy SiteScope objects to templates. You can also move monitors and groups, together with their
contents, to different groups in the monitor tree.
To enable you to differentiate between objects, object names must be unique within the parent
container. For instance, when you copy or move SiteScope objects, you cannot create two
monitors within the same group with exactly the same name. If you make a copy of a SiteScope
object and it has the same name as an existing object in the container, SiteScope automatically
adds a suffix (number) to the end of the object's name. For example, if you create a copy of monitor
Mail Flow and paste it in the same monitor group, SiteScope automatically renames it Mail Flow
(1).
You can copy or move the following SiteScope objects:
SiteScope
Object
Action and Description
Group
Copy/Paste. Copy a monitor group, including its subgroups, monitors, alerts, and
reports, to the same or a different monitor group.
Cut/Paste. Move a monitor group, including its subgroups, monitors, alerts, and
reports, to a different monitor group.
Copy to Template. Copy a monitor group, including its monitors, alerts, and
reports, to a template.
Note:
l
You cannot move or copy a monitor group to its subgroup.
l
If you move a group that is targeted by an alert or report without also moving the
alert or report, the group is removed from the alert or report target.
l
Baseline thresholds are not copied or moved with a monitor whose thresholds
were set using the baseline.
HP SiteScope (11.23)
Page 104 of 1293
Using SiteScope
Chapter 12: Copy and Move SiteScope Objects
SiteScope
Object
Action and Description
Monitor
Copy/Paste. Copy a monitor, including its alerts and reports, to the same or a
different monitor group.
Cut/Paste. Move a monitor, including its alerts and reports, to a different monitor
group.
Copy to Template. Copy a monitor, including its alerts and reports, to a template.
Note:
l
If you move a monitor that is targeted by an alert or report without also moving
the alert or report, the monitor is removed from the alert or report target.
l
After copying a monitor, you normally need to change the system or application
that the monitor is targeting, otherwise the copied monitor duplicates the
monitoring actions of the original monitor instance.
l
Baseline thresholds are not copied or moved with a monitor whose thresholds
were set using the baseline.
Remote
Server
Copy to Template. Copy a remote server profile to a template.
Template
Container
Copy/Paste. Copy a template container and paste it to another template container
or to the SiteScope root.
Template
Copy/Paste. Copy a template including its groups, monitors, alerts, and report, to a
template container.
Template
Group
Copy/Paste. Copy a template group including its subgroups, monitors, alerts, and
reports to a template (provided the template does not already contain a template
group) or to a template group.
Template
Monitor
Copy/Paste. Copy a template monitor including its alerts and reports to a template
group.
Alert
Copy/Paste. Copy an alert definition (from the Alerts tab) to the same or a different
location (group or monitor) in the monitor tree or template tree.
Report
Copy/Paste. Copy a report definition (from the Reports tab) to the same or a
different location (group or monitor) in the monitor tree or template tree.
Note: You can also move or copy multiple monitors and groups to a target group by clicking the
Manage Monitors and Groups
button in the monitor tree toolbar. For details, see
"Perform Actions on Multiple Groups and Monitors" on page 101.
For details on copying or moving SiteScope objects, expand the context menu option for the
relevant SiteScope view in "Context Trees and Menu Options" on page 42.
HP SiteScope (11.23)
Page 105 of 1293
Chapter 13: Global Search and Replace
The Global Search and Replace Wizard enables you to make changes to monitor, alert, alert action,
group, preferences, and report properties. You can select an object based on object type, and
globally replace any of the selected object's properties across a SiteScope or across multiple
SiteScopes when working in SAM Administration.
For example, when upgrading BSM, use the Global Search and Replace Wizard to configure all the
SiteScopes reporting data to BSM to the upgraded version.
To access
l
In SiteScope, right-click SiteScope root or the group or monitor in the monitor tree to which you
want to perform the global replace. To replace Preferences objects, right-click the SiteScope
root. To replace alert objects, right-click the SiteScope root, or the relevant group or monitor
object. Select Global Search and Replace from the context menu.
l
In BSM, select Admin > System Availability Management. Below the SiteScope Summary
table in the right pane, click the Global Search and Replace button.
Learn About
Filter Affected Objects
Use the Filter Affected Options option to further refine your selected object for the search operation.
You can select specific properties and select or enter values pertaining to your object. This enables
you to limit the selected objects but not the value to replace.
When performing the replace operation, only the value to replace is replaced and only on those
objects that match the properties selected in the Filter Affected Options page. For example, select
all monitors with frequency set to 5 minutes and replace the monitor dependency setting for all of
those monitors, or select only those monitors monitoring a specific server and replace the threshold
settings for only those monitor instances matching the value of the server entered in the filter.
Replace or Find and Replace
Use the replace method to search for a field value and replace it with a new value. For example,
change the default monitor run frequency setting for the selected monitors by selecting the
Frequency check box in the Monitor Run Settings panel, and updating the frequency value from
10 to 15 minutes.
Use the find and replace method to search for specific settings and property values and replace
only those objects with the entered setting or value. You can search a string, value, or regular
expression pattern and replace only that string. Replacements are made only if the filter criteria
match. For example, search for all monitors whose name value includes a server name that is no
longer in use. Replace the string representing the old server with a new string representing the
updated server.
HP SiteScope (11.23)
Page 106 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
Threshold Settings
Tip: We recommend using the Publish Changes feature to replace thresholds, since incorrect
threshold names can sometimes appear when changing Threshold Settings with GSAR. See
"Publish Changes to User-Defined Templates" on page 849.
When replacing threshold settings for monitors, by default you replace only those settings that
share all of the following:
l
Have the same condition (Error if, Warning if, or Good if).
l
Are configured for the same schedule.
l
Use the same operator type (< <=, > >=, ==, !=, contains, !contains).
Note: < (less than) and <= (less than and equal to) are considered the same operator type,
as are > (greater than) and >= (greater than and equal to).
You also have the option to override all the existing threshold settings that have the same condition
(Error if, Warning if, or Good if) regardless of the operator used and the schedule configured. The
option is called Override Category and appears in the Choose Changes page of the wizard under
the Threshold Settings panel if you selected Monitor in the Select Type page of the wizard.
For example, you want to change the Error if threshold settings for all CPU monitors to greater
than 85%. In the wizard, you select Monitor in the Select Type page, CPU in the Select Subtype
page, and expand the Threshold Settings panel in the Choose Changes page.
If you select the Override Category option when selecting greater than 85% as the New Error if
status condition, all the existing Error if settings for all CPU monitors are overwritten and changed
to greater than 85% when you complete the wizard.
If you leave the option cleared, the greater than 85% Error if setting you select in the wizard
replaces only those Error if settings that use the > (greater than) and >= (greater than and equal to)
operators and were configured for the same schedule for all CPU monitors.
For details on setting thresholds, see "Setting Status Thresholds" on page 274.
Tasks
How to Perform a Global Search and Replace
This task describes how to perform a global search and replace for objects, using the Global Search
and Replace Wizard.
1.
Begin running the Global Search and Replace Wizard
Right-click SiteScope root or the group or monitor in the monitor tree to which you want to
perform the global replace. To replace Preferences objects, right-click SiteScope root. To
replace alert objects, right-click SiteScope root, or the relevant group or monitor object. Select
Global Search and Replace from the context menu.
HP SiteScope (11.23)
Page 107 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
For user interface details, see the UI Descriptions section below.
2.
Select SiteScope (in SAM only)
Note: This step is only applicable when you access the Global Search and Replace
wizard from SAM.
In the Select SiteScope page, select one or more SiteScopes on which to run the search and
replace.
3.
Select object type
In the Select Type and Select Subtype page, select the object and, if relevant, the subtype on
which you want to make a replacement.
For user interface details, see "Select Type Page" on page 113 and "Select Subtype Page" on
page 114.
HP SiteScope (11.23)
Page 108 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
Example: To change the threshold boundaries for all CPU monitors, select Monitor as
the object type.
Select CPU as the specific monitor type.
4.
Search and replace objects
In the Replace Mode page, select the type of replacement. Select Replace to globally replace
the object or select Find and Replace to replace specific instances of the object. Optionally,
you can open the Advanced Filter dialog box to filter by the object properties. Here you select
on which objects to perform the replace operation. In the Choose Changes page, you select
what properties or values to replace.
For user interface details, see "Replace Mode Page" on page 114 and "Choose Changes
Page" on page 115.
HP SiteScope (11.23)
Page 109 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
Example: Reducing the Frequency of a Monitor Run on a Specific Server.
To reduce the frequency of how often a monitor runs on a specific server in your company,
filter your selection in the Monitor Settings panel in the Choose Changes page to include
only those monitors monitoring the specified server.
In the Monitor Run Settings panel, enter a new frequency of once a day, to monitor the
specified server.
HP SiteScope (11.23)
Page 110 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
Example: Setting Up Alert Action to Send Alert Messages to Specified Email Addresses.
If one of the email addresses you configured to receive alerts has changed, you can
update the email address that has changed. In the Select Type page, select Alert Action
as the object type, and in the Replace Mode page select Find and Replace.
In the Choose Changes page, enter the old email address in the Find field and the new
email address in the and replace with field.
5.
Check affected objects
In the Affected Objects page, view the affected objects and, if necessary, clear or select
objects for the replacement operation. Optionally, you can open the Filter Affected Objects
dialog box to filter by the object properties. Here you select on which objects to perform the
replace operation.
For user interface details, see "Affected Objects Page" on page 119.
HP SiteScope (11.23)
Page 111 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
Example: Reducing the Frequency of a Monitor Run on a Specific Server.
You want to reduce the frequency of how often a monitor runs on a specific server in your
company.
If you had selected Replace in the Replace Mode page, in the Choose Changes page, you
then enter a new frequency of once a day, to monitor the specified server.
The affected objects are displayed in the Affected Objects page.
HP SiteScope (11.23)
Page 112 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
You can filter your selection in the Filter Affected Objects page to include only those
monitors monitoring the specified server.
6.
Review replaced objects
In the Review Summary page, review the results of the replacement operation and click
Finish to complete the wizard. You can view a summary of the changes in the Summary page
to see which changes were implemented successfully and in which errors occurred.
For user interface details, see "Review Summary Page" on page 120 and "Summary Page" on
page 121.
UI Descriptions
Select SiteScope Page
This wizard page enables you to select the SiteScope on which to make replacements.
Note: This page appears only when you are working in System Availability Management
Administration.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
<SiteScope
machines>
Select one or more SiteScopes on which to run the search and replace.
Note: Only SiteScopes running version 9.0 and later and whose connection
status permits configuration changes from SAM are listed.
Select Type Page
This wizard page enables you to select the object type on which you want to make replacements.
HP SiteScope (11.23)
Page 113 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
User interface elements are described below:
UI Element
Description
<object type>
You can select only one object type for each replace operation. Only
those types of objects available for the node you selected are listed.
(Alert, Alert Action,
Group, Monitor,
Preference, Report)
When performing Global Search and Replace from SAM Administration,
group, monitor, alert, alert action, and preferences appear only if they
exist on at least one SiteScope selected in the previous page.
Select Subtype Page
This wizard page enables you to select the properties of the object type on which you want to make
replacements.
User interface elements are described below:
UI Element
Description
<Object type Displays properties of the object type. For example, if you selected Monitor as
properties>
the object type, it lists all monitor types for the selected SiteScopes.
Note: This page is not available if you selected the object type Group, Alert, or
Report in the "Select Type Page" on the previous page of the wizard.
Replace Mode Page
This wizard page enables you to select the type of replacement: global replacement or replacement
based on filter criteria.
User interface elements are described below:
UI
Element Description
Replace
Globally replaces all matching objects with the new string or value.
HP SiteScope (11.23)
Page 114 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
UI
Element Description
Find
and
Replace
Searches the target objects for properties that match a string or regular expression
and replaces only the matching pattern with the replacement value.
This method of replacement includes a search for specific settings and property
values and replaces only those objects with the entered setting or value. You can
select only a partial value and replace only that string.
Note:
l
If you select this option, only settings whose values can contain a string are
available in the settings area of the Choose Changes page and can be selected
for the find and replace action.
l
Use this setting to determine the selection and the value to replace. It differs from
the Advanced Filter option, which is a way to limit the selected objects but not the
value to replace.
Example: Search for all monitors whose name value includes a server name that is
no longer in use. Replace the string representing the old server with a new string
representing the updated server.
Choose Changes Page
This wizard page enables you to select what to replace for the global replace. The wizard displays
only the settings and properties that may be changed for the object type selected in the previous
pages. The filter criteria is built from your selections in the Type, Subtype, and Advanced Filter
pages.
HP SiteScope (11.23)
Page 115 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
Important
information
l
The subtype's properties may appear differently from how they appear when
editing a monitor, alert, preference, and so forth in SiteScope.
Examples: Mail Preferences is a text box in Global Search and Replace
utility rather than a drop-down list, and the Depends on property does not
appear in the Global Search and Replace utility.
l
The Server property is available only when monitors from the following group
are selected: CPU, Disk Space, Memory, Microsoft Windows Performance
Counter, Web Server, and Service monitor. For other monitors, you can only
change the server attribute by selecting that specific monitor subtype in the
Select Subtype page. For example, if a CPU monitor is selected with a Web
Server monitor, the server property is available. If a monitor not from this group
is also selected, the server property is not available.
l
Note for users of SiteScope within SAM Administration: If the
SiteScopes selected for the replace operation are not all the same version, the
subtypes of the SiteScopes may have different properties.
l
Using GSAR to replace values in URL Sequence monitors that do not all
contain the same number of steps (x), might result in monitors with less than x
steps containing irrelevant values.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Find
Replace
With
Description
If you chose the Find and Replace option in the Replace Mode page, the text
boxes Find and Replace With are added to the top of this page.
l
In the Find box, enter the search string, value, or regular expression pattern for
the setting or property you want to replace.
l
In the Replace With box, enter the string or value to which you want all matching
patterns to be changed.
Note: If you select Frequency in the Monitor Run Settings, the values you enter in
the Find and Replace With text boxes must be in seconds. For example, you want
to find monitors with a frequency of 10 minutes and change the frequency to 20
minutes. In the Find text box, enter 600 and in the Replace With text box enter
1200.
If no objects are found that meet the filter criteria, an error message appears.
Reselect your filter criteria.
HP SiteScope (11.23)
Page 116 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
UI
Element
Description
<Settings This area includes the settings for the object you selected. For details about these
area>
settings, refer to the selected object's settings page.
l
If you selected Find and Replace in the Replace Mode page, you select only the
setting in the settings area. Enter the old and new values to replace in the
Find/Replace with boxes.
l
If you selected Replace in the Replace Mode page, you select the setting and
the new value in the settings area.
For details about some of the areas:
Threshold Settings Area
l
The Threshold Settings area appears only if you select Monitor in the Select
Type page, and one monitor in the Select Subtype page. It is not displayed if you
select more than one monitor in the Select Subtype page, and one of the monitors
does not include threshold definitions.
l
The Override Category option is displayed only if you selected Monitor in the
Select Type page:
n
When this option is selected, you can override the threshold settings of the
same threshold condition (Error if, Warning if, or Good if) for the selected
monitor instances with the settings you enter here for the replace operation.
n
When this option is cleared, the settings you enter here replace only those
settings with the same operator type (< <=, > >=, !=, ==, contains,
doesNotContain)) and the same configured schedule for the monitor
instances. Any other settings for the same condition but with a different
operator type or a different schedule remain. For details on this option and an
example, see "Threshold Settings" on page 107.
Filter Settings Area
If you selected Alert in the Select Type page, the Monitor type match field in the
Filter Settings is not displayed and its values cannot be replaced in the wizard.
Server Settings Area
The Server Settings area appears only if you select Monitor in the Select Type
page, and one monitor in the Select Subtype page. It is not displayed if you select
more than one monitor in the Select Subtype page, and these monitors do not belong
to the same family, as listed in the table below:
HP SiteScope (11.23)
Page 117 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
UI
Element
Description
Family of Monitors
Monitors
SAP monitors
l
SAP CCMS
l
SAP CCMS Alerts
l
SAP Java Web Application Server
l
SAP Performance
l
SAP Work Processes
l
Cisco
l
F5 Big-IP
l
Network Bandwidth
l
SNMP by MIB
l
URL
l
URL List
l
URL Content
l
URL Sequence
l
Microsoft Windows Media Player
l
Real Media Player
SNMP monitors
URL monitors
Media Player monitors
HP SiteScope (11.23)
Page 118 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
UI
Element
Description
Family of Monitors
Monitors
Windows Counters monitors
l
ASP
l
Citrix
l
ColdFusion
l
Microsoft Hyper-V
l
Microsoft IIS Server
l
Microsoft SQL Server
l
Microsoft Windows Media
l
Real Monitor
l
CPU
l
Disk Space
l
Memory
l
Microsoft Windows Performance Counter
l
Service
l
UNIX Resources
l
Web Server
Server monitors
Affected Objects Page
This wizard page enables you to view the objects that you selected to change. The page displays
the selected objects in tree format. You can clear or select objects in the Affected Objects tree for
the replacement operation.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Description
Filter. Optionally, click to open the dialog box if you want to further refine your
selections. For user interface details, see "Filter Affected Objects Dialog Box" on
the next page.
HP SiteScope (11.23)
Page 119 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
UI
Element
Description
<Affected The Affected Objects tree includes all objects that are matched against the filter
Objects
criteria selected in the previous pages of the wizard.
tree>
Select or clear objects as required for the replace operation.
Note:
l
When using Global Search and Replace from SAM Administration, a tree is
displayed for each SiteScope selected.
l
The objects displayed depend on whether the user has change permissions on
those objects.
l
n
In SAM Administration, the permissions are set in BSM's Permissions
Management (Admin > Platform > Users and Permissions).
n
In SiteScope standalone, the permissions are set in Preferences > User
Management Preferences.
If you selected Find and Replace in the Replace Mode page, replacements are
made only if the filter criteria are matched. If you selected Replace,
replacements are made in all selected objects.
Filter Affected Objects Dialog Box
This dialog box enables you to select objects based on their specific settings and not only based on
object type. For example, you can select all alerts that have a defined category of critical and
replace any setting for those alerts. You can also select all groups with a dependency set to a
specific monitor or group and replace any setting for those groups.
To access, click the Filter
button in the "Affected Objects Page" on the previous page.
Note: Using this option only refines your selection for the replace and does not determine what
to replace.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Description
<Settings The setting areas pertinent to the object you selected appear. For details about
areas>
these settings, refer to the selected object's settings page. Select the properties and
enter the values by which to filter the selected objects.
Review Summary Page
This wizard page enables you to preview the objects on which the replacement operation is
performed. When working with multiple SiteScopes in SAM Administration, a table appears for
HP SiteScope (11.23)
Page 120 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
each SiteScope and the name of the SiteScope appears above the table.
Important
information
l
The number of objects that are affected by the global replacement is displayed
above the table.
l
Each table column can be sorted in ascending or descending order by rightclicking the column title. An up or down arrow indicates the sort order.
l
Once you click Apply in this page, you cannot undo the replacement
operation.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
Change the sort order in the columns by clicking the up and down arrow
in the column title.
Default: The Full Name column is in alphabetical order, from top to
bottom.
Full Name
Displays a tree of the server name, group, monitor name, and the
monitor's properties whose value is being replaced.
<property>
The box name that you marked in the Choose Changes page that
changes as a result of the replace operation.
Previous Value
The current value that changes as a result of the replace operation.
Note: If the value being replaced is a check box that was cleared and is
now being selected, you may not see the previous value (cleared) for the
check box.
New Value
The new value that you entered in the Choose Changes page.
Verify monitor
properties with
remote server
Verifies the correctness of the monitor configuration properties against
the remote servers on which the changes are being made.
Default value: Selected
Note: When this option is selected, it takes more time to make changes
due to the remote connections.
Summary Page
The Summary page reports the changes that were implemented successfully and those in which
errors occurred. The page displays the changes in table format. When working with multiple
SiteScopes in SAM Administration, a table is displayed for each SiteScope and the name of the
SiteScope appears at the top of the table.
HP SiteScope (11.23)
Page 121 of 1293
Using SiteScope
Chapter 13: Global Search and Replace
Important
information
l
There is no way to undo changes made by the replace operation.
l
The number of objects affected by the global replacement is given above the
table.
l
Each table column can be sorted in ascending or descending order by rightclicking the column title. An up or down arrow indicates the sort order.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Description
Change the sort order in the columns by clicking the up and down arrow in the
column title.
Default: The Full Name column is in alphabetical order, from top to bottom.
Click to open a report of the results in a PDF file.
Note: This option is available only to users accessing Global Search and Replace
from SAM Administration.
Click to open a report of the results in a CSV format file.
Note: This option is available only to users accessing Global Search and Replace
from SAM Administration.
Print. Click to print the table. This icon appears for each table in the summary.
Full Name
Displays a tree of the server name, group, monitor name, and the monitor's
properties whose value is being replaced.
<property> The box name that you marked in the Choose Changes page that changes as a
result of the replace operation.
Previous
Value
The value that was replaced in the global replace operation.
New Value
The new value that resulted from the global replace operation.
Apply
Closes the wizard.
HP SiteScope (11.23)
Page 122 of 1293
Chapter 14: SiteScope Tools
SiteScope provides a number of diagnostic tools that are useful to test the monitoring environment.
You can use these tools before configuring a monitor to uncover issues and facilitate monitor
configuration, and after configuring a monitor to troubleshoot and diagnose problems.
To access
l
Select the Tools context. The Tools menu options are displayed in the left pane (provided you
are an administrator in SiteScope, or a user granted Use tools permissions).
l
Some tools are also available when configuring or editing specific monitors (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions). If a tool is
available when configuring or editing a monitor (see "Testing Monitor Configuration Using
Diagnostic Tools" on page 1008), you can access the tool by:
n
Clicking the Use Tool
button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
Clicking the Tools button in the SiteScope Dashboard toolbar when running the test tool for
an existing monitor. This opens and runs the tool with the monitor's existing data as its input,
and displays test results in the Results pane.
Learn About
SiteScope Tools Overview
Use these tools to make a variety of requests and queries of systems you are monitoring and to
view detailed results of the action. Requests may include testing network connectivity or verifying
login authentication for accessing an external database or service.
Some tools are available when configuring specific monitor types to help you configure the monitor
settings. You enter data into the tool fields, and SiteScope tests the data. After SiteScope tests the
data , you can apply the tested data directly to the monitor configuration form. For example, before
configuring a DNS monitor, you can use the DNS Tool to translate a domain name to an IP address.
After the name has been translated, SiteScope can apply the data to the new monitor.
For the list of SiteScope tools that are available and tool descriptions, see "Tools Menu" on page
67.
HP SiteScope (11.23)
Page 123 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Tasks
How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor
This task describes the steps involved in using a SiteScope tool to assist you to configure or
troubleshoot a monitor.
1. Prerequisites
n
To view and use the tools in the Tools context in the left pane, you must be a SiteScope
administrator user, or a user granted Use tools permissions.
n
To use the tools that are available when configuring specific monitors, you must be a
SiteScope administrator user, or a user granted Use monitor tools permissions.
2. Add and configure a monitor
Select New > Monitor, and add a new monitor from the New Monitor dialog box. If a tool is
available to help you configure the monitor, click the Use Tool button at the bottom of the new
monitor dialog box.
3. Configure and run the test
Enter the required information in the tool dialog box, and run the tool. Any server-side validation
errors are displayed in the result pane.
4. Apply the tested data to the monitor fields
After the configuration data has been successfully tested, click the Apply to New Monitor
button (or Apply to Monitor button when editing an existing monitor) to have SiteScope apply
the data to the monitor configuration.
5. Use a tool to edit or test monitor properties - optional
You can also use SiteScope tools, where available, to edit or test configuration properties for
existing monitors.
n
To edit monitor configuration properties, click the Use Tool button in the monitor Properties
tab, and complete the two previous steps.
n
To open and run the tool with the monitor's existing data as its input, click the Tools
button in the SiteScope Dashboard toolbar. The test results appear in the Results pane. To
save the results to a file, click the Save to File button.
How to Use the Log Analysis Tool – Use-Case Scenario
This task describes the steps involved in using the Log Analysis Tool when you want to configure a
Log File monitor.
The administrator wants to create a Log File monitor for the most common problems or situations
that are described in the log to be monitored. Once he selects the situation and creates the
HP SiteScope (11.23)
Page 124 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
corresponding Log File monitor, the monitor runs as soon as a line corresponding to the selected
situation is added to the log.
1. Prerequisites
n
To view and use the tool in the Tools context in the left pane, the administrator must be a
SiteScope administrator user, or a user granted Use tools permissions.
n
To use the tools that are available when configuring specific monitors, the administrator
must be a SiteScope administrator user, or a user granted Use monitor tools permissions.
2. Copy the log to analyze
The administrator copies the log he wants to analyze to the local SiteScope machine.
3. Run the Log Analysis Tool on that log
a. The administrator selects Tools > Common Utility Tools > Log Analysis Tool.
b. In the Log Analysis Tool dialog box, the administrator enters:
o
File location. The location of the log copied to the local SiteScope server. To analyze
several files at the same time, copy the files to the designated folder and create a regular
expression that matches the file names of the log files to be analyzed.
o
Message position. The number of blocks (separated by blanks) that are to the left of
the message to analyze for patterns.
For example, in the log structure that follows, the part of the log entry you are interested
in is the message that starts after the 7th blank space (the space inside the date format
is not included as it is part of the date format).
2010-11-02 11:49:02,738 [SiteScope Main Thread] (SiteScopeHeartbeatMana
ger.java:53) INFO - The Heartbeat Scheduler was started.
2010-11-02 11:49:02,786 [SiteScope Main Thread] (ServiceController.java
:82) INFO - Registering service: Host DNS Resolution Service
o
Location of the date in the pattern. The order of the block of text where the date is
located. In the example above, the date is part of the first block of text.
o
Date format. In the example above, the date format follows the default. The default
includes blanks.
o
The administrator clicks Run Tool.
The Results box, in the Log Analysis Tool dialog box, displays the Regular Expression
HP SiteScope (11.23)
Page 125 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
patterns found in the log and the number of instances of the pattern.
c. The administrator selects the relevant pattern and clicks the Create New Log File
Monitor button. In the Select group dialog box that opens, the administrator can select an
existing group or create a new group by clicking the New Group button.
The New Log File Monitor dialog box opens, with the selected regular expression
displayed in the Content match box.
d. In that dialog box, the administrator enters the rest of the information needed to run the Log
File monitor, including the path to the "real" log you want to analyze.
e. The administrator clicks Save to save the new Log File monitor.
4. Results
The Log File monitor watches for specific entries added to the monitored log file that contain
the selected regular expression. Depending on the monitor configuration, the administrator or
the user can be notified of these conditions that you may have otherwise been unaware of until
something more serious happened.
The new Log File monitor tool the administrator created is listed in the selected group in the
monitor tree.
For details on the user interface, see "Log Analysis Tool" on page 141.
For details on the Log File monitor, see Log File Monitor in the SiteScope Monitor Reference
Guide.
HP SiteScope (11.23)
Page 126 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Tips/Troubleshooting
Notes and Limitations
To avoid character set problems when the SiteScope client uses a multibyte locale different from
the SiteScope server, set the value in the <SiteScope root directory>\groups\master.config file
for the _httpCharset setting to UTF-8. By default, the _httpCharset value is empty, which means
that the default server locale is used.
Database Connection Tool
This tool enables you to test and verify connectivity between SiteScope and an external ODBC or
JDBC compatible database. This diagnostic tool checks to see if:
l
The supplied database driver can be found and loaded.
l
A connection can be made to the database.
l
An optional SQL query can be run and the results displayed.
l
The database connection and resources can be closed.
This tool can be useful in verifying connection parameter values needed to set up database
monitors, database alerts, and database logging.
To access
l
Select Tools context > Database Tools > Database Connection Tool (you
must have Use tools permissions)
l
Also available when configuring or viewing the Database Counter monitor,
Database Query monitor, DB2 JDBC monitor, or Technology Database
Integration monitor (provided you are an administrator in SiteScope, or a user
granted Use monitor tools permissions):
HP SiteScope (11.23)
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the
monitor's existing data as its input, and displays the test results in the
Results pane.
Page 127 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Important
information
l
If exceptions or errors occur during the test, the information is printed along
with suggested actions to help with troubleshooting.
l
When using the Database Connection Tool to apply properties to the Database
Query monitor or Technology Database Integration monitor, you must enter the
credential data manually (if you select a credential profile the credential data is
lost).
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Database
connection
URL
Database connection URL used when setting up the monitor. When using the
Oracle thin driver, the database connection URL has the form of:
jdbc:oracle:thin:@<server name or IP address>:<port>:
<database sid>.
Example: To connect to the ORCL database on a machine using port 1521, enter
jdbc:oracle:thin:@206.168.191.19:1521:ORCL. The colon (:) symbol must be
included as shown. For other examples of common database connection URLs,
see the "Setup Requirements and User Permissions" section for the relevant
database monitor.
Note: 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 User Name and Password boxes empty so that the credentials of the
currently logged on Windows user (the account from which SiteScope service is
running) are used to establish a connection to the database.
Database
driver
JDBC or ODBC driver that SiteScope should use. The .jar file or library containing
the .class file must be installed in the <SiteScope root directory>\WEB-INF\lib
directory. To use a database other than jdbc:odbc:orders, you must install the
driver files into the proper directory before SiteScope can use them.
Default value: sun.jdbc.odbc.JdbcOdbcDriver
Example: For examples of common database driver strings, see the "Setup
Requirements and User Permissions" section for the relevant database monitor.
HP SiteScope (11.23)
Page 128 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Credentials Option for authorizing credentials if the database specified requires a name and
password for access:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password to access the database in the
User name and Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password for the database
(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" on page 574.
Query
(Optional) SQL query to run on the database. If you do not supply a SQL query
string, the driver is loaded and the connection to the database is tested but no
query is run.
Result set
maximum
columns
Maximum number of columns to display in the query result set if you entered a
SQL Query.
Result set
maximum
rows
Maximum number of rows to display in the query result set if you entered a SQL
Query.
Run Tool
Runs the connection test. Connection results are displayed in the Results pane.
Save to
File
Saves the results to a file.
Default value: 10
Default value: 10
Example
The following is an example of the data returned from a successful database connection with a SQL
query (limited to one row).
group
serverName ID
10.0.0.157
frame setting
frameIndex ID
Name
master. 1
config
HP SiteScope (11.23)
_
_
config database
Max
Summary
line
settingLine Chunk chunkValue
1
1
200
Page 129 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Database Information Tool
This tool enables you to view database server metadata such as product and driver version, SQL
compatibility level information, and supported SQL functions.
To access
Select Tools context > Database Tools > Database Information Tool (you
must have Use tools permissions)
Important
information
Different database drivers and user names can significantly change what
information is displayed.
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Database
connection
URL
Database connection URL used when setting up the monitor. When using the
Oracle thin driver, the database connection URL has the form of:
jdbc:oracle:thin:@<server name or IP address>:<port>:
<database sid>.
Example: To connect to the ORCL database on a machine using port 1521, enter
jdbc:oracle:thin:@206.168.191.19:1521:ORCL. The colon (:) and the (@)
symbols must be included as shown. For other examples of common database
connection URLs, see the "Setup Requirements and User Permissions" section
for the relevant database monitor.
Database
driver
JDBC or ODBC driver that SiteScope should use. The .jar file or library containing
the .class file must be installed in the <SiteScope root directory>\WEB-INF\lib
directory. To use a database other than jdbc:odbc:orders, you must install the
driver files into the proper directory before SiteScope can use them.
Default value: sun.jdbc.odbc.JdbcOdbcDriver
Example: For examples of common database driver strings, see the "Setup
Requirements and User Permissions" section for the relevant database monitor.
HP SiteScope (11.23)
Page 130 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Credentials Option for authorizing credentials if the database specified requires a name and
password for access:
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password to access the database in the
User name and Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password for the database
(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" on page 574.
Run Tool
Runs the tool and displays database information. Test results are displayed in the
Results pane.
Save to
File
Saves the results to a file.
DNS Tool
This tool enables you to look up names from a Domain Name Server and show you the IP address
for a domain name. It also shows you information about the name servers for a domain.
You can use this utility to verify that your DNS server is returning the correct addresses for your
own servers. You can also use it to verify that it can look up the addresses for external domains.
To
access
l
Select Tools context > Network Tools > DNS Tool (you must have Use tools
permissions)
l
Also available when configuring or viewing the DNS monitor (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 131 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI
Element Description
DNS
server
IP address or host name of a DNS server. If left empty, the local DNS server is used.
Host
name to
resolve
Domain name that you want translated into an IP address.
Run
Tool
Runs the test. The tool sends the request to the DNS server entered in the DNS
server box and displays the IP address for the host name entered in the Host name
to resolve box. The results of the test are displayed in the Results pane.
Save to
File
Saves the results to a file.
Event Log Tool
This tool enables you to view portions of the Windows event log locally or on a remote server.
To access
Important
information
l
Select Tools context > Operating System Tools > Event Log Tool (you
must have Use tools permissions)
l
Also available when configuring or viewing the Microsoft Windows Event Log
monitor (provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the
monitor's existing data as its input, and displays the test results in the
Results pane.
l
Different database drivers and user names can significantly change what
information is displayed.
l
This tool is not supported on SiteScopes installed on UNIX platforms.
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 132 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI
Element
Server
Description
The server on which you want to monitor event logs. 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.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Select the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor. A double slash ("\\") is automatically prefixed to any machine name
supplied in the Enter server name box.
Note: You must have domain privileges or authenticated access to the Windows
remote server. For details on how to configure a remote Windows server, see
"Configure SiteScope to Monitor Remote Windows Servers" on page 490.
Add
Remote
Server
Add and configure the remote server. For user interface details, see "New/Edit
Microsoft Windows Remote Server Dialog Box" on page 495.
Log
name
Select the type of log file you want to view:
l
Application
l
Directory Service
l
DNS
l
File Replication Service
l
Security
l
System
Default value: System
Number
Number of entries to list for this event log. The most recent entries in the log are
of events displayed first.
displayed
Default value: 10
HP SiteScope (11.23)
Page 133 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI
Element
Description
Run Tool
Runs the test and refreshes the log entry listing. Log entries are displayed in the
Results pane.
Save to
File
Saves the results to a file.
FTP Tool
This tool enables you to access an FTP server and view the interaction between SiteScope (acting
as an FTP client) and the FTP server. For example, if you receive an alert from SiteScope indicating
that your FTP server is not working properly, the first step is to use this tool to help track down the
problem.
To
access
l
Select Tools context > Web Tools > FTP Tool (you must have Use tools
permissions)
l
Also available when configuring or viewing the FTP monitor (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI
Element
Description
Basic FTP Settings
FTP
server
IP address or the name of the FTP server that you want to test.
Example: 206.168.191.22 or ftp.thiscompany.com
HP SiteScope (11.23)
Page 134 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI
Element
Description
File
File name to retrieve.
Example: /pub/docs/mydoc.txt
User
name
Name used to log on to the FTP server.
Password Password used to log on to the FTP server.
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
Passive
mode
SiteScope uses a passive FTP connection. This is commonly required to access
FTP servers through a firewall.
HTTP Proxy Settings
HTTP
proxy
Proxy name or IP address if you want to use a proxy server for the FTP test.
Proxy
user
name
Name used to log into the proxy server.
Proxy
password
Password used to log into the proxy server.
Run Tool
Runs the test. Check The results of the test are displayed in the Results pane.
Save to
File
Saves the results to a file.
Example
The following is a sample output from the FTP tool. In this case, the FTP server enabled us to
log on without a problem, indicating that the server is running and accepting requests. The
failure is caused when the server was unable to locate the file that was requested: file.txt.
Correcting this particular problem may be as easy as replacing the missing file or verifying the
file location.
Received:
Sent:
Received:
ord.
Sent:
220 public Microsoft FTP Service (Version 2.0).
USER anonymous
331 Anonymous access allowed, send identity (e-mail name) as passw
PASS anonymous
HP SiteScope (11.23)
Page 135 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Received: 230 Anonymous user logged in.
Sent:
PASV
Received: 227 Entering Passive Mode (206,168,191,1,5,183).
Connecting to server 206.168.191.1 port 1463
Sent:
RETR file.txt
Received: 550 file.txt: The system cannot find the file specified.
Sent:
QUIT
Received: 221
LDAP Authentication Status Tool
This tool enables you to verify that a Lightweight Directory Access Protocol (LDAP) server can
authenticate a user by performing a simple authentication.
To access
l
Select Tools context > Database Tools > LDAP Authentication Status Tool
(you must have Use tools permissions)
l
Also available when configuring or viewing the LDAP monitor or Active
Directory Replication monitor (provided you are an administrator in SiteScope,
or a user granted Use monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 136 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI
Element
Security
principal
Description
The constant that holds the name of the environment property for specifying the
identity of the principal that authenticates 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. This should be in the format:
uid=testuser,ou=TEST,o=mydomain.com.
Note: SiteScope does not support users that contain one or more of the following
character inside the users name: equal ("="), semicolon (";"), inverted commas (""").
Security
The constant that holds the name of the environment property for specifying the
credential credentials of the principal for authenticating the caller to the service. The value of
the property depends on the authentication scheme. For example, it could be a
hashed password, clear-text password, key, certificate, and so on. If this property is
unspecified, the behavior is determined by the service provider.
LDAP
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. 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.
Example: ldap://<somehost>:389
Object
query
An object query to look at a LDAP object other than the default user dn object. You
must enter a valid object query in this text box if you are using a LDAP filter. For
details about the search filter, see the description below.
Example: Enter the mail object to check for an email address associated with the
dn object entered above.
LDAP
filter
Searches LDAP using the filter criteria. The LDAP filter syntax is a logical
expression in prefix notation meaning that logical operator appears before its
arguments.
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
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.
Run Tool
Runs the test. LDAP Authentication test results are displayed in the Results pane.
Save to
File
Saves the results to a file.
HP SiteScope (11.23)
Page 137 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Link Check Tool
This tool enables you to verify all the internal and external links on a Web page to ensure that they
can be reached. It checks the URL specific parameters, such as Web page availability, size,
content type, and average time for retrieving a page.
Each time you run the tool, results are displayed in the Results pane. You can export the results to
an Excel of PDF file.
To access
l
Select Tools context > Web Tools > Link Check Tool (you must have Use
tools permissions)
l
Also available when configuring or viewing the Link Check monitor (provided
you are an administrator in SiteScope, or a user granted Use monitor tools
permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the
monitor's existing data as its input, and displays the test results in the
Results pane.
Important
information
Depending on data type, the data in the table can be sorted in ascending or
descending order, or it can be filtered by time, size, type, internal/external data, or
count.
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
Link Check Tool Panel
User interface elements are described below:
UI Element
Description
Main Settings
HP SiteScope (11.23)
Page 138 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
URL
URL that is the starting point for checking links. The link tool 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. It checks links to other servers, but it
does not check all the links of those other servers.
Example: http://demo.thiscompany.com
Pause
Delay, in milliseconds, between each link check. Larger numbers lengthen the
(milliseconds) total time to check links but decrease the load on the server.
Default value: 15 milliseconds
Timeout
(seconds)
Amount of time, in seconds, that the tool should wait for a page to begin
downloading before timing-out. Once this time period passes, the URL monitor
logs an error and reports an error status.
Default value: 5 seconds
Maximum
links
Maximum number of links this tool 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: 100
Use monitor
run result
data
If selected, the tool displays link check result data from the last monitor run.
Note: This check box is available if the tool is run from the Dashboard only (it is
not available if run from the Tools panel).
Default value: Selected
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.
HP SiteScope (11.23)
Page 139 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Proxy server
password
Proxy server password if the proxy server requires a name to access the URL.
Run Tool
Runs the test and displays the results in the Results pane. Each link in the
URL is displayed on a separate line with the followed information. For details,
see "Results Panel" below.
Note: Your proxy server must support Proxy-Authenticate for these options to
function.
Results Panel
User interface elements are described below:
UI
Element
Description
Export to Excel/PDF. Enables you to save link check results by exporting them to
an Excel or PDF file.
Edit the filter. Enables filtering the data displayed in the table.
Operator. Click the down-arrow to select the operator (= Equals, != Not the same
as, < Less than, <= Less than or equal to, > Greater than, >= Greater than or equal
to, In - contains the value entered).
Apply current filter. Click the green check to apply the filter.
Clear current filter. Click the trash can to clear the filter.
Change visible columns. Enables you to select the columns you want to display
in the table.
The Status and Time columns are always displayed.
Status
The status of the link in the URL:
l
ok
l
error
If error status displayed, an error description is included.
For example, bad request, unauthorized, unable to connect, timed out
reading.
Size (K
bytes)
The size of the Web page available from the link.
Time
Response time for the link in the URL.
HP SiteScope (11.23)
Page 140 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI
Element
Description
Est. time Estimated time in seconds.
(seconds)
Content
Type
The content type of the link in the URL.
URL
The URL of the link. Click the hyperlink to open the link page.
Source
Page
The source page of the link. Click the hyperlink to open the source page.
External
Indicates whether the link is external (yes) or internal (no) .
Count
The number of links to get to the URL page.
Log Analysis Tool
This tool enables you to scan a log file to indicate recurring patterns in the file. Once the tool has
listed the patterns, you can have the tool create a SiteScope Log File monitor to monitor that pattern
in the log.
To access
Select Tools context > Common Utility Tools > Log Analysis Tool (you must
have Use tools permissions)
Important
information
l
If the structure of the log you want to analyze is not consistent, you cannot use
this tool.
l
After you have created the Log File monitor for a pattern discovered by the Log
Analysis Tool, the new monitor is listed in the monitor tree.
l
To tell the Log Analysis Tool where the text you want to analyze is located in
the log file, you can provide a regular expression or the number of blocks of text
before the text you want to analyze.
Limitation: The size of the log file you want to analyze should not be more than
10 MB.
Relevant
tasks
See also
l
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
l
"How to Use the Log Analysis Tool – Use-Case Scenario" on page 124
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 141 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI Element
Description
Log Analysis Tool Area
Folder
location on
SiteScope
Server
Enter the path of the folder, on the SiteScope server, where the log files to be
analyzed are located.
File name
Enter the name of the log file to be analyzed. To analyze several files at the same
time, copy the files to the designated folder and create a regular expression that
matches the file names of the log files to be analyzed.
Example: enter /error/ to analyze the error123.log and error345.log at the
same time.
Use regular
expression
You can provide a regular expression or the number of blocks of text before the
text you want to analyze.
Select this option to use a regular expression to find the text you want to analyze
in the log file.
Regular
expression
Enter the regular expression you want the tool to use to find the text you want to
analyze. The regular expression must be entered between slashes (/).
This field is enabled only when you select the Use regular expression option.
Example: For examples of regular expressions, see "Examples of Regular
Expressions" on the next page.
Number of
blocks
before
message
Log files include lots of information. The Log Analysis Tool is looking for patterns
in the message (for example, the message after INFO or ERROR).
This field is not enabled when you select the Use regular expression option.
To indicate to the tool where the message to analyze starts, you must specify
the number of blocks of text (strings) separated by blank spaces that appear in
each line of the log, before the start of the message you want to analyze. Ignore
the blanks in the date if the date format includes blanks (see Date format below).
Note: Logs that do not have a consistent structure cannot be analyzed by this
tool.
Order of
block where
date is
located
Enter the order of the block of text where the date is located counting from the
left. The number of the first block is 1.
Date format
Select the date format used in the log.
This field is disabled when you select the Use regular expression option.
Default format:yyyy-mm-dd HH:mm:ss,SSS
HP SiteScope (11.23)
Page 142 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Tool
timeout (in
seconds)
Amount of time, in seconds, to wait for the Log Analysis tool to run before timing
out.
Run Tool
Runs the test. A list of all recurring message patterns is displayed in the Results
box.
Default value: 30 seconds
Results Area
Create New
Log File
Monitor
Select a pattern and click the button to open the Select group dialog box where
you can select a existing group or create a new group by clicking the New Group
button. The New Log File Monitor dialog box opens, with the selected regular
expression displayed in the Content match box.
Message
Pattern
Displays a list of patterns found in the log.
The list is ordered according to the number of occurrences of the patterns.
Number of
Displays the number of instances of each pattern.
Occurrences
The list is ordered according to the number of occurrences of the patterns.
Examples of Regular Expressions
Use the following regular expression:
\d*-\d*-\d*\s\d*.*,\d*\s\[\w.*\]\s\(\w.*\)\s\w.*\s\-\s
where d indicates a digit, w indicates a word, s indicates a space, and * indicates any character, for
a log with the following structure:
2010-11-02 11:49:02,738 [SiteScope Main Thread] (SiteScopeHeartbeatManager.j
ava:53) INFO - The Heartbeat Scheduler was started.
2010-11-02 11:49:02,786 [SiteScope Main Thread] (ServiceController.java:82)
INFO - Registering service: Host DNS Resolution Service
2010-11-02 11:49:02,951 [SiteScope Main Thread] (ServiceController.java:82)
INFO - Registering service: Monitor History Event Sink Service
2010-11-02 11:49:03,035 [SiteScope Main Thread] (ServiceController.java:82)
INFO - Registering service: Alert Action Execution Counter Registry Service
2010-11-02 11:49:03,035 [SiteScope Main Thread] (ServiceController.java:82)
ERROR - Connection Error while trying to connect
2010-11-02 11:49:03,037 [SiteScope Main Thread] (ServiceController.java:82)
INFO - Registering service: Alert Open Status Registry Service
2010-11-02 11:49:03,277 [SiteScope Main Thread] (SiteScopeSupport.java:655)
INFO
Use the following regular expression:
\d*\s\w*\s\w*\s\**\d*\**\s\-\s
HP SiteScope (11.23)
Page 143 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
where d indicates a digit, w indicates a word, s indicates a space, and * indicates any character, for
a log with the following structure:
123 Error starts *****12****
123 Error starts *****23****
ice
123 Error starts *****34****
nk Service
123 Error starts *****45****
ounter Registry Service
123 Error starts *****45****
ounter Registry Service
- The Heartbeat Scheduler was started.
- Registering service: Host DNS Resolution Serv
- Registering service: Monitor History Event Si
- Registering service: Alert Action Execution C
- Registering service: Alert Action Execution C
Mail Round Trip Tool
This tool enables you to check a Mail Server by using the network to verify that the mail server is
accepting requests and 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 which it checks for to ensure
that it does not retrieve the wrong message and return a false OK reading.
To
access
l
Select Tools context > Mail Tools > Mail Round Trip Tool (you must have
Use tools permissions)
l
Also available when configuring or viewing the Mail monitor (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Basic Mail Settings
HP SiteScope (11.23)
Page 144 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Action
Select the action to take:
l
Send and receive. Enables you to send a test message to an SMTP server
and then receive it back from the POP3 or IMAP4 server to check that the
mail server is up and running. (Default option)
l
Receive only. Checks 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.
l
Send only. 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. Use the POP3 option to check the
POP3 mail server for a sent message. Use the IMAP4 option to check the
IMAP mail server for a sent message.
Example: mail.thiscompany.com
Default value: POP3
Receiving
email server
Host name of the POP 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
Receiving
email server
user name
POP user account name. A test email message is sent to this account and the
logs in to the account to verify that the message was received. No other mail in
the account is touched. You can use your own personal mail account or another
existing account for this purpose.
Note: If you use an email reader that automatically retrieves and deletes
messages from the server, there is a chance that the Mail Round Trip Tool
never sees the mail message and reports an error.
Receiving
email server
password
HP SiteScope (11.23)
Password, if necessary, for the test mail account.
Page 145 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Receive only
String of text to match against the contents of the incoming message. If the
content match text is not contained in the incoming message, the Mail Round Trip reports an
error. This is for the receiving only option (for example, Subject:MySubject).
The search is case sensitive.
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 can perform a regular expression match by enclosing the string in forward
slashes, with an i after the trailing slash indicating case-insensitive matching.
An example might be "/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+)/ ). This returns the temperature as it appears on the page.
Advanced Mail Settings
Timeout
(seconds)
Number of seconds to wait for a mail message to be received before timing-out.
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: 300 seconds
Default value: 10 seconds
NTLM
NTLM version (version 1 or 2) if NTLM authentication is used by the email
authentication server.
Default value: none
SMTP SSL
Enables sending emails securely via SSL SMTP servers.
Note: SMTP SSL uses port 465 only of the SMTP mail server (the port cannot
be changed).
Default value: Not selected
Show details
Displays details of the round trip test.
Run Tool
Runs the test. Check mail server test results are displayed in the Results
pane.
Save to File
Saves the results to a file.
Microsoft Windows Media Player Tool
This tool enables you to test Microsoft Windows Media Player streaming.
HP SiteScope (11.23)
Page 146 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
To
access
l
Select Tools context > Application Tools > Microsoft Windows Media Player
Tool (you must have Use tools permissions)
l
Also available when configuring or viewing the Microsoft Windows Media Player
monitor (provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
URL
URL of the media file or streaming source you want to test. This should be the
URL of the media file.
Example: mms://<servername>/sample.asf for a unicast stream or
http://<servername>/stationid.nsc for a multicast stream using a
Windows Media Server multicast station program.
Note: This monitor does not support the .asx or .mov formats.
Duration
Playback duration that the tool should use for the media file or source. The
(milliseconds) duration value does not need to match the duration of the media contained in
the file.
If the media content of the file or source you are testing is less than the duration
value selected for the test, the monitor plays the entire media content and
reports the results, including the time required to play the media content.
Run Tool
Runs the test. Check mail server test results are displayed in the Results
pane.
Save to File
Saves the results to a file.
Network Status Tool
This tool reports the current network interface statistics and lists the active network connections.
This information can be useful to determine the health of you network interface. You can also use
HP SiteScope (11.23)
Page 147 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
this tool to track down problems, where network connections are being left open, or runaway
conditions, where an increasing number of connections are being opened without being closed.
To access
Select Tools context > Network Tools > Network Status Tool (you must
have Use tools permissions)
Important
information
This tool is not supported on SiteScopes installed on UNIX platforms.
Relevant tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor"
on page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI
Element
Description
Run
Tool
Runs the Network Status Tool and reports the network information. The data
appears in the Results pane.
Save to
File
Saves the results to a file.
News Server Tool
This tool enables you to access a News server and view the NNTP interaction between SiteScope
(acting as a news client) and the News server.
To
access
l
Select Tools context > Application Tools > News Server Tool (you must have
Use tools permissions)
l
Also available when configuring or viewing the News monitor (provided you are an
administrator in SiteScope, or a user granted Use monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 148 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI Element
Description
News
server
Name of the News server in the format
news.sitescope.com or news.sitescope.com:7777.
News
groups
(Optional) News group names. Separate multiple news group names by commas
(",").
User name
User name if the News server specified above requires a name and password for
access.
Password
Password if the News server specified above requires a name and password for
access.
Run Tool
Runs the test. The results of the test are displayed in the Results pane.
Save to File
Saves the results to a file.
Performance Counters Tool
This tool enables you to check performance counters on a specific machine in a Windows network.
It provides an interface to the perfex.exe executable supplied as part of SiteScope.
To access
l
Select Tools context > Operating System Tools > Performance Counters
Tool (you must have Use tools permissions)
l
Also available when configuring or viewing the CPU monitor, Dynamic Disk
Space monitor, Memory monitor, or Microsoft Windows Performance Counter
monitor (provided you are an administrator in SiteScope, or a user granted Use
monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Important
This tool is not supported on SiteScopes installed on UNIX platforms.
information
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 149 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI Element
Description
Performance Counters Tool Area
Server
The server where the Windows performance counter objects you want to monitor
are 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 Microsoft
Windows Remote Server to add a new server.
Default value: SiteScope Server (the server on which SiteScope is installed)
Admin User Account/ Password
Enter the administrative user name and password for the machine you want to
query. This is only necessary if you running SiteScope under an account that does
not have administrative privileges to access performance counters for the domain
or workgroup to which you are trying to connect.
If the test indicates you are required to supply a password, it means that the
remote machine requires authorization to access the performance counter
registry.
Tip: If you see the message "(NO COUNTERS OBJECTS AVAILABLE using
this username and password)" in the drop down list for Counter objects and you
have not supplied a user name and password, follow one of the suggestions below
to ensure that you have access to the remote machine's registry that you are
setting up:
Browse
Servers
l
Setup a SiteScope Windows remote connection to the remote machine that
has local administrator privileges.
l
Run the SiteScope service as a user that has access to your remote
machines.
Opens the Select Server dialog box, enabling you to select the server to be
monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in
the local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor. A double slash ("\\") is automatically prefixed to any machine name
supplied in the Enter server name box.
Note: You must have domain privileges or authenticated access to the Windows
remote server. For details on how to configure a remote Windows server, see
"Configure SiteScope to Monitor Remote Windows Servers" on page 490.
HP SiteScope (11.23)
Page 150 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Add
Remote
Server
Opens the Add Remote Server dialog box, enabling you to select the type of
remote you want to add (Windows or UNIX), and enter the configuration details.
For details on the Microsoft Windows Remote Servers user interface, see
"New/Edit Microsoft Windows Remote Server Dialog Box" on page 495.
For details on the UNIX Remote Servers user interface, see "New/Edit UNIX
Remote Server Dialog Box" on page 512.
Counters
Select a counter object to display the individual performance counters and
corresponding values for the selected counter object.
Run Tool
Runs the tool and displays the individual Windows performance counters and
corresponding values for the selected counter object. This information appears in
the Results pane.
Save to
File
Saves the results to a file.
Results
Counter
Name
Performance counter name.
Counter
Value
Value for the performance counter object.
Counter
Description of the performance counter.
Description
PERF Type
Description of the counter type.
Ping Tool
This tool displays the round trip time along a path. It sends a packet to another location and back to
the sender. When there is a problem with the network, ping can tell you if another location can be
reached. The Ping tool does a ping from the current server to another location.
HP SiteScope (11.23)
Page 151 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
To
access
l
Select Tools context > Network Tools > Ping Tool (you must have Use tools
permissions)
l
Also available when configuring or viewing the Ping monitor or Port monitor
(provided you are an administrator in SiteScope, or a user granted Use monitor
tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Host name to
resolve
Domain name or IP address of the host you want to ping.
Run Tool
Pings the domain name or IP address. The results of the test are displayed
in the Results pane.
Save to File
Saves the results to a file.
Example: demo.thiscompany.com or 206.168.112.53
Processes Tool
This tool displays processes running on the server where SiteScope is installed. This can be useful
to confirm that critical processes are available.
To access
Select Tools context > Operating System Tools > Processes Tool (you must
have Use tools permissions)
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 152 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI
Element Description
Server
The server where the processes you want to monitor are 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.
Default value: SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the Select Server dialog box, enabling you to select the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor. A double slash ("\\") is automatically prefixed to any machine name
supplied in the Enter server name box.
Note: You must have domain privileges or authenticated access to the Windows
remote server. For details on how to configure a remote Windows server, see
"Configure SiteScope to Monitor Remote Windows Servers" on page 490.
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" on page 495.
For details on the UNIX Remote Servers user interface, see "New/Edit UNIX Remote
Server Dialog Box" on page 512.
Run
Tool
Runs the test. The results of the test are displayed in the Results pane.
Save to
File
Saves the results to a file.
Real Media Player Tool
This tool enables you to test Real Media Player streaming.
HP SiteScope (11.23)
Page 153 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
To
access
l
Select Tools context > Application Tools > Real Media Player Tool (you must
have Use tools permissions)
l
Also available when configuring or viewing the Real Media Player monitor
(provided you are an administrator in SiteScope, or a user granted Use monitor
tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
URL
URL of the media file or streaming source you want to test. This should be the
URL of the media file.
Note:
l
You can test video streams only (not audio) with this tool.
l
This tool does not support metadata files such as the .smi format.
Duration
Playback duration that the tool should use for the media file or source. The
(milliseconds) duration value does not need to match the duration of the media contained in
the file.
If the media content of the file or source you are testing is less than the duration
value selected for the test, the monitor plays the entire media content and
reports the results, including the time required to play the media content.
Run Tool
Runs the test. The results of the test are displayed in the Results pane.
Save to File
Saves the results to a file.
Regular Expression Tool
This tool enables you to perform a regular expression match.
HP SiteScope (11.23)
Page 154 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
To
access
Select Tools context > Common Utility Tools > Regular Expression Tool (you
must have Use tools permissions)
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI
Element
Text
Description
Copy and paste a portion of text containing the string or values on which you want
to perform a regular expression match into this box.
For efficiency in developing regular expressions, include all of the content that
would precede the target data or pattern that you want to match. For example,
when developing a regular expression for content matching on a Web page, use
the "URL Tool" on page 167 to retrieve the entire HTTP content including the
HTTP header.
Regular
Enter a regular expression between the slashes //, to match some part of the text
expression you entered.
Note: For content with multiple lines with carriage returns and line feeds, consider
adding the s search modifier to the end of the expression to have the content
treated as a single line of text.
Example: /value:\W[\d]{2,6}/s
Run Tool
Runs the test. The results of the match test are displayed in the Results pane. If
there is a problem with your regular expression, an error message appears.
Save to
File
Saves the results to a file.
Parsed Parentheses and Matches Table
This section includes a table that displays any matches requested as retained values or back
references by pairs of parentheses inside the regular expression. If your expression does not
include parentheses, this table is empty. The columns of the parsed parentheses table are:
UI Element
Description
Parentheses Displays any patterns in the regular expression delimited by parentheses as
counted
counted from the left-hand side of the expression.
from left
HP SiteScope (11.23)
Page 155 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Matching
text
Displays the text that matched the parenthesis marked patterns listed in the
column to the left.
Whole
Match
Between
Slashes
This is the text area below the table. It echoes the entire content entered in the
Your Text that will be matched box. The content that matched the pattern in
your regular expression is highlighted within this content, normally using a blue
font. This is useful for showing possible problems with wildcard expressions like
the .* pattern that match too much content. It can also uncover problems of
duplicate patterns within the content that require you to add other unique patterns
to your expression to match the desired portion of the content.
Services Tool
This tool displays services running on the server where SiteScope is installed. This can be useful to
confirm that critical services are available. If Remote UNIX machines have been defined, they are
listed in a drop-down menu.
To access
l
Select Tools context > Operating System Tools > Services Tool (you must
have Use tools permissions)
l
Also available when configuring or viewing the Service monitor (provided you
are an administrator in SiteScope, or a user granted Use monitor tools
permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Important
This tool is not supported on SiteScopes installed on UNIX platforms.
information
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 156 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI
Element Description
Server
The server where the services you want to monitor are running. Select a server from
the server list (only those remote servers that have been configured in SiteScope
appear). Alternatively, click the Browse Servers button to select a server from the
local domain, or Add Remote Server to add a new server.
Default value:SiteScope Server (the server on which SiteScope is installed)
Browse
Servers
Opens the Select Server dialog box, enabling you to select the server to be monitored:
l
Browse servers. Select a server from the drop-down list of servers visible in the
local domain.
l
Enter server name. If the server you want to monitor does not appear in the
Servers list because it has not been identified in the network or has not been
configured in Remote Servers, enter the IP address or name of the server to
monitor. A double slash ("\\") is automatically prefixed to any machine name
supplied in the Enter server name box.
Note: You must have domain privileges or authenticated access to the Windows
remote server. For details on how to configure a remote Windows server, see
"Configure SiteScope to Monitor Remote Windows Servers" on page 490.
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" on page 495.
For details on the UNIX Remote Servers user interface, see "New/Edit UNIX Remote
Server Dialog Box" on page 512.
Run
Tool
Runs the test. The results of the test are displayed in the Results pane.
Save to
File
Saves the results to a file.
SiteScope Log Grabber Tool
This tool enables you to collect the SiteScope log and configuration files. In addition, it can be used
to gather the following data:
l
Thread dump of SiteScope
l
Results of system commands (such as "netstat", "dir", and so on)
HP SiteScope (11.23)
Page 157 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
l
Information about JVM
l
Windows event log entries
You can use the default configuration file (default.loggrabber.conf.xml) or create your own
configuration files, for example, to create a scheduled backup of the SiteScope configuration.
Note: You can use the SiteScope Log Grabber tool manually by running the LogGrabber.bat
script (LogGrabber.sh for UNIX) from the <SiteScope root
directory>\tools\LogGrabberSiteScope folder. In this mode, the configuration file should be
used as a parameter: LogGrabber.bat full.loggrabber.conf.xml.
You can use this tool from either the Script alert (for example, to collect data for troubleshooting if
CPU utilization is greater than 90%, or if a critical error is found in the log), or from the Script monitor
(to collect regular data using the scheduler). The name of the configuration file should be transferred
in the script as a parameter.
To access
Select Tools context > Common Utility Tools > SiteScopeLog Grabber Tool
(you must have Use tools permissions)
Important
Since the SiteScope configuration can contain valuable data such as encoded
information passwords, make sure that the Download SiteScope Log Grabber run results
permission (in Preferences > User Management Preferences > Permissions
> Other) is not granted to untrusted users. For details on user permissions, see
"Permissions" on page 738.
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
SiteScope Log Grabber Tool Area
Configuration
File
Select the configuration file to use.
Folders
Select the folders and/or files to be checked for runtime changes.
Run Tool
Runs the tool. The results are displayed in the Results box.
Default value: default.loggrabber.conf.xml
Results
HP SiteScope (11.23)
Page 158 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Download file
Enables downloading a file containing the last run results.
Note: You must have Download Log Grabber run results permissions to
download the run results file.
File
Lists all the result files (in .zip format). Click to open a file and download the
results for a selected file.
Size
The size of the results file.
Last Modified
Date and time that the results file was last modified.
Export to Excel/PDF. Enables you to save collected log file results by
exporting them to an Excel or PDF file.
SNMP Browser Tool
This tool provides details of an SNMP agent's MIB. It can be used to verify the connection
properties of an SNMP agent and to gain more information about the SNMP agent's counters.
To access
Important
information
l
Select Tools context > SNMP Tools > SNMP Browser Tool (you must have
Use tools permissions)
l
Also available when configuring or viewing the Cisco Works monitor, F5 Big-IP
monitor, or SNMP by MIB monitor (provided you are an administrator in
SiteScope, or a user granted Use monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
l
This tool operates by traversing all of the OIDs on a given agent and then using
the MIB information in the <SiteScope root directory>\templates.mib
directory to display the OID, counter names, type, and values in a table.
l
If MIBs are not listed in the MIB file drop-down box after adding MIB files to the
templates.mib directory when creating an SNMP by MIB monitor, see the
Troubleshooting MIB Compilation steps in SNMP by MIB Monitor in the
SiteScope Monitor Reference Guide.
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
HP SiteScope (11.23)
Page 159 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
User interface elements are described below:
UI Element
Description
SNMP Settings
Server
Host name or IP address of the device on which the SNMP agent is running
that you want to monitor.
Port
Port on which the SNMP agent is listening.
Default value: 161
MIB file
MIB that you want to view. If you select All MIBs, then all data obtained during
the MIB traversal appears. If you select a specific MIB, then only the OIDs
within that MIB appear. This list of MIBs can be updated or extended by
placing new MIB files in the <SiteScope root directory>\templates.mib
directory.
Default value: All MIBs
Starting OID
Use this option 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. The default value is 1, which is commonly used and applicable to
most applications. 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.
SNMP Connection Settings
Timeout
(seconds)
Total time, in seconds, that SiteScope should wait for all SNMP requests
(including retries) to complete.
Default value: 5 seconds
Number of
retries
Number of times each SNMP GET request should be retried before SiteScope
considers the request to have failed.
Default value: 1
Community
Community string to use when connecting to the SNMP agent for version 1 or
2 connections.
Default value: public
SNMP version
Version of SNMP which the tool should use when connecting to the agent.
SiteScope supports SNMP version 1, version 2, and version 3. Selecting V3
enables you to enter version 3 settings in the fields below.
Default value: V1
HP SiteScope (11.23)
Page 160 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Authentication Authentication algorithm to use for a version 3 connection.
algorithm
Default value: MD5
Note: This field is available only if SNMP V3 is selected.
User name
User name for a version 3 connection.
Note: This field is available only if SNMP V3 is selected.
Password
Password to use for authentication in a version 3 connection.
Note: This field is available only if SNMP V3 is selected.
Privacy
algorithm
The privacy algorithm used for authentication for SNMP version 3 (DES,128Bit AES,192-Bit AES, 256-Bit AES). Leave blank if you do not want privacy.
Default value: DES
Note: This field is available only if SNMP V3 is selected.
Privacy
password
Password to use for DES privacy encryption in a version 3 connection. Leave
blank if you do not want privacy.
Note: This field is available only if SNMP V3 is selected.
Context name
Context Name to use for this connection. This is applicable for SNMP V3 only.
Note: This field is available only if SNMP V3 is selected.
Context
engine ID
Hexidecimal 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.
Run Tool
Runs the test. The results of the test appear in the Results pane.
Save to File
Saves the results to a file.
SNMP Tool
This tool lets you query a SNMP Management Information Base (MIB) and retrieve a set of OIDs.
HP SiteScope (11.23)
Page 161 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
To
access
l
Select Tools context > SNMP Tools > SNMP Tool (you must have Use tools
permissions)
l
Also available when configuring or viewing the SNMP monitor (provided you are
an administrator in SiteScope, or a user granted Use monitor tools
permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Host name
IP address of the server that hosts the SNMP MIB you want to query.
Port
Port to use when requesting data from the SNMP agent.
Default value: 161
HP SiteScope (11.23)
Page 162 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Object ID
Select the Object ID setting:
l
Commonly used values. Select the Object ID mnemonic from the dropdown list. (This is the default option with system.sysDescr set as the
default value.)
Enter the index of the SNMP object. Values for an OID come as either
scalar or indexed (array or table) values.
n
For a scalar OID, the index value must be set to 0.
n
For an indexed or table value, you must provide the index (a positive
integer) to the element that contains the value you want. The index value
for Commonly used values is set to ifSpecific.ifInOctets.
Default value: 0
l
Other values. Enter the Object Identifier (OID) for the SNMP value you
want to retrieve. The OID specifies which value should be retrieved from
the device.
Example: 1.3.6.1.2.1.4.3
Tip: To troubleshooting basic connectivity to the device and to confirm that the
SNMP agent is active, select the system.sysDescr object from the drop-down
list if other objects cannot be found.
Note: SiteScope supports SNMP versions 1.0, 2.0, and 3.0.
If you receive the error message error - noSuchName, it means SiteScope was
able to contact the device but the OID given is not known by the device. You
must provide an OID that is valid to the device to obtain a value.
If you have a MIB file for the device you want to monitor, you can copy the
*.mib (or *.my) file into the <SiteScope root directory>\templates.mib
subdirectory and use the MIB Help utility to compile the MIB and browse the
OIDs for the device. To use the MIB Helper tool, select Tools > MIB Browser
and enter the connection details. After copying a new MIB file to SiteScope,
you must restart SiteScope. Select the MIB file to browse using the drop-down
list. Click the browse button to show the OIDs from the selected MIB file. A
tree that represents the chosen MIB on the specified server appears. You can
browse that tree to find the OID that you want to monitor.
It is not necessary to browse a MIB file with the SiteScope MIB Helper to
monitor a device. The MIB Helper is provided simply as a tool to help you
discover OIDs available on a device, but it is not the only tool available. You
can find other alternative tools on the Web (for example, MG-SOFT or
iReasoning).
HP SiteScope (11.23)
Page 163 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Number of
records to get
Number of OID records to retrieve.
Default value: 1
SNMP Connection Settings
Timeout
(seconds)
Amount of time, in seconds, that SiteScope should wait for an SNMP request.
Number of
retries
Number of SNMP request retries before SiteScope considers the monitor to
have failed.
Default value: 5 seconds
Default value: 1
Community
Community string for the SNMP device.
The Community string provides a level of security for a SNMP device. Most
devices use public as a community string. However, the device you are going
to monitor may require a different Community string to access it.
If you try to monitor an SNMP agent through specific community, you must
make sure that the SNMP agent is familiar with that community. For example,
if you try to monitor a Windows 2003 server through public community, you
must make sure that the SNMP agent has this community configured.
Otherwise, the monitor cannot connect to the agent.
Default value: public
Note: The field is valid only for version 1 or 2 connections.
SNMP version
SNMP version used by the SNMP host you want to monitor. SiteScope
supports SNMP version 1, version 2, and version 3.
Default value: V1
Authentication Authentication algorithm used for SNMP V3. You can select MD5, SHA, or
algorithm
None.
Note: This field is available only if SNMP V3 is selected.
User name
User name to be used for authentication if you are using SNMP version 3.
Note: This field is available only if SNMP V3 is selected.
Password
Password to be used for authentication if you are using SNMP version 3.
Note: This field is available only if SNMP V3 is selected.
HP SiteScope (11.23)
Page 164 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Privacy
algorithm
The privacy algorithm used for authentication for SNMP version 3 (DES,128Bit AES,192-Bit AES, 256-Bit AES).
Default value: DES
Note: This field is available only if SNMP V3 is selected.
Privacy
Password
The privacy password used for authentication for SNMP version 3. Leave
blank if you do not want privacy.
Note: This field is available only if SNMP V3 is selected.
Context Name
The context name of SNMP version 3.
Note: This field is available only if SNMP V3 is selected.
Context
Engine ID
The context engine ID of SNMP version 3.
Run Tool
Runs the test. The results of the test are displayed in the Results pane.
Note: This field is available only if SNMP V3 is selected.
Results
Save to File
Saves the results to a file.
SNMP Trap Tool
This tool enables you to view SNMP Traps received by SiteScope's SNMP listener. The tool is only
enabled if you have already created one or more SNMP Trap monitors. Creating an SNMP Trap
Monitor enables the SiteScope SNMP Trap Log.
To access
l
Select Tools context > SNMP Tools > SNMP Trap Tool (you must have
Use tools permissions).
l
Also available when configuring or viewing the SNMP Trap monitor or
Technology SNMP Trap Integration monitor (provided you are an administrator
in SiteScope, or a user granted Use monitor tools permissions).
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Important
The message Receiving SNMP Traps is not active appears at the top of the
information tool page if the SNMP Trap Log is not currently active.
HP SiteScope (11.23)
Page 165 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI
Element Description
Content
match
Optional text string or regular expression to be used to match entries in the SNMP
Trap Log. Content matching can be done for data from any of the columns of the log
such as OID, Community, Agent, and so on.
The SNMP traps in the SiteScope SNMP Trap Log appear in the SNMP Trap Log
table. The number of traps matching the search criteria appears in the SNMP Trap
Log table title displayed in the lower part of the page.
Traps to Number of SNMP Traps to list. The number of traps is calculated, based on average
show
trap length. If the trap text is longer or shorter than average, the number of traps
shown can be different from the selected value. The most recent SNMP Traps
received by SiteScope appear first.
Default value: 10
Run
Tool
Runs the test. The results of the test are displayed in the Results pane.
Save to
File
Saves the results to a file.
Trace Route Tool
This tool shows you the network path between two locations and how long it takes to get to each
hop in the path. When there is a problem with the network, traceroute can often be used to narrow
down where the problem is occurring. This tool performs a traceroute from your server to another
location.
You can use this utility to verify connectivity of a host and to determine how the host is connected
to the Internet. You can also determine the path taken from your server to the specified host. This
helps you to determine where packet loss may be occurring when you attempt to connect to hosts
elsewhere on the Internet.
To access
Select Tools context > Network Tools > Trace Route Tool (you must have Use
tools permissions)
HP SiteScope (11.23)
Page 166 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Important
You can use this tool to perform a traceroute on Windows platforms only. For
information UNIX, you must stop the SiteScope process, add the path of the traceroute utility
(for example /usr/sbin/traceroute) to the Traceroute command box in
Infrastructure Preferences, and then restart SiteScope.
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Host name to resolve
Domain name or IP address of the other location to resolve.
Example: demo.thiscompany.com or 206.168.112.53
Run Tool
Runs the test. The results of the test are displayed in the Results pane.
Save to File
Saves the results to a file.
URL Tool
This tool enables you to retrieve an item from a Web server. The URL specifies the server to
contact and the item to return. Because SiteScope displays the content of the requested URL, this
tool also functions to check URL Content. You can use this utility to verify that a given URL can be
accessed from a Web server. You can also use it to see how long it takes for the page to be
returned.
To
access
l
Select Tools context > Web Tools > URL Tool (you must have Use tools
permissions)
l
Also available when configuring or viewing the URL monitor, URL Content
monitor, or Oracle 9i Application Server monitor (provided you are an administrator
in SiteScope, or a user granted Use monitor tools permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
HP SiteScope (11.23)
Page 167 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Main Settings
URL
URL that you want to test.
Example: http://demo.company.com
Match
content
String of text to check for in the returned page or frame set. If the text is not
contained in the page, the content match fails. The search is case sensitive.
HTML tags are part of a text document, so you must include the HTML tags if
they are part of the text you are searching for (for example, "< B> Hello< /B>
World").
Match
content for
error
String of text to check for in the returned page or frame set. If the text is
contained in the page, the test indicates an error condition. The search is case
sensitive.
HTTP Settings
URL content
encoding
URL content encoding is the encoding in which the content is written. The
encoding can be found in any of the following:
l
HTTP headers: Content-Type: text/html; charset=UTF-8
l
HTML meta tag <meta http-equiv="Content-Type"
content="text/html; charset=US-ASCII">
l
XML: <?xml version="1.0" encoding="ISO-8859-1"?>
Select the encoding type from the drop down list.
Examples: UTF-8, UTF-16, US-ASCII, ISO-8859-1
Default value: Encoding from server response
Retrieve
images
SiteScope lists the images such as graphics, logos, and so on linked to the
URL being requested.
Retrieve
frames
SiteScope displays the HTML code of a frame linked to the URL being
requested.
Authentication Settings
HP SiteScope (11.23)
Page 168 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Credentials
Option for authorizing credentials if the URL specified requires a name and
password for access:
Pre-emptive
authorization
l
Use user name and password. Select this option to manually enter user
credentials. Enter the user name and password to access the URL in the
User name and Password box.
l
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password for the URL
(default option). Select the credential profile to use from the Credential
profile drop-down list, or click Add Credentials and create a new credential
profile. For details on how to perform this task, see "Credential Preferences"
on page 572.
Option for sending authorization credentials if SiteScope requests the target
URL:
l
Use global preference. Select to have SiteScope use the setting specified
in the Pre-emptive authorization section of the General Preferences page.
l
Authenticate first request. Select to send the user name and password on
the first request SiteScope makes for the target URL.
Note: If the URL does not require a user name and password, this option may
cause the URL to fail.
l
Authenticate if requested. Select to send the user name and password on
the second request if the server requests a user name and password.
Note: If the URL does not require a user name and password, this option may
be used.
All options use the 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.
Client side
certificate
The certificate file, if you need to use 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.
HP SiteScope (11.23)
Page 169 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Client side
certificate
password
Password if you are using a client side certificate and that certificate requires a
password.
Authorization Domain for Windows NT LAN Manager (NTLM) authorization if required to
NTLM
access the URL.
domain
Accept
untrusted
certificates
for HTTPS
If you are accessing a target URL 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 in "URL Monitor" in the SiteScope Monitor Reference
Guide.
Accept
invalid
certificates
for HTTPS
Select this option if you are accessing a target URL 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 URL you are accessing requires authentication using NTLM
version 2.
Prefer SSL to
TLS
Select if the URL you are accessing cannot handle authentication using TLS.
This enables encrypted handshake messages to be sent using SSL.
Proxy Settings
HTTP proxy
Address or domain name and port of an HTTP Proxy Server used to access the
URL.
Proxy server
user name
Name used to log on to the proxy server.
Proxy server
password
Password used to log on to the proxy server.
Proxy NTLM
V2
Proxy uses NTLM (Windows NT LAN Manager) version 2 to authenticate user
logon.
Run Tool
Runs the test. The results of the test are displayed in the Results pane. The
results include statistics on the URL retrieval as well as a text representation of
the URL content.
Save to File
Saves the results to a file.
Web Service Tool
This tool enables you to check Simple Object Access Protocol (SOAP) enabled Web services for
availability, stability, or to see what an actual SOAP response looks like. It is also useful for
diagnosing a Web service request failure, or for picking out match strings for use with a specific
HP SiteScope (11.23)
Page 170 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
Web Service Monitor. The Web Service Test sends a SOAP request to the server and checks the
HTTP response codes to verify that the service is responding. The actual SOAP response appears,
but no further verification occurs on this returned message.
SOAP is a way for a program running under one operating system to communicate with another
program running under the same or different operating system (such as a Windows 2003 program
talking to a Linux-based program). SOAP uses the Hypertext Transfer Protocol (HTTP) and
Extensible Markup Language (XML) for information exchange with services in a distributed
environment.
To access
Important
information
l
Select Tools context > Web Tools > Web Service Tool (you must have Use
tools permissions)
l
Also available when configuring or viewing the Web Service monitor (provided
you are an administrator in SiteScope, or a user granted Use monitor tools
permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a
new monitor, or in the monitor Properties tab when configuring an existing
monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
l
The following specification features are currently supported: WSDL 1.2, SOAP
1.1, Simple and Complex Types based on XML Schema 2001, SOAP binding
with the HTTP(s) protocol only. SOAP with Attachments is not supported.
l
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.
Relevant
tasks
"How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on
page 124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
WSDL Settings
HP SiteScope (11.23)
Page 171 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
WSDL
location
Select the WSDL location:
l
File. Select the WSDL file to be used. This list reflects the files found by
searching on <SiteScope root directory>\templates.wsdl/*.wsdl. Your
WSDL files must have an extension of .wsdl.
l
URL. Enter the URL of the Web service to be tested.
Get Data
Retrieves and analyzes the specified WSDL file for method arguments. The
Result page displays the measurements available.
Service name
Name of the service to be invoked. During initial setup, this is extracted from
the WSDL file.
Port name
Name of the port to be invoked. During initial setup, this is extracted from the
WSDL file.
Method name
Name of the method to be invoked. During initial setup, this is extracted from
the WSDL file.
Method name
space
The XML name space for the method in the SOAP request. During initial setup
this value is extracted from the WSDL file.
Schema
name space
The XML name space for the schema in the SOAP request. During initial setup,
this value is extracted from the WSDL file.
SOAP action
The SOAP action URL in the header of the SOAP request to the Web Service.
During initial setup, this is extracted from the WSDL file.
HP SiteScope (11.23)
Page 172 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Name of
arguments
Arguments to the method specified above and their types. Specify simple type
parameters in the format
parm-name(parm-type) = value, where the <param-name> and <paramtype> must match the service method specifications of its WSDL file exactly.
The <value> must agree with the <param-type>, otherwise the request fails.
Strings with embedded spaces should be enclosed in double quotes (" "). Each
parameter must be on a separate line by adding a carriage return at the end of
each value.
Example: stockSymbol (string) = MERQ
numShares (int) = 10
A complex type parameter must be represented as one long string (line breaks
are for readability purposes only):
stocksymbol[COMPLEX] =
<stocksymbol xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:fw100="urn:ws-stock"
xsi:type="fw100:getQuote">
<ticker xsi:type="xsd:string">MERQ
</ticker>
</stocksymbol>
Note: SiteScope does not perform any validation on your input parameter lists,
so make sure that the complex type values are valid and well-formed XML
strings. Do not add any carriage returns within a complex type parameter—only
at the end.
If the Web service method does not take any parameters, the text box should
be left empty.
Use userdefined
SOAP XML
Use the XML in the User SOAP XML box. This enables you to use XML that
has been manually defined.
User SOAP
XML
Displays the SOAP XML for the selected Web service extracted from the
WSDL file. You can make changes to the default XML, and use the manually
defined XML in this box by selecting the Use User-Defined SOAP XML check
box.
Main Settings
Request's
schema
HP SiteScope (11.23)
The request schema. Currently SiteScope only supports SOAP.
Page 173 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Timeout
(seconds)
Total time, in seconds, that SiteScope should wait for the Web service request
to complete.
Default value: 30 seconds
Use .NET
SOAP
Select if the Web service is based on Microsoft .NET.
Content
match
Text to check for in the returned page or frameset. If the text is not contained in
the page, the tool displays the message no match on content.
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.
Example: "< B> Hello< /B> World"
You may also perform a regular expression match by enclosing the string in
forward slashes, with an i after the trailing slash to indicate that the search is
not case sensitive.
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+)
Note: The search is case sensitive.
HTTP Settings
Web service
server URL
Displays the URL of the Web service server to be checked.
HTTP user
agent
HTTP user agent for the SOAP request.
HTTP content Content type of the HTTP request.
type
Proxy Settings
HTTP proxy
(Optional) A proxy server can be used to access the URL. Enter the domain
name and port of an HTTP Proxy Server.
Proxy server
user name
User name 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.
HP SiteScope (11.23)
Page 174 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Proxy server
password
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.
Login Settings
NTLM
domain
NTLM domain if the Web service requires NTLM / Challenge Response
authentication as part of your credentials (as well as a user name and password
below).
Authorization User name if the Web service requires a user name and password for access
user name
(Basic, Digest, or NTLM authentication), enter the user name.
Alternately, you can leave this entry blank and enter the user name in the
Default authentication user name box on the General Preferences page. You
use this alternate method to define common authentication credentials.
Authorization Password if the Web service requires a user name and password for access
password
(Basic, Digest or NTLM authentication), type the password.
Alternately, you can leave this entry blank and enter the password in the
Default authentication password box on the General Preferences page. You
use this alternate method to define common authentication credentials.
HP SiteScope (11.23)
Page 175 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
UI Element
Description
Run Tool
Runs the test. The results of the test are displayed in the Results pane.
The possible status values returned by the test are:
Save to File
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
document moved
l
unauthorized
l
forbidden
l
not found
l
proxy authentication required
l
server error
l
not implemented
l
server busy
Saves the results to a file.
XSL Transformation Tool
This tool enables you to test a user-defined XSL file that can be used to transform an XML file or
output. This might be a file from a Web application that contains performance metrics data. The use
of an XSL transformation may be necessary to process XML data into an acceptable format for use
by the browsable XML Monitor.
HP SiteScope (11.23)
Page 176 of 1293
Using SiteScope
Chapter 14: SiteScope Tools
To
access
l
Select Tools context > Common Utility Tools > XSL Transformation Tool
(you must have Use tools permissions)
l
Also available when configuring or viewing the XML Metrics monitor (provided you
are an administrator in SiteScope, or a user granted Use monitor tools
permissions):
n
Click the Use Tool button in the new monitor dialog box when configuring a new
monitor, or in the monitor Properties tab when configuring an existing monitor.
n
To run the test tool for an existing monitor, click the Tools
button in the
SiteScope Dashboard toolbar. This opens and runs the tool with the monitor's
existing data as its input, and displays the test results in the Results pane.
Relevant "How to Use SiteScope Tools for Configuring or Troubleshooting a Monitor" on page
tasks
124
See also
l
"SiteScope Tools" on page 123
l
"Tools Menu" on page 67
User interface elements are described below:
UI Element
Description
Main Settings
XML URL
URL of the XML file that is the input for the transformation.
XSL file
Path to the XSL file you want to test. This path must be relative to
SiteScope root folder.
Example: <SiteScope root
directory>\templates.applications\XmlApp1.xsl
Authentication Settings
Authorization user
name
User name needed to access the content if access to the target XML
file requires authentication.
Authorization
password
Password needed to access the content if access to the target XML
file requires authentication.
Proxy server
Proxy server address if you are using a proxy server to access the
target XML content.
Proxy server user
name/password
User name and password required to use the proxy if you are using a
proxy to access the target XML content.
Run Tool
Runs the test. The results of the test appear in the Results pane.
Save to File
Saves the results to a file.
HP SiteScope (11.23)
Page 177 of 1293
Chapter 15: SiteScope Public APIs
SiteScope public APIs enable you to run various scenarios automatically without using the
SiteScope user interface. For example, you can:
l
Import, export and deploy templates.
l
Enable, disable or delete monitors, groups or alerts.
l
Acquire data from SiteScope.
The SiteScope API is SOAP-based and can be invoked by any known Web Services framework
such as Axis or WSIF, or by any SOAP client application. This provides a powerful set of tools for
managing and automating large environments and implementing complex business logics.
Learn About
SiteScope Public APIs Overview
SiteScope Public APIs can be divided in to two core categories: Configuration API and Data
Acquisition API.
l
Configuration API is responsible for template management, deployment and monitors running. It
also provides powerful management tools for downtime and decommission.
l
The Data Acquisition API enables you to retrieve historical monitor run data and VMware
reconciliation topology data.
API Examples
The SiteScope API examples are available from the
<SiteScope installation directory>\examples\integrations\api directory.
API examples include the following content:
l
lib folder - All jars required to start using SiteScope API and build you own client application
l
bin folder - The scripts (*.bin, *.sh) execute provided examples
l
src folder - Code examples show how to use SiteScope APIs
l
doc folder - Java documentation (in JavaDoc format) of all available public SiteScope APIs
methods and data structures.
For details on the APIs included with SiteScope, see the HP SiteScope API Reference located
in the javadoc.zip file. To open the guide, double-click the index.html file.
SiteScope Configuration APIs
SiteScope configuration APIs provide services for working with SiteScope templates, groups,
monitors, alerts, remote servers, server health, search/filter tags, and configuration.
HP SiteScope (11.23)
Page 178 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
The following configuration actions are supported using the SiteScope API:
SiteScope
Object
Action
Templates
l
Template management (create/delete template, create/delete template
container, import/export template, import templates and override them if they
already exist in the given path, get snapshot of all templates)
l
Template deployment (monitor, group, alert, remote server creation), deploy a
single template that gets back details of the deployment
l
Publish template changes (groups, monitors, alerts, remote server); update
templates deployed without a root (updates only a single monitor with new
variables)
Groups
Enable/disable groups, delete groups, search groups by specific criteria
Monitors
Enable/disable, delete monitors, run monitors, search monitors by specific
criteria
Alerts
Enable/disable alerts
Remote
Servers
Create remote server (on Windows and UNIX), delete remote server preferences
Status
Get SiteScope server status (active monitoring, booting) statistics
Tags
Create tags, add tag values, edit tag description, edit tag values (name,
description), delete tags
Configuration
l
Get SiteScope configuration
l
Import an SSH key file to a remote SiteScope machine
For task details, see "How to Use SiteScope Configuration API Calls" on the next page.
For a user-case scenario, see "How to Use SiteScope API Calls - Use-Case Scenario" on page
181.
SiteScope Data Acquisition APIs
The following data acquisition actions are supported using the SiteScope API:
SiteScope Object
Action
getData
Retrieves historical metrics data for monitor runs matching
the specified query parameters.
HP SiteScope (11.23)
Page 179 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
SiteScope Object
Action
getDataWithTopology
Retrieves historical metrics data for monitor runs matching
the specified query parameters and VMware reconciliation
topology collected by VMware monitors currently running
on SiteScope.
getMonitorTypesWithMetricNames
l
Supports given time interval, credentials, and filter
(monitor type(s), name, etc…)
l
Returns XML similar to the XML sent with generic data
integration that contains the (historical) metrics data
Scans all the monitors in this SiteScope instance for which
the user has view permissions, and returns a list of their
types together with the metric names per monitor type. The
list of metric names is merged from all the monitors of each
type (repeated occurrences are removed). Where
enabledMonitorsOnly is true, it scans enabled monitors
only. Where enabledMonitorsOnly is false, it scans all
monitors (enabled/disabled) in the SiteScope instance.
The data for these APIs is taken from the SiteScope daily log.
Note: The data acquisition API is intended for querying limited amount of historical data (up to
20 MB). For consumption of near real-time SiteScope data, use Generic Data Integration. For
details, see "Generic Data Integration Preferences" on page 681.
For task details, see "How to Use the Data Acquisition API" on page 182.
Tasks
How to Use SiteScope Configuration API Calls
This task describes how to use API calls which enable you to run various scenarios automatically
without using the SiteScope user interface.
Tip: For a use-case scenario on using API calls, see "How to Use SiteScope API Calls - UseCase Scenario" on the next page.
1. Create your own Java project.
2. Add all SiteScope client jars into the project (these jars are located in
<SiteScope installation directory>\examples\integrations\api\lib).
3. Connect to SiteScope using the SiteScopeCommandLineUtil.java file located in
<SiteScope installation directory>\examples\integrations\api\src. In the
createConnection method section, enter the required login information:
HP SiteScope (11.23)
Page 180 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
// SiteScope connection properties creation
SiteScopeConnectionPropertiesForExternal props = new SiteScopeCo
nnectionPropertiesForExternal(hostName, port, login, password, isUseSSL);
// SiteScope API Connector creation
SiteScopeExternalAPIConnector siteScopeExternalAPIConnector = new
SiteScopeExternalAPIConnector();
// Get the API instance using connection properties
IAPIConfiguration apiConfiguration = siteScopeExternalAPIConnecto
r.getAPIConfiguration(props);
4. Run the required API methods. For example:
apiConfiguration.getConfigurationSnapshotEx(login, password);
How to Use SiteScope API Calls - Use-Case Scenario
SiteScope APIs enable you to run various scenarios automatically without using the SiteScope
user interface. For example, you can create and deploy templates, enable and disable monitors,
groups, and alerts, and delete monitors, groups, and remote servers.
1. Initial set up
Install SiteScope.
Create a template container using the createTemplateContainer API method (done only
once).
2. Create or import a template
Create a template in the SiteScope user interface, or import it using the importTemplate API
method.
3. Deploy a template and run monitors
Deploy the template for a remote server using the
deploySingleTemplateWithConnectToServer API method.
Use the getConfigurationSnapshotEx API method to get all deployed monitors, groups, and
alerts.
Use the runExistingMonitorEx API method to run deployed monitors.
4. Downtime
Use the disableAlertEx, disableMonitorEx, or disableGroupFullPathEx API method to
disable an alert, monitor, or group for a downtime period.
5. Decommission
HP SiteScope (11.23)
Page 181 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
Use the deleteGroupEx, deleteMonitorEx, or deleteRemote API method to delete a group,
monitor, or remote server.
How to Use the Data Acquisition API
1. When running in SiteScope standalone mode (when SiteScope is not connected to a BSM
server), select the Enable topology collection in standalone deployment check box in
Preferences > Infrastructure Preferences > General Settings. This enables SiteScope to
collect topology in the background, and not when request is made. You must restart SiteScope
for this change to take effect.
2. Optionally, you can modify the following data acquisition settings (you must restart SiteScope
for these changes to take effect):
n
Topology resolving frequency (minutes). Amount of time, in minutes, to wait between
checking the topology of the server being monitored. This applies to non-dynamic monitors
only; for dynamic monitors, frequency can be configured per instance in the user interface. If
this time is exceeded during a monitor run, when running in SiteScope standalone mode the
topology is saved in SiteScope; when SiteScope is integrated with BSM the topology is
created again in BSM's RTSM. The default value is 60 minutes.
n
Data acquisition API single request size (MB). The maximum memory size, in
megabytes, allocated for fetching data from the daily log in a single data acquisition API
request. Loading too much data from the daily log to process a request might have a
negative performance impact on SiteScope, because the memory allocated for the data is
out of SiteScope’s available memory pool. The default value is 20 MB.
n
Data acquisition API total request size (MB). The maximum memory size, in
megabytes, allocated for fetching data from the daily log in all simultaneous data acquisition
API requests. Loading too much data from the daily log to process requests might have a
negative performance impact on SiteScope, because the memory allocated for the data is
out of SiteScope’s available memory pool. The default value is 100 MB.
n
To include deleted monitors in data acquisition API results, select the Include deleted
monitors in data acquisition API results option in Preferences > Infrastructure
Preferences > General Settings.
3. When specifying monitor types for which to get data in the data acquisition API, you must use
the "topaz name" of the monitor.
The following lists the monitor topaz name to use when specifying a monitor type query:
Monitor Display Name
Monitor Topaz Name
Active Directory Replication
(created from the Active Directory Solution
template only)
Active Directory Replication
HP SiteScope (11.23)
Page 182 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
Monitor Display Name
Monitor Topaz Name
Amazon Web Services
AmazonCloudWatch
Apache Server
Apache
BAC Integration Configuration
BAC Integration Configuration
BAC Integration Statistics
BAC Integration Statistics
BroadVision Application Server
BroadVision
CheckPoint
CheckPoint
Cisco Works
Cisco Works
Citrix
Citrix MetaFrame Presentation Server
ColdFusion Server
MS ColdFusion Server
COM+ Server
COM+
Composite
Composite
Connection Statistics Monitor
Connection Statistics Monitor
CPU
CPU
Custom
Custom Monitor
Custom Database
Custom Database Monitor
Custom Log File
Custom Log Monitor
Custom WMI
Custom WMI Monitor
Database Counter
DatabaseCounter
Database Query
SQL Query
DB2 JDBC
DB28x
DHCP
DHCP
Directory
Directory
DNS
DNS
Dynamic Disk Space
Dynamic Disk Space
Dynamic Monitoring Statistics
Dynamic Monitoring Statistics
eBusiness Transaction
Ebus Chain Monitor
HP SiteScope (11.23)
Page 183 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
Monitor Display Name
Monitor Topaz Name
F5 Big-IP
F5
File
File
Formula Composite
Bandwidth
FTP
FTP Monitor
Generic Hypervisor
Generic Hypervisor
HAProxy
HAProxy Monitor
Health of SiteScope Server
Health Server Load Monitor
HP iLO
HP iLO
HP NonStop Event Log
NonStop Event Log
HP NonStop Resources
NonStop Resources
HP Service Manager
HP Incidents
IPMI
IPMI
JMX
JMX Monitor
KVM
KVM
LDAP
LDAP Monitor
License Usage Monitor
License Usage
Link Check
Link Monitor
Log Event Checker
Log Event Health Monitor
Log File
Log Monitor
Mail
E-mail Monitor
MAPI
mapimon
Memcached Statistics Monitor
Memcached Stats
Memory
Memory
Microsoft A/V Archiving Server
Microsoft Lync Server 2010 Archiving
monitor
Microsoft A/V Conferencing Server
Microsoft Lync Server 2010 A/V
Conferencing monitor
HP SiteScope (11.23)
Page 184 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
Monitor Display Name
Monitor Topaz Name
Microsoft ASP Server
MS Active Server Pages
Microsoft Director Server
Microsoft Lync Server 2010 Director monitor
Microsoft Edge Server
Microsoft Lync Server 2010 Edge monitor
Microsoft Exchange 5.5 Message Traffic
Exchange 5.5 Message Traffic
Microsoft Exchange 2000/2003/2007
Message Traffic
Exchange 2000/2003 Message Traffic,
Microsoft Exchange 2007 Message Traffic
Microsoft Exchange 2003 Mailbox
Exchange 2003 Mailbox
Microsoft Exchange 2003 Public Folder
Exchange 2003 Public Folder
Microsoft Exchange
Microsoft Exchange 2007
Microsoft Front End Server
Microsoft Lync Server 2010 Front End
monitor
Microsoft Hyper-V
HyperVMonitor
Microsoft IIS Server
MS IIS Server
Microsoft Mediation Server
Microsoft Lync Server 2010 Mediation
monitor
Microsoft Monitoring and CDR Server
Microsoft Lync Server 2010 Monitoring and
CDR monitor
Microsoft Registrar Server
Microsoft Lync Server 2010 Registrar
monitor
Microsoft SQL Server
MS SQL Server
Microsoft Windows Dial-up
NT Dialup
Microsoft Windows Event Log
Microsoft Windows Event Log
Microsoft Windows Media Player
WindowsMedia
Microsoft Windows Media Server
MS Winodws Media Server
Microsoft Windows Performance Counter
Browsable NT Counters
Microsoft Windows Performance Counter
Windows Performance
Microsoft Windows Resources
Windows Resources
Microsoft Windows Services State
Windows Services State
HP SiteScope (11.23)
Page 185 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
Monitor Display Name
Monitor Topaz Name
Monitor Load Checker
Monitor Load Monitor
Multi Log
Multi Log
NetScout Event
NetScout Event
Network Bandwidth
Network Bandwidth Monitor
News
NNTP
Oracle 10g Application Server
Oracle10gAS
Oracle Database
Oracle
Oracle 9i Application Server
Oracle9iAS HTTP Server
Ping
Ping
Port
Port
Radius
Radius
Real Media Player
RealMediaPlayerMonitor
Real Media Server
Real Media Server
SAP CCMS
CCMS SAP
SAP CCMS Alert
SAP CCMS Alerts
SAP Java Web Application Server
SAP Java Web Application Server
SAP Performance
SAP Performance
SAP Work Processes
SAP Work Processes
Script
Script
Service
Service
Siebel Application Server
Siebel Application Server
Siebel Log
Siebel Log
Siebel Web Server
Siebel Web Server
SNMP
SNMP
SNMP by MIB
SNMP by MIB Monitor
SNMP Trap
SNMP Trap
HP SiteScope (11.23)
Page 186 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
Monitor Display Name
Monitor Topaz Name
Solaris Zones
Solaris Zones
SSL Certificates State in Health
SSL Certificates Status
SunONE Web Server
SunONE
Sybase
Sybase
Syslog
Syslog Monitor
Technology Database Integration
EMS Database
Technology Log Integration
EMS Log Monitor
Tuxedo
Tuxedo
UDDI Server
UDDI Server
UNIX Resources
Unix Resources
URL
URL Monitor
URL Content
URL Content
URL List
URL List
URL Sequence
URL Sequence Monitor
VMware Datastore
VMware Datastore Monitor
VMware Host CPU
VMware Host CPU Monitor
VMware Host Memory
VMware Host Memory Monitor
VMware Host Network
VMware Host Network Monitor
VMware Host State
VMware Host State Monitor
VMware Host Storage
VMware Host Storage Monitor
VMware Performance
VMware
Web Script
Web Script
Web Server
Web Server
Web Service
Technology Web Service
Web Service
Web Service
WebLogic Application Server
BEA WebLogic 6.0
HP SiteScope (11.23)
Page 187 of 1293
Using SiteScope
Chapter 15: SiteScope Public APIs
Monitor Display Name
Monitor Topaz Name
WebSphere Application Server
WebSphere
WebSphere MQ Status
MQStatusMonitor
WebSphere Performance Servlet
WebSphereServlet
XML Metrics
XML Metrics
Tips/Troubleshooting
SiteScope API Calls - Notes and Limitations
l
Most API methods require a SiteScope user and password as part of the method invocation.
Before using these methods, change the Access controlled property in Preferences >
Infrastructure Preferences > Custom Settings to true. The user and password can be in plain
text or encrypted. To encrypt a string, use <SiteScope
installation>\tools\AutoDeployment\encrypt_password.bat.
l
All API methods that do not have a user name and password will be deprecated in future
versions of SiteScope. All analogous API methods with user and password authentication have
been renamed and now have an Ex suffix (for example, enableGroupEx) to avoid the same
method names being used with different parameters.
l
The access level of the SiteScope user affects the behavior of the methods. For example, when
calling getConfigurationSnapshot and getFullConfigurationSnapshot, the returned maps
contain only those entities that the user is privileged to access.
l
To use applications created with previous versions of this API, set _accessControlled=false
and use the deprecated APIs. These deprecated methods will not be supported in a future
version and you will have to port your application to use the secure versions of the API methods.
l
Attempting to use the deprecated forms of the methods when _accessControlled=true or to
use the secure methods when _accessControlled=false results in an exception.
l
The .bat files (.sh files for UNIX) are examples only and not intended as production scripts. You
can change the scripts to fit your requirements.
l
Special characters are not supported in the parameter values.
l
The disable alerts API is not supported when the Disable alerts temporarily permission is not
selected in Preferences > User Management Preferences > Permissions > Alerts.
l
Some API operations can be disabled on the server. This supports a read-only mode, such that
the configuration cannot be changed remotely using the API.
HP SiteScope (11.23)
Page 188 of 1293
Chapter 16: SiteScope Mobile Apps
SiteScope provides free downloadable apps that enable you to keep track of your monitored IT
infrastructure while you are away from your computer. SiteScope mobile apps connect your
company's people and information by giving your team access to SiteScope through the use of
smartphone devices.
Tip: You can view a guided and narrated demonstration for using the SiteScope iPhone
application on the HP Videos channel on YouTube:
http://www.youtube.com/watch?v=cLawpqlkOss&feature=plcp.
Learn About
SiteScope Features Supported on Mobile Apps
SiteScope mobile apps enable your SiteScope staff to have 24 X 7 mobile access while out of the
office so that they can:
l
Receive email notifications about problems related to your organization's monitored applications
and take corrective action (rerun the monitors, view monitor report, acknowledge alerts,
enable/disable associated alerts, view acknowledgment logs).
l
Review group and monitor states to verify availability issues ahead of time, so that you can
solve them before they affect your business.
l
Use the search to gain access to monitor statistics, and perform actions on the search results to
mitigate issues (view monitor details, enable/disable monitors, run monitors, set alert actions).
l
Create ad hoc reports for monitors, groups, and alerts that display how the servers and
applications have performed over time.
l
Add selected monitors and groups to a favorites list.
l
Use Multi-View (supported on iPad only) to view the performance status of everything being
monitored in your IT infrastructure in a single view without losing the hierarchical relationship
between the data.
For more details on using SiteScope on a mobile device, refer to the help supplied with the
SiteScope mobile app. For additional information on how to use the features that are available on
the SiteScope mobile app, see the relevant topic in the SiteScope Help.
Supported Devices
SiteScope mobile apps are supported on the following devices:
l
iPhone, iPad, or iPod touch. The SiteScope iPhone mobile app is available from the iPhone
App Store (http://itunes.apple.com/us/app/hp-sitescope/id410294629?mt=8#). For a movie
demonstration of the SiteScope iPhone app, see
HP SiteScope (11.23)
Page 189 of 1293
Using SiteScope
Chapter 16: SiteScope Mobile Apps
http://www.youtube.com/watch?v=MuLAmO322nI.
l
Android phone or tablet. The SiteScope Android mobile app is available from Android Market
(https://market.android.com/details?id=com.hp.sitescope.mobile.android&feature=search_
result&rdid=com.hp.sitescope.mobile.android&rdot=1&pli=1
Note: Multi-View is supported on iPad only.
SiteScope mobile apps are supported for the following SiteScope versions:
l
SiteScope 10.13 (with patch SIS_108 for Linux, SIS_109 for Solaris, or SIS_110 for Windows)
and later.
l
SiteScope 11.01 (with patch SIS_00114 for Linux, SIS_00115for Solaris or SIS_00116for
Windows) and later.
l
SiteScope 11.10 and later.
Tasks
How to Configure Alerts to be Sent to a Mobile Device
Use the MobileAppMail template in the <SiteScope root directory>\ templates.mail folder, as
this template contains a link that can be used to open the app from your email.
How to Include HTML Content in Mail Templates Sent to a Mobile Device
In the <SiteScope root directory>\groups\master.config file, set the value for the _
defaultMailAlertContentType property to =text/html.
How to Use SiteScope in Secure Mode on a Mobile Device
Change the Access controlled property in Preferences > Infrastructure Preferences > Custom
Settings to true. Otherwise, the SiteScope user name and password are ignored.
Tips/Troubleshooting
Notes and Limitations
l
Make sure the mobile device is set to the correct local time.
l
Monitors that are disabled temporarily (regardless of whether they were disabled in the
SiteScope user interface or from a mobile device) appear in the monitor details summary
according to server time.
l
When deleting a SiteScope user account from your mobile device, any monitors or groups that
are saved to favorites under that account are also removed.
l
When changing SiteScope user account settings (for example, changing a profile's protocol from
HP SiteScope (11.23)
Page 190 of 1293
Using SiteScope
Chapter 16: SiteScope Mobile Apps
http to https, or changing the SiteScope port), all monitors related to that profile disappear from
the favorites list.
l
If you encounter insufficient memory resource messages when generating a report, free up
memory on the mobile device (for example, by closing running apps). You can increase or
decrease the memory required by SiteScope reports by moving the Minimum memory for
reports (MB) slider in the iPhone or Android Settings under HP SiteScope.
l
If you are unable to connect the mobile app to SiteScope using a 3G signal but you can connect
using a wireless network (WiFi), try changing the SiteScope port to 80, as the service provider
might be blocking some ports (such as the default SiteScope port, 8080).
HP SiteScope (11.23)
Page 191 of 1293
Chapter 17: Regular Expressions
SiteScope makes use of regular expressions to match text content. Several SiteScope monitors
enable for content matching on the text returned from a monitor's request or action. This chapter
includes information on using regular expressions to match text content in SiteScope monitors.
Regular expressions is a name given to a text parsing tool that was developed for use with scripting
languages such as Awk and Perl, as well as several programming environments, such as Emacs,
Visual C++, and Java. Regular expressions themselves are not a programming language. They do,
however, make use of many special combinations of characters and symbols that often make them
more difficult to interpret than some programming languages. The many different combinations of
these special characters, known as metacharacters, make regular expressions a very powerful and
flexible tool for parsing and isolating specific text within a larger body of text.
Including a regular expression in the Match content text box of a monitor instructs SiteScope to
parse the text returned to the monitor when it is run and look for content that satisfies the pattern
defined by the regular expression. This document presents an overview of the syntax and
metacharacters used in regular expressions for use in matching content for SiteScope monitors.
Define a Regular Expression
The element of a match content expression in SiteScope is the forward slash (/) character. Entries
in the Match content text box of a SiteScope monitor must start and end with a forward slash to be
recognized as regular expressions. For example, entering the expression /website/ into the Match
content box of a monitor instructs SiteScope to search the text content received by the monitor for
the literal text string: website. If a match is not found, the monitor reports an error status. When a
match is found, the monitor reports a good status, as long as all other monitor status threshold
conditions are also met. If you enter text or other characters into the Match content box without
delimiting the entry with forward slashes, the entry is either ignored or reported as a content match
error by SiteScope.
Adding parentheses ( ) within the forward slashes surrounding the regular expression is another
very useful function for regular expressions in SiteScope. The parentheses are used to create a
"back reference." As a back reference, SiteScope retains what was matched between the
parentheses and displays the text in the Status field of the monitor detail page. This is very useful
for troubleshooting match content. This is also a way to pass a matched value from one monitor to
another, or from one step of a URL Sequence Monitor to the next step of the same transaction.
Parentheses are also used to limit alternations, as discussed below.
Generally, it is best to use an iterative approach when building regular expressions for content
matching within SiteScope. The following are some general steps and guidelines for developing
regular expressions for content matches:
l
Create a regular expression using literal characters to match a single sample of the data you
want to monitor. For example, /value: 1022.5/.
l
Iteratively replace literal characters with character classes and metacharacters to generalize the
literal into a pattern. For example, the literal in the example above could be changed to:
HP SiteScope (11.23)
Page 192 of 1293
Using SiteScope
Chapter 17: Regular Expressions
/value:\s\d\d\d\d\.\d/ to match any four digits, a decimal point, and one more digit.
l
Consider that the pattern of the data you want to match may vary. Adjust your pattern to match
expected or possible variations in the target data. Continuing with the example used above, the
expression /value:\s\d\d\d\d\.\d/ might become /value:\s[\d]{1, 8}\.[\d]{1,2}/.
This pattern enables variation in the number of digits to the left of the decimal point and the
number of digits to the right of the decimal point. It expects that there is a decimal point. See the
following sections for more information about the character classes used here.
l
Consider that the literal string or pattern you want to match may appear more than once in the
content. Identify unique content that precedes the content you want to match, and add regular
expression patterns to make sure that the expression matches that unique content before it tries
to match the content you are trying to monitor. In the example used here, the pattern may match
the first of several entries that have a similar /value: numbers/ pattern. Adding a literal to the
pattern, that matches some static content that delimits the particular data, can be used to be
sure the match is made for the target data. For example, if the data you want to match is
preceded by the text Open Queries, this literal can be added to the pattern, along with a pattern
for any intervening content: /Open Queries[\s\W]{1,5} value:\s[\d]{1, 8}\.[\d]{1,2}/.
Match String Literals
Finding and matching an exact or literal string is the simplest form of pattern matching with regular
expressions. In matching literals, regular expressions behave much as they do in search/replace in
word processing applications. The example above matched the text Web site. The regular
expression /Buy Now/ succeeds if the text returned to the monitor contains the characters Buy
Now, including the space, in that order.
Note that regular expressions are, by default, case sensitive and literal. This means that the
content must match the expression in case and order, including non-alphanumeric characters. For
example, a regular expression of /Website/, without any modifiers, succeeds only if the content
contains the string Website exactly but fails even if the content on the page is website, WEBSITE,
or Web site. (In the last case the match fails because there is space between the two words but
not in the regular expression.)
There are cases where you may want to literally match certain non-alphanumeric characters which
are special "reserved" metacharacters used in regular expressions. Some of these metacharacters
may conflict with important literals that you are trying to match with your regular expression. For
example, the period or dot symbol (.), the asterisk (*), the dollar sign ($), and back slash (\) have
special meanings within regular expressions. Because one of these characters may be a key part of
a particular text pattern you are looking for, you must "escape" these characters in your regular
expression so that the regular expression processing treats them as literal characters rather than
interpreting them as special metacharacters. To force any character to be interpreted as a literal
rather than a metacharacter, add a back slash in front of that character.
Example - Matching a Literal String
For example, if you wanted to find the string 4.99 on a Web page you might create a regular
expression of /4.99/. While this matches the string 4.99, it would also match strings like 4599
and 4Q99 because of the special meaning of the period character. To have the regular expression
interpret the period as a literal, escape the period with a forward slash as follows: /4\.99/. You can
HP SiteScope (11.23)
Page 193 of 1293
Using SiteScope
Chapter 17: Regular Expressions
add the back slash escape character in front of any character to force the regular expression
processing to interpret the character following the back slash as a literal. In general, use this syntax
whenever you want to match any punctuation mark or other non-alphanumeric character.
Using Alternation
Alternation enables you to construct either/or matches where you know that one of two or more
strings should appear in the content. The alternation character is the vertical pipe symbol ("|").
The vertical pipe is used to separate the alternate strings in the expression. For example, the
regular expression /(e-mail|e-mail|contact us)/ succeeds if the content contains any one of
the three strings separated by the vertical pipes. The parentheses are used here to delimit
alternations. In this example, there are no patterns outside of the alternation that must be matched.
In contrast, a regular expression might be written as /(e-mail|e-mail|contact) us/. In this
case, the match succeeds only when any of the three alternates enclosed in the parentheses is
followed immediately by a single white space and the word us. This is more restrictive than the
previous example, but also shows how the parentheses limit the alternation to the three words
contained inside them. The match fails even if one or more of the alternates are found but the word
"us" is not the next word.
Match Patterns with Metacharacters
Often you may not know the exact text you need to match, or the text pattern may vary from one
session or from one day to another. Regular expressions have a number of special metacharacters
used to define patterns and match whole categories of characters. While matching literal
alphanumeric characters seems trivial, part of the power of regular expressions is the ability to
match non-alphanumeric characters as well. Because of this, it is important to keep in mind that
your regular expressions need to account for the presence of non-alphanumeric characters in the
content you are searching. This means that characters such as periods, commas, hyphens,
quotation marks, and even white spaces, must be considered when constructing regular
expressions.
This section contains the following topics:
l
"Metacharacters Used in Regular Expressions" below
l
"Defining Character Classes" on the next page
l
"Using Quantifiers" on page 196
Metacharacters Used in Regular Expressions
Metacharacter Description
\s
HP SiteScope (11.23)
Matches generic white space (that is, the Spacebar key). This metacharacter is
particularly useful when combined with a quantifier to match varying numbers of
white space positions that may occur between words that you are looking to
match.
Page 194 of 1293
Using SiteScope
Chapter 17: Regular Expressions
Metacharacter Description
\S
Matches characters that are not white space. Note that the \S is capitalized as
opposed to the small \s which is used to match white space.
.
This is the period or dot character. Generally, it matches all characters.
Because SiteScope considers the dot as a form of character class on its own,
do not include it inside the square brackets of a character class.
\n
Matches the linefeed or newline character.
\r
Matches the carriage return character.
\w
Matches non-white space word characters, the same as what is matched by
character class [A-Za-z0-9_]. It is important to note that the \w metacharacter
matches the underscore character but not other punctuation marks such as
hyphens, commas, periods, and so forth.
\W
Matches characters other than those matched by \w (lowercase). This is
particularly useful for matching punctuation marks and non-alphabetic
characters, such as [email protected]#$%^&*()+={[}]:; and including the linefeed character,
carriage return, and white space. It does not match the underscore character,
which is considered a word constituent matched by \w.
\d
Matches digits only. This is equivalent to the [0-9] character class.
\D
Matches non-numeric characters (what \d does not match) plus other
characters. Similar to \W but also matches on alphabetic characters. In
SiteScope, this generally matches everything, including multiple lines, until it
encounters a digit.
\b
Requires that the match have a word boundary (usually a white space) at the
position indicated by the \b.
\B
Requires that the match not have a word boundary at the position indicated.
Defining Character Classes
An important and very useful regular expression construct is the character class. Character classes
provide a set of characters that may be found in a particular position within a regular expression.
Character classes may be used to define a range of characters to match a single position or, with
the addition of a quantifier, may be used to universally match multiple characters and even
complete lines of text.
You form character classes by enclosing any combination of characters and metacharacters in
square brackets: [ ]. Character classes create an "any-or-all-of-these" group of characters that may
be matched. Unlike literals and metacharacters outside character classes, the physical sequence
of characters and metacharacters within a character class has no effect on the search or match
sequence. For example, the class [ABC0123abc] matches the same content as [0123abcABC].
The hyphen is used to further streamline character classes to indicate a range of letters or numbers.
For example, the class [0-9] includes all digits from zero to nine inclusive. The class [a-z] includes
all lowercase letters from a to z. You can also create more restrictive classes with the hyphen, such
HP SiteScope (11.23)
Page 195 of 1293
Using SiteScope
Chapter 17: Regular Expressions
as [e-tE-T], to match upper or lowercase letters from E to T, or [0-5] to match digits from zero to five
only.
You can use the caret character (^) within a character class as a negation or to exclude certain
characters from a content match.
Example Character Classes
Example Description
[a-zA-Z]
This matches any alphabetic character, both upper case and lowercase, from the
letter a to the letter z. To match more than one character, append a quantifier after the
character class as described below.
[0-9]
This matches any digit from 0 to 9. To match more than one digit, append a quantifier
after the character class as described below.
[0-9A-Za- This matches any alphanumeric character, excluding the underscore.
z]
[\w\s]
This matches any alphanumeric character, any white space, or both.
Using Quantifiers
Another set of metacharacters used in regular expressions provides character counting options.
This adds a great deal of power and flexibility in content matching. Quantifiers are appended after
the metacharacters and character classes described above to specify against which positions the
preceding match character or metacharacter should be matched. For example, in the regular
expression /(contact|about)\s+us/, the metacharacter \s matches on a white space. The plus
sign quantifier following the \s means that there must be at least one white space between the
words contact (or about) and us.
The following table describes the quantifiers available for use in regular expressions. The Quantifier
applies to the single character immediately preceding it. When used with character classes, the
quantifier is placed outside the closing square bracket of the character class. For example: [a-z]+
or [0-9]*.
Quantifier
Description
?
The question mark means the preceding character or character class may appear
once, but is optional and not required to appear in the position indicated.
*
The asterisk requires that any number of the preceding character or character class
appear in the designated position. This includes zero or more matches.
Note: Care must be used in combining this quantifier with the dot (.) metacharacter
or a character class including the \W metacharacter, as these are likely to "grab"
more content than anticipated and cause the regular expression engine to use up all
of the available CPU time on the SiteScope server.
HP SiteScope (11.23)
Page 196 of 1293
Using SiteScope
Chapter 17: Regular Expressions
Quantifier
Description
+
The plus sign requires that the preceding character or character class appear at
least once.
{min,max} Using curly braces creates a quantifier range. The range enumerator digits are
separated by commas. This construct requires that the preceding character or
character class appear at least as many times as specified by the min enumerator
up to but no more than the value of the max enumerator. The match succeeds as
long as there are at least as many matches as specified by the min enumerator.
However, the matching continues up to the number of times specified by the max
enumerator or until no more matches are found.
Match content in SiteScope is run against the entire HTTP response, including the HTTP header,
which is not normally viewable by using the browser. The HTTP header usually contains several
lines of text including words coupled with sequences of numbers. This may cause failure of some
otherwise simple content matching on short sets of numbers and letters. To avoid this, identify a
unique sequence of characters near the text you are trying to match and include them as literals,
where applicable, in the regular expression.
Search Mode Modifiers
Regular expressions used in SiteScope may include optional modifiers outside of the slashes used
to delimit the expression. Modifiers after the ending slash affect the way the matching is performed.
For example, regular expression of /website/i with the i search modifier added makes the match
content search insensitive to upper and lowercase letters. This would match either website,
Website, WEBSite, or even WEBSITE.
With the exception of the i modifier, some metacharacters and character classes can override
search mode modifiers. In particular, the dot (.) and the \W metacharacters can override the m and s
modifiers, matching content across multiple lines despite the modifier.
More than one modifier can be added by concatenating them together after the closing slash of the
regular expression. For example: /matchpattern/ic combines both the i and c modifiers.
Regular Expression Match Mode Modifiers
Mode
Modifier Description
/i
Ignore case mode. This makes the search insensitive to upper case and lowercase
letters. This is a useful option especially when searching for matches in the text
content of Web pages.
/c
The matched pattern may NOT appear anywhere in content that is being searched.
This is a "complement" match, returning an error if the pattern IS found, and
succeeding if the pattern is NOT found.
HP SiteScope (11.23)
Page 197 of 1293
Using SiteScope
Chapter 17: Regular Expressions
Mode
Modifier Description
/m
Match across multiple lines WITHOUT ignoring intervening carriage returns and
linefeeds. With this modifier you may still need to account for possible linefeeds and
carriage returns with a character class such as [\w\W]* or [\s\S\n\r]*. The .* does not
match carriage returns or linefeed characters with this modifier.
/s
Consider the content as being on a single line, ignoring intervening carriage returns
and linefeed characters. With this modifier, both the [\w\W]* character class and the
.* pattern match across linefeeds and carriage returns.
Retain Content Match Values
Some monitors, like the URL Monitor and URL Sequence Monitor, have a content match value that
is logged and can be used to set error status thresholds. Another purpose of the parentheses /
(match pattern)/ used in regular expression syntax is to determine which text is retained for the
Content Match Value. You use this function to use content match values directly as thresholds for
determining the error threshold of a URL monitor or URL Sequence monitor.
For example, if the content match expression was:
/Copyright (\d*)/
and the content returned to the monitor by the URL request included the string:
... Copyright 2007 by HP
then the match is made and the retained content match value would be:
2007
Under the error-if option at the bottom of the monitor set up page, you could then change the error-if
condition from the default of status != 200 to content match, then specify the relational operator as
!=, and then specify the value 2008. This sets the error threshold for this monitor so that whenever
the year in the string Copyright is other than 2008, the monitor reports an error. This mechanism
could be used to watch for unauthorized content changes on Web pages.
Checking a Web page for links to other URLs can be an important part of constructing URL
Sequence Monitors. The following regular expression can be used to match the URL text of a link
on a Web page:
/a href="?([:\/\w\s\d\.]*)"?/i
This expression matches the href="protocol://path/URLname.htm" for many URLs. The question
mark modifiers enable the quotation marks around the HREF= attribute to be optional. The i
modifier enables the match pattern to be case-insensitive.
Retained or remembered values from content matches can be referenced and used as input for
subsequent steps in a URL Sequence Monitor. See the Match content section of the URL
Sequence Monitor for the syntax used for Retaining and Passing Values Between Sequence Steps.
HP SiteScope (11.23)
Page 198 of 1293
Using SiteScope
Chapter 17: Regular Expressions
SiteScope Date Variables
SiteScope uses specially defined variables to create expressions that match the current date or
time. These variables can be used in content match fields to find date-coded content. The General
Date Variables are useful for matching portions of date formats. The Language/Country Specific
Date Variables enable you to automatically extend the language used for month names and
weekday names to specific countries, based on ISO codes.
This section contains the following topics:
l
"General Date Variables" below
l
"Language/Country Specific Date Variables" on the next page
l
"Special Substitution for Monitor URL or File Path" on page 201
General Date Variables
The following table lists the general variables:
Variable
Range of Values
$hour$
0 - 23
$minute$
0 - 59
$month$
1 - 12
$day$
1 - 31
$year$
1000 - 9999
$shortYear$
00 - 99
$weekdayName$
Sun - Sat
$fullWeekdayName$
Sunday - Saturday
$0hour$
00 - 23
$0minute$
00 - 59
$0day$
01 - 31 (two-digit day format)
$0month$
01 - 12 (two-digit month format)
$monthName$
Jan - Dec (three-letter month format in English)
$fullMonthName$
January - December
$ticks$
milliseconds since midnight, January 1, 1970
For example, if the content match search expression was defined as:
HP SiteScope (11.23)
Page 199 of 1293
Using SiteScope
Chapter 17: Regular Expressions
/Updated on $0month$\/$0day$\/$shortYear$/
and the content returned by the request includes the string:
Updated on 06/01/98
then the expression would match when the monitor is run on June 1, 1998. The match fails if the
content returned does not contain a string matching the current system date or if the date format is
different than the format specified.
If you want the time to be before or after the current time, you can add a $offsetMinutes=mmmm$
to the expression, and this offsets the current time by mmmm minutes (negative numbers are
permitted for going backwards in time) before doing the substitutions.
For example, if the current day is June 1, 2007, and the search expression is:
/$offsetMinutes=1440$Updated on $0month$\/$0day$\/$shortYear$/
the content string that would match would be:
Updated on 06/02/07
Note: The date is one day ahead of the system date.
Language/Country Specific Date Variables
The following table lists the SiteScope special variables for use with international day and month
name matching. The characters LL and CC are placeholders for two-letter ISO 639 language code
characters and two-letter ISO 3166 country code characters (see the notes below the table for more
details).
Variable
Range of Values
$weekdayName_LL_
CC$
Abbreviated weekday names for the language (LL) and country (CC)
specified (see notes below).
$fullWeekdayName_
LL_CC$
Full weekday names for the language (LL) and country (CC) specified.
$monthName_LL_
CC$
Abbreviated month names for the language (LL) and country (CC)
specified.
$fullMonthName_LL_
CC$
Full month names for the language (LL) and country (CC) specified.
CC - an uppercase 2-character ISO-3166 country code. Examples are: DE for Germany, FR for
France, CN for China, JP for Japan, BR for Brazil. You can find a full list of these codes at a
number of Internet sites, such as:
http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_names_and_code_
elements.htm.
LL - a lowercase 2-character ISO-639 language code. Examples are: de for German, fr for French,
zh for Chinese, ja for Japanese, pt for Portuguese. You can find a full list of these codes at a
number of Internet sites, such as:
HP SiteScope (11.23)
Page 200 of 1293
Using SiteScope
Chapter 17: Regular Expressions
http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt or
http://www.dsv.su.se/~jpalme/ietf/language-codes.html.
For example, if the content match expression was defined as:
/$fullWeekdayName_fr_FR$/i
and the content returned by the request includes the string:
mercredi
then this expression would match when the monitor was run on Wednesday.
If you are not concerned with the country-specific language variations, it is possible to use any of
the above variables without including the country code. For example:
/$fullWeekdayName_fr$/
could be used to match the same content as /$fullWeekdayName_fr_FR$/.
Special Substitution for Monitor URL or File Path
SiteScope Date Variables are useful for matching content as part of a regular expression. The date
variables can also be used as a special substitution to dynamically create URLs or file paths for
specific monitors. This is useful for monitoring date-coded files and directories where the URL or
file path is updated automatically based on system date information. SiteScope is an example of an
application that creates date-coded log files. The log file names include some form of the year,
month, and day as part of the file name, such as File2001_05_01.log, where the year, month,
and date are included.
Based on this example, a new file is created each day. Monitoring the creation, size, or content of
the current days file would normally require the file path or URL of the monitor to be manually
changed each day. Using the SiteScope date variables and special substitution, SiteScope can
automatically update the file path to the current day's log file. By knowing the pattern used in
naming the files, you can construct a special substitution string similar to a regular expression that
substitutes portions of the system date properties into the file path or URL.
For example if the absolute file path to the current day's log file in a file monitor is:
D:/Production/Webapps/Logs/File2001_05_01.log
the log file for the following day would be:
D:/Production/Webapps/Logs/File2001_05_02.log
You can construct a special substitution expression to automatically update the file path used by
the monitor, with the following syntax:
s/D:\/Production\/Webapps\/Logs\/File$year$_$0month$_$0day$.log/
The substitution requires that the expression start with a lower-case s and that the expression is
enclosed by forward slashes /.../. Forward slashes that are part of the file path must be escaped
by adding the back slash (\) character as shown. The SiteScope date variables are separated by the
underscore character literals. SiteScope checks the system time properties each time the monitor
runs and substitutes with applicable values into the file path or URL before accessing the file.
SiteScope monitor types that support the special substitution are:
HP SiteScope (11.23)
Page 201 of 1293
Using SiteScope
Chapter 17: Regular Expressions
l
e-Business Transaction monitor
l
File monitor
l
Log File monitor
l
URL monitor
l
URL Sequence Monitor
l
Web server monitor
While the special substitution syntax is similar in syntax to the substitution syntax used in regular
expressions, they are not the same. While all of the SiteScope date variables can be used in match
content regular expressions, the special substitution discussed here can not be used as part of a
match content expression.
Examples for Log File Monitoring
SiteScope's Log File Monitor and File Monitor check for entries in files created by other
applications. These files may be data files created by a third-party application or they may be logs
created by a custom system specially designed for your environment. Where the logs or files are
written with a known, predictable format, SiteScope can be configured to regularly check the files
for new entries and match on specific content strings. The following are several examples of log file
entries and simple regular expression patterns that can be used to check the entries. You can use
these examples or modify them to work with a specific case.
Note: All regular expressions must be entered on a single line in SiteScope. Some of the
examples below may break across more than one line to fit on this page.
This section contains the following topics:
l
"Searching Paths for Log Files" below
l
"Matching Comma-Separated Values" on the next page
l
"Matching Space Separated Values" on page 204
l
"Matching and Retaining the Numbers in a Line of Text and Numbers" on page 204
l
"Matching Integers and Floating-point Numbers (Positive or Negative)" on page 205
l
"Matching Date and Time-Coded Log Entries" on page 205
Searching Paths for Log Files
UNIX and Windows operating systems treat the case ("N" and "n") of file names in incompatible
ways. Windows operating systems are case insenstive which means that when a file is being
searched, its case is ignored. UNIX operating systems are case sensitive which means that the
case of a name is significant at all times. To avoid log file errors when using regular expressions to
HP SiteScope (11.23)
Page 202 of 1293
Using SiteScope
Chapter 17: Regular Expressions
search for path names on UNIX operating systems, use markers to change the character case in
the path expression.
Marker Description
$L
Enables changing characters between the $L marker and the $E marker to lowercase.
$U
Enables changing characters between the $U marker and the $E marker to upper case.
$E
The end marker used for changing character case.
Example:
If you define the following path expression:
s/\/tmp\/logs\/arcv.log.$weekdayName$/
for the /tmp/logs/arcv.log.tue log file on a Linux machine, you get a log file error because
SiteScope tries to find tmp/logs/arcv.log.Tue, and Linux is case sensitive.
To resolve this problem, define the path expression as follows:
s/\/tmp\/logs\/arcv.log.$L$weekdayName$$E/
The monitor converts the characters between $L and $E to lowercase,
/tmp/logs/arcv.log.tue.
Conversely, use $U and $E to enable SiteScope to change the characters between the markers
to upper case. For example, if you define the path expression:
s/\/tmp\/logs\/arcv.log.$L$weekdayName$$E/
the monitor converts the path to /tmp/logs/arcv.log.TUE.
You can use $L and $U multiple times in a path expression, and you can use them both in the
same expression.
For example:
s/\/tmp\/logs-$L$weekdayName$$E\/arcv.log.$U$weekdayName$$E/
converts the path to /tmp/logs-tue/arcv.log.TUE
s/\/tmp.$L$monthName$$E\/logs-$L$weekdayName$$E\/arcv.log.$U$weekdayName$$E/
converts the path to /tmp.mar/logs-tue/arcv.log.TUE
Matching Comma-Separated Values
The following is an example of log file entries that are comma-separated strings of digits and letters:
new,open,changed,12,alerts
new,open,changed,13,alerts
new,open,changed,13,alerts
new,open,changed,14,alerts
HP SiteScope (11.23)
Page 203 of 1293
Using SiteScope
Chapter 17: Regular Expressions
A regular expression to match on log file entries that are comma-separated strings of digits and
letters.
/([\w\d]+,[\w\d]+,[\w\d]+,[\w\d]+,[\w\d]+)[\n\r]?/
Note: If the file entries include punctuation marks such as an underscore or a colon, add that
character explicitly to the [\w\d] class pattern. For example, to include a colon character,
change each of the [\w\d] patterns to [\w\d:].
Matching Space Separated Values
The following is an example of log file entries that are a sequence of strings and digits separated by
spaces:
requests
requests
requests
requests
requests
12
12
11
12
10
succeeded
succeeded
succeeded
succeeded
succeeded
12
12
11
12
10
failed
failed
failed
failed
failed
The following is a regular expression to match on log file entries that are a sequence of strings and
digits separated by spaces.
/([\w\d]+\s+[\w\d]+\s+[\w\d]+\s+[\w\d]+\s+[\w\d]+)[\n\r]?/
Note: The use of the + character forces the match to include the number of sequences per line
included in the match pattern: in this example, five word or number sequences per line of the
log file. If the sequences include punctuation marks such as an underscore or colon, add that
character explicitly to the [\w\d] class pattern. For example, to include a colon character,
change each of the [\w\d] patterns to [\w\d:].
Matching and Retaining the Numbers in a Line of Text and Numbers
The following is an example of log file entries that are comma separated strings that combine digits
and letters:
request handle number 12.56, series 17.5, sequence reported 97.45, 15.95 and
19.51
request handle number 15.96, series 27.5, sequence reported 107.45, 25.95 and
19.52
request handle number 11.06, series 36.5, system codes 9.45, 35.95 and 19.53
log reference number 12.30, series 17.5, channel reset values 100.45, 45.95
HP SiteScope (11.23)
Page 204 of 1293
Using SiteScope
Chapter 17: Regular Expressions
and 19.54
The following is a regular expression to match on log file entries that are comma-separated strings
that combine digits and letters and retain the decimal numeric data:
/[,\w\s]+(\d+\.\d+)[,\w\s]+(\d+\.\d+)[,\w\s]+(\d+\.\d+)[,\w\s]+
(\d+\.\d+)[,\w\s]+(\d+\.\d+)[\n\r]?/.
Note: If the file entries include punctuation marks such as an underscore or colon, add that
character explicitly to the [,\w\s] class pattern. For example, to include a colon character that
appears embedded in the text sequences, change each of the [,\w\s] patterns to [,:\w\s].
Matching Integers and Floating-point Numbers (Positive or Negative)
The following is an example of log file entries that are a sequence of integers and floating point
numbers that may be negative or positive:
12.1987
13.2987
14.3987
15.4987
-71
-72
-73
-74
-199.1
-199.2
-199.3
-199.4
145
245
345
445
-1.00716
-1.00726
-1.00736
-1.00746
The following is a regular expression to match on log file entries that are a sequence of 5 integers
and floating point numbers that may be negative or positive. The numbers in each entry must be
separated by one or more spaces.
/(-?\d+\.?\d{0,})[\s]+(-?\d+\.?\d{0,})[\s]+(-?\d+\.?\d{0,})[\s]+
(-?\d+\.?\d{0,})[\s]+(-?\d+\.?\d{0,})[\n\r]?/
Matching Date and Time-Coded Log Entries
Many log files include some form of date and time data with each entry. The following is an example
of log file entries that include date and time information together with string data separated by
commas:
20/04/2003 14:29:22,ERROR,request failed
20/04/2003 14:31:09,INFO,system check complete
20/04/2003 14:35:46,INFO,new record created
The following is a regular expression to match on log file entries that are date- and time-coded
followed by comma-separated strings of letters and digits. This example uses the SiteScope date
variables to match only on entries that were created on the same day, month, and year as indicated
by the system clock of the server where SiteScope is running.
/$0day$\/$0month$\/$year$\s+\d+:\d+:\d+,[\w\d]+,[\w\d]+/
HP SiteScope (11.23)
Page 205 of 1293
Using SiteScope
Chapter 17: Regular Expressions
The following example uses the SiteScope date variables to match on a more restricted set of
entries that were created on the same day, month, year, and within the same hour as indicated by
the system clock of the server on which SiteScope is running.
/$0day$\/$0month$\/$year$\s+$0hour$:\d+:\d+,[\w\d]+,[\w\d]+)/
Problems Working with Regular Expressions
This section contains problems encountered when working with regular expressions.
This section contains the following topics:
l
"Using the .* construct presents a very large number of possible matches on any page of
content" below
l
"Text matching is done against code lines of the script (instead of against the browser's output
from the script) for URLs containing client side-scripts, such as JavaScript" below
l
"Regular expression match succeeds as soon as the minimum match requested is satisfied" on
the next page
l
"Forgetting to account for non-alphanumeric content" on the next page
l
"Use of excessive metacharacters can be problematic" on the next page
l
"Example Regular Expression Syntax" on the next page
Using the .* construct presents a very large number of possible matches
on any page of content
The use of the .* construct is known to cause the regular expression-matching engine used by
SiteScope to take over all available CPU cycles on the SiteScope server. If this occurs, SiteScope
is unable to function and must be restarted each time the monitor with the offending regular
expression is run, until the expression has been corrected.
Note: Regular expression matching is run against the entire text content returned to the
SiteScope monitor request. This includes HTTP headers that are normally not viewable in the
browser window (for example, not visible using the View > Source option). This also means
that you must account for other information that may not be displayed in the browser view. This
includes text in META tags used by Internet search engines as well as client side-scripts.
Text matching is done against code lines of the script (instead of against
the browser's output from the script) for URLs containing client sidescripts, such as JavaScript
This means that if the script dynamically writes or replaces text on the Web page with values
calculated by the script, it may not be possible to match this content with regular expressions. If the
script is only changing text, you may be able to match the corresponding text strings that appear in
the script code. A further pitfall would be that you are trying to check that a certain condition was
HP SiteScope (11.23)
Page 206 of 1293
Using SiteScope
Chapter 17: Regular Expressions
met in the browser but the matching text string appears in the script content regardless of any user
action.
Regular expression match succeeds as soon as the minimum match
requested is satisfied
After a match is made, no further matching is performed. Therefore, regular expressions are not well
suited to count the number of occurrences of a repeating text pattern. For example, if you want to
check a Web page with a catalog list of items and each item has a link next to it saying Buy Now!
and you want to make sure that at least five items are listed, a regular expression of /Buy Now!/
would succeed in matching only the first Buy Now!. Likewise, if your regular expression searches
the word catalog on the main browser screen, the match may succeed if the word appears as a
META tag in the HTML header section or if it appears as a hyperlink in a site navigation menu that
appears in the content before the occurrence you intend to match.
Forgetting to account for non-alphanumeric content
Regular expressions need to be written to account for all of the characters that are and may be
present. This includes white space, linefeed, and carriage returns. This is not normally a problem
when matching a single-word literal. It can be a challenge when you need to create a match of
several words separated by unknown amounts of white space and other non-alphanumeric
characters and possibly span more than one line. The [\s\n\r]+ character class can be useful
between words used in the expression. Always check the format of the content you are trying to
match to look for patterns and special characters, such as periods, commas, and hyphens, that
may cause a seemingly simple match to fail.
Use of excessive metacharacters can be problematic
In some cases, overly generous quantifiers combined with the . or \W metacharacters can grab
content that you were intending to match with a literal string elsewhere in your regular expression
resulting in a match failure. For example, the following might be used to match the URL content of
the hyperlink anchor reference: /a href="([\W\w\s]*)"/. When the monitor performs the check
for this regular expression, however, the match grabs the first occurrence of the pattern /a href="...
and continues matching multiple lines of text up to the last quotation mark found on the page.
Without some other unique ending delimiter, the [\W\w\s]* class and quantifier combination is too
excessive. A more successful syntax that narrows the class of expected characters would be: /a
href="?([:\/\w\s\d\.]*)"?/
Example Regular Expression Syntax
The following are some examples of syntax for use in regular expressions:
Example
Expression
Description
/CUSTID\s?=\s? This example matches an ID string that is made of 20 or more digits and
upper-case letters with no spaces or other non-alphanumeric characters. The
([A-Z0-9]
{20,48})/
\s? construct permits a white space on either side of the equals sign. Using
the parentheses around the character class instructs SiteScope to retain this
value (up to the maximum of 48 characters) as a content match value and the
matched value is displayed in the monitor detail status column.
HP SiteScope (11.23)
Page 207 of 1293
Using SiteScope
Chapter 17: Regular Expressions
Example
Expression
Description
/a href="?
This example matches the URL string in an HTML hyperlink. The "?
([:\/\w\s\d\.] construct makes a quotation mark on either end of the URL string optional.
Using the parentheses instructs SiteScope to retain this value as a content
*)"?/i
match value and the value is displayed in the monitor status. The i modifier
tells the search to treat upper- and lower-case letters equally.
/"[^"]*"/
This example matches text sequences that are contained between quotation
marks. Note the use of the negation caret (^) to define a character class of all
characters other than the quotation mark.
As with programming and scripting languages, there is almost always more than one way to
construct a regular expression to accomplish a particular match. There is not one right way to build
regular expressions. You should plan to test and modify regular expressions as necessary until you
get the results you need.
HP SiteScope (11.23)
Page 208 of 1293
Part 3: Integrations
SiteScope can be integrated with a wide variety of HP software and third party products, including
HP Business Service Management (BSM), HP Operations Manager (HPOM), HP Network Node
Manager i (NNMi), HP LoadRunner, HP Performance Center, HP Operations Orchestration (OO),
HP Application Lifestyle Management (ALM), HP Diagnostics, HP Continuous Delivery
Automation (CDA), and Amazon CloudWatch.
For more details on SiteScope integrations, see "Integrations Overview" on page 210.
For a diagram illustrating the various integrations available, what each integration gives you, and
how the integration works, see "Integrating with Other Applications" on page 213.
For the versions of HP software that are supported in this release, refer to the SiteScope Support
Matrices section in the SiteScope Deployment Guide (<SiteScope root directory>\sisdocs\doc_
lib\Get_Documentation.htm).
HP SiteScope (11.23)
Page 209 of 1293
Chapter 18: Integrations Overview
SiteScope can be integrated with the following applications:
HP Business Service Management
SiteScope can be used as a data collector for HP Business Service Management (BSM). BSM
receives data about end-users, business processes, and systems and uses the data in reports and
analysis. You can configure SiteScope monitor data to be sent to BSM for all monitors, or for
selected monitors only. For details, see "Connecting to a BSM Server" on page 225.
HP Operations Manager
SiteScope can work together with HP Operations Manager products to provide a combination of
agentless and agent-based infrastructure management.
l
Event Integration. SiteScope uses the HP Operations agent to forward event data to
Operations Manager (HPOM) or to Operations Management in BSM, enabling a more
comprehensive and detailed overview of the health of your IT operation.
l
Metrics Integration.
n
To report metrics for use in Performance Manager (a reporting component of HPOM),
SiteScope uses the HP Operations agent to act as data storage for metrics collected data by
SiteScope.
n
To report metrics for use in Performance Graphing in BSM's Operations Management,
SiteScope uses either the profile database in BSM (the recommended option) or the HP
Operations agent.
For details, see Integrating SiteScope with HP Operations Manager Products in the SiteScope
Help. You can check the HP Software Integrations site to see if a more updated version of this
guide is available:
(for Windows: http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39;
for UNIX: http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
Tip: For best practices and troubleshooting for using and configuring the integration of
SiteScope with BSM and HPOM products, see Integration with BSM and HPOM Best
Practices Overview.
HP Network Node Manager i (NNMi)
SiteScope can be used as a data collector for HP Network Node Manager i (NNMi), which is an
event console used for network monitoring. SiteScope monitors the application side of the system
that NNMi is monitoring, and uses SNMP Traps to forward event data from SiteScope monitors to
NNMi. SiteScope can also report metrics data to NNMi. For details, see Integrating SiteScope with
NNMi in the SiteScope Help. You can check the HP Software Integrations site to see if a more
updated version of this guide is available
(http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=483).
HP SiteScope (11.23)
Page 210 of 1293
Using SiteScope
Chapter 18: Integrations Overview
HP LoadRunner/HP Performance Center
SiteScope can be used with an HP LoadRunner or HP Performance Center installation to enable
users to define and use SiteScope monitors on a LoadRunner or Performance Center application.
SiteScope provides additional monitoring that complements the native LoadRunner and
Performance Center monitors. To integrate SiteScope with LoadRunner or Performance Center, the
HP SiteScope for Load Testing setup type must be installed. For details, see "Integrating with HP
Load Testing Products" on page 257.
HP Operations Orchestration (OO)
The HP Operations Orchestration (OO) SiteScope integration enables OO administrators to
connect specific events or alerts in SiteScope to the execution of OO flows. The administrator
builds OO flows using SiteScope operations (which use SiteScope API calls) in OO Studio. For
example, an OO administrator can create flows that automatically create monitors in SiteScope
when a new server is added, or delete monitors when the server is decommissioned. For details,
see the HP Operations Orchestration SiteScope Integration Guide in the OO documentation set.
HP Application Lifestyle Management (ALM)
SiteScope integrates with HP Application Lifecycle Management (ALM) to share monitoring data
and templates from the production environment to enable load testing engineers to plan
performance tests and application deployment. For details, see the "Application Lifecycle
Management Integration" page in the BSM Application Administration Guide in the BSM Help.
HP Diagnostics
HP Diagnostics monitors application servers using SiteScope. SiteScope forwards data about
these application servers to Diagnostics, providing an insight into the infrastructure components
onto which the application servers are deployed. Diagnostics presents the data in its reports and
graphs. For details, see Integrating SiteScope with HP Diagnostics in the SiteScope Help. You can
check the HP Software Integrations site to see if a more updated version of this guide is available
(http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=665).
Amazon CloudWatch
SiteScope can be used to report SiteScope monitor measurement data to an Amazon CloudWatch
service. This integration enables customers who use SiteScope for monitoring their AWS-hosted
applications to report any SiteScope metrics to Amazon CloudWatch service. SiteScope metrics
data can be used for AWS AutoScaling, reporting, and alerting. For details, see "Amazon
CloudWatch Integration Preferences" on page 657.
Generic Data integrations
SiteScope can be used to forward metrics to other applications that can receive XML files. These
files contain information about the status of SiteScope groups, monitors, and measurements. For
details, see "Generic Data Integration Preferences" on page 681.
Generic Event integrations
SiteScope can be used to forward events to a third-party application or management console. The
event that is sent contains information regarding the monitor and its measurement, including the
status change that triggered the event. For details, see "Generic Event Integration Preferences" on
page 686.
HP SiteScope (11.23)
Page 211 of 1293
Using SiteScope
Chapter 18: Integrations Overview
For a diagram illustrating the various integrations available,what each integration gives you, and
how the integration works, see "Integrating with Other Applications" on page 213.
HP SiteScope (11.23)
Page 212 of 1293
Chapter 19: Integrating with Other Applications
You can integrate SiteScope with the various different applications as listed in the following
sections:
l
"Integrating with BSM and Operations Manager Products" below
l
"Integrating with Other HP Products" on page 220
Integrating with BSM and Operations Manager Products
HP SiteScope (11.23)
Page 213 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
(1)
SiteScope
events ->
BSM events
and health
indicators.
What the
Integration Gives
You
If you have an
Event Management
Foundation license,
the events
corresponding to
SiteScope metrics
status changes and
alerts are displayed
in the Event
Browser in
Operations
Management.
If the SiteScope
events have
corresponding
event type
indicators (ETIs),
the health
indicators affect the
status of the
relevant CIs in BSM
applications such
as Service Health
and Service Level
Management
(regardless of
whether you have
an Event
Management
Foundation
license).
HP SiteScope (11.23)
How the Integration
Works
If SiteScope is
configured as a data
collector for BSM's
Operations
Management,
SiteScope sends
data about SiteScope
metrics status
changes and alerts to
Operations
Management using
the HP Operations
agent technology.
Where to Get the Details
l
Integration with BSM and HPOM
Best Practices Guide in the
SiteScope Help
l
Integrating SiteScope with HP
Operations Manager Products in the
SiteScope Help (End-to-end flow)
Note: You can check the
HP Software Integrations site to see
if a more updated version of this
guide is available (for Windows:
http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=39;
for UNIX: http://support.openview.
hp.com/sc/solutions/integrations.jsp?
intid=628)
l
For information on the Operations
Management (OMi) licensing
structure, see Licensing in the BSM
User Guide in the BSM Help
Page 214 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
(2)
SiteScope
events ->
HPOM
events.
What the
Integration Gives
You
Events generated
from SiteScope
metrics status
changes and alerts
are displayed in
HPOM.
How the Integration
Works
If SiteScope is
configured to report
events to HPOM,
SiteScope sends
data about SiteScope
metrics status
changes and alerts to
HPOM using the HP
Operations agent
technology.
Where to Get the Details
l
Integration with BSM and HPOM
Best Practices Guide in the
SiteScope Help
l
Integrating SiteScope with HP
Operations Manager Products in the
SiteScope Help (End-to-end flow)
Note: You can check the
HP Software Integrations site to see
if a more updated version of this
guide is available (for Windows:
http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=39;
for UNIX: http://support.openview.
hp.com/sc/solutions/integrations.jsp?
intid=628)
l
HP SiteScope (11.23)
For information on the Operations
Management (OMi) licensing
structure, see Licensing in the BSM
User Guide in the BSM Help
Page 215 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
(3)
SiteScope
events ->
BSM events
and health
indicators
using HPOM.
What the
Integration Gives
You
If you have an
Event Management
Foundation license,
events generated
from SiteScope
metrics status
changes and alerts
are sent to
Operations
Management using
HPOM.
If the SiteScope
events have
corresponding
event type
indicators (ETIs),
the health
indicators affect the
status of the
relevant CIs in BSM
applications such
as Service Health
and Service Level
Management
(regardless of
whether you have
an Event
Management
Foundation
license).
HP SiteScope (11.23)
How the Integration
Works
If SiteScope is
configured to report
events to HPOM,
SiteScope sends
data about SiteScope
metrics status
changes and alerts to
HPOM using the HP
Operations agent
technology.
Where to Get the Details
l
Integration with BSM and HPOM
Best Practices Guide in the
SiteScope Help
l
Integrating SiteScope with HP
Operations Manager Products in the
SiteScope Help (End-to-end flow)
Note: You can check the
HP Software Integrations site to see
if a more updated version of this
guide is available (for Windows:
http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=39;
for UNIX: http://support.openview.
hp.com/sc/solutions/integrations.jsp?
intid=628)
l
For information on the Operations
Management (OMi) licensing
structure, see Licensing in the BSM
User Guide in the BSM Help
Page 216 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
(4)
SiteScope
metrics ->
BSM metrics
and health
indicators.
What the
Integration Gives
You
How the Integration
Works
If the SiteScope
SiteScope sends
metrics have health metrics to BSM over
indicators assigned HTTP/HTTPS.
to them, these
health indicators
affect the status of
the relevant CIs in
BSM applications
such as Service
Health, Service
Level Management,
and Service Health
Analyzer.
Where to Get the Details
l
Integration with BSM and HPOM
Best Practices Guide in the
SiteScope Help
l
"How to Configure SiteScope to
Communicate with BSM" on page
236
If the SiteScope
metrics have health
indicators assigned
to them, these
health indicators
affect the status of
the relevant CIs in
BSM applications
such as Service
Health and Service
Level Management.
SiteScope metrics
are also used in
Service Health
Analyzer.
HP SiteScope (11.23)
Page 217 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
(5)
SiteScope
metrics ->
Performance
Graphing
(BSM).
What the
Integration Gives
You
SiteScope collects
metrics data, and
logs it to the data
source. The data
source depends on
which integrations
are enabled.
l
If only the BSM
integration is
enabled, data is
logged to the
Profile
database.
l
If both BSM and
HP Operations
Manager metrics
integration are
enabled,
SiteScope logs
the data to the
HP Operations
agent data store
installed on the
SiteScope host.
When a user draws
or designs a graph
in Performance
Graphing in
Operations
Management,
Performance
Graphing collects
metrics data from
the data source for
the selected CI,
which is monitored
by SiteScope, and
draws the graph.
HP SiteScope (11.23)
How the Integration
Works
Where to Get the Details
Data source used:
l
Integration with BSM and HPOM
Best Practices Guide in the
SiteScope Help
l
Integrating SiteScope with HP
Operations Manager Products in the
SiteScope Help (End-to-end flow)
l
l
Profile database:
SiteScope reports
metrics data to the
profile database
in BSM. To use
this data source,
SiteScope must
be connected to a
BSM server and
reporting monitor
metrics to BSM
should be
enabled.
HP Operations
agent: SiteScope
uses the HP
Operations agent
to make its metrics
data available to
Performance
Graphing. To
enable SiteScope
to report metrics,
the agent must be
installed on the
SiteScope server,
and metrics
reporting must be
enabled for each
monitor instance
you want to report.
Note: You can check the
HP Software Integrations site to see
if a more updated version of this
guide is available (for Windows:
http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=39;
for UNIX: http://support.openview.
hp.com/sc/solutions/integrations.jsp?
intid=628)
Page 218 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
What the
Integration Gives
You
(6)
SiteScope
metrics ->
Performance
Manager
graphs
(HPOM).
SiteScope collects
metrics data, and
logs it to the
Operations agent
data store, which is
installed on the
SiteScope host.
When a user in
Performance
Manager draws or
designs a graph,
Performance
Manager collects
metrics data from
the Operations
agent data store for
the selected node
in Performance
Manager that is
monitored by
SiteScope, and
draws the graph.
HP SiteScope (11.23)
How the Integration
Works
SiteScope uses the
HP Operations agent
to make its metrics
data available to
Operations Manager
(Performance
Manager). To enable
SiteScope to report
metrics, the HP
Operations agent
must be installed on
the SiteScope server.
Where to Get the Details
l
Integration with BSM and HPOM
Best Practices Guide in the
SiteScope Help
l
Integrating SiteScope with HP
Operations Manager Products in the
SiteScope Help (End-to-end flow)
Note: You can check the
HP Software Integrations site to see
if a more updated version of this
guide is available (for Windows:
http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=39;
for UNIX: http://support.openview.
hp.com/sc/solutions/integrations.jsp?
intid=628)
Page 219 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integrating with Other HP Products
HP SiteScope (11.23)
Page 220 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
What the
Integration
Gives You
How the Integration
Works
Where to Get the Details
(7) SiteScope
metrics -> HP
Diagnostics
data.
SiteScope
forwards metrics
to HP
Diagnostics,
displaying a
more complete
view of the
performance of
the application
server that is
monitored by
Diagnostics. The
metrics can
provide insight
into the
infrastructure
components
onto which the
application
servers are
deployed.
SiteScope forwards
metrics to HP
Diagnostics using
Diagnostics Integration
Preferences.
Integrating SiteScope with
HP Diagnostics in the SiteScope Help
(End-to-end flow)
(8) SiteScope
events ->
NNMi.
The SiteScopeNNMi event
integration
enables
SiteScope to
forward events
from SiteScope
monitors (events
generated from
alerts), and
displays the
event data in the
NNMi incident
console.
(SiteScope
11.10 and NNMi
9.10 or later are
required)
SiteScope sends SNMP
traps to NNMi. The
SNMP traps are
converted to NNMi
incidents. From the
resulting incidents, an
NNMi console user can
launch SiteScope in the
context of that monitor
(using the URL in the
SNMP trap sent to the
NNMi server).
l
HP SiteScope (11.23)
Note: You can check the HP Software
Integrations site to see if a more
updated version of this guide is
available
(http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=665)
Integrating SiteScope with HP NNMi
in the SiteScope Help (End-to-end
flow)
Note: You can check the
HP Software Integrations site to see
if a more updated version of this
guide is available
(http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=483)
l
You can view a guided and narrated
demonstration for the SiteScopeNNMi integration on the HP Videos
channel on YouTube:
http://www.youtube.com/
watch?v=jwnzpjK0c1A&feature=plcp
Page 221 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
(9) SiteScope
metrics ->
NNMi.
(10) Run
SiteScoperelated
actions in
Operations
Orchestration
(OO).
What the
Integration
Gives You
How the Integration
Works
Where to Get the Details
The SiteScopeNNMi metrics
integration
enables
SiteScope to
forward metrics
data from
SiteScope
monitors
(metrics status
changes and
alerts) to NNMi.
(SiteScope
11.10 and NNMi
9.10 or later are
required)
The HP NNMi-HP
SiteScope System
Metrics integration
populates the NNM iSPI
Performance for Metrics
Network Performance
Server (NPS) with
system metrics data
collected by SiteScope
monitors using the
Generic Data
Integration.
l
The HP
Operations
Orchestration
(OO) SiteScope
integration
enables
administrators to
build OO flows
that are
integrated with
HP SiteScope.
The administrator builds
OO flows using
SiteScope operations
(which use SiteScope
API calls) in OO Studio.
For example, you can
create flows that
automatically create
monitors in SiteScope
when a new server is
added, or delete
monitors when the
server is
decommissioned.
HP Operations Orchestration SiteScope Integration Guide in the OO
documentation
HP SiteScope (11.23)
Integrating SiteScope with HP NNMi
in the SiteScope Help (End-to-end
flow)
Note: You can check the
HP Software Integrations site to see
if a more updated version of this
guide is available
(http://support.openview.hp.com/sc/
solutions/integrations.jsp?intid=483)
l
You can view a guided and narrated
demonstration for the SiteScopeNNMi integration on the HP Videos
channel on YouTube:
http://www.youtube.com/
watch?v=jwnzpjK0c1A&feature=plcp
Page 222 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
What the
Integration
Gives You
How the Integration
Works
Where to Get the Details
(11)
SiteScope
metrics and
configuration
-> ALM/PAL.
SiteScope
integrates with
Application
Lifecycle
Management
(ALM)
/Performance
Application
Lifecycle (PAL)
to share
monitoring data
and templates
from the
production
environment to
enable load
testing
engineers to
plan
performance
tests and
application
deployment.
You can export
SiteScope related data
(metrics, templates, and
topology) from BSM to
ALM and vice versa.
Exporting data to ALM
enables you to plan
scripts and load tests
that resemble your
production environment,
and importing data from
ALM enables you to use
scripts and SiteScope
configurations that have
already been tested.
You perform this from
the Application Lifecycle
Management Integration
page in BSM.
l
"Integrating with HP Application
Lifecycle Management" on page 259
l
Application Lifecycle Management
Integration Page in the BSM
Application Administration Guide in
the BSM Help
(12)
SiteScope
metrics ->
LoadRunner
/Performance
Center.
Performance
metrics collected
by SiteScope
can be utilized
by load testing
analysis
products and
solutions, for
example, by HP
LoadRunner
and HP
Performance
Center.
To integrate SiteScope
with LoadRunner or
Performance Center, the
HP SiteScope for Load
Testing setup must be
installed. The
integration should be
configured in the
respective load testing
product.
l
"Integrating with HP Load Testing
Products" on page 257
l
HP LoadRunner Controller User's
Guide / HP Performance Center
Administrator Guide (available from
the HP Software Product Manuals
site)
http://h20230.www2.
hp.com/selfsolve/manuals)
HP SiteScope (11.23)
Page 223 of 1293
Using SiteScope
Chapter 19: Integrating with Other Applications
Integration
(13)
SiteScope
events ->
CDA
(Continuous
Delivery
Automation).
What the
Integration
Gives You
HP Continuous
Delivery
Automation
(CDA) integrates
with SiteScope
to deploy
SiteScope
monitors and
receive events
from them.
Monitoring
status based on
the events
received is
available in the
CDA user
interface.
HP SiteScope (11.23)
How the Integration
Works
SiteScope forwards
events to CDA using an
out-of-the-box template
that is specially
configured for CDA. The
template is available
from Preferences >
Common Event
Mappings.
Where to Get the Details
l
"How to Configure SiteScope
Generic Event Integration" on page
687
l
HP Continuous Delivery Automation
documentation
Page 224 of 1293
Chapter 20: Connecting to a BSM Server
SiteScope can be used as a data collector for Business Service Management (BSM). BSM uses
data about end-users, business processes, and systems. When configured as a data collector for
BSM, the metrics and topology data collected by SiteScope monitors can be passed on to BSM for
analysis and for use in reports. Monitor data can be sent for all monitors or for selected monitors
only.
The following diagram illustrates the use of SiteScope as a data collector for BSM:
Note: The BSM integration should not be confused with the integration using the HP
Operations agent, which is required for displaying metrics data in Performance Graphing (in
BSM's Operation Management) or in Performance Manager (a reporting component of HPOM).
For details on collecting metrics using the HP Operations agent, see Integrating SiteScope
with HP Operations Manager Products in the SiteScope Help. You can check the HP Software
Integrations site to see if a more updated version of this guide is available (for Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39; for UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
BSM includes a System Availability Management (SAM) Administration page, that enables you to
manage SiteScope monitor configurations for one or more SiteScope servers through a central
console. After activating the BSM integration, SiteScope data flows to BSM regardless of whether
you manage SiteScopes through SAM Administration or the SiteScope standalone user interface.
For the BSM versions supported in this release, refer to the SiteScope Support Matrices section in
the SiteScope Deployment Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_
Documentation.htm).
HP SiteScope (11.23)
Page 225 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Tip: For best practices and troubleshooting for reporting metrics data to BSM and HPOM, see
Integration with BSM and HPOM Best Practices Overview.
Troubleshooting/Limitations
This section includes:
l
"Reporting Data to BSM" below
l
"Disabling the Data Reduction Mechanism to Troubleshoot Data Flow Problems" on the next
page
l
"SiteScope Reports the IP Address Instead of the Hostname Configured in the Monitor" on the
next page
l
"Additional Troubleshooting" on the next page
Reporting Data to BSM
l
SiteScope reports numeric metric values only to BSM. It does not report metrics containing
string values.
l
Due to the complexity of some monitoring deployments and network communications,
SiteScope may be temporarily unable to communicate with the BSM server. SiteScope Health
monitoring includes several monitors for watching connectivity and data transfers to the BSM
server.
If SiteScope is unable to connect to the BSM Server, SiteScope continues to record and store
monitor data files locally. After the number of data files exceeds a specified threshold,
SiteScope saves the data files in a cache folder with the syntax <SiteScope root
directory>\cache\persistent\topaz\data<index>.old. It also saves the heartbeat samples to
bus_<index>.old and configuration samples to config_<index>.old. You can configure the
number of data.old folders to keep by modifying the _topazMaxOldDirs property in the
<SiteScope root directory>\groups\master.config file.
Note: By default, the threshold number of data files is set to 1,000 files. You can change
this setting by modifying the _topazMaxPersistenceDirSize property in the master.config
file.
After the connection between SiteScope and the Agent Server is restored, you must
manually copy the files from these folders to the <SiteScope
root directory>\cache\persistent\topaz\data folder.
We recommend that you only copy these files when the data folder is empty to avoid
overloading the system with large amounts of data to upload. When the number of data.old
folders exceeds a specified threshold, by default 10 folders, the oldest folders are deleted.
HP SiteScope (11.23)
Page 226 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Disabling the Data Reduction Mechanism to Troubleshoot Data Flow
Problems
By default, SiteScope uses a data reduction mechanism which reduces the sample load from
SiteScope to BSM by up to 80%. This is done by sending special samples only when there is some
change in the data reading rather than repeating the same sample each monitor run.
Note: The SiteScope Heartbeat sample (ss_heartbeat) indicates that SiteScope is functioning
properly and that its integration with BSM is healthy. The sample is only sent if SiteScope is in
data reduction mode (in which case the sample is sent every minute).
It is possible to disable this mechanism for troubleshooting data flow problems by setting the
property _topazEnforceUseDataReduction= to false in the <SiteScope root
directory>\groups\master.config file. However, it is not recommended to change this default
setting.
SiteScope Reports the IP Address Instead of the Hostname Configured in
the Monitor
When reverse DNS lookup is either not configured or is faulty for the monitored remote server,
SiteScope reports the IP address of the host to BSM instead of the hostname configured in the
monitor
Workaround: You can force the monitor to send the hostname instead of the IP address to BSM by
setting the _disableHostDNSResolution property to “=true” in the <SiteScope root
directory>\groups\master.config file.
Additional Troubleshooting
For additional troubleshooting issues related to SiteScope-BSM metrics integration, CI topology
reporting, and CI downtime,see Troubleshooting SiteScope Integration Issues in the Integration
with BSM and HPOM Best Practices Guide.
Configure the Connection
To enable the connection between SiteScope and BSM, the SiteScope must be configured as a
data collector for BSM. This involves adding a SiteScope to the SAM Administration page in the
BSM. For details on this task, see "How to Configure SiteScope to Communicate with BSM" on
page 236.
For information about troubleshooting reporting data to BSM, see "Troubleshooting/Limitations" on
the previous page.
Using a Secure Connection for SiteScope-BSM Communication
You can use a secure connection to transmit data from SiteScope to the BSM server. If you have
installed a certificate signed by a root Certificate Authority on the BSM server, no additional setup is
required on the SiteScope server.
If you are using a self-signed certificate on the BSM server and want to use that certificate for
secure communication with SiteScope, you must perform the steps as described in "Configure
SiteScope to connect to a BSM server that requires a client certificate or a secure connection
(recommended for enterprise security)" on page 238.
HP SiteScope (11.23)
Page 227 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Changing the Gateway Server to Which SiteScope Sends Data
You can change the Gateway Server to which a SiteScope reports its data. Generally, this is only
applicable if you are working with a BSM deployment with components installed on more than one
server (in the case of a distributed deployment where the BSM Gateway Server is installed on a
different machine from the Data Processing Server).
For details on making this change, see "Change the Gateway Server to which SiteScope sends
data - optional" on page 238.
Integrate SiteScope Data with BSM's Configuration
Items
When a monitor instance is added to a SiteScope reporting data to BSM, that monitor creates a
corresponding configuration item (CI) in Run-time Service Model (RTSM). For details on
understanding configuration items, see the introduction section in the RTSM Administration Guide
in the BSM Help.
The SiteScope monitors that populate RTSM include both actual monitors and the groups in which
they are created.
l
Actual monitors instances are represented in RTSM as monitor CIs. Monitor CIs receive data
from the corresponding SiteScope monitor instance and use the data, along with health
indicators (HIs) and event type indicators (ETIs) that are assigned to SiteScope monitor metrics,
to calculate key performance indicator status. These indicators provide a more detailed view of
the health of a CI. For details on understanding indicators, see "Health Indicators and KPIs Overview" in the BSM User Guide in the BSM Help.
l
SiteScope groups are represented as group CIs in RTSM and receive KPI status from the
monitor CIs created by the monitors they are running.
Monitor Types and Topology Reporting
SiteScope reports different levels of topology data to RTSM depending on the type of monitor and
the options selected for the monitor. SiteScope forwards the topology to create or update a CI under
the following conditions:
l
When the CI is created in SiteScope for the first time as a result of the monitor retrieving data,
regardless of whether the CI exists in RTSM.
l
If there were any changes to any of the CI's properties.
This prevents overloading RTSM with CI updates coming from the monitor.
When working with specific monitors, you do not select a topology and the topology is
preconfigured with the necessary data for the integration.
The types of monitors are as follows:
HP SiteScope (11.23)
Page 228 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
l
Technology Integration Monitors. These monitors report data based on the topology settings
script you select and edit for the monitor. The data they report is tightly integrated with BSM.
You can create a custom topology or use a predefined script to forward the relevant data. For
details on these monitors and how to work with their topology settings, see "Topology Settings
for Technology Integration Monitors" on page 400.
l
Monitors of Supported Environments. For these supported environments, SiteScope acts
like a discovery probe when the monitor is created or its configuration is changed. When
topology reporting is enabled, SiteScope automatically discovers the application's topologies
and populates RTSM with the relevant CIs and monitor CIs. For details and a list of supported
environments, see "Report Discovered Topologies to BSM" on page 233.
You can create a custom topology for monitors of a supported environment (except for monitors
where the CI type is per metric as described in "Monitors Reporting CI Per Metric" on page 255).
For details on creating a topology, see "How to Configure Topology Reporting" on page 242.
Monitors Not Reporting Topology Data By Default. SiteScope includes monitors that do not
report hosts or servers and, therefore, it is not possible to know the CI type that is being
monitored in advance. To include topology data for these monitors when reporting to BSM, you
must select the CI type, define CI type key attributes, and map metrics related to the monitor
type to specific indicators. SiteScope then creates a CI for the monitor in RTSM and forwards
monitor CI data to BSM. For the list of monitors that do not have a default topology defined, see
"Monitors Not Reporting Topology Data By Default" on page 254. For details on how to create a
topology for these monitors, see "How to Configure Topology Reporting" on page 242.
l
Creating Relationships Between Monitors and CIs
You can also create relationships between SiteScope monitor CIs and existing CIs in RTSM. This
relationship enables the monitor to pass HI status information to the CI to which it is attached, even
if that CI was not created from a topology forwarded by SiteScope.
You can create these relationships in SiteScope or in SAM Administration. For details, see task
step "Create relationships between SiteScope monitors and existing CIs in RTSM - optional" on
page 239.
Aging of CIs in RTSM
In RTSM, CIs that have had no activity over a period of time are removed from the database. The
CIs created from SiteScope data are also subject to this aging policy. To prevent the aging policy
from acting on CIs that SiteScope has sent to BSM, SiteScope synchronizes the data it sends to
BSM. The synchronization refreshes the data for those CIs and creates activity on the CIs.
For details on setting the time interval for topology synchronization, see Topology Settings in the
BSM Application Administration Guide in the BSM Help. For details on the aging mechanism, see
Working with CIs in the Modeling Guide in the BSM Help.
Note:
l
Synthetic monitors and groups created by the EMS integration monitors that use
Measurement field mapping are subject to the aging process regardless of the
HP SiteScope (11.23)
Page 229 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
synchronization.
l
To prevent CIs for EMS integration monitors being removed from RTSM when aging is
enabled, EMS topology is resent during a hard synchronization of SiteScope. In addition,
you can enable topology resending as part of an anti-aging process by adding the property _
reportEmsCIsAsPartOfAntiAging=true to the
<SiteScope root directory>\groups\master.config file.
l
If you delete a CI from RTSM you must perform a resynchronization or a hard
synchronization of SiteScope (in Integration Preferences), or you must wait for a restart of
SiteScope so the CI is restored to RTSM. This is due to the CI cache in SiteScope that
prevents SiteScope from sending an unchanged CI twice. For details, see the section on
BSM Integration Preferences.
Managing Indicator Assignments in System Availability Management
Note: This section is relevant only to those users connecting SiteScope with BSM 9.00 or
later.
SiteScope metrics that are mapped to indicators, are stored and managed in the Indicator
Assignments repository in SAM Administration. The repository provides the following benefits:
l
Centralized management of metric mappings in BSM, which makes it easier to manage large
numbers of SiteScope and monitors. The Indicator Assignments repository is available for
editing in the Metrics and Indicators tab in SAM Administration.
l
Metrics are mapped from different SiteScope monitors to indicators, per monitor type. You can
create, edit, and delete indicator assignments for specific monitor types.
l
If new indicator assignments are added or existing assignments are modified in the Indicator
Assignments repository, these changes can be published to all SiteScopes that are connected
to BSM. This ensures that new monitor instances created in SiteScope have indicators
according to the latest centralized assignments. You can restore the default assignments
included in your current version of SiteScope by clicking the Reset to Default button in HP
Integration Settings > Indicator Settings section of the monitor properties.
Note: Where indicator assignments have been modified on a local SiteScope server
(mappings for monitor metrics were changed):
n
These assignments are not overridden by the centralized assignments when SiteScope
downloads the updated mappings.
n
If an assignment is deleted from the Indicator Assignments repository, the local
assignment is not automatically deleted and SiteScope keeps sending the old indicator
value to BSM. In this case, a different indicator assignment should be selected for the
monitor metric.
HP SiteScope (11.23)
Page 230 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
n
If an indicator is deleted from the Indicator repository, a different indicator assignment
should be selected for monitor metrics that used the mapping.
l
The central repository ensures compatibility with earlier versions of SiteScope by mapping
metrics from earlier SiteScopes to indicators.
l
When a hard synchronization is performed on SiteScope, all the indicator mappings are
downloaded from BSM.
For details on editing the centralized Indicator Assignments in SAM Administration, see "Indicator
Assignment Settings" in the BSM Application Administration Guide in the BSM Help.
Assigning SiteScope Metrics to Indicators
Note: This section is relevant only to those users connecting SiteScope with BSM 9.00 or
later.
When configuring monitor instances, you can also map a metric to an indicator. SiteScope monitor
metrics are mapped to indicators on a monitor type basis as follows:
l
Monitors of supported environments and monitors that have a defined topology have indicators
assigned to metrics by default. For details of these monitors, see "Monitor Types and Topology
Reporting" on page 228. For the list of default indicator assignments, see Indicator Mapping
Alignment in the BSM User Guide in the BSM Help.
l
For SiteScope monitors that do not have a defined topology, there are no default indicator
mappings, since these monitors can be linked to different CI types, and a single mapping cannot
be set. For these monitors, you can map metrics to the appropriate indicators for the CI type
linked to the monitor. For a list of monitors that do not have a defined topology, see "Monitors
Not Reporting Topology Data By Default" on page 254.
You can change the default metrics mappings in SiteScope. If indicator mappings are modified
locally in SiteScope, these mappings are not overridden by the centralized repository mappings
when SiteScope downloads the latest mappings from BSM. This enables you to:
l
Override indicators for a monitor instance or some metrics of a monitor.
l
Configure non-default indicators in templates. Note that the CI type for custom topology and
metric mappings is not configurable through variables in templates (they should be predefined in
a template).
l
Configure indicators for alerts. Since the CI type of a triggered alert is not always known when
configuring an alert for groups or for monitors reporting a CI per metric (see "Monitors Reporting
CI Per Metric" on page 255), you can manually enter the indicator and indicator state for an alert.
For details, see "HP Operations Manager Integration Settings" on page 1165.
For task details on mapping SiteScope metrics to indicators, see "Map Indicators to metrics" on
page 243.
HP SiteScope (11.23)
Page 231 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
For user interface details, see "Indicator Settings" on page 317.
When are Health Indicators Created?
l
Events in SiteScope are based on SiteScope monitor metric status changes and alerts being
triggered. Events are created after the first event arrives to the CI. For more details, see
Integrating SiteScope with HP Operations Manager Products. You can check the HP Software
Integrations site to see if a more updated version of this guide is available (for Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39; for UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
l
Metrics are created when the monitor topology is reported to RTSM. For more details, see
"Report Discovered Topologies to BSM" on the next page.
Discovery Scripts and the Package Manager
Note: This section applies to users integrating with Business Availability Center/BSM 8.00 or
later. When integrating topology data with earlier versions of BSM, SiteScope uses legacy
scripts which are stored on the SiteScope server.
The scripts that enable SiteScope to act as a discovery probe are stored on the BSM server in the
SiteScope package. When SiteScope is configured to discover an application's topology,
SiteScope downloads the appropriate script from the BSM server. It then uses the script to perform
the discovery while monitoring the application.
The SiteScope package includes scripts and other SiteScope-related RTSM resources, such as
views and enrichments. You can access this package in BSM in Admin > RTSM Administration
> Administration > Package Manager. The package is a factory package, meaning that the outof-the-box configurations for the package enable it to perform the discoveries in SiteScope. For
details on working with packages, see Package Administration in the Modeling Guide in the BSM
Help.
Note: Advanced users may want to modify the topology scripts within the package. Be warned
that the SiteScope package uses scripts from other packages which may be shared by
SiteScope and Data Flow Management. Any changes made to the scripts in the package can
also affect Data Flow Management.
Any changes made to the topology script that influence the way a topology is reported to BSM
can affect all the applications that use those topologies, including BSM applications and
Operations Management.
Topology Script Properties File
If you are working in a secure BSM installation that has a certificate, you may have to insert the
following line into the <SiteScope root directory>\discovery\discovery_agent.properties file:
appilog.agent.Probe.BasicAuth.Realm=authRealm.
Where authRealm is a variable for Basic Authentication Realm. If you want to find out what realm a
given URL belongs to, you can open the URL with a Web browser and see the first line in the popup
box.
HP SiteScope (11.23)
Page 232 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Note: When you modify the discovery_agent.properties, you must restart SiteScope to
enable your changes to take effect.
Topology Reporting Limitation
The number of characters in SiteScope group and monitor descriptions that can be reported to BSM
is limited to 600 characters. If a group or monitor description contain more than this number,
SiteScope truncates the description to the first 600 characters.
Report Discovered Topologies to BSM
SiteScope can act as a discovery probe and discover the hierarchy of the monitored entities of
selected environments. These hierarchies are represented by topologies that SiteScope reports to
BSM. The CIs within the topologies correspond to the hosts, servers, and applications that
SiteScope monitors, and are created in BSM's RTSM. Monitor and measurement CIs are also
created and SiteScope reports their status to BSM. The relationships between the CIs are defined
by the topology reported by SiteScope.
You enable this feature by selecting the Report monitor and related CI topology option under
the HP Integration Settings panel when creating or configuring a monitor instance. If this option is
cleared, the CIs that were created in RTSM are not automatically deleted. If there is no activity on
the CI, they are eventually removed from the database through aging or they must be manually
deleted.
For details on the Topology Settings user interface, see Topology Settings in the BSM Application
Administration Guide in the BSM Help.
For troubleshooting problems involving topology reporting, see Business Service Management
Topology Issues in the Integration with BSM and HPOM Best Practices Guide.
Supported Environments
This direct connection between SiteScope and BSM is available for selected environments only
and with specific versions of BSM. SiteScope reports specific topologies for the following monitors
(documentation for these monitors is available from the SiteScope Monitor Reference Guide in the
SiteScope Help):
HP SiteScope (11.23)
Page 233 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Environment/
Monitor Type
Monitors
Reporting
Node
Topology
Monitors
This includes all monitors that report the status of a host or server (other than
Technology Integration monitors and the supported environments listed below)
that can forward topology data to BSM using a predefined CI type such as
Node, Computer, or some other child CI type derivative. When topology
reporting is enabled, SiteScope forwards the topology along with monitor CI
data to BSM. For details on this option, see "HP Integration Settings" on page
311.
Note: This does not include monitors that do not monitor the status of a host or
server, since it is not possible to know the CI type that is being monitored in
advance. For the list of monitors without host data, see "Monitors Not
Reporting Topology Data By Default" on page 254.
Database
(Available when integrating with Business Availability Center version 8.00 or
Environments later.)
Big Data
Environments
ERP/CRM
Application
Environments
l
Database Counter Monitor
l
Database Query Monitor
l
DB2 JDBC Monitor
l
Microsoft SQL Server Monitor
l
Oracle Database Monitor
l
Hadoop Monitor
l
HP Vertica JDBC Monitor
l
SAP CCMS Monitor
l
SAP Work Processes Monitor
l
Siebel Application Server Monitor
l
Siebel Web Server Monitor
Server
(Available when integrating with BSM 9.0 or later.)
Environments
Dynamic Disk Space Monitor
SOA
Web Service Monitor
Environments
HP SiteScope (11.23)
Page 234 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Environment/
Monitor Type
Monitors
Virtualization (Available when integrating with Business Availability Center/BSM 8.02 or
Environments later.)
Web server
Environments
l
Solaris Zones Monitor
l
VMware Datastore Monitor
l
VMware Host Monitors
l
VMware Performance Monitor
l
Microsoft IIS Server Monitor
l
WebLogic Application Server Monitor, using the JMX Monitor
l
WebSphere Application Server Monitor
CI Downtime
Note: This section is relevant only to those users connecting SiteScope with BSM 9.00 or
later.
Downtimes are defined and managed in BSM using the Downtime Management page in Platform
Administration. For details about configuring downtime, refer to Downtime Management in the BSM
Platform Administration Guide in the BSM Help.
SiteScope is affected by downtime if a SiteScope monitor or measurement CI is directly linked to a
CI that BSM detects is in downtime. SiteScope is also affected by downtime if a Business
Application CI, Business Service CI, Infrastructure Service CI, or a CI Collection linked to a
SiteScope Group CI is in downtime.
Monitors affected by a CI that is currently in downtime do not go into downtime immediately. The
time that it takes for the monitors to go into downtime is affected by two configuration parameters:
l
The interval between SiteScope queries to BSM for downtime requests (the default downtime
retrieval frequency value is 15 minutes). This can be modified in SiteScope in Preferences >
Infrastructure Preferences > General Settings > BSM downtime retrieval frequency
(minutes).
l
The interval between updating the SiteScope downtime cache in BSM (the default value is 5
minutes). This can be modified in BSM in Admin > Platform > Setup and Maintenance >
Infrastructure Settings. Select Applications > End User/System Availability Management.
In the Downtime table, locate SiteScope Downtime Cache Update Interval. Change the
value to the required cache update interval.
The action that is taken in SiteScope during the downtime depends on the downtime configuration
in BSM. Downtime can be enforced on the following:
HP SiteScope (11.23)
Page 235 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
l
Alerts. No alerts are sent for any of the CIs associated with the downtime.
l
Reports. Reports are not updated and display the downtime for the CI.
l
KPIs. KPIs attached to the CI are not updated and display the downtime for the CI in Service
Health.
l
Monitoring. SiteScope monitoring stops for any of the CIs associated with the downtime.
A monitor that is in downtime is indicated in the SiteScope Dashboard Summary column by
"disabled by <Downtime Name> from BSM". Details of downtimes that are associated with the
monitor and are currently taking place are displayed in the Monitor Downtime table in the
Enable/Disable Monitor panel. For details, see "Enable/Disable Monitor" on page 323.
If the monitor is affected by a CI that is currently in downtime and the downtime applies to
associated alerts of the monitor, downtime details are displayed in the Associated Alerts
Downtime table in the Enable/Disable Associated Alerts panel. For details, see "Enable/Disable
Associated Alerts" on page 325.
Notes and Limitations
l
When SiteScope queries BSM for downtime requests, it gets the downtimes for the downtime
period (up to a maximum of 24 hours). A record is written to <SiteScope root
directory>\logs\audit.log which includes new downtimes, changes to existing downtimes, and
deleted downtimes.
l
When SiteScopeis connected to BSM 9.00 or later, the downtime mechanism is enabled by
default. To change the default setting, clear the Enable downtime mechanism check box in
SiteScope's Preferences > Infrastructure Preferences > General Settings.
l
Downtime is not supported for SAP, Siebel, or SOA topologies (regardless of whether the
Application Management for Siebel/SAP license is installed).
l
For monitors that report the CI per metric, when a CI connected to a metric is in downtime, this
sends the monitor to which the metric belongs into downtime. This is applicable to the VMware
Performance Monitor and Solaris Zones Monitor.
l
Downtime information is not available in System Availability Management reports.
l
When SiteScope is connected to BSM 9.10, downtime on the SiteScope profile is upgraded to
downtime on the hosts and software elements that are monitored by the SiteScope profile
monitors and measurements.
l
For additional troubleshooting relating to CI downtime, see Business Service Management CI
Downtime Issues in the Integration with BSM and HPOM Best Practices Guide.
How to Configure SiteScope to Communicate with
BSM
This task describes how to configure SiteScope to be used as a data collector for BSM.
HP SiteScope (11.23)
Page 236 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
1.
Prerequisites
n
To integrate SiteScope with BSM, you must be a SiteScope administrator user. For details
on user permissions, see "User Management Preferences" on page 726.
n
Prepare a plan that maps out the specific IT infrastructure resources whose data you want
to collect. Include information about the business processes that are affected by the
specified infrastructure components. For example, business processes being monitored by
Business Process Monitor, that are running on an application server against which you plan
to run SiteScope monitors.
n
If smart card authentication is configured in BSM and you want to integrate SiteScope with
BSM, you must configure SiteScope smart card authentication to authenticate the BSM
client certificate. For details, see Smart Card Authentication in the SiteScope Deployment
Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_Documentation.htm).
Note: When connecting SiteScope with BSM 9.x, the HPOprInf, HPOprMss,
HPOprOra, and HPOprJEE content packs are required (they are installed by default, so
you generally do not need to do anything). If you do not have these content packs, you
need to import them as described in "How to Create and Manage Content Packs" in the
BSM Platform Administration Guide in the BSM Help.
2.
Download and install SiteScope
In BSM, navigate to Admin > Platform > Setup and Maintenance, and click Downloads.
Download and save the SiteScope installation files (for Windows or Solaris) to a local or
network drive.
Install SiteScope on machines designated to run the SiteScope data collector. You can run
multiple SiteScopes from multiple platforms. For more information, see the Installing
SiteScope section in the SiteScope Deployment Guide (<SiteScope root
directory>\sisdocs\doc_lib\Get_Documentation.htm).
3.
Connect the installed SiteScope with BSM
In BSM, navigate to Admin > System Availability Management, and add the SiteScope to
SAM Administration. For user interface details, see "New SiteScope Page" in the BSM
Application Administration Guide in the BSM Help.
n
To change logging options, edit a specific monitor and select the relevant option in the HP
Integration Settings panel of the monitor properties page. For details, see "HP Integration
Settings" on page 311. You can use the Global Search and Replace wizard to update the
logging options on those monitors created before the integration was established. For details
on the wizard, see "Global Search and Replace Wizard" in the BSM Application
Administration Guide in the BSM Help.
n
Monitors created in SiteScope before registration to BSM have their logging option set to
Disable reporting to BSM. After you configure SiteScope as a data collector reporting to
HP SiteScope (11.23)
Page 237 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
BSM, the default for new monitors created in SiteScope is to log their monitoring data to
BSM.
Note:
4.
o
If you are working with a SiteScope that is not accessible to BSM (for example in
HP Software-as-a-Service), the procedure for the connection includes creating an
empty profile in SAM Administration and creating an Integration Preference for BSM
in SiteScope. For task details, see "How to Configure SiteScope-BSM Integration
Preferences for Inaccessible Profiles" on page 664.
o
When working under high load, suspend all monitors before connecting to BSM for
the first time.
Configure SiteScope to connect to a BSM server that requires a client
certificate or a secure connection (recommended for enterprise
security)
If the BSM server requires a secure connection, you must perform the appropriate step below:
5.
n
For a BSM server that requires a secure connection, see "How to Connect SiteScope to a
BSM Server That Requires a Secure Connection" on page 241.
n
For a BSM server that requires a client certificate, see Configuring SiteScope to Connect to
a BSM Server That Requires a Client Certificate in the SiteScope Deployment Guide
(<SiteScope root directory>\sisdocs\doc_lib\Get_Documentation.htm).
Change the Gateway Server to which SiteScope sends data - optional
You can change the Gateway Server to which a SiteScope reports its data. Generally, this is
only applicable if you are working with a BSM deployment with components installed on more
than one server.
n
In SiteScope's BSM Integration Preferences, enter the required Gateway Server name or IP
address in the Business Service Management machine name/IP address box. For user
interface details, see "BSM Integration Preferences" on page 662.
n
In SAM Administration, update the SiteScope settings with the Gateway Server name in
Distributed Settings. For user interface details, see "New/Edit SiteScope Page" in the
BSM Application Administration Guide in the BSM Help.
Note: This can only be used for changing the Gateway Server for a SiteScope that is
already registered with a given BSM installation. It cannot be used to add a new
SiteScope, or to connect a SiteScope to a different BSM system.
6.
Create a monitoring structure in SiteScope
HP SiteScope (11.23)
Page 238 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
a. Create groups and subgroups to organize the monitors to be deployed, and then create
monitors in these groups. When configuring monitors, verify that BSM data logging and
topology settings are set as required.
For details on creating a monitoring structure, see "Create a Basic Monitoring Structure" on
page 77.
b. Configure SiteScope to send metrics, events, and topology data to BSM.
In addition, SiteScope can also store metrics data to the HP Operations agent data store
which is installed on the SiteScope host, or in the profile database in BSM (when graphing
metrics data for use in Performance Graphing in Operations Management).
Tip: The profile database in BSM is the recommended option, since it is a more robust
and scalable data source, and does not require configuration of the HP Operations
Integration.
7.
o
Metrics and Topology (using the classic SiteScope-BSM Integration). For details, see
"HP Integration Settings" on page 311.
o
Events and Metrics (using the HP Operations agent/Profile DB in BSM). For details,
see Integrating SiteScope with HP Operations Manager Products in the SiteScope
Help. You can check the HP Software Integrations site to see if a more updated version
of this guide is available(for Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39;
for UNIX: http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
Create relationships between SiteScope monitors and existing CIs in
RTSM - optional
You can create relationships to enable a monitor to pass HI status information to the CI to
which it is attached (even if that CI was not created from a topology forwarded by SiteScope):
n
In SiteScope, you can customize the relationship between SiteScope monitor CIs and
existing CIs in HP Integration Settings by manually selecting the CI type option when
editing a monitor instance. The CI type is defined by default for monitors of supported
environments and monitors that have a defined topology. For task details, see "Select the
CI type" on page 242.
n
In SAM Administration, by using the Monitor Deployment Wizard which uses the existing
CI property data in RTSM to deploy SiteScope monitors, groups, and remote servers. This
creates in RTSM a monitored by relationship between the monitored CI and the created
monitor. For concept details, see "Monitor Deployment Wizard" in the BSM Application
Administration Guide in the BSM Help.
Once defined, the SiteScope and its groups and monitors are added as CIs to RTSM and are
automatically attached to the relevant monitor views, from where they can be added to other
HP SiteScope (11.23)
Page 239 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
views. When editing a monitor in SAM Administration, you can associate the monitor with
existing CIs using HP Integration Settings. For example, you can attach the CPU monitor to
an existing logical CI representing a machine whose CPU is being monitored.
The data from the SiteScope is available in Service Health and Service Level Management.
8.
Map SiteScope metrics to indicators - optional
In SiteScope, you can add mappings for monitors that do not have default indicator metric
mappings, or modify settings for existing mappings (monitors of supported environments and
monitors that have indicators mapped to metrics by default).
For task details, see "Map Indicators to metrics" on page 243.
9.
Assign permissions in BSM
In BSM, navigate to Admin > Platform > Users and Permission, and click User
Management.
For each defined user, assign permissions to view SiteScope groups and their subgroups in
SAM reports and custom reports. For details, see the User Management Operations section in
the BSM Application Administration Guide in the BSM Help.
For details on how permissions are applied, see "Accessing SiteScope and Building
Permissions Model" in the BSM Application Administration Guide in the BSM Help.
10.
Modify the connection settings - optional
After you have created the connection, you can modify the settings either in SiteScope or in
BSM, depending on the setting that you are modifying.
n
In BSM, select Admin > System Availability Management. In the list of SiteScopes,
right-click the relevant SiteScope and select Edit SiteScope from the context menu. For
user interface details, see "New/Edit SiteScope Page" in the BSM Application
Administration Guide in the BSM Help.
n
In SiteScope, open the Preferences context and select Integration Preferences. Edit the
BSM Integration Preference. For user interface details, see "BSM Integration Preferences"
on page 662.
Tip:
o
To secure the connection to BSM (since the BSM user name and password are not
used for authentication), it is recommended to configure either Basic Authentication
in SiteScope or use two-way SSL. If BSM is configured to use Basic Authentication,
the same user name and password entered in the Authentication user name and
Authentication password fields in SiteScope are used for reporting both data and
topology to BSM. If BSM is not configured to use Basic Authentication, the
credentials sent are ignored.
HP SiteScope (11.23)
Page 240 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
o
To enable data to be compressed before being sent from the SiteScope server to
BSM, set _topazCompressDataInGzip=true in the <SiteScope root
directory>\groups\master.config file. When enabled, SiteScope monitor (ss_
monitor_t) and SiteScope metric (ss_t) samples are compressed in gzip before
being sent to BSM (where it is decompressed). Data compression can be used only
when SiteScope is reporting to BAC/BSM 8.05 or later.
How to Configure SiteScope to Send Bulk Data to the
Run-Time Service Model
SiteScope results can be sent to BSM’s Run-time Service Model (RTSM) either zipped or
unzipped. The request includes a parameter that indicates to RTSM whether the results being sent
are in zipped or unzipped format.
To send SiteScope results in a zipped format:
1. Open the following file: <SiteScope root directory>\discovery\discovery_
agent.properties.
2. Locate the line beginning appilog.agent.probe.send.results.zipped. If the line does not
exist, add it to the file.
3. Change the value to =true.
4. Restart SiteScope. SiteScope results are zipped before being sent to RTSM.
How to Connect SiteScope to a BSM Server That
Requires a Secure Connection
This task describes the steps involved in enabling secure communication between SiteScope and
BSM when the BSM server requires a secure connection.
1. Prepare SiteScope to use a secure connection. For details, see the section on configuring
SiteScope to use a secure connection in the SiteScope Deployment Guide (<SiteScope root
directory>\sisdocs\doc_lib\Get_Documentation.htm).
2. Import the CA or BSM server certificate into SiteScope using Certificate Management in the
SiteScope user interface. For task details, see "How to Import Server Certificates Using
Certificate Management" on page 557.
Note: The machine name in the certificate must be a fully qualified domain name that is
exactly the same name (including case sensitive) as the one used in the New SiteScope
page in System Availability Management Administration.
HP SiteScope (11.23)
Page 241 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
3. In BSM, select Admin > System Availability Management Administration, and click the
New SiteScope button to add the SiteScope instance. In the New SiteScope page, make sure
the following settings are configured:
n
Distributed Settings: Check that the Gateway Server name/IP address contains the
correct server name and port (default 443).
n
Profile Settings: Select the BSM Front End Use HTTPS check box (in versions of BSM
earlier than 9.20, select the Web Server Use SSL check box).
How to Configure Topology Reporting
Note: Only advanced users with a thorough knowledge of CIs and indicators should attempt to
edit the indicator mappings or to add mappings to metrics.
This task describes how to configure topology settings for monitors. It also describes how to select
or modify the CI type and map metrics to indicators.
1.
2.
Prerequisites
n
If BSM requires a client certificate, you must configure the topology discovery agent in
SiteScope to report topology to the BSM server. For details, see Configuring the Topology
Discovery Agent in SiteScope When BSM Server Requires a Client Certificate in the
SiteScope Deployment Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_
Documentation.htm).
n
For SiteScope to forward the host topology along with monitor CI data to BSM, the Report
monitor and related CI topology option must be selected under the HP Integration
Settings panel in the monitor properties. By default, this option is selected for monitors of
supported environments and monitors that have a CI type defined by default. For user
interface details, see "BSM Integration Data and Topology Settings" on page 313.
Select the CI type
For monitors that report a topology by default (the default CI type associated with the monitor is
displayed in parenthesis in the CI type list), you can use the default selection, or override the
selection by modifying the CI type and entering key attributes.
For monitors that do not report a topology by default, select the CI type for the monitor in the
BSM Integration Data and Topology Settings section, and enter values for the CI type key
attributes. For the list of monitors that do not report a topology by default, see "Monitors Not
Reporting Topology Data By Default" on page 254.
Note: For monitors where the CI type is per metric (for the list of monitors, see "Monitors
Reporting CI Per Metric" on page 255), the CI type cannot be modified and CI key
attributes are not displayed.
HP SiteScope (11.23)
Page 242 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Tip: It is recommended to perform a resynchronization of SiteScope if BSM is restarted
within 10 minutes after making changes to a monitor's topology settings. To do so, select
Preferences > Integration Preferences > BSM Integration > BSM Preferences
Available Operations, and click Re-Synchronize.
For user interface details, see "BSM Integration Data and Topology Settings" on page 313.
3.
Map Indicators to metrics
When a CI type is selected, the table in the Indicator Settings section is filtered to show
indicator settings for the selected CI type. Monitors of supported environments and monitors
that have a defined topology have indicators mapped to metrics by default. You can add new
metric mappings or edit settings for existing mappings.
For monitors that do not have default indicator metric mappings, you can map metrics to the
appropriate indicators for the CI type linked to the monitor. For the list of default indicator
assignments, see Indicator Mapping Alignment in the BSM Application Administration Guide in
the BSM Help.
For concept details, see "Assigning SiteScope Metrics to Indicators" on page 231.
For user interface details, see "Indicator Settings" on page 317.
4.
Select a preference for influencing BSM Service Health when events
and metrics are reported to BSM - optional
Since SiteScope events and metrics can affect BSM's Service Health, select the preference
for influencing Service Health when both data types are reported. Select the preference in the
BSM Service Health Preferences section of HP Integration Settings. For user interface
details, see "BSM Service Health Preferences" on page 321.
This preference is relevant only when:
n
Both BSM and Operations Manager integrations are active.
n
The Operations Manager event integration is connected to the BSM server—not the HPOM
server.
n
The following settings are selected in the monitor's HP Integration Settings:
o
In the BSM Integration Data and Topology Settings section: Enable reporting monitor
status and metrics or Enable reporting monitor status and metrics with thresholds.
o
In the HP Operations Manager Integration Settings section: Send events.
Note:
HP SiteScope (11.23)
Page 243 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
5.
o
The preference can also be set globally for each newly-created monitor in
Integration Preferences > HP Operations Manager Integration > HP
Operations Manager Integration Main Settings. For user interface details, see
"HP Operations Manager Integration Main Settings" on page 674.
o
For more information on choosing which preference to use, see Integrating
SiteScope with Business Service Management Applications.
Results
After configuring the topology settings click Save. SiteScope creates a CI for the monitor in
RTSM and forwards monitor CI data to BSM.
How to Configure Topology Reporting for a Custom
Monitor
This task describes how to configure topology settings, select or modify the CI type, and map
metrics to indicators for a custom monitor type.
1.
Prerequisites
If BSM requires a client certificate, you must configure the topology discovery agent in
SiteScope to report topology to the BSM server. For details, see Configuring the Topology
Discovery Agent in SiteScope When BSM Server Requires a Client Certificate in the
SiteScope Deployment Guide (<SiteScope root directory>\sisdocs\doc_lib\Get_
Documentation.htm).
2.
Select the CI type
In the BSM Integration Data and Topology Settings section of HP Integration Settings,
configure the topology reporting settings that define how SiteScope reports CIs to BSM.
You can report the following types of CI topology data:
n
User-defined CI type topology. In the CI type list, select a CI type and define the key
attribute values for the selected CI type. For details on key attribute values, see "<CI type
key attributes>" on page 317.
n
Custom topology script. Select the Custom topology setting option, and create the
topology script which defines how to report CIs to BSM. Only select this option if you are
familiar with the Jython language, because you must create the topology script in Jython
yourself. For task details, see "How to Configure Custom Topology for a Custom Monitor"
on page 247.
n
If you do not want to report topology for the monitor, you can choose to report the monitor CI
only. In the CI type list, select Default(None). This is the default setting.
HP SiteScope (11.23)
Page 244 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Note: If you do not want to report topology for a custom monitor, but you want to map
its metrics to CIs with a custom CI hint and map metrics to indicators in the user
interface, you must perform the following:
i. Select the Custom topology setting option.
ii. In the Data Processing Script box, enter the following (empty) script:
from
from
from
from
java.lang import *
java.util import *
appilog.common.system.types.vectors import ObjectStateHolderVector
appilog.common.system.types import ObjectStateHolder
def DiscoveryMain(Framework):
OSHVResult = ObjectStateHolderVector()
return OSHVResult
For user interface details, see "BSM Integration Data and Topology Settings" on page 313.
HP SiteScope (11.23)
Page 245 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
3.
Map Indicators to metrics
Map indicators to metrics for the selected CI type.
n
When a CI type is selected, the table in the Indicator Settings section is filtered to show
indicator settings for the selected CI type. You can add new metric mappings or edit
settings for existing mappings.
n
When Custom topology setting is selected, configure the indicator mappings using the
HIs you used in your HI assignment (see "Define an HI Assignment" on the next page).
Unlike for regular monitors, the CI Type can be edited in Indicator Settings when creating a
custom topology script for a custom monitor. When adding an indicator setting, select the CI
type from the CI Type list, and SiteScope displays the appropriate indicators for the CI type.
Note: Do not define more than one indicator mapping with different CI types that match
the same metric.
When CI type Default(None) is selected, indicator mappings are not available.
n
For concept details, see "Assigning SiteScope Metrics to Indicators" on page 231.
For user interface details, see "Indicator Settings" on page 317.
4.
Select a preference for influencing BSM Service Health when events
and metrics are reported to BSM - optional
Since SiteScope events and metrics can affect BSM's Service Health, select the preference
for influencing Service Health when both data types are reported. Select the preference in the
BSM Service Health Preferences section of HP Integration Settings. For user interface
details, see "BSM Service Health Preferences" on page 321.
This preference is relevant only when:
n
Both BSM and Operations Manager integrations are active.
n
The Operations Manager event integration is connected to the BSM server—not the HPOM
server.
n
The following settings are selected in the monitor's HP Integration Settings:
o
In the BSM Integration Data and Topology Settings section: Enable reporting monitor
status and metrics or Enable reporting monitor status and metrics with thresholds.
o
In the HP Operations Manager Integration Settings section: Send events.
HP SiteScope (11.23)
Page 246 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Note:
5.
o
The preference can also be set globally for each newly-created monitor in
Integration Preferences > HP Operations Manager Integration > HP
Operations Manager Integration Main Settings. For user interface details, see
"HP Operations Manager Integration Main Settings" on page 674.
o
For more information on choosing the preference to use, see Integrating SiteScope
with BSM in the Integration with BSM and HPOM Best Practices Guide.
Results
After configuring the topology settings click Save. SiteScope creates the topology according to
your definition, and forwards monitor data to BSM.
How to Configure Custom Topology for a Custom
Monitor
This task describes the steps involved in creating a custom monitor with a custom topology script.
1.
Change the CI Resolver TQL (only if SiteScope is connected to a
version of BSM earlier than 9.20)
a. In BSM, select Admin > Platform > Infrastructure Settings.
o
Select Applications.
o
Select End User/System Availability Management.
o
In the End User/System Availability Management - SiteScope CI Resolver
Settings, check if the value of the TQL Queries parameter is CIs Monitored by
SiteScope. If it is, change it to OMiAutoView.
b. Restart BSM to apply the change.
Note: This TQL does not support models with a large number of CIs (it may cause
performance problems in such models).
2.
Define an HI Assignment
You need to define an HI assignment that will assign the HI to a CI. The assignment also
defines which data samples will be captured by this HI and which business rule will be used to
calculate the status of the HI according to the data samples.
For more information on HI assignments in Service Health, see "Health Indicator Assignments
Page" in the BSM Application Administration Guide in the BSM Help. For more information on
HP SiteScope (11.23)
Page 247 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
HI assignments in SLM, see "Health Indicator Assignments Page" in the BSM Application
Administration Guide in the BSM Help.
To define an HI assignment:
a. In BSM, select Admin > Service Health / Service Level Management > Assignments
> Health Indicator Assignments.
b. From the CI type hierarchy in the left pane, select the CI type which you are going to report
from your topology script. The assigned indicators for the CI type are displayed in the
Indicators pane. When you select an indicator, its details are displayed in the right pane.
c. Create a new HI assignment. For details on how to create the assignment, see "How to
Define a KPI or HI Assignment" in the BSM Application Administration Guide in the BSM
Help.
o
In the Monitored By property in the Condition area, enter a value that enables you to
distinguish between the CIs reported by this monitor and CIs of the same type which are
reported by other monitors. The condition of the assignment should correspond with the
CIs you report in the topology script (see "Create the custom topology script" on page
252).
Tip: It is recommended that the CI has the value "SiteScope" in the Monitored By
property, and that it has a unique value to enable you to differentiate between this
CI and CIs of the same type reported by other monitors. For this purpose, we
recommend using the Note property of the CI.
o
When you create the topology script for the monitor, enter the monitored_by attribute
with this value on the CI you report. For more details on topology scripts, see "Create
the custom topology script" on page 252.
o
Choose the business rule to use for the HI calculation. We recommend using the
SiteScope Worst Status Rule. You can also use the SiteScope Consecutive Worst
Status Rule or SiteScope Best Status Rule.
o
In the selector, enter the following:
o eti_id = (Binary) <<Health Indicator Type ID>>
o ci_id = (Binary) <<CI ID>>
o sampleType = (String) ss_t
The custom monitor sends metrics samples (ss_t) that contain the same eti_id as the HI
used in the assignment, and the same CI ID as the CI's.
HP SiteScope (11.23)
Page 248 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Example: Indicator assignment for CI Type Computer (in Service Health)
HP SiteScope (11.23)
Page 249 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Example: Indicator configuration and selector settings (in Service Health)
3.
Define the custom monitor
In SiteScope, create the custom monitor and add the required data for the monitor settings in
the Main Settings, Advanced Settings, and Timeout Settings sections. You can choose from
the following custom monitors: Custom Monitor, Custom Database Monitor, Custom Log File
Monitor, Custom WMI Monitor.
For details on configuring these monitors, see the SiteScope Monitor Reference Guide.
HP SiteScope (11.23)
Page 250 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
Example: Settings for a Custom Log File monitor
The complete strings used in the example are:
Content match: /([a-z])=([0-9]+),*([a-z])*=*([0-9]+)*,*([a-z])*=*([0-9]+)*,*([a-z])*=*([0-9]+)
*,*([a-z])*=*([0-9]+)*/
Match value labels: disk1,val1,disk2,val2,disk3,val3,disk4,val4,disk5,val5
4.
Create the data processing script
In the Data Processing Script section of the Custom Monitor Settings panel, enter the script for
processing the collected data.
HP SiteScope (11.23)
Page 251 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
In the script, supply the CI resolution hint for the different metrics by using setCIHint method.
For an explanation on the format to use for the hint, see "CI Resolution Hint Formats" on page
398.
Note: An example data processing script is available in a text file attached to this PDF. To
view the attachment, select View > Navigation Panels > Attachments, and select
Custom_Monitor_Data_Processing_Script.txt.
When working in template mode with a template containing a custom monitor with the
example data processing script, you also need to define a variable SERVER_NAME.
When deploying the template, you need to enter a value for the server name.
5.
Create the custom topology script
In the HP Integration Settings panel, create the topology script that defines how to report CIs to
BSM.
a. In the BSM Integration Data and Topology Settings section, select the Custom topology
script option and develop a custom topology script that reports the CIs defined in the HI
assignment.
For the monitored_by attribute of the CI, you must enter SiteScope. This is the same
value you used in the HI assignment in "Define an HI Assignment" on page 247.
Note: An example custom topology script is available in a text file attached to this
PDF. To view the attachment, select View > Navigation Panels > Attachments,
and select Custom_Monitor_Topology_Script.txt.
In the example, you need to replace <IP Address>, <name>, and <Server DNS name>
with the relevant values.
Tip: It is recommended to perform a resynchronization of SiteScope if BSM is
restarted within 10 minutes after making changes to a monitor's topology settings. To
do so, select Preferences > Integration Preferences > BSM Integration > BSM
Preferences Available Operations, and click Re-Synchronize.
b. In the Indicator Settings section, configure the HI mappings using the HIs you used in the
HI assignment in "Define an HI Assignment" on page 247.
Note: Do not define more than one indicator mapping with different CI types that
match the same metric. For details on defining indicator mappings in SiteScope, see
"Map Indicators to metrics" on page 243. Alternatively, you can define the mappings in
BSM in Admin > System Availability Management > Metrics and Indicators and
HP SiteScope (11.23)
Page 252 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
click Publish Changes. The mappings are then downloaded to SiteScope and
displayed in the user interface. For details on defining mappings in BSM, see How to
Create and Manage Indicator Assignments in the BSM Application Administration
Guide in the BSM Help.
Example: Indicator Mappings for Computer CI Type
6.
View Results
After you have configured the HI assignments in BSM and the monitor settings including the
topology script in SiteScope, you can run the monitor. After the monitor run has finished,you
can view the results in BSM's Service Health.
We recommend creating a view that shows the reported CIs for this monitor. After you save
the monitor and the monitor has run, you can see the results in BSM's Service Health in the
view that you created.
Example: View Created for CIs Reported for this Monitor (in Service Health)
Example: Indicator Status Results on the Monitored Machine (in Service Health)
HP SiteScope (11.23)
Page 253 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
.
Monitors Not Reporting Topology Data By Default
Following is a list of monitors that do not monitor the status of a host or server.
Note: For these monitors to report CI information to BSM, you must select the CI type, enter
the required CI key attributes, and select an indicator relevant for the CI type linked to the
monitor. For task details, see "How to Configure Topology Reporting" on page 242.
l
Composite Monitor
l
Custom Log/Database/WMI Monitors
l
Directory Monitor
l
Dynamic JMX Monitor
l
e-Business Transaction Monitor
l
File Monitor
l
Formula Composite Monitor
l
HP NonStop Event Log Monitor
l
JMX Monitor (when not monitoring WebLogic)
l
Link Check Monitor
l
Log File Monitor
l
Microsoft Windows Dial-up Monitor
HP SiteScope (11.23)
Page 254 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
l
Multi Log Monitor
l
Script Monitor
l
SNMP Trap Monitor
l
Syslog Monitor
l
URL Monitor
l
URL Content Monitor
l
URL List Monitor
l
URL Sequence Monitor
l
XML Metrics Monitor
Monitors Reporting CI Per Metric
Following is a list of monitors that report CI per metric.
Because these monitors have multiple CIs, you cannot modify the CI for these monitors and you
can modify the indicator mappings for these monitor types from BSM only (in the SAM Admin >
Metrics and Indicators tab).
l
SAP CCMS Monitor
l
SAP Work Processes Monitor
l
Siebel Application Server Monitor
l
Siebel Web Server Monitor
l
Solaris Zones Monitor
l
VMware Host CPU Monitor
l
VMware Host Memory Monitor
l
VMware Host Network Monitor
l
VMware Host State Monitor
l
VMware Host Storage Monitor
l
VMware Performance Monitor
Note: You can define a custom topology Node for the monitor and specify a host name for it. If
there is a remote server in any SiteScope connected to this BSM, this CI is automatically
HP SiteScope (11.23)
Page 255 of 1293
Using SiteScope
Chapter 20: Connecting to a BSM Server
changed to Unix or Windows CI type, depending on the environment of the remote server.
HP SiteScope (11.23)
Page 256 of 1293
Chapter 21: Integrating with HP Load Testing
Products
Performance metrics collected by SiteScope can be utilized by load testing analysis products and
solutions, for example, by HP LoadRunner and HP Performance Center. When running a load
testing scenario, it is sometimes necessary to correlate the behavior of the application under test
with various software and hardware performance metrics available from the system where the
application is running.
Learn About
This section includes:
l
"Differences Between SiteScope and SiteScope for Load Testing" below
l
"Supported Versions" on the next page
Differences Between SiteScope and SiteScope for Load Testing
When using LoadRunner or Performance Center, you can choose a performance data collection
option through a native solution available in the products or through SiteScope. In a variety of
cases, SiteScope provides more monitoring options and deeper performance coverage of systems
and applications.
SiteScope for Load Testing is an installation option of SiteScope which is optimized for load testing
scenarios and provided for LoadRunner and Performance Center users. This installation type is not
meant to monitor production environments. As a result, some options which are available in a
regular SiteScope installation are not available in SiteScope for Load Testing.
The main differences between regular SiteScope and SiteScope for Load Testing are:
SiteScope for Load
Testing
SiteScope
Minimum run frequency for SiteScope
monitors
1 second*
15 seconds
Default run frequency (available when a
new monitor is created)
5 seconds*
10 minutes
SiteScope Reports
Not available
Available
Analytics
Not available
Available
Integration with BSM
Not supported
Supported
Description
*The Minimum run frequency for SiteScope for Load Testing monitors and the default run
frequency apply only for API executions.
HP SiteScope (11.23)
Page 257 of 1293
Using SiteScope
Chapter 21: Integrating with HP Load Testing Products
Note: The integration between SiteScope and LoadRunner or Performance Center should be
configured in the respective load testing product and not in SiteScope. For more information,
see "How to Set Up the Monitoring Environment - Workflow", "Configuring Monitors User
Interface", and "SiteScope Resource Monitoring" in the HP LoadRunner Controller User Guide,
and "Adding Hosts" in the HP Performance Center Administrator Guide.
Supported Versions
For the list of supported LoadRunner and Performance Center versions supported in this release,
refer to the SiteScope Support Matrices section in the SiteScope Deployment Guide (<SiteScope
root directory>\sisdocs\doc_lib\Get_Documentation.htm).
Tips/Troubleshooting
l
To enable SiteScope to integrate with LoadRunner, user authentication must be disabled in
SiteScope. For details, see "User Management Preferences" on page 726.
l
Integration between SiteScope for Load Testing and BSM is not supported.
HP SiteScope (11.23)
Page 258 of 1293
Chapter 22: Integrating with HP Application
Lifecycle Management
You can export SiteScope related data from BSM to Application Lifecycle Management (ALM) and
vice versa. Exporting data to ALM enables you to plan scripts and load tests that resemble your
production environment, and importing data from ALM enables you to use scripts and SiteScope
configurations that have already been tested.
To access
In BSM, select Admin > Integrations > Application Lifecycle Management Integration.
Learn About
This section also includes:
l
"Export Data from BSM (SiteScope) to ALM" below
l
"Import Data from ALM to BSM (SiteScope)" below
Export Data from BSM (SiteScope) to ALM
You can export SiteScope configuration data for a single application. The exported data includes
information about the SiteScope metrics, templates, and topology data. Sharing such information
between operations and development assists you in planning your scripts and load tests in ALM, so
that they better resemble your production environment.
Import Data from ALM to BSM (SiteScope)
You can import data from ALM that includes SiteScope configuration templates. Sharing such
information between development and operations enables you to use SiteScope configurations that
have already been tested and fine tuned. Imported SiteScope configuration templates are stored in
the SiteScope template tree for each SiteScope registered to BSM. A default directory called
AutoSyncContainer is created in the SiteScope root folder, and for each application for which a
template is imported, a sub-directory is created with the application name.
Tasks
How to export data from BSM to ALM
For details, see the Application Lifecycle Management Integration page in the BSM Application
Administration Guide in the BSM Help.
How to import data from ALM to BSM (SiteScope)
1. Prerequisites
n
The SiteScope Administrator user must be configured with a user name and password (it
cannot be left blank).
HP SiteScope (11.23)
Page 259 of 1293
Using SiteScope
Chapter 22: Integrating with HP Application Lifecycle Management
The passphrase string for all HP software applications integrated using LW-SSO must be
identical. Make sure that LW SSO Init String in SiteScope Preferences > General
Preferences > LW SSO Settings matches the string in BSM.
n
2. In Performance Center, design and create a performance test. For details, refer to the task on
how to design a performance test in the HP ALM Performance Center Guide.
3. Import the .zip file from ALM that includes the SiteScope configurations
a. In BSM, select Admin > Integrations > Application Lifecycle Management
Integration > Import from ALM.
b. In the Select File box, enter the path to the .zip file you want to import, or click Browse to
open a dialog box in which you can browse to the required .zip file.
For details on creating the .zip file for importing, refer to the ALM documentation.
c. Click Upload Content to upload the content of the selected .zip file. The upload status is
displayed.
Note:
n
If you previously imported data from ALM, the data is deleted and replaced with the
latest .zip file. To avoid losing changes made to previously imported templates, rename
the templates to avoid these changes being lost.
n
If you have already deployed monitors from synchronized templates and then import
another .zip package that does not contain the necessary templates, these monitors
will be unlinked from the templates that should be deleted.
For more details, see the Application Lifecycle Management Integration page in the BSM Help.
4. Edit and publish changes to templates in SiteScope - optional
Imported SiteScope configuration templates are copied to the following location within each
SiteScope registered to BSM:
Templates > SiteScope root folder > AutoSyncContainer > < application name>
You can make changes to the templates, and manually deploy the templates. For details on
deploying templates, see "Deploy Templates" on page 836.
Tip: It is recommended to rename any imported templates that you modify in order to
avoid these changes being overwritten the next time data is imported from ALM.
You can also publish changes to templates using the Publish Template Changes Wizard. For
details, see "Publish Changes to User-Defined Templates" on page 849.
HP SiteScope (11.23)
Page 260 of 1293
Part 4: Monitors and Groups
Group containers help you organize the monitor instances that you create. Monitor instances that
you create must be added within a SiteScope monitor group container. For details, see "Create
Groups in SiteScope" on page 262.
SiteScope monitors are tools for automatically connecting to and querying different kinds of
systems and applications used in enterprise business systems. The different monitor types provide
the generic capabilities for performing actions specific to different systems. You create one or more
instances of a monitor type to instruct SiteScope how to monitor specific elements in your IT
infrastructure. For details, see "Create Monitors in SiteScope" on page 269.
You can create custom monitors to broaden the capabilities of regular SiteScope monitors by
developing your own solutions for environments that are not supported by predefined SiteScope
monitors. For details, see "Create Custom Monitors" on page 333.
You can create baselines and schedule specific thresholds based on a time period or date.
Baselines enable you to understand how your applications typically perform and determine whether
a performance problem is an isolated incident or a sign of a significant downward performance
trend. For details, see "Set Monitor Thresholds Using a Baseline" on page 340.
You can also configure thresholds based on calculated metrics—a metric produced by performing
an arithmetic function or logical operation on existing SiteScope metrics. For details, see "Create
Calculated Metrics" on page 374.
SiteScope provides various dynamic monitors that automatically update themselves over time by
adding and removing counters as changes occur in your IT environment. For details, see "Dynamic
Monitoring Mechanism" on page 387.
SiteScope also includes the capability to monitor XML documents. For details, see "Monitor XML
Documents" on page 390.
Tip:
l
For details on monitor settings for a specific SiteScope monitor, including supported
versions and platforms, and a list of counters or metrics that can be configured for the
monitor, see the monitor type in the SiteScope Monitor Reference Guide.
l
You can also use the SiteScope API when working with monitors. For details, see
"SiteScope Public APIs" on page 178.
HP SiteScope (11.23)
Page 261 of 1293
Chapter 23: Create Groups in SiteScope
You create group containers to make the deployment of monitors and associated alerts manageable
and effective for your environment and organization. It is also useful to group monitors that should
generate similar alerts.
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope container or an existing
monitor group, and select New > Group.
Learn About
This section includes:
l
"SiteScope Groups Overview" below
l
"Copying or Moving Existing Groups" below
l
"Creating Group Alerts and Reports" on the next page
SiteScope Groups Overview
You create groups that reflect your environment, and for organizing your monitors in SiteScope. A
group is a collection of one or more monitors. It might contain several of one type of monitor, such
as URL monitors, or several different monitors that track a specific part of your Web environment,
such as a Web server, URL, and network parameters related to a specific transaction.
Each SiteScope monitor instance that you create must belong to a SiteScope group, either a top
level group or a subgroup nested within other group containers.
For example, if you intend to monitor a large number of processes running on your system, you may
want all of them to be in a single group named Processes. If you are monitoring processes on
several machines using remote monitors, you could create a primary group called Processes with
several subgroups named after each of the remote machines that you are monitoring.
When you add a new monitor you either add it to an existing group, or you must first create a group
for it. You can add groups individually to SiteScope, or you can deploy groups along with multiple
monitors by using templates. For details on templates, see "SiteScope Templates" on page 771.
You can perform mass operations on group objects using the Manage Groups and Monitors feature.
This enables you to perform move, copy, delete, run monitors in group, enable/disable monitors,
and enable/disable associated alert actions on multiple SiteScope objects. For details, see
"Perform Actions on Multiple Groups and Monitors" on page 101.
Note: You can also use the SiteScope API when working with groups. For details, see
"SiteScope Public APIs" on page 178.
Copying or Moving Existing Groups
In addition to creating groups, you can copy or move existing groups to a new location within the
HP SiteScope (11.23)
Page 262 of 1293
Using SiteScope
Chapter 23: Create Groups in SiteScope
SiteScope tree. Copying or moving a group duplicates the configuration settings for the group and
all monitors within the group. After copying or moving a group, you normally need to edit the group
and the configuration properties for each individual monitor within the group to direct the monitors to
a unique system or application. Otherwise, the monitors in the group duplicate the monitoring
actions of the original group.
Tip: Instead of copying groups which can lead to redundant monitoring, use templates to more
efficiently replicate common group and monitor configuration patterns. For more information
about working with templates, see "SiteScope Templates" on page 771.
Note:
l
To avoid group identity problems within SiteScope, object names must be unique within the
parent group. If you copy or move a group to another group in which there is group with
exactly the same name, SiteScope automatically adds a suffix (number) to the end of the
copied/moved group's name.
l
You cannot move or copy a monitor group to its subgroup.
Creating Group Alerts and Reports
After creating a group, you can create alerts and reports for the group. By default, group alerts and
reports are associated with all monitors within the group.
You create an alert by adding an alert definition to a group container. This means that when any one
monitor in the group reports the status category defined for the alert (for example, error or
warning), the group alert is triggered. You can configure a group alert to exclude one or more of the
monitors in the group by using the Alert targets selection tree. For details on this topic, see
"Configure SiteScope Alerts" on page 1140.
You create a group report by adding a report definition to a group container. You can configure a
group report to exclude one or more of the monitors in the group by using the Monitors and groups
to report on selection tree. For details on this topic, see "Reports" on page 1210.
If you delete a group, SiteScope removes the applicable monitor actions and disables any alert
actions associated with the group.
Tasks
How to Manage a Group
This task describes the steps involved in managing a group.
1.
Create SiteScope groups and subgroups
Create groups according to the monitor hierarchy which you want to implement. For example,
you can create groups of locations, server types, network resources, and so forth.
n
Create a new group. Right-click the SiteScope or group container in which to create the
group, and select New > Group. For user interface details, see the UI Descriptions section
HP SiteScope (11.23)
Page 263 of 1293
Using SiteScope
Chapter 23: Create Groups in SiteScope
below.
Create a group by copying or moving an existing group.
n
o
Right-click the group you want to copy, and click Copy. Right-click the location in the
monitor tree where you want to copy the group container, and click Paste.
o
Right-click the group you want to move, and click Cut. Right-click the location in the
monitor tree where you want to move the group container, and click Paste.
o
To copy or move multiple monitors and groups to a target group, click the Manage
Monitors and Groups
button in the monitor tree toolbar. Select the objects for
copying or moving and click Copy/Cut. Select the destination group and click Paste. For
details, see "Perform Actions on Multiple Groups and Monitors" on page 101.
2.
Add URL links to group descriptions - optional
You can add additional information to describe a group, and include HTML tags for hyperlinks
to enable you to access URLs from the SiteScope Dashboard.
a. To add a hyperlink, open the Properties tab for the selected group.
b. Expand the General Settings panel and enter the URL in the Group description field. For
example, <a href="http://www.hp.com">My Link</a>.
c. Click the Dashboard tab. A URL is displayed in the Description field for the selected
group. To open the URL, click the group's Description field, and then click the link.
Tip: To automatically adjust the row height to make all cell contents visible in the
Dashboard, select the Wrap text option in Dashboard Settings. For details, see
"Dashboard Settings Dialog Box" on page 1014.
3.
Create monitor instances
Select the monitor instances you want to add to the group.
For task details, see "How to Create and Deploy a Monitor" on page 277.
4.
Set group dependencies - optional
You can set group dependencies to make the running of monitors in this group dependent on
the status of another monitor.
For concept details, see "Monitoring Group Dependencies" on page 272.
Example: The monitors in the group being configured run normally as long as the monitor
selected in the Depends on box reports the condition selected in the Depends condition
HP SiteScope (11.23)
Page 264 of 1293
Using SiteScope
Chapter 23: Create Groups in SiteScope
box. In this example, the group being configured is enabled only when the Service monitor
reports a status of Good.
5.
Set up group alerts - optional
Create alerts to send notification of an event or change of status in some element or system in
your infrastructure.
To create an alert for the group, right-click the group and select New > Alert. For each alert
scheme, you can create one or more alert actions. In the New Alert dialog box, click New Alert
Action to start the Alert Action wizard.
For task details, see "How to Configure an Alert" on page 1144.
6.
Set up group reports - optional
Create reports to display information about how the servers and applications you are
monitoring have performed over time.
To create a report for the group, right-click the group and click Reports. Select a report type
and configure the report settings.
For task details, see "Create SiteScope Reports" on page 1211.
7.
Results
The monitor group, including its monitors, alerts, and reports, is added to the monitor tree.
UI Descriptions
New SiteScope Group Dialog Box
The New SiteScope Group dialog box enables you to define a new group for SiteScope, or a
subgroup for an existing monitor group.
HP SiteScope (11.23)
Page 265 of 1293
Using SiteScope
Chapter 23: Create Groups in SiteScope
Important
information
l
Only a SiteScope administrator user, or a user granted the appropriate
permissions can edit, refresh, or disable groups. For details on user
permissions, see "Permissions" on page 738.
l
You cannot delete a monitor group if it has dependent alerts or reports at the
container level. To delete a monitor group with dependencies, you must
remove the monitor group from Alert Targets and Report Targets for each
dependency, and then delete the monitor group. You can delete monitor groups
that have dependencies at the child level.
l
You can also use the SiteScope API when working with groups. For details,
see "SiteScope Public APIs" on page 178.
The following elements are found throughout the New SiteScope Group dialog box:
General Settings
UI Element
Description
Group
name
Name that describes the content of the group, or the purpose of the monitors
added to the group. For example, <host_name> or <business_unitresource_
name> or <resource_type>.
Note:
l
The group name cannot be sitescope or contain any of the following
characters: ` ; & | < > / \ + =
l
The group name is case sensitive. This means that you can have more than
one group with the same name provided they each have a different case
structure.
HP SiteScope (11.23)
Page 266 of 1293
Using SiteScope
Chapter 23: Create Groups in SiteScope
UI Element
Description
Group
Description of the group. This can include the most common HTML tags for text
description styling, such as <BR>, <HR>, and <B>, and hyperlinks. The description is
displayed only when viewing or editing the group's properties in the SiteScope
Dashboard. For details on adding a hyperlink, see "Add URL links to group
descriptions - optional" on page 264.
Note: This field does not support JavaScript/iframes/frames or other advanced
features. HTML code entered in this box is checked for validity and security, and
corrective action is taken to fix the code (for example, code is truncated if it spans
more than one line). If malicious HTML code or JavaScript is detected, the entire
field is rejected. The following is prohibited HTML content:
l
Tags: script, object, param, frame, iframe.
l
Any tag that contains an attribute starting with on is declined. For example,
onhover.
l
Any attribute with javascript as its value.
Source
template
Displays the path of the source template if the group was created from a template.
If you are using deployed templates created in older versions of SiteScope,
enables you to manually associate the root groups with the source template by
entering the path of the source template.
Clear
Removes the source template associated with the root group.
Dependencies
UI
Element
Depends
on
Description
The monitor on which you want to make the running of this monitor group dependent.
Click the Depends on
button to open the Select Depends On Monitor dialog
box, and select the monitor on which you want to create a dependency. For user
interface details, see "Select Depends On Monitor Dialog Box" on page 330.
For concept details, see "Monitoring Group Dependencies" on page 272.
Default: No dependency is set for a monitor group.
HP SiteScope (11.23)
Page 267 of 1293
Using SiteScope
Chapter 23: Create Groups in SiteScope
UI
Element
Description
Depends The Depends condition that the Depends on monitor should have for the current
condition monitor group to run normally. If the selected condition is not satisfied then the
monitor selected in the Depends on box is automatically disabled. The conditions
are:
l
Good
l
Error
l
Available
Search/Filter Tags
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element Description
<Tag
name
and
values>
Keyword tags are used to search and filter SiteScope objects (groups, monitors,
remote servers, templates, and preference profiles). If no tags have been created for
the SiteScope, this section appears but is empty. If tags have been created, they are
listed here and you can select them as required.
For concept details, see "Search SiteScope Objects" on page 88.
Add
Tag
Opens the New Tag dialog box, enabling you to add new keyword tags. For user
interface details, see "New/Edit Tag Dialog Box" on page 93.
HP SiteScope (11.23)
Page 268 of 1293
Chapter 24: Create Monitors in SiteScope
SiteScope collects data samples from components in your infrastructure using out-of-the-box
monitors and custom monitors. These are tools that connect to and query different kinds of
systems and applications. You configure monitors to collect the data from remote servers you want
to monitor.
To access
Select the Monitors context. In the monitor tree, right-click a group and select New > Monitor.
Learn About
This section includes:
l
"Monitor Types" below
l
"Monitoring Remote Servers" on page 271
l
"Monitoring Group Dependencies" on page 272
l
"Setting Status Thresholds" on page 274
Monitor Types
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 in the SiteScope Monitor Reference Guide.
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" on page 283.
Standard Monitors
Standard monitor categories represent the monitor categories available with a general SiteScope
license. These monitor categories include many of the general purpose monitor categories.
l
Application Monitors. Monitors in this category monitor third-party applications. These
monitors enable SiteScope to access and retrieve data from the monitored applications.
l
Big Data. Monitors in this category monitor Big Data platforms to gain real-time visibility and
insight into the health and performance of the big data infrastructure.
l
Database Monitors. Monitors in this category monitor different types of database applications.
There are monitors that access data from specific database applications and generic monitors
HP SiteScope (11.23)
Page 269 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
that can be configured to monitor any database application.
l
Generic Monitors. Monitors in this category monitor different types of environment. These
monitors can monitor networks, applications, and databases depending on how they are
configured.
l
Media Monitors. Monitors in this category monitor applications that play media files and stream
data.
l
Network Monitors. Monitors in this category monitor network health and availability.
l
Server Monitors. Monitors in this category monitor server health and availability.
l
Virtualization and Cloud Monitors. Monitors in this category monitor virtualized environments
and cloud infrastructures.
l
Web Transaction Monitors. Monitors in this category monitor web-based applications.
Customizable Monitors
Custom monitors broaden the capabilities of regular SiteScope monitors for tracking the availability
and performance of your infrastructure systems and applications. Using custom monitors, you can
develop your own solutions for environments that are not supported by predefined SiteScope
monitors.
You can create your own monitor that collects data, and define a script that processes the collected
data and creates metrics. Each time the custom monitor runs, it updates the metrics and returns a
status for the metrics defined in the script.
Custom monitors can be published to the HP Live Network for sharing with other SiteScope users.
For more details on using Custom monitors, see "Create Custom Monitors" on page 333.
Integration Monitors
Integration monitors are used to capture and forward data from third-party domain managers or
applications (typically Enterprise Management Systems (EMS)) into BSM.
These monitor types require additional licensing and may only be available as part of another HP
product. For more information about Integration Monitor capabilities, see "Integration Monitors
Overview" on page 394.
Solution Template Monitors
Solution template monitor types are a special class of monitors that enable new monitoring
capabilities for specific applications and environments. As part of a solution template, these
monitor types are deployed automatically together with other, standard monitor types to provide a
monitoring solution that incorporates best practice configurations. These monitor types are
controlled by option licensing and can only be added by deploying the applicable solution template.
After they have been deployed, you can edit or delete them using the same steps as with other
monitor types. For more information, see "Deploy Solution Templates" on page 882.
SiteScope provides the following solution templates that include standard SiteScope monitor types
and solution-specific monitors:
HP SiteScope (11.23)
Page 270 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
l
Active Directory (with and without Global Catalog)
l
AIX Host
l
Hadoop
l
HP Quality Center
l
HP Service Manager
l
HP Vertica
l
JBoss Application Server
l
Linux Host (OS )
l
Microsoft Exchange
l
Microsoft IIS Server
l
Microsoft Lync Server
l
Microsoft SharePoint
l
Microsoft SQL Server
l
Microsoft Windows Host
l
.NET
l
Oracle Database
l
SAP Application Server
l
Siebel Application/Gateway/Web Server (for UNIX and Windows)
l
VMware Capacity Management
l
VMware Host CPU/Memory/Network/State/Storage
l
VMware Host For Performance Troubleshooting
l
WebLogic Application Server
l
WebSphere Application Server
Monitoring Remote Servers
The requirements for monitoring services and applications that are running on remote servers vary
according to the application and network policies in your environment. Some SiteScope monitors
use Internet protocols to test Web systems and applications. Other SiteScope monitors use
network file system services and commands to monitor information on remote servers.
HP SiteScope (11.23)
Page 271 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
For information about how SiteScope monitors connect to remote systems, see "How to Configure
SiteScope to Monitor a Remote Microsoft Windows Server" on page 490 and "Configure SiteScope
to Monitor Remote UNIX Servers" on page 510.
Monitoring Group Dependencies
To prevent redundant alerting from multiple monitors that are monitoring different aspects of a single
system, select one monitor to check the basic availability of the system and then create other
monitors that perform more detailed tests of that system. This creates a dependency relationship
that enables you to make the running of a monitor group dependent on the status of a selected
monitor.
When creating dependencies in templates, you can enter the full path or a relative path to a
dependent monitor in the Dependencies panel. You can also have SiteScope ignore dependency
changes when publishing template changes.
For information about configuring dependency settings, see "Depends On" below and "Depends
Condition" on the next page.
Depends On
You can use this option to make the running of a monitor dependent on the status of another
monitor. This can be used to prevent redundant alerting from multiple monitors that are monitoring
different aspects of a single system. You can create a simple system monitor to check the basic
availability or heartbeat of a system, and then create other monitors that perform more detailed
tests of that system. The figure below shows an example dependency relationship where three
system monitors have been made dependent on a Service Monitor instance.
You can make the detailed test monitors dependent on the status of the heartbeat monitor by
selecting that monitor. This means the dependent monitors run as long as the dependency condition
is satisfied. If the heartbeat monitor detects that the target system has become unavailable, the
dependency relationship automatically disables the other monitors. This has the effect of disabling
any alerts that would have been generated by those monitors. The figure below shows the example
monitors are disabled because the monitor on which they depend is reporting an error condition.
HP SiteScope (11.23)
Page 272 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
By default, no dependency is set for a monitor instance. To make the running of the monitor
dependent on the status of another monitor, expand the node in the SiteScope tree containing the
monitor to which to you want to create dependence, and select the check box next to the required
monitor. To remove dependence on a monitor, clear the required check box.
Depends Condition
If you choose to make a monitor dependent on the status of another monitor (by using the Depends
on setting), you use this option to select the status category or condition that the Depends on
monitor should have for the current monitor to run normally.
The status categories include:
l
Good
l
Error
l
Available
l
Unavailable
The monitor being configured is run normally as long as the monitor selected in the Depends on
box reports the condition selected in this box. If you have selected Unavailable and the Depends
on monitor reports this status, the current monitors are not disabled.
For example, by selecting Good, this monitor is only enabled as long as the monitor selected in the
Depends on box reports a status of Good. The current monitor is automatically disabled if the
monitor selected in the Depends on box reports a category or condition other than the condition
selected for this setting. See the examples for "Depends On" on the previous page.
Dependencies When Configuring Template Monitors and Groups
When deploying monitors and groups using a template, monitor and group dependencies are also
published. This enables the template to automatically write the groups and monitors into their proper
place in the tree and automatically create any number of dependencies, without you having to do
this manually.
HP SiteScope (11.23)
Page 273 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
If a change is required to a template monitor dependency, you can update the template once and
publish the changes to all deployed groups without having to update each monitor individually. For
details, see "Publish Changes to User-Defined Templates" on page 849.
Alternatively, if you do not want dependency settings for selected monitors and groups in the
source template to overwrite dependency settings in deployed template objects, select the Ignore
dependencies when publishing changes check box in the Dependencies panel. When template
changes are published to the deployed objects, dependency settings for the selected template
monitors and groups are ignored and the existing dependency settings in the deployed objects are
preserved.
When configuring a template, you can create monitor and group dependencies to existing monitors
that are not part of the current template. This avoids having to recreate the tree structure within the
template. You do this in the Depends on box of the monitor or group template, by entering the full or
relative path to the monitor in the monitor tree.
For example, you can enter:
l
Full path:
<group name>\<group name>\<monitor name>
l
Relative path:
..\..\<group name>\<monitor name>
Setting Status Thresholds
You can use threshold settings to set logic conditions that determine the reported status of each
monitor instance. The status is based on the results or metrics returned by the monitor action on the
target system as compared to the thresholds set for the monitor.
You can set status threshold criteria for each monitor instance to determine an Error, Warning,
and Good status. Each status threshold consists of a metrics parameter, a logic comparison
operation, and a metrics value that you may specify. The parameter and the value depend on the
monitor type. For example, the metrics parameter for a CPU monitor is CPU utilization (%).
You can set up one or more status threshold criteria for each status condition. Most monitor types
include one default setting for each of the three status conditions. Default thresholds of the monitor
appear when you first configure the monitor. When the monitor is not available, it is assigned a
status that is based on the user definition in the If Unavailable drop-down list. A monitor can have a
state of Unavailable as well as a status of Good, Warning, or Error. Alerts are triggered
according to availability, status, or both availability and status.
For dynamic monitors (such as Disk Space or VMware Host), you can display thresholds for all
regular expression patterns that are translated to actual current counters. Patterns enable the
monitor to automatically configure itself with counters on the relevant dynamic environment
components. For more details, see Dynamic Monitoring Mechanism in the SiteScope Monitor
Reference Guide.
Tip: Instead of setting logic conditions manually in the threshold settings for each monitor
instance, you can have SiteScope calculate thresholds for one or more monitor instances
HP SiteScope (11.23)
Page 274 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
using a baseline. This is useful to indicate data volatility, where current monitor readings
significantly deviate from monitor previous runs. For details, see "Set Monitor Thresholds
Using a Baseline" on page 340.
This section includes:
l
"Scheduling" below
l
"Impact of Threshold Status" below
l
"Setting Multiple Thresholds" below
l
"Indicator Mappings when Reporting Topology to BSM" on the next page
Scheduling
You can select a schedule to determine the status of the monitor instance if you want to define
when to check the monitor run result against the threshold. This is useful if you want to restrict
checking the monitor run results against the threshold to certain days or hours only. For example,
you may want the monitor status to be based on results gathered during business hours only. At
times outside the threshold schedule period, the monitor is assigned the predefined status in the
Default status box. By default, monitor run results are checked against the threshold on an every
day, all day schedule.
Impact of Threshold Status
A change of status can have the following impact:
l
It signals an event and acts as a trigger for alerts associated with the monitor or the group to
which the monitor belongs. For example, if the monitor detects that the system has become
unavailable, the status change from Good to Error is used to trigger an alert on error.
l
It can affect the state of a dependency between monitors. For example, a monitor that detects a
change that results in an Error status may be a trigger to disable one or more other monitors that
are dependent on the system. For information about dependency settings, see "Monitoring
Group Dependencies" on page 272.
l
It can affect the status of the monitor in the SiteScope Dashboard. When viewing SiteScope
data in the Current Status tab of Dashboard, you can drill down in the monitor tree to view
monitor and measurement status and availability. The status is displayed by color and a status
icon in the SiteScope Dashboard. For information on measurement status and availability in the
Dashboard user interface, see "SiteScope Dashboard - Current Status View" on page 1020.
Setting Multiple Thresholds
The individual threshold criteria results are combined as logical OR relationships when more than
one threshold condition is defined for any of the three settings. When one or more of the conditions
(for example when two conditions for Error if setting) are met for a status setting the monitor status
is set to the corresponding status condition. If status conditions are met for more than one status
condition setting the status of the monitor is set to the highest valued status condition.
HP SiteScope (11.23)
Page 275 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
For example, if one condition selected as Error if and another condition selected as Warning if are
both met, the status would be reported as an Error, with Error being the highest value, Warning
the next highest, and Good the lowest value.
Indicator Mappings when Reporting Topology to BSM
When SiteScope is reporting data to BSM, indicators provide a more detailed view of the health of a
configuration item (CI). For details on understanding indicators, see "Health Indicators, KPIs, and
KPI Domains" in the BSM User Guide in the BSM Help.
When configuring thresholds for a monitor metric, monitors that have a defined topology and a
default mapping have an indicator state and severity value assigned to the metric status by default.
l
Every indicator can have several states. For example, when measuring CPU Load, the indicator
state might be Bottlenecked or Busy, whereas when measuring Memory Load, the indicator
state might be Paging or Starving for Memory.
l
Indicator severity is the severity corresponding to the indicator state. The available indicator
severity levels are Critical, Major, Minor, Warning, Normal, and Unknown.
Indicator states are assigned to the metric status according to the closest available severity that
exists in the states for the indicator associated with the metric. The selected severity is shown in
the SiteScope threshold.
Example:
l
When measuring percent used on a Memory monitor, the metric is mapped to Major
severity in the Error threshold, since Critical severity is not available for the Memory
Load indicator.
l
When measuring round trip time on a Ping monitor, the closest severity level in the
Warning threshold is Major, since the Minor severity level does not exist for this indicator
state.
The Good threshold is always mapped to the Normal severity level.
The association between the indicator state and severity cannot be changed on the local SiteScope
server.
If you select a different indicator mapping in the HP Integration Settings panel for the monitor, the
indicator state and severity values are updated in the Threshold Settings.
Note: If the Indicator State and Severity box is empty, the metric is not colored in Service
Health, except for always (default) which is automatically assigned.
The default indicator assignments (mappings) are stored in the Indicator Assignment Settings in
SAM Administration. For details, see "Indicator Assignment Settings" in the BSM User Guide in the
BSM Help.
When there is a change to an assignment in the Indicator Assignment Settings, SiteScope detects
the change and downloads the updated assignments. If indicator assignments have been changed
HP SiteScope (11.23)
Page 276 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
on a local SiteScope server, these assignments are not overridden by the Indicator Assignment
Settings. This includes indicator states where the state selected in the user interface is the same
as the default value.
Note:
l
If overlapping thresholds have been set (for example, Error if cpu utilization > 80%
and Error if cpu utilization > 90%), the indicator state and severity value that is
mapped to the closest threshold value is sent. In this example, if the actual metric value is
95%, then the indicator value that is mapped to Error if cpu utilization > 90% is sent.
This is applicable only to thresholds where the values are numeric.
l
Indicator state and severity are not displayed in SiteScope reports.
"Reference Information: Monitors" on page 283
Tasks
How to Create and Deploy a Monitor
This task describes the steps involved in deploying a monitor.
1.
Prerequisites
n
Check if there are setup requirements and user permissions that need to be obtained for the
monitor before configuring the monitor. For details, see the help for the specific monitor in
the SiteScope Monitor Reference Guide.
n
Monitors must be created in a group in the monitor tree. For task details, see "Create
SiteScope groups and subgroups" on page 263.
Note: To enable SiteScope to monitor data on remote servers, you must configure remote
servers. For details on configuring a Windows remote server, see "Configure SiteScope to
Monitor Remote Windows Servers" on page 490. For details on configuring a UNIX remote
server, see "Configure SiteScope to Monitor Remote UNIX Servers" on page 510.
2.
Create monitor instances
a. To create a new monitor instance, right-click the group into which you want to add the
monitor instance, and select New > Monitor. For user interface details, see "New Monitor
Dialog Box" on page 280.
Note: Alternatively, you can create a new monitor instance by copying or moving
existing monitor instances to the group in the monitor view. For details, see "Copy and
Move SiteScope Objects" on page 104.
b. Select the monitor you want to add from the New Monitor dialog box, and configure the
HP SiteScope (11.23)
Page 277 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
settings for the specific monitor. For a description of the monitor settings, see the help for
the specific monitor in the SiteScope Monitor Reference Guide.
c. You can configure other properties that affect the monitor. For example:
o
In the Monitor Run Settings panel, you can set how often SiteScope attempts to run
the action defined for the monitor instance. You can also set the range schedule if you
want the monitor to run on certain days or on a fixed schedule. For user interface details,
see "Monitor Run Settings" on page 302.
o
In the Dependencies panel, you can set monitor dependencies to make the running of
this monitor dependent on the status of another monitor. For user interface details, see
"Dependencies" on page 304.
Example:
The monitor being configured is run normally as long as the monitor selected in the
Depends on box reports the condition selected in the Depends condition box. In
this example, the monitor being configured is enabled only when the Service monitor
reports a status of Good.
o
In the Calculated Metrics panel, you can manually configure calculated metrics to
calculate the relation between two or more metrics for one or more monitors. For user
interface details, see "Calculated Metrics Settings" on page 378.
o
In the Threshold Settings panel, you can manually set logic conditions that determine
the reported status of each monitor instance. For user interface details, see "Threshold
Settings" on page 305.
Alternatively, you can set thresholds for one or multiple monitors using a baseline. For
task details, see "How to Set Monitor Thresholds Using a Baseline" on page 341.
Example:
The following shows the default threshold settings for a disk space monitor:
HP SiteScope (11.23)
Page 278 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Disk space of less than 95 percent full results in a good status; disk space greater
than 95 percent full but lower than 98 percent full results in a warning status; disk
space greater than 98 percent full or "n/a" results in an error status.
3.
o
In the Logging Settings panel, you can create a dedicated log file for the selected
monitor instance and view that file from this panel. You can also enable debugging for
perfex process. For user interface details, see "Logging Settings" on page 328.
o
For details of the other common monitor properties, see "Common Monitor Settings" on
page 298.
Set up monitor alerts - optional
Create alerts to send notification of an event or change of status in some element or system in
your infrastructure.
To create an alert for the monitor, right-click the monitor and select New > Alert. For each alert
scheme, you can create one or more alert actions. In the New Alert dialog box, click New Alert
Action to start the Alert Action wizard.
For task details, see "Configure SiteScope Alerts" on page 1140.
Note:
n
You can disable alerts associated with specific groups and monitors in the SiteScope
tree from the Enable/Disable Associated Alerts panel in the monitor Properties tab,
or by clicking the Enable/Disable Associated Alerts
icon in the Dashboard and
selecting the required disable option. Note that this disables only the triggers that come
from that specific monitor. If an alert is assigned to more the one monitor, the alerts on
the other monitors are unaffected and keep working. When an associated alert is
disabled from the Properties tab, the alert itself is still enabled in the Alerts tab.
HP SiteScope (11.23)
Page 279 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
n
You can filter the SiteScope tree to show all groups and monitors with associated alerts
enabled or disabled by clicking the Filter
button in the tree toolbar, and selecting
Enabled or Disabled from the Enable/Disable Associated Alerts list in the Filter
Options section. The results of this filter appear in the monitor tree.
4.
Set up monitor reports - optional
Create reports to display information about how the servers and applications you are
monitoring have performed over time.
To create a report for the monitor, right-click the monitor and click Reports. Select a report type
and configure the report settings.
For task details, see "Create SiteScope Reports" on page 1211.
5.
Configure analytics - optional
Configure analytics which enables SiteScope to anticipate potential problems on business
monitors and alert users of issues in critical applications before they occur. Analytics is also
able to provide details to assist with root cause analysis to help expedite problem resolution.
For details. see "Configure Predictive Analytics" on page 1261.
6.
Results
The monitor is added to the monitor group in the monitor tree with the configuration settings that
you specified displayed in the Properties tab.
UI Descriptions
New Monitor Dialog Box
The New Monitor dialog box enables you to define a new monitor in a monitor group.
HP SiteScope (11.23)
Page 280 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
User interface elements are described below:
UI Element
Description
Quick
Search
Enter a monitor name in the Quick Search box. You can select the following
settings to help you with your search:
l
All. Search for matches in all columns.
l
Monitor. Search for matches in the Monitor column only.
l
Category. Search for matches in the Category column only.
l
Case sensitive. Search for matches that are case sensitive.
l
Case insensitive. Search for matches that are not case sensitive.
l
Use wild cards. Enables you to use wild card characters in your search. For
example, use an asterisk wildcard (*) to represent a string of characters, or a
question mark wild card (?) to represent one character only.
l
Match from start. Search for monitors/monitor categories that match the
search text from the start.
l
Match exactly. Search for monitors/monitor categories that exactly match the
search text.
l
Match anywhere. Search for monitors/monitor categories that contain the
search text somewhere in the name.
Recently
Used
Monitors
Displays the five most recently selected monitors. Click a link to create a new
monitor for the selected monitor type.
Monitor
Displays the list of SiteScope monitors. Select a monitor from the list by clicking
the monitor link. A grayed-out link indicates that the monitor is not available.
Note: The displayed monitors may change as more selections are made.
You can change the order of the listed monitors, by clicking the column header. An
arrow is displayed to indicate the sort order (ascending or descending).
You can also select a monitor by clicking the arrow to the right of the Monitor
heading, and selecting a monitor from the list, or you can choose (Custom...),
which enables you to customize the monitor filter using various conditions.
HP SiteScope (11.23)
Page 281 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Category
Displays the list of monitor categories.
You can change the order of the listed categories, by clicking the column header.
An arrow is displayed to indicate the sort order (ascending or descending).
To select a monitor by category, click the arrow to the right of the Category
heading, and select a category from the list detailed below.
l
(All) - This is the default setting.
l
(Custom...) - Enables you to customize the category filter using various
conditions.
l
Application
l
Customizable
l
Database
l
Generic
l
Integration
l
Media
l
Network
l
Server
l
Virtualization and Cloud
l
Web Transaction
For the monitors in each category, see "Monitor Categories List" on the next page.
Availability Displays the monitor availability status (Available/Not Available).
You can change the availability status order, by clicking the column header. An
arrow is displayed to indicate the sort order (ascending or descending), or by
clicking the arrow to the right of the Availability heading, and selecting a status.
"SiteScope Monitors User Interface" on page 297
Tips/Troubleshooting
General Notes and Limitations
l
Monitors can be created only in a SiteScope group.
HP SiteScope (11.23)
Page 282 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
l
Only a SiteScope administrator user, or a user granted the appropriate permissions can create,
edit, refresh, disable, or acknowledge monitors. For details on user permissions, see
"Permissions" on page 738.
l
You cannot delete a monitor if it has dependent alerts or reports at the container level. To delete
a monitor with dependencies, you must remove the monitor from Alert Targets and Report
Targets for each dependency, and then delete the monitor. You can delete monitors that have
dependencies at the child level.
l
The Monitor description field supports HTML tags (HTML version 3.2) including the most
common tags for text styling, such as <BR>, <HR>, and <B>, and hyperlinks. It does not
support JavaScript/iframes/frames or other advanced features.
l
You can also use the SiteScope API when working with monitors. For details, see "SiteScope
Public APIs" on page 178.
Reference Information: Monitors
You can find additional reference information on SiteScope monitor in the following sections:
l
"Monitor Categories List" below
l
"Monitors Supported in SiteScopes Installed on Windows Environments Only" on page 289
l
"Monitors Supporting Windows Management Instrumentation (WMI)" on page 290
l
"Server Monitors that Support Monitoring Amazon EC2 Instances From SiteScopes Not
Installed on EC2" on page 290
l
"Ports Used for SiteScope Monitoring" on page 291
l
"List of Deprecated SiteScope Monitors" on page 296
Monitor Categories List
This section displays the SiteScope monitors in each monitor category. For information about the
usage and configuring each monitor type, see the monitor type in the SiteScope Monitor Reference
Guide.
l
"Application Monitors" on the next page
l
"Big Data" on page 285
l
"Customizable Monitors" on page 286
l
"Database Monitors" on page 286
l
"Generic Monitors" on page 286
HP SiteScope (11.23)
Page 283 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
l
"Integration Monitors" on page 287
l
"Media Monitors" on page 287
l
"Network Monitors" on page 287
l
"Server Monitors" on page 288
l
"Virtualization and Cloud Monitors" on page 288
l
"Web Transaction Monitors" on page 289
Application Monitors
l
Active Directory Replication Monitor
l
Apache Server Monitor
l
BroadVision Application Server Monitor
l
Check Point Monitor
l
Cisco Works Monitor
l
Citrix Monitor
l
ColdFusion Server Monitor
l
COM+ Server Monitor
l
F5 Big-IP Monitor
l
HAProxy Monitor
l
Mail Monitor
l
MAPI Monitor
l
Memcached Statistics Monitor
l
Microsoft ASP Server Monitor
l
Microsoft Exchange Monitor
l
Microsoft Exchange 2003 Mailbox Monitor
l
Microsoft Exchange 5.5 Message Traffic Monitor
l
Microsoft Exchange 2000/2003/2007 Message Traffic Monitor
HP SiteScope (11.23)
Page 284 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
l
Microsoft Exchange 2003 Public Folder Monitor
l
Microsoft IIS Server Monitor
l
News Monitor
l
Oracle 9i Application Server Monitor
l
Oracle 10g Application Server Monitor
l
Radius Monitor
l
SAP CCMS Monitor
l
SAP CCMS Alerts Monitor
l
SAP Java Web Application Server Monitor
l
SAP Performance Monitor
l
SAP Work Processes Monitor
l
Siebel Application Server Monitor
l
Siebel Log File Monitor
l
Siebel Web Server Monitor
l
SunONE Web Server Monitor
l
Tuxedo Monitor
l
UDDI Monitor
l
WebLogic Application Server Monitor
l
Web Server Monitor
l
WebSphere Application Server Monitor
l
WebSphere MQ Status Monitor
l
WebSphere Performance Servlet Monitor
Big Data
l
Hadoop Monitor
l
HP Vertica JDBC Monitor
HP SiteScope (11.23)
Page 285 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Customizable Monitors
l
Custom Monitor
l
Custom Database Monitor
l
Custom Log File Monitor
l
Custom WMI Monitor
Database Monitors
l
Database Counter Monitor
l
Database Query Monitor
l
DB2 JDBC Monitor
l
LDAP Monitor
l
Microsoft SQL Server Monitor
l
Oracle Database Monitor
l
Sybase Monitor
Generic Monitors
l
Composite Monitor
l
Directory Monitor
l
Dynamic JMX Monitor
l
File Monitor
l
Formula Composite Monitor
l
JMX Monitor
l
Log File Monitor
l
Multi Log Monitor
l
Script Monitor
l
Syslog Monitor
l
Web Service Monitor
l
XML Metrics Monitor
HP SiteScope (11.23)
Page 286 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Integration Monitors
l
HP OM Event Monitor
l
HP Service Manager Monitor
l
NetScout Event Monitor
l
Technology Database Integration Monitor
l
Technology Log File Integration Monitor
l
Technology SNMP Trap Integration Monitor
l
Technology Web Service Integration Monitor
Media Monitors
l
Microsoft Lync Server 2010 Monitors (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
l
Microsoft Windows Media Server Monitor
l
Real Media Player Monitor
l
Real Media Server Monitor
Network Monitors
l
DNS Monitor
l
FTP Monitor
l
Microsoft Windows Dial-up Monitor
l
Network Bandwidth Monitor
l
Ping Monitor
l
Port Monitor
l
SNMP Monitor
l
SNMP Trap Monitor
l
SNMP by MIB Monitor
HP SiteScope (11.23)
Page 287 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Server Monitors
l
Browsable Windows Performance Monitor
l
CPU Monitor
l
Disk Space Monitor (Deprecated)
l
DHCP Monitor
l
Dynamic Disk Space Monitor
l
HP iLO (Integrated Lights-Out) Monitor
l
HP NonStop Event Log Monitor
l
HP NonStop Resources Monitor
l
IPMI Monitor
l
Memory Monitor
l
Microsoft Windows Event Log Monitor
l
Microsoft Windows Performance Counter Monitor
l
Microsoft Windows Resources Monitor
l
Microsoft Windows Services State Monitor
l
Service Monitor
l
UNIX Resources Monitor
Virtualization and Cloud Monitors
l
Amazon Web Services Monitor
l
Generic Hypervisor Monitor
l
KVM Monitor
l
Microsoft Hyper-V Monitor
l
Solaris Zones Monitor
l
VMware Datastore Monitor
l
VMware Host Monitors (VMware Host CPU, VMware Host Memory, VMware Host Network,
VMware Host State, and VMware Host Storage)
HP SiteScope (11.23)
Page 288 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
l
VMware Performance Monitor
Web Transaction Monitors
l
e-Business Transaction Monitor
l
Link Check Monitor
l
URL Monitor
l
URL Content Monitor
l
URL List Monitor
l
URL Sequence Monitor
l
Web Script Monitor
Monitors Supported in SiteScopes Installed on Windows
Environments Only
The following is a list of the monitors supported in SiteScopes that are running on Windows
versions only. Where relevant, the monitors can monitor remote servers running on any
platform/operating system.
l
MAPI Monitor
l
Microsoft Exchange 2003 Mailbox Monitor
l
Microsoft Exchange 2003 Public Folder Monitor
l
Microsoft Exchange 2003 Public Folder Monitor
l
Microsoft Exchange Monitor
l
Microsoft Exchange 5.5 Message Traffic Monitor
l
Microsoft Windows Dial-up Monitor
l
Microsoft Windows Media Player Monitor
l
Real Media Player Monitor
l
Sybase Monitor
l
Tuxedo Monitor
l
Web Script Monitor
HP SiteScope (11.23)
Page 289 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Monitors Supporting Windows Management
Instrumentation (WMI)
For the list of the monitors that support the Windows Management Instrumentation (WMI) method
for collecting data, see "Configure the WMI Service for Remote Windows Monitoring" on page 507.
Server Monitors that Support Monitoring Amazon EC2
Instances From SiteScopes Not Installed on EC2
Supported protocols for monitoring Amazon EC2 instances using SiteScope deployed in a private
customer network:
Required
configuration in Required
Amazon
configuration in
security group
OS
Protocol
Windows
UNIX
NetBIOS
Supported
Not supported
Enable 443, 445
tcp ports
Enable incoming
requests in
Windows
Firewall
WMI
Not supported
Not supported
N/A
N/A
SSH
Supported
Supported
Enable 22 tcp
port
Configure
standard sshd
Telnet
Not supported
Supported
Enable telnet
port
The following is a list of the SiteScope server monitors that support monitoring Amazon EC2
instances from outside EC2:
l
Citrix Monitor
l
ColdFusion Server Monitor
l
CPU Monitor
l
Directory Monitor
l
Disk Space Monitor (Deprecated)
l
Dynamic Disk Space Monitor
l
File Monitor
l
HP Vertica JDBC Monitor
HP SiteScope (11.23)
Page 290 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
l
Log File Monitor
l
Memory Monitor
l
Microsoft ASP Server Monitor
l
Microsoft Hyper-V Monitor
l
Microsoft IIS Server Monitor
l
Microsoft SQL Server Monitor
l
Microsoft Windows Event Log Monitor
l
Microsoft Windows Media Server Monitor
l
Microsoft Windows Performance Counter Monitor
l
Microsoft Windows Services State Monitor
l
Real Media Server Monitor
l
Script Monitor
l
Service Monitor
l
Siebel Log File Monitor
l
Syslog Monitor
l
Web Server Monitor
Ports Used for SiteScope Monitoring
The following table lists the network ports that are generally used for SiteScope monitoring. In many
cases, alternate ports may be configured depending on the security requirements of your
environment.
Note: All monitors that support perfex—SiteScope's internal application that connects to
Windows APIs—may use port 135, in addition to other ports.
Monitor Type
Ports Used
Apache Server Monitor
Port which Apache Server Admin pages
located. Configurable by using server
configuration file.
HP SiteScope (11.23)
Page 291 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Monitor Type
Ports Used
BroadVision Application Server Monitor
Uses the Object Request Broker (ORB) port
number for the BroadVision server you are
trying to monitor.
Check Point Monitor
SNMP monitor. Default is port 161. This is
configurable.
Cisco Works Monitor
Cisco Works resources are usually available by
using port 161 or 162 (SNMP), depending on
the configuration of the server.
Citrix Monitor
Ports 137, 138, and 139 (NetBIOS).
ColdFusion Server Monitor
Ports 137, 138, and 139 (NetBIOS).
CPU Monitor
For local CPU, no ports required.
For CPUs on remote servers (Windows-based
systems): ports 137, 138, and 139 (NetBIOS).
For CPUs on remote servers (Solaris/Linuxbased systems): ports 22 (SSH), 23 (telnet), or
513 (rlogin).
Database Query Monitor
This is configurable and depends on ODBC or
JDBC driver and DB configuration.
DB2 JDBC Monitor
Default is port 50000. This is configurable.
DHCP Monitor
Default is port 68.
Directory Monitor
For local directory, no ports required.
For directories on remote servers (Windowsbased systems): ports 137, 138, and 139
(NetBIOS).
For directories on remote servers
(Solaris/Linux-based systems): ports 22 (SSH),
23 (telnet), or 513 (rlogin).
HP SiteScope (11.23)
Page 292 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Monitor Type
Ports Used
Disk Space Monitor (Deprecated)
For local disk space, no ports required.
Dynamic Disk Space Monitor
For disk space on remote servers (Windowsbased systems): ports 137, 138, and 139
(NetBIOS).
For disk space on remote servers
(Solaris/Linux-based systems): ports 22 (SSH),
23 (telnet), or 513 (rlogin).
Note that diskperf -y must be enabled , and
the monitored client requires a reboot.
DNS Monitor
Default is port 53.
F5 Big-IP Monitor
Uses SNMP. This is configurable.
File Monitor
Local disk. No ports required.
For files on remote servers (Windows-based
systems): ports 137, 138, and 139 (NetBIOS).
For files on remote servers (Solaris/Linuxbased systems): ports 22 (SSH), 23 (telnet), or
513 (rlogin).
FTP Monitor
Default is port 21. This is configurable.
Generic Hypervisor Monitor
Ports 22 (SSH), 23 (telnet), or 513 (rlogin).
HAProxy Monitor
The default is port 80. This is configurable.
HP Vertica JDBC Monitor
The default is port 5433. This is configurable.
KVM Monitor
Ports 22 (SSH), 23 (telnet), or 513 (rlogin).
LDAP Monitor
The default is port 389. This is configurable.
Link Check Monitor
The default is port 80. This is configurable.
Log File Monitor
Ports 137, 138, and 139 (NetBIOS) for
Windows based systems.
Ports 22 (SSH), 23 (telnet), or 513 (rlogin) for
Solaris/Linux based systems.
Mail Monitor
Port 110 for POP3, port 25 for SMTP, port 143
for IMAP.
MAPI Monitor
MAPI uses the Name Service Provider
Interface (NSPI) on a dynamically assigned
port higher than 1024 to perform client-directory
lookup.
HP SiteScope (11.23)
Page 293 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Monitor Type
Ports Used
Memory Monitor
Ports 137, 138, and 139 (NetBIOS) for
Windows based systems, ports 22 (SSH), 23
(telnet), or 513 (rlogin) for Solaris/Linux based
systems.
Memcached Statistics Monitor
Default is port 11211. This is configurable.
Microsoft Lync Server 2010 Monitors
(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)
Windows Performance Counters over ports
137, 138, and 139 (NetBIOS).
Microsoft Hyper-V Monitor
Windows Performance Counters over ports
137, 138, and 139 (NetBIOS).
Microsoft IIS Server Monitor
Windows Performance Counters over ports
137, 138, and 139 (NetBIOS).
Microsoft SQL Server Monitor
Ports 137, 138, and 139 (NetBIOS).
Microsoft Windows Event Log Monitor
Ports 137, 138, and 139 (NetBIOS).
Microsoft Windows Media Player Monitor
Same port as media content to be monitored.
Microsoft Windows Media Server Monitor
Ports 137, 138, and 139 (NetBIOS).
Microsoft Windows Performance Counter
Monitor
Ports 137, 138, and 139 (NetBIOS).
Microsoft Windows Resources Monitor
Ports 137, 138, and 139 (NetBIOS).
Multi Log Monitor
Ports 137, 138, and 139 (NetBIOS) for
Windows based systems.
Ports 22 (SSH), 23 (telnet), or 513 (rlogin) for
Solaris/Linux based systems.
Network Bandwidth Monitor
No ports required; monitors only the local
machine.
News Monitor
Default is port 144. This is configurable.
Oracle Database Monitor
This is configurable. Depends on target DB.
Default is port 1521.
Oracle 9i Application Server Monitor
This is configurable. Port which Webcaching
admin page located.
Oracle 10g Application Server Monitor
HP SiteScope (11.23)
Page 294 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Monitor Type
Ports Used
Ping Monitor
Default is port 7.
Port Monitor
Monitors any port.
Radius Monitor
Currently supports Password Authentication
Procedure (PAP) authentication but not the
Challenge Handshake Authentication Protocol
(CHAP) or Microsoft Challenge Handshake
Authentication Protocol (MS-CHAP). The
RADIUS servers must be configured to accept
PAP requests.
Default is port 1645. In recent changes to the
RADIUS spec, this may be changed to 1812.
The monitor is configurable.
Real Media Player Monitor
Uses Real Media client on SiteScope box.
Uses the port from which the media content is
streamed (based on the URL).
Real Media Server Monitor
Ports 137, 138, and 139 (NetBIOS).
SAP CCMS Monitor
Uses SAP Client software (SAP Front End) to
run certain SAP transactions. Therefore, same
ports as SAP.
Script Monitor
Ports 137, 138, and 139 (NetBIOS) for
Windows based systems.
Ports 22 (SSH), 23 (telnet), or 513 (rlogin) for
Solaris/Linux based systems.
Service Monitor
Ports 137, 138, and 139 (NetBIOS) for
Windows based systems.
Ports 22 (SSH), 23 (telnet), or 513 (rlogin) for
Solaris/Linux based systems.
SNMP Monitor
Default is port 161. This is configurable.
SNMP Trap Monitor
Uses port 162 for receiving traps. This is
configurable.
SunONE Web Server Monitor
URL to the stats-xml file on the target SunONE
server. The port is configurable.
Sybase Monitor
Monitor requires Sybase Central client on the
machine where SiteScope is running to connect
to the Adaptive Server Enterprise Monitor
Server. Port number the same as Sybase
client.
HP SiteScope (11.23)
Page 295 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Monitor Type
Ports Used
Syslog Monitor
Ports 22 (SSH), 23 (telnet), or 513 (rlogin) for
Solaris/Linux based systems.
Tuxedo Monitor
The default port for the TUXEDO workstation
listener is port 65535. This is configurable.
URL Monitor
Generally port number 80. This is configurable.
Web Server Monitor
Ports 137, 138, and 139 (NetBIOS) for
Windows based systems.
Ports 22 (SSH), 23 (telnet), or 513 (rlogin) for
Solaris/Linux based systems.
Web Service Monitor
This is configurable.
WebLogic Application Server Monitor
Oracle WebLogic Application Server monitor
uses the Java JMX interface. Port is
configurable.
WebSphere Application Server Monitor
Same port as the IBM WebSphere
Administrator's Console.
WebSphere Performance Servlet Monitor
WebSphere Performance Servlet. Port is
configurable.
List of Deprecated SiteScope Monitors
In recent versions of SiteScope, a number of monitors were deprecated and are no longer
supported. The following table lists the deprecated monitors and, where available, the respective
monitors that can replace them:
Deprecated Monitor
Recommended Alternative Monitor
Active Directory Performance
N/A
Asset
N/A
Astra Load Test
Web Script Monitor
DB2
DB2 JDBC Monitor
Disk Space
Dynamic Disk Space Monitor
Dynamo
N/A
IPlanet Application Server
SunONE Web Server Monitor
IPlanet Server
SunONE Web Server Monitor
HP SiteScope (11.23)
Page 296 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Deprecated Monitor
Recommended Alternative Monitor
IPlanet Web Server
SunONE Web Server Monitor
Network
Network Bandwidth Monitor
Quick Test Pro
Web Script Monitor
RTSP
Real Media Player Monitor
SAP
SAP Performance Monitor
SAP Portal
SAP CCMS Monitor
SilverStream Server
N/A
WebLogic 5.x Application Server
N/A
SiteScope Monitors User Interface
This section includes:
l
"New Monitor Dialog Box" on page 280
l
"Common Monitor Settings" on the next page
l
n
"General Settings" on page 300
n
"Monitor Run Settings" on page 302
n
"Dependencies" on page 304
n
"Calculated Metrics Settings" on page 378
n
"Threshold Settings" on page 305
n
"HP Integration Settings" on page 311
n
"Event Mapping Settings" on page 322
n
"Enable/Disable Monitor" on page 323
n
"Enable/Disable Associated Alerts" on page 325
n
"Search/Filter Tags" on page 326
n
"Baseline Settings" on page 327
n
"Logging Settings" on page 328
"Select Depends On Monitor Dialog Box" on page 330
HP SiteScope (11.23)
Page 297 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
l
"Select Template Dialog Box" on page 331
l
"Copy to Template Tree Dialog Box" on page 331
Common Monitor Settings
The common monitor settings enable you to configure settings for a new monitor.
To
access
Select the Monitors context.
l
For new monitors: In the monitor tree, right-click a group, select New > Monitor,
and select a monitor from the New Monitor dialog box. In the right pane, click the
Properties tab.
l
For existing monitors: In the monitor tree, expand the group folder that contains
the monitor, and select the monitor. In the right pane, click the Properties tab.
Relevant "How to Create and Deploy a Monitor" on page 277
tasks
See also
"Monitor Tree" on page 43
User interface elements are described below (unlabeled elements are shown in angle brackets):
HP SiteScope (11.23)
Page 298 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI
Element
Description
Properties The following setting panel in the monitor Properties tab are common to all
Tab
monitors. For details on the settings for a specific SiteScope monitor, see the user
interface page for the monitor type.
l
"General Settings" on the next page
l
<Monitor Name> Monitor Settings. For a description of monitor settings and
details on how to configure each monitor, see the specific monitor in the
SiteScope Monitor Reference Guide.
l
"Monitor Run Settings" on page 302
l
"Dependencies" on page 304
l
"Calculated Metrics Settings" on page 378
l
"Threshold Settings" on page 305
l
"HP Integration Settings" on page 311 (displayed when SiteScope is integrated
with BSM, or with Operations Manager (HPOM) and event or metrics integration
is enabled)
l
"Event Mapping Settings" on page 322 (displayed when SiteScope is integrated
with HPOM and event integration is enabled, or when a Generic Event
Integration is configured in Integration Preferences)
l
"Enable/Disable Monitor" on page 323
l
"Enable/Disable Associated Alerts" on page 325
l
"Search/Filter Tags" on page 326
l
"Baseline Settings" on page 327
l
"Logging Settings" on page 328
Note: The Link Monitor to CI settings panel was removed in SiteScope 11.00 and
the functionality was replaced by the report custom topology feature in the HP
Integration Settings panel.
HP SiteScope (11.23)
Page 299 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI
Element
Verify &
Save
Description
Verifies the correctness of the monitor configuration locally and on the remote
server to be monitored, before saving the settings. If SiteScope fails to connect to
the remote server, or if there is an invalid property in the configuration settings,
verification fails and an error message is displayed.
Tip: Performance is not as fast if you use Verify & Save instead of Save, because
SiteScope needs to establish a connection to the remote server to verify the
settings. For bulk operations such as Publish Template Changes and Global
Search and Replace, we recommend using the Save option only
Save
Performs a local verification of the configuration settings, and saves the settings
(without verifying the correctness of the monitor configuration on the remote
server).
Tip: Performance is faster if you use Save instead of Verify & Save, because
SiteScope does not need to establish a connection to the remote server to verify
the settings. For bulk operations such as Publish Template Changes and Global
Search and Replace, we recommend using the Save option only.
Note: When saving a customizable monitor type, Save has the same affect as
Verify & Save. SiteScope verifies the correctness of the monitor configuration both
locally and on the remote server to be monitored, before saving the settings.
General Settings
The General Settings panel enables you to create a name and description for the monitor instance.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select General Settings.
Important
information
l
HTML code entered in the monitor description fields is checked for validity and
security, and corrective action is taken to fix the code (for example, code is
truncated if it spans more than one line). If malicious HTML code or JavaScript
is detected, the entire field is rejected.
l
To automatically adjust the row height to make all cell contents visible in the
Dashboard, select the Wrap text option in Dashboard Settings. For details,
see "Dashboard Settings Dialog Box" on page 1014.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
Relevant
tasks
"How to Create and Deploy a Monitor" on page 277
HP SiteScope (11.23)
Page 300 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
User interface elements are described below:
UI Element
Description
Name
Name that describes the element or system being monitored. Use a useful
naming convention for all monitors to make creating view filters and category
assignments more effective.
Example: <hostname:resource_type> or <business_unit resource_
name monitored_element>
Default value: SiteScope creates a default name based on the host, system,
and/or URL being monitored or the default name defined for the monitor type.
Monitor
description
Additional information to describe a monitor. This can include the most common
HTML tags for text styling, such as <BR>, <HR>, and <B>. The description is
displayed only when viewing or editing the monitor's properties in the SiteScope
Dashboard.
You can also include HTML tags to enable you to access URLs from the
SiteScope Dashboard. To add a hyperlink, enter the URL (UNC path is supported
for Windows remotes). For example, <a href="http://www.hp.com">My
Link</a>. The URL is displayed in the Description field for the selected monitor
in the SiteScope Dashboard.
Note: This field does not support JavaScript/iframes/frames or other advanced
features. HTML code entered in this box is checked for validity and security, and
corrective action is taken to fix the code (for example, code is truncated if it spans
more than one line). If malicious HTML code or JavaScript is detected, the entire
field is rejected. The following is prohibited HTML content:
l
Tags: script, object, param, frame, iframe.
l
Any tag that contains an attribute starting with on is declined. For example,
onhover.
l
Any attribute with javascript as its value.
HP SiteScope (11.23)
Page 301 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Report
Optional description for this monitor to make it easier to understand what the
Description monitor does. This description is displayed on each bar chart and graph in
Management Reports.
Example: Network traffic or main server response time.
Note: HTML code entered in this box is checked for validity and security, and
corrective action is taken to fix the code (for example, code is truncated if it spans
more than one line). If malicious HTML code or JavaScript is detected, the entire
field is rejected. The following is prohibited HTML content:
l
Tags: script, object, param, frame, iframe.
l
Any tag that contains an attribute starting with on is declined. For example,
onhover.
l
Any attribute with javascript as its value.
Monitor Run Settings
The Monitor Run Settings panel enables you to configure settings for the monitor run.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Monitor Run Settings.
Important
For buttons common to all panes, see "Common Monitor Settings" on page 298.
information
Relevant
tasks
"How to Create and Deploy a Monitor" on page 277
See also
"Schedule Preferences" on page 708
User interface elements are described below:
UI
Element
Description
Frequency How often SiteScope attempts to run the action defined for the monitor instance.
Each monitor run updates the status of the monitor. Use the drop-down list to
specify increments of seconds, minutes, hours, or days.
Default value: 10 minutes
Minimum value: 15 seconds
Note: When configuring this setting in a template, the variable value can only be in
time units of seconds.
HP SiteScope (11.23)
Page 302 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI
Element
Error
frequency
Description
Monitoring interval for monitors that have reported an error condition.
Example: You may want to run the monitor every 10 minutes normally, but as often
as every 2 minutes if an error has been detected. When the monitor's status is no
longer in error, the monitor reverts to the run interval specified in the Frequency
setting.
Note:
Verify
error
l
Increasing the monitor run frequency affects the number of alerts generated by
the monitor.
l
When configuring this setting in a template, the variable value can only be in
time units of seconds.
Automatically runs the monitor again if it detects an error. It runs the monitor
immediately after the regular run returned an error to make sure that the first error
was not a false alert. If the error is returned again, it is reported as a result of the
monitor run, and the next run takes place according to the monitor schedule.
To change monitor scheduling while the monitor is in error status, see the Error
frequency setting. This is a preferred and recommended setting over Verify error,
especially for large SiteScope environments.
The status returned by the Verify error run of the monitor replaces the status of the
originally scheduled run that detected an error. The data from the verify run may be
different than the initial error status, causing the loss of important performance
data.
Tip: We recommend using this option in small monitoring environments only.
Significant monitoring delays may result if multiple monitors are rescheduled to
verify errors at the same time.
Monitor
schedule
Range schedule if you want the monitor to run only on certain days or on a fixed
schedule. The range schedules created in Schedule Preferences appear in the
drop-down list. For more information about creating monitor schedules, see
"Schedule Preferences" on page 708.
Default value: every day, all day
Note: If you select a threshold schedule in the Threshold Settings, at least one
threshold schedule must coincide with the monitor run schedule (at least one
minute of the monitor run schedule must be covered by one of the threshold
schedules).
Show run
results on
update
Whenever a change is made to a monitor's configuration settings, the monitor is
run. Displays the results of that monitor run in a popup dialog box.
Note: The updated run results are always displayed in the applicable Dashboard
views for the monitor.
HP SiteScope (11.23)
Page 303 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Dependencies
The Dependencies panel enables you to create a dependency relationship that enables you to make
the running of this monitor dependent on the status of another monitor.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Dependencies.
Important
For buttons common to all panes, see "Common Monitor Settings" on page 298.
information
Relevant
tasks
"How to Create and Deploy a Monitor" on page 277
See also
"Monitoring Group Dependencies" on page 272
User interface elements are described below:
UI Element
Depends on
Description
Click Depends on
to open the Select Depends On Monitor dialog box, and
select the monitor on which you want to make the running of this monitor
dependent. For details on the Select Depends On Monitor dialog box, see
"Select Depends On Monitor Dialog Box" on page 330.
Use this option to prevent redundant alerting from multiple monitors that are
monitoring different aspects of a single system.
Example: Create a system monitor to check the basic availability of a system
and then create other monitors that perform more detailed tests of that system.
Set the detailed test monitors to be dependent on the status of the monitor
checking basic availability.
If the system monitor detects that the target system has become unavailable,
the dependency relationship automatically disables the other monitors. This
also disables any alerts that would have been generated by the dependent
monitors.
Default value: No dependency is set for a monitor instance.
Note when working in template mode: This field is cleared and is not
available when Ignore dependencies when publishing changes is selected.
HP SiteScope (11.23)
Page 304 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Depends
condition
If you make this monitor dependent on the status of another monitor (by using
the Depends on setting), use this option to select the status condition of the
Depends on monitor for the current monitor to run normally.
The status categories include:
l
Good
l
Error
l
Available
l
Unavailable
The monitor being configured is run normally as long as the monitor selected in
the Depends on box reports the condition selected in this box.
Example: Select Good and this monitor is enabled only when the monitor
selected in the Depends on box reports a status of Good. The current monitor
is automatically disabled if the monitor selected in the Depends on box reports
a category or condition other than Good. You can also enable dependent
monitors specifically for when a monitor detects an error.
Default value: Good
Ignore
dependencies
when
publishing
changes
(available in
Template
mode only)
When template changes are published to the deployed objects, dependency
settings for the selected template group are ignored and the existing
dependency settings in the deployed objects are preserved. For details, see
"Dependencies When Configuring Template Monitors and Groups" on page
273.
Default value: Not selected
Note: When selected, the Depends on field is cleared and is not available.
Threshold Settings
The Threshold Settings panel enables you to set conditions that determine the reported status of
each monitor instance. The status result is based on the results or metrics returned by the monitor
action on the target system during a specified period of time.
Status threshold criteria for each monitor instance can be set for the Error if, Warning if, and
Good if status conditions. You can also set monitor thresholds using a baseline to provide a
comparison for establishing acceptable or expected threshold ranges. For details, see "Setting
Status Thresholds" on page 274.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Threshold Settings.
HP SiteScope (11.23)
Page 305 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Important
information
Relevant
tasks
See also
l
You can apply multiple status threshold criteria for each status condition per
monitor instance. A single monitor instance may have one or more criteria used
to determine Error status, one or more conditions to determine Warning
status, and one or more conditions to indicate Good status. Most monitor
types include one default setting for each of the three status conditions.
l
When setting a baseline threshold, you can only change certain threshold
conditions during the baseline calculation and after the baseline is activated.
For details on the threshold changes that are allowed, see "Changing
Threshold Settings" on page 311.
l
When working with Global Search and Replace, if you select to replace
threshold settings, the Override Category option appears. When selected, all
the threshold settings for the selected monitor instances are overridden with
the settings you entered for the replace operation. If this option is cleared and
you selected to replace threshold settings, the settings you entered are added
to the existing threshold settings for the monitor instances.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Set Monitor Thresholds Using a Baseline" on page 341
l
"How to Create a Calculated Metrics Expression" on page 376
l
"How to Set Combined Threshold Calculated Metrics" on page 377
"Set Monitor Thresholds Using a Baseline" on page 340
User interface elements are described below:
UI Element
Description
New. Creates additional thresholds that determine the Error/Warning/Good
status. For each threshold, select the metric and operator, and enter a value for
the metric.
By default, two thresholds are displayed for the Error status when you first
configure the monitor, and one threshold for the Warning and Good status.
Delete. Deletes the selected threshold.
HP SiteScope (11.23)
Page 306 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
If
Status assignment for when the monitor is not available from the following
unavailable options:
l
Set monitor status according to thresholds. The monitor gets a new status
according to the thresholds.
l
Set monitor status to Good. The monitor's status is set to Good when it is
unavailable without thresholds being checked.
l
Set monitor status to Warning. The monitor's status is set to Warning when
it is unavailable without thresholds being checked.
l
Set monitor status to Error. The monitor's status is set to Error when it is
unavailable without thresholds being checked.
Note: A monitor instance can have a status of Unavailable as well as a status of
Good, Warning, or Error. Alerts are triggered according to availability, status,
or both availability and status, depending on how the alert is configured. For
details, see "Configure SiteScope Alerts" on page 1140.
Default
status
Monitor status (Good, Warning, or Error) if the threshold criteria for the monitor
instance are not met.
Default value: Good
On internal
error
Monitor status assignment if a configuration or internal error occurs:
l
Set monitor status according to Thresholds. The monitor's status is set
according to its current thresholds if a configuration or internal error occurs
(default setting). It is unreliable to rely on the threshold since there is no way of
knowing at what point the error occurred (and whether the threshold is based on
old data, updated data, or both). For example, a monitor may remain in its
current status even though the monitor did not run; change status if thresholds
were defined that were not applicable; or trigger false alerts as if a remote was
not available, when in fact, the remote was not contacted.
l
Set monitor status to Error. The monitor's status is set to Error if a
configuration or internal error occurs without thresholds being checked.
l
Set monitor status to Warning. The monitor's status is set to Warning if a
configuration or internal error occurs without thresholds being checked.
l
Set monitor status to Good. The monitor's status is set to Good if a
configuration or internal error occurs without thresholds being checked.
l
Treat monitor as unavailable. The monitor is treated as being Unavailable
if a configuration or internal error occurs without thresholds being checked.
HP SiteScope (11.23)
Page 307 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Add
Default
Thresholds
Adds default threshold settings to the monitor instance, for the applicable status
categories. Default thresholds are indicated by the (default) label. Default
thresholds are editable only after selecting a condition from the Condition field
(the default condition can be selected). After any criteria of the default threshold is
changed, the (default) label is removed.
Remove
Default
Thresholds
Deletes the default threshold settings (those indicated by the (default) label) from
the monitor instance. Default settings that were added and were subsequently
modified, are not removed.
Threshold
Preview
Opens the Threshold Preview dialog box that displays a preview of thresholds for
static counters and for regular expression patterns translated to actual current
counters. Patterns enable the monitor to automatically configure itself with
counters and thresholds on the relevant dynamic environment components
(currently available for VMware Host monitors).
The table also displays an Indicator State and Severity value for each current
counter translated from a pattern (this value is not available for patterns in
Threshold Settings).
For more details on dynamic monitors, see Dynamic Monitoring Mechanism in the
SiteScope Monitor Reference Guide.
Example: The pattern /.*/VirtualMachine/.*/cpu/usage.average\[\]/
displays the average CPU usage threshold condition for each VM currently being
monitored.
Error if
Conditions for the monitor instance to report an Error status.
Condition
Metrics parameter for determining the status of this monitor instance. The list of
metrics is dynamically updated based on the type of monitor you are configuring.
Default value: Default metrics exist for many monitor types and differ according
to monitor type. For many default metrics, there are corresponding defaults for the
operator and value boxes that are not editable.
HP SiteScope (11.23)
Page 308 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Operator
Metrics operator for determining the status of this monitor instance. The following
operators are available:
l
>= Greater than or equal to
l
> Greater than
l
== Equals
l
!= Not the same as
l
<= Less than or equal to
l
< Less than
l
contains Contains the value entered
l
!contains Does not contain the value entered
Note: To indicate data volatility (where current monitor readings significantly
deviate from previous runs), set status thresholds using a baseline. For details,
see "Set Monitor Thresholds Using a Baseline" on page 340.
Value
Value applicable to the metrics parameter.
Note:
l
If a monitor has an activated baseline, its metrics values are non-editable and
the Percentiles Table
button is displayed. You can change baseline
threshold values by clicking the button and changing the current percentile
value from the Percentiles Table. For user interface details, see "Percentile
Range Mapping Table" on page 357.
l
Schedule
You cannot change the metrics value, operator or schedule for a baseline
threshold condition.
Range schedule to determine the status of this monitor instance if you want to
define when to check the monitor run result against the threshold. This is useful,
for example, if you want to check the monitor run result against the threshold only
on certain days or during peak hours. The range schedules created in Schedule
Preferences appear in the drop-down list. For more information about creating
monitor schedules, see "Schedule Preferences" on page 708.
Default value: every day, all day
Note: When selecting threshold schedules, at least one threshold schedule must
coincide with the Monitor schedule in the Monitor Run Settings (at least one
minute of the monitor run schedule must be covered by one of the threshold
schedules).
HP SiteScope (11.23)
Page 309 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Indicator
State and
Severity
State of the indicator (for example, Bottlenecked), and the severity
corresponding to the indicator state (for example, Critical).
Every indicator can have several states. For example, when measuring CPU
Load, the indicator state might be Bottlenecked or Busy, whereas when
measuring Memory Load, the indicator state might be Paging or Starving for
Memory.
Indicator state and severity level are mapped to metric status according to the
closest available severity that exists in the states for the indicator associated with
the metric. The indicator state and severity values are updated when a different
indicator mapping is selected in the HP Integration Settings panel.
For more information on indicator mappings, see "Indicator Mappings when
Reporting Topology to BSM" on page 276.
Note:
l
SiteScope must be connected to BSM 9.00 or later for the Indicator State and
Severity column to be displayed.
l
Indicator state and severity values are not displayed in SiteScope reports.
l
If the Indicator State and Severity box is empty, the metric is not colored in
Service Health, except for always (default) which is automatically assigned.
l
To display the Indicator State and Severity value for each current counter for
a dynamic monitor (these are the actual counters translated from a regular
expression pattern), click the Threshold Preview button. The indicator state
and severity value is displayed for each actual counter in the Threshold
Preview dialog box.
l
The association between the indicator state and severity cannot be changed on
the local SiteScope server.
l
When there are several indicator states of the same severity associated with a
given metric and threshold, the default state is taken (as it is configured in
BSM's Service Health CI Indicator Repository). If no default state is defined,
an arbitrary state is chosen. For example, if the Host Disk Utilization
indicator is mapped to the MB free metric and the indicator has two Critical
severity states Higher than normal and Lower than normal (and neither is
defined as default), either one of these states can be used as the indicator
state assigned to this threshold.
Warning if
Conditions for the monitor instance to report a Warning status. For each threshold,
select the measurement and operator, and enter a value for the metric.
Good if
Conditions for the monitor instance to report a Good status. For each threshold,
select the measurement and operator, and enter a value for the metric.
HP SiteScope (11.23)
Page 310 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Changing Threshold Settings
You can make changes to threshold conditions according to the baseline status of the monitor
instance.
Monitor
Baseline
Status
Change Threshold Condition
Add/Delete
Threshold
Condition
Not
baselined
You can change any condition of any threshold.
Allowed
In
calculating/
activating
process
You can only change the measurement value for static
thresholds.
Not allowed
Baselined
l
You can change any condition for static thresholds.
l
You can change the percentile value only for baseline
thresholds.
For example, Error if CPU >= 70 every day, all day,
you can only change the value 70 to another value.
Allowed for static
thresholds only
HP Integration Settings
The HP Integration Settings panel enables you to control what data a monitor forwards to the
applications integrated with SiteScope.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select HP Integration Settings.
Important
information
l
The HP Integration Settings panel is displayed only when SiteScope is
integrated with BSM, or when SiteScope is integrated with Operations
Manager (HPOM) and event or metrics integration is enabled. It is not
displayed for EMS Integration monitors.
l
The custom topology is available only if SiteScope is connected to BSM
version 9.00 or later.
l
The indicator settings are available only if SiteScope is connected to BSM
version 9.00 or later or to HPOM.
l
The HP Operations Manager integration settings are available only if an HPOM
integration has been configured and SiteScope is connected to HPOM. For
details on configuring the HPOM Integration, see "HP Operations Manager
Integration Preferences" on page 673.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
HP SiteScope (11.23)
Page 311 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Relevant
tasks
See also
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Configure SiteScope to Communicate with BSM" on page 236
"Integration Preferences" on page 657
HP SiteScope (11.23)
Page 312 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
BSM Integration Data and Topology Settings
This section enables you to select BSM logging options and topology reporting settings for the
monitor instance.
Important
information
Relevant
tasks
See also
l
The BSM logging options are available only if BSM integration is enabled.
l
After upgrading to BSM 9.2x, monitors configured to report status changes no
longer affect BSM's Service Health (except for System Monitors view). This
occurs because status change event samples are sent per monitor which does
not correlate with the measurement-to-indicator mappings. If you were using
status change event samples in Service Health, do the following:
n
Switch to metrics reporting if you do not have an SLM for these events.
n
If both Service Health and SLM are being used for status change event
samples, we recommend upgrading to SiteScope 11.x and switching to event
reporting in addition to reporting status change samples.
l
The Enable reporting changes in status option was removed due to the
introduction of event management in BSM. This option can be enabled for
backward compatibility by changing the property Allow sending monitor
status only to BSM 9.x to =true in Preferences > Infrastructure
Preferences > Custom Settings.
l
BSM logging selection should be based on how much data is relevant to report
to BSM for this monitor and how much space the BSM database has for this
data.
l
For troubleshooting problems involving topology reporting, see BSM Topology
Issues in the Integration with BSM and HPOM Best Practices Guide in the
SiteScope Help.
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Configure SiteScope to Communicate with BSM" on page 236
l
"How to Configure Topology Reporting" on page 242
"Integration Preferences" on page 657
"Troubleshooting/Limitations" on page 226 (for BSM integration data reporting
issues)
HP SiteScope (11.23)
Page 313 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
BSM Logging Options
Disable
reporting
metrics to
BSM
Prevents the status information or metrics for this monitor being transferred to
BSM or temporarily disables reporting this monitor to BSM.
Enable
reporting
monitor
status and
metrics
Sends all monitor data to BSM for each time that the monitor runs. This option
enables the largest data transfer load.
Enable
reporting
monitor
status (no
metrics)
Sends only monitor category (error, warning, good), status string, and other
basic data for each time that the monitor runs. No information on specific
performance counters is included.
Enable
reporting
monitor
status and
metrics with
thresholds
Sends monitor data to BSM for only those metrics counters that have configured
thresholds (for example, Error If, Warning If, Good if). The data is sent for
each time that the monitor is run.
Default value: Selected
Note: This option is supported only for backward compatibility with legacy SLM,
and not for Service Health.
Topology Settings
HP SiteScope (11.23)
Page 314 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Report
monitor and
related CI
topology
SiteScope reports monitor and related CI topology data to BSM's RTSM (Runtime Service Model). The data that SiteScope forwards depends on the monitor
type. This option enables SiteScope to:
l
Discover topologies and forward specific CI data for the monitors that monitor
applications from among a group of supported environments. For details and a
list of these supported environments, see "Report Discovered Topologies to
BSM" on page 233.
l
Report Computer CI data for those monitors that monitor hosts (SiteScope
sends Computer CI type for each monitored host). If this option is selected,
the monitor creates a topology that includes the host as a CI in BSM's RTSM.
l
Report CI data based on the user-defined CI type and key attribute values.
If this option is cleared, the monitor and related CI topology data is not reported to
BSM, and the Indicator Settings section is unavailable.
For details on how SiteScope reports data to RTSM, see "Integrate SiteScope
Data with BSM's Configuration Items" on page 228.
Note: If SiteScope is connected to BSM (and you have an Event Management
Foundation license), and sending events is enabled, hosts are reported to BSM
through Operations Management.
Default value:
l
Selected for monitors of supported environments and monitors that have a CI
type defined by default.
l
Cleared for monitors that do not have a topology defined by default. For a list
of these monitors, see "Monitors Not Reporting Topology Data By Default" on
page 254.
HP SiteScope (11.23)
Page 315 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
CI type
The monitor's topology that is used for reporting data to BSM's RTSM. You can
link between this monitor instance and any existing, logical configuration item
type (CIT) in BSM's RTSM. This link or relationship enables the monitor to pass
KPI status to the CI to which it is linked.
The CI type indicates the following:
l
Default (<CI type>). The default CI type for the monitor (for most monitors,
the default CI type is Computer). For a list of monitors where the default CI
type is not Computer, see "Report Discovered Topologies to BSM" on page
233.
CI types include BusinessApplication, BusinessService, DB2,
InfrastructureService, JBoss AS, Node, Oracle, Oracle iAS, SQL Server,
Sybase, Unix, WebLogic AS, WebSphere AS, and Windows.
From SiteScope 11.23, added support for the generic Running Software CI
type. This CI type can reconcile with any of its descendant CI types such as
Database, Application Server, Web Server and so forth (for the full list of
descendant CI types, see the RTSM documentation).
l
Default (Multiple). The monitor has multiple CIs (this is where the CI type is
per metric). The CI type for these monitors is fixed and cannot be modified.
For a list of these monitors, see "Monitors Reporting CI Per Metric" on page
255.
l
None. The monitor instance is not linked to a CI type. For a list of these
monitors, see "Monitors Not Reporting Topology Data By Default" on page
254. You can select a CI type from an RTSM view to link to this monitor
instance. For details on selecting and working with views, see "Working with
the CI Selector" in the Modeling Guide in the BSM Help.
Note:
l
This setting is active only when Report monitor and related CI topology is
selected.
l
After a CI type is selected, the Indicator Settings table is filtered to show
mappings that exist for the selected CI type only.
HP SiteScope (11.23)
Page 316 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
<CI type key
attributes>
CI type key attributes are displayed according to the CI type selected for the
monitor instance. Enter the key attribute values for the selected CI type:
l
Server. Container CI for the selected CI. This attribute is required for DB2,
JBoss AS, Oracle, Oracle iAS, SQL Server, Sybase, WebLogic AS,
WebSphere AS, and Windows CI types.
l
Name. Name of the CI (for BusinessApplication, BusinessService,
Computer, DB2, InfrastructureService, JBoss AS, Oracle, Oracle iAS, SQL
Server, Sybase, WebLogic AS, and WebSphere AS CI types).
l
Organization Type. Identifier used to differentiate levels within an
organization. This attribute is required for BusinessApplication,
BusinessService, and InfrastructureService CI types.
l
Organization Name. Name of the organization. This attribute is required for
BusinessApplication, BusinessService, and InfrastructureService CI types.
Note:
l
This setting is active only when Report monitor and related CI topology is
selected.
l
CI key attributes are not available for monitors where the CI type is per
metric. For a list of these monitors, see "Monitors Reporting CI Per Metric" on
page 255.
l
When upgrading to SiteScope 11.23 or later, SiteScope is unable to update
custom topology for a monitor that had BusinessElement CIs if there was an
error in the Organization Type field, such as a spelling mistake or the wrong
parameter was defined. There will be an empty value in this field.
Workaround: After performing the upgrading, select the required
Organization type from the drop down list.
Indicator Settings
This section displays the metrics for the SiteScope monitor type and the health indicators (HIs) and
event type indicators (ETIs) to which the metric is assigned. Indicators provide a more detailed
view of the health of a configuration item (CI) when the monitor's topology is reported to BSM's
RTSM. The Indicator Settings table is filtered to show mappings for the monitor instances that exist
for the selected CI type only.
HP SiteScope (11.23)
Page 317 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Important
information
Relevant
tasks
See also
Indicator Settings are available only if Operations Manager event integration or
BSM integration is enabled, and:
l
n
The Report monitor and related CI topology setting is selected in BSM
Integration Data and Topology Settings section.
n
The monitor has default metric-to-indicator mappings. For a list of monitors
that do not have default indicator mappings, see "Monitors Not Reporting
Topology Data By Default" on page 254.
l
Indicator mappings for monitors that report CI type per metric (where CI type is
displayed as Default (Multiple)) cannot be added/deleted from the Indicator
Settings panel. Mappings for these monitor types can only be added/deleted
from BSM (SAM Admin > Metrics and Indicators tab). For a list of these
monitors, see "Monitors Reporting CI Per Metric" on page 255.
l
The indicator assignments table in SiteScope might contain assignments that
do not exist in the Indicator Assignments repository in BSM. This is because
mappings that are incorrectly defined in BSM are not validated when they are
downloaded to SiteScope (whereas they are validated, and therefore, not
displayed in BSM).
l
Only advanced users with a thorough knowledge of CIs and indicators should
attempt to edit any of the indicator mappings or to add mappings to metrics.
l
If any of the settings in the indicator mapping table are modified by a user, a
note to indicate this is displayed below the table.
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Configure Topology Reporting" on page 242
"Integrate SiteScope Data with BSM's Configuration Items" on page 228
User interface elements are described below:
New. Enables you to add a metric-to-indicator mapping to a monitor instance based
on the monitor type.
Note: This button is not available for monitors that have multiple CI types (see
"Monitors Reporting CI Per Metric" on page 255). Indicator mappings for these
monitors can only be added from BSM (SAM Admin > Metrics and Indicators tab).
Delete. Deletes the selected metric-to-indicator mapping.
Note: This button is not available for monitors that have multiple CI types (see
"Monitors Reporting CI Per Metric" on page 255). Indicator mappings for these
monitors can only be removed from BSM (SAM Admin > Metrics and Indicators
tab).
HP SiteScope (11.23)
Page 318 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Reset to Default. Resets the metric-to-indicator mapping for the monitor type to the
default mappings included in your current version of SiteScope. Indicators mappings
are stored in a central repository in System Availability Management (SAM) in BSM.
SiteScope checks every 5 minutes to see if the mappings in SAM have changed, and
if they have, downloads the latest mappings.
If indicator mappings on a local SiteScope server have been modified, these
mappings are not overridden by the centralized mappings when the topology is next
reported to BSM.
For details on modifying the centralized mappings, see "Indicator Assignments
Overview" in in the BSM Application Administration Guide in the BSM Help.
Move Down. Enables you to change the sort order of the indicator mappings by
moving the selected indicator mapping down the list. If the mapping order is changed
locally, the local mapping order is not overridden when mapping changes are
downloaded from the Indicator repository in SAM Administration.
Move Up. Enables you to change the sort order of the indicator mappings by moving
the selected indicator mapping up the list. If the mapping order is changed locally, the
local mapping order is not overridden when mapping changes are downloaded from
the Indicator repository in SAM Administration.
Metric
Pattern
Displays the metrics name, or a regular expression pattern based on the metric
name, mapped to the indicator of this monitor instance. You can modify an existing
mapping or create a new one. Where there is more than one CI type for the same
regular expression, they are displayed in different rows. For details on using regular
expressions, see "Regular Expressions" on page 192.
Note: The list of available metrics is dynamically updated based on the type of
monitor you are configuring. Default metrics exist for many monitor types and differ
from one type to another.
CI Type
Displays the CI type selected for the monitor instance (the Indicator Settings table is
filtered to show mappings that exist for the selected CI type only).
Note: This field is not editable.
Indicator Displays the indicator mapping for the metric. In the drop-down list, health indicators
are displayed above the divider line, and event type indicators below the line.
HP Operations Manager Integration Settings
This section enables you to configure SiteScope to send events and report metrics to the
HP Operations agent. The agent is required for sending events to HPOM and BSM's Operations
Management, and for reporting metrics to Performance Manager (a reporting component of HPOM)
and Performance Graphing (in Operations Management). It also enables you to select the event
preference mapping that is used for sending events for the monitor instance.
HP SiteScope (11.23)
Page 319 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Important
These settings are available only if the HP Operations agent is installed and
information connected to an HPOM server, and event/metrics integration is enabled in the
Operations Manager Integration dialog box.
Relevant
tasks
See also
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Configure Common Event Mappings for HPOM or BSM" on page 563
l
For details on how to enable SiteScope to send events to HPOM or Operations
Management, or how to enable SiteScope to report metrics using the HP
Operations agent, see Integrating SiteScope with HP Operations Manager
Products in the SiteScope Help. You can check the HP Software Integrations
site to see if a more updated version of this guide is available:
For Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39
For UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628
l
"Integration Preferences" on page 657
l
"Common Event Mappings" on page 562
User interface elements are described below:
Report
metrics to
HP
Operations
agent
Enables SiteScope to report metrics for the monitor instance to the HP Operations
agent, from which HPOM and Operations Management (in BSM) can collect the
data.
Note: Monitor metrics are sent to the agent only if metrics integration is enabled in
the Operations Manager Integration dialog box. For user interface details, see "HP
Operations Manager Integration Preferences" on page 673.
Default value: Selected if metrics integration is enabled (otherwise this setting is
not available).
Send
events
Enables sending events to HPOM or Operations Management (in BSM) when
there is a change of a counter/metric status (Good/Warning/Error/Unavailable)
for the monitor instance. Status change is only applicable on counters or metrics
that are configured in the monitor's Threshold Setting.
Note: This setting is available only if the HP Operations agent is installed and
connected to an HPOM or BSM server, and event integration is enabled in the
Operations Manager Integration dialog box. For user interface details, see "HP
Operations Manager Integration Preferences" on page 673.
Default value: Selected if event integration is enabled (otherwise this setting is
not available).
HP SiteScope (11.23)
Page 320 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Manually
send first
event
When creating a new monitor in a SiteScope connected to BSM, it is possible that
the first event is triggered before the topology is reported to BSM, and the event is
lost from the Service Health perspective (it is still shown in the Operations
Management Event Browser). Select this option to avoid waiting for the next event
to be sent. The event is resent during the next monitor run, regardless of the
monitor's metrics reaching their status change conditions.
Default value: Not selected
Note:
l
This option is automatically disabled after the monitor run.
l
You can configure this setting globally using Global Search and Replace.
BSM Service Health Preferences
This section enables you to configure the preference for influencing BSM's Service Health when
both SiteScope events and metrics are reported to BSM.
Important
This setting is available only when:
information
l Both BSM and Operations Manager integrations are active, and are connected
to the same BSM server (the BSM server is used instead of the HPOM server).
The following settings are selected in the monitor's HP Integration Settings:
l
n
In BSM Integration Data and Topology Settings: Enable reporting monitor
status and metrics or Enable reporting monitor status and metrics with
thresholds, and
n
In HP Operations Manager Integration Settings: Send events.
Note:
l
If only Send events is selected, the BSM Service Health affected by
preference is set to Events.
l
If only Report monitor and related CI topology is selected, the BSM
Service Health affected by preference is set to Metrics.
l
If both are selected, Metrics is the default preference.
HP SiteScope (11.23)
Page 321 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Relevant
tasks
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Configure Topology Reporting" on page 242
l
"How to Enable SiteScope to Send Events to HPOM or Operations
Management" in Integrating SiteScope with HP Operations Manager Products
in the SiteScope Help. You can check the HP Software Integrations site to see
if a more updated version of this guide is available
For Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39
For UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=62
User interface elements are described below:
BSM
Select the preference (events or metrics) for influencing BSM's Service Health when
Service both SiteScope events and metrics are reported to Service Health (since indicators for
Health
SiteScope events and metrics both affect CIs).
affected
l Metrics. If selected, each SiteScope metric affects CIs in BSM (status change
by
events reported by SiteScope do not have any influence on CIs in Service Health).
l
Events. If selected, only status change events affect CIs in BSM's Service Health
(SAM reports for the monitored CIs are still based on metrics).
For more information on choosing the preference to use, see Integrating SiteScope
with BSM in Integration with BSM and HPOM Best Practices in the SiteScope Help.
Default value: Metrics
Note: You can also configure a global default preference (events or metrics) for all new
monitors created when configuring the Operations Manager integration. For details,
see Prefer events over metrics in BSM Service Health (global preference) in "HP
Operations Manager Integration Preferences" on page 673.
Event Mapping Settings
The Event Mapping Settings panel is used for selecting a template for mapping SiteScope runtime
data to the attribute values that are used for sending events for the monitor instance.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Event Mapping Settings.
HP SiteScope (11.23)
Page 322 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Important
information
Relevant
tasks
See also
l
The Event Mapping Settings panel is available only if the HP Operations agent
is installed and connected to an HPOM or BSM server, and event integration is
enabled in the HP Operations Manager Integration dialog box, or when a
Generic Event Integration is configured in Integration Preferences. For user
interface details, see "HP Operations Manager Integration Preferences" on
page 673.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Configure SiteScope Generic Event Integration" on page 687
l
"Generic Event Integration Preferences" on page 686
l
"HTTP Preferences" on page 596
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Description
Event
Select the desired event mapping template, or use the default mapping. Click New or
mapping Edit to open the Common Event Mappings dialog box and configure a new event
preference or modify an existing one. For user interface details, see "New/Edit Event
Mappings Dialog Box" on page 565.
Note: When editing an event mapping from here, it changes the event pattern for all
monitors using this template. We recommend creating a new event mapping if you
want a specific monitor to report different attributes.
Enable/Disable Monitor
The Enable/Disable Monitor panel enables you to set the status (enabled/disabled) for the selected
monitor.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Enable/Disable Monitor.
HP SiteScope (11.23)
Page 323 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Important
information
l
HTML code entered in the monitor description fields is checked for validity and
security, and corrective action is taken to fix the code (for example, code is
truncated if it spans more than one line). If malicious HTML code or JavaScript
is detected, the entire field is rejected.
l
The Monitor Downtime table is displayed only when SiteScope is connected to
BSM if the selected monitor is affected by a CI currently in downtime. For
details, see "CI Downtime" on page 235.
l
When publishing changes to a template that contains a custom monitor, the
monitor is temporarily disabled before changes are published, and is restored
to the enabled state after changes have been made.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
Relevant
tasks
"How to Create and Deploy a Monitor" on page 277
See also
"Enable/Disable Monitors in Group Dialog Box" on page 1029
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
Enable monitor
Enables the monitor if the monitor was previously disabled.
Default value: Selected
Disable monitor
Disables the monitor. When a monitor has been disabled, SiteScope
continues to schedule the monitor to run based on the Frequency setting for
the monitor but the monitor action is not run. SiteScope records a monitor
data log entry for the monitor when it was scheduled to be run but reports the
monitor status as disabled in the place of metrics data.
Disable monitor
for the next
<time period>
Time period that the monitor should remain disabled. Select Seconds,
Minutes, Hours, or Days to define the disable time period as applicable.
Disable monitor
on a one time
schedule from
<time> to
<time>
Temporarily disables the monitor for a time period in the future. The time
period can span more than one day.
Disable
description
Optional descriptive text that appears as part of the monitor status in the
monitor group display. The disable status text also includes a string
indicating which disable option is in force for the monitor, for example
Disabled manually indicates that the monitor was disabled using the
Disable monitor option.
HP SiteScope (11.23)
Enter or select the start time and end time for the disable period using the
format: hh:mm:ss mm/dd/yyyy.
Page 324 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Monitor Downtime Table
(This table is displayed only when SiteScope is connected to BSM if the selected monitor is
affected by a CI currently in downtime. For details, see "CI Downtime" on page 235.)
Downtime
Name
The name of the downtime as configured in the BSM Downtime wizard.
Downtime
Description
A description of the downtime if entered in the BSM Downtime wizard.
Current
Occurrence End
Date
Date and time that the current downtime occurrence is scheduled to end.
Enable/Disable Associated Alerts
The Enable/Disable Associated Alerts panel enables you to set the status (enabled/disabled) for
associated alerts.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Enable/Disable Associated Alerts.
Important
information
l
HTML code entered in the monitor description fields is checked for validity and
security, and corrective action is taken to fix the code (for example, code is
truncated if it spans more than one line). If malicious HTML code or JavaScript
is detected, the entire field is rejected.
l
The Associated Alerts Downtime table is displayed only when SiteScope is
connected to BSM if the monitor is affected by a CI that is currently in
downtime, and the downtime applies to associated alerts of the monitor. For
details, see "CI Downtime" on page 235.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Configure an Alert" on page 1144
Relevant
tasks
See also
"Configure SiteScope Alerts" on page 1140
User interface elements are described below (unlabeled elements are shown in angle brackets):
HP SiteScope (11.23)
Page 325 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
UI Element
Description
Enable all associated alerts
Enable the alerts if the alerts associated with this monitor were
previously disabled.
Default value: Selected
Disable all associated
alerts indefinitely
Prevents SiteScope from executing the alert action even if the
alert condition is met until this radio button is cleared and the
alert definition is updated.
Note: Use of this option may result in loss of expected alert
capability if the alert is disabled to accommodate a temporary
condition. It is important to review this status at a later time, and
to manually enable the alert definition as necessary.
Default value: Not selected
Disable all associated
alerts for the next <time
period>
Time period that the associated alerts should remain disabled.
Select Seconds, Minutes, Hours, or Days to define the disable
time period as applicable.
Default value: Not selected
Disable all associated
alerts on a one time
schedule from <time> to
<time>
Temporarily disables the associated alerts for a time period in
the future. The time period can span more than one day.
Enter the start time and end time for the disable period using the
format: hh:mm:ss mm/dd/yyyy.
Default value: Not selected
Disable description
Optional descriptive text.
Associated Alerts Downtime Table
(This table is displayed only when SiteScope is connected to BSM if the monitor is affected by a
CI that is currently in downtime, and the downtime applies to associated alerts of the monitor. For
details, see "CI Downtime" on page 235.)
Downtime Name
The name of the downtime as configured in the BSM Downtime
wizard.
Downtime Description
A description of the downtime if entered in the BSM Downtime
wizard.
Current Occurrence End
Date
Date and time that the current downtime occurrence is
scheduled to end.
Search/Filter Tags
The Search/Filter Tags panel enables you to add a new search/filter tag, and assign the tag to
objects in the context tree and preference profiles. Keyword tags are used to search and filter
SiteScope objects (groups, monitors, remote servers, templates, and preference profiles). If no
HP SiteScope (11.23)
Page 326 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
tags have been created for the SiteScope, this section appears but is empty. If tags have been
created, they are listed here and you can select them as required.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Search/Filter Tags.
Important
information
l
You can edit existing tags in the Preferences context (Preferences >
Search/Filter Tags). For details on this topic, see "Search/Filter Tags" on
page 714.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
l
"How to Create and Deploy a Monitor" on page 277
l
"Search SiteScope Objects" on page 88
Relevant
tasks
See also
"Search SiteScope Objects" on page 88
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
Description
<Tag
name
and
values>
Displays the tag names and tag values if tags have been created. Select the tags or
tag values that you want to assign to the object. If no tags have been created for the
SiteScope, this section appears but is empty.
Add
Tag
Opens the New Tag dialog box, enabling you to add new keyword tags. For user
interface details, see "New/Edit Tag Dialog Box" on page 93.
Baseline Settings
The Baseline Settings panel displays the baseline status for the selected monitor.
To access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the
Properties tab, and select Baseline Settings.
Important
information
l
Baseline Settings are not available for monitors that use the dynamic
monitoring mechanism to update thresholds settings.
l
For buttons common to all panes, see "Common Monitor Settings" on page
298.
l
"How to Create and Deploy a Monitor" on page 277
l
"How to Set Monitor Thresholds Using a Baseline" on page 341
Relevant
tasks
See also
"Set Monitor Thresholds Using a Baseline" on page 340
HP SiteScope (11.23)
Page 327 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
User interface elements are described below:
UI
Element
Description
Baseline The monitor's baseline status. The following statuses are available:
status
l Monitor not selected for baselining. The monitor has not been selected for
baselining.
l
Calculating baseline.SiteScope is in the process of calculating the baseline.
l
Calculation failed.SiteScope was unable to calculate a baseline.
l
Calculated, not activated. A baseline was calculated for the monitor, but it has
not yet been activated.
l
Activating baseline.SiteScope is in the process of activating the baseline.
l
Activation failed.SiteScope was unable to activate the baseline.
l
Baseline activated. The baseline has been activated for the monitor.
The Baseline mode check box is selected if the baseline status is anything other
than Monitor not selected for baselining.
For details on using the baseline threshold, see "Set Monitor Thresholds Using a
Baseline" on page 340.
Remove Removes the baseline threshold. The baseline thresholds are removed and the static
Baseline threshold value is used to create a threshold. You must remove the baseline before
you can calculate the baseline after a baseline has been calculated (even if the
calculation failed).
For details on this topic, see "Set Monitor Thresholds Using a Baseline" on page 340.
Logging Settings
The Logging Settings panel enables you to create a dedicated log file with a specified log level for
each monitor instance and view that log file.
To
access
Select the Monitors context. In the monitor tree, expand the group folder that
contains the monitor, and select the monitor. In the right pane, click the Properties
tab, and select Logging Settings.
Relevant "How to Create and Deploy a Monitor" on page 277
tasks
See also
"Log Files Page" on page 1093
"Log Preferences" on page 697
HP SiteScope (11.23)
Page 328 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
User interface elements are described below:
UI
Element
Enable
separate
log for
this
monitor
Description
Enables sending log data to a dedicated log file for that monitor instance in the
<SiteScope root directory>\logs\monitor_runs folder. This folder contains one
file per monitor instance. The format of log file names is determined according to
the monitor path in the SiteScope tree, as follows: SiteScope_<monitorGroup>_
<monitorName>.log. After each monitor run, this log file appears on the Log File
page. For details, see "Log Files Page" on page 1093.
When this is disabled, log data for the selected monitor is not sent to the dedicated
monitor log file. However, log data is still sent to general log files (for example,
error.log or RunMonitor.log), together with log data from all other monitors.
Note:
Log level
l
To enable a separate log for this monitor (and for all other monitors where
monitor instance logging is enabled), the Disable separate logging for
monitors check box must be cleared in Preferences > Log Preferences (the
setting is cleared by default). If the separate logging for monitors option is
disabled in Log Preferences, a warning is displayed in the Logging Settings
panel when you enable logging for a monitor instance, and you must first clear
the Disable separate logging for monitors check box in Log Preferences.
l
The <SiteScope root directory>\logs\monitor_runs folder contains log data
from the last run of the monitor instance. Historical monitor instance log data is
stored in general log files.
Select DEBUG, INFO, WARN, ERROR, or FATAL. Your selection determines
which log messages for this monitor instance are sent both to the dedicated log file
for the selected monitor instance and to the general log files. For more details about
log levels, see "Log Levels" below.
You can select a log level only if Enable separate log for this monitor is
enabled. If Enable separate log for this monitor is disabled, the log level for all
monitors is determined by the log4j.properties file.
Enable
Enables debugging for perfex process. For details about perfex process, see
debugging "Perfex Process Pool Page" on page 1099.
for perfex
You can enable debugging for perfex process only if Enable separate log for this
process
monitor is enabled.
View Log
Click to view the log. The log appears only if there is data for the selected log level.
Log Levels
Log levels operate hierarchically, meaning that some log levels also produce results for other log
levels, as follows:
HP SiteScope (11.23)
Page 329 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Log level writes messages for the
following log levels:
DEBUG
DEBUG INFO WARN
X
INFO
ERROR
FATAL
X
X
X
X
X
X
X
X
X
X
X
X
X
WARN
ERROR
FATAL
X
Select Depends On Monitor Dialog Box
This dialog box enables you to make the running of this monitor or monitor group dependent on the
status of another monitor.
To
access
Select the Monitors context. In the monitor tree, select a monitor, and click the
Properties tab. Expand the Dependencies tab, and click Depends on
the monitor on which to you want to create a dependency.
. Select
Relevant "How to Create and Deploy a Monitor" on page 277
tasks
See also
l
"Monitoring Group Dependencies" on page 272
l
"Monitor Tree" on page 43
User interface elements are described below:
UI
Element Description
Represents an individual SiteScope server.
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
appears next to the group icon.
symbol
Represents a SiteScope monitor (enabled/disabled).
If an alert has been set up for the monitor, the alert
monitor icon.
symbol appears next to the
Represents the collection of available health monitors that are deployed to check
proper functioning of SiteScope monitors.
Parent: SiteScope.
HP SiteScope (11.23)
Page 330 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Select Template Dialog Box
This dialog box enables you to select the templates you want to deploy to the monitor group.
To access
Select the Monitors context. In the monitor tree, right-click the group into which
you want to deploy a template, and select Deploy Template or Deploy Template
Using CSV.
Important
information
l
Templates that do not contain any child objects (subgroups, monitors,
variables, or a remote server) are not displayed in the template tree.
l
Solution templates are not displayed in the Select Template dialog box and can
be deployed from the Template context only. For details, see "How to Deploy a
SiteScope Solution Template" on page 887.
Relevant
tasks
"How to Create a Monitoring Structure Using a Template" on page 782
See also
l
"Publish Changes to User-Defined Templates" on page 849
l
"Deploy Solution Templates" on page 882
l
"Monitor Tree" on page 43
l
"Template Tree" on page 56
User interface elements are described below:
UI
Element Description
Represents the SiteScope root group.
Represents a template container. A template container is used to organize
configuration deployment templates. Expand to display the templates.
Represents a template configuration for deploying SiteScope objects. Select the
templates that you want to deploy. You can select multiple templates using the CTRL
or SHIFT keys.
Copy to Template Tree Dialog Box
This dialog box enables you to copy a SiteScope object (group, monitor, or remote server) and its
contents (monitors, alerts, and reports) to a template or template group.
To access
In the monitor or remote server tree, right-click the object you want to copy to a
template, and select Copy to Template. In the Copy to Template Tree dialog
box, select the destination to which to copy the template object.
HP SiteScope (11.23)
Page 331 of 1293
Using SiteScope
Chapter 24: Create Monitors in SiteScope
Important
information
l
You can copy a group and its contents to a template provided the template
does not already contain a group.
l
When copying a server monitor to a template, SiteScope replaces the server
name with the $$SERVER_LIST$$ variable.
Tip: We recommend creating a remote server in the template after copying the
monitor to the template, and replacing the $$SERVER_LIST$$ variable with this
remote server.
l
The Web Script Monitor is not supported in template mode.
Relevant
tasks
"How to Create a Monitoring Structure Using a Template" on page 782
See also
l
"Monitor Tree" on page 43
l
"Template Tree" on page 56
User interface elements are described below:
UI
Element Description
Represents an individual SiteScope server.
Represents a template container. A template container is used to organize
configuration deployment templates.
Template containers can hold templates only.
Represents a template configuration for deploying SiteScope objects.
You can copy a template group (provided the template does not already contain a
group), or a remote server to a template group.
Represents a SiteScope monitor group or subgroup (with enabled monitors/with no
monitors or no enabled monitors).
You can copy a template group or monitor to a template group.
If a group alert has been set up for the monitor group or subgroup, the alert
appears next to the group icon.
HP SiteScope (11.23)
symbol
Page 332 of 1293
Chapter 25: Create Custom 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. This provides you with greater flexibility that is not available in existing monitors.
Tip: You can view guided and narrated demonstrations for using the WMI Custom monitor on
the HP Videos channel on YouTube:
l
Custom WMI Monitor Creation Process and Packaging http://www.youtube.com/watch?v=bB6NlTGdd88
l
Custom WMI Monitor Data Processing Script http://www.youtube.com/watch?v=GIw3JVnunWE
To access
Select the Monitors context. In the monitor tree, right-click a group, select New > Monitor, and
select one of the custom monitors (see "List of Custom Monitors" on page 335).
Learn About
Custom Monitor Overview
You can use the Custom monitors to:
l
Collect data that is not available in existing monitors
You can create your own customized monitor that collects data and processes the results of the
collected data to create new metrics.
l
Process the collected data
The collected data is processed using a script you defined in the monitor. Each time the monitor
runs, the script extracts and processes the results of the collected data, and updates and returns
a status for the metrics defined in the script.
For example, you can define metrics based on data collected from a database, and perform
mathematical operations on it. When creating a script, you can use Java code developed by
yourself or by a third-party to process the data.
Tip:
n
Sample scripts for all the custom monitors are available from the sample content
package located in the <SiteScope installation directory>\examples\
monitors\custom folder. CustomMonitorSamplePackage.zip contains examples for
HP SiteScope (11.23)
Page 333 of 1293
Using SiteScope
Chapter 25: Create Custom Monitors
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 details, see "How to import
and use a customizable monitor" for the specific custom monitor in the SiteScope
Monitor Reference Guide.
n
l
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).
Debug custom monitors remotely on a local machine
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
"Debug Custom Monitors on a Local Machine" on page 338.
l
Collect data dynamically (for query-based custom monitors)
You can include dynamically-defined queries in the data processing script. These queries are
executed while the script is running, in contrast to predefined queries, which are executed before
the script is run.
Dynamically-executed queries provide the added benefit of enabling you to create queries based
on values that are not in the monitored entity data store (for example, timestamp), create queries
based on previous query results or calculations, and include variables in queries. For details, see
"Data Processing Script with Dynamic Queries" on page 337.
l
Customize how results are displayed
You can determine how results are displayed. For example, whether result data is displayed in
megabytes or kilobytes.
After developing the monitor, you can:
l
Define thresholds for new metrics
Since some metrics are only defined during a script run, you cannot define thresholds for them in
advance. Once 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.
HP SiteScope (11.23)
Page 334 of 1293
Using SiteScope
Chapter 25: Create Custom Monitors
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. For details on creating
content packages, see "SiteScope Content Packages" on page 815.
The content package can then be sent to specific users, or shared with other SiteScope users
by publishing it to the HP Live Network (https://hpln.hp.com/group/sitescope) community. For
details, see "Share Content on the HP Live Network" on page 878.
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.
This section also includes:
l
"List of Custom Monitors" below
l
"Topology Reporting" on the next page
l
"Indicator Settings" on the next page
l
"Data Processing Script" on the next page
l
"Data Processing Script with Dynamic Queries" on page 337
l
"Debug Custom Monitors on a Local Machine" on page 338
l
"Tips/Troubleshooting" on page 338
List of Custom Monitors
Monitor
Name
Description
Custom
Monitor
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.
Custom
You can create your own database monitor by developing queries (static or
Database dynamically-defined) that collect data, and a script that processes the collected data
Monitor
and creates metrics.
Custom
Log File
Monitor
You can create your own Log File monitor that scans for matches in the form of text
phrases or regular expressions, and a script that processes the collected data and
creates metrics.
Custom
WMI
Monitor
You can create your own WMI monitor by developing WMI Query Language (WQL)
queries (static or dynamically-defined) that collect data, and a script that processes
the collected data and creates metrics.
For details on custom monitors, see the specific monitor in the SiteScope Monitor Reference.
HP SiteScope (11.23)
Page 335 of 1293
Using SiteScope
Chapter 25: Create Custom Monitors
Topology Reporting
You can enable SiteScope to report monitor and related CI topology data to BSM's RTSM by
selecting Report monitor and related CI topology in the HP Integration Settings panel for the
custom monitor, and configuring the topology reporting settings in the BSM Integration Data and
Topology Settings section. This defines how SiteScope reports CIs to BSM.
You can report the following types of CI topology data:
l
User-defined CI type topology. You select a CI type and define the key attribute values for the
selected CI type. For details on key attribute values, see "<CI type key attributes>" on page
317.
l
Custom topology script. You create the topology script which defines how to report CIs to BSM.
Only select this option if you are familiar with the Jython language, because you must create the
topology script in Jython yourself. For task details, see "How to Configure Custom Topology for
a Custom Monitor" on page 247.
l
If you do not want to report topology for the monitor, you can choose to report the monitor CI
only.
For more details on configuring topology reporting settings, see "How to Configure Topology
Reporting for a Custom Monitor" on page 244.
Indicator Settings
The table in the Indicator Settings section of HP Integration Settings displays indicator settings for
the selected CI type. Indicators provide a more detailed view of the health of a CI when the
monitor's topology is reported to BSM's RTSM. You can add new metric mappings or edit settings
for existing mappings. For task details, see "How to Configure Topology Reporting" on page 242.
Data Processing Script
In the script you develop, you can use Java code developed by yourself or by a third-party. You can
store Java objects in the monitor storage.
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).
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" for the specific custom monitor (in the SiteScope Monitor Reference Guide).
Note: When working in template mode, you can use template variables in a data processing
script.
Sample Scripts
SiteScope provides a sample data processing script in the Data Processing Script box for each
custom monitor. You need to uncomment the script in order to use it.
Sample scripts for all the custom monitors are available from
CustomMonitorSamplePackage.zip and CustomMonitorsExamples_11_21.zip in the
HP SiteScope (11.23)
Page 336 of 1293
Using SiteScope
Chapter 25: Create Custom Monitors
<SiteScope installation directory>\examples\monitors\custom\ folder. To use these scripts,
you need to import the custom monitor content package and then deploy the custom monitor
template. For details, see "How to Develop a Custom Monitor" for the specific custom monitor (in
the SiteScope Monitor Reference Guide).
Script Log File
SiteScope provides a custom monitor log which you can use for script debugging purposes. The log
file (custom_monitor.log) is located in <SiteScope root directory>\logs\custom_monitors.
This log can be used for info, warning, error, and debug messages from running the script.
Data Processing Script with Dynamic Queries
Note: This section is applicable to the Custom Database and Custom WMI monitors only.
When creating query-based custom monitors, you can include dynamically-defined queries in the
data processing script. Dynamic queries are executed while the script is running, in contrast to
predefined queries which are executed before the script is run. Dynamically-defined queries have
the same syntax and structure as the queries predefined in the queries table.
Using dynamically-defined queries provides the following benefits:
l
You can create queries based on values that are not in the monitored entity data store. For
example, timestamp.
l
You can create queries based on previous query results.
l
You can include variables in queries.
Flow of a monitor run with dynamic queries
When a custom monitor with dynamic queries is run, the following sequential flow takes place:
1. The predefined queries in the queries table are executed by the monitor, and the data returned
is passed to the script engine.
2. The script engine starts to execute the script.
3. If a query is encountered in the script, the script engine hands it over to the monitor to execute,
and stops the script execution.
4. The monitor executes the query on the monitored entity, and returns the data to the script
engine.
5. The script engine resumes the script execution.
Sample Script with Dynamic Queries
For a sample data processing script containing dynamic queries, see the sample content package,
CustomMonitorsExamples_11_21.zip in the <SiteScope installation
directory>\examples\monitors\custom folder. To use these example scripts, you need to import
the custom monitor content package and then deploy the custom monitor template. For details, see
HP SiteScope (11.23)
Page 337 of 1293
Using SiteScope
Chapter 25: Create Custom Monitors
"How to Develop a Custom Monitor" for the specific custom monitor (in the SiteScope Monitor
Reference Guide).
Debug Custom Monitors on a Local Machine
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. Offline debugging provides full
simulation of the remote system code execution without the need for an open connection to the
debugged system. As a result, there is minimal impact on the remote machine CPU and memory
resources.
To perform offline debugging, you must install and configure the Custom Monitor Debugger Eclipse
project on a local machine. The debugger project is available from <SiteScope root
directory>\examples\monitors\custom\CustomMonitorDebuggingEclipseProject or from the
HP Live Network.
For task details, see "How to Debug a Custom Monitor Offline" for the specific custom monitor in
the SiteScope Monitor Reference Guide.
Tasks
See the Tasks section for the relevant custom monitor in the SiteScope Monitor Reference.
Tips/Troubleshooting
General Tips/Limitations
l
If a user-defined or imported Java package has the same name as an existing SiteScope or
standard Java package, SiteScope ignores the user-defined/imported Java package.
l
When setting custom monitor metrics with a string (non-numeric) value, the maximum and
average values in the Measurement Summary table of the Management Report are shown as
'n/a'. This also occurs if you change the metric value type, for example, if you set the metric with
a numeric value, and later change it to a string value or vice versa.
l
When deploying a custom monitor using a template, clearing the Verify monitor properties
with remote server check box in the Deployment Values dialog box has no effect, because the
monitor configuration properties in the template must be checked against the remote server on
which the template is being deployed.
l
When publishing changes to a template that contains a custom monitor, we recommend using
the Disable custom monitors while publishing changes option (selected by default) in
Preferences > Infrastructure Preferences > Custom Monitor Settings. The monitor is
temporarily disabled before changes are published and is restored to the enabled state after
changes have been made.
l
Setting status thresholds using a baseline is not supported on user-defined metrics.
l
You can use third-party .jar files without removing the JVM security from the registry by adding
HP SiteScope (11.23)
Page 338 of 1293
Using SiteScope
Chapter 25: Create Custom Monitors
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 Troubleshooting
l
Errors in the monitor (including errors in the script) are written to the SiteScope logs in the same
way as for any other monitor. Check the error.log and RunMonitor.log files.
l
Error messages from the script are displayed in the custom_monitor.log file located in
<SiteScope root directory>\logs\custom_monitors. This log can be used for info, warning,
error, and debug messages from running the script.
To change the log level to DEBUG mode, in <SiteScope root
directory>\conf\core\Tools\log4j\PlainJava\log4j.properties, change ${loglevel} to
DEBUG in the following paragraph:
# Custom monitors category
log4j.category.CustomMonitor=${loglevel},custom.monitor.appender
log4j.additivity.CustomMonitor=false change
l
For query-based custom monitors: If running a dynamic query from within a data processing
script fails, an exception is thrown.
HP SiteScope (11.23)
Page 339 of 1293
Chapter 26: Set Monitor Thresholds Using a
Baseline
Baselines enable you to understand how your applications typically perform and determine whether
a performance problem is an isolated incident or a sign of a significant downward performance
trend. Baseline data is gathered from monitor performance metrics over a period of time and is used
to provide a comparison for establishing acceptable or expected threshold ranges. When the
monitor's performance exceeds that range by some value (or does not reach that range, for
example, in the case of Free Disk Space), the monitor can signal an error or warning. The
acceptable threshold range of a monitor is determined by how far the current performance is from
the baseline.
Learn About
Calculating the Baseline
To enable SiteScope to begin calculating baselines, you select the groups, monitors, or both, to be
used for collecting baseline data. You can also select the schedule ranges used for collecting
baseline threshold data. This enables you to restrict to certain days or hours of the week the periods
during which SiteScope collects data for the baseline calculation. For example, you may want the
monitor status to be based on results gathered during peak business hours only.
You can also select the adherence level used for determining the extent to which values for the
baseline calculation affect the threshold values and set threshold boundaries for all monitor
measurements. For details, see "Baseline Adherence Level" on page 350 and "Good and Error
Boundaries" on page 350.
The baseline engine calculates the baseline for each schedule using measurements collected from
the monitors during the data collection period. SiteScope uses a percentile algorithm in the baseline
calculation, in which a percentile value is used to determine the value of the baseline. For details on
how baseline thresholds are calculated, see "Baseline Threshold Values" on page 351.
Activating the Baseline
After the baseline is calculated, you can review a summary of calculated monitors and analyze the
baseline data in the Activate Baseline dialog box. The dialog box lists all the monitor instances for
which a baseline was calculated, the date of the baseline calculation, and the reduction in the
number of error and warning statuses that would have been generated for a monitor if the baseline
thresholds were applied. If SiteScope is unable to calculate a baseline for a monitor, it lists a reason
for calculation failure.
You can also view a graph that displays the current thresholds, the baseline thresholds, and historic
data of all baseline-related monitor measurements over a 24-hour time period for each monitor
measurement. The graph includes an annotation tool that enables you to annotate a snapshot of the
graph you are viewing, to highlight important areas. You can save, print, or email an annotation
graph. For user interface details, see "Annotation Tool" on page 363.
After reviewing the baseline data, you can activate baseline threshold configuration. This applies
the baseline values to the thresholds for the selected monitors. You can also activate the baseline
HP SiteScope (11.23)
Page 340 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
for monitors that failed for the reason Insufficient data by using the limited measurement samples
that were collected.
Before activating the baseline threshold, consider the option to save the current monitor
configuration, because you cannot undo threshold configuration changes after the baseline has
been activated.
When the baseline is activated, the baseline thresholds are displayed in the Threshold Settings
panel for each monitor. The baseline value is recalculated each day according to the history
samples collected for the measurement and the current day's readings, and the baseline threshold
values are recalculated and updated accordingly.
At any time, you can create a baseline summary report showing the baseline status and baseline
status description for each monitor in the selected context.
Tasks
How to Set Monitor Thresholds Using a Baseline
This task describes the steps involved in setting monitor thresholds using a baseline.
1.
Configure baseline setting preferences - optional
You can view and define the values of global SiteScope baseline settings in Infrastructure
Preferences. This includes calculation and activation priority settings, the number of days of
historical data to include in baseline calculations, and the offset for calculating the error
boundary.
For user interface details, see "Baseline Settings" on page 645.
2.
Calculate the baseline
Define thresholds on the monitor measurements for which the baseline should be calculated.
a. Select the monitor instances you want to baseline. For user interface details, see "Select
Monitors for Baseline Calculation" on page 354.
b. Select one or more schedule ranges to be used for collecting baseline data, or accept the
default schedule (every day, all day). For user interface details, see "Schedule" on page
355.
c. Select the global baseline adherence level that is used for determining the extent to which
values for the baseline calculation affect the threshold values for all monitor
measurements. For user interface details, see "Adherence Level" on page 355.
d. Additionally, you can click the Fine-Tune Adherence Levels/Set Boundary button to:
o
Individually fine-tune the baseline adherence level for any monitor measurement.
o
Define a good boundary for each monitor measurement. A measurement within this
boundary is not in error status, even though it should report an error according to existing
baseline percentiles.
HP SiteScope (11.23)
Page 341 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
For user interface details, see "Fine-Tune Adherence Levels/Set Boundary Dialog Box" on
page 356.
HP SiteScope (11.23)
Page 342 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
e. Click Calculate to perform the baseline threshold calculation.
Example: Calculate Baseline dialog box (only monitors that the user is eligible to see
according to their user permissions are displayed)
Example: Fine-Tune Adherence Levels/Set Boundary dialog box
HP SiteScope (11.23)
Page 343 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
3.
Review the baseline settings
Review the summary of calculated monitors and baseline data in the Activate Baseline dialog
box. Only the monitors that the user is eligible to see according to their user permissions are
displayed.
For user interface details, see "Activate Baseline Dialog Box" on page 370.
Example: Activate Baseline dialog box (only monitors that the user is eligible to see
according to their user permissions are displayed)
HP SiteScope (11.23)
Page 344 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
4.
View the baseline monitor measurements graphs
You can view a graphical display of each monitor's baselined measurements to analyze the
baseline data for a selected day. You can also use the annotation tool to create a snapshot of
the graph you are viewing and highlight important areas.
For user interface details, see "Baseline Monitor Measurement Graphs Dialog Box" on page
360.
Note: The data displayed in the graphs is an aggregate of the measurement data and as
such, the time periods may not accurately reflect the time the data was collected.
Example: Baseline Monitor Measurements Graph
HP SiteScope (11.23)
Page 345 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
5.
Activate the baseline settings
Select the monitors for which you want to set thresholds using a baseline, and click Activate.
You can select all monitors with a successfully calculated baseline, and those that failed with
the reason Insufficient data (indicated by Yes in the Can Be Activated column). The monitor
thresholds are configured according to the baseline calculation, and are set to change status
when the thresholds settings are exceeded.
For user interface details, see "Activate Baseline Dialog Box" on page 370.
Note: If you want to revert to the current monitor threshold configuration, select the option
to save the current monitor configuration before activating the baseline configuration.
6.
View baseline properties in the Baseline Status Report
You can create an ad hoc report showing information about each monitor in the selected
context, including each monitor's baseline status and baseline status description. For user
interface details, see "Baseline Status Report" on page 368.
You can also track the baseline status for a monitor in the monitor's Baseline Settings. For user
interface details, see "Baseline Settings" on page 327.
HP SiteScope (11.23)
Page 346 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
Example: Baseline Status Report
7.
View and modify baseline thresholds
In the Threshold Settings, you can view the baseline thresholds and manually fine-tune the
thresholds by changing the percentile value from which the threshold value is derived.
For user interface details, see "Threshold Settings" on page 305.
Example: Monitor's baseline threshold settings
HP SiteScope (11.23)
Page 347 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
In the example, the Error if percent used threshold value is >= 42.81 and the Warning if
percent used threshold value is >= 40.77 (both these values are non-editable). To change
the threshold values, you must change the percentile value from which the threshold
values are derived. To help you understand what the new threshold value is after you
change the percentile value, click the Percentiles Table
button to open the percentile
table that shows the threshold value that is mapped to each percentile range.
Note: The Error if percent used (default)> 90 threshold is the error boundary. This is the
value of a measurement considered to be in error status, even though according to existing
baseline percentiles it should not report an error. For example, if the baseline threshold
were updated to Error if percent used (%)>= 96, all measurements greater than 90 are in
error status, even if the calculated baseline error threshold of 96 is not exceeded. For
details on this topic, see "Good and Error Boundaries" on page 350.
Tips/Troubleshooting
Notes and Limitations
l
Only an administrator in SiteScope, or a user granted Add, edit or delete monitors or Edit or
delete monitors only permissions, can use the baseline feature to set monitor thresholds, and
only for the monitors that are in the users allowed groups list. Any user can view the Baseline
Status Report regardless of edit permissions.
HP SiteScope (11.23)
Page 348 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
l
You cannot add or delete thresholds or measurements, or copy or move monitors during the
baseline calculation process (up until the point that the monitor baseline is activated).
l
If you add, edit, or delete threshold measurements from browsable monitors after the baseline is
activated for a monitor, the monitor needs to be recalculated and reactivated as a baseline
monitor.
l
Baseline thresholds are not copied or moved along with the other group or monitor objects when
copying or moving a group or monitor with an activated baseline.
l
If SiteScope is restarted before the remove baseline process is complete, the process is not
continued after the restart, and you must run the remove baseline process again.
l
If SiteScope is restarted before the baseline calculation or activation process is complete, it
automatically continues the process after the restart. Monitors with any other baseline status
(Calculated, not activated; Activation failed; Calculation failed; Baseline activated) are not
affected by the restart.
l
Before the baseline is calculated, the monitors should be enabled and permitted to run for a
period long enough for SiteScope to accumulate sufficient data to calculate the baseline. This
period depends on the Minimum number of days required for baselining and Minimum
number of samples required for baselining settings in Preferences > Infrastructure
Preferences > Baseline Settings. For details, see "Baseline Settings" on page 645. The
baseline can still be calculated and activated even if the monitor has insufficient data, although
the calculation may not be accurate.
l
After you define a set of counters for a browsable monitor and the monitor runs with these
counters for some time, if you later change the counters (for example, remove existing counters
and/or add new counters), and then you attempt to calculate baseline, the calculation results
may be incorrect. This can occur because old data, possibly for counters that no longer exist,
interferes with the new data. The calculation may also be incorrect for counters that have not
changed since the monitor was created. To avoid this problem, do not make any changes to a
monitor's browsable counters during the minimum number of days period required for calculating
the baseline.
l
You can change threshold related properties using Global Search and Replace, regardless of
whether the threshold was created using a baseline or manually. However, you cannot activate
a baseline threshold for a monitor using Global Search and Replace.
l
During the baseline calculation and after the baseline is activated, only certain baseline
threshold changes are supported. The same restrictions apply when you change threshold
related properties using Global Search and Replace. For details on the threshold changes that
are allowed, see "Changing Threshold Settings" on page 311.
l
Memory consumption increases for each monitor threshold set using a baseline. To reduce
memory consumption, you can set the Interval for saving accumulated baseline data to
disk settings in the Baseline Settings. For details, see "Baseline Settings" on page 645.
HP SiteScope (11.23)
Page 349 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
Additional Information: Understanding Baseline
Calculations
This section includes:
l
"Baseline Adherence Level" below
l
"Good and Error Boundaries" below
l
"Baseline Threshold Values" on the next page
l
"How SiteScope Calculates Thresholds" on page 352
l
"How SiteScope Calculates the Error Boundary" on page 352
Baseline Adherence Level
You can select the baseline adherence level used for determining the threshold value. This is the
extent to which values for the baseline calculation affect the threshold values for all monitor
measurements. You can select High adherence, Medium adherence, or Low adherence. The
higher the adherence level, the closer the threshold range is to the monitor measurement baseline
values. Conversely, the lower the adherence level, the further the threshold range is from the
monitor measurement baseline values.
In addition to selecting the adherence level, you can also fine-tune the adherence level for individual
monitor measurements by configuring adherence percentiles separately for each monitor
measurement. Adherence levels are based on adherence percentiles—a measurement value that
determines when a measurement is in error or warning. For browsable monitor measurements, you
can configure only one set of adherence percentiles that is used by all browsable monitors.
To manually fine-tune the adherence level, you need to understand how the threshold values are
created. For details on this topic, see "Baseline Threshold Values" on the next page.
Good and Error Boundaries
Configuring good and error boundaries is useful to avoid setting off errors and warnings
unnecessarily when using baseline thresholds. You can manually set a good boundary for each
monitor measurement and the browsable monitor counters. SiteScope automatically configures the
error boundary for each monitor measurement.
Note: To set good boundaries, it is important to understand how baseline threshold values are
created. For details on this topic, see "Baseline Threshold Values" on the next page.
Good Boundary
This is the value of a measurement that is not considered to be in error status, even though
according to existing baseline percentiles it should report an error. For example, consider a low load
system where CPU utilization measurements are constantly below 3%. Based on these
measurements, SiteScope might calculate a baseline threshold with a 5% error threshold. Because
this is not an accurate measure of CPU load error, you may want to define 70% CPU utilization as
HP SiteScope (11.23)
Page 350 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
the good boundary to avoid generating false errors. Provided CPU utilization remains below this
limit (even though it is above the baseline error threshold), the monitor is not in error status.
You manually set the Good Boundary in the Fine Tune Adherence Levels /Set Boundary dialog box.
For user interface details, see "Fine-Tune Adherence Levels/Set Boundary Dialog Box" on page
356.
Error Boundary
This is the value of a measurement that is considered to be in error status, even though according to
existing baseline percentiles it should not report an error. This can occur when a measurement
value grows slowly over a period of time, for example, due to a slow memory leak. Because the
baseline threshold is recalculated and updated every day as the measurement average increases,
the measurement value does not cross the new threshold.
To overcome this problem, SiteScope automatically sets the error boundary for each monitor
measurement. It does this by setting a limit that triggers errors when monitor measurements
exceed a specified value, regardless of the baseline. For example, if SiteScope sets an error
boundary of 80% CPU utilization, values over 80% CPU utilization are in error status even if the
calculated baseline error threshold is not exceeded.
For information on how the error boundary is calculated, see "Baseline Threshold Values" below.
Baseline Threshold Values
To help you fine-tune the percentile value used in the baseline calculation at each adherence level
and to set the "Good and Error Boundaries" on the previous page, it is important to understand:
l
The types of threshold values.
l
How they are applied to metrics.
l
How metrics are used to calculate baseline thresholds and boundaries.
Baseline thresholds are added or updated dynamically to the monitor configuration for each
measurement the monitor had before the baseline was calculated. Baseline thresholds are added
for each schedule selected for collecting baseline data.
In general, there are two types of thresholds: baseline thresholds and static thresholds. Baseline
thresholds have a percentile value that is used to determine when a measurement is in error or
warning status, while static thresholds have an actual fixed value. Baseline threshold metrics have
a condition of either >= or <= depending on the direction of the measurement.
Baseline thresholds are changed, added, or deleted on metrics provided the following two
conditions are met:
l
The measurement can be used in the baseline calculation. To be used in the baseline
calculation, a measurement must be numeric and it must have a direction. An example of a
measurement that cannot be used in the baseline calculation is a URL 404 error code (it is
numeric, but it has no direction).
l
The measurement has a static threshold defined for any schedule and any status category
(Good, Warning, Error) prior to the baseline calculation.
HP SiteScope (11.23)
Page 351 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
Metrics that do not adhere to these conditions are not affected (in terms of the thresholds defined on
them), and a baseline is not calculated for these metrics.
How SiteScope Calculates Thresholds
When SiteScope calculates the baseline, it creates a percentile value for each baselinable
threshold measurement for each schedule. SiteScope makes an adjustment for extreme metrics by
discarding, by default, 2% of the most extreme samples (considered "noise" metrics), and
calculates the percentiles on the remaining metrics. For example, if most monitor run results on a
server show CPU utilization of no more than 20% and one peak value of 50%, the peak value is not
used to determine the baseline. You can change the percentage of discarded measurement
samples in the Baseline Settings.
The baseline engine uses a sliding-window approach to calculate thresholds. This means that
newer data samples have more influence on the baseline calculation than older samples, and that
after a period of time (by default 30 days), the historic data becomes obsolete. You can set the
number of days to include in the calculation in the Baseline Settings.
For information about configuring Baseline Settings, see "Infrastructure Preferences" on page 615.
How SiteScope Calculates the Error Boundary
SiteScope uses the percentile value to create an error boundary for each measurement. This is the
value of a measurement that is considered to be in error status, even though according to existing
baseline percentiles it should not report an error. For details, see "Good and Error Boundaries" on
page 350.
SiteScope calculates the error boundary in one of the following ways:
If the measurement has a static error threshold for the specific schedule, the percentile value of
the baseline threshold is calculated into an actual value and this value is then compared to the
value of the static threshold as follows:
l
n
If the static error threshold value is more extreme than the baseline threshold value, the static
error threshold value is used as the error threshold boundary for that measurement.
Example:
If the static error threshold is 100% CPU utilization and the computed baseline threshold is
67% CPU utilization, the static error threshold value (100% CPU utilization) is used as the
error boundary.
n
If the baseline threshold value is more extreme than the static error threshold value, then the
offset value is used. The offset is a percentage value that SiteScope adds to the baseline
threshold value (or subtracts from, depending on the direction of the measurement), and the
resulting value is used as the error boundary for that measurement. You can determine the
offset value in the Baseline Settings panel of Infrastructure Preferences.
Example:
HP SiteScope (11.23)
Page 352 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
If the static error threshold for a schedule is 60% CPU utilization and the computed baseline
threshold value is 65% CPU utilization, the error boundary is calculated as:
65% CPU utilization * 130% (using the default offset value of 0.3) = 84.5% CPU utilization.
l
If there is no error threshold value for the measurement with the specific schedule prior to
calculating the baseline (the measurement has a warning or good threshold value but no error
threshold value), and the Automatically create an error boundary if no error thresholds are
defined option is selected in the Baseline Settings, the percentile value of the baseline threshold
is calculated into an actual value and the offset value is added to/subtracted from the baseline
threshold value (depending on the direction of the measurement). The resulting value is used as
the error boundary for the measurement.
Note: An error boundary is not created if:
n
There is no error threshold value for the measurement with the specific schedule prior to
calculating the baseline (for example, the measurement has a warning or good threshold
value but no error threshold value), and
n
The Automatically create an error boundary if no error thresholds are defined option
is not selected.
For details on defining the offset value and automating error boundary creation, see "Infrastructure
Preferences" on page 615.
Baseline Thresholds User Interface
This section includes:
l
"Calculate Baseline Dialog Box" on the next page
l
"Fine-Tune Adherence Levels/Set Boundary Dialog Box" on page 356
l
"Percentile Range Mapping Table" on page 357
l
"Backup Configuration Dialog Box" on page 359
l
"Baseline Monitor Measurement Graphs Dialog Box" on page 360
l
"Annotation Tool" on page 363
l
"Remove Baseline Dialog Box" on page 367
l
"Baseline Status Report" on page 368
l
"Activate Baseline Dialog Box" on page 370
HP SiteScope (11.23)
Page 353 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
Calculate Baseline Dialog Box
This dialog box enables you to select the groups, monitors, or both, to include in the baseline
calculation, select the time range schedule for collecting baseline data, select and fine-tune the
adherence level to determine the extent that monitor measurement sample values have on the
threshold values, and calculate the baseline threshold.
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope
container, a group, or a monitor, and select Baselining > Calculate.
Important
information
l
Only an administrator in SiteScope, or a user granted Add, edit or delete
monitors or Edit or delete monitors only permissions can use the baseline
feature to set monitor thresholds, and only for the monitors that are in the users
allowed groups list. Monitors in groups for which the user does not have
permissions are not displayed in the dialog box. For details on user
permissions, see "User Management Preferences" on page 726.
l
The amount of time required to calculate the baseline thresholds depends on
the speed of the SiteScope server and the number of monitors selected for
baselining. If SiteScope needs to restart before the calculation process is
complete, SiteScope automatically continues the process after the restart.
l
Enable the monitors run for a period that is long enough for SiteScope to
accumulate sufficient data to calculate the baseline. This period depends on
the Minimum number of days required for baselining and Minimum
number of samples required for baselining settings in Infrastructure
Preferences. For details, see "Infrastructure Preferences" on page 615. The
baseline can still be calculated and activated even if the monitor has
insufficient data, although the calculation is unlikely to be accurate.
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Set Monitor Thresholds Using a Baseline" on page 340
Select Monitors for Baseline Calculation
User interface elements are described below (unlabeled elements are shown in angle brackets):
HP SiteScope (11.23)
Page 354 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element
Description
<List of
available
groups and/or
monitors>
Groups, monitors, or both, to include in calculating the baseline threshold.
The list includes the currently selected container and all of the child
containers that are in the users allowed groups list.
Default value: The current container and all child elements are selected.
Note: You cannot select a monitor instance if:
l
Its baseline has already been activated. In such cases, the selection
check box is not displayed.
l
There is another monitor in SiteScope with the same name (the file path,
group name, and monitor name are identical). In such cases, Duplicate
name appears next to the monitor name.
Schedule
User interface elements are described below:
UI
Element
Description
Schedule Schedule ranges used for collecting baseline threshold data. This enables you to
Range
restrict to certain days or hours of the week the periods during which monitor data is
Name
collected for the baseline calculation. The baseline thresholds that are created are
only effective for the same schedule range period. The range schedules displayed
are created in Schedule Preferences. For more information about creating range
schedules, see "Schedule Preferences" on page 708.
Note: You can select multiple ranges using the CTRL or SHIFT keys.
Default value: If no schedule range is selected, baseline threshold data is collected
all day, every day.
Adherence Level
User interface elements are described below:
Description Enables you to select the adherence level that determines the extent to which
monitor measurement sample values used in calculating the baseline affect the
threshold values. The adherence level is based on a percentile value that is
applied to all monitor measurements to determine when a measurement is in error
or warning. You can also fine-tune the adherence level for individual monitor
measurements, and set the Good Boundary.
To access: In the monitor tree, right-click the SiteScope container, a group, or a
monitor, and select Baselining > Calculate. Expand the Adherence Level
panel.
HP SiteScope (11.23)
Page 355 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Additional Information: Understanding Baseline Calculations" on page 350
User interface elements are described below:
UI
Element
Description
Low
adherence
The further the values used to update the thresholds are from the values calculated
by the baseline. Select this option if you are more tolerant to extreme measurement
values having an effect on the baseline.
Medium
adherence
The values used to update the thresholds are at a mid-range from the values
calculated by the baseline (default setting).
High
adherence
The closer the values used to update the thresholds are to the values calculated by
the baseline. Select this option if you are less tolerant to extreme measurement
values having an effect on the baseline.
Fine-Tune
Adherence
Levels/Set
Boundary
Opens the Fine-Tune Adherence Levels/Set Boundary dialog box, enabling you to
fine-tune the baseline adherence level and define a good boundary for any
measurement of any monitor type within the selected context. For user interface
details, see "Fine-Tune Adherence Levels/Set Boundary Dialog Box" below.
Fine-Tune Adherence Levels/Set Boundary Dialog Box
This dialog box displays the percentile value used in the baseline calculation at each adherence
level and the good boundary (if configured), for each monitor measurement in the selected context.
This enables you to fine-tune the baseline adherence level and set good boundaries for any
measurement of any monitor type.
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope
container, a group, or a monitor, and select Baselining > Calculate. Expand the
Adherence Level panel, and click the Fine-Tune Adherence Levels/Set
Boundary button.
Important
You can set adherence level percentile values to over 100%. This enables you to
information raise the threshold level above the level that would have been set, based on the
sample measurements collected. For example, if measurements collected for
CPU Utilization are between 10%-60%, and you only want to get errors above 80%
CPU Utilization, set the Error Percentiles Low value to a percentile that raises
the error threshold level to the desired level. In this instance, set the percentile to
134% (60% CPU Utilization * 134% = 80.4% CPU Utilization).
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Set Monitor Thresholds Using a Baseline" on page 340
HP SiteScope (11.23)
Page 356 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
User interface elements are described below:
UI Element
Description
Reset. Restores the default error and warning threshold adherence level
values for the monitor measurement and to remove the Good Boundary.
Select All. Selects all listed monitor measurements.
Clear Selection. Clears the selection.
Monitor
Name:
Measurement
Name
For each monitor in the selected context, displays the measurements that are
used in the baseline calculation. It also displays one measurement that
represents the measurements for all browsable monitors (at the bottom of the
list).
Warning
Percentiles
Displays the Low, Medium, and High adherence level percentile value that is
used to calculate the warning baseline threshold. For more details on this
topic, see "Baseline Adherence Level" on page 350.
Default value: Low 110; Medium 93; High 90
Error
Percentiles
Displays the Low, Medium, and High adherence level percentile value that is
used to calculate the error baseline threshold. For more details on this topic,
see "Baseline Adherence Level" on page 350.
Default value: Low 120; Medium 98; High 95
Good
Boundary
Displays the actual value for the Good Boundary for each monitor
measurement type. This is the value of a measurement that is not considered
to be in error status, even though according to existing baseline percentiles it
should report an error. For more details on this topic, see "Good and Error
Boundaries" on page 350.
Default value: No value
All browsable Displays the Low, Medium, and High adherence level percentile value that is
monitor
used to calculate the warning and error baseline threshold for all browsable
measurements monitor measurements.
Default Warning values: Low 110; Medium 93; High 90
Default Error values: Low 120; Medium 98; High 95
Percentile Range Mapping Table
This table displays the actual value that is mapped to each percentile range. SiteScope uses the
percentile value to define the baseline error and warning thresholds. Use this table to view the
actual value that corresponds to the percentile value, and to manually change the percentile value.
HP SiteScope (11.23)
Page 357 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
To access
Select the Monitors context. In the monitor tree, select a monitor with an
activated baseline (you can check whether a monitor has an activated baseline by
right-clicking a group or monitor, and select Baselining > Status Report).
Expand the monitor's Threshold Settings, and click the Percentiles Table
button.
Important
This table is available for monitors with an activated baseline only.
information
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
l
"Set Monitor Thresholds Using a Baseline" on page 340
l
"Threshold Settings" on page 305
User interface elements are described below:
UI Element Description
Percentiles Percentile range that correlates to the actual value used for defining the baseline
Range
error and warning thresholds. You can set the number of percentile ranges
displayed in the table from the SiteScope Preferences (Preferences >
Infrastructure Preferences > Baseline Settings).
Note: The left-hand value is exclusive and the right-hand value is inclusive. This
means that for a percentile range of 33-100, all values above 33 (but not 33 itself)
up to 100 are included in the range. The value 33 falls into the previous range and
100.01 falls into the next range.
Actual
Value
The actual value that is mapped to the percentile range.
HP SiteScope (11.23)
Page 358 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element Description
Current
Percentile
Percentile value that correlates to the actual value that is used to define the
baseline thresholds.
Note:
l
You can set the current percentile to a value over 100%. This enables you to
raise the threshold level above the level that would have been set, based on the
sample measurements collected. For example, if measurements collected for
CPU Utilization are between 10%-60%, and you only want to get errors above
80% CPU Utilization, set the percentile value to a percentile that raises the error
threshold level to the desired level. In this instance, set the percentile to 134%
(60% CPU Utilization x 1.34 = 80.4% CPU Utilization).
l
SiteScope calculates the percentile range as follows:
n
For ranges below 100%, percentiles represent the amount of samples in
each range. So the 80th percentile is the range that 80 percent of the CPU
Utilization values are smaller than or equal to.
n
Ranges above 100%: The 110th percentile is calculated as the 100th
percentile x 1.1 (66.42 x 1.10 = 73.06); the 120th percentile is calculated as
the 100 percentile x 1.2 ( 66.42 x 1.2 = 79.7), and so forth.
Backup Configuration Dialog Box
This dialog box enables you to save the current monitor threshold configuration before activating the
baseline threshold. You use the Configuration Tool to restore the configuration settings. For details
on the Configuration Tool, see the SiteScope Deployment Guide (<SiteScope root
directory>\sisdocs\doc_lib\Get_Documentation.htm).
HP SiteScope (11.23)
Page 359 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope node, a
group, or a monitor and select Baselining > Review & Activate. Click the
Backup Configuration button.
Important
Create a backup configuration before activating the baseline configuration, since
information you cannot undo threshold configuration changes after the baseline has been
activated.
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Set Monitor Thresholds Using a Baseline" on page 340
User interface elements are described below:
UI
Element
Description
Enter
target
directory
Target directory where the backup configuration file is saved or use the default
SiteScope installation directory.
Enter the
backup
file name
Name for the configuration backup file. By default, the file is named using the
format: SiteScope_<MM_DD_YYYY>_<HH_MM_SS>. SiteScope saves a backup file in
zip format to the specified location.
Default value: C:\SiteScope
Example: SiteScope__11_05_2008_08_24_06
Baseline Monitor Measurement Graphs Dialog Box
This dialog box displays a graph per measurement, for all the measurements of the monitor. The
default date selected for displaying the graph is the day with the maximum error reduction. Each
graph shows the current warning and error thresholds, the baseline warning and error thresholds,
and historic data of all baseline-related monitor measurements over a 24-hour time period (from
00:00-23:59).
HP SiteScope (11.23)
Page 360 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope node, a
group or a monitor container, and select Baselining > Review & Activate. In the
Successfully Calculated Monitors panel, select a monitor with calculated
baseline data, and click the View Graph button.
Important
The data displayed in the monitor measurement graphs is an aggregate of the
information measurement data and as such, the time periods may not accurately reflect the
time the data was collected.
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Set Monitor Thresholds Using a Baseline" on page 340
Graph Settings
User interface elements are described below:
UI
Element Description
Annotation Tool. Creates a snapshot of the graph you are viewing and highlight
important areas of the graph by drawing shapes, lines, and adding text to the
snapshot. For user interface details, see "Annotation Tool" on page 363.
HP SiteScope (11.23)
Page 361 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI
Element Description
Collapse Report Filter. Click to collapse or expand the report filter.
Tooltip: When the collapsible report filter closes, the icon's tooltip displays details
about the selections you made in the filter.
Run. After you have specified the report setup, click to run the report for the date
displayed in the date link.
Historic
date
<date
link>
Opens the calendar, enabling you to select the date for which you want to create
monitor measurement graphs. The calendar contains the following buttons:
l
Revert. Returns to the previously selected report date.
l
Current. Selects today's date in the calendar.
l
OK. Updates the date link for the selected date and closes the calendar.
l
Cancel. Closes the calendar without making any changes.
Graph Content
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
<Legend>
Describes the color coding used in the graph.
Measurement
name
Name of the measurement appears above the graph.
Date
Time and date on which the graph was generated.
<Data points>
Displays for each 2 hour period of time on the Time axis, the value for the
selected monitor measurement.
Tooltip: The measurement value.
<Measurement Displays the monitor measurement type.
Type> <yaxis>
Hours <xaxis>
Time division units for the date specified when generating the report (from 0-24
hours).
Baseline Error
Threshold
Displays the baseline threshold line that determines Error status.
Measurements beyond this line exceed the error baseline status threshold for
the monitor. This is displayed on the graph as a solid red line.
HP SiteScope (11.23)
Page 362 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element
Description
Baseline
Warning
Threshold
Displays the baseline threshold line that determines Warning status.
Measurements beyond this line exceed the warning baseline status threshold
for the monitor. This is displayed on the graph as a solid orange line.
Current Error
Threshold
Displays the threshold line that determines Error status. Measurements
beyond this line exceed the error status threshold for the monitor. This is
displayed on the graph as a dashed black line.
Current
Warning
Threshold
Displays the threshold line that determines Warning status. Measurements
beyond this line exceed the warning status threshold for the monitor. This is
displayed on the graph as a dashed blue line.
Annotation Tool
This tool enables you to annotate a snapshot of the report you are viewing, to highlight important
areas. The Annotation Tool is available when viewing Baseline Monitor Measurements Graphs. The
Annotation Options enable you to customize your snapshot.
The Annotation Menu Bar contains elements that enable you to:
l
Change the appearance of the snapshot.
l
Save, print, or email an annotation report.
l
Customize the appearance of text annotated onto your snapshot. These elements are enabled
only when the Text Tool
To access
button is selected.
Click the Annotate
button on the right side of the page.
Important
To use the Annotation Tool, the Sun JRE plug-in 1.6.0_x (latest version
information recommended) must be installed on your machine. If the plug-in is not installed
on your machine, you are prompted to install it.
See also
"Set Monitor Thresholds Using a Baseline" on page 340
Annotation Options
User interface elements are described below:
UI Element
(A–Z)
Description
Pan Tool. Click to navigate the snapshot.
Select Tool. Click to select a specific area of the snapshot.
HP SiteScope (11.23)
Page 363 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element
(A–Z)
Description
Shape Tool. Click to add a shape to the snapshot. Clicking the shape tool
button enables the following shape buttons:
Rectangle. Click to mark an area of the snapshot with a rectangle.
l
Filled Rectangle. Click to mark an area of the snapshot with a filled
rectangle.
l
l
Oval. Click to mark an area of the snapshot with an oval.
l
Filled Oval. Click to mark an area of the snapshot with a filled oval.
l
Rounded Rectangle. Click to mark an area of the snapshot with a round
rectangle.
l
Filled Rounded Rectangle. Click to mark an area of the snapshot with
a filled round rectangle.
Customization. After selecting this button, you can customize your line
appearance through the following parts of the interface:
Line Type. Choose the type of line you want to add. Options include:
l
l
HP SiteScope (11.23)
n
Solid Line
n
Jagged Line
Line Width. Select the width of the line, in pixels, in the annotation.
Page 364 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element
(A–Z)
Description
Line Tool. Click to enable the line tool, which marks the selected area of the
snapshot with a line.
Customization. After selecting this button, you can customize your line
appearance through the following parts of the interface:
Line Style. Choose the style of line you want to add. Options include:
l
n
Regular line
n
Line with endpoints
n
Line with arrows
Line Type. Choose the type of line you want to add. Options include:
l
l
n
Solid Line
n
Jagged Line
Line Width. Select the width of the line, in pixels, in the annotation.
Text Tool. Click to add text to the snapshot.
Example: Add the syntax This is the problematic transaction above a
line marking an area of the report.
Border and
Fill Colors
Select the relevant square to choose the color of the border and fill of your
annotations. The available squares are:
l
Upper Square. Click to choose the color of lines, as generated by the line
tool and displayed in unfilled shapes.
l
Lower Square. Click to choose the color to fill shapes.
Clicking either of the squares generates a dialog box with the following tabs
where you choose the color:
l
Swatches
l
HSB
l
RGB
HP SiteScope (11.23)
Page 365 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element
(A–Z)
Opacity
Description
Slide the opacity bar to choose the darkness level of the selected shape line, text
line, or shape color in the annotation.
Note:
l
A higher opacity percentage means that the selection appears darker. A lower
opacity percentage means that the selection appears lighter.
l
This field is enabled when either the shape tool, line tool, or text tool button is
selected.
Annotation Menu Bar
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI
Element
(A–Z)
Description
Save. Saves the snapshot on your local machine.
Note:
l
The snapshot is saved in .png format.
l
You cannot select the New Folder
directory or any of its subdirectories.
icon when saving in the My Documents
Select All. Selects all of the annotations added to your snapshot.
Clear Selected. Clears all annotations.
Undo. Rolls back the most recent action performed on the snapshot.
Redo. Cancels the roll back of the most recent action performed on the snapshot.
Zoom In. Brings the snapshot view closer.
Zoom Out. Sets the snapshot view further away.
Restore original size. Restores the snapshot to its original size.
Print. Prints the snapshot.
Send E-mail. Click to send the snapshot via email.
HP SiteScope (11.23)
Page 366 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI
Element
(A–Z)
Description
Save to repository. Uploads the snapshot to Report Manager. For details on Report
Manager, see "Report Manager Overview" in the BSM User Guide in the BSM Help.
Note: This option is not available when accessing the Annotation Tool from
SiteScope.
Help. Displays online documentation help for the page you are currently viewing.
Bold. Bolds the text.
Note: This field is enabled only when selecting the Text Tool
button.
Italic. Italicizes the text.
Note: This field is enabled only when selecting the Text Tool
button.
Underline. Underlines the text.
Note: This field is enabled only when selecting the Text Tool
button.
Anti-aliasing. Adjusts the pixel reading of text or annotation lines so that they appear
smoother.
Note: This field is only enabled when selecting the Text Tool
<Font
Family>
Select the font for the text in the report.
Note: This field is only enabled when selecting the Text Tool
<Font
Size>
button.
button.
Select the size of the font in the report.
Note: This field is only enabled when selecting the Text Tool
button.
Remove Baseline Dialog Box
This dialog box enables you to select the groups, monitors, or both from which to remove the
baseline. You must remove a monitor's existing baseline calculation before you can recalculate the
monitor's threshold baseline.
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope node, a
group, or a monitor and select Baselining > Remove.
HP SiteScope (11.23)
Page 367 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
Important
Only an administrator in SiteScope, or a user granted Add, edit or delete
information monitors or Edit monitors only permissions can remove a baseline, and only for
the monitors that are in the users allowed groups list. Monitors in groups for which
the user does not have permissions are not displayed in the dialog box. For details
on user permissions, see "User Management Preferences" on page 726.
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Set Monitor Thresholds Using a Baseline" on page 340
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
<List of
groups
and/or
monitors>
Groups, monitors, or both, from which you want to remove baseline threshold
calculation. The list includes all groups and/or monitors in the currently selected
container, and all child containers in the users allowed groups list.
Default value: The current container and all child elements are selected.
Baseline Status Report
This report displays information about the baseline status for all monitors in the selected context.
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope node, a
group, or a monitor and select Baselining > Status Report.
HP SiteScope (11.23)
Page 368 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
Important
information
l
This is an ad hoc report that is not saved to the SiteScope configuration data
for later use.
l
You can sort monitor types in ascending or descending order by clicking the
column header. An arrow is displayed showing the sort order direction.
l
You can filter the display for Monitor Type and Baseline Status by clicking the
down arrow
and selecting a monitor type or baseline status by which to
filter. To clear the filter, select (All).
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Set Monitor Thresholds Using a Baseline" on page 340
User interface elements are described below:
UI
Element
Description
Monitor
Name
Name and path of the SiteScope monitor depending on the context.
Monitor
Type
The type of SiteScope monitor.
Note: Only monitors in groups or subgroups that a user has permissions to access
are displayed in the report.
Baseline The monitor's baseline status. The following statuses are available:
Status
l Monitor not selected for baselining. The monitor has not been selected for
baselining.
l
Calculating baseline. SiteScope is in the process of calculating the baseline.
l
Calculation failed.SiteScope was unable to calculate a baseline.
l
Calculated, not activated. A baseline was calculated for the monitor, but it has
not yet been activated.
l
Activating baseline.SiteScope is in the process of activating the baseline.
l
Activation failed.SiteScope was unable to activate the baseline.
l
Baseline activated. The baseline has been activated for the monitor.
HP SiteScope (11.23)
Page 369 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI
Element
Description
Baseline Displays additional details for monitors with the following status:
Status
l Calculating baseline. Displays the baseline calculation stage for the monitor.
Details
l
Refresh
Calculation failed. Displays the reason that the baseline calculation failed
(Insufficient data, No measurements to baseline). Monitors that failed due to
insufficient data are selected by default for automatic baseline calculation after
the monitors have run for a period that is sufficient for SiteScope to accumulate
data for the baseline period. For details, see "Activate Baseline Dialog Box"
below.
Click during the calculation process to update the data in the status report.
Activate Baseline Dialog Box
This dialog box displays a summary of the calculated monitor's baseline data, and enables you to
save the current monitor configuration, view baseline measurement graphs, view failed operations,
and activate baseline threshold configuration. For monitors that SiteScope is unable to calculate a
baseline, it includes the reason for the failure.
To access
Select the Monitors context. In the monitor tree, right-click the SiteScope node, a
group, or a monitor and select Baselining > Review & Activate.
Important
information
l
Only an administrator in SiteScope, or a user granted Add, edit or delete
monitors or Edit or delete monitors permissions can use the baseline
feature to set monitor thresholds, and only for the monitors that are in the users
allowed groups list. Monitors in groups for which the user does not have
permissions are not displayed in the dialog box. For details on user
permissions, see "User Management Preferences" on page 726.
l
To revert to the current monitor configuration, you must create a backup
configuration before activating the baseline configuration.
l
The amount of time required to activate the baseline threshold depends on the
speed of the SiteScope server and the number of monitors selected for
baselining. If SiteScope needs to restart before the activation process is
complete, SiteScope automatically continues the process after the restart.
Relevant
tasks
"How to Set Monitor Thresholds Using a Baseline" on page 341
See also
"Set Monitor Thresholds Using a Baseline" on page 340
HP SiteScope (11.23)
Page 370 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
User interface elements are described below:
UI Element
Description
Successfully Calculated Monitors
View Graph. Displays a graphical representation of baseline data for all the
measurements of the monitor. For details, see "Baseline Monitor
Measurement Graphs Dialog Box" on page 360.
Select All. Selects all listed monitors.
Clear Selection. Clears the selection.
Monitor Name
Name of the SiteScope monitor selected for baselining.
Calculation
Date
Date on which the baseline was calculated.
Error Status
Reduction
Reduction in the number of error statuses for a monitor if the baseline
threshold were applied. A negative number indicates an increase in the
number of error statuses for a monitor if the proposed baseline thresholds
were applied.
Example: Suppose you manually configure the threshold status for CPU
Utilization to Error if >= 65% and there are 5 error statuses for the CPU
monitor (of which 3 errors are for data samples between 65%-70%, and 2
errors for above 70%). If you have SiteScope calculate the threshold using a
baseline and the threshold is set to Error if >= 70%, Error Status
Reduction would be 3.
Note: The Error Status Reduction value is based on collected data on the
calculation date.
Tip: If more than three days have elapsed since the calculation date, we
recommend that you recalculate the baseline.
HP SiteScope (11.23)
Page 371 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element
Description
Warning Status
Reduction
Reduction in the number of warning statuses for a monitor if the baseline
threshold were applied. A negative number indicates an increase in the
number of warning statuses for a monitor if the proposed baseline thresholds
were applied.
Example: Suppose you manually configure the threshold status for CPU
Utilization to Warning if >= 55% and there are 3 warning statuses for the
CPU monitor (of which 2 warnings are for data samples between 55%-60%,
and 1 warnings for above 60%). If you have SiteScope calculate the
threshold using a baseline and the threshold is set to Warning if >= 60%,
Warning Status Reduction would be 2.
Note: The Warning Status Reduction value is based on collected data on the
calculation date.
Tip: If more than three days have elapsed since the calculation date, we
recommend that you recalculate the baseline.
Failed Monitors
Select All. Selects all listed failed monitors.
Clear Selection. Clears the selection.
Monitor Name
Name of the monitor for which SiteScope was unable to calculate a baseline.
Reason for
Failure
Reason that SiteScope was unable to calculate a baseline value for the
monitor. They include:
HP SiteScope (11.23)
l
Insufficient data. The monitor has not run for a sufficient period of time to
collect data to produce a meaningful baseline threshold. This period
depends on the Minimum number of days required for baselining and
Minimum number of samples required for baselining settings in
Infrastructure Preferences. For details on configuring the Baseline
Settings, see "Baseline Settings" on page 645.
l
No measurements to baseline. The monitor has no measurements that
can be used in the baseline calculation. You cannot select the monitor for
baseline activation.
l
No samples for the requested schedule. No data samples were
collected for the range schedule specified. You cannot select the monitor
for baseline activation.
l
Unknown. The reason for baseline calculation failure is unknown. You
cannot select the monitor for baseline activation.
Page 372 of 1293
Using SiteScope
Chapter 26: Set Monitor Thresholds Using a Baseline
UI Element
Description
Can Be
Activated
Indicates whether a baseline can be activated even if the monitor baseline
calculation failed.
Displays No if the baseline calculation failed for any reason other than
Insufficient data.
Displays Yes if the baseline calculation failed with the reason Insufficient
data. SiteScope uses the limited measurement samples that were collected
to calculate the baseline.
HP SiteScope (11.23)
Page 373 of 1293
Chapter 27: Create Calculated Metrics
A calculated metric is a metric produced by performing an arithmetic function or logical operation on
existing SiteScope metrics. The calculated metric then appears in the Thresholds Settings panel,
enabling you to configure thresholds based on that metric.
For example, you can create a calculated metric to calculate the average of two or more existing
metrics for a monitor instance, and then configure a threshold that triggers an alert if that average
exceeds a certain number.
To access
Select the Monitors context. In the monitor tree, expand the group folder that contains the monitor,
and select the monitor. In the right pane, click the Properties tab, and select the Calculated Metrics
Settings panel.
Learn About
This section includes:
l
"Calculated Metrics Overview" below
l
"Examples of Calculated Metrics" on the next page
l
"Calculated Metrics for Dynamic Monitors" on the next page
Calculated Metrics Overview
Use calculated metrics to:
l
Analyze metrics that are constantly changing, making it difficult to define status thresholds.
l
Define new arithmetic or logic metrics based on SiteScope regular metrics.
l
Enable you to run operations on monitor metrics using out-of-the-box operators, such as sum,
average, minimum, maximum, frequency, and previous.
l
Enhance the business impact of certain SiteScope metrics.
To create a new calculated metric, you create an expression that consists of metrics, operators,
and values. You can check the validity of the expression at any time while creating the expression.
To enable you to distinguish between the metrics, operators, and values within an expression, they
are separately color-coded.
You can also create calculated metrics when you create a template monitor instance. For details on
creating template monitors, see "How to Create a Monitoring Structure Using a Template" on page
782.
SiteScope calculates the results for calculated metrics, and the results appear in the SiteScope
Dashboard and in the monitor's status summary.
HP SiteScope (11.23)
Page 374 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
Examples of Calculated Metrics
Example 1:
You want to calculate the percentage of the page reads/sec to pages/sec for the Microsoft
Windows Performance Counter monitor. Create a calculated metric on the Microsoft Windows
Performance Counter monitor using the following expression:
(<<Memory: Page Reads/sec>> / <<Memory: Pages/sec>>)*100
Example 2:
You want to calculate the maximum CPU usage on a CPU Monitor. Create a calculated metric
on the CPU Monitor using the following expression:
#max(<<CPU Utilization # 1>>, <<CPU Utilization # 2>>, <<CPU Utilization # 3
>>, <<CPU Utilization # 4>>)
Example 3:
You want to check the maximum utilization of vCenter environments. Create the following
calculated metric expression:
#max(<</labm3esx01/HostSystem/cpu/coreUtilization.average*/>>)
Calculated Metrics for Dynamic Monitors
Dynamic monitors automatically update metrics and thresholds according to a metrics pattern that
specifies the metrics you want to monitor. When creating a calculated metric expression, you can
use only those regular expressions that are part of the dynamic monitors’ configured patterns.
For example, the Dynamic Disk Space monitor tracks how much disk space is currently in use on
your server. When dynamic monitoring is configured, the metrics 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 system changes.
You can configure calculated metrics for dynamic monitors based on a common function, such as
average or sum.
Example:
To calculate the total free space for all disks, create a calculated metric expression that is the
sum of all metrics created from /.*/MB free/ as follows:
SUM(<</.*/MB free/>>)
Note: You can use only one regular expression per calculated metric that is not part of a
function (that is, a calculated metric that returns only one result).
HP SiteScope (11.23)
Page 375 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
For more details on dynamic monitors, see Dynamic Monitoring Mechanism in the SiteScope
Monitor Reference Guide.
Tasks
How to Create a Calculated Metrics Expression
1.
2.
Prerequisites
n
Only a SiteScope administrator, or a SiteScope user granted Add, edit or delete monitors
or Edit or delete monitors permissions, can use the calculated metrics feature, and only
for the monitors that are in the user's allowed groups list. If a user does not have
permissions to a group of monitors, those monitors do not appear in the Calculated Metrics
Settings panel. For details on user permissions, see "User Management Preferences" on
page 726.
n
To configure calculated metrics to perform some arithmetic functions, there must be at least
one previous value of the selected metric. For example, you cannot calculate a previous
function without at least one previous run of the monitor.
Create a calculated metric expression
a. Select the monitor for which you want to create a calculated metric expression, and open
the Calculated Metrics Settings panel in the monitor properties. For user inerface details,
see "Calculated Metrics Settings" on page 378.
b. Configure the calculated metric expression to include metrics, operators, and values.
To insert a metric or operator in the Expression field, double-click the metric or operator, or
drag and drop it into the Expression field. You can also manually enter it in the Expression
field. The selected metric or operator appears in the Expression field in purple.
o
Metrics. The list of metrics is dynamically updated based on the type of monitor that
you are configuring. For example, for a Disk Space monitor, the available metrics are
<<percent full>> and <<MB free>>.
o
Operators. Defines the relation between the metric and the value. Operators contain
functions. For details about operators, see "Operators" on page 379.
o
Values. A number or numerical expression applicable to the metrics parameter. For
relational or Boolean operations, enter 1 or 0. For SiteScope functions, enter values in
the inside parentheses of the operator. For example, to calculate the average of the
numbers 7, 9, and 11, enter those numbers inside the operator parentheses as follows:
#Average(7, 9, 11).
Note:
HP SiteScope (11.23)
Page 376 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
o
Calculated metric expressions involving the following features cannot be
calculated:
o
A number divided by 0.
o
A non-numerical string divided by a number. For example, the expression
<<Overlicensed status>>/100 for a License Usage Monitor cannot be
calculated because <<Overlicensed status>> is non-numerical.
For such calculated metrics, n/a appears in the Summary column of the
Dashboard for the relevant calculated metric.
For more details about available operations when creating calculated metric
expressions, see "Available Data Processing Operations" on page 410.
3.
o
You can include nested functions in expressions. For example, #average(#max
(<<access permitted>>.length,<<directory exists>>.length),2).
o
For monitors, the Summary column in the Dashboard displays the most recent
measurement results reported by the monitor. This may include more than one
measurement, depending on the monitor type. For monitor groups, the summary
displays the number of monitors within the group and the number of monitors, if
any, that are reporting an error status.
o
Owing to a limitation of the JavaScript engine, calculated metric expressions
cannot include values greater than 252. For more details, see http://ecmainternational.org/ecma-262/5.1/.
Check the validity of the expression - optional
To enable you to distinguish between the metrics, operators, and values within an expression,
they are separately color-coded. If any character is missing from a metric or operator, the
metric or operator remains black.
To check the validity of the expression at any time while creating the expression, click
Validate.
How to Set Combined Threshold Calculated Metrics
You can create calculated metrics which include logical expressions that can be used in thresholds.
To do this, configure two calculated metrics in the Expression field in the New/Edit Calculated
Metrics dialog box, and insert an operator between those two calculated metrics.
Example:
(utilization cpu#11==3)&(utilization cpu#12==5)
HP SiteScope (11.23)
Page 377 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
UI Descriptions
Calculated Metrics Settings
UI Element
Description
New. Enables you to creates a new calculated metric in the New/Edit Calculated
Metrics dialog box. For details, see "New/Edit Calculated Metric Dialog Box"
below.
Delete. Deletes the selected calculated metric.
Edit. Enables you to edit the selected calculated metric.
For details, see "New/Edit Calculated Metric Dialog Box" below.
Name
Name that describes the calculated metric.
Expression
Defines the calculated metric. Expressions include metrics, operators, and
values. For details, see "New/Edit Calculated Metric Dialog Box" below.
Description Optional description of the calculated metric to make it easier to understand what
the calculated metric does.
New/Edit Calculated Metric Dialog Box
This dialog box enables you to create a new calculated metric or edit an existing calculated metric.
UI Element
Description
Calculated Metric Panel
Name
Name that describes the calculated metric. The name should be unique, to
distinguish it from the names of other calculated metrics.
If you do not enter a name, the default name is Calculated Metric, followed by
the number of the calculated metric. For example, if there already exists one
calculated metric for a monitor and you create an additional calculated metric for
that monitor, the default name of the additional calculated metric is Calculated
Metric 2.
Description Optional description of the calculated metric to make it easier to understand what
the calculated metric does.
Expression
Calculated metric expressions include metrics, operators, and values.
Validate
Checks the validity of the syntax of the expression in the Expression field. If the
expression is valid, the ok test
icon appears. If the expression is invalid, an
Error dialog box opens indicating that the expression could not be calculated.
Clear
Deletes the expression in the Expression field.
HP SiteScope (11.23)
Page 378 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
UI Element
Description
Metrics
Metrics to insert in the Expression field. The list of metrics is dynamically
updated based on the type of monitor that you are configuring. For example, for a
Disk Space monitor, the available metrics are <<percent full>> and
<<MB free>>.
To insert a metric in the Expression field, double-click the metric, or drag and
drop the metric into the Expression field. You can also manually enter the metric
in the Expression field. The selected metric appears in the Expression field in
purple. If any character is missing from a metric, the metric remains black; if you
click Validate, it appears highlighted.
Operators
Operators define the relation between the metric and the value. Operators contain
functions. For more details about operators, see "Operators" below.
To insert an operator in the Expression field, double-click the operator, or drag
and drop the operator into the Expression field. You can also manually enter the
operator in the Expression field. The selected operator appears in the
Expression field in blue. If any character is missing from an operator, the operator
remains black; if you click Validate, it appears highlighted.
Integration Panel
Monitored
Entity
Displays the name of the monitored entity for the current calculated metric. If
SiteScope is connected to Business Service Management (BSM), the Integration
Panel displays the CI that is reported to BSM. For more details about monitored
entities, see "Monitored Entity" on page 381.
Note: If you have selected a CI in the CI Type field in the HP Integrations
Settings panel, this CI Type appears as the monitored entity in the Calculated
Metric Integration Panel. For more information about the HP Integrations Settings
panel, see "HP Integration Settings" on page 311.
Operators
Operators include:
l
Arithmetic operators. +, -, *, /, (, ).
l
Boolean operators.
Logical
Binary
and
&
&&
or
|
||
not
~
!
Note: You can use the operator | followed by zero (that is, |0) at the end of an expression to
HP SiteScope (11.23)
Page 379 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
determine whether the expression is true or false. For example, if the metric
<<utilization cpu #1>> is greater than the metric <<utilization cpu #2>>, the
expression (<<utilization cpu #1>> > <<utilization cpu #2>>)|0 returns the
result 1, indicating that the expression is true. If the expression is false, it returns the result
0.
l
Relational operators. <, >, ==, !=, <=, >=.
l
JavaScript String Object Methods:
l
.length
.charAt()
.concat()
.indexOf()
.lastIndexOf()
.match()
.replace()
.search()
.split()
.slice()
.substr()
.substring()
toLowerCase()
.toUpperCase()
.valueOf()
SiteScope functions:
n
#Average() - Calculates the average (mean) value among a series of numbers or value of
numerical expressions, separated by commas. For example, #Average(value 1, value 2,
value 3) calculates the average of value 1, value 2, and value 3.
This function works only if Java version 7 is installed on each client side user station.
n
#Frequency() - Returns the value of the monitor running frequency in seconds. For example,
if the running frequency of a monitor is set at one minute, #frequency() returns the result
60.0.
n
#longToDate() - Converts a time stamp in numerical format to a regular readable format. The
function receives a number (Long) and converts it to a date string according to the date format
in the second parameter: #longToDate(Long, Date Format). The returned timestamp is the
number of milliseconds since January 1, 1970 00:00:00.000 GMT. If GMT on the SiteScope
server machine is set to +6 for example, then the “start date” will be 1st January 1970
06:00:00.000
n
#Max() - Returns the maximum value among a series of numbers or value of numerical
expressions, separated by commas. For example, #Max(value 1, value 2, value 3)
calculates the maximum value of value 1, value 2, and value 3.
This function works only if Java version 7 is installed on each client side user station.
n
#maxMetric() - Returns the name of the metric which has the maximum value. It works only if
the expression includes regular expressions.
For example, if the value of the metric <<Zone/l2sun23-z1/mem/%memory>> is greater than
the value of the metric <<Zone/l2sun23-z2/mem/%memory>>, then #maxMetric
HP SiteScope (11.23)
Page 380 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
(<<Zone/l2sun23-z1/mem/%memory>>,<<Zone/l2sun23-z2/mem/%memory>>) returns
<<Zone/l2sun23-z1/mem/%memory>> (but not its value).
This function works only for dynamic monitors.
n
#Min() - Returns the minimum value among a series of numbers or value of numerical
expressions, separated by commas. For example, #Min(value 1, value 2, value 3)
calculates the minimum value of value 1, value 2, and value 3.
This function works only if you have installed Java version 7.
n
#minMetric() - Returns the name of the metric which has the minimum value. It works only if
the expression includes regular expressions.
For example, if the value of the metric <<Zone/l2sun23-z1/mem/%memory>> is less than the
value of the metric <<Zone/l2sun23-z2/mem/%memory>>, then #minMetric
(<<Zone/l2sun23-z1/mem/%memory>>,<<Zone/l2sun23-z2/mem/%memory>>) returns
<<Zone/l2sun23-z1/mem/%memory>> (but not its value).
This function works only for dynamic monitors.
n
#Previous() - Returns the value of a metric from the previous monitor run. For example, if the
MB free value of a memory monitor on its last run was 7828 MB and its current run is 7821
MB, #previous(<<MB free>>) returns the result 7828.0.
n
#Sum() - Returns the sum of a series of numbers or value of numerical expressions,
separated by commas. For example, #Sum(value 1, value 2, value 3) calculates the
sum of value 1, value 2, and value 3.
This function works only if Java version 7 is installed on each client side user station.
n
#valueOf() - Returns the value of the metric. The metric name should be inserted inside
parentheses, without angle brackets.
For example, you enter the expression #valueOf(#maxMetric(/(.)/cpu*1/) +
"cpuClick"). If the value of the regular expression (/(.)/cpu*1) is VM1/cpuBla1, then the
returned value is VM1.
This function works only for dynamic monitors.
Monitored Entity
Most SiteScope monitors report one monitored CI to BSM. This CI automatically appears as the
monitored entity in the Monitored Entity field. For monitors that report separate CI for each metric,
the calculated metric is connected to CIs according to the following table:
Note: After you have created a calculated metric with a particular monitored entity, you cannot
later select another monitored entity for that calculated metric. In that case, you need to delete
the calculated metric and create a new one with the desired monitored entity.
HP SiteScope (11.23)
Page 381 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
Monitor Name
CI Type
Dynamic Disk Space Monitor
Always a computer.
SAP CCMS Monitor
SAP System
Note: If a SAP CCMS monitor is not
connected to BSM, or you do not have the
license required to enable this monitor type,
NODE appears in the Monitored Entity field.
SAP Work Processes Monitor
SAP ABAP Application Server
Note: If a SAP Work Processes monitor is not
connected to BSM, or you do not have the
license required to enable this monitor type,
NODE appears in the Monitored Entity field.
Siebel Web Server Monitor
Siebel Web Server Extension
Note: If a Siebel Web Server Extension
monitor is not connected to BSM, or you do
not have the license required to enable this
monitor type, NODE appears in the Monitored
Entity field.
Siebel Application Server Monitor
Siebel Application Server
Note: If a Siebel Application Server monitor is
not connected to BSM, or you do not have the
license required to enable this monitor type,
NODE appears in the Monitored Entity field.
HP SiteScope (11.23)
Page 382 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
Monitor Name
CI Type
Solaris Zones Monitor
In regular mode:
You must select a monitored entity by clicking
the Monitored Entities
button and
selecting a monitored entity from the
monitored entity tree.
In template mode:
VMware Performance Monitor
If the calculated metric includes a free regular
expression, the "Monitored Entity is set by
regular expression" message appears in the
Monitored Entity field. This means that the
monitored entity is calculated automatically
during the template deployment. However,
you may still select a monitored entity by
clicking the Monitored Entities
button
and selecting a monitored entity from the
monitored entity tree.
If the calculated metric does not include a free
regular expression, you must select a
monitored entity from the monitored entity
tree.
For information about free regular
expressions, see "Free regular expressions"
on page 385.
HP SiteScope (11.23)
Page 383 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
Monitor Name
CI Type
VMware Host CPU Monitor
VMware Host Network Monitor
If the calculated metric includes a free regular
expression, the "Monitored Entity is set by
regular expression" message appears in the
Monitored Entity field. This means that the
monitored entity is calculated automatically
for each calculated metric that results from the
calculated metric. However, you may still
select a monitored entity by clicking the
VMware Host State Monitor
Monitored Entities
button and selecting
a monitored entity from the monitored entity
tree.
VMware Host Memory Monitor
VMware Host Storage Monitor
VMware Datastore Monitor
HP SiteScope (11.23)
If the calculated metric does not include a free
regular expression, you must select a
monitored entity from the monitored entity
tree.
For information about free regular
expressions, see "Free regular expressions"
on the next page.
Page 384 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
Free regular expressions
A free regular expression is a regular expression that is not inside a function. For more details about
regular expressions, see "Regular Expressions" on page 192.
For example, the following is a free regular expression:
/.*VirtualMachine/.*/cpu/usagemhz.average[]/
This is calculated into four different calculated metrics, as follows:
labm3esx01/VirtualMachine/sisqavm01/cpu/usagemhz.average[]
labm3esx01/VirtualMachine/sisqavm02/cpu/usagemhz.average[]
labm3esx01/VirtualMachine/sisqavm03/cpu/usagemhz.average[]
labm3esx01/VirtualMachine/sisqavm04/cpu/usagemhz.average[]
Each of these calculated metrics has its own monitored entity according to the virtual machine
name, as follows:
sisqavm01
sisqavm02
sisqavm03
sisqavm04
Tips/Troubleshooting
Troubleshooting/Limitations
l
The Calculated Metrics Settings panel does not appear for custom monitors. You can create
calculated metrics in custom monitors only inside their data processing script.
l
You can create calculated metrics when you create a template monitor instance. For details on
creating template monitors, see "How to Create a Monitoring Structure Using a Template" on
page 782.
l
You can limit the number of calculated metrics per monitor that can be displayed in the
Dashboard (default is 100). In the case of dynamic monitors, the number of calculated metrics
per monitor is calculated after SiteScope has evaluated all dynamic monitors regular
expressions. You can change the maximum number of calculated metrics per monitor in
Preferences > Infrastructure Preferences > Calculated Metrics Settings. For details, see
"Calculated Metrics Settings" on page 639.
Note: If you reduce the maximum number of calculated metrics to less than the number of
calculated metrics already configured for that monitor, the number of calculated metrics that
appear in the Dashboard and in the calculated metrics table for that monitor is the new
maximum number of calculated metrics and an error is written to RunMonitor.log.
l
The JMX monitor currently supports both calculated metrics and arithmetic counters. However,
it is planned that arithmetic counters will be removed from the JMX monitor in the future and
upgraded to calculated metrics. For details, see Arithmetic Counters in the SiteScope Monitor
HP SiteScope (11.23)
Page 385 of 1293
Using SiteScope
Chapter 27: Create Calculated Metrics
Reference Guide.
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. To obtain a calculated metric result
for the monitor that has metrics, you need to create a new calculated metric for that monitor.
HP SiteScope (11.23)
Page 386 of 1293
Chapter 28: Dynamic Monitoring Mechanism
Elastic or dynamic configuration is a way to 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 as changes occur in the system (for example, as disks/MBeans are added to or removed
from the server, as datastores and virtual disks are added or removed from the VMware
Datacenters, or as virtual machines move from one host system to another). In addition, you can
select counter patterns to be used as threshold conditions. In this way, thresholds are also updated
automatically when the counters are updated.
Learn About
This section includes:
l
"List of Dynamic Monitors" below
l
"Dynamic Monitoring Mechanism" below
l
"Calculated Metrics for Dynamic Monitors" on page 389
List of Dynamic Monitors
The following dynamic monitors are available in SiteScope:
l
Dynamic Disk Space Monitor
l
HP Vertica JDBC Monitor
l
Dynamic JMX Monitor
l
KVM Monitor
l
Generic Hypervisor Monitor
l
VMware Datastore Monitor
l
Hadoop Monitor
l
VMware Host Monitors
For task details, UI description, and tips/troubleshooting, see the specific dynamic monitor in the
SiteScope Monitor Reference guide.
Dynamic Monitoring Mechanism
The dynamic monitoring mechanism works as follows:
l
Define Counter Patterns
To enable the monitor to dynamically update counters, you define the counter patterns you want
to monitor using regular expressions. SiteScope uses Perl regular expressions for pattern
matching. For example, if you enter /cpu.*/ or cpu, any counters with cpu in their name match
this pattern and are added to the counters list.
HP SiteScope (11.23)
Page 387 of 1293
Using SiteScope
Chapter 28: Dynamic Monitoring Mechanism
Examples:
Dynamic Disk Space monitor: 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.
Dynamic JMX, Hadoop monitor: If you enter the pattern
/java.lang/ClassLoading/.*/, the monitor retrieves all the ClassLoading counters in
the JMX application, such as TotalLoadedClassCount, UnloadedClassCount,
LoadedClassCount, ObjectName.
KVM/Generic Hypervisor monitor: If you enter the pattern /.*/Domains
Information/.*/Used Memory/, the monitor retrieves the Used Memory counter for all
VMs.
VMware Datastore monitor: If you enter the pattern /.*/.*/accessible/, the monitor
retrieves the accessible counter for all datastores.
VMware Host monitor: If you enter the pattern
/.*/VirtualMachine/.*/cpu/usage.average\[\]/, the monitor retrieves the
usage.average[] counter for all VMs.
l
Set Update Frequency
You set the frequency of the dynamic update mechanism at the monitor level. This is the
frequency that SiteScope uses to update the counters retrieved from the server. This enables
running the update mechanism at a frequency that is appropriate for the monitor type. The
update frequency should not be less than the monitor run frequency in Monitor Run Settings. For
example, if the monitor runs every 10 minutes, the dynamic update frequency should be at least
10 minutes.
l
Use Counter Patterns as Threshold Conditions
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 example, in the Dynamic
JMX example above, you could set an error threshold based on the
/java.lang/ClassLoading/.*/ counter pattern.
The thresholds list always contains the counter patterns that were defined in the counters
pattern table (not the final counters that were found). The values in this list are updated
according to changes you make in the counter patterns table.
l
Update Mechanism
During each update, the monitor connects to the server and automatically updates the status of
each counter that matches the pattern defined by the regular expression as follows:
HP SiteScope (11.23)
Page 388 of 1293
Using SiteScope
Chapter 28: Dynamic Monitoring Mechanism
n
It adds counters that match the patterns defined by the regular expression, and updates the
status of each counter.
n
If the Continue displaying counters that no longer exist after update option is cleared, it
removes counters that no longer exist (avoids errors unnecessarily being logged). If this
option is selected (the default setting), counters are only added; not deleted.
n
If you also defined a threshold using a counter pattern, then thresholds are added or removed
according to the counters available on server that match the pattern.
In this way, the monitor automatically configures itself with counters on the relevant dynamic
environment components.
If there are no counters that match the monitor patterns and no static counters, then the changes
are not saved since the monitor must have counters.
Note: When you define static counters (with no regular expression), these counters are
never removed from the monitor, even if they are no longer available on the server.
Calculated Metrics for Dynamic Monitors
A calculated metric is a metric produced by performing an arithmetic function or logical operation on
existing SiteScope metrics. The calculated metric then appears in the Thresholds Settings panel,
enabling you to configure thresholds based on that metric. For example, you can create a calculated
metric to calculate the average of two or more existing metrics for a monitor instance, and then
configure a threshold that triggers an alert if that average exceeds a certain number. For more
details on calculated metrics, see "Create Calculated Metrics" on page 374.
When creating a calculated metric expression for dynamic monitors, you can use both static
metrics (for which you can use calculated metrics normally, without using patterns), and you can
use regular expressions that are part of the dynamic monitor’s configured patterns.
For example, the Dynamic Disk Space monitor tracks how much disk space is currently in use on
your server. When dynamic monitoring is configured, the metrics 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 system changes.
You can configure calculated metrics for dynamic monitors based on a common function, such as
average or sum.
Example:
To calculate the total free space for all disks, create a calculated metric expression that is the
sum of all metrics created from /.*/MB free/ as follows:
SUM(<</.*/MB free/>>)
Note: You can use only one regular expression per calculated metric that is not part of a
function (that is, a calculated metric that returns only one result).
HP SiteScope (11.23)
Page 389 of 1293
Chapter 29: Monitor XML Documents
SiteScope's content matching capabilities is an important function in monitoring networked
information systems and content. For SiteScope monitors that provide content matching, the basic
content matching is available through the use of Perl regular expressions.
SiteScope also includes the capability of matching document content by traversing XML
documents. For example, you can include an XML match content string using the URL Monitor and
Web Services Monitor to match an XML element name, an attribute of an XML element, or the
content of an element. You can use this to check for content in XML based Web pages, SOAP or
XML-RPC documents, and even WML pages served to WAP-enabled devices.
Learn About
Content Matching for XML Documents
The syntax of XML match content strings reflects the hierarchal structure of the XML document.
Match content strings that start with "xml" are recognized as element names within an XML
document. The element names are added, separated by periods, in the order of their relationship to
the root element. For example, in the document weather.xml the root element is <weather>. This
element includes child elements named <area>, <skies>, <wind>, <forecast>, and so forth. To
access the content of these XML elements or their attributes, you would use a syntax like
xml.weather.area.
To check that specific content or value is present, add an equals sign after the element name
whose content you are testing and then add the value of the content. If there are multiple instances
of an element name in the document, you can check a particular instance of that element by adding
the number indicating the order of the element in the document in square brackets (see the example
in the table below). You can also test for multiple elements or values by separating individual search
strings with commas. The table below gives several examples of the syntax used to match content
in XML documents.
Example Match Content
Description
xml.weather.temperature
Succeeds if any <weather> node in the document
contains one or more <temperature> elements. The
content of the <temperature> elements is returned by
the monitor. If no <temperature> element is found
within the <weather> node, an error is returned.
xml.weather.temperature=20
Succeeds if any <weather> node in the document
contains one or more <temperature> elements
where the content of the <temperature> element
equals 20. The content of the <temperature> element
is not returned by the monitor if the match is found.
An error is returned if no <temperature> element is
found within the <weather> node or if no
<temperature> element contains the value 20.
HP SiteScope (11.23)
Page 390 of 1293
Using SiteScope
Chapter 29: Monitor XML Documents
Example Match Content
Description
xml.weather.forecast.
[confidence]
Succeeds if any <weather> node in the document
contains a <forecast> element that has an attribute
called confidence. The value of the confidence
attribute is returned by the monitor if the match is
found. An error is returned if no <forecast> element is
found within the <weather> node or if no confidence
attribute is found.
xml.weather.forecast[3].
[confidence]=50
Succeeds if any <weather> node in the document
contains three or more <forecast> elements where
the third <forecast> element has a confidence
attribute with a value of 50. An error is returned if the
<weather> node has fewer than three <forecast>
elements or if the value of the confidence attribute is
not equal to 50.
xml.weather.temperature=20,
xml.weather.skies=rain
Succeeds if any <weather> node in the document
contains one or more <temperature> elements
where the content of the <temperature> element
equals 20 and if any <weather> node contains one
or more <skies> elements where the content of the
<skies> element equals rain. Returns an error if
either of the matches fails.
xml.wml.card.p.table.tr.td.anchor=Home Checks the content of <anchor> elements in the
Page
designated path of a WML document. Succeeds if
any <card> node containing table cells with one or
more <anchor> elements where the content of any of
the <anchor> elements equals "Home Page."
XML Content Match Values in Monitor Configurations
Monitors like the URL Monitor have a content match value that is logged to the SiteScope monitor
data log and can also be used to set error and warning status thresholds for the monitor. The values
of the XML names are saved as the content match values for the monitor.
For example, if the match content expression was xml.weather.temperature and the document
was the contents of the file weather.xml, then the content match value would be 46.
You can then set the error, warning, and good status thresholds in the Advanced Options section for
the monitor to compare your specific thresholds to the value returned by the content match.
For example, if you are monitoring temperature values and want to be alerted when the temperature
value drops below 72 degrees, you could set the monitor status thresholds as follows:
Error if
content match < 72
Warning if
content match = 72
Good if
content match > 72
HP SiteScope (11.23)
Page 391 of 1293
Using SiteScope
Chapter 29: Monitor XML Documents
With this configuration, the monitor checks the content of the temperature element and then
compares it to the error and warning thresholds. In the example above, the status of the monitor
would be error because the temperature value is 46, which is less than 72.
HP SiteScope (11.23)
Page 392 of 1293
Part 5: Integration Monitors
Integration monitors are used to capture and forward data from third-party domain managers or
applications (typically Enterprise Management Systems (EMS)) into BSM.
These monitor types require additional licensing and may only be available as part of another HP
product. For more information about Integration Monitor capabilities, see "Integration Monitors
Overview" on page 394.
HP SiteScope (11.23)
Page 393 of 1293
Chapter 30: Integration Monitors Overview
Integration monitors are run by the SiteScope data collector and are used to capture and forward
data from third-party domain managers or applications (typically Enterprise Management Systems
(EMS)) into BSM.
There are two levels of configuration for collecting the data and forwarding that data to BSM:
l
Required: The monitors must be configured to properly map to the monitored system and
collect the required data samples, whether in the form of events, metrics, or tickets. The field
mapping from the monitored system is done by selecting a data type in the Field Mapping setting
and editing the corresponding script in a text editor.
l
Optional: The data can also be mapped to a topology to forward data to the correct CI hierarchy
in BSM. This enables the monitor to accurately report status to the required CIs within BSM for
use by the different applications in the product. The topology settings are configured using a
topology script that is loaded depending on the type of topology you want to create.
Note: You can have SiteScope report only the topology discovered by the SiteScope
Technology Integration monitors, without reporting the data. For details, see "Report
Topology Without Data" on page 485.
This section also includes:
l
"Integration Monitor Categories" below
l
"Field Mapping Data Types" on the next page
Integration Monitor Categories
Integration monitors can be divided into two categories: Application-Specific monitors and Generic
Integration monitors.
Application-Specific Monitors
These integration monitors are designed for use with specific EMS applications. These monitors
are predefined with the required field mapping and topology settings.
The monitors include:
l
HP OM Event Monitor. For details, see the SiteScope Monitor Reference Guide in the
SiteScope Help.
l
HP Service Manager Monitor. For details, see the SiteScope Monitor Reference Guide in the
SiteScope Help.
l
NetScout Event Monitor. For details, see the SiteScope Monitor Reference Guide in the
SiteScope Help.
HP SiteScope (11.23)
Page 394 of 1293
Using SiteScope
Chapter 30: Integration Monitors Overview
The scripts for both the field mapping and the topology settings can be further configured to suit the
needs of your specific environment.
Note:
l
The HP OM Event monitor is not available when SiteScope is connected to BSM version
9.00 or later (unless the monitor was created in an earlier version of SiteScope that was
upgraded to SiteScope 11.20). OM events can be forwarded to BSM 9.00 from the HPOM
Server, provided you have an Event Management Foundation license and an integration is
configured between Operations Manager and BSM.
l
Topology Settings are not available for the NetScout Event Monitor.
Generic Integration Monitors
Note: Generic Integration monitor are used for backward compatibility with third-party
integrations when SiteScope is connected to BSM versions earlier than 9.20. For all new thirdparty data integrations when SiteScope is connected to BSM 9.20 or later, HP recommends
BSM Connector. BSM Connector provides more functionality and coverage regarding the
types of third-party data that can be collected than Technology Integration monitors. For details
on BSM Connector, see the BSM Application Administration Guide in the BSM Help.
Technology Integration Monitors designed for use with most EMS applications that support
extraction of data from a database, log file, SNMP trap, or Web service interface.
The field mapping and topology settings for these monitors must be configured by loading the
applicable scripts and editing them in a separate text editor during monitor creation.
The monitors include:
l
Technology Database Integration Monitor. For details, see the SiteScope Monitor Reference
Guide in the SiteScope Help.
l
Technology Log File Integration Monitor. For details, see the SiteScope Monitor Reference
Guide in the SiteScope Help.
l
Technology SNMP Trap Integration Monitor. For details, see the SiteScope Monitor Reference
Guide in the SiteScope Help.
l
Technology Web Service Integration Monitor. For details, see the SiteScope Monitor Reference
Guide in the SiteScope Help.
Field Mapping Data Types
The integration monitors use field mapping scripts to correctly map the data they collect to a format
recognizable by BSM. For the generic integration monitors, you configure and customize the
mapping as required. When you select a field mapping type, you can use the script editor provided,
or you can copy the script into your preferred text editor, make your changes, and then copy the
script back into the field mapping text box.
HP SiteScope (11.23)
Page 395 of 1293
Using SiteScope
Chapter 30: Integration Monitors Overview
Tip: The mapping for the application-specific monitors is not editable while configuring the
monitor. We recommend that you use the out-of-the-box integration mapping already
configured for those monitors.
When configuring the generic integration monitors, select from the following types of sample
scripts:
l
Metrics. Used to collect time-based data. Data collected by Integration Monitors that use the
metrics data type is integrated into BSM as typical SiteScope data and can be viewed in all
contexts that support viewing SiteScope data (for example, Service Health, Service Level
Management, SAM, user reports, and so on). For more details, see "Configure Integration
Monitors to Collect Metrics Data" on page 420.
l
Events
n
Common Events. Used to integrate events collected from third-party domain managers or
applications to BSM 9.x. Unlike the legacy EMS events, the Common Event integration allows
you to manage the events in Operations Management event sub system and the Service
Health console. In addition, the common event channel provides the option to report topology to
BSM without reporting the data. For more details, see "How to Configure Integration Monitors
to Collect Data on Common Events" on page 459.
n
Legacy Events. Used to collect data on specific events in BAC 8.x and earlier (retained for
backward compatibility). Data collected by Integration Monitors that use the event data type is
integrated into BSM using the UDX framework and can be viewed in contexts that support the
display of UDX data (Event Log, Service Health, trend reports). The data can also be accessed
using the BSM API. For more details, see "How to Configure Integration Monitors to Collect
Data on Legacy Events" on page 463.
Note: Events sent by EMS applications are event samples. They are not the same as
Operations Management events in BSM.
l
Tickets. Used to collect incidents and events from ticketing systems. Data collected by
integration monitors that use the ticketing data type is integrated into BSM and can be viewed in
Service Health and Service Level Management. For more details, see "How to Configure
Integration Monitors to Collect Ticketing Data" on page 477.
The Database, Log File, SNMP Trap, and Web Service Technology Integration Monitors can be
configured to work with these data types. You use the field mapping scripts that come prepackaged
with SiteScope as a basis for creating a customized configuration required for your specific
environment. When you configure an integration monitor, you select the data type to load the
required script and edit the script to collect the data you want to forward to BSM.
For details on customizing the field mapping scripts, see:
l
"Integration Monitor Field Mapping for Event Samples" on page 457
l
"Integration Monitor Field Mapping for Metrics Samples" on page 420
HP SiteScope (11.23)
Page 396 of 1293
Using SiteScope
Chapter 30: Integration Monitors Overview
l
"Integration Monitor Field Mapping for Ticketing Samples" on page 476
HP SiteScope (11.23)
Page 397 of 1293
Chapter 31: Field Mapping Structure
The field mapping contains instructions on how to process the data as it arrives at the integration
monitors. The instructions that constitute the field mapping are grouped into event handlers—
independent sections that contain instructions relevant to specific data. Each event handler
contains a matching condition by which SiteScope can determine whether to use a particular
event handler for an arriving event.
When an event or metrics data arrives at the integration monitor, it iterates over the different event
handlers in the field mapping, in the order that they appear, testing the matching condition of each
handler. If a matching handler is found, the monitor uses the instructions within that handler to
process the event and perform the action defined for this handler (for example, forward it to BSM or
discard). No further sections are checked after the first match. If no matches are found, the event is
discarded.
In addition to the event handlers, the field mapping can contain special entries that affect the
integration monitor engine as a whole. These values are grouped into the [$DEFAULT_
PARAMETERS$] section. This section defines default values for tags that are common for all
handlers. Any tag can be set in this section of the field mapping. It is used to create a reported value
unless overridden in the matched event handler. For each incoming event, this event handler is
always run prior to the matched event handler.
For details on event handler structure, see "Event Handler Structure and Syntax" on page 409.
CI Resolution Hint Formats
You can use the following formats for CI resolution hints:
Format
Description
Example
Standalone CIs
that do not
exist in the
context of
Node and
descendant CI
types
For example, Business Application,
Business Service, or Siebel Enterprise. CI
resolution hint should be a CI name.
For a Business Service CI
named
myBusinessService, the
CI resolution hint would
be:
MeasurementCIHint(1)
="myBusinessService".
Note: The CI name must
be unique in RTSM.
Node topology
and
descendant CI
types
CI resolution hint should be a fully qualified
domain name or an IP address of a node.
To report a node with IP
address 12.34.56.78, the
CI resolution hint would
be:
"12.34.56.78" or
"<MachineName>".
HP SiteScope (11.23)
Page 398 of 1293
Using SiteScope
Chapter 31: Field Mapping Structure
Format
Description
Example
CIs which exist
in the context
of Node and
descendant CI
types
For example, CIs which belong to CI types that
inherit from Running Software, Node Element,
or Network Entity. You must specify in the hint
both the Node/descendant CI and the CI
connected to the Node/descendant CI,
separated by @@.
For an Oracle Database CI
connected to the
Node/descendant CI, the
CI resolution hint should
be in the format:
HP SiteScope (11.23)
"<oraclesid>:<product
name>@@<fqdnhostname>"
.
Page 399 of 1293
Chapter 32: Topology Settings for Technology
Integration Monitors
To report topology to BSM, you can select an out-of-the-box topology script for your integration
monitor. You do this while creating an integration monitor in the Topology Settings panel.
Jython language is used for developing topology scripts. For details on how to work in Jython, refer
to http://www.jython.org and http://www.python.org.
Selecting a Topology
When working with generic integration monitors, you can select from the following topology settings
(the topology scripts that are available depend on the field mapping type selected):
l
Computer. Creates a topology with a Computer CI. It is available for Common Events data
type only.
l
Computer - Running Software. Creates a topology with a Computer CI and a Running
Software CI connected to it with a Composition relationship. It is available for Common
Events data type only. The following illustrates the topology created for the Computer - Running
Software integration type which retrieves events data from a third-party system:
l
Custom. You create your own topology if you want the retrieved data to be forwarded to specific
CIs and not one of predefined topology scripts. It is available for all field mapping types. You
should only select Custom if you are familiar with the Jython language, because no topology
script is loaded and you must create the topology script in Jython yourself. We recommend that
you begin with one of the predefined scripts.
Tip: When selecting a topology setting, you can have it report only the topology discovered by
the SiteScope Technology Integration monitors, without reporting the data. For task details,
see "Report Topology Without Data" on page 485.
HP SiteScope (11.23)
Page 400 of 1293
Using SiteScope
Chapter 32: Topology Settings for Technology Integration Monitors
Legacy Topology Scripts
The following are legacy topology scripts:
l
"Node Topology" below
l
"Node - Running Software Topology" below
l
"Tickets" on the next page
Node Topology
Creates a Node CI with an EMS monitor CI connected to it with Monitored By relationship. The
EMS Monitor CI propagates status onto the Node CI.
Node - Running Software Topology
Creates a topology with a Node CI and a Running Software CI connected to it with a Composition
relationship, and an EMS monitor CI which can be connected to either the Node CI or the Running
Software CI with Monitored By relationship.
In this integration type, there are two types of data that can be retrieved from a third-party system:
events related to Running Software and events related to Nodes.
The following table illustrates the topology created for each type of event:
HP SiteScope (11.23)
Page 401 of 1293
Using SiteScope
Chapter 32: Topology Settings for Technology Integration Monitors
Topology Created for Running Software-Related
Events
Topology Created for Node-Related
Events
You can configure which events are related to Running Software and which are related to Node by
editing the topology script as follows:
Search for the following string in the topology script:
if (subject != "system"):
The variable subject represents the subject field in the event. The value system is an example of
possible values representing the data that is considered related to Node and not forwarded to the
Running Software CI.
Tickets
Creates a Business Service CI with an EMS monitor CI connected to it with Monitored By
relationship. The EMS Monitor CI propagates status onto the Business Service CI. It is available
for Tickets data type only.
For more information on the legacy integration types, see "Understanding Node, Tickets, or Node Running Software Integration Types" in the BSM section of the Integrations tab in the HP Software
Integrations site.
Editing the Topology Script
To configure the topology, you can edit the topology script that appears in the Topology Settings
HP SiteScope (11.23)
Page 402 of 1293
Using SiteScope
Chapter 32: Topology Settings for Technology Integration Monitors
panel when creating an integration monitor. You can use the script editor provided, or use any other
script editor.
You can choose one of the predefined topologies which are already configured with the necessary
information. Following are the guidelines for editing the script if you want to create your own
topology.
General Script Editing Guidelines
l
The Jython language is sensitive to spaces and tabs. For more information on Jython, see
http://wiki.python.org/moin/HowToEditPythonCode.
l
You must leave the import section of the predefined topology scripts as is and only add to it.
l
The main body of the script is mandatory and consists of:
def DiscoveryMain(Framework)
This main function is responsible for creating Object State Holder Vector (OSHV) results. It
holds the CI and CI relationship data, and how to map the incoming samples to the CIs.
l
Use the built-in "logger" to debug the topology scripts when samples arrive. You do this by
modifying the level and type of information reported to the log file:
a. Add the logger import statement before system_lib import statement to the topology script,
for example:
import logger
…
import system_lib
b. Change the log file settings in the <SiteScope root
directory>/conf/core/Tools/log4j/PlainJava/bac_integration.properties file as follows:
Open the bac_integration.properties file in a text editor and locate the following lines in the
file:
# Jython logger
log4j.category.PATTERNS_DEBUG=${loglevel}, discovery.appender
Change the argument of log4j.category.PATTERNS_DEBUG from ${loglevel} to
DEBUG, as follows:
log4j.category.PATTERNS_DEBUG=DEBUG, discovery.appender
HP SiteScope (11.23)
Page 403 of 1293
Using SiteScope
Chapter 32: Topology Settings for Technology Integration Monitors
c. Save the file. It may take a few seconds for the changes to take effect.
The debug data is written to the <SiteScope root directory>/log/discovery.log file.
Guidelines Relating Specifically to Integration Monitors
l
When using field mapping, you can use the field mapping fields as an input for the topology
script. For example, if using common event mapping, you can access the value of the Category
field in the following way:
category = Framework.getDestinationAttribute("Category").
In addition, you can access values of the "monitor variables", such as group0, group1, and so
forth, from Technology Log File Integration monitor, or the names of database columns in
Technology Database Integration monitor, or other variables in the other integration monitors.
For example, you can access the value of the group1 variable, in the following way:
group1 = Framework.getDestinationAttribute("group1")
l
If you report an EMS monitor CI in your script, each CI should not have more than one EMS
monitor CI as a leaf node.
l
For legacy event scripts, the following expressions must appear as the last lines in the script:
Framework.setUserObject("result_object",monitoredCiType)
return OSHVResult
The variable monitoredCiType is a type of CI being monitored by the EMS Monitor CI that
receives the event.
If the script creates more than one EMS Monitor CI for one retrieved event, you must determine
to which of the CIs that event belongs and passes status. You do this by assigning the correct
value to the monitoredCiType. For example, if the script creates one EMS Monitor CI for a
Running Software CI and one for a Node CI, and you want the event to pass status to the Node
CI, the value of the variable monitoredCiType should be "node".
Additional Documentation
For general information on topology scripts, see "Create Jython Code" and "Developing Jython
Adapters" in the RTSM Developer Reference Guide in the BSM Help.
For information about Java classes that can be used in topology scripts, see "HP Data Flow
Management API Reference" in the RTSM Developer Reference Guide in the BSM Help.
Notes and Limitations
l
The script for EMS topology from SiteScope 10.x is displayed in SiteScope in the previous
content language format, even if SiteScope is connected to BSM 9.00. For example, the Host CI
HP SiteScope (11.23)
Page 404 of 1293
Using SiteScope
Chapter 32: Topology Settings for Technology Integration Monitors
type appears in the script instead of Node.
l
If SiteScope is connected to BSM versions earlier than 9.00, the Hosts and Host-Software
elements topology script are displayed in the topology script list for the monitor instead of
Computer,Computer - Running Software, Node, and Node - Running Software.
HP SiteScope (11.23)
Page 405 of 1293
Chapter 33: How to Migrate Technology
Integration Monitors to BSM Connector
You can migrate existing technology integration monitors from SiteScope to BSM Connector. The
export downloads a technology integration monitor from SiteScope and converts it to the BSM
Connector format for import to BSM Connector. Such imported policies can be maintained and
further customized in BSM Connector. Exporting technology integration monitors for use in BSM
Connector enables you to use BSM Connector for all your third party integrations.
Note: The Export to BSM Connector policy functionality is relevant only where BSM
Connector 9.22 (or later) is integrated with BSM version 9.20 or later.
Supported SiteScope technology integration monitors
Only the following technology integration monitors with a metrics, common events, or legacy
events field mapping data type are supported for export in SiteScope:
l
Technology Database Integration Monitor
l
Technology Log File Integration Monitor
l
Technology Web Service Integration Monitor
Note: The Technology SNMP Trap Integration Monitor, HP OM Event Monitor, HP Service
Manager Monitor, and NetScout Event Monitor do not support export to BSM Connector
policies.
Migrate Technology Integration Monitors to BSM Connector Policies
1. In SiteScope, export the technology integration monitor that you want to migrate to BSM
Connector
a. In SiteScope, open the monitor properties for the technology integration monitor that you
want to export, and expand the Export to BSM Connector panel.
b. In the Export to BSM Connector panel, click the Export button, and select a folder on the
client file system in which to save the policy files, and then click Open.
c. The export process is performed, and a popup message displays the results
(success/error).
In case of an error, a detailed error message is written in <SiteScope root
directory>\logs\error.log.
The SiteScope monitor is converted to a policy data and a header file. The files are saved
to the selected location on the client machine in the format:
HP SiteScope (11.23)
Page 406 of 1293
Using SiteScope
Chapter 33: How to Migrate Technology Integration Monitors to BSM Connector
o
<policy_id>_data for the policy data file
o
<policy_id>_header.xml for the header file
where the policy_id is a generated UUID for the new policy.
2. Transfer the generated policy files to the BSM Connector system.
3. Import the migrated integration monitor to BSM Connector
Import the policy data file and the header file to a BSM Connector machine using the BSM
Connector's import policy mechanism. For details, see the BSM Connector online help system
(available from the toolbar of the BSM Connector user interface).
After importing the files, the policy can then be activated in BSM Connector like any other
policy.
HP SiteScope (11.23)
Page 407 of 1293
Chapter 34: How to Deploy Integration Monitors
Note: You can deploy integration monitors while working in:
l
A standalone SiteScope that reports to BSM
l
Directly in SAM Administration
The steps involved in configuring the integration depend on the type of sample data being captured
(metrics, events, or tickets), and on whether the data is mapped to a topology (in order to forward it
to the correct CI hierarchy in BSM).
Collect metrics samples
Select the Metrics field mapping data type to forward metrics data to BSM, and choose from the
following topology scripts:
l
Computer - Monitor. SiteScope reports this data to the Computer CI, a descendant of the
Node CI. For task details, see "How to Configure Integration Monitors to Collect Metrics Data
With Computer - Monitor Topology" on page 421.
l
Custom. Enables you to create your own topology. For task details, see "How to Configure
Integration Monitors to Collect Metrics Data With Custom Topology" on page 429.
l
No Topology. Select if you do not want to send any topology (although data is still sent). For
task details, see "How to Configure Integration Monitors to Collect Metrics Data With No
Topology" on page 441.
Collect event samples
Select the Common Events or Legacy Events field mapping data type to integrate events
collected from third-party domain managers or applications to BSM. Unlike the legacy EMS events,
the Common Event integration allows you to manage the events in Operations Management event
sub system and the Service Health console. In addition, the common event channel provides the
option to report topology to BSM without reporting the data.
l
For task details on using the common event integration, see "How to Configure Integration
Monitors to Collect Data on Common Events" on page 459.
l
For task details on using the legacy event integration, see "How to Configure Integration
Monitors to Collect Data on Legacy Events" on page 463.
Collect ticketing samples
Select the Tickets field mapping data type to forward ticketing data to BSM,
For task details on collecting incidents and events from third-party ticketing systems, see "How to
Configure Integration Monitors to Collect Ticketing Data" on page 477.
HP SiteScope (11.23)
Page 408 of 1293
Chapter 35: Event Handler Structure and Syntax
Each event handler has the following structure:
[name]Matching condition
Action directive
Tags
The names of Matching condition, Action directive, and additional directives start with the dollar
sign symbol ($). The names of tags should not start with the dollar sign.
Comments are permitted in the field mapping. The comment starts with either #, !, or ; character
and continues to the end of the line.
Note: Use only the mandatory and optional fields defined in the scripts when working with the
field mapping. See the tables in the following sections for more information.
This section also includes:
l
"Matching Condition" below
l
"Available Data Processing Operations" on the next page
l
"Conditional Expression" on page 415
l
"Action Directive" on page 415
l
"Tags" on page 416
l
"Integration Monitor Field Mapping Examples" on page 416
Matching Condition
The Match Condition must be a valid boolean expression. The expression can contain calls to the
operators and functions defined below. The expression can access the contents of the data that is
being processed using the dollar sign ($) notation. For example, if the incoming data is SNMP Trap,
then its enterprise OID can be accessed as $oid. For names specific to a monitor, refer to the
documentation of the relevant monitor type:
l
Technology Database Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
l
Technology Log File Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
l
Technology SNMP Trap Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
l
Technology Web Service Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
HP SiteScope (11.23)
Page 409 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
Note: The Match Condition expression is limited to 4,000 characters.
The matching condition has the form:
$MATCH=Boolean expression
where the Boolean expression is a combination of one of the expressions listed in "Available Data
Processing Operations" below. The value of the expression, which can be either true or false,
determines whether the event handler is be used to process the event or not.
Available Data Processing Operations
The language used in the field mapping is a simplified version of Java programming language,
which allows the following operations only.
Expressions and
Functions
Description
+
String concatenation.
Example: "trap type is " + $trap
<, <=, > , >=, ==, !=
Checks the numerical correctness of the expression. Can be used with
numeric values.
Example: $MATCH=$numberOfLines == 100
&&, ||
To be used to combine any of the above boolean expressions.
Example: $MATCH=$status.equals("ERROR") || ($numberOfLines ==
100)
true, false
Constant Boolean values.
Example: $MATCH=true
boolean contains
(String str)
Returns true if and only if this string contains the specified sequence of
char values.
For more details, see http://download.oracle.com/javase/7/docs/api/
java/lang/String.html#contains(java.lang.CharSequence).
Example: MonitorName=$group0.contains("monitor")? $group0 :
$group0 + "monitor"
boolean endsWith
(String suffix)
Tests if this string ends with the specified suffix.
For more details, see http://download.oracle.com/javase/7/docs/
api/java/lang/String.html#endsWith(java.lang.String).
Example: MonitorName=$group1.endsWith("Operations")? $group1 :
$group1 + "Operations"
HP SiteScope (11.23)
Page 410 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
Expressions and
Functions
boolean equals
(String anotherString)
Description
Compares this string to another string.
For more details, see
http://download.oracle.com/javase/7/docs/api/java/lang/
String.html#equals(java.lang.Object).
Examples:
$MATCH="ERROR".equals($status)
or
$MATCH=$status.equals("ERROR")
boolean
equalsIgnoreCase
(String anotherString)
Compares this String to another String, ignoring case considerations.
For more details, see
http://download.oracle.com/javase/7/docs/api/java/lang/
String.html#equalsIgnoreCase%28java.lang.String%29.
Examples:
$MATCH="ERROR".equalsIgnoreCase($status)
or
$MATCH=$status.equalsIgnoreCase("ERROR")
boolean exists(String
property)
Checks for an existence of a property in the processed event and make
sure that it is not an empty value.
Example: $MATCH=exist($status)
String getToken
(String str, String
delimiterRegular
Expression,int
zeroBasedTokenIndex
)
Splits input string according to a supplied delimiter (in regular
expression format), and returns one of the result strings according to a
specified zero-based index.
int indexOf
(String str)
Returns the index within this string of the first occurrence of the
specified substring.
Example: getToken($var, "/", 1) will produce "y" if $var equals "x/y/z"
For more details, see http://download.oracle.com/javase/7/docs/
api/java/lang/String.html#indexOf(int).
Example: Severity=$group0.lastIndexOf("Critical")>-1? "Critical" :
"Normal"
HP SiteScope (11.23)
Page 411 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
Expressions and
Functions
int indexOf
(String str, int
fromIndex)
Description
Returns the index within this string of the first occurrence of the
specified substring, starting at the specified index.
For more details, see http://download.oracle.com/javase/7/docs/
api/java/lang/String.html#indexOf(java.lang.String,%20int).
Example: Severity=$group0.indexOf("Critical",3)>-1? "Critical" :
"Normal"
boolean isDouble
(String number)
Checks if the input string can be interpreted as a double number.
boolean isEmpty()
Tests for an empty string (length() == 0).
Example: $MATCH=isDouble($size)
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#isEmpty().
Example: Description=$group1.isEmpty()?$group0 :$group1
boolean isInt
(String number)
Checks if the input string can be interpreted as an integer number.
int lastIndexOf (String
str, int fromIndex)
Returns the index within this string of the last occurrence of the
specified substring, searching backward starting at the specified index.
Example: $MATCH=isInt($size)
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#lastIndexOf(java.lang.String,%20int).
Example: Severity=$group0.lastIndexOf("Critical",2)>-1? "Critical" :
"Normal"
int lastIndexOf
(String str)
Returns the index within this string of the rightmost occurrence of the
specified substring.
For more details, see http://download.oracle.com/javase/7/docs/
api/java/lang/String.html#lastIndexOf(java.lang.String).
Example: Severity=$group0.lastIndexOf("Critical")>-1? "Critical" :
"Normal"
int length()
Returns the length of this string.
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#length().
Example: Description=$group1.length() <10 ? $group0+$group1
:$group1
HP SiteScope (11.23)
Page 412 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
Expressions and
Functions
boolean matches
(String regex)
Description
Tells whether or not the string matches the given regular expression.
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#matches(java.lang.String).
Example: Severity=$group0.matches("(.*)Critical(.*)")? "Critical" :
"Normal"
double parseDouble
(String number)
Use to convert strings to numeric values. The input string should be a
valid representation of an integer or a floating point number.
Note: Calling this function on a string that cannot be interpreted as a
number causes an error and the incoming data is dropped.
Example: $MATCH=parseDouble($size) > 10
int parseInt
(String number)
Use to convert strings to numeric values. The input string should be a
valid representation of an integer or a floating point number.
Note: Calling this function on a string that cannot be interpreted as a
number causes an error and the incoming data is dropped.
Example: $MATCH=parseInt($size) > 10
String resolveHostIP
(String hostName)
Performs DNS resolution from a server to its IP address.
If the DNS resolution fails, the function returns the value unknown
host.
Example: target_ip=resolveHostIP($host)
String
resolveHostName
(String hostIP)
Performs DNS resolution from an IP address to a fully qualified domain
name.
If the DNS resolution fails,
the function returns the original input host name.
Example: target_name=resolveHostName($host)
boolean startsWith
(String prefix)
Tests if this string starts with the specified prefix.
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#startsWith(java.lang.String).
Example: MonitorName=$group1.startsWith("Operations")? $group1 :
"Operations"+$group1
HP SiteScope (11.23)
Page 413 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
Expressions and
Functions
boolean startsWith
(String prefix, int
offset)
Description
Tests if the substring of this string beginning at the specified index
starts with the specified prefix.
For more details, see http://download.oracle.com/javase/7/docs/
api/java/lang/String.html#startsWith(java.lang.String,%20int).
Example: MonitorName=$group1.startsWith("Operations",2)? $group1
: "Operations" + $group1
long str_to_seconds
(String dateTime,
String format)
Calculates the timestamp (in seconds, since January 1, 1970 format)
held in the first String using the format in the second string.
True if the date specified in $time in yyyy-MM-dd HH:mm:ss.SSS format
is later than the current time.
For more details, see http://download.oracle.com/javase/7/docs/
api/java/text/SimpleDateFormat.html.
Example: $MATCH=str_to_seconds ($time,"yyyy-MM-dd
HH:mm:ss.SSS") > time()
Note: Use the following symbols to represent time:
Year - `y'; Month - `M"; Day of month - `d'; Hour - `H'; Minute - `m';
Second - `s'
String substring
(int beginIndex)
Returns a new string that is a substring of this string. The substring
begins with the character at the specified index and extends to the end
of this string.
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#substring(int).
Example: Title=$group0.substring(2)
String substring
(int beginIndex, int
endIndex)
Returns a new string that is a substring of this string.
For more details, see http://download.oracle.com/javase/7/docs/api/
java/lang/String.html#substring(int).
Example: Title=$group0.substring(2,9)
int time()
Returns the current time, in seconds, since January 1, 1970 format.
Example: $MATCH=$timeStampField > (time()-600)
True if the value of the $timeStampField is newer than ten minutes ago
(in seconds, since January 1, 1970 format).
HP SiteScope (11.23)
Page 414 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
Expressions and
Functions
String toLowerCase()
Description
Converts all of the characters in this to lower case using the rules of the
default locale.
Example: Title=$group0.toLowerCase()
String toUpperCase()
Converts all of the characters in this to upper case using the rules of the
default locale.
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#toUpperCase().
Example: Title=$group0.toUpperCase()
String trim()
Returns a copy of the string, with leading and trailing whitespace
omitted.
For more details, see http://download.oracle.com/javase/7/
docs/api/java/lang/String.html#trim().
Example: Category=$group3.trim()
Conditional Expression
One conditional expression is supported; the ? operator. This operator can be used to compose
three expressions into one. For example:
<Conditional part> ? <if true part> : <if false part>)
Action Directive
The action directive has the form:
$ACTION= SEND or DISCARD
TOPAZ_BUS_POST is the equivalent of SEND, which is used only for backwards compatibility.
The value of the Action directive defines whether the event is processed and forwarded to BSM, or
discarded. This value takes effect only if the matching condition within the handler had been
evaluated to positive value (that is, to true). The table below describes the effect of the different
actions.
Action
Description
For Use With
SEND(event)
Send the event to the BSM bus and database.
BSM
SEND(ss_t)
Send the metrics to RTSM as SiteScope Data.
BSM
DISCARD
Do not send the data to BSM.
events you want to filter out
Note: If you are using the metrics mapping, SEND(ss_t), the data is sent to the BSM database
as SiteScope data, and thus saved to the database. For details on metrics mapping, see
HP SiteScope (11.23)
Page 415 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
"Configure Field Mapping for Metrics Samples" on page 454.
Tags
In addition to directives, the event handler contains tags. Each tag represents a field if it is
forwarded to BSM. The tag's value can be evaluated when the event arrives to the integration
monitor.
The general format of a tag is:
name[:type]=value
The <name> is any string without spaces or dollar signs ($). The <type> specifies the type of field as
reported to BSM. It can be either INT, DOUBLE or STRING. The default type is STRING. You can
view available data processing operations in "Available Data Processing Operations" on page 410.
By defining a tag, you can customize event forwarding to BSM. Thus getting more value from the
external applications that create those events. For example, if the monitor pulls out data from a
database table column called AlertText, which contains a textual description of an alert, it is
possible to send that data to BSM by adding the following line to an event handler section:
[event handler]
$MATCH=true
$ACTION=SEND(event)
text=$AlertText
Note: When adding tags, always add them after the $MATCH and $ACTION.
Integration Monitor Field Mapping Examples
Example 1: Universal Event Handler
[post them all]
$MATCH=true
$ACTION=SEND(event)
severity:INT=SEVERITY_INFORMATIONAL
szAlarmText:STRING="post them all handler received an event"
Note that the $MATCH directive in the handler is set to true. This causes every event to match the
handler and therefore every event is sent to the BSM bus.
Example 2: Different Event Handlers for Different Severities
[Error Handler]
$MATCH= $status.equals("ERROR")
$ACTION=SEND(event)
severity:INT=SEVERITY_CRITICAL
[Info Handler]
$MATCH= $status.equals("INFO")CTION=SEND(event)
severity:INT=SEVERITY_INFORMATIONAL
HP SiteScope (11.23)
Page 416 of 1293
Using SiteScope
Chapter 35: Event Handler Structure and Syntax
[post them all]
$MATCH=true
$ACTION=SEND(event)
severity:INT=SEVERITY_INFORMATIONAL
In this example, an incoming event is matched against the Error Handler event handler. If the
handler's condition is true (that is, the value in the status field equals ERROR), then an event with a
field called severity, whose value is SEVERITY_CRITICAL, is sent to BSM. An event can be
matched only by a single handler. The first match stops the processing and therefore once an event
is matched by a section, it is not processed by the next handler.
If the event was not matched by the first handler, the second handler comes into action and its
match (which looks for status of INFO) is used to decide whether the second handler needs to take
action. Finally, if the event does not match the second handler, the third universal handler is
evaluated.
HP SiteScope (11.23)
Page 417 of 1293
Chapter 36: Troubleshooting and Limitations
This section describes troubleshooting and limitations when working with SiteScope Integration
Monitors.
Integration Monitor Logs
Integration Monitor activity is logged to <SiteScope root directory>\logs\
RunMonitor.log and <SiteScope root directory>\logs\bac_integration\bac_integration.log.
You can modify the level and type of information reported to the log file by changing the log file
settings in the <SiteScope root directory>\conf\core\
Tools\log4j\PlainJava\log4j.properties file. You can instruct the logging mechanism to:
l
Report logged information in less or greater detail than is reported by default.
l
Log all samples sent by Integration Monitors to BSM.
l
Log all received events from external EMS systems.
To modify log settings:
1. Open the log4j.properties file in a text editor.
2. To specify that samples sent by Integration Monitors to BSM be logged:
a. Locate the following lines in the file:
log4j.category.EmsSamplePrinter=${loglevel}, integration.appender
log4j.additivity.EmsSamplePrinter=false
b. Change the argument of log4j.category.EmsSamplePrinterfrom ${loglevel} to DEBUG,
as follows:
log4j.category.EmsSamplePrinter=DEBUG, integration.appender
c. Save the file. It may take a few seconds for the changes to take effect.
The results are logged to the bac_integration.log file.
3. To specify that all received events from external EMS systems be logged:
a. Locate the following lines in the file:
log4j.category.EmsEventPrinter=${loglevel}, monitors.appender
log4j.additivity.EmsEventPrinter=false
b. Change the argument of log4j.category.EmsEventPrinter from ${loglevel} to DEBUG, as
follows:
log4j.category.EmsEventPrinter=DEBUG, monitors.appender
HP SiteScope (11.23)
Page 418 of 1293
Using SiteScope
Chapter 36: Troubleshooting and Limitations
c. Save the file. It may take a few seconds for the changes to take effect. The results are
logged to the RunMonitor.log file.
Other Log and Troubleshooting Issues
l
Look for errors in <SiteScope root directory>\logs\error.log and in <SiteScope root
directory>\logs\bac_integration\bac_integration.log.
l
If samples are created and sent from SiteScope but cannot be seen in BSM Service Health,
Event Log, or SiteScope reports, search for the string ERROR or WARN in the wde.logl and
loader.logl files in the <BSM root directory>\log\mercury_wde\ directory to make sure the
samples were not dropped due to missing fields or values.
l
Increase the level of Service Health logging in <BSM
root directory>\conf\core\Tools\log4j\EJB\ble.properties file to verify that Service Health is
receiving samples. Locate the following parameter and change the log level status to DEBUG:
log4j.category.Trinity.BLE_SAMPLES=DEBUG, trinity.samples.appender
The results are logged to the <BSM root directory>\log\EJBContainer\TrinitySamples.log.
Tip: After you have determined the cause of the problem, we recommend that you set log
levels to their default settings so as not to overload the system.
Additional Troubleshooting Information
Additional troubleshooting information is located in the HP Software Self-solve Knowledge Base
(http://h20230.www2.hp.com/selfsolve/documents) (you must log on to the knowledge base with
your HP Passport ID) and in the following sections of the documentation:
l
For troubleshooting the Technology Database Integration monitor, see Technology Database
Integration Monitor in the SiteScope Monitor Reference Guide.
l
For troubleshooting the Technology Log File monitor, see Technology Log File Integration
Monitor in the SiteScope Monitor Reference Guide.
l
For troubleshooting the Technology SNMP Trap monitor, see Technology SNMP Trap
Integration Monitor in the SiteScope Monitor Reference Guide.
l
For troubleshooting the Technology Web Service Integration monitor, see Technology Web
Service Integration Monitor in the SiteScope Monitor Reference Guide.
HP SiteScope (11.23)
Page 419 of 1293
Chapter 37: Configure Integration Monitors to
Collect Metrics Data
When configuring the generic integration monitors, you can select the metrics data type to collect
time-based data. Data collected by Integration Monitors that use the metrics data type is integrated
into BSM as typical SiteScope data and can be viewed in all contexts that support viewing
SiteScope data.
This chapter includes:
l
"Integration Monitor Field Mapping for Metrics Samples" below. Provides an overview of
integration monitor field mappings for capturing metric samples.
l
"How to Configure Integration Monitors to Collect Metrics Data With Computer - Monitor
Topology" on the next page. Describes how to design and implement the EMS metrics flow
using the Computer - Monitor topology script.
l
"How to Configure Integration Monitors to Collect Metrics Data With Custom Topology" on page
429. Describes how to create an integration for metrics samples using the custom topology flow.
l
"How to Configure Integration Monitors to Collect Metrics Data With No Topology" on page 441.
Describes how to design and implement the EMS metrics flow using the No Topology script.
l
"Configure Field Mapping for Metrics Samples" on page 454. Provides a list of mandatory and
optional values (and examples) for the metrics script.
Integration Monitor Field Mapping for Metrics
Samples
You can enable capturing metrics data from Enterprise Management Systems (EMS), automated
support systems, and other management applications by configuring integration monitors and their
field mapping scripts.
Integration monitors depend on the field mapping you customize within the user interface in the
settings for the monitor. The mapping defines the processing of incoming data and defines the
output sample forwarded to BSM.
Integration Monitors designed for use with specific EMS applications (these currently include HP
OM, HP Service Center, and NetScout) can be configured without editing their field mapping script.
The mapping is predefined by HP and requires modification only if specific customizations are
required. For details on editing these field mapping scripts, see the description for the field mapping
element in the user interface pages for the monitor you are deploying.
For Technology Integration Monitors (Technology SNMP Trap, Technology Log File, and
Technology Database monitors), you must select the data type and the required script is loaded
directly into the field mapping text box. You must edit the field mapping script to suit your
organization's needs. The Technology Web Service Integration Monitor field mapping may also
need to be customized.
HP SiteScope (11.23)
Page 420 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
When you select the Metrics data type to forward metrics data to BSM, and you want to integrate to
BSM using topology settings, you can select from the following predefined topology scripts:
l
Computer - Monitor. Select to send SiteScope topology (monitors). This is the default setting.
SiteScope reports this data to the Computer CI, a descendant of the Node CI.
l
No Topology. Select if you do not want to send any topology (although data is still sent).
l
Custom. Enables you to create your own topology. Only select this option if you are familiar
with the Jython language, because you must create the topology script in Jython yourself.
For details on selecting a topology setting, see "Topology Settings for Technology Integration
Monitors" on page 400.
Note: SiteScope uses indicator definitions for monitor CIs created by the integration that are
defined in BSM (and that are applicable for Computer CI type). If a different ETI is specified in
the monitor's field mapping, it overrides the default indicator definition.
How to Configure Integration Monitors to Collect
Metrics Data With Computer - Monitor Topology
This task describes the steps involved in designing and implementing the EMS metrics flow using
the Computer - Monitor topology script. The topology describes a Computer CI connected to a
SiteScope monitor CI with a Monitored By link.
Note: For an example of this task, see "Example – Create a Metrics Flow With Computer Monitor Topology" on page 425.
1.
Configure BSM integration
Integrate SiteScope and BSM. For details, see "How to Configure SiteScope to Communicate
with BSM" on page 236.
2.
Select the SiteScope
Select the SiteScope server from which you want to deploy the integration monitor:
3.
n
For SiteScope standalone, select and open a SiteScope instance.
n
When in SAM Administration, select the SiteScope server from which you want to deploy
the integration monitor. For user interface details, see "System Availability Management
Administration Page" in the BSM User Guide in the BSM Help.
Create a group for the integration monitor
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
HP SiteScope (11.23)
Page 421 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Tip: We recommend that you create special groups for the integration monitors. This
enables you to more easily recognize the data that is reported to BSM as coming from the
integrations.
4.
Add the integration monitor
Configure the integration monitor and add the required data for the monitor's settings. You can
choose from the following application-specific integrations:
n
HP OM Event Monitor (for details, see the SiteScope Monitor Reference Guide)
n
HP Service Manager Monitor (for details, see the SiteScope Monitor Reference Guide)
n
NetScout Event Monitor (for details, see the SiteScope Monitor Reference Guide)
You can choose from the following generic integration monitors (note that generic integration
monitors are supported for BSM 9.1x and earlier versions only; for all new third-party data
integrations in BSM 9.2x, use BSM Connector as described in the BSM Application
Administration Guide in the BSM Help.)
5.
n
Technology Database Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology Log File Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology SNMP Trap Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
n
Technology Web Service Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
Plan the topology flow
Before you start, plan the following:
6.
n
The type of the monitor and the metrics you will have.
n
The HIs you want to be created on the Computer CI you will report in topology.
n
For most of the default HIs, there are already HI and KPI assignments, and there is no need
to create new ones.
n
The metrics you want to map to the HIs.
Edit the monitor's field mapping
The mapping defines the processing of incoming data and the output sample forwarded to
BSM.
HP SiteScope (11.23)
Page 422 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
a. In the Field Mapping panel, select the Metrics field mapping script, and click Load File.
b. Map the script values to the corresponding field mapping group in which they appear in the
entity (database, log file, SNMP trap, or Web service) from which you want to extract data.
o
For mandatory script values, see "Mandatory Values for the Metrics Script" on page
454.
o
For optional script values, see "Optional Values for the Metrics Script" on page 455.
Note: Integration field mapping should be configured in such a way that assures
that each monitor CI created by the integration is connected to a single monitored
CI (such as Computer). Avoid creating monitor CIs connected to multiple Computer
CIs. To achieve this, it is recommended to use a value for the TargetName field as
part of a MonitorName. For example:
Recommended:
MonitorName="Disk usage on " + $group0
TargetName=$group0
Avoid:
MonitorName="Disk usage on my computer"
TargetName=$group0
c. The indicator mapping fields can be configured in either the Field Mapping panel in
SiteScope or in SAM Administration. For details, see the following step.
Note: The Field Mapping settings are not available when the Report topology without
data check box is selected in the Topology Settings panel. For details on reporting
topology without data, see "Report Topology Without Data" on page 485.
7.
Map metrics to indicators
Define the mapping of your metrics to HIs. There are two ways to define the indicator
mappings:
n
In System Availability Management (SAM) Administration. Use this option to create a
general mapping for your monitor type, or if you want to use regular expressions for the
measurements in the mapping. For details, see "How to Create and Manage Indicator
Assignments" and "Create New Monitor Dialog Box" in the BSM User Guide in the BSM
Help.
n
In the Field Mapping of the technology integration monitor. Use this option for simpler cases.
For example, if you want to define a mapping between a metric to an HI without using
HP SiteScope (11.23)
Page 423 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
regular expressions. For details, see the previous step ("Edit the monitor's field mapping" on
page 422).
To map metrics to indicators:
a. If you use SAM Administration to define the indicator mapping, enter the monitor name you
used in the indicator mapping in SAM Administration for the MonitorType value in the Field
Mapping panel.
b. If you already defined a mapping between the metric and the indicator in SAM
Administration for the MeasurementETI(x) value, this field should not be set in the Field
Mapping panel (keep it commented out). Otherwise, it should be uncommented and you
should enter the label (display name) of one of the existing indicators that is defined on the
Computer CI that suits your requirements. For example, CPU Load, for a measurement that
checks CPU usage.
c. The MeasurementCIHint(x) value should not be set (keep it commented out), since
SiteScope sets the CI hint automatically.
8.
Select a Topology Script
In the Topology Settings section of the integration monitor, select Computer - Monitor from
the Topology script list. You do not need to fill any topology script.
Note: The Computer - Monitor topology integration requires that the names or IP
addresses of the nodes that it adds to RTSM are accessible through DNS resolution. To
successfully populate a Node CI specified in the TargetName field to RTSM, SiteScope
must be able to resolve the node's fully qualified domain name and IP address through a
DNS service.
9.
Assign group permissions if using SAM reports
If you configure a generic integration monitor with a Metrics field mapping, you must assign for
each defined user, permissions to view SiteScope groups and their subgroups in System
Availability Management reports and custom reports. For more information, see the section on
Permissions in the BSM Platform Administration Guide in the BSM Help.
10.
Test the field mapping script - optional
In the Topology Settings panel, click Test Script to test the script before running the monitor.
This tests the following:
11.
n
Checks the field mapping and topology script syntax.
n
Displays the mapping results.
n
Displays the topology results if a topology script has been configured.
View Integration Results
HP SiteScope (11.23)
Page 424 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
After defining metrics assignments and configuring the monitor in SiteScope (including field
mapping and topology script), you can view the results in the following applications:
In Service Health:
a. In BSM, select Applications > Service Health > Top View.
b. In the drop down list, select:
o
System Hardware Monitoring to view the status of the Computer CI.
o
System Monitors view to view the monitor and its status.
In SAM Reports:
You can also view the data of your integration in SAM reports. In the different reports, specify a
filter for the data that you want to be displayed in the graphs.
Configure the filter to include the following values that you defined in the field mapping (see
"Edit the monitor's field mapping" on page 422):
n
Target: Select a value that was defined in the TargetName field in the Integration Monitor
Field Mapping.
n
Monitor type: Select a value that was defined in the MonitorType field in the Integration
Monitor Field Mapping.
n
Monitor title/name: Select a value that was defined in the MonitorName field in the
Integration Monitor Field Mapping.
n
Measurement: Select a value that was defined in the MeasurementName(x) field in the
Integration Monitor Field Mapping.
Example – Create a Metrics Flow With Computer Monitor Topology
This example describes how to create an integration monitor to capture and forward metrics
samples from a third-party system that monitors different disks to BSM using the Computer Monitor topology script.
Note: For a task related to this example, see "How to Configure Integration Monitors to Collect
Metrics Data With Computer - Monitor Topology" on page 421.
1.
Design stage
You have a third-party application that writes to a log file. It writes to the log the disk usage of
different computers.
HP SiteScope (11.23)
Page 425 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Since the application writes to log files, create a Technology Log File Integration monitor for the
integration in SiteScope. Use the Metrics field mapping and the Computer - Monitor topology
script, and select the Host Disk Utilization indicator. There is no need to create
assignments for this HI or KPI since there are existing assignments for them.
Entries in the log file:
2.
n
labamrnd42,disk,d,65,warning
n
labamrnd42,disk,d,70,warning
n
labamrnd42,disk,d,70,warning
Map Metrics to Indicators in SAM Administration
Create a new monitor type in BSM > Admin > System Availability Management > Metrics
and Indicators.
My Disk Usage is the monitor type and Custom is the category.
HP SiteScope (11.23)
Page 426 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Now, define a new indicator mapping for the monitor:
This is how the table looks when you save it:
3.
Define the Field Mapping
Note: The field mapping script to use is available in a text file attached to this PDF. To
view the attachment, select View > Navigation Panels > Attachments, and select
Metrics_Computer_Monitor_Topology_Field_Mapping.txt.
HP SiteScope (11.23)
Page 427 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
In the field mapping script, you can see that the MonitorType value is My Disk Usage (as
defined in the indicator mapping in SAM Administration).
The measurement matches the regular expression defined in the indicator mapping:
MeasurementName(1)="disk " +$group2 + " utilization".
MeasurementETI(1) is commented out since you already defined a mapping in SAM
Administration.
MeasurementCIHint(1) is commented out since SiteScope sets the hint automatically.
4.
Select a Topology Script
In the Topology Settings section of the integration monitor, select the Computer - Monitor
script from the Topology script list.
5.
View Integration Results
In BSM, select Applications > Service Health and view the target computer being monitored
(labamrnd42) in the System Hardware Monitoring view.
These are the results of the indicator status on the monitored machine:
HP SiteScope (11.23)
Page 428 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
How to Configure Integration Monitors to Collect
Metrics Data With Custom Topology
This task describes the steps involved in creating an integration for metrics samples using the
custom topology flow.
Note: For an example of this task, see "Example – Create a Metrics Flow With Custom
Topology" on page 433.
1.
Change the CI Resolver TQL (only if SiteScope is connected to a
version of BSM earlier than 9.20)
a. In BSM, select Admin > Platform > Infrastructure Settings.
o
Select Applications.
o
Select End User/System Availability Management.
o
In the End User/System Availability Management - SiteScope CI Resolver
Settings, check if the value of the TQL Queries parameter is CIs Monitored by
SiteScope. If it is, change it to OMiAutoView.
b. Restart BSM to apply the change.
Note: This TQL does not support models with a large number of CIs (it may cause
performance problems in such models).
2.
Configure BSM integration
Integrate SiteScope and BSM. For details, see "How to Configure SiteScope to Communicate
with BSM" on page 236.
3.
Select the SiteScope
HP SiteScope (11.23)
Page 429 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Select the SiteScope server from which you want to deploy the integration monitor:
4.
n
For SiteScope standalone, select and open a SiteScope instance.
n
When in SAM Administration, select the SiteScope server from which you want to deploy
the integration monitor. For user interface details, see "System Availability Management
Administration Page" in the BSM User Guide in the BSM Help.
Create a group for the integration monitor
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
Tip: We recommend that you create special groups for the integration monitors. This
enables you to more easily recognize the data that is reported to BSM as coming from the
integrations.
5.
Add the integration monitor
Configure the integration monitor and add the required data for the monitor's settings. You can
choose from the following application-specific integrations:
n
HP OM Event Monitor (for details, see the SiteScope Monitor Reference Guide)
n
HP Service Manager Monitor (for details, see the SiteScope Monitor Reference Guide)
n
NetScout Event Monitor (for details, see the SiteScope Monitor Reference Guide)
You can choose from the following generic integration monitors (note that generic integration
monitors are supported for BSM 9.1x and earlier versions only; for all new third-party data
integrations in BSM 9.2x, use BSM Connector as described in the BSM Application
Administration Guide in the BSM Help.)
6.
n
Technology Database Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology Log File Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology SNMP Trap Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
n
Technology Web Service Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
Edit the monitor's field mapping
The mapping defines the processing of incoming data and the output sample forwarded to
BSM.
HP SiteScope (11.23)
Page 430 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
a. In the Field Mapping panel, select the Metrics field mapping script, and click Load File.
b. Enter the details you want to send in the ss_t sample file.
o
For the MeasurementETI value, enter the label of the HI you chose previously in "How
to Configure Integration Monitors to Collect Metrics Data With Custom Topology" on
page 429.
o
Enter a hint for the CI in MeasurementCIHint. This hint helps the CI resolver in BSM to
recognize the CI to which the sample should be attached.
For details on values for the metrics script, see "Configure Field Mapping for Metrics
Samples" on page 454.
Note: The Field Mapping settings are not available when the Report topology without
data check box is selected in the Topology Settings panel. For details on reporting
topology without data, see "Report Topology Without Data" on page 485.
7.
Design the topology flow
When planning the design strategy for the custom topology flow, you need to consider the
following:
n
CIs for topology
Consider the entities that you want to report to BSM. For these entities, you might also want
to report data and to view the health status of these entities in BSM's Service Health.
For example, you have a third-party application named TPA that writes to a database. The
entries in this database contain performance data on CPU and network usage of different
computers. In this case, you will probably want to create a topology that reports Computer
CIs to BSM.
n
Data that you want to be reported for these CIs
Consider what data you have for these CIs and how it can be attached to the CIs. What is
the relevant health indicator (HI) for the data being reported? If there is no such indicator,
consider creating a new HI. Which KPI or HI assignments create the desired HIs and KPIs?
If no such assignments exist, consider creating your own.
8.
Create the custom topology script
Finally you create the topology script. The script defines how to report CIs to BSM. For details
on the topology script, see "Topology Settings for Technology Integration Monitors" on page
400.
HP SiteScope (11.23)
Page 431 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
For the monitored_by attribute of the CI, enter the identifier for this integration. This is the
same value you used in the HI assignment in "How to Configure Integration Monitors to Collect
Metrics Data With Custom Topology" on page 429.
Note:
n
When using field mapping, you can use the field mapping fields as an input for topology
script. For example, if using common event mapping, you can access the value of the
Category field in the following way:
category = Framework.getDestinationAttribute("Category")
n
In addition, you can access values of the "monitor variables", such as group0, group1,
and so forth, from Technology Log File Integration monitor, or the names of database
columns in Technology Database Integration monitor, or other variables in the other
integration monitors. For example, you can access the value of the group1 variable, in
the following way:
group1 = Framework.getDestinationAttribute("group1")
Tip: To troubleshoot topology issues, see BSM Topology Issues in the Integration with
BSM and HPOM Best Practices Guide.
9.
Assign group permissions if using SAM reports
If you configure a generic integration monitor with a Metrics field mapping, you must assign for
each defined user, permissions to view SiteScope groups and their subgroups in SAM reports
and custom reports. For more information, see the section on Permissions in the BSM Platform
Administration Guide in the BSM Help.
10.
Test the field mapping script - optional
In the Topology Settings panel, click Test Script to test the script before running the monitor.
This tests the following:
11.
n
Checks the field mapping and topology script syntax.
n
Displays the mapping results.
n
Displays the topology results if a topology script has been configured.
View Integration Results
After configuring the HI and KPI assignments in BSM and the monitor in SiteScope (including
field mapping and topology script), you can view the results.
n
Create a view in RTSM to view the results of the integration in BSM's Service Health or
Service Level Management application. The view should describe the topology you defined
HP SiteScope (11.23)
Page 432 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
in "Create the custom topology script" on page 431.
For details on creating the view, see "Modeling Studio Page" in the Modeling Guide in the
BSM Help.
If you defined the integration for SLM as well, you can view the integration results in SLM
reports. For more information on SLM and on the reports, see "Working with the Service
Level Management Application" in the BSM User Guide in the BSM Help.
n
You can also view the integration data in System Availability Management reports. In the
different reports, specify a filter for the data that you want to be displayed in the graphs.
Configure the filter to include the following values that you defined in the field mapping in
"Edit the monitor's field mapping" on page 430:
o
Target: Select a value that was defined in the TargetName field in the Integration Monitor
Field Mapping.
o
Monitor type: Select a value that was defined in the MonitorType field in the Integration
Monitor Field Mapping.
o
Monitor title/name: Select a value that was defined in the MonitorName in the
Integration Monitor Field Mapping.
o
Measurement: Select a value that was defined in the MeasurementName(x) field in the
Integration Monitor Field Mapping.
Example – Create a Metrics Flow With Custom Topology
This example describes how to create an integration monitor to capture and forward metrics
samples from a third-party system that monitors different Oracle databases to BSM using the
custom topology script. This script enables you to create your own topology.
Note: For a task related to this example, see "How to Configure Integration Monitors to Collect
Metrics Data With Custom Topology" on page 429.
1.
Design Stage
You have an application named My Oracle Monitoring. This application writes
measurements from Oracle databases running on different computers to a log file.
Since the application writes to log files, create a Technology Log File Integration monitor for the
integration. The topology that you want to report includes Oracle CIs, and you will create a HI
on these CIs. You will focus on one indicator and one measurement that you are interested in.
Entries in the log file:
HP SiteScope (11.23)
Page 433 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
n
amrnd153,27,1,good
n
amrnd153,82,1,warning
n
amrnd153,80,1,warning
The Technology Log File Integration monitor in SiteScope:
2.
Select an Indicator
In BSM, select Admin > Service Health > Repositories > Indicators. For the My Oracle
Monitoring application, use the CPU Usage by SQL (Database) indicator. This indicator
reports SQL as well as Oracle usage.
HP SiteScope (11.23)
Page 434 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
This indicator is defined on the Oracle CI type (the CI that will be reported), and is appropriate
for the measurement being read from the log. This measurement describes the amount of CPU
that Oracle uses.
3.
Define an HI Assignment
In BSM, select Admin > Service Health > Assignments > Health Indicator Assignments
and create the indicator assignment.
HP SiteScope (11.23)
Page 435 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
In the Monitored by property, manually enter My Oracle Monitoring integration. This
value helps you distinguish Oracle CIs reported by this integration from other Oracle CIs that
are being reported. This assigns the CPU Usage by SQL indicator on the Oracle CIs that are
reported by this integration only.
If you edit the indicator in this assignment, you get this:
HP SiteScope (11.23)
Page 436 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
The CPU Usage by SQL indicator is calculated using the SiteScope Worst Status Rule. The
selector defines that samples of type ss_t (the metrics data type) with the same ci_id and
eti_id as the current CI and ETI are captured by this indicator on this Oracle CI. You do not
want other samples to be captured.
4.
Define a KPI Assignment
Since you used a default indicator, you do not need to create a KPI assignment as there is an
existing Service Health KPI assignment on Oracle CIs.
In BSM, select Admin > Service Health > Assignments > KPI Assignments, and in the CI
Type tree select Oracle and choose Oracle KPI Assignment.
HP SiteScope (11.23)
Page 437 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Select the Software Performance KPI:
HP SiteScope (11.23)
Page 438 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
You can see that one of the indicators related to this KPI is the CPU Usage by SQL indicator
which you used.
HP SiteScope (11.23)
Page 439 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
5.
Configure Field Mapping
Note: The field mapping script to use is available in a text file attached to this PDF. To
view the attachment, select View > Navigation Panels > Attachments, and select
Metrics_Custom_Topology_Field_Mapping.txt.
In the field mapping script, you can see that you defined a new monitor type: My Oracle.
The monitor name is My Oracle mon on $group0 where $group 0 is also the target computer
on which the Oracle database is running.
The measurement name is oracle cpu usage and its value is taken from the log file. The
quality that is sent is conditional and depends on what is written in the log file.
The ETI to which the measurement is mapped is CPU Usage by SQL.
The CI hint is in the format <<oracle sid>>@@<<computer name>>. The CI hint helps the CI
Resolver in BSM to find the CI to which this data sample should be attached.
6.
Create the Custom Topology Script
Note: The custom topology script to use is available in a text file attached to this PDF. To
view the attachment, select View > Navigation Panels > Attachments, and select
Metrics_Custom_Topology_Script.txt.
In the custom script, you can see that:
7.
n
system_lib.createNode(Framework) creates the node on which the database is running.
n
modeling.createDatabaseOSH creates the Oracle CI.
n
mainInstance is the SID of the Oracle you used.
n
My Oracle Monitoring integration is the monitored_by attribute which is the condition
you gave in the indicator assignment (see "Define an HI Assignment" on page 435).
View Integration Results
In BSM, select Applications > Service Health and manually create a view for the integration.
For example, here we created a view named My Oracle Monitoring (it is also displayed in
System Software Monitoring view):
HP SiteScope (11.23)
Page 440 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
These are the results of the indicator status on the monitored machine:
The state and value are the same as you assigned in the field mapping.
How to Configure Integration Monitors to Collect
Metrics Data With No Topology
This task describes the steps involved in designing and implementing the EMS metrics flow using
the No Topology script.
Use this flow to use integration monitors to send metrics samples for an already existing topology in
BSM. In this flow, SiteScope sends data without sending topology.
Note: For an example of this task, see "Example – Create a Metrics Flow With No Topology"
on page 447.
1.
Change the CI Resolver TQL (only if SiteScope is connected to a
version of BSM earlier than 9.20)
a. In BSM, select Admin > Platform > Infrastructure Settings.
o
Select Applications.
o
Select End User/System Availability Management.
o
In the End User/System Availability Management - SiteScope CI Resolver
HP SiteScope (11.23)
Page 441 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Settings, check if the value of the TQL Queries parameter is CIs Monitored by
SiteScope. If it is, change it to OMiAutoView.
b. Restart BSM to apply the change.
Note: This TQL does not support models with a large number of CIs (it may cause
performance problems in such models).
2.
Select an Indicator
To view the status of a CI, you need an HI which provides a fine-grained measure of the health
of the CI. In most cases, you want to view the HI in BSM's Service Health. The HI is also used
in Service Level Management (SLM). For details on HIs, see "Health Indicators and KPIs Overview" in the BSM User Guide in the BSM Help.
Note: For alignment reasons, we recommend using an out-of-the-box HI; only create your
own HI if you do not find an existing HI that fits your needs.
To select an existing HI or create a new HI:
a. In BSM, select Admin > Service Health / Service Level Management > Repositories
> Indicators.
b. Select a CI type.
c. Check if you already have an existing HI that fits your requirements. If you do not, create a
new one. For details on how to create HIs, see "How to Create or Edit an ETI or HI
Template in the Indicator Repository" in the BSM User Guide in the BSM Help.
d. If you create a new HI, publish the changes to SiteScope. In BSM, select Admin >
System Availability Management > Metrics and Indicators and click Publish
Changes. The changes should reach SiteScope within no more than 5 minutes.
3.
Define an HI Assignment
After you select an HI, you need to define an HI assignment that will assign the HI to a CI. The
assignment also defines which data samples will be captured by this HI and which business
rule will be used to calculate the status of the HI according to the data samples.
For more information on HI assignments, see the BSM Application Administration Guide in the
BSM Help.
To define an HI assignment:
a. In BSM, select Admin > Service Health / Service Level Management > Assignments
> Health Indicator Assignments.
HP SiteScope (11.23)
Page 442 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
b. Select a CI type.
c. Create a new HI assignment. For details on how to create the assignment, see "How to
Define a KPI or HI Assignment" in the BSM Application Administration Guide in the BSM
Help.
o
In the Condition area, enter a unique value for your integration in the Monitored By
property. This enables you to distinguish between the CIs reported by your integration to
other CIs of this type which are not reported by the integration.
o
Select the HI you chose in "Select an Indicator" on the previous page.
o
Choose the business rule to use for the HI calculation. We recommend using the
SiteScope Worst Status Rule. You can also use the SiteScope Consecutive Worst
Status Log or SiteScope Best Status Rule.
o
In the selector, enter the following:
o
eti_id = (Binary) <<Health Indicator Type ID>>
o
ci_id = (Binary) <<CI ID>>
o
sampleType = (String) ss_t
The integration monitor sends metrics samples (ss_t) that contain the same eti_id as
your ETI and same CI ID as the CI's.
The eti_id in the sample is sent by SiteScope according to your field mapping entry for
the monitor in "Edit the monitor's field mapping" on page 445.
The ci_id is found by the CI resolver in BSM. For it to find the CI, it uses the CI hint sent
by SiteScope in the sample, according to your field mapping entry for the monitor in "Edit
the monitor's field mapping" on page 445.
For details on field mapping for metrics samples, see "Configure Field Mapping for
Metrics Samples" on page 454.
4.
Define a KPI Assignment for each CI type
Verify whether you have an appropriate KPI assignment, or create one if one does not already
exist. The assignment determines which KPI to assign to the CI and for which HIs.
If you use one of the default HIs then there should already be a default KPI assignment for your
HI and you do not need to create one.
For more information on KPI assignments, see the BSM Application Administration Guide in
the BSM Help.
To create a KPI assignment:
HP SiteScope (11.23)
Page 443 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
a. In BSM, select Admin > Service Health > Repositories > Indicators.
b. Choose the type of your CI.
c. Create a new KPI assignment. For details, see "How to Define a KPI or HI Assignment" or
"How to Define a KPI or HI Assignment" in the BSM User Guide in the BSM Help.
d. In the KPI assignment, the related HI should be the one you chose in "Select an Indicator"
on page 442.
Note: If you also want to view the integration results in Service Level Management
(SLM), you need to define the Service Level Agreement (SLA). For more information
on SLAs, see "Agreements Manager Page" in the BSM User Guide in the BSM Help.
5.
Configure BSM integration
Integrate SiteScope and BSM. For details, see "How to Configure SiteScope to Communicate
with BSM" on page 236.
6.
Select the SiteScope
Select the SiteScope server from which you want to deploy the integration monitor:
7.
n
For SiteScope standalone, select and open a SiteScope instance.
n
When in SAM Administration, select the SiteScope server from which you want to deploy
the integration monitor. For user interface details, see "System Availability Management
Administration Page" in the BSM User Guide in the BSM Help.
Create a group for the integration monitor
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
Tip: We recommend that you create special groups for the integration monitors. This
enables you to more easily recognize the data that is reported to BSM as coming from the
integrations.
8.
Add the integration monitor
Configure the integration monitor and add the required data for the monitor's settings. You can
choose from the following application-specific integrations:
n
HP OM Event Monitor (for details, see the SiteScope Monitor Reference Guide)
n
HP Service Manager Monitor (for details, see the SiteScope Monitor Reference Guide)
n
NetScout Event Monitor (for details, see the SiteScope Monitor Reference Guide)
HP SiteScope (11.23)
Page 444 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
You can choose from the following generic integration monitors (note that generic integration
monitors are supported for BSM 9.1x and earlier versions only; for all new third-party data
integrations in BSM 9.2x, use BSM Connector as described in the BSM Application
Administration Guide in the BSM Help.)
9.
n
Technology Database Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology Log File Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology SNMP Trap Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
n
Technology Web Service Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
Edit the monitor's field mapping
The mapping defines the processing of incoming data and the output sample forwarded to
BSM.
a. In the Field Mapping panel, select the Metrics field mapping script, and click Load File.
b. Enter the details you want to send in the ss_t sample file.
o
For the MeasurementETI value, enter the label of the HI you chose previously in
"Select an Indicator" on page 442.
o
Enter a hint for the CI in MeasurementCIHint. This hint helps the CI resolver in BSM to
recognize the CI to which the sample should be attached.
For details on values for the metrics script, see "Configure Field Mapping for Metrics
Samples" on page 454.
Note: The Field Mapping settings are not available when the Report topology without
data check box is selected in the Topology Settings panel. For details on reporting
topology without data, see "Report Topology Without Data" on page 485.
10.
Plan the no topology flow
When planning the design strategy for the no topology flow, you need to consider the following:
n
CIs for topology
Since you are using the No Topology option, you probably already have CIs in the RTSM to
which you want to report data using EMS monitors.
n
Data that you want to be reported for these CIs
HP SiteScope (11.23)
Page 445 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Consider what data you have for these CIs and how it can be attached to the CIs. What is
the relevant health indicator (HI) for the data being reported? If there is no such indicator,
consider creating a new HI. Which KPI or HI assignments create the desired HIs and KPIs?
If no such assignments exist, consider creating your own.
For example, if you have data on CPU usage and network usage, you can use the CPU Load
and Interface Utilization HIs that are defined for the Computer CI type, and you can
use the System Performance KPI. Check if there are HI and KPI assignments that meet
your needs, and if not, consider creating them.
11.
Assign group permissions if using SAM reports
If you configure a generic integration monitor with a Metrics field mapping, you must assign for
each defined user, permissions to view SiteScope groups and their subgroups in SAM reports
and custom reports. For more information, see the section on Permissions in the BSM Platform
Administration Guide in the BSM Help.
12.
View Integration Results
After configuring the HI and KPI assignments in BSM and the monitor in SiteScope (including
field mapping), you can view the results.
n
Create a view in RTSM to view the results of the integration in BSM's Service Health or
Service Level Management application. The view should describe the CIs you want to view.
For details on creating the view, see "Modeling Studio Page" in the Modeling Guide in the
BSM Help.
If you defined the integration for SLM as well, you can view the integration results in SLM
reports. For more information on SLM and on the reports, see "Working with the Service
Level Management Application" in the BSM User Guide in the BSM Help.
n
You can also view the integration data in System Availability Management reports. In the
different reports, specify a filter for the data that you want to be displayed in the graphs.
Configure the filter to include the following values that you defined in the field mapping in
step 9:
o
Target: Select a value that was defined in the TargetName field in the Integration Monitor
Field Mapping.
o
Monitor type: Select a value that was defined in the MonitorType field in the Integration
Monitor Field Mapping.
o
Monitor title/name: Select a value that was defined in the MonitorName field in the
Integration Monitor Field Mapping.
o
Measurement: Select a value that was defined in the MeasurementName(x) field in the
Integration Monitor Field Mapping.
HP SiteScope (11.23)
Page 446 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Example – Create a Metrics Flow With No Topology
This example describes how to create an integration monitor to capture and forward metrics
samples from a third-party system that monitors different Oracle databases to BSM using the No
Topology flow. This flow is used to send metric samples when a topology already exists in BSM,
and there is no need to report the CIs.
Note: For a task related to this example, see "How to Configure Integration Monitors to Collect
Metrics Data With No Topology" on page 441.
1.
Design Stage
You have an application named My Oracle Monitoring. This application writes various
measurements from Oracle databases running on different computers to a log file.
Since the application writes to log files, you need to create a Technology Log File Integration
monitor for the integration. The measurements will be assigned to Oracle CIs that already exist
in RTSM; therefore the CIs do not need to be reported. The data is assigned to HIs on the CIs.
You will focus on one indicator and one measurement that you are interested in.
Entries in the log file:
n
amrnd153,27,1,good
n
amrnd153,82,1,warning
n
amrnd153,80,1,warning
HP SiteScope (11.23)
Page 447 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
The Technology Log File Integration monitor in SiteScope:
2.
Select an Indicator
In BSM, select Admin > Service Health > Repositories > Indicators. For the My Oracle
Monitoring application, use the CPU Usage by SQL (Database) indicator. This indicator
reports SQL as well as Oracle usage.
HP SiteScope (11.23)
Page 448 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
This indicator is defined on Oracle CI type and is appropriate for the measurement being read
from the log. This measurement describes the amount of CPU that Oracle uses.
3.
Define an HI Assignment
In BSM, select Admin > Service Health > Assignments > Health Indicator Assignments
and create the indicator assignment.
The assignment condition should match the Oracle CIs on which you want to define the
indicators (and not other Oracle CIs that do not belong to this integration). In the indicator
assignment, select the CPU Usage by SQL indicator.
If you edit the indicator in this assignment, you get this:
HP SiteScope (11.23)
Page 449 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
The CPU Usage by SQL indicator is calculated using the SiteScope Worst Status Rule. The
selector defines that samples of type ss_t (the metrics data type) with the same ci_id and
eti_id as the current CI and ETI are captured by this indicator on this Oracle CI. You do not
want other samples to be captured.
4.
Define a KPI Assignment
Since you used a default indicator, you do not need to create a KPI assignment as there is an
existing Service Health KPI assignment on Oracle CIs.
In BSM, select Admin > Service Health > Assignments > KPI Assignments, and in the CI
Type tree select Oracle and choose Oracle KPI Assignment.
In the Monitored by property, manually enter My Oracle Monitoring integration. This
value helps you distinguish Oracle CIs reported by this integration from other Oracle CIs that
are being reported. This assigns the CPU Usage by SQL indicator on the Oracle CIs that are
reported by this integration only.
HP SiteScope (11.23)
Page 450 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Select the Software Performance KPI:
HP SiteScope (11.23)
Page 451 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
You can see that one of the indicators related to this KPI is the CPU Usage by SQL indicator
which you used.
HP SiteScope (11.23)
Page 452 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
5.
Define the Field Mapping
Note: Thefield mapping script to use is available in a text file attached to this PDF. To
view the attachment, select View > Navigation Panels > Attachments, and select
Metrics_No_Topology_Field_Mapping.txt.
In the field mapping script, you can see that a new monitor type was defined: My Oracle.
The monitor name is My Oracle mon on$group0 where $group 0 is also the target computer
on which the Oracle database is running.
The measurement name is oracle cpu usage and its value is taken from the log file. The
quality that is sent is conditional and depends on what is written in the log file.
The ETI to which the measurement is mapped is CPU Usage by SQL.
The CI hint is in the format <<oracle sid>>@@<<computer name>>. The CI hint helps the CI
Resolver in BSM to find the CI to which this data sample should be attached.
6.
View Integration Results
In BSM, select Applications > Service Health and manually create a view for the integration.
For example, here we created a view named My Oracle Monitoring (it is also displayed in
System Software Monitoring view):
These are the results of the indicator status on the monitored machine:
HP SiteScope (11.23)
Page 453 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
The state and value are the same as you assigned in the field mapping.
Configure Field Mapping for Metrics Samples
You use metrics data type to extract metrics collected by external systems and import them to
BSM.
When configuring an integration monitor's field mapping, select the Metrics data type to load the
metrics script. You can then copy the contents of the Field Mapping text box and paste it into a text
editor to make your configuration changes. When you are done, copy the contents back into the
Field Mapping text box.
For details on event handler structure and syntax, see "Event Handler Structure and Syntax" on
page 409.
For CI resolution hint formats, see "CI Resolution Hint Formats" on page 398.
This section also includes:
l
"Mandatory Values for the Metrics Script" below
l
"Optional Values for the Metrics Script" on the next page
l
"Metrics Script Example" on page 456
Mandatory Values for the Metrics Script
The table below lists mandatory values for the metrics script.
Field Name
Type
TimeStamp
DOUBLE Time stamp in the seconds
since Jan 1st 1970 format.
TimeStamp:DOUBLE=time()
Quality
INT
Quality in SiteScope terms.
Possible values are:
QUALITY_ERROR,
QUALITY_WARNING,
QUALITY_GOOD.
Quality:INT= QUALITY_ERROR
MonitorName
STRING
Logical monitor name.
MonitorName="NT cpu
Monitor"
MonitorState
STRING
The monitor status, for
example, N\A, Good, Error,
and so on.
MonitorState="Received " +
$count + " events"
MonitorType
STRING
The monitor type.
MonitorType="System
Monitor"
HP SiteScope (11.23)
Description
Example
Page 454 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Field Name
Type
Description
Example
TargetName
STRING
The target of this monitor
(e.g. name of host
machine).
TargetName=$Device
Name the Nth metric.
MeasurementName(1)="CPU
Temperature"
MeasurementName STRING
(N)
Value(N)
DOUBLE Value of Nth metric.
Value
(1):DOUBLE=$CPUTemperature
Optional Values for the Metrics Script
The table below lists optional values for the metrics script.
Field Name
Type
Description
MeasurementETI
STRING The display name of the ETI.
Note: When using BSM 9.00, add the
relevant indicator names to the
integration field mapping (otherwise the
system KPI is used instead), or configure
the indicator in SAM Administration. For
details, see Indicator Assignment
Settings in the BSM User Guide in the
BSM Help.
HP SiteScope (11.23)
Example
MeasurementETI(1)=
"Indicator display
name"
Page 455 of 1293
Using SiteScope
Chapter 37: Configure Integration Monitors to Collect Metrics Data
Field Name
Type
Description
MeasurementCI
Hint
STRING CI resolution hint that is used to identify
monitored CIs and relate metrics to
them. SiteScope sends an out-of-the-box
CI resolution hint in the format based on
the monitor's internal IDs.
Example
MeasurementCIHint
(1)=
"SCDAM038.testlab"
For EMS metric field mapping, you might
want to send a custom CI resolution hint
when:
l
Sending a custom topology without
monitor CIs using a custom topology
script.
l
You only want to forward third-party
metrics and connect them to an
existing topology. In this case, you
create a field mapping, provide CI
resolution hints, and select the No
Topology option in the integration
monitor's Topology Settings.
The CI resolution hint must be specified
in a format recognizable in BSM, as
described in "Field Mapping Structure" on
page 398.
Metrics Script Example
Note: The metrics script example is available in a text file attached to this PDF. To view the
attachment, select View > Navigation Panels > Attachments, and select Metrics_Script_
Example.txt.
When specifying more than one metric in the script, a separate sample is sent with each of the
metrics.
Note: When specifying multiple metrics per file, the metric numbering must be consecutive.
In the case of failure, errors appear in the RunMonitor.log but the error does not affect the monitor
status.
HP SiteScope (11.23)
Page 456 of 1293
Chapter 38: Configure Integration Monitors to
Collect Event Data
When configuring the generic integration monitors, you can select the event data type to collect
common or legacy event-based data. Common events data are used to integrate events collected
from third-party domain managers or applications to BSM 9.x. Legacy events are used to collect
data on specific events in BAC 8.x and earlier (retained for backward compatibility).
This chapter includes:
l
"Integration Monitor Field Mapping for Event Samples" below. Provides an overview of
integration monitor field mappings for capturing event samples from Enterprise Management
Systems and other management applications.
l
"How to Configure Integration Monitors to Collect Data on Common Events" on page 459.
Describes how to configure the common event integration.
l
"How to Configure Integration Monitors to Collect Data on Legacy Events" on page 463.
Describes how to configure the legacy event integration.
l
"Configure Field Mapping for Common Event Samples" on page 466. Provides a list of
mandatory and optional values (and example scripts) for the common event samples.
l
"Configure Field Mapping for Legacy Event Samples" on page 471. Provides a list of mandatory
and optional values (and example scripts) for legacy event samples.
l
"Troubleshooting and Limitations" on page 475. Describes troubleshooting and limitations for
Integration Monitor field mappings for event samples.
Integration Monitor Field Mapping for Event Samples
You can enable capturing event data from Enterprise Management Systems (EMS), automated
support systems, and other management applications by configuring integration monitors and their
field mapping scripts.
Integration monitors depend on the field mapping you customize within the user interface in the
settings for the monitor. The mapping defines the processing of incoming data and defines the
output sample forwarded to BSM.
Integration Monitors designed for use with specific EMS applications (these currently include HP
OM, HP Service Center, and NetScout) can be configured without editing their field mapping script.
The mapping is predefined by HP and requires modification only if specific customizations are
required. For details on editing these field mapping scripts, see the description for the field mapping
element in the user interface pages for the monitor you are deploying.
For Technology Integration Monitors (Technology SNMP Trap, Technology Log File, and
Technology Database monitors), you must select the data type and the required script is loaded
directly into the field mapping text box. You must edit the field mapping script to suit your
HP SiteScope (11.23)
Page 457 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
organization's needs. The Technology Web Service Integration Monitor field mapping may also
need to be customized.
You can select the Common Events or Legacy Events data type to integrate events collected
from third-party domain managers or applications to BSM 9.x. Unlike the legacy EMS events, the
Common Event integration allows you to manage the events in Operations Management event sub
system and the Service Health console. In addition, the common event channel provides the option
to report topology to BSM without reporting the data.
When you select the Common Events data type to forward event data to BSM, and you want to
integrate to BSM using topology settings, you can select from the following predefined topology
scripts:
l
Computer. Select to create a topology with a Computer CI.
l
Computer - Running Software. Select to create a topology with a Computer CI and a Running
Software CI connected to it with a Composition relationship.
l
Custom. Select to create your own topology script, if you want the retrieved data to be sent to
specific CIs instead of the Computer or Running Software CIs. Only select this option if you are
familiar with the Jython language, because you must create the topology script in Jython
yourself.
When you select the LegacyEvents data type to forward event data to BSM, and you want to
integrate to BSM using topology settings, you can select from the following topology scripts:
l
Node. Creates a Node CI with an EMS monitor CI connected to it with Monitored By
relationship.
l
Node - Running Software. Creates a topology with a Node CI and a Running Software CI
connected to it with a Composition relationship, and an EMS monitor CI which can be
connected to either the Node CI or the Running Software CI with Monitored By relationship.
l
Custom. Select to create your own topology script, if you want the retrieved data to be sent to
specific CIs instead of the Computer or Running Software CIs. You must be familiar with the
Jython language, since you must create the topology script yourself.
Note:
l
Events sent by EMS applications are event samples. They are not the same as Operations
Management events in BSM.
l
When SiteScope version 11.10 or earlier is connected to BSM 9.00, the HostsApplications topology script is no longer available in the topology script list for the monitor.
Only existing integrations that report Hosts-Applications (created in SiteScope connected
to BSM 8.x) continue reporting to BSM 9.00. You cannot create new integrations using this
script type.
l
SiteScope uses indicator definitions for monitor CIs created by the integration that are
HP SiteScope (11.23)
Page 458 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
defined in BSM (and that are applicable for Computer CI type). If a different ETI is specified
in the monitor's field mapping, it overrides the default indicator definition.
For details on selecting a topology setting, see "Topology Settings for Technology Integration
Monitors" on page 400.
Note: Use only the mandatory and optional fields defined in the scripts when working with the
field mapping. For more information, see the tables for each data type.
How to Configure Integration Monitors to Collect
Data on Common Events
This task describes the steps involved in configuring the common event integration, which is used
to collect data on specific events, and to make the data available for use in BSM's Operations
Management event sub system, the Service Health console, and Service Level Management.
1.
Plan the integration strategy
Review the Integration Monitor types. Consider the type of information you want to view in
BSM from your EMS system. Determine whether one of the specific Integration Monitors
meets your organization's needs or whether a generic Integration Monitor (Technology Log File,
Database, SNMP Trap, Web Service) is required.
For concept details, see "Integration Monitors Overview" on page 394.
2.
Configure BSM integration
Integrate SiteScope and BSM. For details, see "How to Configure SiteScope to Communicate
with BSM" on page 236.
3.
Configure HP Operations Manager event integration
Follow the steps for configuring the event integration. For details, see "How to enable
SiteScope to send events to HPOM or OMi" in Integrating SiteScope with HP Operations
Manager Products. You can check the HP Software Integrations site to see if a more updated
version of this guide is available(for Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39; for UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
Note:
n
You do not need to select Enable sending events in the HP Operations Manager
Integrations Main Settings panel (the "Enable SiteScope to send events to HPOM or
BSM" step), because this step applies only to sending events for regular SiteScope
monitors. Events for integration monitors are automatically sent when the integration
HP SiteScope (11.23)
Page 459 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
monitor is configured to use the Common Events sample mapping script.
4.
n
The "Enable/Disable sending events for monitor instances and alerts" step is not
relevant when sending events for integration monitors.
n
You do not need to select the Enable HP Operations Manager metrics integration
check box in the HP Operations Manager Metrics Integrations panel.
Select the SiteScope server
Select the SiteScope server from which you want to deploy the integration monitor:
5.
n
For SiteScope standalone, select and open a SiteScope instance.
n
When in SAM Administration, select the SiteScope server from which you want to deploy
the integration monitor. For user interface details, see "System Availability Management
Administration Page" in the BSM User Guide in the BSM Help.
Create a group for the integration monitor
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
Tip: We recommend that you create special groups for the integration monitors. This
enables you to more easily recognize the data that is reported to BSM as coming from the
integrations.
6.
Add the integration monitor
Configure the integration monitor and add the required data for the monitor's settings. You can
choose from the following application-specific integrations:
n
HP OM Event Monitor (for details, see the SiteScope Monitor Reference Guide)
n
HP Service Manager Monitor (for details, see the SiteScope Monitor Reference Guide)
n
NetScout Event Monitor (for details, see the SiteScope Monitor Reference Guide)
You can choose from the following generic integration monitors (note that generic integration
monitors are supported for BSM 9.1x and earlier versions only; for all new third-party data
integrations in BSM 9.2x, use BSM Connector as described in the BSM Application
Administration Guide in the BSM Help.)
n
Technology Database Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology Log File Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
HP SiteScope (11.23)
Page 460 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
7.
n
Technology SNMP Trap Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
n
Technology Web Service Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
Edit the monitor's field mapping
The mapping defines the processing of incoming data and the output sample forwarded to
BSM.
a. In the Field Mapping panel, select the Common Events field mapping script, and click
Load File. A template script is displayed in the Field mapping box.
b. Edit the script to enable SiteScope to retrieve the data from the monitored application that
you want to forward to BSM by mapping the script values to the corresponding field
mapping group in which they appear in the log file from which you want to extract data. For
details on the file structure and syntax, see "Event Handler Structure and Syntax" on page
409.
For mandatory script values, see "Mandatory Values for the Common Events Script" on
page 467.
For optional script values, see "Optional Values for the Common Events Script" on page
468.
Note: The Field Mapping settings are not available when the Report topology without
data check box is selected in the Topology Settings panel. For details on reporting
topology without data, see "Report Topology Without Data" on page 485.
8.
Map the data to a topology script - optional (required when reporting
topology to BSM)
In the Topology Settings panel, select a topology script to forward the data to the correct CI
hierarchy in BSM:
n
Computer. Select to create a topology with a Computer CI.
Note: Information about Computer CI is taken from the HostHint field.
n
Computer - Running Software. Select to create a topology with a Computer CI and a
Running Software CI connected to it with a Composition relationship.
Note: Information about Node CI is taken from the HostHint field and the name of the
Running Software CI is taken from the Category field.
HP SiteScope (11.23)
Page 461 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
n
Custom. Select to create your own topology script.
Edit the topology settings. The topology scripts are specially configured with the necessary
values to forward data to the required CIs in BSM's RTSM. For concept details, see
"Topology Settings for Technology Integration Monitors" on page 400.
Note:
o
When using field mapping, you can use the field mapping fields as an input for
topology script. For example, if using common event mapping, you can access the
value of the Category field in the following way:
category = Framework.getDestinationAttribute("Category").
o
In addition, you can access values of the "monitor variables", such as group0,
group1, and so forth, from Technology Log File Integration monitor, or the names of
database columns in Technology Database Integration monitor, or other variables in
the other integration monitors. For example, you can access the value of the group1
variable, in the following way:
group1 = Framework.getDestinationAttribute("group1")
9.
Test the field mapping script - optional
In the Topology Settings panel, click Test Script to test the script before running the monitor.
This tests the following:
n
Checks the field mapping and topology script syntax.
n
Displays the mapping results.
n
Displays the topology results if a topology script has been configured.
The test does not forward events or topology to BSM.
10.
Results
When events are gathered from a third-party system and processed by integration monitors,
common events are generated, and SiteScope writes the event data to the
HPSiteScopeOperationsManagerIntegration.log file in the <SiteScope root
directory>\logs directory. Each event is written as a separate line in the log. The log file policy
instructs the agent to read this file and create event messages that are sent to BSM.
You can view the event in the Operations Management Event Browser (if you have an Event
Management Foundation license). If Operations Management is not part of your BSM
installation, you can view events that affect CI status using a health indicator in Service
Health.
HP SiteScope (11.23)
Page 462 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
How to Configure Integration Monitors to Collect
Data on Legacy Events
This task describes the steps involved in configuring the legacy event integration, which is used to
collect data on specific events, and to make the data available for use in BSM's Service Health,
Event Log, and trend reports.
1.
Plan the integration strategy
Review the Integration Monitor types. Consider the type of information you want to view in
BSM from your EMS system. Determine whether one of the specific Integration Monitors
meets your organization's needs or whether a generic Integration Monitor (Technology Log File,
Database, SNMP Trap, Web Service) is required.
For concept details, see "Integration Monitors Overview" on page 394.
2.
Configure BSM integration
Integrate SiteScope and BSM. For details, see "How to Configure SiteScope to Communicate
with BSM" on page 236.
Note: You do not need to configure the HP Operations Manager event integration when
the integration monitor is configured to use the Legacy Events sample mapping script.
3.
Select the SiteScope server
Select the SiteScope server from which you want to deploy the integration monitor:
4.
n
For SiteScope standalone, select and open a SiteScope instance.
n
When in SAM Administration, select the SiteScope server from which you want to deploy
the integration monitor. For user interface details, see "System Availability Management
Administration Page" in the BSM User Guide in the BSM Help.
n
When in EMS Integrations Administration, click the New Integration or Edit Integration
button. In the Edit Integration dialog box, click the link in the System Availability
Management panel to open SAM Administration window where you can select a SiteScope
server. For user interface details, see "Edit Integration Dialog Box" in the BSM Application
Administration Guide in the BSM Help.
Create a group for the integration monitor
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
Tip: We recommend that you create special groups for the integration monitors. This
enables you to more easily recognize the data that is reported to BSM as coming from the
integrations.
HP SiteScope (11.23)
Page 463 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
5.
Add the integration monitor
Configure the integration monitor and add the required data for the monitor's settings. You can
choose from the following application-specific integrations:
n
HP OM Event Monitor (for details, see the SiteScope Monitor Reference Guide)
n
HP Service Manager Monitor (for details, see the SiteScope Monitor Reference Guide)
n
NetScout Event Monitor (for details, see the SiteScope Monitor Reference Guide)
You can choose from the following generic integration monitors (note that generic integration
monitors are supported for BSM 9.1x and earlier versions only; for all new third-party data
integrations in BSM 9.2x, use BSM Connector as described in the BSM Application
Administration Guide in the BSM Help.)
6.
n
Technology Database Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology Log File Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology SNMP Trap Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
n
Technology Web Service Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
Edit the monitor's field mapping
The mapping defines the processing of incoming data and the output sample forwarded to
BSM.
a. In the Field Mapping panel, select the Legacy Events field mapping script, and click Load
File.
b. Edit the script to enable SiteScope to retrieve the data from the monitored application that
you want to forward to BSM by mapping the script values to the corresponding field
mapping group in which they appear in the log file from which you want to extract data. For
details on the file structure and syntax, see "Event Handler Structure and Syntax" on page
409.
For mandatory script values, see "Mandatory Values for the Legacy Event Script" on page
471.
For optional script values, see "Optional Values for the Legacy Event Script" on page 472
Note: The Field Mapping settings are not available when the Report topology without
data check box is selected in the Topology Settings panel. For details on reporting
HP SiteScope (11.23)
Page 464 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
topology without data, see "Report Topology Without Data" on page 485.
7.
Map the data to a topology script - optional (required when reporting
topology to BSM)
In the Topology Settings panel, select a topology script to forward the data to the correct CI
hierarchy in BSM:
n
Node. Select to create a Node CI with an EMS monitor CI connected to it with Monitored
By relationship.
n
Node - Running Software. Select to create a topology with a Node CI and a Running
Software CI connected to it with a Composition relationship, and an EMS monitor CI which
can be connected to either the Node CI or the Running Software CI with Monitored By
relationship.
Note: Information about Computer CI is taken from the HostHint field and the name of
the Running Software CI is taken from the Category field.
n
Custom. Select to create your own topology script.
Edit the topology settings. The topology scripts are specially configured with the necessary
values to forward data to the required CIs in BSM's RTSM. For concept details, see
"Topology Settings for Technology Integration Monitors" on page 400.
Note:
o
When using field mapping, you can use the field mapping fields as an input for
topology script. For example, if using legacy event mapping, you can access the
value of the Subject field in the following way:
subject = Framework.getDestinationAttribute("Subject")
o
In addition, you can access values of the "monitor variables", such as group0,
group1, and so forth, from Technology Log File Integration monitor, or the names of
database columns in Technology Database Integration monitor, or other variables in
the other integration monitors. For example, you can access the value of the group1
variable, in the following way:
group1 = Framework.getDestinationAttribute("group1")
8.
Test the field mapping script - optional
In the Topology Settings panel, click Test Script to test the script before running the monitor.
This tests the following:
HP SiteScope (11.23)
Page 465 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
n
Checks the field mapping and topology script syntax.
n
Displays the mapping results.
n
Displays the topology results if a topology script has been configured.
The test does not forward events or topology to BSM.
9.
Configure the EMS Integrations application in BSM
In addition to configuring the monitor, you need to configure the EMS Integrations application in
BSM. For details, see the remaining steps in "Create an EMS integration (for Event or Ticket
Samples)" in "How to Integrate Data from Third-Party Sources (EMS Data) into HP Business
Service Management" in the BSM Application Administration Guide in the BSM Help.
Note: If you are configuring a metrics integration, do not need to go to BSM's SAM
Administration and configure a new integration. You just need to create a monitor and
select the Report topology option.
10.
Results
When events are gathered from a third-party system and processed by integration monitors,
the events are generated and the event data is written to the
HPSiteScopeOperationsManagerIntegration.log file in the <SiteScope root
directory>\logs directory. Each event is written as a separate line in the log. The log file policy
instructs the agent to read this file and create event messages that are sent to BSM.
You can view events in Service Health, System Availability Management Event Logs, and
trend reports.
Configure Field Mapping for Common Event Samples
The events data type is used for extracting events collected by external systems and importing
them to BSM. When configuring an integration monitor's field mapping, select the CommonEvents
data type to load the events script. You can then copy the contents of the Field Mapping text box
and paste it into a text editor to make your configuration changes. When you are done, copy the
contents back into the Field Mapping text box.
For details on event handler structure and syntax, see "Event Handler Structure and Syntax" on
page 409.
For CI resolution hint formats, see "CI Resolution Hint Formats" on page 398.
This section also includes:
l
"Mandatory Values for the Common Events Script" on the next page
l
"Mandatory Values When Reporting Topology Without Data" on the next page
HP SiteScope (11.23)
Page 466 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
l
"Optional Values for the Common Events Script" on the next page
l
"Common Events Script Example" on page 470
Mandatory Values for the Common Events Script
The table below lists mandatory values for the common events script. Map the values to the
corresponding field mapping group in which they appear in the log file from which you want to
extract data.
Field
Name
Description
Title
Summary of the event.
Severity
Severity of the event. Possible values are: Normal, Warning, Minor, Major, and
Critical.
SourceHint Information about the monitoring application and the corresponding probe/agent
that is responsible for creating the event.
Mandatory Values When Reporting Topology Without Data
The following values are mandatory when reporting only the topology discovered by the SiteScope
Technology Integration monitors, without reporting the data:
For
Topology
Script
l
l
Field
Name
Computer target_
name
Computer
- Running
Software
Description
Name of the host or machine that generated the event. This can be
added manually or taken from:
Framework.getDestinationAttribute("<someAttribute>")
Examples:
Technology Log File Integration monitor:
Framework.getDestinationAttribute("group0") where group0 is the
value of the first pattern matching group.
Technology Database Integration monitor:
Framework.getDestinationAttribute("NAME") where NAME is the
name of a database column.
Technology Web Service Integration monitor:
Framework.getDestinationAttribute(“Host") where HOST is the key in
the SOAP request <key>Host</key>.
HP SiteScope (11.23)
Page 467 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
For
Topology
Script
l
l
Field
Name
Computer target_
ip
Computer
- Running
Software
Computer Running
Software
name
Description
IP of the host or machine. This can be added manually, or calculated
using:
HostIPCachingManager.getIPByHostName(target_name)
where target_name represents a valid host or machine, or you can
use:
HostIPCachingManager.getIPByHostName("<someAttribute>")
Name of Running Software. This can be added manually, or taken
from:
Framework.getDestinationAttribute("<someAttribute>")
Optional Values for the Common Events Script
The table below lists optional values for the common events script. Map the values to the
corresponding field mapping group in which they appear in the log file from which you want to
extract data.
Field Name
Description
CiHint
Information about a CI that is related to the event. For details of the formats for
CI resolution hints, see "Field Mapping Structure" on page 398.
EtiHint
Event Type Indicator hint in the format:
[ETI Name]:[ETI Value]:[Metric Value]
Example: CPULoad:Critical:50
For more information on BSM indicators, see "Health Indicators and KPIs" in the
BSM User Guide in the BSM Documentation Library.
ComponentCi Information used to identify a subcomponent of a CI. This CI subcomponent is
used to calculate an aggregated status within BSM's Service Health for selected
CIs.
If an HI is populated by events from multiple components, you can specify a
component name in this field in order to ensure the correct calculation of the HI
state.
Example: If you have a Computer CI with two CPUs, cpu #1 and cpu #2,
events from both CPUs will be sent to the same CPU Load HI. By default, the
events will override each other and create an incorrect HI state. To prevent this,
you can populate ComponentCi with values "cpu #1" and "cpu #2" which will
cause the HI state to be calculated as an aggregated state between the two
events.
HP SiteScope (11.23)
Page 468 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
Field Name
Description
HostHint
Information about a CI of type Node that is hosting the CI related to the event.
This field is mandatory when reporting topology which includes Node CIs.
Description
Additional information describing the event.
Category
Name of a logical group to which the event belongs. An event category is similar
to a message group in HPOM.
Example (from log file): Database, Security, Network
SubCategory
Name of a logical subgroup (category) to which the event belongs.
Example (from log file): Oracle (database), Accounts (security), Routers
(network))
Key
A unique string representing the type of event that occurred. Two events can
have the same key if both events represent the same situation in the managed
environment. Events with the same key are treated as duplicates.
Example (from log file): foohost:barhost:CPULoad:Critical
CloseKey
Enables the event that is sent to close all events whose Key attribute matches
the CloseKey pattern expression. You can use wildcards (*) if necessary.
Example (from log file): barhost:CPULoad<*>
LogOnly
This field allows submitting an event that goes directly into the history event
browser as a closed event. Such an event goes though the complete event
processing (CI Resolution, updating HIs, and so forth), but has its Life Cycle
State set to closed from the beginning. For details on CI Resolution, see "CI
Resolution" in the BSM User Guide in the BSM Documentation Library.
Typical examples of events having this attribute set to "True" are events that will
result in resetting a Health Indicator to a "Normal" or "Good" state, or an event
signaling that a previous problem no longer exists (where the problem was
reported in another event).
Possible values are:
l
True. Logs all events automatically on arrival.
l
False. Events are not logged automatically.
l
True for normal severity. Automatically logs events with Normal severity
only.
Default value: False
Attributes
HP SiteScope (11.23)
Page 469 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
Field Name
Description
#cma1=
Use these attributes to send any custom attributes in the event.
#cma2=
Note: Only the predefined custom mapping attributes are supported. You cannot
change a custom attribute name (cma1-cma5) or add a new one.
#cma3=
#cma4=
#cma5=
Common Events Script Example
The example below shows a section of the Common Events script with script values mapped to the
corresponding field mapping group ($group<#>) in which they appear in the log file.
[$DEFAULT_PARAMETERS$]
############################################
# NOTE: the following fields are mandatory #
############################################
# Brief summary of the event
Title=$group0
# Severity of the event. Possible values are: "Normal", "Warning", "Minor",
"Major",
and "Critical"
Severity=$group2
# Information about the monitoring application and the corresponding probe/a
gent that
is responsible for creating the event
# If the field is left empty then it will be auto filled with [email protected]@
[SiteScope Node FQDN]
SourceHint=$group8
############################################
NOTE: the following fields are optional
#
# An unfilled field must remarked with '#' #
#############################################
# Information about a CI that is related to the event. For more information,
see
"Preferences" > "Common Event Mappings" > "New/Edit Event Mapping Dialog Box"
in the
SiteScope documentation
CiHint=$group6
# Event Type Indicator hint in the format: [ETI Name]:[ETI Value]:[Metric Va
lue].
Example: CPULoad:Critical:50
EtiHint=$group5
# Information used to identify a subcomponent of a CI. This CI subcomponent
is used
HP SiteScope (11.23)
Page 470 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
to calculate an aggregated status within BSM Service Health for selected CIs
#ComponentCi=
Configure Field Mapping for Legacy Event Samples
The events data type is used for extracting events collected by external systems and importing
them to BSM. When configuring an integration monitor's field mapping, select the LegacyEvents
data type to load the events script. You can then copy the contents of the Field Mapping text box
and paste it into a text editor to make your configuration changes. When you are done, copy the
contents back into the Field Mapping text box.
For details on event handler structure and syntax, see "Event Handler Structure and Syntax" on
page 409.
For CI resolution hint formats, see "Field Mapping Structure" on page 398.
This section also includes:
l
"Mandatory Values for the Legacy Event Script" below
l
"Optional Values for the Legacy Event Script" on the next page
l
"Conditional Expression Example 1" on page 474
l
"Conditional Expression Example 2" on page 474
l
"Event Script Example" on page 474
Mandatory Values for the Legacy Event Script
The table below lists mandatory values for the legacy event script.
Field Name
Type
Description
time_stamp
DOUBLE Time stamp in seconds since
Jan 1 1970.
Example
time_stamp:DOUBLE=str_to_
seconds($time,"yyyy-MM-dd
HH:mm:ss.SSS").
time_stamp:DOUBLE=int time
()
For details on int time(), see
"Available Data Processing
Operations" on page 410.
HP SiteScope (11.23)
Page 471 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
Field Name
Type
Description
Example
severity
INT
Can be one of the following
preconfigured severities (based
on applicable integer):
0:SEVERITY_UNKNOWN
1:SEVERITY_
INFORMATIONAL
2:SEVERITY_WARNING
3:SEVERITY_MINOR
4:SEVERITY_MAJOR
5:SEVERITY_CRITICAL
severity:INT=SEVERITY_MINOR
Name of device or host machine
that generated the event.
target_name=$hostName
target_name STRING
target_name=String
resolveHostName(String
hostIP)
For details on String
resolveHostName(String
hostIP), see "Available Data
Processing Operations" on page
410.
status
STRING
Status of event in external EMS
terminology.
status="OPEN"
status="ASSIGNED"
status="CLOSED"
subject
STRING
Subject of event (e.g. CPU,
SAP application, Hard Disk),
middle/high level hierarchy
describing the event source.
subject="DISK"
instance
STRING
Instance of subject that
generated the event (e.g D:\).
Lowest level of hierarchy
describing the event source.
instance="E:\\"
description STRING
Textual description of event.
description="free space on
drive e is below 10%"
data_source STRING
System that generated the
event.
data_source="HP OVO"
Optional Values for the Legacy Event Script
The table below lists optional values for the legacy event script.
HP SiteScope (11.23)
Page 472 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
Field Name
Type
Description
Example
target_ip
STRING
IP of device or host machine that
generated the event.
target_ip=$IPString
object
STRING
Optional level in the hierarchy
describing the event source.
object="OS"
event_id
STRING
Unique identifier of this event.
event_id=$id
logical_group STRING
Logical grouping of this event.
logical_group="error
messages"
Monitor group that reported this
event.
monitor_group="log
monitors on \\hostname"
STRING
orig_
severity_name
Severity in external EMS
terminology.
orig_severity_name
="Cleared"
acknowledged_ STRING
by
Name of user that acknowledged
this event.
acknowledged_by
=$username
Name of user who owns this
event.
owner="admin"
monitor_
group
STRING
owner
STRING
value
DOUBLE Use to transfer numerical values
from the event.
value=$thresholdViolated
attr1
STRING
Extra data slot.
attr1=$history
attr2
STRING
Extra data slot.
attr2=$moreHistory
attr3
STRING
Extra data slot.
attr3="Design"
attr4
STRING
Extra data slot.
attr4=$MonitorOutput
attr5
STRING
Extra data slot for long strings.
attr5=$Longhistory
Host DNS Resolution for Event Sample
Both the FQDN (fully qualified domain name) and valid IP address are necessary for the fields that
are used to create Node CIs in the BSM integration.
If you do not know the FQDN, IP address, or both, then you can use the following functions in the
field mapping to resolve the names and access them from the source of the integration:
target_name=resolveHostName($SomeHost)
target_ip=resolveHostIP($SomeHost)
Note: The variable $SomeHost must be replaced by a variable from the integration source.
These functions are not necessary if:
HP SiteScope (11.23)
Page 473 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
l
The FQDN, IP address, or both, are available from the source that the integration is accessing.
In this case, input the value for target_name= as a FQDN and the value for the target_ip=
without the function.
l
It is not possible for the SiteScope server to resolve the FQDN, IP address, or both, for the
servers from the source that the integration is accessing. In this case, the functions may not
provide the valid values.
Conditional Expression Example 1
severity:INT=$var6.equals("red") ? SEVERITY_CRITICAL
: SEVERITY_INFORMATIONAL
In this example, the value of sixth variable binding is compared to string red. If the variable binding
is indeed equal to string red, then the value of the severity tag is set to SEVERITY_CRITICAL,
otherwise it is set to SEVERITY_INFORMATIONAL.
Conditional Expression Example 2
severity:INT=$var6.equals("red") ? SEVERITY_CRITICAL :
$var6.equals("green") ? SEVERITY_INFORMATIONAL : $var6.equals("yellow")
? SEVERITY_MINOR : SEVERITY_WARNING
This example chains the conditional operator into a decision chain. If the sixth variable binding
holds string red, then severity tag has the value SEVERITY_CRITICAL. If the sixth variable binding
holds string green, then severity tag has the value SEVERITY_INFORMATIONAL. If the variable
binding holds string yellow, the tag has the value SEVERITY_MINOR. If none of the above conditions
are true, then the tag has the value SEVERITY_WARNING.
Event Script Example
In the example below, two types of events are sent: the first are events of status "OPEN" and the
second are events cleared by a user. The data is retrieved from incoming event fields using the $
notation. All other events are discarded by the last handler.
[$DEFAULT_PARAMETERS$]
################################################
# NOTE: the following parameters are mandatory #
################################################
time_stamp:DOUBLE=str_to_seconds($time,"yyyy-MM-dd HH:mm:ss.SSS")
severity:INT= SEVERITY_UNKNOWN
target_name=$Device
status=$Status
subject="EMS X Events"
instance=$target
description=$description
data_source="EMS X"
HP SiteScope (11.23)
Page 474 of 1293
Using SiteScope
Chapter 38: Configure Integration Monitors to Collect Event Data
#send an open event with the value in value fields and with the event id
[OPEN events]
$MATCH="OPEN".equals($Status)
$ACTION=SEND(event)
value:DOUBLE=parseDouble($threshold)
event_id=$uid
#send clear events with the event id and acknowledging username
[clear events]
$MATCH="CLEAR".equals($Status)
$ACTION=SEND(event)
event_id=$uid
acknowledged_by=$ClearedBy
[event sink]
$MATCH=true
$ACTION=DISCARD
Troubleshooting and Limitations
This section describes troubleshooting and limitations for Integration Monitor field mapping.
For event samples, the monitor_id of the reported EMS monitor is built in the following way:
l
l
n
For Events samples and Computer topology, the monitor_id is:
< target_name>
n
For Events samples and Computer - Running Software topology (where subject is not equal
to system), the monitor_id is:
<subject (running software name)>
n
For Events samples and Computer - Running Software topology (where subject equals
system), the monitor_id is:
< target_name>
Do not use XML special characters (",',<,>,&) in the fields used to create the monitor_id, since
these characters causes problems for these samples in BSM.
HP SiteScope (11.23)
Page 475 of 1293
Chapter 39: Configure Integration Monitors to
Collect Ticketing Data
When configuring the generic integration monitors, you can select the ticketing data type to collect
incidents and events from ticketing systems. Data collected by integration monitors that use the
ticketing data type is integrated into BSM and can be viewed in Service Health and Service Level
Management.
This chapter includes:
l
"Integration Monitor Field Mapping for Ticketing Samples" below. Provides an overview of
integration monitor field mappings for ticketing samples.
l
"How to Configure Integration Monitors to Collect Ticketing Data" on the next page. Describes
how to configure SiteScope to collect incidents and events from third-party ticketing systems,
and to import the data samples into BSM.
l
"Configure Field Mapping for Ticket Samples" on page 480. Provides a list of mandatory and
optional values (and examples) for the ticket script.
l
"Troubleshooting and Limitations" on page 483. Describes troubleshooting and limitations for
Integration Monitor field mappings for tickets samples and topology.
Integration Monitor Field Mapping for Ticketing
Samples
You can enable capturing event and metrics data from Enterprise Management Systems (EMS),
automated support systems, and other management applications by configuring integration
monitors and their field mapping scripts.
Integration monitors depend on the field mapping you customize within the user interface in the
settings for the monitor. The mapping defines the processing of incoming data and defines the
output sample forwarded to BSM.
Integration Monitors designed for use with specific EMS applications (these currently include HP
OM, HP Service Center, and NetScout) can be configured without editing their field mapping script.
The mapping is predefined by HP and requires modification only if specific customizations are
required. For details on editing these field mapping scripts, see the description for the field mapping
element in the user interface pages for the monitor you are deploying.
For Technology Integration Monitors (Technology SNMP Trap, Technology Log File, and
Technology Database monitors), you must select the data type and the required script is loaded
directly into the field mapping text box. You must edit the field mapping script to suit your
organization's needs. The Technology Web Service Integration Monitor field mapping may also
need to be customized.
HP SiteScope (11.23)
Page 476 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
When you select Tickets and you want to integrate to BSM using topology settings, you can select
the following topology script: Tickets or Custom (only if you are familiar with the Jython language,
since you must create the Jython topology script yourself).
For details, on selecting a topology setting, see "Topology Settings for Technology Integration
Monitors" on page 400.
Note: Use only the mandatory and optional fields defined in the scripts when working with the
field mapping. For more information, see the tables for each data type.
How to Configure Integration Monitors to Collect
Ticketing Data
This task describes the steps involved in configuring SiteScope to collect incidents and events
from third-party ticketing systems, and to import the data samples into BSM.
1.
Plan the integration strategy
Review the Integration Monitor types. Consider the type of information you want to view in
BSM from your EMS system. Determine whether one of the specific Integration Monitors
meets your organization's needs or whether a generic Integration Monitor (Technology Log File,
Database, SNMP Trap, Web Service) is required.
For concept details, see "Integration Monitors Overview" on page 394.
2.
Configure BSM integration
Integrate SiteScope and BSM. For details, see "How to Configure SiteScope to Communicate
with BSM" on page 236.
3.
Select the SiteScope server
Select the SiteScope server from which you want to deploy the integration monitor:
4.
n
For SiteScope standalone, select and open a SiteScope instance.
n
When in SAM Administration, select the SiteScope server from which you want to deploy
the integration monitor. For user interface details, see "System Availability Management
Administration Page" in the BSM Application Administration Guide in the BSM Help.
n
When in EMS Integrations Administration, click the New Integration or Edit Integration
button. In the Edit Integration dialog box, click the link in the System Availability
Management panel to open SAM Administration window where you can select a SiteScope
server. For user interface details, see "Edit Integration Dialog Box" in the BSM Application
Administration Guide in the BSM Help.
Create a group for the integration monitor
For user interface details, see "New SiteScope Group Dialog Box" on page 265.
HP SiteScope (11.23)
Page 477 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
Tip: We recommend that you create special groups for the integration monitors. This
enables you to more easily recognize the data that is reported to BSM as coming from the
integrations.
5.
Add the integration monitor
Configure the integration monitor and add the required data for the monitor's settings. You can
choose from the following application-specific integrations:
n
HP OM Event Monitor (for details, see the SiteScope Monitor Reference Guide)
n
HP Service Manager Monitor (for details, see the SiteScope Monitor Reference Guide)
n
NetScout Event Monitor (for details, see the SiteScope Monitor Reference Guide)
You can choose from the following generic integration monitors (note that generic integration
monitors are supported for BSM 9.1x and earlier versions only; for all new third-party data
integrations in BSM 9.2x, use BSM Connector as described in the BSM Application
Administration Guide in the BSM Help.)
6.
n
Technology Database Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology Log File Integration Monitor (for details, see the SiteScope Monitor Reference
Guide)
n
Technology SNMP Trap Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
n
Technology Web Service Integration Monitor (for details, see the SiteScope Monitor
Reference Guide)
Edit the monitor's field mapping
The mapping defines the processing of incoming data and the output sample forwarded to
BSM.
a. In the Field Mapping panel, select the Tickets field mapping script, and click Load File.
b. Edit the script to enable SiteScope to retrieve the data from the monitored application that
you want to forward to BSM by mapping the script values to the corresponding field
mapping group in which they appear in the log file from which you want to extract data.
For mandatory script values, see "Mandatory Values for the Ticket Script" on page 481.
For optional script values, see "Optional Values for the Ticket Script" on page 482.
HP SiteScope (11.23)
Page 478 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
Note: The Field Mapping settings are not available when the Report topology without
data check box is selected in the Topology Settings panel. For details on reporting
topology without data, see "Report Topology Without Data" on page 485.
7.
Map the data to a topology script - optional (required when reporting
topology to BSM)
In the Topology Settings panel, select a topology script to forward the data to the correct CI
hierarchy in BSM:
n
Tickets. Select to create a Business Service CI with an EMS monitor CI connected to it
with Monitored By relationship. The EMS Monitor CI propagates status onto the Business
Service CI.
Note: The topology script must include the EMS monitor CI as the lowest leaf in the
topology created by the integration
n
Custom. Select to create your own topology script.
Edit the topology settings. The topology scripts are specially configured with the necessary
values to forward data to the required CIs in BSM's RTSM.
Note:
o
When using field mapping, you can use the field mapping fields as an input for
topology script. For example, if using legacy event mapping, you can access the
value of the Subject field in the following way:
subject = Framework.getDestinationAttribute("Subject")
o
In addition, you can access values of the "monitor variables", such as group0,
group1, and so forth, from Technology Log File Integration monitor, or the names of
database columns in Technology Database Integration monitor, or other variables in
the other integration monitors. For example, you can access the value of the group1
variable, in the following way:
group1 = Framework.getDestinationAttribute("group1")
8.
Test the field mapping script - optional
In the Topology Settings panel, click Test Script to test the script before running the monitor.
This tests the following:
HP SiteScope (11.23)
Page 479 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
9.
n
Checks the field mapping and topology script syntax.
n
Displays the mapping results.
n
Displays the topology results if a topology script has been configured.
Configure the EMS Integrations application in BSM
In addition to configuring the monitor, you need to configure the EMS Integrations application in
BSM. For details, see the remaining steps in "Create an EMS integration (for Event or Ticket
Samples)" in "How to Integrate Data from Third-Party Sources (EMS Data) into HP Business
Service Management" in the HP Software Integrations site.
Note: If you are configuring a metrics integration, do not need to go to BSM's SAM
Administration and configure a new integration. You just need to create a monitor and
select the Report topology option.
10.
Results
When events are gathered from a third-party system and processed by integration monitors,
the events are generated and the event data is written to the
HPSiteScopeOperationsManagerIntegration.log file in the <SiteScope root
directory>\logs directory. Each event is written as a separate line in the log. The log file policy
instructs the agent to read this file and create event messages that are sent to BSM.
You can view events in Service Health, System Availability Management Event Logs, and
trend reports.
Configure Field Mapping for Ticket Samples
The ticket data type is used for extracting events collected by external systems and importing them
to BSM.
To configuring an integration monitor's field mapping:
1. Select the Tickets data type to load the tickets script.
2. Copy the contents of the Field Mapping text box and paste it into a text editor to make your
configuration changes.
3. Copy the contents back into the Field Mapping text box.
For details on event handler structure and syntax, see "Event Handler Structure and Syntax" on
page 409.
This section also includes:
HP SiteScope (11.23)
Page 480 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
l
"Mandatory Values for the Ticket Script" below
l
"Optional Values for the Ticket Script" on the next page
l
"Conditional Expression Example" on page 483
l
"Ticket Script Example" on page 483
Mandatory Values for the Ticket Script
The table below lists mandatory values for the ticket script.
Field
Name
Type
Description
Example
time_
stamp
DOUBLE Time stamp in
seconds since Jan 1
1970.
time_stamp:DOUBLE=str_to_seconds
($time,"yyyy-MM-dd HH:mm:ss.SSS").
severity
INT
Can be one of the
following
preconfigured
severities (based on
applicable integer):
SEVERITY_
UNKNOWN
SEVERITY_
INFORMATIONAL
SEVERITY_
WARNING
SEVERITY_MINOR
SEVERITY_
MAJOR
SEVERITY_
CRITICAL
4".equals($severity) ?
("3".equals($severity)
("2".equals($severity)
("1".equals($severity)
"Unknown")))
target_
name
STRING
Name of the entity
(usually a service)
that generated the
ticket.
target_name="mail service" (Do not enter
static string here, should be retrieved dynamically
from the ticket.)
data_
source
STRING
System that
generated the ticket.
data_source="ticketing" (This string should
not be edited for HP ServiceCenter integration
and must be edited for a generic technology
integration monitor.)
ticket_id
STRING
ID of the ticket.
ticket_id=112233
HP SiteScope (11.23)
"Low" :
? "Average" :
? "High" :
? "Critical" :
Page 481 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
Field
Name
Type
Description
Example
ticket_
state
STRING
One of the states in
the incident lifecycle
as defined in the
ticketing system.
"Open" / "Closed"
ticket_
type
STRING
Type of the incident
as defined in the
ticketing system.
"Incident"
orig_
STRING
severity_
name
Severity in external
EMS terminology.
orig_severity_name ="Cleared"
Optional Values for the Ticket Script
The script includes comments describing the optional values available for the ticket script. They
include those listed here:
Field
Name
Type
Description
Example
subject
STRING Middle/High level hierarchy describing the event
source.
CPU, SAP
application, hard
disk
instance
STRING Instance of subject that generated the event. The
lowest level hierarchy describing the event
source.
D:\\
object
STRING Optional level in the hierarchy describing the
ticket source.
object="OS"
logical_
group
STRING Logical grouping of this ticket.
logical_
group="error
messages"
monitor_
group
STRING Monitor group that reported this ticket.
monitor_group="log
monitors on
\\hostname"
elapsed_
time
STRING Elapsed time of the ticket.
orig_
STRING Severity name as defined in the ticketing system.
severity_
name
attr1
STRING Extra data slot.
HP SiteScope (11.23)
attr1=$history
Page 482 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
Field
Name
Type
attr2
STRING Extra data slot.
attr2=$moreHistory
attr3
STRING Name of organization which owns a business
service (if used in the Business Service
integration topology flow).
Attr3="XYZ Inc"
attr4
STRING Type of organization which owns a business
service (if used in the Business Service
integration topology flow).
Attr4="department"
attr5
STRING Extra data slot for long strings. Use for values up
to 2000 chars.
attr5=$Longhistory
Description
Example
Conditional Expression Example
This example configures the severity of the ticket sample. It matches between the status terms
used in the ticketing system to those used in BSM.
4".equals($severity) ? "Low" : ("3".equals($severity) ? "Average" :
("2".equals($severity) ? "High" : ("1".equals($severity) ? "Critical" :
"Unknown")))
Ticket Script Example
[$DEFAULT_PARAMETERS$]
time_stamp:DOUBLE=$time_stamp
ticket_id=$ticket_id
ticket_state=$ticketStatus
severity:INT=$severity
target_name=$target_name
data_source="ticketing"
ticket_type="Incident"
orig_severity_name="4".equals($severity) ? "Low" : ("3".equals($severity)
? "Average" : ("2".equals($severity) ? "High" : ("1".equals($severity)
? "Critical" : "Unknown")))
Troubleshooting and Limitations
This section describes troubleshooting and limitations for Integration Monitor field mapping.
l
For Tickets samples and Tickets topology, the monitor_id of the reported EMS monitor is:
<data_source>_<target_name>
HP SiteScope (11.23)
Page 483 of 1293
Using SiteScope
Chapter 39: Configure Integration Monitors to Collect Ticketing Data
l
Do not use XML special characters (",',<,>,&) in the fields used to create the monitor_id,
because these characters causes problems for these samples in BSM.
HP SiteScope (11.23)
Page 484 of 1293
Chapter 40: Report Topology Without Data
You can enable SiteScope to report only the topology discovered by the SiteScope Technology
Integration monitors, without reporting the data.
Tasks
How to Report Topology Without Data
This task describes how to enable reporting topology discovered by the SiteScope Technology
Integration monitors without sending data.
1. Configure the Technology Integration monitor
a. When configuring a Technology Integration monitor, in the Topology Settings panel, select
the Report topology without data check box.
Note: When this option is selected, the Field Mapping area is not available.
b. Select a topology script from the following options:
o
Computer. Select to create a topology with a Computer CI.
o
Computer - Running Software. Select to create a topology with a Computer CI as the
parent CI and a Running Software CI under it.
o
Custom. Select to create your own topology script, if you want the retrieved data to be
sent to specific CIs instead of the Computer or Running Software CIs.
c. Map the data discovered by the monitor to the relevant attributes in the topology settings.
The topology scripts are specially configured with the necessary values for reporting
topology only to BSM.
For mandatory script values, see "Configure Field Mapping for Common Event Samples"
on page 466.
Note:
o
Computer and Computer - Running Software are out-of-the-box topology scripts
that are available for the report topology without data type flow.
o
The Computer and Computer - Running Software scripts are available only
when SiteScope is connected to BSM versions 9.x or later.
Note: You can access values of the "monitor variables", such as group0, group1, and
HP SiteScope (11.23)
Page 485 of 1293
Using SiteScope
Chapter 40: Report Topology Without Data
so forth, from the Technology Log File Integration monitor, or the names of database
columns in the Technology Database Integration monitor, or other variables in the
other integration monitors. For example, you can access the value of the group1
variable, in the following way:
group1 = Framework.getDestinationAttribute("group1")
2. Test the script - optional
In the Topology Settings panel, click Test Script to test the script before running the monitor.
This displays the topology results.
The test does not forward topology to BSM.
HP SiteScope (11.23)
Page 486 of 1293
Chapter 41: Network Node Manager Integration
BSM can accept events from HP Network Node Manager (NNM). You can forward event data from
Network Node Manager (NNM) by configuring NNM to run a script for each event that you want
forwarded to BSM. The script that you write and associate with NNM can do one of the following
actions:
l
Write the NNM data to a log file.
l
Send an SNMP trap with the NNM data to a SiteScope server.
If your script writes the data to a log, you then use a Technology Log File Integration Monitor to read
the data and forward it to BSM. If you use a script to send an SNMP trap to a SiteScope server, you
use an Technology SNMP Trap Integration Monitor configured to receive it and forward to BSM.
Learn About
Scripts to Export Network Node Manager Data
The script you use should accept data from NNM as a command line argument, and process the
data so that it can be forwarded to BSM. The following sections describe example scripts that can
be used to export NNM data.
Sample Script for Writing to a Log File
The following Perl script receives data from the command line and writes it to a log file as a comma
separated vector of values that can be parsed by the Log File Integration Monitor:
#!/usr/bin/perl
open LOG, ">>log1.log" or die;
print LOG (join ',', @ARGV) . "\n";
close LOG;
Sample Script for Sending SNMP Trap Data
The following Perl script receives data from the command line and sends it as a message in an
SNMP trap (using SNMP data generated by Network Node Manager) that can be caught by a
Technology SNMP Trap Integration Monitor. It accepts the host name to which the trap is sent as
the first parameter and a string description of the alert as the second parameter.
#!/usr/bin/perl
$host = $ARGV[0];
$message = $ARGV[1];
system("snmptrap $host \"\" \"\" 6 0 5 system.sysDescr.0 " . "octetstringascii $message");
HP SiteScope (11.23)
Page 487 of 1293
Using SiteScope
Chapter 41: Network Node Manager Integration
Tasks
How to Configure Events in Network Node Manager
Use the following steps to configure NNM 7.x to run a script for the requested events in NNM.
Note: For later versions of NNM and NNMi, refer to the NNMi documentation.
1. From the Options menu, choose Event Configuration.
2. Select the requested enterprise and event from the Event Configuration dialog box.
3. Select the Actions tab from the Edit > Events > Modify Events dialog box.
4. Enter the command line for the script in the Command for Automatic Action text box. You
may use NNM variables to pass data to the command line.
5. Click OK to close the Modify Events dialog box.
6. From the File menu in the Event Configuration dialog box, select Save.
HP SiteScope (11.23)
Page 488 of 1293
Part 6: Remote Servers
You configure monitors to collect the data from remote servers you want to monitor. This means
selecting a remote server, and configuring connection properties so that SiteScope can monitor
systems and services running in remote environments. For details, see "Configure SiteScope to
Monitor Remote Windows Servers" on page 490 and "Configure SiteScope to Monitor Remote
UNIX Servers" on page 510.
This section also describes the following:
l
How to configure SiteScope to monitor data on remote Windows servers using Windows
Management Instrumentation (WMI) ("Configure the WMI Service for Remote Windows
Monitoring" on page 507).
l
How to enable SiteScope to prefer IPv6 addresses over IPv4 when connecting to remote
servers ("Enable SiteScope to Prefer IP Version 6 Addresses" on page 526).
l
How to use Secure Shell (SSH) connection for remote monitoring ("SiteScope Monitoring Using
Secure Shell (SSH)" on page 531).
l
How to configure the integrated Java SSH client ("Integrated Java SSH Client" on page 548).
l
How to create and customize adapter files for UNIX monitoring ("Extend UNIX Monitoring Using
Operating System Adapters" on page 519).
HP SiteScope (11.23)
Page 489 of 1293
Chapter 42: Configure SiteScope to Monitor
Remote Windows Servers
Microsoft Windows Remote server options are used to set up the connection properties, such as
credentials and protocols, so that SiteScope can monitor systems and services running in remote
environments. You can then create monitors to watch the resources and performance counters for
that server. Multiple monitors can use the same connection profile. You can also create multiple
remote servers for the same host machine.
To access
Select the Remote Servers context. In the remote servers tree, click the Microsoft Windows
Remote Servers container.
Learn About
Remote Server Overview
SiteScope must be able to establish a connection to the servers you want to monitor.
It must also be authenticated as a user having account permissions to access the Windows
performance registry on the Microsoft Windows remote machine, and to run command line tools on
the UNIX remote machine as a remote user.
Monitoring remote Windows servers also requires that a supported operating system is running on
the remote server (see the list of supported operating systems for remote Windows servers below).
Operating Systems Supported for Monitoring Remote Windows Servers
The following operating systems are supported for monitoring remote Windows servers:
l
Windows Server 2003
l
Windows Server 2008
l
Windows Server 2008 R2
l
Windows Server 2012
Tasks
How to Configure SiteScope to Monitor a Remote Microsoft Windows
Server
This task describes the steps involved in configuring SiteScope to monitor data on remote
Windows servers.
1.
Prerequisites (for Windows Server 2008, 2008 R2, and 2012 remote
servers)
HP SiteScope (11.23)
Page 490 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
n
Only an administrator in SiteScope, or a user granted Add, edit or delete remote servers
permissions can view or edit the Remote Servers page. For details on user permissions,
see "User Management Preferences" on page 726.
n
SiteScope supports monitoring on Microsoft Windows Server 2008/2008 R2/2012 remote
servers with User Account Control (UAC) enabled or disabled. Where UAC is enabled, you
must make the following registry changes on the remote server so as to avoid access
issues or problems getting data on perfex monitors (such as CPU, Memory, Disk Space,
Microsoft Windows Resources, Microsoft Windows Event Log, Microsoft Windows
Performance Counter, Services, Microsoft IIS Server, Microsoft SQL Server) when using
the WMI or NetBIOS protocol.
i. Click Start, click Run, type regedit, and then press ENTER.
ii. Locate and then click the following registry subkey: HKEY_LOCAL_
MACHINE\SOFTWARE\Microsoft\Windows\
CurrentVersion\Policies\System
iii. If the LocalAccountTokenFilterPolicy registry entry does not exist, follow these steps:
o
On the Edit menu, select New >DWORDValue.
o
Type LocalAccountTokenFilterPolicy, and then press ENTER.
iv. Right-click LocalAccountTokenFilterPolicy, and then click Modify.
v. In the Value data box, type 1, and then click OK.
vi. Exit Registry Editor.
n
2.
To remotely monitor on a Windows Server 2008 or 2012 machine, you must enable the
Remote Event Log Management exception in the Windows Firewall Settings on the remote
server to which you want to connect. Otherwise, when you try to use the session handle,
the call will result in a RPC_S_SERVER_UNAVAILABLE error.
Enable SiteScope to monitor data on remote Windows servers
To enable SiteScope to monitor data on remote Windows servers, you must perform one of the
following steps:
n
Define an individual remote Windows server connection profile for each server.
Monitoring remote Windows server data requires authenticated access to the remote server.
A Windows server connection profile provides the necessary address and login credentials
for SiteScope to log on to a remote server and to access the Windows performance registry
on that remote machine.
To log on to a remote server using the Windows server connection profile, either:
HP SiteScope (11.23)
Page 491 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
n
o
Log on to the remote server as a user with administrator privileges, or
o
Create or modify a user account on the remote server that corresponds with the
connection method and login permissions used in the SiteScope connection profile for
that server.
Set domain access privileges to permit SiteScope to access remote servers.
SiteScope for Windows automatically generates a list of servers visible in the local domain.
These servers are listed in the Servers list for monitor types where a server must be
specified. SiteScope running on Windows may be able to use this list to monitor remote
Windows servers without having to create individual connection profiles for each server.
To set domain privileges, use one of the following methods:
o
Set the SiteScope service to run as a user in the Domain Admin group.
By default, SiteScope is installed to run as a Local System account. You can set the
SiteScope service to log on as a user with domain administration privileges. This gives
SiteScope access privileges to monitor server data within the domain.
To change the user account of the SiteScope service:
o
o
In Administrative Tools, open Services, and select SiteScope from the list of
services. The SiteScope Properties dialog box opens.
o
Click the Log On tab, and in the Log on as area, enter an account that can access
the remote servers.
o
Click OK to save your settings and close the SiteScope Properties dialog box.
o
Right-click SiteScope. Click Stop to stop the SiteScope service.
o
Click Start. The SiteScope service now uses the new account.
Add the server where SiteScope is running to the Domain Admin group in
ActiveDirectory (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.
o
Edit the registry access permissions for all machines in the domain to enable
non-admin access.
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 remote machines whose registry has been modified can be
monitored without use of a connection profile.
HP SiteScope (11.23)
Page 492 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
Note: If you configure the SiteScope service to run as a domain user, SiteScope uses
this account for all Windows-related authorization. You must ensure that this account
has the necessary privileges across the domain.
3.
Configure user permissions for remote monitoring
For SiteScope to collect performance measurements on a remote Windows machine,
SiteScope must have permission to access the remote machine.
Note:
n
Microsoft Best Practice recommends giving permissions to groups instead of to users.
n
Back up the registry before making any registry changes.
To configure user permissions on the SiteScope machine:
a. On the SiteScope machine, select Start > Run. In the Open text box, enter Regedt32.exe.
The Registry Editor dialog box opens.
b. In the HKEY_LOCAL_MACHINE window, select SOFTWARE > Microsoft > Windows
NT > CurrentVersion > Perflib.
c. Click Edit in the Registry Editor tool bar and select Permissions. The Permissions for
Perflib dialog box opens.
d. In the Name pane, select the user SiteScope uses to access the remote machine. In the
Permissions pane, select the Allow check box for Read. Click OK to save the
configuration and close the Permissions for Perflib dialog box.
e. In the HKEY_LOCAL_MACHINE window, select SYSTEM > CurrentControlSet >
Control > SecurePipeServers > winreg. Click Security in the Registry Editor tool bar
and select Permissions. The Permissions for winreg dialog box opens.
f. In the Name pane, select the user that SiteScope uses to access the remote machine. In
the Permissions pane, select the Allow check box for Read. Click OK to save the
configuration and close the Permissions for winreg dialog box.
g. In the Registry Editor tool bar, click Registry and select Exit to save the configuration and
exit.
h. Restart the SiteScope machine.
Note: For information about enabling non-administrative users to monitor performance
on a remote machine, refer to the Microsoft Knowledge Base
(http://support.microsoft.com/kb/q164018/).
HP SiteScope (11.23)
Page 493 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
4.
Configure and test the settings for the Windows remote server
a. Configure the remote Windows server in the remote server tree. For user interface details,
see "New/Edit Microsoft Windows Remote Server Dialog Box" on the next page.
Note:
o
If you are configuring remote Windows Servers for SSH monitoring with SiteScope,
see "How to Configure Remote Windows Servers for SSH monitoring" on page
535.
o
If WMI is selected as the connection method for gathering management data from
remote servers (in the Method field in Main Settings), the WMI service must be
configured on the remote machine. For task details, see "How to Configure the
WMI Service for Remote Monitoring" on page 508.
o
When configuring the WMI connection type method for monitoring on the localhost
machine (the machine where SiteScope is running), the User name and Password
must be left blank in the Credentials section.
o
If specifying a literal IPv6 address as the name for the remote monitored 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 (where supported),
and avoid having to make changes to the IPv6 address.
b. After defining the Microsoft Windows remote server definition for SiteScope, click the Test
button for the applicable server to test the connection.
Note: If an "unable to connect to remote machine" error message opens when
trying to view remote counters, refer to the Microsoft Knowledge Base
(http://support.microsoft.com/search/).
5.
Results
The server is added to the list of remote Windows Remote servers in the remote server tree.
You can then create monitors to watch the resources and performance counters for that server.
Multiple monitors can use the same connection profile.
HP SiteScope (11.23)
Page 494 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
Note: For information about troubleshooting and limitations of SiteScope monitoring of
remote servers, see "Tips/Troubleshooting" on page 501.
UI Descriptions
New/Edit Microsoft Windows Remote Server Dialog Box
Important
information
See also
l
You cannot delete a server from the list of remote servers if the server is
referenced by a monitor. Select a different server in the Server box of the
Monitor Settings panel for each monitor that references the remote server, and
then delete the remote server from the remote server list.
l
Remote server passwords support empty spaces and the following special
characters: \ " & | > < ^
l
When configuring a Microsoft Windows remote server in template mode, the
Method value must be entered using the same case that follows, otherwise
verification does not work properly: NetBIOS, WMI, or ssh
l
"Remote Server Tree" on page 55
l
"Remote Servers Properties Page" on page 554
The following elements are included:
UI Element
Description
Save
Saves the settings without verifying the correctness of the configuration on the
remote server.
Tip: Performance is faster if you use Save instead of Save & Test, because
SiteScope does not need to establish a connection to the remote server to
verify the settings.
HP SiteScope (11.23)
Page 495 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
UI Element
Description
Save & Test
Saves the settings and verifies the correctness of the configuration on the
remote server. If SiteScope fails to connect to the remote server, or if there is
an invalid property in the configuration settings, an error message is displayed.
Tip: Performance is slower if you use Save & Test instead of Save, because
SiteScope needs to establish a connection to the remote server to verify the
settings.
General Settings
Name
Name by which the remote machine should be known in SiteScope. This name
appears in the Server list of monitors that can use this connection profile.
Note when working in template mode:
Description
l
For each template monitor that requires this remote server, you must enter
this same value in the Servers box for the template monitor.
l
Names must be unique, otherwise the deployment fails.
Description for the remote Windows server. This text appears only when
editing the remote's properties.
Main Settings
HP SiteScope (11.23)
Page 496 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
UI Element
Description
Server
Real IP address or UNC name of the monitored Windows server. Network
address translation (NAT) is not supported for SiteScope monitors that require
a remote host definition. SiteScope is unable to determine if an external (real
IP) or internal IP (NAT) is used when you configure a monitor with an IP
address or host. To monitor servers in a NAT environment, we recommend
placing SiteScope inside the firewall. Virtual IPs can be used in monitors which
do not collect host specific information, such as in the URL monitor or other
similar monitors.
An IP host name also works if the SiteScope server can translate this common
name into an IP address by using a hosts file, DNS, or WINS/DNS integration.
You can create multiple remote servers for the same host machine. For
example, you can create one remote server that uses the NetBIOS protocol
and another that uses WMI for the same host machine, provided the name in
General Settings is unique.
To use the same login credentials to configure multiple servers at the same
time, enter the server names or addresses separated by a comma (","),
semicolon (";"), or a space. For example, \\server1,\\server2,\\.
Note: In the list of Windows Remote Servers, click the Test
connectivity after the profiles have been added.
button to test
Note when working in template mode: Name of a template variable that
represents the remote server name, for example, %%host%%. This enables you
to add each server as you deploy the template when asked to enter the required
information for the variables. Each time you enter a server name for the
variable, a monitor instance is created for that server and the server is added to
the remote server tree. If the host name does not match a server name at that
time, the monitor fails.
If the remote servers onto which you want to deploy monitor templates already
exist under Remote Servers, you can reference these servers within the
monitor template. You do this by referencing the system variable $$SERVER_
LIST$$ which identifies the servers accessible to the SiteScope. For details,
see "Variable Syntax" on page 779.
HP SiteScope (11.23)
Page 497 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
UI Element
Description
Credentials
Option for providing the user name and password for the remote Windows
server:
Use user name and password. Select this option to manually enter user
credentials.
l
l
Trace
n
User name. Enter the user name for the remote server or use a template
variable that represents the user login name (for example, %%user%%).
Note: If the server is within the same domain as the SiteScope machine,
include the domain name in front of the user login name. For example:
<DOMAIN>\<username>. If using a local machine login account for
machines within or outside the domain, include the machine name in front
of the user login name. For example: <machinename>\<username>.
n
Password. Enter the password for the remote server or the passphrase for
the SSH key file, or use a template variable that represents the password
(for example, %%password%%). When using SSH authentication with
public/private key based authentication enter the passphrase for the
identity file here.
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password for the server
(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
"Credential Preferences" on page 572.
Traces messages to and from the subject server, and records them in the
SiteScopeRunMonitor.log file.
Default value: Not selected
HP SiteScope (11.23)
Page 498 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
UI Element
Description
Method
Connection types for monitoring Windows server resources:
l
NetBIOS. The default server-to-server communication protocol for
Microsoft Windows networks.
Note: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 when the NetBIOS
connection is used and the Trace option is selected. 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.
l
SSH. Secure Shell, a more secured communication protocol that can be
installed on Microsoft Windows networks. This connection method normally
requires installing SSH libraries on each server to be connected, unless you
are using agentless Windows SSH. For the list of monitors that support
Windows SSH (agentless or using the SiteScope remote Windows SSH
files), see "Monitors Supporting Windows SSH (Agentless or Using the
SiteScope Remote Windows SSH Files)" on page 545. For more
information on SSH requirements, see "SiteScope Monitoring Using Secure
Shell (SSH)" on page 531.
l
WMI. Windows Management Instrumentation, a more secured
communication protocol than NetBIOS, supports Windows server monitors
that use perfmon to gather performance data. For the list of monitors that
support WMI and details on how to configure the WMI service for remote
monitoring, see "Configure the WMI Service for Remote Windows
Monitoring" on page 507.
Note:
HP SiteScope (11.23)
n
Remote servers that have been configured with the WMI method are not
displayed in the list of available remote servers when configuring a
monitor that does not support WMI.
n
When configuring the WMI connection type method for monitoring
Windows server resources on the localhost machine (the machine where
SiteScope is running), the User name and Password must be left blank
in the Credentials section.
Page 499 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
UI Element
Description
Remote
server
encoding
Encoding for the remote server, if the remote server is running an operating
system version that uses a different character encoding than the server on
which SiteScope is running. This enables SiteScope to display encoded
content correctly.
Default value: Cp1252 encoding
Advanced Settings
SSH port
number
Port on which the remote SSH server is listening.
Connection
limit
Number of open connections that SiteScope permits for this remote. If there
are many monitors configured to use this connection, set the number of open
connections high enough to relieve a potential bottleneck.
Default value: 22
Default value: 3
Note: This setting does not effect running tests for a remote server. Tests
always create a new connection.
Disable
connection
caching
Turns off connection caching for this remote. By default, SiteScope caches
open connections.
Default value: Not selected
SSH
Authentication method to use for SSH connections:
authentication
l Password. Authenticates using a password (default setting).
method
l
Key File. Authenticates using public/private key authentication. When this
option is selected SiteScope uses the private key in the file
<SiteScope root directory>\groups\identity to authenticate. The
corresponding public key must be listed in the authorized_keys file on the
remote host.
For information about SSH requirements, see "SiteScope Monitoring Using
Secure Shell (SSH)" on page 531.
Key file for
SSH
connections
Path and name of the file that contains the private key for this connection. The
default key file is <SiteScope root directory>\groups\identity. This setting
applies only when the authentication method is Key File.
SSH version
2 only
Forces SiteScope to use SSH protocol version 2 only.
HP SiteScope (11.23)
Default value: Not selected
Page 500 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
UI Element
Description
SSH keep
alive
mechanism
Engages a keep alive mechanism for SSH version 2 sessions. This option
applies only when using the integrated Java Client. SSH keepalive packets are
sent every 55 seconds.
Default value: Not selected
SSH using
preinstalled
SiteScope
remote
Windows
SSH files
Uses preinstalled SiteScope remote Windows SSH files. For the list of
monitors that support Windows SSH using SiteScope SSH files, see "Monitors
Supporting Windows SSH (Agentless or Using the SiteScope Remote
Windows SSH Files)" on page 545.
Default value: Selected
Search/Filter Tags
Add Tag
Opens the New Tag dialog box, enabling you to add new keyword tags. For
user interface details, see "New/Edit Tag Dialog Box" on page 93.
<Tag name
and values>
Keyword tags are used to search and filter SiteScope objects (groups,
monitors, remote servers, templates, and preference profiles). If no tags have
been created for the SiteScope, this section appears but is empty. If tags have
been created, they are listed here and you can select them as required.
For concept details, see "Search SiteScope Objects" on page 88.
See also: "Remote Servers Properties Page" on page 554
Tips/Troubleshooting
This section describes troubleshooting and limitations when working with remote servers.
l
"General Issues Monitoring Windows Remote Servers" below
l
"Recommended Network Settings for Monitoring Windows Servers" on the next page
l
"Understanding Error Codes When Testing Windows Remote Servers" on page 503
l
"Microsoft Windows Event Log Access on Remote Windows Servers" on page 503
l
"SiteScope Uses the Wrong Credentials for Remote Windows Connections Using Perfex" on
page 504
l
"Viewing Data Returned when SiteScope is Trying to Access the Remote Registry" on page 504
l
"System Encoding Used When Displaying System Resources for Remote Hosts Connected
Through NETBIOS" on page 506
Troubleshooting/Limitations
General Issues Monitoring Windows Remote Servers
HP SiteScope (11.23)
Page 501 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
The following is additional information relating to setting up and troubleshooting SiteScope
monitoring of remote Windows servers.
l
Connect to the remote machine using PERFMON. If a connection cannot be made using this
tool, there is probably a problem with the user access permissions granted to the SiteScope
account on the remote server. SiteScope requires certain administrative permissions to be able
to monitor server statistics.
l
If multiple Windows remote servers are configured for the same host machine using the
NetBIOS method, the connection fails. This is because Windows does not permit multiple
connections to a server or shared resource by the same user, using more than one user name
(System error 1219).
l
For security reasons, SiteScope may not be permitted to use the permissions of a full
administrator account. SiteScope can be granted restricted monitoring access by editing certain
Windows Registry Keys. For information about restricting access to the registry from a remote
machine, refer to the Microsoft Knowledge Base (http://support.microsoft.com/kb/q153183/).
l
When you need to monitor a server which is a standalone server or not part of a domain already
visible to the SiteScope server, try entering the machine name followed by a slash and then the
login name in the Login box. For example, loneserver\sitescope.
l
If you are unable to connect to Microsoft Windows Vista or Microsoft Windows 2008 remote
servers using the NetBIOS connection method, you can use the WMI connection instead.
l
To remotely monitor a Windows Server 2008 or 2012 machine, you must enable the Remote
Event Log Management exception in the Windows Firewall Settings on the remote server to
which you want to connect. Otherwise, when you try to use the session handle, the call will
result in a RPC_S_SERVER_UNAVAILABLE error.
Note:
n
For additional information on how to secure performance data in Windows operating
systems, refer to the Microsoft Knowledge Base
(http://support.microsoft.com/kb/q146906/).
n
For information about troubleshooting performance monitor counter problems, refer to the
Microsoft Knowledge Base (http://support.microsoft.com/kb/152513/).
Recommended Network Settings for Monitoring Windows Servers
When monitoring Windows-based servers, it is recommended to disable NetBIOS over TCP/IP on
networks where WINS in not enabled to avoid network-related errors such as "System error: 53 The network path was not found".
1. Open Network Connections.
2. Right-click the network connection you want to configure, and then click Properties.
3. On the General tab, click Internet Protocol (TCP/IP), and then click Properties.
HP SiteScope (11.23)
Page 502 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
4. Click Advanced, click the WINS tab, and then select the Disable NetBios over TCP/IP
option.
Understanding Error Codes When Testing Windows Remote Servers
Problem:
In the remote server test results, the status string does not contain descriptive error codes.
Resolution:
Use the net helpmsg command to help explain Windows network messages and provide problemsolving information.
Run the following command line:
net helpmsg <error code number>
For example, entering net helpmsg 53 returns "The network path was not found."
Microsoft Windows Event Log Access on Remote Windows Servers
Problem:
When viewing Remote Windows event logs or getting alerts relating to monitoring a remote
Windows machine, the following message is displayed:
"The description for Event ID ( XXXX ) in Source ( XXXX ) could not be found. It
contains the following insertion string(s):
The operation has completed successfully."
Cause:
If the required registry keys (and referenced files) are not present on the remote computer,
SiteScope is unable to format the data when viewing the event log on a computer from a remote
computer; hence it displays the data in a generic format.
Resolution:
The required registry entries and DLL files must be copied to the remote computer on which the
event viewer application is being run.
To get the remote registry entries and DLL files onto the local SiteScope machine:
1. Locate on the remote machine which event you are not getting properly in SiteScope by finding
the entry in the Event Viewer. Write down the information for the source, event id, and
description. For example:
Source: MSExchangeSA, Event ID: 5008, Description: The message tracking log f
ile C:\exchsrvr\tracking.log\20020723.log was deleted.
2. Open the registry setting HKEY_LOCAL_
MACHINE\System\CurrentControlSet\Services\EventLog
\Application and click the source (for example, MSExchangeSA).
3. Click EventMessageFile and write down the data for where that DLL is located (for example,
C:\EXCHSRVR\bin\madmsg.dll).
HP SiteScope (11.23)
Page 503 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
4. Locate the DLL on the remote and copy it to the SiteScope machine. You can perform the copy
in one of two ways:
n
Use the Initlog.exe utility, in the BackOffice Resource Kit, Second Edition, to copy the
required registry entries from the Exchange Server computer to the remote computer. This
utility can also copy the required DLL files if you are logged on to Windows with an account
that has Administrator privilege on the Exchange Server computer (see Microsoft Article
Q184719).
n
Use FTP, mail, and so forth, to get the file to your local drive.
5. SiteScope uses the data from the EventMessageFile field in step 3 to determine where to find
the DLL on the local machine. You must create the same folder structure as in this step and
place the file in that directory.
Alternatively, you can change the directory structure to say c:\Windows\System32 (SiteScope
looks in the ADMIN$ by default on the remote machine), and places the DLL in that folder, but
you must have this structure and the DLL on both machines. If you do this, you must update
the registry in step 3 to reflect the directory in which the DLL is located.
SiteScope Uses the Wrong Credentials for Remote Windows Connections
Using Perfex
Problem:
SiteScope ignores the credentials provided for specific remotes and tries to run monitoring
commands and actions for perfex-based monitors (such as CPU, Memory, and Windows monitors)
using credentials that are used to start the SiteScope service.
Resolution:
For perfex-based monitors to work correctly with remote servers, you must add optionalSetupConnection to the _perfexOptions= property in the <SiteScope root
directory>\groups\master.config file. Use a single space as a separator if other strings have
already been added to this property.
For example:
_perfexOptions=-wrmUiTimeout 300 -optionalSetupConnection
Viewing Data Returned when SiteScope is Trying to Access the Remote
Registry
Use the following steps to view that data is being returned when SiteScope is trying to access the
remote registry:
1. Open a command window on the SiteScope server.
2. Change the directory to <SiteScope root directory>\tools.
3. Enter the following in a command line:
HP SiteScope (11.23)
Page 504 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
perfex \\MACHINE -u username -p password -d -elast "Application"
This command gives you the number of entries in your Application log. For example:
4. List only the last 10 or 12 events to find the one you are looking for. For this example, the
command is:
perfex \\MACHINE -u username -p password -d -elog "Application" 2355 |
more
5. Look through each entry until you find the one you need. Note the Record id for easier
searching next time when using the command in Step 3.
6. This output tells you what data SiteScope is receiving. In the example given, the following is an
example of the data that typically would be returned:
Type: Information
Time: 02:00:24 08/01/102
Source: MSExchangeMTA
ID: 298
Category: 1
Record: 2342
Machine: EX-SRV
FILE=C:\EXCHSRVR\res\mtamsg.dll
REMOTE FILE=
String 835050d is: MTA
Next String 835054d is: OPERATOR
Next String 83505dd is: 34
Next String 835060d is: 0
Next String 835062d is:
File: C:\EXCHSRVR\res\mtamsg.dll
Remote Path:
calling FormatMessage()
Formatted Message 142 bytes long
HP SiteScope (11.23)
Page 505 of 1293
Using SiteScope
Chapter 42: Configure SiteScope to Monitor Remote Windows Servers
Raw message is: The most current routing information has been loaded by
the MTA, and a text copy was saved in the fileGWART0.MTA. [MTA OPERATOR
34 0] (12) Message: The most current routing information has been loaded
by the MTA, and a text copy was saved in the file GWART0.MTA.[MTA
OPERATOR 34 0] (12)
The file path is where the remote file is being found. If you copy the DLL to the
WINDOWS\SYSTEM, the file and remote file path like this:
Type: Information
Time: 03:15:00 08/01/102
Source: MSExchangeIS Public
ID: 1221
Category: 6
Record: 2350
Machine: EX-SRV
FILE=C:\WINNT\SYSTEM32\mdbmsg.dll
REMOTE FILE=\\ex-srv\ADMIN$\SYSTEM32\mdbmsg.dll
String 835054d is: 0
Next String 835056d is:
File: C:\WINNT\SYSTEM32\mdbmsg.dll
Remote Path: \\ex-srv\ADMIN$\SYSTEM32\mdbmsg.dll
LOADING LIB REMOTE: \\ex-srv\ADMIN$\SYSTEM32\mdbmsg.dllcalling
FormatMessage()Formatted Message 89 bytes long
Raw message is: The database has 0 megabytes of free spaceafter online
defragmentation has terminated.Message: The database has 0 megabytes of
free space afteronline defragmentation has terminated.
System Encoding Used When Displaying System Resources for Remote
Hosts Connected Through NETBIOS
This limitation affects all server monitors that use encoding of the remote host to display received
data.
SiteScope uses default system encoding when displaying system resources information for the
remote hosts connected through NETBIOS. The Remote server encoding field (available in the
remote server's Main Settings) is not used. For example, if system encoding is ASCII and remote
encoding is Unicode, the ASCII characters are displayed correctly and the Unicode symbols are
not supported.
WMI Issues
For tips and troubleshooting for WMI issues, see "Configure the WMI Service for Remote Windows
Monitoring" on page 507
HP SiteScope (11.23)
Page 506 of 1293
Chapter 43: Configure the WMI Service for
Remote Windows Monitoring
You can use SiteScope to monitor data on remote Windows servers using Windows Management
Instrumentation (WMI). WMI is a more secure communication method than NetBIOS for gathering
management data from remote servers running on Windows servers.
Using WMI, you can access system counter data from objects in the performance libraries. This is
the same performance data that appears in the Perfmon utility.
Learn About
Monitors Supporting WMI
The following is a list of the monitors that support the WMI method for collecting data.
l
Citrix Monitor
l
ColdFusion Server Monitor
l
CPU Monitor
l
Disk Space Monitor (Deprecated)
l
Dynamic Disk Space Monitor
l
Memory Monitor
l
Microsoft Lync Server 2010 Monitors (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 ASP Server Monitor
l
Microsoft Hyper-V Monitor
l
Microsoft IIS Server Monitor
l
Microsoft SQL Server Monitor
l
Microsoft Windows Event Log Monitor
l
Microsoft Windows Media Server Monitor
l
Microsoft Windows Resources Monitor
l
Microsoft Windows Services State Monitor
HP SiteScope (11.23)
Page 507 of 1293
Using SiteScope
Chapter 43: Configure the WMI Service for Remote Windows Monitoring
l
Real Media Server Monitor
l
Service Monitor
Tasks
How to Configure the WMI Service for Remote Monitoring
This task describes the steps involved in configuring SiteScope to monitor data on remote
Windows servers using WMI. For the list of monitors that support the WMI protocol, see "Monitors
Supporting WMI" on the previous page.
Note: This task is part of a higher-level task. For details, see "Configure SiteScope to Monitor
Remote Windows Servers" on page 490.
1. Prerequisites
SiteScope must be installed on a Windows machine.
2. Configure the WMI service on the remote server
The following are requirements for using SiteScope to collect performance measurements on a
remote machine using WMI:
n
The WMI service must be running on the remote machine. For details, refer to the Windows
Management Instrumentation documentation (http://msdn.microsoft.com/enus/library/aa826517(VS.85).aspx).
n
The user entered on the WMI remote server must have permissions to read statistics
remotely from WMI namespace root\CIMV2. For details, refer to
http://support.microsoft.com/kb/295292.
n
The monitoring user must be added to the Performance Monitor Users group on the target
server, and have DCOM remote launch and activation permissions (see
http://msdn.microsoft.com/en-us/library/Aa393266.aspx).
For information about troubleshooting WMI service problems, see "Tips/Troubleshooting" on
the next page.
3. Configure WMI preference settings in SiteScope - optional
You can configure the connection type for monitoring Windows server resources on the local
host machine and the WMI timeout settings in Preferences > General Preferences > WMI
Preferences. For user interface details, see "WMI Preferences" on page 593.
4. Configure a monitor
Add a WMI supported monitor, and configure the monitor settings.
HP SiteScope (11.23)
Page 508 of 1293
Using SiteScope
Chapter 43: Configure the WMI Service for Remote Windows Monitoring
Note: When configuring the WMI connection type method for monitoring Windows server
resources on the localhost machine (the machine where SiteScope is running), the User
name and Password must be left blank in the Credentials section.
Tips/Troubleshooting
WMI Limitations
It is not recommended to have more than 4000 monitors using WMI.
When a counter or object is shared between resources, SiteScope is unable to receive data for the
counters and the query fails. If other counters 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.
WMI Fails to Retrieve Counters
In some cases, WMI shows n/a for counters while perfmon gives the value 0 for the same counters.
This is the behavior for counters that are also not selectable using the perfmon utility. The reason
that perfex can get values for these counters is that it bypasses perfmon and accesses them
through the registry.
WMI Data Not Synchronized
WMI data relies on being synchronized with the Perfmon utility. If WMI data is not synchronized,
perform the following:
1. Check that the WMI service is started on the target machine. For details, refer to
http://msdn.microsoft.com/en-us/library/aa826517(VS.85).aspx.
2. Check that the namespace root\CIMV2 is configured to enable remote access to the user
specified in the SiteScope WMI remote server. For details, refer to
http://support.microsoft.com/kb/295292.
3. On the target machine, run the command perfmon and verify that the required perfmon objects
appear. For details, refer to http://msdn.microsoft.com/en-us/library/aa645516(VS.71).aspx.
For details on how to rebuild these libraries, refer to
http://support.microsoft.com/?kbid=300956.
4. On the target machine, run the command perfmon /wmi and verify that the required perfmon
objects appear. For details, refer to http://msdn.microsoft.com/en-us/library/aa645516
(VS.71).aspx.
If the required perfmon objects do not appear, run the command perfmon wmiadap /f. For
details, refer to http://msdn.microsoft.com/en-us/library/aa394528(VS.85).aspx.
HP SiteScope (11.23)
Page 509 of 1293
Chapter 44: Configure SiteScope to Monitor
Remote UNIX Servers
UNIX Remote server options are used to set up the connection properties, such as credentials and
protocols, so that SiteScope can monitor systems and services running in remote environments.
You can then create monitors to watch the resources and performance counters for that server.
Multiple monitors can use the same connection profile. You can also create multiple remote servers
for the same host machine.
Tip: You can use SiteScope UNIX operating system adapters to extend SiteScope to connect
to, and remotely monitor versions of UNIX that are not supported by default. For details, see
"Extend UNIX Monitoring Using Operating System Adapters" on page 519.
To access
Select the Remote Servers context. In the remote servers tree, click the UNIX Remote Servers
container.
Learn About
UNIX Remote Server Overview
SiteScope can monitor systems and services running on remote UNIX servers for certain statistics
(such as CPU, Disk Space, Memory, and Processes) without the installation of agent software on
each server. Select the servers to display when configuring UNIX monitors. SiteScope creates a
new remote connection profile for each server address in the list.
Tasks
How to Configure SiteScope to Monitor a Remote UNIX Server
This task describes the steps involved in configuring SiteScope to monitor data on remote UNIX
servers.
1. Enable SiteScope to monitor data on remote UNIX servers
n
Only an administrator in SiteScope, or a user granted Add, edit or delete remote servers
permissions can view or edit the Remote Servers page. For details on user permissions,
see "User Management Preferences" on page 726.
n
Monitoring remote UNIX server data requires authenticated access to the remote server. A
UNIX server connection profile provides the necessary address and login credentials for
SiteScope to log on to a remote server.
To log on to a remote server using the UNIX server connection profile, either:
HP SiteScope (11.23)
Page 510 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
o
Log on to the remote server as a user with administrator privileges, or
o
Create or modify a user account on the remote server that corresponds with the
connection method and login permissions used in the SiteScope connection profile for
that server.
You need to define an individual remote UNIX server connection profile for each remote
UNIX server you want SiteScope to monitor, .
2. Configure and test the settings for the UNIX remote server
a. Configure the remote UNIX server in the remote server tree.
b. Test the settings for the applicable server.
o
Click the Test
button to test the connection to the server.
o
Click the Detailed Test
button to test the running commands on the remote host
and check the permissions for the defined user.
3. Results
The server is added to the list of UNIX Remote Servers in the remote server tree. You can then
create monitors to watch the resources and performance counters for that server. Multiple
monitors can use the same connection profile.
Note: For information about troubleshooting and limitations of SiteScope monitoring of
remote servers, see "Tips/Troubleshooting" on page 518.
HP SiteScope (11.23)
Page 511 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
UI Descriptions
New/Edit UNIX Remote Server Dialog Box
Important
information
See also
l
You cannot delete a remote server from the list of remote servers if the server
is referenced by a monitor. Select a different server in the Server box of the
Monitor Settings panel for each monitor that references the remote server, and
then delete the remote server from the remote server list.
l
The HTTP method for connecting to a remote server is no longer supported.
l
Remote server passwords support empty spaces and the following special
characters: \ " & | > < ^
l
When configuring a remote server in template mode, the Method and
Operating system values must be entered using the same case that is
displayed below, otherwise verification does not work properly:
n
Method. telnet, http, rlogin, or ssh
n
Operating System. AIX, CentOSLinux, FreeBSD, HP, HP-UX, HP64,
Linux, MacOSX, OPENSERVER, RHESLinux, SCO, SGI, Sun, SunOS,
Tru64, Tru64_4.x, UbuntuLinux.
l
"Remote Server Tree" on page 55
l
"Remote Servers Properties Page" on page 554
The following elements are included:
UI Element
Description
Save
Saves the settings without verifying the correctness of the configuration on the
remote server.
Tip: Performance is faster if you use Save instead of Save & Test, because
SiteScope does not need to establish a connection to the remote server to
verify the settings.
Save & Test
Saves the settings and verifies the correctness of the configuration on the
remote server. If SiteScope fails to connect to the remote server, or if there is
an invalid property in the configuration settings, an error message is displayed.
Tip: Performance is slower if you use Save & Test instead of Save, because
SiteScope needs to establish a connection to the remote server to verify the
settings.
General Settings
HP SiteScope (11.23)
Page 512 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
UI Element
Description
Name
Name by which the remote machine should be known in SiteScope. This name
appears in the Server list of monitors that can use this connection profile.
Description
Description for the remote UNIX server. This text appears only when editing
the remote's properties.
Main Settings
Server
Real IP address or host name of the monitored server. Network address
translation (NAT) is not supported for SiteScope monitors that require a remote
host definition. SiteScope is unable to determine if an external (real IP) or
internal IP (NAT) is used when you configure a monitor with an IP address or
host. To monitor servers in a NAT environment, we recommend placing
SiteScope inside the firewall. Virtual IPs can be used in monitors which do not
collect host specific information, such as in the URL monitor or other similar
monitors.
To use the same login credentials to configure multiple servers at the same
time, enter the server names or addresses separated by a comma (","),
semicolon (";"), or a space.
Example: If using NetBIOS to connect to other servers, enter a commaseparated string of server addresses such as:
serveraddress1,serveraddress2,serveraddress3
When completing the other required entries on the form, SiteScope creates a
new remote connection profile for each server address in the list.
Note: To test connectivity after the host is added, click the Test
button in
the table listing the UNIX Servers. This tests only the connection to the server.
Click the Detailed Test
button to run a test that displays the result of
running commands on the remote host. This enables checking the permissions
for the defined user.
Note when working in template mode: Enter the name of a template
variable that represents the remote server name, for example, %%host%%. Each
time you enter a server name for the variable, a monitor instance is created for
that server and the server is added to the remote server tree.
If the remote servers onto which you want to deploy monitor templates already
exist under Remote Servers, you can reference these servers within the
monitor template. You do this by referencing the system variable $$SERVER_
LIST$$ which identifies the servers accessible to the SiteScope. For details,
see "Variable Syntax" on page 779.
HP SiteScope (11.23)
Page 513 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
UI Element
Description
Credentials
Option for providing the user name and password for the remote UNIX server:
Use user name and password. Select this option to manually enter user
credentials.
l
l
Trace
n
User name. Enter the user name for the remote server or use a template
variable that represents the user login name (for example, %%user%%).
n
Password. Enter the password for the remote server or the passphrase for
the SSH key file, or use a template variable that represents the password
(for example, %%password%%). When using SSH authentication with
public/private key based authentication enter the passphrase for the
identity file here.
Select predefined credentials. Select this option to have SiteScope
automatically supply a predefined user name and password for the server
(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
"Credential Preferences" on page 572.
Traces messages to and from the remote server in the RunMonitor.log file.
Default value: Not selected
Operating
system
Operating system that is running on a remote server. This is required so that
the correct information can be obtained from that server. Select an operating
system from the list.
The following operating systems are supported when defining UNIX remote
servers: AIX, CentOS, FreeBSD, HP-UX, HP/UX, HP/UX64-bit, Linux,
MacOSX, NonStopOS, OPENSERVER, Red Hat Enterprise Linux, SCO, SGI
Irix, Solaris Zones, Sun Solaris, SunOS, Tru64 5.x,Tru64 Pre 4.x (Digital), and
Ubuntu. For servers running versions of UNIX which are not included in the list,
see "Extend UNIX Monitoring Using Operating System Adapters" on page 519.
HP SiteScope (11.23)
Page 514 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
UI Element
Description
Method
Connection types for monitoring UNIX server resources:
l
Rlogin. Logs in to the remote server using the Rlogin protocol. You can set
up your remote servers to require a password for rlogin, or to enable access
without a password (like "rsh"). SiteScope supports either case.
l
SSH. Logs in to the remote server using Secure Shell, a more secured
communication protocol. This may require additional software and setup
depending on the version of UNIX.
For Solaris, using the SSH access method requires that an SSH client is
installed on the SiteScope machine and the SSH server installed on the
servers you are monitoring. The path to the SSH client on the machine where
SiteScope is running should be /usr/local/bin/ssh or /usr/bin/ssh. For
information about SSH requirements, see "SiteScope Monitoring Using
Secure Shell (SSH)" on page 531.
Using SSH requires that digital certificates be installed on each of the servers
to which you are connecting.
l
Telnet. Logs in to the remote server using Telnet. Telnet is a popular
method for connecting to remote UNIX servers. You can set up your remote
servers to require a password for telnet, or to enable access without a
password (like "rsh"). SiteScope handles either case.
Prompt
Prompt output when the remote system is ready to handle a command.
Login prompt
Prompt output when the system is waiting for the login to be entered.
Password
prompt
Prompt output when the system is waiting for the password to be entered.
Secondary
prompt
Secondary prompts if the telnet connection to the remote server causes the
remote server to prompt for more information about the connection. Separate
multiple prompt string by commas (,).
Example: For Telnet connections to some remote servers, the remote server
may ask what terminal type should be emulated for the connection. In this
case, enter Terminal type? as the secondary prompt. The response to the
secondary prompt is entered in the Secondary Response box below.
Mask
secondary
response
Hides the secondary response behind asterisks. If you subsequently clear the
check box, the hidden data is deleted.
Secondary
response
Responses to any secondary prompts required to establish connections with
this remote server. Separate multiple responses with commas (,).
HP SiteScope (11.23)
Default value: Not selected
Page 515 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
UI Element
Description
Initialize shell
environment
Shell commands to be run at the beginning of the session. Separate multiple
commands with a semicolon (;). This option specifies shell commands to be
run on the remote machine directly after a Telnet or SSH session has been
initiated. These commands can be used to customize the shell for each
SiteScope remote. Some examples include:
l
The remote shell may not have the correct path set for SiteScope scripts to
run. The following command adds the directory /usr/local/bin into the
PATH of the current shell on the remote machine: export
PATH=$PATH:/usr/local/sbin
l
The remote shell may not be initializing the pseudo terminal correctly. Enter
the following command to increase the terminal width to 1024 characters:
stty cols 1024;${SHELL}
Note: Commands after a shell invocation are not run.
Remote
server
encoding
l
There have been cases where the remote Telnet Server does not echo back
the command line properly. This may cause strange behavior for monitors
that rely on this behavior. Enter the following command to force the remote
terminal to echo: stty echo
l
Certain UNIX shells have been known to behave erratically with SiteScope.
This includes bash, ksh, and csh. Enter the following command to change
the shell to sh for the SiteScope connection: /bin/sh
Encoding for the remote server if the remote server is running an operating
system version that uses a different character encoding than the server on
which SiteScope is running. This enables SiteScope to display encoded
content correctly.
Default value: Cp1252 encoding
HP NonStop Shell Settings
Shell choice
prompt
(For NonStopOS only) Prompt output when the system is waiting for the shell
to be selected.
Default value: >
Shell name
(For NonStopOS only) Shell name to be executed.
Default value: OSS
Advanced Settings
SSH port
number
HP SiteScope (11.23)
Port on which the remote SSH server is listening.
Default value: 22
Page 516 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
UI Element
Description
Connection
limit
Number of open connections that SiteScope permits for this remote. If there
are many monitors configured to use this connection, set the number of open
connections high enough to relieve a potential bottleneck.
Default value: 3
Note: This setting does not effect running tests for a remote server. Tests
always create a new connection.
SSH
Authentication method used for SSH connections:
authentication
l Password. Authenticates using a password (default setting).
method
l
Key File. Authenticates using public/private key authentication. When this
option is selected, SiteScope uses the private key in the file
<SiteScope root directory>\groups\identity to authenticate. The
corresponding public key must be listed in the authorized_keys file on the
remote host. For information about SSH requirements, see "SiteScope
Monitoring Using Secure Shell (SSH)" on page 531.
Disable
connection
caching
Turns off connection caching for this remote. By default, SiteScope caches
open connections.
Key file for
SSH
connections
Path and name of the file that contains the private key for this connection. The
default key file is <SiteScope root directory>\groups\identity. This setting
applies only when the authentication method is Key File.
SSH version
2 only
Forces SiteScope to use SSH protocol version 2 only.
SSK keep
alive
mechanism
Engages a keep alive mechanism for SSH version 2 sessions. This option
applies only when using the integrated Java Client. SSH keepalive packets are
sent every 55 seconds.
Default value: Not selected
Default value: Not selected
Default value: Not selected
Search/Filter Tags
<Tag name
and values>
Keyword tags are used to search and filter SiteScope objects (groups,
monitors, remote servers, templates, and preference profiles). If no tags have
been created for the , this section appears but is empty. If tags have been
created, they are listed here and you can select them as required.SiteScope
For concept details, see "Search SiteScope Objects" on page 88.
Add Tag
Opens the New Tag dialog box, enabling you to add new keyword tags. For
user interface details, see "New/Edit Tag Dialog Box" on page 93.
"Remote Servers Properties Page" on page 554
HP SiteScope (11.23)
Page 517 of 1293
Using SiteScope
Chapter 44: Configure SiteScope to Monitor Remote UNIX Servers
Tips/Troubleshooting
Remote UNIX Servers Not Configured for an English Locale
Problem:
The File monitor and Directory monitor may fail when using UNIX remote servers that are not
configured by default for an English locale or language.
Resolution:
Add "LANG=C; export LANG" to the Initialize shell environment property of the problematic
UNIX remote server.
HP SiteScope (11.23)
Page 518 of 1293
Chapter 45: Extend UNIX Monitoring Using
Operating System Adapters
You can use SiteScope UNIX operating system adapters to extend SiteScope to connect to, and
remotely monitor other UNIX platforms, in addition to those supported by default. This is done by
configuring an adapter file to support the particular UNIX platform you want to monitor.
SiteScope uses adapter files to describe the commands that are needed to retrieve a variety of
system resource information from servers running different platforms of the UNIX operating
system. These adapter files are written in plain text and are stored in the <SiteScope
root directory>/templates.os directory. For a list of the default UNIX adapters that are provided
with SiteScope, see "UNIX Adapters Provided with SiteScope" below.
You can modify existing adapter files to adjust for specific system requirements in your
environment, or you can create your own adapter files.
Learn About
UNIX Adapters Provided with SiteScope
The default UNIX adapters that are provided with SiteScope, include:
Filename
Description
AIX.config
Adapter file for IBM AIX
CentOS.config
Adapter file for CentOS Linux
Digital.config
Adapter file for Digital Tru64 UNIX (Pre 4.x)
FreeBSD.config
Adapter file for FreeBSD 3.x
HP.config / HP-UX.config
Adapter file for Hewlett-Packard HP/UX
HP64.config
Adapter file for Hewlett-Packard HP/UX 64-bit
ILO.config
Adapter file for Hewlett-Packard Integrated Lights-Out
Linux.config
Adapter file for Linux (Red Hat and others)
MacOSX.config
Adapter file for Apple MacIntosh OS X
NonStopOS.config
Adapter file for Hewlett-Packard NonStop Operating System
OPENSERVER.config
Adapter file for SCO OpenServer
RedHatEnterpriseLinux.config
Adapter file for Red Hat ES Linux
SCO.config
Adapter file for SCO UNIXWare
HP SiteScope (11.23)
Page 519 of 1293
Using SiteScope
Chapter 45: Extend UNIX Monitoring Using Operating System Adapters
Filename
Description
SGI.config
Adapter file for Silicon Graphics Irix
Sun.config / SunOS.config
Adapter file for Sun Microsystems Solaris
Tru64.config
Adapter file for Compaq Tru64 UNIX 5.x
Ubuntu.config
Adapter file for Ubuntu Linux
Adapter File Format
Each UNIX platform supported for remote monitoring by SiteScope has an adapter file in the
<SiteScope root directory>/templates.os directory. These files use SiteScope's standard setting
file format.
The first group of settings (those settings before the first # sign line) describe the platform:
id=yourPlatform
name=your Platform Name
The id is theSiteScope internal ID for the OS. This ID must be unique, contain no spaces, and can
be alphanumeric.
Tip: We recommend that you use the name of the adapter file as the ID name. For example, if
the name of your adapter file is linux.config, your ID would be linux.
The name is the name you want displayed in the Operating system drop-down list when adding or
editing remote servers.
The rest of the template file contains groups of settings representing a single command, separated
by a line of # characters. For example, the following settings represent the disk space command:
id=disks
command=/usr/bin/df -k
mount=6
name=1
where:
id=disks is the id that SiteScope uses to look up a command. This must be one of the set of
SiteScope commands (see "Adapter Command List" on the next page). This entry is case
sensitive.
For example:
command=/usr/bin/df -k means that the usr/bin/df -k command is run to get the information
about the disks.
mount=6 and name=1 mean that the mount name is in column 6 and the name of the mount or file
system is in column 1. The data names vary from command to command and are documented
below.
Applying the above for the following command output:
HP SiteScope (11.23)
Page 520 of 1293
Using SiteScope
Chapter 45: Extend UNIX Monitoring Using Operating System Adapters
Filesystem kbytes used avail capacity Mounted on /proc 0 0 0 0%/proc /dev/dsk/c0
t3d0s0 73049 42404 23341 65% /
where the disks command automatically skips lines not starting with (/dev) reads column 1
(/dev/dsk/c0t3d0s0) as the name of the file system, and column 6 ("/") as the mount name.
Adapter Command List
SiteScope requires settings for each the following commands to operate properly. Each command
description requires an ID and a command, one or more fields to specify where the data is being
read from, and optionally a set of modifiers that are used to filter the output of the command to
eliminate certain sets of lines (such as header lines).
Where the variable column is used below, it means the number of the column in which the data
appears, where columns are space delimited sets of data.
In addition, there are certain fields that can be optionally applied to any command description. For
details, see "Optional Adapter Command Details" on page 523.
This section includes:
l
"Disk Listing" below
l
"Disk Information" on the next page
l
"Memory" on the next page
l
"Page Faults" on the next page
l
"CPU Usage" on page 523
l
"Process List" on page 523
l
"Process List with Details" on page 523
l
"Log File Processing" on page 523
l
"Optional Adapter Command Details" on page 523
Disk Listing
ID
Description
Used
by
disks
Returns a list of the file systems on the system. The
/usr/bin/df -k command is the standard way to get this
data. Lines returned that do not start with /dev are
automatically skipped.
Disk
name. The
Space column of the
Monitor name of the file
system.
Fields
mount. The
column of the
name of the
mount.
HP SiteScope (11.23)
Page 521 of 1293
Using SiteScope
Chapter 45: Extend UNIX Monitoring Using Operating System Adapters
Disk Information
ID
Description
Used by
Fields
disk
Takes a disk as an argument and returns
the total, free, and percent used for the
disk.
Disk
Space
Monitor
total. The column of the total
kilobytes capacity of the file
system.
free. The column of the free
kilobytes of the file system.
Memory
ID
Description
Used
by
Fields
memory
The amount of swap
space used and available.
Memory
Monitor
swapUnit. The multiplier applied to used, free,
or total swap space to give bytes.
used. The amount of swap space used.
free. The amount of swap space free.
total. The amount of total swap space.
Note: Only two of used, free, and total fields
need to read. The other is computed.
Page Faults
ID
Description
Used
by
pageFault The number of page Memory
faults/sec. If multiple Monitor
page faults lines are
matched, they are
added up.
Fields
pageFaults. The column of the number of page
faults.
inPageFaults. The column of the number of page
in faults.
outPageFaults. The column of the number of
page out faults.
units. pages (default), pages/sec, or k/sec
units for the paging data.
pageSize. If units are k/sec, the pageSize is
used to compute the number of pages. Otherwise
it is ignored.
Note: Either use pageFaults, if there is a single
column of data, or inPageFaults and
outPageFaults, if there are two columns of page
fault data. inPageFaults and outPageFaults are
added together to get the total page faults.
HP SiteScope (11.23)
Page 522 of 1293
Using SiteScope
Chapter 45: Extend UNIX Monitoring Using Operating System Adapters
CPU Usage
ID
Description
cpu Returns the wait and idle % of the
CPU.
Used by
Fields
CPU
Monitor
idle. The idle % for the CPU.
wait. The wait % for the CPU
(optional).
Process List
ID
Description
Used
by
Fields
process
A list of processes with long process names.
Typically this is /usr/bin/ps -ef
Service
Monitor
name. The column of the
names of the processes.
Process List with Details
ID
Description
processDetail A list of processes with size
of the process. Typically this
is /usr/bin/ps -el
Used by
Fields
Service Monitor
(with Check
Memory option
enabled)
name. The column of the
names of the processes
size. The column of the
size of the processes.
pageSize. Page size on
the system (optional).
The default is 8192.
Log File Processing
ID
Description
Used by
Fields
fileExists
Checks that the log file exists.
Log File monitor
(on Windows or
Linux)
match. The text to match
in the log entries.
filesize
Returns the file size to ascertain if the
file changed.
Log File monitor
(on Windows or
Linux)
size. The number in the
size column in the
command output.
tail
Reads the file content for local file
processing (not supported for serverside processing).
Log File monitor
(on Windows or
Linux)
match
Performs server-side processing with
perl or awk.
Log File Monitor
(on Linux)
Optional Adapter Command Details
The following fields can optionally be applied to any command description:
HP SiteScope (11.23)
Page 523 of 1293
Using SiteScope
Chapter 45: Extend UNIX Monitoring Using Operating System Adapters
Process List with Details
ID
Description
startLine
The line number where the command starts looking for data.
endLine
The line number where the command ends looking for data.
skipLine
The pattern that if matched, skips the line.
matchLine
The pattern that if matched, looks for data in that line.
startMatch
The pattern that if matched, starts the command looking for data.
endMatch
The pattern that if matched, ends the command looking for data.
reverseLines
If true, the command output lines are reversed and read back to front. This is
useful if there is data at the end of the command and it is too difficult to work out
when to start reading.
If a field name has the format, fieldnameColumnName=COLUMN, the adapter searches the headers
(first line) for COLUMN and records the columns containing the data, and then use those settings to
read the fieldname field. This is useful where the width of the columns varies, and the data has
spaces in it.
For example, to read the my data information from the following command output:
MEM NAME DESC12K my data some of my data
you would specify the name field in the command description as:
nameColumnName=NAME
The adapter reads the header line, finds NAME, and records where the previous column ends (MEM in
this case) and where the specified column ends (NAME), and uses that to read, in this case, the text
in character columns 6 through 22.
To see an example of the ColumnName reading in action, look at the process and processDetail
commands for the supported UNIX platforms. They use this method to get the process name and
the size of the process.
Tasks
How to Add an Adapter
This task describes the steps involved in adding an adapter to specific versions of UNIX.
1. If the UNIX platform to which you want to add support is similar to one of the default
SiteScope-supported UNIX platforms, make a copy of the adapter file for that UNIX platform
and use that as a starting point for your adapter.
2. Modify the adapter file to match the command line requirements for the UNIX platform to which
you want SiteScope to connect.
HP SiteScope (11.23)
Page 524 of 1293
Using SiteScope
Chapter 45: Extend UNIX Monitoring Using Operating System Adapters
3. Save your adapter file to the <SiteScope root directory>/templates.os directory. The
filename must use the .config extension.
4. Restart the SiteScope service.
5. Open the installation SiteScope to which you have added the new adapter file.
6. In the left pane, click Remote Servers to display the remote servers view.
7. In the remote servers tree, right-click UNIX Remote Servers, and select New UNIX Remote
Server. The New UNIX Remote Server dialog box opens.
8. In the Operating system box, select the name of the UNIX adapter that you have created.
9. Click OK. SiteScope uses the new adapter file to try and retrieve that applicable data from the
remote server.
10. If you make changes to the adapter file after you have configured one or more server
connection profiles to use the adapter, you can use the Detailed Test option in the UNIX
Remote Servers to test your adapter. After adding the remote server, the Detailed Test
displays the output of the command that SiteScope is running remotely, along with
SiteScope's parsing of the output.
The amount of work required to modify a particular template depends on how different the new
UNIX platform is from the supported UNIX platforms.
HP SiteScope (11.23)
Page 525 of 1293
Chapter 46: Enable SiteScope to Prefer IP
Version 6 Addresses
Internet Protocol version 6 (IPv6) is a new version of the Internet Protocol for the Network layer of
the Internet. IPv6 is designed to solve many of the problems of IPv4 such as address depletion,
security, auto-configuration, and extensibility.
By default, SiteScope connects to remote servers using IPv4 addresses. If you want your
environment to resolve host names to IPv6, you need to enable SiteScope to prefer IPv6 addresses
over IPv4 when connecting to remote servers.
Learn About
Resolving Host Names to IPv6 Overview
The level of support for IPv6 depends on the operating system on which SiteScope is installed.
Windows Server 2008 has full-featured support for IPv6, which is installed and enabled by default.
As a result, IPv6 is supported by most SiteScope monitors when SiteScope is installed on
Windows Server 2008 or later versions. Support for IPv6 on Windows Server 2003 is limited, as
many core services and networking components do not support it. IPv6 is also fully supported when
SiteScope is installed on UNIX operating systems that provide full support for IPv6.
By default, SiteScope connects to remote servers using IPv4 addresses. 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. When this option is selected, the following must occur
for the IPv6 over IPv4 preference to take effect:
l
A host name must be specified for the remote server. If an IP address is specified, the prefer
IPv6 setting has no effect on the host since the IP address determines the IP version that is
used.
l
The host name resolves to both an IPv4 and an IPv6 address. If the host name resolves only to
an IPv4 address, then the IPv4 address is used.
Note:
n
If a host name is specified and the host name resolves to both an IPv4 and an IPv6
address, but the monitor does not support IPv6, the monitor will not work. For details on
how to resolve this issue, see "Working in a Mixed IPv4 and IPv6 Environment" on the
next page. For the list of monitors supporting IPv6, see "Monitors Supporting IP Version
6 Addresses" on page 528.
n
When specifying a literal IPv6 address as the name for the remote monitored server
when using the NetBIOS connection method, the IPv6 address must be customized by:
1. Replacing any colon (":") characters with a dash ("-") character.
2. Appending the text .ipv6-literal.net to the IP address.
HP SiteScope (11.23)
Page 526 of 1293
Using SiteScope
Chapter 46: Enable SiteScope to Prefer IP Version 6 Addresses
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 (where supported), and
avoid having to make changes to the IPv6 address.
Working in a Mixed IPv4 and IPv6 Environment
When working in a mixed environment where both IPv4 and IPv6 are used, the DNS server might
return both an IPv4 and an IPv6 address for a host name. To instruct SiteScope which IP address
to use for each resolved host name, you can:
Select the Prefer IP version 6 addresses option, and perform one of the following (for the
hosts that you want to use the IPv4 protocol):
l
n
Enter the IP address instead of the host name for the specified remote server.
n
Configure the DNS server so that the host name resolves to the IP address that you want to
use for the remote server. You can do this by removing the IPv6 address from the DNS server
for the specified host.
Clear the Prefer IP version 6 addresses option, and perform the following (for the hosts that
you want to use the IPv6 protocol):
l
n
Enter the IP address instead of the host name for the specified remote servers.
n
Configure the DNS server so that the host name resolves to the IP address that you want to
use for the specified remote servers. You can do this by removing the IPv4 address from the
DNS server for the specified hosts.
Supported Protocols
The following protocols are supported when IPv6 is used in SiteScopes installed on Windows and
UNIX platforms:
Target
SiteScope Installed on
Windows Platform
SiteScope Installed on UNIX
Platform
Windows
NetBios
SSH
WMI
UNIX
Not supported
SSH
Note:
l
SiteScope installed on Windows platforms can monitor Windows machines only.
l
NetBIOS and WMI are supported when SiteScope is installed on Windows platforms only .
HP SiteScope (11.23)
Page 527 of 1293
Using SiteScope
Chapter 46: Enable SiteScope to Prefer IP Version 6 Addresses
l
SSH is supported only when SiteScope is installed on UNIX machines. For the list of
Windows-based monitors that are supported in SiteScopes running on UNIX using SSH,
see "Monitors Supporting Windows SSH (Agentless or Using the SiteScope Remote
Windows SSH Files)" on page 545.
Monitors Supporting IP Version 6 Addresses
The following lists the monitors that support IPv6. A check mark indicates that the monitor requires
additional IPv6 address customization in SiteScope.
Monitors Supporting IPv6 Addresses
Additional
Configuration
Required
Cisco Works Monitor
Citrix Monitor
a
ColdFusion Server Monitor
a
CPU Monitor
a
Custom Database Monitor
Database Counter Monitor
Database Query Monitor
DB2 JDBC Monitor
Disk Space Monitor (Deprecated)
Dynamic Disk Space Monitor
F5 Big-IP Monitor
HAProxy Monitor
a
Log File Monitor
a
Memcached Statistics Monitor
Memory Monitor
a
Microsoft ASP Server Monitor
a
Microsoft Hyper-V Monitor
Microsoft IIS Server Monitor
HP SiteScope (11.23)
a
Page 528 of 1293
Using SiteScope
Chapter 46: Enable SiteScope to Prefer IP Version 6 Addresses
Monitors Supporting IPv6 Addresses
Additional
Configuration
Required
Microsoft Lync Server 2010 Monitors (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)
a
Microsoft SQL Server Monitor
a
Microsoft Windows Event Log Monitor
a
Microsoft Windows Media Server Monitor
a
Microsoft Windows Resources Monitor
a
Microsoft Windows Services State Monitor
a
Network Bandwidth Monitor
Oracle Database Monitor
Ping Monitor
Port Monitor
Real Media Server Monitor
a
Service Monitor
a
SNMP Monitor
SNMP by MIB Monitor
SNMP Trap Monitor
Technology SNMP Trap Integration Monitor
UNIX Resources Monitor
URL Monitor
a
URL Content Monitor
a
URL List Monitor
a
URL Sequence Monitor
a
Web Service Monitor
a
HP SiteScope (11.23)
Page 529 of 1293
Using SiteScope
Chapter 46: Enable SiteScope to Prefer IP Version 6 Addresses
Tasks
How to Enable SiteScope to Prefer IP Version 6 Addresses
This task describes how to enable SiteScope to prefer IPv6 addresses over IPv4 when connecting
to remote servers.
1. Enable SiteScope to prefer IPv6 addresses
In Preferences > Infrastructure Preferences > Server Settings, select Prefer IP version 6
addresses.
For user interface details, see "Server Settings" on page 626.
Note:
n
You must restart SiteScope before changes to this setting can take effect.
n
If a host name is specified and the host name resolves to both an IPv4 and an IPv6
address, but the monitor does not support IPv6, the monitor will not work. For details on
how to resolve this, see "Working in a Mixed IPv4 and IPv6 Environment" on page 527.
2. Customize IPv6 address as the name for the remote monitored server (for specific monitors
only)
Some monitors have additional customization requirements or limitations when using IPv6
addressing.
For monitors that require additional IPv6 address customization, see "Monitors Supporting IP
Version 6 Addresses" on page 528.
HP SiteScope (11.23)
Page 530 of 1293
Chapter 47: SiteScope Monitoring Using Secure
Shell (SSH)
SiteScope supports a number of security capabilities. One of these is support for remote server
monitoring using Secure Shell (SSH) connections. You can use SSH to connect to a server and
automatically send a command, so that the server runs that command and then disconnects. This
is useful for creating automated processing and scripting.
Secure Shell (SSH), sometimes known as Secure Socket Shell, is a UNIX-based command
interface and protocol for securely accessing a remote computer. It is widely used by network
administrators to remotely control Web and other kinds of servers. SSH commands are encrypted
and secure in several ways. Both ends of the client/server connection are authenticated using a
digital certificate, and passwords are protected by encryption. Secure Shell client machines make
requests of SSH daemons or servers on remote machines.
Monitoring with SiteScope over SSH has the following basic requirements:
1. The servers that you want to have monitored by SiteScope using SSH must have an SSH
daemon (or server) installed and active.
2. The SiteScope server has an integrated Java SSH client. SiteScope includes an SSH client
written in Java and native to the SiteScope application code.
Note: MindTerm is the only connection client available for SSH connections.
This section also includes:
l
"SSH Connectivity Options" below
l
"Guidelines" on page 533
SSH Connectivity Options
The following tables outline the SSH connectivity options currently supported with SiteScope. For
important information about configuring and managing SSH connectivity, see "Guidelines" on page
533.
HP SiteScope (11.23)
Page 531 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
SiteScope Installed on Windows Platform:
Target
Windows
UNIX/
Linux
SiteScope Relevant
Client
Target
Options
Servers
SiteScope
integrated
Java SSH
Client
SiteScope
integrated
Java SSH
Client
Comments
SSH
server
(Cygwin
OpenSSH)
l
Agentless SSH. The RemoteNTSSH package is not
required for monitors that support agentless SSH. For a
list of agentless SSH supported monitors, see
"Monitors Supporting Windows SSH (Agentless or
Using the SiteScope Remote Windows SSH Files)" on
page 545.
l
SSH using the SiteScope remote Windows SSH files.
The RemoteNTSSH package should be installed under
the home user directory on the remote server. For
details, see "Install SiteScope Remote Windows SSH
Files" on page 543.
SSH host
daemon
(sshd either
proprietary
or
OpenSSH)
SiteScope Installed on UNIX or Linux Platform:
Target
SiteScope Client
Options
Windows
l
SiteScope
integrated Java
SSH Client
l
SSH client
(/usr/local/bin/ssh
or usr/bin/ssh)
HP SiteScope (11.23)
Relevant
Target
Servers
SSH
server
(Cygwin
OpenSSH)
Comments
l
Agentless SSH. The RemoteNTSSH
package is not required for monitors that
support agentless SSH. For a list of
agentless SSH supported monitors, see
"Monitors Supporting Windows SSH
(Agentless or Using the SiteScope Remote
Windows SSH Files)" on page 545.
l
SSH using the SiteScope remote Windows
SSH files. The RemoteNTSSH package
should be installed under the home user
directory on the remote server. For details,
see "Install SiteScope Remote Windows
SSH Files" on page 543.
Page 532 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
Target
UNIX/
Linux
SiteScope Client
Options
l
l
Relevant
Target
Servers
Comments
SiteScope
integrated Java
SSH Client
SSH host
daemon
(sshd either
SSH client
proprietary
(/usr/local/bin/ssh or
or usr/bin/ssh)
OpenSSH)
Guidelines
l
There are two different versions of the SSH protocol: version 1 and version 2. Version 1 and
version 2 are different protocols and are not compatible with each other. This means that the
SSH clients and SSH hosts must be configured to use the same protocol version between them
to communicate. In many cases, SSH version 1 (SSH1) is the default version used. Some
security vulnerabilities have been found in SSH version 1. Also, the SSH1 protocol is not being
developed anymore and SSH2 is considered the current standard.
Tip: We recommend using SSH version 2 (SSH2) for all SSH connections.
l
The release version number of the SSH utilities and libraries you have installed must not be
confused with the version of the SSH protocol that you want to be using. For example,
OpenSSH release 3.5 supports both SSH1 and SSH2 protocols. The release version 3.5 does
not mean that the libraries use an SSH version 3.5 protocol. You must configure the OpenSSH
software to use either SSH1 or SSH2.
l
If you have set up SiteScope remote monitoring using SSH connections and then make
configuration changes or upgrades to the SSH daemon or server software deployed on remote
servers in the environment, it may be necessary to reconfigure the SSH connectivity between
the machine on which SiteScope is running and the remote servers that are being monitored.
Monitor Remote Windows Servers Using SSH
NetBIOS is the default remote connection method used by SiteScope for Windows-to-Windows
connectivity and monitoring in Windows networks . While this provides easier connectivity, it does
have several disadvantages; it is relatively vulnerable in terms of network security, and it does not
support remote execution scripts. Running commands on remote servers requires that scripts be
run locally, with commands to the remote machine being written using the UNC syntax of remote
servers. Even then, some parameters are not returned from the remote server by using NetBIOS.
Note: SiteScope also supports the Windows Management Instrumentation (WMI) protocol
which is a more secured communication protocol than NetBIOS for gathering data from remote
servers running on Windows servers. For details on configuring the WMI service on the remote
HP SiteScope (11.23)
Page 533 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
machine, see "Configure the WMI Service for Remote Windows Monitoring" on page 507.
SiteScope supports monitoring of remote Windows servers using SSH. This technology has been
tested with the OpenSSH binaries from Cygwin (available at http://www.cygwin.com/) installed as
the SSH server on the remote server. It has also been tested with the server available from FSecure. You can also try OpenSSH for Windows (formerly Network Simplicity "OpenSSH on
Windows") which is available on SourceForge (available at http://sshwindows.sourceforge.net/).
The following is a comparison overview of two of the packages.
OpenSSH
Package
Advantages
Disadvantage
Cygwin
OpenSSH
1. Provides access to either Windows or UNIXstyle scripting on a Windows machine.
Complicated setup procedure.
2. Provides access to UNIX-style system tools
and utilities.
3. SiteScope can access the remote server both
as a Windows Remote and /or a UNIX Remote.
OpenSSH
for
Windows
Simple setup procedure.
Only provides access to
Windows commands, scripts,
and utilities.
Note:
l
OpenSSH for Windows and the Cygwin SSH implementations are incompatible with each
other. They should not be installed on the same machine.
l
If there is more than one version of the Cygwin utilities or more than one SSH server
installed on a machine, there may be conflicts that prevent the SSH connections from
working. An error message such as "could not find entry point" is an indication of this kind of
conflict. If you suspect this error, search the machine for multiple copies of cygwin1.dll. It
may be necessary to remove all versions of the utilities and then reinstall only a single
installation to resolve this problem.
For details on configuring remote Windows servers for SSH monitoring, see "How to Configure
Remote Windows Servers for SSH monitoring" on the next page.
How to Configure Remote UNIX Servers for SSH
monitoring
SiteScope for Solaris or Linux supports remote monitoring by using SSH. This task describes the
steps involved in configuring remote UNIX Servers for SSH monitoring with SiteScope.
HP SiteScope (11.23)
Page 534 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
Note: Setting up the SSH hosts on the remote servers you want to monitor in the UNIX
environment can be very complex and is beyond the scope of this document. Some suggested
resources on installation of the OpenSSH daemon are
http://sunfreeware.com/introduction.html (for Solaris) and http://docs.redhat.com/docs/enUS/Red_Hat_Network_Satellite/5.4/html/Reference_Guide/sect-Reference_GuideMonitoring-RHN_Monitoring_Daemon_rhnmd.html#sect-Reference_Guide-RHN_Monitoring_
Daemon_rhnmd-Configuring_SSH (for Red Hat Linux).
1.
Prerequisites
For details on the requirements for configuring remote UNIX servers for SSH monitoring with
SiteScope in a UNIX environment, see "SSH Configuration Requirements for UNIX Remote
Servers" on page 545.
2.
Configure the SSH client to connect to the remote servers
After you have set up SSH servers or daemons on remote servers, you must configure the
integrated Java SSH client that SiteScope uses to connect to the remote servers.
For task details, see "How to Configure the Integrated Java SSH Client" on page 549.
3.
Configure UNIX remote settings to use the SSH connection method
After you have confirmed SSH connectivity, create or configure UNIX remote settings in
SiteScope to use SSH as the connection method.
For user interface details, see "New/Edit UNIX Remote Server Dialog Box" on page 512.
How to Configure Remote Windows Servers for SSH
monitoring
This task describes the steps involved in configuring remote Windows Servers for SSH monitoring
with SiteScope.
1.
Install and configure a SSH server
Install and configure a SSH server on each remote server to which you want SiteScope to
connect. There are two software packages generally available that enable SSH capability:
n
Cygwin environment available from http://www.cygwin.com/. For task details, see "Install
Cygwin OpenSSH on Windows " on the next page.
n
OpenSSH for Windows available at OpenSSH for Windows. For task details, see "Install
OpenSSH for Windows" on page 542.
Note: These setup steps must be performed for each server that runs the SSH daemon
or server.
HP SiteScope (11.23)
Page 535 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
2.
Enable Windows SSH monitoring using preinstalled SiteScope SSH
files - optional
Depending on the monitor that you are using, you can choose to use preinstalled SiteScope
SSH files or agentless Windows SSH for monitoring the remote server (for the list of supported
monitors, see "Monitors Supporting Windows SSH (Agentless or Using the SiteScope Remote
Windows SSH Files)" on page 545.
n
Using preinstalled SiteScope remote Windows SSH files. To enable SSH monitoring of
the remote server using the preinstalled SSH files, you must install the SiteScope remote
Windows SSH files on each remote server to enable commonly used server monitoring
functions. For task details, see "Install SiteScope Remote Windows SSH Files" on page
543.
n
Agentless SSH. If you are using agentless Windows SSH, you do not need to install
SiteScope remote Windows SSH files on the remote Windows server.
Tip: If a monitor supports both preinstalled SiteScope SSH files and agentless
Windows SSH, we recommend using agentless Windows SSH.
3.
Configure the SSH client to connect to the remote servers
After you have set up SSH servers or daemons on remote servers, you must configure the
integrated Java SSH client that SiteScope uses to connect to the remote servers. For task
details, see "How to Configure the Integrated Java SSH Client" on page 549.
4.
Configure Windows remote settings to use the SSH connection
method
After confirming SSH connectivity between SiteScope and the remote server, set up Windows
remote server settings in SiteScope as follows:
n
In Main Settings, select SSH as the connection method. You can then configure monitors to
use the SSH connectivity.
n
To enable SSH monitoring of the remote server using the preinstalled SiteScope SSH files,
make sure SSH using preinstalled SiteScope remote Windows SSH files is selected in
the Advanced Settings panel (this is the default setting).
n
To monitor using agentless Windows SSH, clear the SSH using preinstalled SiteScope
remote Windows SSH files check box in the Advanced Settings panel.
For user interface details, see "New/Edit Microsoft Windows Remote Server Dialog Box" on
page 495.
Install Cygwin OpenSSH on Windows
This task describes the steps involved in installing and configuring a Cygwin OpenSSH server on
Windows servers.
HP SiteScope (11.23)
Page 536 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
Note:
l
This task is part of a higher-level task. For details, see "How to Configure Remote Windows
Servers for SSH monitoring" on page 535.
l
The following instructions assume that no other Cygwin or other SSH utilities are installed
on the machine and that the machine has Internet access.
l
The user login account used to install and run the SSH daemon needs adequate
permissions to install the necessary programs, configure several file options, and control
Windows services. It does not need to be the account that SiteScope uses to connect to
the subject server, although that account must be configured within the Cygwin installation
before you can monitor that server with SiteScope.
Supported versions
Cygwin 1.7.x (the latest certified Cygwin version is 1.7.7)
To install and configure a Cygwin OpenSSH server on Windows servers:
1. Create a new System Environment variable with the following definition: CYGWIN = ntsec
tty.
2. Add the string ;C:\cygwin\bin to your PATH variable. Save the changes to the variables.
3. Download the Cygwin setup program into a temporary folder. For example: C:\temp. The setup
program is used to select, download, and install different packages and components available
with Cygwin.
4. Run the downloaded setup program and choose the Install from Internet option when
prompted to Choose A Download Source. Click Next to continue.
5. If prompted, select a root install directory where the Cygwin package should be installed. This
is where the SSH daemon and related files are installed. For example, C:\cygwin. Click Next
to continue.
6. If prompted, select a temporary directory where the Cygwin installation files should be stored.
For example, C:\temp. Click Next to continue.
7. If prompted, select an Internet Connection option. Normally, you can use Direct Connection.
Click Next to continue.
8. Select a suitable mirror site from which to retrieve the files using the selection list when
prompted. Click Next to continue.
9. The Setup program queries the mirror site for the packages available and displays a hierarchy
tree of package categories. To view and select the packages to download, click on the plus (+)
symbol to the left of the category name to expand any of the package trees. Packages that are
HP SiteScope (11.23)
Page 537 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
selected for download and installation display a version number in the New column. If a version
number is not displayed for a particular package, it is not downloaded and installed. Click Skip
to the left of package name to select the package for download.
Note: Many of the development (Devel) and database (Database) tools that may be
selected by default for download are not necessary to run the SSH daemon and can be
deselected to reduce download time and installation space.
Select each of the following packages for download and installation:
n
cygrunsrv from the Admin branch
n
cygwin-doc from the Doc branch
n
pdksh from the Shells branch
n
openssh and openssl from the Net branch
n
your choice of UNIX-style text editor from the Editors branch (for example: vim or emacs)
Then click to download the files as prompted.
10. Depending on your installation options, the Cygwin setup downloads and installs the selected
packages. You may be prompted to choose to have a shortcut to the Cygwin terminal window
added to the Desktop or Program Start menu. Click to continue and complete the installation.
11. After the Cygwin setup is complete, open a Cygwin terminal window by clicking on the Cygwin
desktop shortcut or Program Start menu item.
Note: Depending on the user profile in the Windows system, the default directory that
opens in the terminal window may not be within the root Cygwin installation tree. Use the
pwd command to display the current directory. Typing in the command string cd /
normally changes the directory to the Cygwin root, which by default corresponds to the
Windows C:\cygwin directory.
Update the default Cygwin group file with the group names in use on the machine and on your
network. Use the mkgroup utility to update the default Cygwin group file with the groups
defined on the server and in your domain. Examples of the commands to use are as follows:
mkgroup -l >> ../etc/group mkgroup -d >> ../etc/group
Note:
HP SiteScope (11.23)
Page 538 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
n
To have Cygwin recognize both domain and local group accounts, run the mkgroup
utility twice, once for local users (-l option) and once for domain users (-d option).
Remember to use >> syntax and not just >, to append entries to the file.
n
If you use both the local and domain options, you must manually edit the /etc/group
file (using the UNIX style text editor you downloaded) to remove any duplicate group
entries. You may also want to remove group entries that are not needed for monitoring
or should not have access to this machine.
Update the default Cygwin user (passwd) file with the users defined on the local machine plus
any individual domain users you want to grant access to Cygwin on this machine. Use the
mkpasswd utility to update the default Cygwin user file.
Examples of the commands to use are as follows:
mkpasswd -l >> ..\etc\passwd mkpasswd -d -u username >> ..\etc\passwd (domain
users)
Note:
n
By default, Cygwin is set to run the OpenSSH daemon as the local user called SYSTEM.
To have Cygwin recognize both domain and local machine user accounts, run the
mkpasswd using the -l option to add all local users, and run it with the -d and -u
options to add individual domain users. Remember to use >> syntax and not just >, to
append entries to the file.
n
If you use both the local and domain options, you must manually edit the /etc/passwd
file (using the UNIX style text editor you downloaded) to remove any duplicate user
entries. You may also change the default /home path and default shell for individual
users. This may be necessary to install the RemoteNTSSH package in the
/home/sitescopeaccount/ directory of the user account to be used by SiteScope.
12. Change the active directory to the /bin directory by typing cd /bin.
13. Create a symbolic link in the /bin directory that points to the Windows Command (CMD) shell
by entering the following command line (be sure to include the trailing space and period):
ln -s /cygdrive/c/winnt/system32/cmd.exe .
14. We recommend that you change permissions and ownership of several Cygwin files and
directories. Also create a log file for the SSH daemon. Enter the following command lines in the
Cygwin terminal command line and press ENTER after each command line entered:
cd /
chmod -R og-w .
HP SiteScope (11.23)
Page 539 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
chmod og+w /tmp
touch /var/log/sshd.log
Note:
n
Exact syntax is required, including spaces.
n
Inconsistent and incorrectly assigned file and directory permissions can be one reason
that the SSH daemon can not be started or that SiteScope is unable to connect to and
run commands or scripts on the remote server.
15. Configure the SSH daemon to run as a Windows service by entering the following command:
ssh-host-config -y
When presented with the CYGWIN= prompt, type ntsec tty to match the environment variable
you set at the beginning of this procedure. Normally, this configures the SSH daemon or
service to restart automatically if the server needs to be restarted.
16. Configure the encryption keys and files for the SSH daemon using the following command:
ssh-user-config -y.
Enter required passphrases for several keystore files when prompted. The program asks you to
re-enter the passphrase for confirmation.
17. You must change the ownership of several files and folders for use by the SSH daemon. The
program does not normally run if the permissions on these files enable them to be changed or
run by group or "world" level users. Enter the following command strings to restrict access to
these files:
chown SYSTEM:Users /var/log/sshd.log /var/empty /etc/ssh_h*
chmod 755 /var/empty
18. Check the installation by starting and then stopping the CYGWIN sshd service using the
Programs > Administrative Tools > Services panel.
Note: Cygwin includes a server utility to start the SSH daemon. However, there have
been a number of situations where this method failed to start the server, whereas using the
Windows Services panel was able to start the server.
19. Configure the default shell or command environment for the user account you use for
monitoring with SiteScope. The shell you select effects what types of scripts or commands
can be run remotely using the SSH connection. Use the UNIX-style text editor and edit the
/etc/passwd file. Find the entry for the SiteScope login account you intend to use and change
the shell from /bin/bash to the shell you want to use as described below. This is normally the
last entry in the line for that account entry.
HP SiteScope (11.23)
Page 540 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
n
If you chose to have SiteScope interact with the remote server using the Windows Command
shell, change the default shell entry to /bin/cmd. Use this option when you plan to use
Windows-style batch files and scripts You must also include the symbolic link to the
Windows cmd.exe kernel in the /bin directory as described in a previous step of this
procedure.
n
If you chose to have SiteScope interact with the remote Windows server using a Cygwin
UNIX shell, change the default shell entry to be /bin/pdksh. The SiteScope SSH client may
not accurately parse Cygwin's default bash shell. You must also configure a Remote UNIX
server connection to this (Windows) server that connects to the Cygwin SSH daemon.
Save the changes to the file.
20. Edit the PATH and the default prompt commands in the /etc/profile file to make sure that
Cygwin can find certain files and that SiteScope can parse the output from the remote shell.
Use the UNIX-style text editor and edit the /etc/profile file. Find the PATH definition entry
near the top of the file. For example:
PATH=/usr/local/bin:/usr/bin:/bin:$PATH
Change this to include the following:
PATH=.:/usr/local/bin:/usr/bin:/bin:$PATH
21. To change the default prompt commands, edit the /etc/profile file, and find the section
similar to the following:
;;
sh | -sh
| */sh |\
sh.exe | -sh.exe
| */sh.exe )
#Set a simple prompt
PS1='$ '
;;
Immediately under this entry, add the following:
;;
pdksh | -pdksh
| */pdksh |\
pdksh.exe | -pdksh.exe
| */pdksh.exe )
#Set a simple prompt
PS1='> '
;;
22. Save the changes to the file.
23. Change the active directory to the home directory of the user you have created for SiteScope
monitoring.
After making these changes and starting the SSH daemon, you should be able to connect to
the server using an SSH client.
HP SiteScope (11.23)
Page 541 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
Note: Any time you run the mkpasswd -l /etc/passwd command (for example, when
adding a new user), edit the /etc/passwd file again to make sure that the default shell for
that user is set to the required value for any account being used by SiteScope.
Install OpenSSH for Windows
This task describes the steps involved in installing and configuring an OpenSSH server on
Windows servers.
The OpenSSH for Windows package is an alternative to the Cygwin SSH package and can be
easier to install. Like most products, the Cygwin product and the Open SSH for Windows are
subject to change. There are cases where some versions of the Cygwin SSH server have not
returned the data needed for SiteScope monitoring. If the OpenSSH for Windows package can
solve this problem, use this package in place of the Cygwin package.
Note: This task is part of a higher-level task. For details, see "How to Configure Remote
Windows Servers for SSH monitoring" on page 535.
To install and configure an OpenSSH for Windows server on Windows servers:
1. Download and install the OpenSSH for Windows package.
2. Open a command prompt and change to the installation directory (C:\Program
Files\OpenSSH is the default installation path).
3. Change the active directory to the OpenSSH\bin directory.
4. You must update the default group file with the group names in use on the machine and in your
network. Use the mkgroup utility to update the default OpenSSH group file with the groups
defined on the server and in your domain. Examples of the commands to use are as follows:
mkgroup -l >> ..\etc\group mkgroup -d >> ..\etc\group
Note:
n
To have OpenSSH recognize both domain and local group accounts, run the mkgroup
utility twice, once for local users (-l option) and once for domain users (-d option).
Remember to use >> syntax and not just >, to append entries to the file.
n
If you use both the local and domain options, you must manually edit the /etc/group
file (using the UNIX style text editor you downloaded) to remove any duplicate group
entries. You may also want to remove group entries that are not needed or should not
have access to this machine.
5. You must update the default OpenSSH user (passwd) file with the users defined on the local
HP SiteScope (11.23)
Page 542 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
machine plus any domain user you want to grant access to the SSH server on this machine.
Use the mkpasswd utility to update the default user file. Examples of the commands to use
are as follows:
mkpasswd -l >> ..\etc\passwd
mkpasswd -d -u username >> ..\etc\passwd
Note:
n
To have OpenSSH recognize both domain and local machine user accounts, run the
mkpasswd utility using the -l option to add all local users and run it with the -d and -u
options to add individual domain users. Remember to use >> syntax and not just >, to
append entries to the file.
n
If you use both the local and domain options, you must manually edit the /etc/passwd
file (using the UNIX style text editor you downloaded) to remove any duplicate user
entries. You may also change the default /home path and shell for individual users (see
instructions below).
6. Check the installation by starting the OpenSSH Server service using the Programs >
Administrative Tools > Services panel.
Install SiteScope Remote Windows SSH Files
This task describes the steps involved in installing SiteScope remote Windows files on each
remote Windows server according to the SSH package you are working with.
Note:
l
This task is part of a higher-level task. For details, "How to Configure Remote Windows
Servers for SSH monitoring" on page 535.
l
SiteScope remote Windows files do not need to be installed on remote Windows server
monitors that support agentless SSH. For a list of monitors that support agentless SSH,
see "Monitors Supporting Windows SSH (Agentless or Using the SiteScope Remote
Windows SSH Files)" on page 545.
To install the SiteScope SSH Files on Cygwin installations:
1. Verify that a \sitescope_login_account_name directory exists within the <install_
drive>:\cygwin\home directory on each machine that is monitored by SiteScope using SSH.
Replace sitescope_login_account_name with the user account name you use to connect to
the machine using the SSH server.
2. One of the advantages of using SSH on Windows is that it enables SiteScope to run scripts on
the remote server running the SSH daemon. To be able to use the Script Monitor to run remote
HP SiteScope (11.23)
Page 543 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
scripts, create a scripts subdirectory in the /home/sitescope_login_account_name
directory. Scripts you create for execution by the SiteScope Script Monitor must be placed
inside this directory.
3. On the machine where SiteScope is installed, find the file called RemoteNTSSH.zip in the
<SiteScope root directory>\tools directory.
Note: All .exe and .dll files in RemoteNTSSH.zip should have executable permissions.
Use the command chmod +x * to grant executable permissions to the relevant files.
4. Copy this file to the <install_drive>:\cygwin\home\sitescope_login_account_name
directory on each of the remote Windows servers where you have installed the SSH server or
daemon software.
5. Unzip the RemoteNTSSH.zip file on the remote server. Place the contents of the zip file into
the <install_drive>:\cygwin\home\sitescope_login_account_name directory. This should
create a <install_drive>:\cygwin\home\sitescope_login_account_name\scripts subfolder.
You use this subfolder to hold scripts that can be run by the SiteScope Script Monitor.
Note: If the RemoteNTSSH.zip file is from a version of SiteScope earlier than 11.10, you
must reinstall the zip file from <SiteScope 11.10 root>\tools directory on all monitored
remote servers.
6. Start the CYGWIN sshd service on the remote server.
To install the SiteScope SSH Files on OpenSSH for Windows installations:
1. On the machine where SiteScope is installed, find the file called RemoteNTSSH.zip in the
<SiteScope root directory>\tools directory.
2. Copy this file to the user home directory where the user is automatically directed after logging
on to the machine using the SSH server that was previously installed. This is the directory on
each of the remote Windows servers where you have installed the SSH server or daemon
software.
3. Unzip the RemoteNTSSH.zip file on the remote server into the user home directory. This
should create a <user home directory>\scripts subfolder. You use this subfolder to hold
scripts that can be run by the SiteScope Script Monitor.
Note: If the RemoteNTSSH.zip file is from a version of SiteScope earlier than 11.10, you
must reinstall the zip file from <SiteScope root directory>\tools directory on all
monitored remote servers.
4. Start the OpenSSH server service on the remote server.
HP SiteScope (11.23)
Page 544 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
SSH Configuration Requirements for UNIX Remote
Servers
The following are requirements for configuring remote UNIX servers for SSH monitoring with
SiteScope in a UNIX environment:
l
Secure Shell daemons or servers (sshd) must be installed on each remote server you want to
monitor with SiteScope.
l
The SSH daemons on the remote servers must be running and the applicable communication
ports must be open. For example, the default for SSH is port number 22.
l
A SSH client must be installed on the server where SiteScope is running. The SiteScope
integrated Java SSH client fills this requirement.
Verify SSH client-to-server connectivity from the machine where SiteScope is running to the
remote machine you want to monitor. Check SSH connectivity outside of the SiteScope application
before setting up remote server connections using SSH in SiteScope. For example, if SiteScope is
running on Solaris or Linux, use the following command line to request an SSH connection using
SSH2 to the server <remotehost>:
ssh -2 <remotehost>
This normally returns text information that indicates the version of SSH protocol that is being used.
Also, this attempts to authenticate the current user. Use the -l username switch to request a login
as a different user.
Once you have confirmed SSH connectivity, create or configure UNIX Remote settings in
SiteScope to use SSH as the connection method.
Monitors Supporting Windows SSH (Agentless or
Using the SiteScope Remote Windows SSH Files)
The following lists the monitors that support agentless Windows SSH, or Windows SSH using the
SiteScope's remote Windows SSH files. All the monitors that support Windows SSH using
SiteScope's SSH files are supported in SiteScopes running on UNIX platforms.
Monitor
Supports Windows SSH
Using SiteScope's Remote
Windows SSH Files
Supports Agentless
Windows SSH
Citrix Monitor
a
a
ColdFusion Server Monitor
a
a
CPU Monitor
a
a
Directory Monitor
a
HP SiteScope (11.23)
Page 545 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
Monitor
Supports Windows SSH
Using SiteScope's Remote
Windows SSH Files
Supports Agentless
Windows SSH
Disk Space Monitor
a
a
Dynamic Disk Space Monitor
a
a
Log File Monitor
a
Memory Monitor
a
a
Microsoft Lync Server 2010
Monitors
a
a
Microsoft ASP Server Monitor
a
a
Microsoft Hyper-V Monitor
a
a
Microsoft IIS Server Monitor
a
a
Microsoft SQL Server Monitor
a
a
Microsoft Windows Event Log
Monitor
a
Microsoft Windows Media Server
Monitor
a
Microsoft Windows Performance
Counter Monitor
a
Microsoft Windows Resources
Monitor
a
Microsoft Windows Services State
Monitor
a
Multi Log Monitor
a
Real Media Server Monitor
a
Script Monitor
a
Service Monitor
a
a
a
a
Troubleshooting and Limitations
This section contains troubleshooting and limitations when monitoring using SSH.
Skips in Windows SSH Based Monitors on Red Hat Linux 5
If you encounter skips in Windows SSH based monitors running on Red Hat Linux 5 platforms, in
the opt/SiteScope/java/lib/security/java.security file, change:
HP SiteScope (11.23)
Page 546 of 1293
Using SiteScope
Chapter 47: SiteScope Monitoring Using Secure Shell (SSH)
"securerandom.source=file:/ dev/urandom"
to
"securerandom.source=file:///dev/urandom"
Agentless Windows SSH is Not Working
If Windows SSH is working using the SiteScope remote Windows SSH files, but agentless
Windows SSH is not, perform the following:
l
Check that perfmon is working correctly. On the target machine, run the command perfmon and
verify that the required perfmon objects appear. For details on how to rebuild these libraries, refer
to http://support.microsoft.com/?kbid=300956.
l
Check that the remote machine has a working typeperf command (sample command to test)
by entering the following in the command line:
typeperf "\Processor(_Total)\% Processor Time"
For details, refer to http://technet.microsoft.com/en-us/library/cc753182.aspx.
Agentless SSH Fails to Retrieve Counters
In some cases, agentless SSH shows n/a for counters while perfmon gives the value as 0 for the
same counters. This is the behavior for counters that are also not selectable using the perfmon
utility. The reason that SSH using the SiteScope remote Windows SSH files can get values for
these counters is because it bypasses perfmon and accesses them through the registry.
Windows SSH Using the SiteScope remote SSH Files is Not Working
Check that the prerequisites for Windows SSH monitoring using the SiteScope SSH files have
been met. For details, see "Install SiteScope Remote Windows SSH Files" on page 543.
Error: "resize: unknown character exiting"
If SiteScope fails to create a connection using SSH and the error.log or runMonitor.log contain a
server error message similar to "resize: unknown character exiting", this is probably caused by an
invalid bash-related command. SiteScope supports basic bash environments only. Bash
commands are usually found in the .bashrc file under the user default directory.
HP SiteScope (11.23)
Page 547 of 1293
Chapter 48: Integrated Java SSH Client
If you need to use Secure Shell (SSH) to connect to remote UNIX or Windows servers, SiteScope
must be able to access a SSH client to make the connection and transmit data. This section
contains some of the client configuration possibilities and issues involved in using SSH for
SiteScope monitoring.
SiteScope provides an SSH client written in Java that is integrated into the SiteScope application.
This client significantly reduces the required system resources used by SiteScope when
connecting to servers using SSH. The Java client supports both SSH version 1 (SSH1) and version
2 (SSH2) protocols as well as both password-based and key-based authentication. The SiteScope
configuration for the client is identical for UNIX, Linux, and Windows SiteScope.
For details on configuring the Integrated Java SSH Client, see "How to Configure the Integrated
Java SSH Client" on the next page.
This section also includes:
l
"Working with the Integrated SSH Client" below
l
"Setting Up Key-Based Authentication" below
l
"Using SSH Version 2 Protocol" on the next page
Working with the Integrated SSH Client
While SSH1 and SSH2 are both Secure Shell protocols, they are considered to be two different
protocols and are not compatible with each other. Some security vulnerabilities have been found in
SSH1 that has resulted in SSH2 being considered the current standard. Most SSH software
supports both protocols. However, to be sure that a request for an SSH connection uses SSH2
instead of SSH1, it is necessary to configure SSH clients and SSH hosts to use the same protocol
version between them to communicate. In many cases, SSH1 is the default version used for
connections, as it is considered the lowest common denominator between an SSH client and an
SSH host.
There are two ways to force SSH2 connections:
l
Configure all SSH daemons or servers to accept only SSH2 connection requests. This is
the most secure option but may be the most time- consuming unless each server was
configured for this option when it was installed and activated.
l
Configure the SSH client on the SiteScope server to only make SSH2 requests. Requires
changes only to the client on the SiteScope server. For the integrated Java SSH client, this can
be controlled by a setting in the Advanced Options section on the remote server setup page.
Setting Up Key-Based Authentication
Another part of SSH security is authentication. The integrated SSH client for SiteScope can be
configured to use one of two authentication options:
HP SiteScope (11.23)
Page 548 of 1293
Using SiteScope
Chapter 48: Integrated Java SSH Client
l
Password Authentication. Password Authentication is the default method for SSH
connections in SiteScope.
l
Key-Based Authentication. Key-Based Authentication adds an additional level of security
through the use of a passphrase and a public-private key authentication.
To use Key-Based Authentication for SSH remote servers, you must first create a pair of
public/private keys. The public key resides on the remote and the private key is kept on the
SiteScope machine. Both Cygwin OpenSSH and OpenSSH for Windows come with a key
generation tool called ssh-keygen. The ssh-keygen tool enables you to create both protocol version
1 and version 2 keys.
When setting up a UNIX or Windows remote server using the Internal Java Libraries Client, use the
key generation tool called MindTerm to create a public/private key pair for RSA (version 1 and
version 2) and DSA (version 2).
Using SSH Version 2 Protocol
By default, the SiteScope Java client uses the SSH1 Protocol if the server it is trying to connect to
enables SSH1 connections. If this negotiation fails, SiteScope attempts to connect using version 2
protocol. The SiteScope Java client can be configured to use only SSH2 connections. Making the
change on the SiteScope machine may be easier than having to reconfigure a large number of
remote SSH servers.
How to Configure the Integrated Java SSH Client
This task describes the steps involved in configuring the integrated Java SSH client.
1. Select an authentication option for SSH connections
Select an authentication option for integrating SSH client for SiteScope: password
authentication (the default method in SiteScope) or key-based authentication.
For details on how to set up key-based authentication for SSH connections, see "How to Set
Up Key-Based Authentication" below.
2. Configure the SiteScope java client to use SSH2 connections only (if required)
When configuring your remote server profile in Microsoft Windows/UNIX Remote Servers,
select the SSH version 2 only check box in the Advanced Settings.
How to Set Up Key-Based Authentication
This task describes the steps involved in setting up key-based authentication for SSH remote
servers. You can copy a SiteScope SSH key to the remote server, or take the remote server key
from a remote server and copy it to SiteScope.
Tip: It is recommended to maintain one key file on the SiteScope server and copy it to the
remote servers instead of generate a file for each machine and copy them to the SiteScope
HP SiteScope (11.23)
Page 549 of 1293
Using SiteScope
Chapter 48: Integrated Java SSH Client
machine.
Note: This task is part of a higher-level task. For details, see "How to Configure the Integrated
Java SSH Client" on the previous page.
Creating a Key on the SiteScope Server
To create a public or private key pair on the SiteScope server:
1. Open a command window on the SiteScope server, and run the following command to launch
MindTerm:
<SiteScoperoot directory>\java\bin\java -jar c:\<SiteScope root directory>\
WEB-INF\lib\mindterm.jar
2. In MindTerm, select File > Create Keypair > DSA (or RSA). Also select OpenSSH .pub
format.
3. The key pair is written to the <USER_HOME>\mindterm directory.
4. Copy the private key (file not ending in *.pub) to the <SiteScope root directory>\groups
directory.
5. Copy the identity.pub file to the <USER_HOME>/.ssh directory on the remote machine and
rename it authorized_keys (or authorized_keys2 for SSH2). You also can add content of
identity.pub to existing authorized_keys/authorized_keys2 file if you want to allow a
number of different users to connect to the server with different keys files.
6. On the remote machine, run the command chmod 744 authorized_keys in the <USER_
HOME>/.ssh directory, and make sure that User has read, write, and execute permissions,
and that Group and Other have read permissions on the authorized_keys file.
7. Create a remote connection in SiteScope for the remote server using key file authentication
and Internal Java Libraries.
The public key goes in the <USER_HOME>/.ssh/authorized_keys file on the remote
machines.
The private key file can be put into the <SiteScope root directory>\groups directory, and
renamed identity, which enables SiteScope to automatically take it without having to specify
the file path in Advanced Settings of the remote server. Alternatively, you can put the private
key in any other SiteScope directory, or outside of SiteScope.
The key generated from MindTerm is in Openssh format.
Note: You must verify that the server key and the MindTerm key are at the same level. For
example, if the server key is 768 bit and the MindTerm key is 1024 bit, the authentication
procedure fails.
HP SiteScope (11.23)
Page 550 of 1293
Using SiteScope
Chapter 48: Integrated Java SSH Client
To find out what your server is using:
1. Stop the sshd service on the remote server. On a Red Hat Linux server, run the command:
/etc/rc.d/init.d/sshd stop
2. Start the sshd service in debug mode on the remote server. On a Red Hat Linux server, run the
command:
/usr/sbin/sshd -d
You should see output similar to Generating 768 bit RSA key.
Note: When using the Key File for SSH connections box in SiteScope, if there is a
trailing space after the information entered, this causes an "unknown error (-1)" failure.
Remove the trailing space to fix the problem.
To convert the openSSH key to SEC SSH format:
1. Create a RSA key in MindTerm (which is an openSSH key pair).
2. Run the following command on the remote server to convert the openSSH key to SEC SSH
format:
ssh-kegen -e -f <public key>
3. Leave the private key on the SiteScope server in the openSSH format.
Note: When using Key-Based authentication, the Key File supplied must be a version 2
private key.
Creating a Key on a UNIX Remote Server and Copying it to the SiteScope
Server
To set up a connection by taking the remote machine key and put it into SiteScope:
1. Log on to your UNIX remote server as the user that has root permissions.
2. To generate a public/private RSA key pair for protocol version 1, run the following command:
$> ssh-keygen -t rsa
If you want to generate key pair for version 2, run the command:
$> ssh-keygen -t dsa
The possible output is:
HP SiteScope (11.23)
Page 551 of 1293
Using SiteScope
Chapter 48: Integrated Java SSH Client
Enter file in which to save the key (~/.ssh/id_rsa):
Enter passphrase* (empty for no passphrase):
Enter same passphrase again:
where the passphrase is the password used to decode your private key file; it can be left blank.
Your identification is saved in ~/.ssh/id_rsa and the public key in ~/.ssh/id_rsa.pub
(protocol version 1); or ~/.ssh/id_dsa and ~/.ssh/id_dsa.pub for protocol version 2.
3. The corresponding public key must be listed in the authorized file on the remote host. Add the
content of generated public key to this file (the default authorized_keys file location is the
~/.ssh directory).
To do this run the commands:
$> chmod 700 .ssh
$> cd .ssh
$> touch authorized_keys (for ver. 2: touch authorized_keys2)
$> chmod 600 authorized_keys (for ver. 2: chmod 600 authorized_keys2)
$> cat id_rsa.pub >> authorized_keys (for ver. 2: cat id_dsa.pub >> authoriz
ed_keys2)
$> rm id_rsa.pub (for ver. 2: rm id_dsa.pub)
4. Copy the identification file, private key, to the SiteScope machine.
5. In SiteScope, create a new UNIX remote server with the following in the Main Settings:
n
User name. This must be the name of a user that you want to connect to the remote server.
n
Password. The password is the passphrase of the generated private key.
n
Method. SSH.
6. Set the Advanced Settings as follows:
HP SiteScope (11.23)
Page 552 of 1293
Using SiteScope
Chapter 48: Integrated Java SSH Client
7. Test the remote server connection.
HP SiteScope (11.23)
Page 553 of 1293
Chapter 49: Remote Servers Properties Page
This page displays information about the remote servers configured in your network environment.
Use this page to add, edit, or delete remote server profiles.
To access
Select the Remote Servers context. In the remote servers tree, click the
Microsoft Windows Remote Servers or UNIX Remote Servers container.
Important
information
l
Only an administrator in SiteScope, or a user granted Add, edit or delete
remote servers permissions can view or edit the Remote Servers page. For
details on user permissions, see "User Management Preferences" on page
726.
l
You cannot delete a server from the list of remote servers if the server is
referenced by a monitor. Select a different server in the Server box of the
Monitor Settings panel for each monitor that references the remote server, and
then delete the remote server from the remote server list.
l
You can create multiple remote servers for the same host machine.
l
"How to Configure SiteScope to Monitor a Remote Microsoft Windows Server"
on page 490
l
"How to Configure SiteScope to Monitor a Remote UNIX Server" on page 510
Relevant
tasks
See also
"Remote Server Tree" on page 55
User interface elements are described below:
UI Element
Description
New Microsoft Windows/UNIX Remote Server. Opens the New Microsoft
Windows/UNIX Remote Server dialog box enabling you to configure a remote
server and add it to the tree. For details, see "New/Edit Microsoft Windows
Remote Server Dialog Box" on page 495 or "New/Edit UNIX Remote Server
Dialog Box" on page 512.
Edit Remote Server. Enables you to edit the properties of the selected remote
server.
Delete Remote Server. Deletes the selected server from the tree.
HP SiteScope (11.23)
Page 554 of 1293
Using SiteScope
Chapter 49: Remote Servers Properties Page
UI Element
Description
Test. Tests the connection to one or multiple servers.
l
When testing the connection to a single remote server, the test results are
displayed in a popup window.
l
When testing the connection for multiple remote servers, the test is performed
in the background so you can continue to use SiteScope. The test results are
displayed in Server Statistics > Log Files > Other Logs in the remotes_
multi_test.log.
Detailed Test. Runs a test that displays the result of running commands on UNIX
remote servers. This enables checking the permissions for the defined user.
Select All. Selects all listed remote servers.
Clear Selection. Clears the selection.
<Remote
servers
list>
Lists the remote servers that have been configured in SiteScope. Double-click a
remote server to open the Edit Remote Server page for the selected remote server
type.
Name
Name by which the remote server is known in SiteScope.
Server
IP address or name of the monitored remote server. You can create two remote
servers with the same host name.
Status
Connection status of the remote server. If SiteScope is unable to connect to the
remote server, a reason for the connection failure is provided.
Last Test
The date and time that the remote server connection was last tested.
Operating
System
Operating system that is running on the remote server.
Method
Connection type for monitoring the server resources (NetBIOS, WMI, and SSH
for Windows; Rlogin, Telnet, and SSH for UNIX).
Description Description of the remote server that was assigned when creating or editing the
remote server.
Associated
Monitors
Number of monitors used by each remote server. This enables sorting the table by
the number of monitors used by each remote server, and removal of unused
remote servers (those with 0 associated monitors can subsequently be deleted).
HP SiteScope (11.23)
Page 555 of 1293
Part 7: Preferences
The Preferences menu represents the preference types that enable you to configure specific
properties and settings related to most of the administrative tasks available within SiteScope.
You can configure the following preference types within SiteScope:
l
"Certificate Management" on page 557
l
"Common Event Mappings" on page 562
l
"Credential Preferences" on page 572
l
"Email Preferences" on page 580
l
"General Preferences" on page 586
l
"HTTP Preferences" on page 596
l
"High Availability Preferences" on page 604
l
"Infrastructure Preferences" on page 615
l
"Integration Preferences" on page 657
l
"Log Preferences" on page 697
l
"Pager Preferences" on page 703
l
"Schedule Preferences" on page 708
l
"Search/Filter Tags" on page 714
l
"SNMP Preferences" on page 717
l
"User Management Preferences" on page 726
HP SiteScope (11.23)
Page 556 of 1293
Chapter 50: Certificate Management
When monitoring a remote server, if the target server uses a self-signed certificate, the certificate
must be added to a trusted keystore. If you are monitoring a URL, a WebSphere Application Server,
or a VMware-based server using a secure connection, you can manage self-signed certificates from
the Certificate Management page.
Note: You can still import certificates using the keytool method if preferred. For details on
manually importing certificates, see the documentation for the specific monitor type.
To access
Select Preferences context > Certificate Management.
l
To view certificate details, double-click a certificate (opens the Certificate Details dialog box).
l
To add certificates, click the Import Certificates button (opens the Import Certificates dialog
box).
Note: To view the Certificate Management page, you must be an administrator in SiteScope,
or a user granted View certificates list permissions. Edit certificates list permissions are
required to manage certificates using the Certificate Management page. For details on this
topic, see "User Management Preferences" on page 726.
Learn About
Benefits of Certificate Management
l
Certificates do not need to be managed using the standard JVM tools (keytool). This avoids the
requirement for a desktop/shell session to the SiteScope machine.
l
Provides visual keystore management (add and remove certificates) and enables dynamic
keystore reload, without having to restart SiteScope after each certificate change operation.
l
Monitors are bound to the keystores that they are using. For URL, WebSphere Application
Server, and VMware monitors, the following keystore is used:
<SiteScope root directory>\java\lib\security\cacerts. Other keystores are ignored.
l
If you use a self-generated Certificate Authority (CA) certificate to sign all the server certificates,
you only need to import the CA certificate once.
Tasks
How to Import Server Certificates Using Certificate Management
This task describes the steps involved in importing self-signed certificates using Certificate
Management.
HP SiteScope (11.23)
Page 557 of 1293
Using SiteScope
Chapter 50: Certificate Management
1. Prerequisites
n
Certificate Management can be used to import server certificates that are required when
configuring secure connections for the SiteScopeURL, WebSphere Application, and
VMware monitors.
n
Only a SiteScope administrator user, or a user with View/Edit certificates list permissions,
can view, add, or make changes to the certificates keystore on the Certificate Management
page. For details on user permissions, see "Permissions" on page 738.
2. Import the server certificate
If the Web server on which you are monitoring has an https:// prefix, it is a secure, encrypted
connection, and you need to import the server certificate.
a. Select Preferences > Certificate Management, and click the Import Certificates
button. Select File or Host, and enter the details of the source server. For user interface
details, see "Import Certificates Dialog Box" on the next page.
b. From the Loaded Certificates table, select the server certificates to import and click
Import. The imported certificates are listed on the Certificate Management page. For user
interface details, see "Certificate Management Page" below.
3. Configure the monitor properties
After importing the required server certificates, you can create a monitor with a secured
connection.
UI Descriptions
Certificate Management Page
This page is used for managing certificates used with SiteScope URL, WebSphere Application, and
VMware monitors. The Certificate Management page enables you to add, remove, and refresh
keystore contents.
User interface elements are described below (unlabeled elements are shown in angle brackets):
UI Element
Description
Import Certificates. Opens the Import Certificates dialog box and add
certificates to the Certificate Management keystore list. For user interface
details, see "Import Certificates Dialog Box" on the next page.
Remove Certificates. Deletes the selected certificates from the Certificate
Management keystore list.
HP SiteScope (11.23)
Page 558 of 1293
Using SiteScope
Chapter 50: Certificate Management
UI Element
Description
ReloadCertificate List. Reloads the keystore certificates from the <SiteScope
root directory>\java\lib\security\cacerts files on the remote server. This
enables you to manually reload keystore changes without having to restart
SiteScope.
Select All. Selects all listed certificates.
Clear Selection. Clears the selection.
<certificates> Lists the server certificates that have been imported. Double-click a certificate
to open the Certificate Details dialog box and display the certificate's properties
and values. For user interface details, see "Certificate Details Dialog Box" on
the next page.
Alias
Certificate alias name.
Note: Alias names of imported certificates cannot be modified (they can be
modified only during the import certificate step).
Issuer
Name of the certificate issuer.
Valid Until
Time and date until which the certificate is valid.
Version
Certificate version number.
Import Certificates Dialog Box
This dialog box is used for adding certificates used with SiteScope URL, WebSphere Application,
and VMware Performance monitors to the Certificate Management list keystore. The Certificate
Management page enables you to add, remove, and refresh keystore contents.
To access
Select Preferences context > Certificate Management. Click the Import
Certificates button.
Important
information
l
Only an administrator in SiteScope, or a user with View/Edit certificates list
permissions can view, add, or make changes to the certificates keystore on
the Certificate Management page.
l
You can change the sort order in the columns by clicking the arrow in the
column title. A small down or up arrow is displayed indicating the column is
sorted in ascending or descending order.
Relevant
tasks
"How to Import Server Certificates Using Certificate Management" on page 557
See also
"Certificate Management" on page 557
HP SiteScope (11.23)
Page 559 of 1293
Using SiteScope
Chapter 50: Certificate Management
User interface elements are described below:
UI
Element Description
Source Selection
Host
Select this option to add certificates from a host server. Enter the real IP address or
host name of the monitored server.
Port
Port number of the host machine (available only if the Host option is selected).
Default Port value: 443
Load
Loads certificates for the machine specified in the Host field. The certificates are
displayed in the Loaded Certificates table.
File
Select this option to add certificates from a file.
Select
Use to navigate to the file from which you want to import certificates, and click Open.
Add the required certificates to the Certificate Management list.
Loaded Certificates
Select All. Selects all listed certificates.
Clear Selection. Clears the selection.
Alias
Certificate alias name. You can modify a certificate alias during the import certificate
step by entering a new alias in the Alias column.
Note: An alias name cannot be modified after the certificate has been imported.
Issuer
Name of the certificate issuer.
Valid
Until
Time and date until which the certificate is valid.
Version
Certificate version number.
Import
Select the certificates to import from the Loaded Certificates table, and click Import.
The imported certificates are displayed in the Certificate Management page.
Certificate Details Dialog Box
This dialog box displays properties and values for the selected server certificate.
To access
Select Preferences context > Certificate Management. Double-click a
certificate in the Certificate Management page.
HP SiteScope (11.23)
Page 560 of 1293
Using SiteScope
Chapter 50: Certificate Management
Important
Only an administrator in SiteScope, or a user with View/Edit certificates list
information permissions can view, add, or make changes to the certificates keystore on the
Certificate Management page.
Relevant
tasks
"How to Import Server Certificates Using Certificate Management" on page 557
See also
"Certificate Management" on page 557
User interface elements are described below:
UI Element
Description
Alias
Certificate alias name.
Certificate Properties
Fingerprint
The certificate's fingerprint.
Type
The certificate type.
Version
Version number of the certificate.
Issuer principal
Name of the certificate issuer.
Serial number
Serial number of the certificate.
Signature algorithm name
Name of the signature algorithm of the certificate.
Valid from
Time and date from which the certificate is valid.
Valid until
Time and date until which the certificate is valid.
HP SiteScope (11.23)
Page 561 of 1293
Chapter 51: Common Event Mappings
This page is used to define event mappings and settings. It enables you to configure mappings
between SiteScope runtime data and the attribute values of the event to be sent. Common event
mappings are used when configuring the Operations Manager event integration and the Generic
Event integration.
To access
Select Preferences context > Common Event Mappings to open the Common Event Mappings
page.
Note: You must be an administrator in SiteScope, or a user granted View common event
mappings permissions to be able to view Common Event Mappings. Add, edit or delete
common event mappings permissions are required to create or edit Common Event
Mappings. For details on this topic, see "User Management Preferences" on page 726.
Learn About
Common Event Mappings Overview
You can configure SiteScope to send events directly to Operations Manager (HPOM) or to
Operations Management in BSM. You do this by using Common Event Mappings to create event
mapping instances between SiteScope runtime data and the event attribute values that are sent to
the HPOM or BSM Gateway Server. Common event mappings are also used when configuring the
Generic Event integration for sending events to other management consoles.
When the event trigger condition is met, the event template is used to map the SiteScope runtime
data to the event attributes. These attributes have values that are passed to the event subsystem
to create the corresponding event (for example, the template translates the runtime data into an
event in HPOM or BSM). The event is then sent to HPOM, BSM, or the specified management
console.
You can do this by using the default event mapping associated with the monitor or alert, select a
different event mapping (if any exist), or create a new event mapping in Common Event Mappings.
Alternatively, for alerts, you can use the event mapping template associated with the monitor that
triggered the alert. For details on creating event mappings for an event in HPOM or BSM, see "How
to Configure Common Event Mappings for HPOM or BSM" on the next page.
SiteScope contains the HP CDA Event Mapping template, an out-of-the-box template that is
specially configured for CDA (Continuous Delivery Automation). CDA is a policy-based platform
that provides infrastructure provisioning in hybrid cloud environments. CDA integrates with
SiteScope to deploy SiteScope monitors and receive events from them. Monitoring status based on
the events received is available in the CDA user interface. For more details on CDA, refer to the
CDA documentation.
For details on configuring SiteScope to report events directly to the Operations Manager server,
see "How to Enable SiteScope to Send Events to HPOM or Operations Management" in Integrating
SiteScope with HP Operations Manager Products in the SiteScope Help. You can check the
HP Software Integrations site to see if a more updated version of this guide is available (for
HP SiteScope (11.23)
Page 562 of 1293
Using SiteScope
Chapter 51: Common Event Mappings
Windows: http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39; for UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
For details on creating event mappings to report events to a management console using the Generic
Event integration, see "How to Configure SiteScope Generic Event Integration" on page 687.
For details on event mapping attribute properties, see "Properties Available in Alerts, Templates,
and Events" on page 1199.
Tip: It is recommended to disable any existing event integrations and to configure new
integrations when upgrading from versions of SiteScope earlier than 11.00 and versions of
BSM earlier than 9.00. Although integrations work after an upgrade, events are used only in the
BSM Event Browser.
Tasks
How to Configure Common Event Mappings for HPOM or BSM
This task describes how to use Common Event Mappings to configure event mappings for monitors
and alerts. This is the mapping between SiteScope runtime data and the values of event attributes
that will be sent.
1. Prerequisites
n
To create or make changes to event mappings, you must be an administrator in SiteScope,
or a user granted Add, edit or delete common event mappings permissions. For details
on user permissions, see "User Management Preferences" on page 726.
n
To select an event mapping when configuring an alert or a monitor instance, the HP
Operations agent must be installed and connected to an HPOM or BSM server, and event
integration must be enabled in the HP Operations Manager Integration dialog box
(Preferences > Integration Preferences > HP Operations Manager Integration). For
task details, see "How to Enable SiteScope to Send Events to HPOM or Operations
Management" in Integrating SiteScope with HP Operations Manager Products in the
SiteScope Help. You can check the HP Software Integrations site to see if a more updated
version of this guide is available (for Windows:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=39; for UNIX:
http://support.openview.hp.com/sc/solutions/integrations.jsp?intid=628).
2. Configure the alerts or monitor instances
You configure the alerts or monitor instances that, where triggered, create the relevant events
in the event system.
For task details on creating SiteScope alerts, see "Configure SiteScope Alerts" on page 1140.
For task details on creating monitor instances, see "How to Create and Deploy a Monitor" on
page 277.
HP SiteScope (11.23)
Page 563 of 1293
Using SiteScope
Chapter 51: Common Event Mappings
3. Configure the event mappings for an alert or monitor instance
You configure an event mapping to map an alert or monitor instance to the corresponding event
attributes. You can create several mappings for each type of alert or monitor.
n
You configure alerts from the Alerts tab > New/Edit Alert > HP Operations Manager
Integration Settings > Event mapping.
n
You configure a monitor instance from monitor Properties tab > Event Mapping Settings.
For each alert or monitor instance, you can select an existing event mapping, or create a new
event mapping in Common Event Mappings. For user interface details, see "New/Edit Event
Mappings Dialog Box" on the next page.
Note:
n
The event mapping settings are only available when SiteScope is integrated with
HPOM and event integration is enabled (Enable sending events is selected in the
HP Operations Manager Integration Main Settings panel of the HP Operations Manager
Integration dialog box), or when a Generic Event Integration is configured in Integration
Preferences.
n
You cannot delete a common event mapping if it is referenced by a monitor or an alert
action. You must change the event mapping referenced by the monitor or alert before
you can delete the mapping.
4. Results
You can view the events corr