Zenoss Extended Monitoring

Zenoss, Inc.
www.zenoss.com
Zenoss Extended Monitoring
Copyright © 2009 Zenoss, Inc., 275 West St. Suite 204, Annapolis, MD 21401, U.S.A. All rights reserved.
This work is licensed under a Creative Commons Attribution Share Alike 3.0 License. To view a copy of this license, visit http://
creativecommons.org/licenses/by-sa/3.0/; or send a letter to Creative Commons, 171 2nd Street, Suite 300, San Francisco, California,
94105, USA.
The Zenoss logo is a registered trademark of Zenoss, Inc. Zenoss and Open Enterprise Management are trademarks of Zenoss, Inc. in
the U.S. and other countries.
Amazon Web Services, AWS, Amazon Elastic Compute Cloud, and Amazon EC2 are trademarks of Amazon.com, Inc. or its affiliates in
the United States and/or other countries.
Flash is a registered trademark of Adobe Systems Incorporated.
Java is a registered trademark of Sun Microsystems, Inc.
Linux is a registered trademark of Linus Torvalds.
Oracle and the Oracle logo are registered trademarks of the Oracle Corporation.
SNMP Informant is a trademark of Garth K. Williams (Informant Systems, Inc.).
Sybase is a registered trademark of Sybase, Inc.
Tomcat is a trademark of the Apache Software Foundation.
Windows is a registered trademark of Microsoft Corporation in the United States and other countries.
All other companies and products mentioned are trademarks and property of their respective owners.
Part Number: 07-102009-2.5-v01
1. ZenPacks .......................................................................................................................................... 1
1.1. Introduction to ZenPacks ......................................................................................................... 1
1.2. Installing ZenPacks ................................................................................................................. 1
1.2.1. Installing from the Command Line ................................................................................. 1
1.2.2. Installing from the User Interface ................................................................................... 1
1.2.3. Installing All Core ZenPacks from RPM ......................................................................... 2
1.3. Creating a ZenPack ................................................................................................................. 2
1.3.1. Packaging and Distributing Your ZenPack ...................................................................... 3
1.4. Displaying Installed ZenPacks .................................................................................................. 3
1.5. Removing a ZenPack .............................................................................................................. 3
I. Core ZenPacks ................................................................................................................................... 4
2. Amazon Web Services ............................................................................................................... 5
2.1. About .............................................................................................................................. 5
2.2. Prerequisites ................................................................................................................... 5
2.3. Setup .............................................................................................................................. 5
2.4. Working with the EC2Manager Account ............................................................................ 6
2.4.1. CloudWatch Data ................................................................................................. 6
2.4.2. Templates and Collection ...................................................................................... 7
2.4.2.1. Example: Initiating Load-Based Elasticity for an EC2 Setup ........................... 7
3. Apache Web Server ................................................................................................................... 9
3.1. About .............................................................................................................................. 9
3.2. Prerequisites ................................................................................................................... 9
3.3. Enable Monitoring ........................................................................................................... 9
3.3.1. Display the Status Page in Apache Version 1.3 or higher ........................................ 9
3.3.2. Display the Status Page in Apache Version 2.x .................................................... 10
3.3.3. Verifying your Apache configuration ..................................................................... 11
3.3.4. Configure Zenoss to Monitor the Web Server ....................................................... 12
3.4. Daemons ...................................................................................................................... 12
4. Dell Hardware .......................................................................................................................... 13
4.1. About ............................................................................................................................ 13
4.2. Prerequisites ................................................................................................................. 13
4.3. Enable Enhanced Modeling ............................................................................................ 13
4.4. Daemons ...................................................................................................................... 13
5. Distributed Name Server (DNS) ................................................................................................ 14
5.1. About ............................................................................................................................ 14
5.2. Prerequisites ................................................................................................................. 14
5.3. Enable Monitoring .......................................................................................................... 14
5.4. Daemons ...................................................................................................................... 14
6. File Transfer Protocol (FTP) ..................................................................................................... 15
6.1. About ............................................................................................................................ 15
6.2. Prerequisites ................................................................................................................. 15
6.3. Enable Monitoring .......................................................................................................... 15
6.4. Enable Secure Site Monitoring ....................................................................................... 15
6.5. Tuning for Site Responsiveness ..................................................................................... 16
6.6. Daemons ...................................................................................................................... 16
7. HP PC Hardware ..................................................................................................................... 17
7.1. About ............................................................................................................................ 17
7.2. Prerequisites ................................................................................................................. 17
7.3. Enable Enhanced Modeling ............................................................................................ 17
7.4. Daemons ...................................................................................................................... 17
8. Internet Relay Chat (IRC) ......................................................................................................... 18
8.1. About ............................................................................................................................ 18
8.2. Prerequisites ................................................................................................................. 18
8.3. Enable Monitoring .......................................................................................................... 18
8.4. Daemons ...................................................................................................................... 18
9. Jabber Instant Messaging ......................................................................................................... 19
9.1. About ............................................................................................................................ 19
9.2. Prerequisites ................................................................................................................. 19
iii
Zenoss Extended Monitoring
10.
11.
12.
13.
14.
15.
16.
17.
9.3. Enable Monitoring ..........................................................................................................
9.4. Daemons ......................................................................................................................
Java 2 Platform Standard Edition (J2E) ...................................................................................
10.1. About ..........................................................................................................................
10.1.1. JMX Background ...............................................................................................
10.1.2. ZenJMX Capabilities .........................................................................................
10.1.3. Allowable Parameter Types ...............................................................................
10.1.4. Single Value Attribute Calls ...............................................................................
10.1.5. Complex-Value Attribute Calls ...........................................................................
10.1.6. Example Method Calls ......................................................................................
10.1.6.1. No parameters, single return value ..........................................................
10.1.6.2. No parameters, multiple values returned in List format ..............................
10.1.6.3. No parameters, multiple values returned in Map format .............................
10.1.6.4. Single parameter in polymorphic operation ...............................................
10.1.6.5. Multiple parameters in polymorphic operations .........................................
10.2. Prerequisites ...............................................................................................................
10.2.1. Sun Java Runtime Environment (JRE) ...............................................................
10.3. Example to Monitor a JMX Value .................................................................................
10.3.1. Enabling Remote JMX Access ...........................................................................
10.3.2. Configure Zenoss with a Custom Data Source ....................................................
10.4. Monitor Values in TabularData and CompositeData Objects ...........................................
10.5. Using JConsole to Query a JMX Agent ........................................................................
10.6. Daemons .....................................................................................................................
Lightweight Directory Access Protocol (LDAP) Response Time .................................................
11.1. About ..........................................................................................................................
11.2. Prerequisites ...............................................................................................................
11.3. Enable Monitoring ........................................................................................................
11.4. Daemons .....................................................................................................................
MySQL Database ...................................................................................................................
12.1. About ..........................................................................................................................
12.2. Prerequisites ...............................................................................................................
12.3. Enable Monitoring ........................................................................................................
12.3.1. Authorize MySQL Performance Data Access ......................................................
12.3.2. Zenoss .............................................................................................................
12.4. Daemons .....................................................................................................................
Network News Transport Protocol (NNTP) ...............................................................................
13.1. About ..........................................................................................................................
13.2. Prerequisites ...............................................................................................................
13.3. Enable Monitoring ........................................................................................................
13.4. Daemons .....................................................................................................................
Network Time Protocol (NTP) .................................................................................................
14.1. About ..........................................................................................................................
14.2. Prerequisites ...............................................................................................................
14.3. Enable Monitoring ........................................................................................................
14.4. Daemons .....................................................................................................................
ONC-style Remote Procedure Call (RPC) ................................................................................
15.1. About ..........................................................................................................................
15.2. Prerequisites ...............................................................................................................
15.3. Enable Monitoring ........................................................................................................
15.4. Daemons .....................................................................................................................
SSH Monitoring Example ........................................................................................................
16.1. About ..........................................................................................................................
16.2. Prerequisites ...............................................................................................................
16.3. Set Linux Server Monitoring Credentials .......................................................................
16.4. Add a Linux Server ......................................................................................................
16.5. Troubleshooting ...........................................................................................................
16.6. Daemons .....................................................................................................................
Web Page Response Time (HTTP) .........................................................................................
iv
19
19
20
20
20
20
21
21
22
22
22
22
23
23
24
24
24
25
25
25
26
27
30
31
31
31
31
32
33
33
33
33
33
33
34
35
35
35
35
35
36
36
36
36
36
37
37
37
37
37
38
38
38
38
38
39
39
40
Zenoss Extended Monitoring
17.1. About .......................................................................................................................... 40
17.2. Prerequisites ............................................................................................................... 40
17.3. Enable Monitoring ........................................................................................................ 40
17.4. Check for a Specific URL or Specify Security Settings ................................................... 40
17.5. Check for Specific Content on the Web Page ................................................................ 41
17.6. Tuning for Site Responsiveness ................................................................................... 41
17.7. Daemons ..................................................................................................................... 42
II. Enterprise ZenPacks ........................................................................................................................ 43
18. AIX ........................................................................................................................................ 44
18.1. About .......................................................................................................................... 44
18.2. Prerequisites ............................................................................................................... 44
18.3. Add an AIX Server ...................................................................................................... 44
18.4. Set AIX Server Monitoring Credentials .......................................................................... 44
18.5. Resolving CHANNEL_OPEN_FAILURE Issues ........................................................................ 45
18.6. Resolving Command timed out Issues ............................................................................ 45
18.7. Daemons ..................................................................................................................... 46
19. Apache Tomcat Application Server .......................................................................................... 47
19.1. About .......................................................................................................................... 47
19.2. Prerequisites ............................................................................................................... 47
19.3. Enable Monitoring ........................................................................................................ 48
19.3.1. Configuring Tomcat to Allow JMX Queries .......................................................... 48
19.3.2. Configuring Zenoss ........................................................................................... 48
19.4. Change the Amount of Data Collected and Graphed ...................................................... 49
19.5. Viewing Raw Data ....................................................................................................... 50
19.6. Daemons ..................................................................................................................... 50
20. BEA WebLogic Application Server ........................................................................................... 51
20.1. About .......................................................................................................................... 51
20.1.1. Overall Application Server Vitals ........................................................................ 51
20.1.2. Entity EJB, Message Driven Bean (MDB), and Session EJB Subsystem Metrics
.... 51
20.1.3. Data Pool (JDBC) metrics ................................................................................. 51
20.1.4. Queue (JMS) Metrics ........................................................................................ 52
20.2. Prerequisites ............................................................................................................... 52
20.3. Enable Monitoring ........................................................................................................ 52
20.3.1. Configuring WebLogic to Allow JMX Queries ...................................................... 52
20.3.2. Configuring Zenoss ........................................................................................... 52
20.4. Change the Amount of Data Collected and Graphed ...................................................... 53
20.5. Viewing Raw Data ....................................................................................................... 53
20.6. Monitor SSL-Proxied WebLogic Servers ........................................................................ 54
20.7. Daemons ..................................................................................................................... 54
21. BIG-IP Network Devices ......................................................................................................... 55
21.1. About .......................................................................................................................... 55
21.2. Prerequisites ............................................................................................................... 55
21.3. Enable Monitoring ........................................................................................................ 55
21.4. Viewing Virtual Servers ................................................................................................ 56
21.5. Daemons ..................................................................................................................... 56
22. Brocade SAN Switches ........................................................................................................... 57
22.1. About .......................................................................................................................... 57
22.2. Prerequisites ............................................................................................................... 57
22.3. Enable Monitoring ........................................................................................................ 57
22.3.1. Configuring Brocade Devices to Allow SNMP Queries ......................................... 57
22.3.2. Configuring Zenoss ........................................................................................... 57
22.4. Viewing Fibre Channel Port Information ........................................................................ 57
22.5. Daemons ..................................................................................................................... 58
23. CheckPoint Firewalls .............................................................................................................. 59
23.1. About .......................................................................................................................... 59
23.2. Prerequisites ............................................................................................................... 59
23.3. Enable Monitoring ........................................................................................................ 59
23.3.1. Configuring CheckPoint Firewalls to Allow SNMP Queries ................................... 59
v
Zenoss Extended Monitoring
23.3.2. Configuring Zenoss ...........................................................................................
23.4. Daemons .....................................................................................................................
24. Cisco Devices ........................................................................................................................
24.1. About ..........................................................................................................................
24.2. Prerequisites ...............................................................................................................
24.3. Enable Monitoring ........................................................................................................
24.3.1. Configuring Cisco Devices to Allow SNMP Queries .............................................
24.3.2. Configuring Zenoss ...........................................................................................
24.4. Forwarding Syslog Messages to Zenoss .......................................................................
24.5. Extended Capabilities for Cisco Devices .......................................................................
24.5.1. IOS ..................................................................................................................
24.5.2. CatOS ..............................................................................................................
24.5.3. ASA, FWSM and PIX ........................................................................................
24.5.4. Wireless LAN Controllers ...................................................................................
24.5.5. ACE Load Balancers .........................................................................................
24.5.6. Telepresence Codecs ........................................................................................
24.6. Daemons .....................................................................................................................
25. Device Access Control Lists ....................................................................................................
25.1. About ..........................................................................................................................
25.2. Prerequisites ...............................................................................................................
25.3. Key Concepts ..............................................................................................................
25.3.1. Permissions and Roles ......................................................................................
25.3.2. Administered Objects ........................................................................................
25.3.3. Users and Groups .............................................................................................
25.3.4. Assigning Administered Object Access ...............................................................
25.3.5. Restricted Screen Functionality ..........................................................................
25.3.5.1. Dashboard .............................................................................................
25.3.5.2. Device List .............................................................................................
25.3.5.3. Device Organizers ..................................................................................
25.3.5.4. Reporting ...............................................................................................
25.3.5.5. Viewing Events ......................................................................................
25.4. Create a User Restricted to Specific Devices ................................................................
25.5. Create a Manager Restricted to Specific Devices ..........................................................
25.6. Adding Device Organizers ............................................................................................
25.7. Restricted User Organizer Management ........................................................................
26. Distributed Collector ...............................................................................................................
26.1. About ..........................................................................................................................
26.1.1. Navigating Existing Collectors and Hubs .............................................................
26.1.2. Restrictions and Requirements ..........................................................................
26.1.3. Installation Notes ..............................................................................................
26.1.4. Firewall Notes ...................................................................................................
26.1.5. Platform Notes ..................................................................................................
26.1.6. Debugging ........................................................................................................
26.2. Prerequisites ...............................................................................................................
26.3. Typical Usage Scenarios for Distributed Monitoring ........................................................
26.3.1. ZeoDB - Local Hub - Local Collector ..................................................................
26.3.2. ZeoDB - Local Hub - Remote Collector ..............................................................
26.3.3. ZeoDB - Local Hub - Multiple Remote Collectors ................................................
26.3.4. ZeoDB - Multiple Remote Hubs - Multiple Remote Collectors ...............................
26.4. Deploying Collectors ....................................................................................................
26.4.1. Prerequisite Tasks ............................................................................................
26.4.2. Adding Collectors ..............................................................................................
26.4.2.1. Install Remotely (Root Password) ............................................................
26.4.2.2. Install Remotely (Root SSH Keys) ...........................................................
26.4.2.3. Install Remotely (Zenoss SSH Keys) .......................................................
26.4.2.4. Install Locally .........................................................................................
26.4.3. Deleting Collectors ............................................................................................
26.4.4. Updating a Hub or Collector ..............................................................................
vi
59
59
60
60
60
60
60
60
60
61
61
62
62
62
63
63
64
65
65
65
65
65
65
65
65
66
66
66
66
66
66
66
66
67
67
68
68
68
68
69
69
69
69
70
70
70
70
70
70
70
71
71
72
73
73
74
75
75
Zenoss Extended Monitoring
27.
28.
29.
30.
31.
32.
33.
26.4.5. Backing Up Remote Collectors ..........................................................................
26.5. Adding Devices to Collectors ........................................................................................
26.5.1. Moving Devices Between Collectors ...................................................................
26.6. Managing the Collector Daemons .................................................................................
26.7. Deploying Hubs ...........................................................................................................
26.7.1. Configuring MySQL for Remote Hubs ................................................................
26.7.2. Add a Hub ........................................................................................................
26.7.2.1. Install Remotely (Root Password) ............................................................
26.7.2.2. Install Remotely (Root SSH Keys) ...........................................................
26.7.2.3. Install Remotely (Zenoss SSH Keys) .......................................................
26.7.3. Setting Up SSH Keys for Distributed Collector ....................................................
Enterprise Collector ................................................................................................................
27.1. About ..........................................................................................................................
27.2. Prerequisites ...............................................................................................................
27.3. Enabling Enterprise Collector .......................................................................................
Enterprise Linux .....................................................................................................................
28.1. About ..........................................................................................................................
28.2. Prerequisites ...............................................................................................................
28.3. Add a Linux Server ......................................................................................................
28.4. Set Linux Server Monitoring Credentials .......................................................................
28.5. Resolving CHANNEL_OPEN_FAILURE Issues ..............................................................
28.6. Resolving Command timed out Issues ..........................................................................
28.7. DMIDECODE Modeler Plugin .......................................................................................
28.8. Daemons .....................................................................................................................
Enterprise Reports ..................................................................................................................
29.1. About ..........................................................................................................................
29.1.1. 95th Percentile ..................................................................................................
29.1.2. Alert Rule Email Addresses ...............................................................................
29.1.3. Defined Thresholds ...........................................................................................
29.1.4. Event Time to Resolution ..................................................................................
29.1.5. Interface Volume ...............................................................................................
29.1.6. Maintenance Windows ......................................................................................
29.1.7. Organizer Availability .........................................................................................
29.1.8. User Event Activity ............................................................................................
29.1.9. Users Group Membership ..................................................................................
29.2. Viewing Enterprise Reports ..........................................................................................
29.3. Prerequisites ...............................................................................................................
Enterprise Security .................................................................................................................
30.1. About ..........................................................................................................................
30.2. Prerequisites ...............................................................................................................
30.3. Enabling Password Encryption .....................................................................................
Foundry Device ......................................................................................................................
31.1. About ..........................................................................................................................
31.2. Prerequisites ...............................................................................................................
31.3. Configuring Zenoss ......................................................................................................
31.4. Daemons .....................................................................................................................
JBoss Application Server ........................................................................................................
32.1. About ..........................................................................................................................
32.2. Prerequisites ...............................................................................................................
32.3. Enable Monitoring ........................................................................................................
32.3.1. Configuring JBoss to Allow JMX Queries ............................................................
32.3.2. Configuring Zenoss ...........................................................................................
32.4. Change the Amount of Data Collected and Graphed ......................................................
32.5. Viewing Raw Data .......................................................................................................
32.6. Daemons .....................................................................................................................
Juniper Devices ......................................................................................................................
33.1. About ..........................................................................................................................
33.2. Prerequisites ...............................................................................................................
vii
75
76
76
77
77
77
78
78
79
80
81
82
82
82
82
83
83
83
83
83
84
84
85
85
86
86
86
87
87
87
87
88
88
88
89
89
89
90
90
90
90
91
91
91
91
92
93
93
94
94
94
94
95
95
95
96
96
96
Zenoss Extended Monitoring
34.
35.
36.
37.
38.
39.
40.
41.
33.3. Enable Monitoring ........................................................................................................ 96
33.3.1. Configuring Juniper Devices to Allow SNMP Queries ........................................... 96
33.3.2. Configuring Zenoss ........................................................................................... 96
33.4. Daemons ..................................................................................................................... 96
LDAP Authentication ............................................................................................................... 97
34.1. About .......................................................................................................................... 97
34.2. Prerequisites ............................................................................................................... 97
34.2.1. LDAP Configuration Information ......................................................................... 97
34.3. Limitations ................................................................................................................... 98
34.4. Authenticating with Microsoft Active Directory ................................................................ 98
34.4.1. Adding the Authentication Plugin ........................................................................ 98
34.4.2. Configuring Plugin Settings ................................................................................ 98
34.4.3. Enabling Group to Role Mapping ....................................................................... 99
34.4.4. Verifying Connectivity and Credentials Outside of Zenoss .................................. 100
34.5. Authenticating with other LDAP Servers ...................................................................... 100
34.6. Optimizing Authentication with a Cache ....................................................................... 100
34.7. Configuring Local Authentication as a Fallback ............................................................ 101
Mail Transactions ................................................................................................................. 102
35.1. About ........................................................................................................................ 102
35.1.1. Events ............................................................................................................ 102
35.2. Prerequisites .............................................................................................................. 102
35.3. Enable Monitoring ...................................................................................................... 102
35.4. Daemons ................................................................................................................... 103
MS Active Directory .............................................................................................................. 104
36.1. About ........................................................................................................................ 104
36.2. Prerequisites .............................................................................................................. 104
36.3. Enable Monitoring ...................................................................................................... 104
36.4. Daemons ................................................................................................................... 105
MS Exchange ....................................................................................................................... 106
37.1. About ........................................................................................................................ 106
37.2. Prerequisites .............................................................................................................. 106
37.3. Enable Monitoring ...................................................................................................... 106
37.4. Daemons ................................................................................................................... 106
Microsoft Internet Information Services (IIS) ........................................................................... 107
38.1. About ........................................................................................................................ 107
38.2. Prerequisites .............................................................................................................. 107
38.3. Enable Monitoring ...................................................................................................... 107
38.4. Daemons ................................................................................................................... 108
Microsoft SQL Server ........................................................................................................... 109
39.1. About ........................................................................................................................ 109
39.2. Prerequisites .............................................................................................................. 109
39.3. Enable Monitoring ...................................................................................................... 109
39.4. Collecting Information from Non-Default Microsoft SQL Server Instances ....................... 109
39.5. Daemons ................................................................................................................... 110
Multi-Realm IP Networks ....................................................................................................... 111
40.1. About ........................................................................................................................ 111
40.2. Prerequisites .............................................................................................................. 111
40.3. Example System ........................................................................................................ 111
40.4. System Setup ............................................................................................................ 112
40.4.1. Adding Realms ............................................................................................... 112
40.4.2. Adding Collectors to Realms ............................................................................ 113
40.4.3. Adding Devices to Realms ............................................................................... 115
40.5. Notes ........................................................................................................................ 117
NetApp Filers ....................................................................................................................... 118
41.1. About ........................................................................................................................ 118
41.2. Prerequisites .............................................................................................................. 118
41.3. Enable Monitoring ...................................................................................................... 118
41.3.1. Configuring NetApp Devices to Allow SNMP Queries ......................................... 118
viii
Zenoss Extended Monitoring
42.
43.
44.
45.
46.
47.
48.
49.
41.3.2. Configuring Zenoss .........................................................................................
41.4. Daemons ...................................................................................................................
NetScreen Devices ...............................................................................................................
42.1. About ........................................................................................................................
42.2. Prerequisites ..............................................................................................................
42.3. Enable Monitoring ......................................................................................................
42.3.1. Configuring NetScreen Devices to Allow SNMP Queries ....................................
42.3.2. Configuring Zenoss .........................................................................................
42.4. Daemons ...................................................................................................................
Nortel Devices ......................................................................................................................
43.1. About ........................................................................................................................
43.2. Prerequisites ..............................................................................................................
43.3. Enable Monitoring ......................................................................................................
43.3.1. Configuring Nortel Devices to Allow SNMP Queries ...........................................
43.3.2. Configuring Zenoss .........................................................................................
43.4. Daemons ...................................................................................................................
Oracle ..................................................................................................................................
44.1. About ........................................................................................................................
44.2. Prerequisites ..............................................................................................................
44.3. Enable Monitoring ......................................................................................................
44.3.1. Authorize Oracle Performance Data Access ......................................................
44.3.2. Configure Zenoss ............................................................................................
44.4. Monitor Multiple SIDs without DNS Aliases ..................................................................
44.5. Monitor Multiple SIDs with DNS Aliases ......................................................................
44.6. Daemons ...................................................................................................................
Predictive Thresholding .........................................................................................................
45.1. About ........................................................................................................................
45.2. Prerequisites ..............................................................................................................
45.3. Add a Predictive Threshold ........................................................................................
RANCID Integration ..............................................................................................................
46.1. About ........................................................................................................................
46.2. Prerequisites ..............................................................................................................
46.3. Enable Integration ......................................................................................................
46.3.1. Configure Cisco Devices to Send Traps ...........................................................
46.3.2. Configure RANCID Update Information in Zenoss .............................................
Remedy Ticket Creation ........................................................................................................
47.1. About ........................................................................................................................
47.2. Prerequisites ..............................................................................................................
47.3. Enable Ticket Creation ...............................................................................................
47.4. Send Test Tickets ......................................................................................................
47.5. Daemons ...................................................................................................................
SNMP Trap Forwarding ........................................................................................................
48.1. About ........................................................................................................................
48.2. Prerequisites ..............................................................................................................
48.3. Enable Event Forwarding ...........................................................................................
48.3.1. Import Zenoss MIB onto the Remote Receiver ..................................................
48.3.2. Configure Zenoss to Send Events as Traps ......................................................
48.4. Send Test Events ......................................................................................................
48.5. Daemons ...................................................................................................................
Solaris ..................................................................................................................................
49.1. About ........................................................................................................................
49.2. Prerequisites ..............................................................................................................
49.3. Limitations .................................................................................................................
49.4. Set Solaris Server Monitoring Credentials ...................................................................
49.5. Enable Monitoring ......................................................................................................
49.6. Resolving CHANNEL_OPEN_FAILURE Issues ............................................................
49.7. Resolving Command time out Issues ..........................................................................
49.8. Daemons ...................................................................................................................
ix
118
119
120
120
120
120
120
120
120
121
121
121
121
121
121
121
122
122
122
122
122
122
123
123
124
125
125
125
125
126
126
126
126
126
126
128
128
128
128
128
128
129
129
129
129
129
129
130
130
131
131
131
131
131
132
132
133
133
Zenoss Extended Monitoring
50. SQL Transactions .................................................................................................................
50.1. About ........................................................................................................................
50.2. Prerequisites ..............................................................................................................
50.3. Enable SQL Server Monitoring ...................................................................................
50.4. Enable Sybase Server Monitoring ...............................................................................
50.5. Enable MySQL Server Monitoring ...............................................................................
50.6. Storing Query Results ................................................................................................
50.7. Daemons ...................................................................................................................
51. Sugar CRM ..........................................................................................................................
51.1. About ........................................................................................................................
51.2. Prerequisites ..............................................................................................................
51.3. Enable Monitoring ......................................................................................................
51.3.1. Configuring Sugar CRM to Allow Queries .........................................................
51.3.2. Configuring Zenoss .........................................................................................
51.4. Daemons ...................................................................................................................
52. VMware Virtual Hosts ...........................................................................................................
52.1. About ........................................................................................................................
52.1.1. VMware Events ...............................................................................................
52.1.1.1. Migration Events ...................................................................................
52.2. Prerequisites ..............................................................................................................
52.3. Enable Monitoring ......................................................................................................
52.4. Viewing VMware Devices ...........................................................................................
52.5. Viewing Guest Virtual Machines ..................................................................................
52.6. Adding a Custom Metric .............................................................................................
52.7. Moving VMware Devices Between Collectors ..............................................................
52.8. Daemons ...................................................................................................................
52.8.1. Tuning Options ...............................................................................................
53. WebSphere Application Server ..............................................................................................
53.1. About ........................................................................................................................
53.2. Prerequisites ..............................................................................................................
53.3. Enable Monitoring ......................................................................................................
53.3.1. Configure WAS for Monitoring ..........................................................................
53.3.2. Zenoss ...........................................................................................................
53.4. Examples ..................................................................................................................
53.5. Daemons ...................................................................................................................
54. Web-Based Synthetic Transactions ........................................................................................
54.1. About ........................................................................................................................
54.1.1. Data Points .....................................................................................................
54.1.2. Event Generation ............................................................................................
54.2. Prerequisites ..............................................................................................................
54.3. Enable Monitoring ......................................................................................................
54.4. Creating twill Commands ............................................................................................
54.4.1. Creating twill Commands from TestGen4Web ...................................................
54.4.2. Creating twill Commands Manually ...................................................................
54.5. Monitoring through Proxy Servers ...............................................................................
54.5.1. Example Proxy Setup ......................................................................................
54.5.2. Testing the Proxy Setup ..................................................................................
54.6. Daemons ...................................................................................................................
55. Windows Performance ..........................................................................................................
55.1. About ........................................................................................................................
55.2. Prerequisites ..............................................................................................................
55.3. Enable Monitoring ......................................................................................................
55.3.1. Defining Windows Credentials ..........................................................................
55.3.2. Add Devices in Zenoss ....................................................................................
55.4. Monitor Other Performance Counters ..........................................................................
55.5. Testing Connections from Windows ............................................................................
55.6. Testing Connections from Zenoss ...............................................................................
55.7. Modify Registry Settings for Firewalls in Secure Environments ......................................
x
134
134
134
134
135
135
136
137
138
138
138
138
138
138
139
140
140
140
143
143
143
145
145
147
148
149
149
150
150
150
150
150
150
151
152
153
153
153
153
154
154
155
156
156
156
157
157
157
158
158
158
158
158
159
159
159
159
160
Zenoss Extended Monitoring
55.8. Configuring a Standalone Windows Device for a Non-Administrative Account .................
55.9. Tuning Collector Daemon Performance .......................................................................
56. Xen Virtual Hosts .................................................................................................................
56.1. About ........................................................................................................................
56.2. Prerequisites ..............................................................................................................
56.3. Model Hosts and Guest .............................................................................................
57. Zenoss Global Dashboard .....................................................................................................
57.1. About ........................................................................................................................
57.2. Prerequisites ..............................................................................................................
57.3. Configuration .............................................................................................................
57.3.1. Install the ZenGlobe Web Server .....................................................................
57.3.2. Configure Remote Zenoss for Monitoring ..........................................................
57.3.3. Configure ZenGlobe to Monitor Remote Zenoss Instances .................................
57.4. Viewing a Remote Zenoss Instance ............................................................................
57.5. Ending a Session .......................................................................................................
58. ZenOperator Role .................................................................................................................
58.1. About ........................................................................................................................
58.2. Prerequisites ..............................................................................................................
A. twill Commands Reference .............................................................................................................
A.1. About ..................................................................................................................................
A.2. Browsing .............................................................................................................................
A.3. Assertions ...........................................................................................................................
A.4. Display ................................................................................................................................
A.5. Forms .................................................................................................................................
A.6. Cookies ..............................................................................................................................
A.7. Debugging ..........................................................................................................................
A.8. Other Commands ................................................................................................................
A.9. Details on Form Handling ....................................................................................................
A.10. ZenWebTx Extensions to twill ............................................................................................
A.10.1. twilltiming ...............................................................................................................
A.10.2. twillextract ..............................................................................................................
A.10.3. twillxpathextract ......................................................................................................
A.10.4. ignorescripts ...........................................................................................................
xi
160
164
165
165
165
165
166
166
166
166
166
167
167
167
167
168
168
168
169
169
169
169
169
170
170
170
170
171
172
172
173
173
173
Chapter 1. ZenPacks
1.1. Introduction to ZenPacks
ZenPacks are a mechanism for extending and modifying Zenoss. This can be as simple as adding new device
classes or performance templates, or as complex as extending the data model and providing new collection
daemons. ZenPacks can be distributed for installation on other Zenoss systems. Simple ZenPacks can be created completely within the Zenoss user interface; more complex ZenPacks require development of scripts or
daemons in Python or another programming language. ZenPacks also can be used to package your customizations to multiple Zenoss servers.
For example, say you have developed a performance template for a new piece of hardware. You have created
data sources for the OID's you think are worth monitoring, thresholds to make sure some of these values stay
within reasonable limits, and several graph definitions to show this data graphically. Perhaps you also have
created a new device class for this hardware. You can create a ZenPack to easily distribute your performance
template and device class to other Zenoss administrators. This ZenPack can be entirely created from within
the Zenoss user interface.
1.2. Installing ZenPacks
ZenPacks are distributed as .egg files.
You can install ZenPacks from the command line on the Zenoss server, or from the Zenoss user interface.
1.2.1. Installing from the Command Line
The following ZenPack command can be used from the command line to install ZenPack files. After installing
or updating ZenPacks you need to restart Zenoss:
zenpack --install <filename>
zenoss restart
If you have the source code for the ZenPack you can install directly from that rather than from a .egg file. The
command is the same, you just specify the directory containing the source code. This copies the source code
into either $ZENHOME/ZenPacks (for newer egg ZenPacks) or $ZENHOME/Products (for older style ZenPacks.)
zenpack --install <directoryname>
zenoss restart
If you are developing a ZenPack you usually will want to maintain your source code outside of $ZENHOME/ZenPacks or $ZENHOME/Products. This is advisable for two reasons. First, if you issue a zenpack --remove command it will delete your code from either of those two locations and you would lose your files unless you had
them backed up elsewhere. Second, if you are maintaining your source code in a version control system it is
frequently more convenient to have the files reside elsewhere on the file system. Using the --link option you
can install the ZenPack but have Zenoss use your code from its current location. Instead of installing your code
in $ZENHOME/ZenPacks or $ZENHOME/Products Zenoss will create a link in one of those locations that points to
your source code directory.
zenpack --link --install <directoryname>
zenoss restart
1.2.2. Installing from the User Interface
You can upload and install a ZenPack .egg file from the user interface. To do this:
1. From the navigation menu, select Settings.
2. Click the ZenPacks tab.
3. From the Loaded ZenPacks table menu, select Install ZenPack.
1
ZenPacks
The Install ZenPack dialog appears.
4. Browse to and select the .egg file you want to install, and then click OK.
The file is uploaded to the Zenoss server and installed.
After installing the ZenPack, you should restart Zenoss.
1.2.3. Installing All Core ZenPacks from RPM
The Zenoss Core ZenPacks, along with third party ZenPacks, are available for download individually from
SourceForge. Also on that page is a link to download an RPM that includes the most popular Core ZenPacks.
To install via the Core ZenPacks RPM follow these steps:
1. Download the appropriate file from the Zenoss ZenPacks download area specific to your version.
2. Make sure Zenoss is running (as the zenoss user):
zenoss start
3. Install the RPM (as root user):
rpm -ihv <rpm file>
1.3. Creating a ZenPack
When logged into Zenoss as an Administrator click on the Setting link and then on the ZenPacks tab. Select the "Create a ZenPack..." menu item. You will get a dialog asking for a name for your new ZenPack.
The name must be of the form ZenPacks.Organization.Identifier, where Organization is a name that identifies
you or your organization and Identifier is a string that represents the intent of your ZenPack. For example,
ZenPacks.zenoss.HttpMonitor was created by Zenoss to help monitor HTTP sites. Once you have entered a
name click the save button. This creates both the ZenPack object in the database as well as a new directory
in the file system $ZENHOME/ZenPacks/YourZenPackID.
Many types of objects can be added to a ZenPack via the user interface. Some examples are:
•
Device Classes
•
Event Classes
•
Event Mappings
•
User Commands
•
Event Commands
•
Service Classes
•
Device Organizers
•
Performance Templates
Devices are the conspicuous omission from this list. Any individual Device is usually specific to a particular site
and therefore not likely to be useful to other Zenoss users.
To add one of these database objects to a ZenPack navigate to that object and use the "Add to ZenPack..."
menu item. Zenoss will present a dialog which lists all installed ZenPacks. Select the ZenPack to which you
want to add this object and click the Add button. To view the objects that are part of a ZenPack navigate to the
Settings page then the ZenPacks tab. Click on the name of the ZenPack and you will see a page that lists both
the files and the objects that are part of this ZenPack. You can remove objects from the ZenPack by selecting
the checkboxes next to them and using the "Delete from ZenPack..." menu item.
ZenPacks can contain items that are not Zeo database items, such as new daemons, Data Source types, skins,
etc. These are added to a ZenPack by placing them in the appropriate subdirectory within the ZenPack's directory. See the Core ZenPacks for examples of how to incorporate such items into your ZenPack. Further information regarding ZenPack development is available in the Zenoss Developer's Guide.
2
ZenPacks
Discussion regarding development of ZenPacks takes place on the zenoss-dev mailing list and forums
1.3.1. Packaging and Distributing Your ZenPack
To create the installable .egg file for a ZenPack use the "Export ZenPack..." menu item in the page menu when
viewing a ZenPack. The dialog that follows has two options. The first option simply exports the ZenPack to a
file named <ZenPackId>.egg in the $ZENHOME/exports directory on the Zenoss server. The second option does
the same but then downloads the exported file to your browser. Other Zenoss administrators can install this
exported .egg file as described in the Installing ZenPacks section.
For information on how to make your ZenPack available on the zenoss.com site see these instructions.
1.4. Displaying Installed ZenPacks
From the command line you can display installed ZenPacks and their current state with the following command:
zenpack --list
To display the list of installed ZenPacks inside the Zenoss GUI, follow this procedure:
1. From the navigation bar, click Settings.
2. Click the ZenPacks tab.
1.5. Removing a ZenPack
1. Perform a backup of your Zenoss data before removing a ZenPack. See Section "Backup and Restore" in
Zenoss Administration for information on how to back up your Zenoss data.
2. A ZenPack that installed a device class will remove both the device class and all devices within that class.
Therefore, check if the ZenPack creates a device class:
a. From the navigation bar, select Settings.
b. Select the ZenPacks tab.
c. Select the ZenPack that you want to remove.
d. In the ZenPack Provides table, look for entries that start with /Devices/. If listed, then you must go to
that device class and ensure that any devices it contains can be deleted. If a device cannot be moved
or deleted, then do not remove the ZenPack.
3. Delete any data sources provided by the ZenPack. In the ZenPack Provides table, look for entries that
contain the word datasources.
4. From the ZenPacks tab under Settings, select the ZenPack that you want to remove.
5. From the table menu, select Delete ZenPacks.
6. Click OK.
7. Restart Zenoss.
Removing a ZenPack may have unexpected consequences. For example, removing a ZenPack that installed
a device class will remove all devices in the class.
3
Part I. Core ZenPacks
Chapter 2. Amazon Web Services
2.1. About
The Amazon Web Services™ (AWS™) ZenPack allows you to monitor Amazon Elastic Compute Cloud™ (Amazon EC2™) server instances. It collects information for these objects monitored through Amazon's CloudWatch
APIs:
•
Account
•
Instance
•
Instance Type
When you install the ZenPack, the /AWS/EC2 device class is added to your Zenoss instance. A single device
in the EC2 class, EC2Manager, represents your EC2 account. All instances and instance types are contained in
the EC2 account manager.
2.2. Prerequisites
You must have a valid Amazon Web Services account with the Elastic Compute Cloud service enabled.
The Zenoss server time must be correct; otherwise, no performance data will be returned.
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.5 or higher
Required ZenPacks
AWS
Table 2.1. Prerequisites
2.3. Setup
To set up the EC2 account manager in Zenoss, follow these steps:
1. Retrieve your Amazon EC2 access credentials.
a. Browse to http://aws.amazon.com.
b. Select Security Credentials from the Your Account list of options.
The Access Key ID and Secret Access Key values appear on the Access Keys tab.
Figure 2.1. Access Credentials
5
Amazon Web Services
2. Enter the access credentials on the Edit page for the EC2Manager account.
Figure 2.2. Enter Credentials
3. Model the EC2Manager account to retrieve the Instance and InstanceType objects.
2.4. Working with the EC2Manager Account
The Instances tab on the manager shows each instance that is active in your Amazon EC2 account. Click an
instance to view detailed information.
The Instance Type field is a link to a type object that references all instances of a particular type.
Figure 2.3. Instance Status
2.4.1. CloudWatch Data
Amazon provides monitoring information through its CloudWatch APIs. These APIs provide monitoring information for each of their primary objects (Account, Instance, and Instance Type).
Metrics provided by the API are:
•
CPU utilization
•
Network in/out
•
Disk bytes read/write
•
Disk operations read/write
The metrics for an instance apply directly for the instances; for example, if an instance shows 100% CPU utilization, then its CPU is at maximum. However, for an instance type, 100% CPU utilization means that all in-
6
Amazon Web Services
stances within that type are at 100% CPU utilization. The same is true for the account; metrics are summed
for all instances.
Zenoss collects monitoring information for the Account, Instance, and Instance Type objects. Account information appears on the Perf tab. Instance and Instance Type information appears on their main screens.
2.4.2. Templates and Collection
Zenoss uses the standard monitoring template system to configure EC2 Manager accounts. Each template
relies on a custom ZenCommand, zencw2, that polls the CloudWatch API and returns all available parameters.
These parameters are used by their associated graphs. You can set thresholds against the parameters.
Templates for each primary object type are defined in the /AWS/EC2 class.
Object Type
Template
Account
EC2Manager
Instance
EC2Instance
Instance Type
EC2InstanceType
Table 2.2. Primary Object Type Templates
2.4.2.1. Example: Initiating Load-Based Elasticity for an EC2 Setup
Suppose you want to use Zenoss to initiate load-based elasticity for your EC2 setup. For example, each time
the account CPU exceeds 80%, you want Zenoss to create a new instance. To set up this scenario, you would
first set up and model your account. Then, you would follow these steps:
1. Go to the account monitoring template (/AWS/EC2/Templates/EC2Manager).
2. Add a threshold against the zencw2_CPUUtilization CPU Utilization data point, and then set its event class
to /Perf/CPU.
Figure 2.4. Add Threshold
Each time the CPU exceeds the threshold, Zenoss creates an event with the device name EC2Manager
in the /Perf/CPU class.
3. Create an event command that matches this event, and launch the EC2 command to create the new instances.
7
Amazon Web Services
Figure 2.5. Create Event Command
When the event is initiated, the new instances will be created.
The clear command can be used to shut down unneeded instances.
8
Chapter 3. Apache Web Server
3.1. About
The ApacheMonitor ZenPack provides a method for pulling performance metrics from the Apache Web server
directly into Zenoss, without requiring the use of an agent. This is accomplished by using Apache's mod_status
module that comes with Apache Version 1 and 2.
The following metrics are collected and graphed for the Apache HTTP server.
•
Requests per Second
•
Throughput (Bytes/sec and Bytes/request)
•
CPU Utilization of the HTTP server and all worker processes or threads
•
Slot Usage (Open, Waiting, Reading Request, Sending Reply, Keep-Alive DNS Lookup, and Logging)
3.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ApacheMonitor
Table 3.1. Apache Prerequisites
3.3. Enable Monitoring
3.3.1. Display the Status Page in Apache Version 1.3 or higher
1. On the Apache server, locate the httpd.conf file. Generally, this file is located at /etc/httpd/httpd.conf or
/etc/httpd/conf/httpd.conf; however, other locations are possible depending on your operating system
and setup.
If you cannot locate the configuration file, use your system's search facilities to locate it. For Windows, use
the Search button of the Windows Explorer tool. For Unix, try the following command:
find / -name httpd.conf
2. Check to see that the following line is not commented out and is available in httpd.conf or /etc/apache/
modules.conf:
LoadModule status_module /usr/lib/apache/1.3/mod_status.so
You may have to search in alternate locations to find the mod_status.so file. Also, the syntax may differ
depending on your configuration.
3. Turn the ExtendedStatus option on in the httpd.conf file. This option is typically commented out. You can
enable it by uncommenting it or ensuring that it is defined.
#ExtendedStatus on
becomes:
ExtendedStatus on
4. Enable the /server-status location in the httpd.conf file. Typically, this option exists but is commented out.
#<Location /server-status>
#
SetHandler server-status
#
Order deny,allow
9
Apache Web Server
#
Deny from all
#
Allow from .example.com
#</Location>
becomes:
<Location /server-status>
SetHandler server-status
Order deny,allow
Deny from all
Allow from zenoss.example.com
</Location>
Your Zenoss server or servers must be able to connect to your Apache server. Ensure that it is listed
here or is part of the network specified in this chunk of configuration.
To specify multiple servers, separate the entries with spaces. If you specify an IP address range rather
than a destination, be sure to add a network mask to the end of the IP address range.
The following example allows a server called externalzenoss.example.com, as well as all servers that
start with 192.168.10, in their addresses:
<Location /server-status>SetHandler server-status
Order deny,allow
Deny from all
Allow from externalzenoss.example.com 192.168.10.0/24
</Location>
5. Save the httpd.conf file with these changes and verify that the configuration file is correct. This can be
accomplished with following command.
apachectl -t
Correct any issues before restarting Apache.
6. Restart the Web server (httpd). This can be accomplished with following command.
apachectl restart
3.3.2. Display the Status Page in Apache Version 2.x
1. On the Apache server, find the httpd.conf file. This is usually /etc/apache2/apache2.conf or /etc/apache2/
conf/httpd.conf; however, other locations are possible depending on your operating system and setup.
If you are unsure about where your configuration file is located, use your system;s search facilities to locate
this file. Under Windows, use the Search button of the Windows Explorer tool. Under Unix, try the following
command:
find / -name httpd.conf
2. Verify that the mod_status module is loaded.
apache% apachec2ctl -M 2<&1 | grep status
status_module (shared)
The previous output indicates that the module is loaded and no further configuration is necessary. If there
is no output, then copy the mods-available/status.load to the mods-enabled directory, and then run:
apache% /etc/init.d/apache2 force-reload
3. Turn the ExtendedStatus option on in the httpd.conf file. This option is typically commented out. You can
enable it by uncommenting it or ensuring that it is defined.
#ExtendedStatus on
becomes:
ExtendedStatus on
10
Apache Web Server
4. Enable the /server-status location in the httpd.conf file. This is another option that typically already exists
but is commented out.
#<Location /server-status>
#
SetHandler server-status
#
Order deny,allow
#
Deny from all
#
Allow from .example.com
#</Location>
becomes:
<Location /server-status>
SetHandler server-status
Order deny,allow
Deny from all
Allow from zenoss.example.com
</Location>
Your Zenoss server or servers must be able to connect to your Apache server so you must ensure that
it is either listed here or is a part of the network specified in this chunk of configuration.
To specify multiple servers, separate the entries with spaces. If you would like to specify an IP address
range rather than a destination, be sure to add a network mask to the end of the IP address range. The
following example allows a server called externalzenoss.example.com as well as all servers that start
with '192.168.10' in their addresses:
<Location /server-status>SetHandler server-status
Order deny,allowDeny from all
Allow from externalzenoss.example.com 192.168.10.0/24
</Location>
5. Save the httpd.conf file with these changes and verify that the configuration file is correct. This can be
accomplished with following command.
apache2ctl -t
Correct any issues before restarting Apache.
6. Restart the webserver (httpd). This can be accomplished with following command.
apache2ctl restart
3.3.3. Verifying your Apache configuration
Once Apache has been configured, you should verify that it is working correctly. To verify your Apache server,
point your Web browser to your Apache server at the appropriately modified URL:
http://your-apache-server/server-status?auto
This is an example of what you might see:
Total Accesses: 1
Total kBytes: 2
Uptime: 43
ReqPerSec: .0232558
BytesPerSec: 47.6279
BytesPerReq: 2048
BusyWorkers: 1
IdleWorkers: 5
Scoreboard: _W____................................
If there is a configuration issue, you should see an error message telling you that the page is forbidden.
Your Zenoss server or servers must be able to connect to your Apache server by using HTTP to receive
information. This means that the Zenoss server must be permitted not only by the Apache configuration
settings, but also by any firewalls or proxies between the Zenoss server and the Apache server, including
11
Apache Web Server
any firewall on the Apache server. If there are any proxies, they must be configured to allow the Zenoss
HTTP traffic through to Zenoss. Consult your network administrator and security officer to verify the firewall
configuration and your site's policies.
Further note that the name or IP address that your server has behind a firewall may be different than the IP
address (some form of Network Address Translation (NAT)) or name resolution (the way that the external
server resolves names may be through an Internet-visible DNS system rather than an intranet-only DNS
system).
3.3.4. Configure Zenoss to Monitor the Web Server
Once the Apache server is configured to allow Zenoss to access the extended status, you can add Apache
monitoring to the device within Zenoss by simply binding the Apache template to the device.
1. Navigate to the device in the Zenoss user interface.
2. Click the page menu, and then select More → Templates.
3. From the table menu select the Bind Templates... item to display the Bind Performance Templates dialog.
4. To add the Apache template and retain other performance templates, hold down the control key while clicking
on the Apache entry.
5. Click OK.
The Apache template should now be displayed under the Performance Templates for Device. You will now
be able to start collecting the Apache server metrics from this device.
6. Navigate to the Perf tab. You should see some placeholders for graphs (such as Apache - Requests, Apache
- Throughput). After approximately fifteen minutes, you should see the graphs start to become populated
with information.
3.4. Daemons
Type
Name
Performance Collector
zencommand
Table 3.2. Daemons
12
Chapter 4. Dell Hardware
4.1. About
The DellMonitor ZenPack provides custom modeling of devices running the Dell OpenManage agents. It also
contains hardware identification for Dell proprietary hardware. The information is collected through the SNMP
interface.
The following information is modeled:
•
Hardware Model
•
Hardware Serial Number
•
Operating System
•
CPU Information (socket, speed, cache, voltage)
•
PCI Card Information (manufacturer, model)
4.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.DellMonitor
On each remote device
The Dell OpenManage SNMP Agent is used to gather information about the device.
Table 4.1. Dell Hardware Prerequisites
4.3. Enable Enhanced Modeling
1. Navigate to the device or device class.
2. Click the page menu, and then select More → Collector Plugins.
3. Click Add Fields to reveal the list of plugins.
4. Select the following plugins, and then drag them to the list of plugins.
•
DellCPUMap
•
DellDeviceMap
•
DellPCIMap
5. Remove the following plugins by clicking on the 'X' button located at the right side of the plugin.
•
zenoss.snmp.CPUMap
•
zenoss.snmp.DeviceMap
6. Click Save to save the updates.
7. Remodel the device using these new plugins by selecting Manage → Model Device from the page menu.
4.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 4.2. Daemons
13
Chapter 5. Distributed Name Server (DNS)
5.1. About
DigMonitor monitors the response time of DNS lookups for devices running a DNS server.
5.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.DigMonitor
Table 5.1. DNS (DigMonitor) Prerequisites
5.3. Enable Monitoring
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → Templates.
3. From the table menu, select Bind Templates... to display the Bind Performance Templates dialog.
4. To add the DigMonitor template and retain other performance templates, hold down the control key while
clicking on the DigMonitor entry.
5. Click OK.
The DigMonitor template should now be displayed under the Performance Templates for Device.
6. Select the DigMonitor template and change options as needed. Click Save to save your changes.
Option
Description
DNS Server
the nameserver against which the dig command should be run
Port
The port on which the nameserver is listening. This is normally
port 53.
Record Name
The name of the record you wish to look up
Record Type
The DNS record type (e.g. A, MX, CNAME).
Table 5.2. DigMonitor Data Source Options
7. Navigate to the Perf tab. You should see some placeholders for graphs. After approximately fifteen minutes
you should see the graphs start to become populated with information.
5.4. Daemons
Type
Name
Performance Collector
zencommand
Table 5.3. Daemons
14
Chapter 6. File Transfer Protocol (FTP)
6.1. About
The FTPMonitor ZenPack monitors connection response time to an FTP server.
6.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.FTPMonitor
Table 6.1. FTP Prerequisites
6.3. Enable Monitoring
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → Templates.
3. From the table menu, select Bind Templates.
The Bind Performance Templates dialog appears.
4. To add the FTPMonitor template and retain other performance templates, hold down the control key while
clicking on the FTPMonitor entry.
5. Click OK.
The FTPMonitor template should now be displayed under the Performance Templates for Device.
6. Click the FTPMonitor template and change options as needed. Click Save to save your changes.
Option
Description
Port
The port to connect to FTP server (default 21)
Send String
Command string to send to the server
Expect String
A string to expect in server response
Mismatch
If the expected string does not match the string returned from
the remote server, create an event with one of these states: ok,
warn, crit (default: warn)
Quit String
Command to send to the remote server to end the session
Table 6.2. FTPMonitor Basic Data Source Options
7. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
6.4. Enable Secure Site Monitoring
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → Templates.
3. Select the FTPMonitor template and change options as needed. Click Save to save your changes.
15
File Transfer Protocol (FTP)
Option
Description
Port
The port to connect to FTP server (default 21).
Certificate
Minimum days for which a certificate is valid
Use SSL
Use SSL for the connection
Table 6.3. FTPMonitor Secure Data Source Options
6.5. Tuning for Site Responsiveness
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → Templates.
3. Select the FTPMonitor template and change options as needed. Click Save to save your changes.
Option
Description
Timeout
Seconds before connection times out (default: 60)
Refuse
If a TCP/IP connection to the remote service is refused (ie no
program is listening at that port) send an event with one of
these severity states: ok, warn, crit (default: crit)
Max Bytes
Close the connection once more than this number of bytes are
received.
Delay
Seconds to wait between sending string and polling for response
Warning response time (seconds)
Response time to result in a warning status.
Critical response time (seconds)
Response time to result in critical status
Table 6.4. FTPMonitor Tunables Data Source Options
6.6. Daemons
Type
Name
Performance Collector
zencommand
Table 6.5. Daemons
16
Chapter 7. HP PC Hardware
7.1. About
HPMonitor provides custom modeling of devices running the HP Insight Management Agents. It also contains
hardware identification for HP proprietary hardware. The information is collected through the SNMP interface.
The following information is modeled:
•
Hardware Model
•
Hardware Serial Number
•
Operating System
•
CPU Information (socket, speed, cache)
7.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.HPMonitor
On each remote device
The HP Insight SNMP Management Agent gathers information
about the device.
Table 7.1. HP PC Hardware Prerequisites
7.3. Enable Enhanced Modeling
1. Navigate to the device or device class.
2. From the page menu, select More → Collector Plugins.
3. Click Add Fields to reveal the list of plugins.
4. Select the following plugins and drag them to the list of plugins:
•
HPCPUMap
•
HPDeviceMap
5. Remove the following plugins by clicking the 'X' button on the right side of the plugin:
•
zenoss.snmp.CPUMap
•
zenoss.snmp.DeviceMap
6. Click Save to save the updates.
7. Remodel the device using these new plugins by selecting Manage → Model Device from the page menu.
7.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 7.2. Daemons
17
Chapter 8. Internet Relay Chat (IRC)
8.1. About
ZenPacks.zenoss.IrcdMonitor monitors the number of users connected to an IRC server.
8.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.IrcdMonitor
Table 8.1. IRC Prerequisites
8.3. Enable Monitoring
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → Templates.
3. From the table menu, select Bind Templates to display the Bind Performance Templates dialog.
4. To add the IrcdMonitor template and retain other performance templates, hold down the control key while
clicking the IrcdMonitor entry.
5. Select the IrcdMonitor template and change options as needed. Click Save to save your changes.
Option
Description
Port
The port to connect to IRC server (default 6667).
warning_num
Create a warning event when this number of users are seen.
critical_num
Create a critical event when this number of users are seen.
Table 8.2. IRC Basic Data Source Options
6. Click OK.
The IrcdMonitor template should now be displayed under the Performance Templates for Device. You will
now be able to start collecting the IrcdMonitor server metrics from this device.
7. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
8.4. Daemons
Type
Name
Performance Collector
zencommand
Table 8.3. Daemons
18
Chapter 9. Jabber Instant Messaging
9.1. About
ZenPacks.zenoss.JabberMonitor monitors the response time of devices running a Jabber server.
9.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.JabberMonitor
Table 9.1. Jabber Prerequisites
9.3. Enable Monitoring
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → Templates.
3. From the table menu, select Bind Templates to display the Bind Performance Templates dialog.
4. To add the Jabber template and retain other performance templates, hold down the control key while clicking
on the Jabber entry.
5. Click on the Jabber template and change options as needed. Click Save to save your changes.
Option
Description
Timeout (seconds)
Seconds before connection times out (default: 60)
Port
The port on which the Jabber server is listening. Typically this is
port 5223.
Send String
string to send to the server : default
<stream:stream to='${dev/id}'
xmlns:stream='http://etherx.jabber.org/streams'>
Expect String
String to expect in server response.
<stream>
Table 9.2. Jabber Data Source Options
6. Click OK.
The Jabber template should now be displayed under the Performance Templates for Device. You can now
start collecting the Jabber server metrics from this device.
7. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
9.4. Daemons
Type
Name
Performance Collector
zencommand
Table 9.3. Daemons
19
Chapter 10. Java 2 Platform Standard
Edition (J2E)
10.1. About
ZenJMX is a ZenPack that allows Zenoss to communicate with remote Java Management Extensions (JMX)
agents. The ZenJMX ZenPack defines a data source named JMX that allows you to query any single or complex-value attribute, or invoke an MBean operation. It also comes with a built-in template named Java that contains MBean information for a few beans built into the JVM.
ZenJMX also includes a built-in template named ZenJMX. This template should only be used on the device
running the zenjmx daemon. To monitor other Java servers use the included Java template.
When the zenjmx daemon is started it communicates with ZenHub and retrieves a list of devices that possess
JMX data sources. It also spawns a Java process. ZenJMX asynchronously issues queries for each of those
devices to the Java process via XML-RPC. The Java process then collects the data from the Java application
and returns the results to ZenJMX. Any collection or configuration errors are sent as events to Zenoss and will
appear in the event console.
Lastly, ZenJMX heartbeats after each collect to ZenHub to let Zenoss know that ZenJMX is still alive and well.
10.1.1. JMX Background
The JMX technology is used throughout the Java Virtual Machine to provide performance and management
information to clients. Using a combination of JConsole (Sun Microsystems' JMX client that is shipped with the
JDK) and JMX, a system operator can examine the number of threads that are active in the JVM or change the
log level. There are numerous other performance metrics that can be gleaned from the JVM, as well as several
management interfaces that can be invoked that change the behavior of the JVM.
In Java 5, Sun introduced the Remote API for Java Management Extensions. This enhancement defines an RMI
wrapper around a JMX agent and allows for independent client development. ZenJMX accesses remote JMX
agents via the "Remote API for Java Management Extensions." It currently does not support local connections
(provided via the temporary directory) to JMX Agents.
10.1.2. ZenJMX Capabilities
ZenJMX is a full-featured JMX client that works "out of the box" with JMX agents that have their remote APIs
enabled. It supports authenticated and unauthenticated connections, and it can retrieve single-value attributes,
complex-value attributes, and the results of invoking an operation. Operations with parameters are also supported so long as the parameters are primitive types (Strings, booleans, numbers), as well as the object version
of primitives (such as java.lang.Integer and java.lang.Float). Multi-value responses from operations (Maps
and Lists) are supported, as are primitive responses from operations.
The JMX data source installed by ZenJMX allows you to define the connection, authentication, and retrieval
information you want to use to retrieve performance information. The IP address is extracted from the parent
device, but the port number of the JMX Agent is configurable in each data source. This allows you to operate
multiple JMX Agents on a single device and retrieve performance information for each agent separately. This is
commonly used on production servers that run multiple applications.
Authentication information is also associated with each JMX data source. This offers the most flexibility for site
administrators because they can run some JMX agents in an open, unauthenticated fashion and others in a
hardened and authenticated fashion. SSL-wrapped connections are supported by the underlying JMX Remote
subsystem built into the JDK, but were not tested in the Zenoss labs. As a result, your success with SSL encrypted access to JMX Agents may vary.
20
Java 2 Platform Standard Edition (J2E)
The data source allows you to define the type of performance information you want to achieve: single-value
attribute, complex-value attribute, or operation invocation. To specify the type of retrieval, you must specify an
attribute name (and one or more data points) or provide operation information.
Any numerical value returned by a JMX agent can be retrieved by Zenoss and graphed and checked against
thresholds. Non-numerical values (Strings and complex types) cannot be retrieved and stored by Zenoss.
When setting up data points, make sure you understand the semantics of the attribute name and choose the
correct Zenoss data point type. Many JMX Agent implementations use inconsistent nomenclature when describing attributes. In some cases the term "Count" refers to an ever-increasing number (a "Counter" data point type).
In other cases the term "Count" refers to a snapshot number (a "Gauge" data point type).
10.1.3. Allowable Parameter Types
The following primitive data types are allowed in JMX calls:
•
java.lang.Integer
•
java.lang.Long
•
java.lang.Double
•
java.lang.Float
•
java.lang.String
•
java.lang.Boolean
•
int
•
long
•
double
•
float
•
boolean
10.1.4. Single Value Attribute Calls
This is the most basic usage scenario. If you are interested in retrieving a single value from an MBean in a JMX
Agent, and the attribute returns simple numeric data, you fall into the "single value attribute" category. To define
a single-value attribute call simply provide the fully qualified name of your MBean and then provide the name of
the attribute in the Attribute Name field of the data source. Lastly, you must define a data point.
Some examples of this include the commonly referenced JDK Threading information:
•
MBean Name: java.lang:type=Threading
•
Attribute Name: ThreadCount
•
Data Points:
•
ThreadCount (type: gauge)
Java uses lots of file descriptors during normal operation. The number of open file descriptors the JVM is working
with can be measured using the following information:
•
MBean Name: java.lang:type=OperatingSystem
•
Attribute Name: OpenFileDescriptorCount
•
Data Points:
•
OpenFileDescriptorCount (type: gauge)
There are several other single-value attributes that can be retrieved from the JDK. We recommend using JConsole to interactively navigate through the MBean hierarchy to determine which MBeans contain useful information to you. See Section 10.5, “Using JConsole to Query a JMX Agent” for additional information on how to
inspect the MBeans deployed in an JMX Agent.
21
Java 2 Platform Standard Edition (J2E)
10.1.5. Complex-Value Attribute Calls
If your MBean attribute defines multiple sub-attributes (via CompositeData or Tabular) that you are interested
in capturing, then you fall into the category of a "complex-value attribute" call. The JDK contains a few complex-value attributes you might be interested in capturing, including garbage collection statistics that were captured during the copy and mark-sweep compact collection cycles.
To extract data from a complex-value attribute, you must define one or more data points in the data source.
The names of the data points are used as keys into the complex-value data structure returned from the MBean
attribute. For JMX CompositeData attributes, the data point names are used as a key to map the results. For
JMX TabularData, the data point names are used as indexes into the structure to map the result.
The JDK also provides heap memory information via a complex-value attribute. The amount of committed, used,
and maximum heap memory can be viewed by setting up a complex-value attribute in Zenoss with the following
information:
•
MBean Name: java.lang:type=Memory
•
Attribute Name: HeapMemoryUsage
•
Data Points:
•
committed (type: gauge)
•
used (type: gauge)
•
max (type: gauge)
10.1.6. Example Method Calls
Some management values need to be computed. These situations frequently arise when custom MBeans are
deployed alongside an enterprise application. An MBean named "Accounting" might be deployed within an
enterprise application that defines operations intended for operators or support staff. These operations might
include methods such as "getBankBalance()" or "countTotalDeposits()".
ZenJMX has the ability to invoke operations, but there are some subtleties in how ZenJMX sends parameters
to the JMX Agent and interprets the response.
10.1.6.1. No parameters, single return value
In the most basic usage scenario no arguments are passed to the operation and a single value is returned. This
usage scenario is very similar to a single-value attribute call, except we're invoking an operation to retrieve the
value rather than accessing an attribute. The configuration for this hypothetical usage scenario follows:
•
MBean Name: Application:Name=Accounting,Type=Accounting
•
Operation Name: getBankBalance()
•
Data Points:
•
balance (type: gauge)
10.1.6.2. No parameters, multiple values returned in List format
In this scenario no parameters are passed to an operation, but multiple response values are provided in a List.
The values returned are expressed in a List<Object>, but they are coerced (but not casted) to doubles prior to
being stored in Zenoss. This means that returning a numeric value as "1234" will work, but "1,234" will not work.
The litmus test is to evaluate if Double.valueOf(object.toString()) will successfully evaluate.
ZenJMX can be configured to read multiple values from an operation's results by defining multiple data points.
You must define a data point for each value returned from the operation, and if there is a mismatch between
the number of data points you define and the size of the List<Object> returned an exception will be generated.
The configuration for ZenJMX follows:
•
MBean Name: Application:Name=Accounting,Type=Accounting
22
Java 2 Platform Standard Edition (J2E)
•
Operation Name: getBalanceSummary()
•
Data Points:
•
dailyBalance (type: gauge)
•
annualBalance (type: gauge)
10.1.6.3. No parameters, multiple values returned in Map format
In this scenario no parameters are passed to an operation, but multiple response values are provided in a
Map<String, Object>. The keyset of the Map contains the names of data points that can be defined, and the
values are the values of said data points. When a Map<String, Object> is returned you need not capture all of
the returned values as data points, and you can instead pick the exact values you are interested in. To choose
the values to capture you simply define data points with the same names as Strings in the keyset.
The following configuration demonstrates how to extract specific data points from an operation that returns
a Map<String, Object>. The key item to note in this configuration is that "dailyBalance" and "annualBalance"
must be present as keys in the returned Map<String, Object> and their values must be coercible via the
Double.valueOf(object.toString()) idiom.
•
MBean Name: Application:Name=Accounting,Type=Accounting
•
Operation Name: getBalances()
•
Data Points:
•
dailyBalance (type: gauge)
•
annualBalance (type: gauge)
10.1.6.4. Single parameter in polymorphic operation
MBeans are implemented as Java classes and Java permits parameterized polymorphic behavior. This means
that multiple methods can be defined with the same name so long as their parameter signatures differ. You can
safely define "getBalance(String)" and "getBalance()" and the two exist as separate methods.
In order to properly resolve methods with the same name the caller must provide a Class[] that lists the types of
parameters that exist in the method's signature. This resolves the candidate methods to an individual method
which can then be invoked by passing an Object[].
ZenJMX allows you to resolve methods of the same name and asks you to provide the fully qualified class
names of each parameter in comma delimited format when you set up the data source. Note that primitive types
(String, Boolean, Integer, Float) are supported but complex types are not supported, and that you must include
the class' package name when providing the information (java.lang.String).
The Object[] of parameter values must line up with Class[] of parameter types, and if there is a mismatch in the
number of types and values that are provided an exception will be generated.
The marshaling of values from String to Boolean, Integer, and Float types is provided via the .valueOf() static
method on each of those types. That is, if you define an attribute of type java.lang.Integer you must provide
a String that can be successfully passed to java.lang.Integer.fromValue(). If you fail to do so an exception is
generated.
This example illustrates how to pass a single parameter to a polymorphic operation:
•
MBean Name: Application:Name=Accounting,Type=Accounting
•
Operation Name: getBalances()
•
Paramater Types: java.lang.Integer
•
Parameter Values: 1234
•
Data Points:
•
balance (type: gauge)
23
Java 2 Platform Standard Edition (J2E)
Here is another example where we've changed the type of the parameter passed to the method to be a String.
Semantically it represents a different type of Account in our example:
•
MBean Name: Application:Name=Accounting,Type=Accounting
•
Operation Name: getBalances()
•
Paramater Types: java.lang.String
•
Parameter Values: sbb552349999
•
Data Points:
•
balance (type: gauge)
10.1.6.5. Multiple parameters in polymorphic operations
The above example describes how polymorphic behavior in Java functions and how method resolution can be
provided by identifying the Class[] that represents the parameters passed to a method. The situation where
multiple parameters are passed to a polymorphic operation is no different then the situation where a single
parameter is passed to a polymorphic operation, except that the length of the Class[] and Object[] is greater
than one.
When multiple parameters are required to invoke an operation you must provide the fully qualified class names
of each parameter's type in comma delimited format, as well as the object values for each type (also in comma
delimited format).
The following example demonstrates a configuration that passes two parameters to an MBean operation. The
second parameter passed is a default value to return if no account can be located matching the first parameter.
•
MBean Name: Application:Name=Accounting,Type=Accounting
•
Operation Name: getBalances()
•
Parameter Types: java.lang.String, java.lang.Integer
•
Parameter Values: sbb552349999, 0
•
Data Points:
•
balance (type: gauge)
There are additional combinations that are possible with polymorphic methods and the values they return, and
those combinations are left as an exercise for the reader to explore. The logic for extracting results from multi-value operation invocations follows the same rules as the logic for extracting results from a multi-value attribute
read. For additional information on the rules of that logic see the section above on multi-value attributes.
10.2. Prerequisites
Prerequisite
Restriction
Zenoss version
Zenoss version 2.2 or higher
Zenoss Product
All Zenoss products (Core, Pro, Enterprise)
Required ZenPacks
ZenPacks.zenoss.ZenJMX
Other
Sun JRE Version 5.0 or higher
Table 10.1. J2EE Prerequisites
10.2.1. Sun Java Runtime Environment (JRE)
ZenJMX requires Sun JRE Version 5.0 or higher. Make sure that after you install Sun's JRE you update your
PATH such that the java executable works. You can test this using the command:
$ which java
/usr/java/default/bin/java
If the above returns a fully qualified path, then you have successfully installed Java.
24
Java 2 Platform Standard Edition (J2E)
If Java is not installed, the which will return a message similar to the following:
$ which java
/usr/bin/which: no java in (/usr/local/bin:/bin:/usr/bin:/opt/zenoss/bin)
To determine which version of Java is installed, run the following command:
$ java -version
java version "1.5.0_16"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_16-b06-284)
Java HotSpot(TM) Client VM (build 1.5.0_16-133, mixed mode, sharing)
Sun's Java version 5 (aka 1.5) must be installed. The GNU Java does not work.
Installing ZenJMX on an appliance
ZenJMX and Sun's JRE is installed using a conary command. As root, run the following command:
conary update --resolve group-zenjmx
10.3. Example to Monitor a JMX Value
10.3.1. Enabling Remote JMX Access
Each application server has a slightly different process for enabling remote JMX Access. It's best to consult
with your application server for specific instructions. We've included instructions for a few commonly used configurations below.
JMX agents can be configured in two ways: remote access and local-only. When configured for remote access a
JMX client communicates with the JMX agent via a socket and uses the Remote Method Invocation (RMI) protocol to access the MBeans. When configured for local-only access the JMX agent periodically dumps serialized
MBeans to a temporary directory on the machine. JConsole can be used to access JMX agents in local-only
mode as well as in remote mode (via RMI). ZenJMX can only be used with remote servers via RMI and cannot
work with local-only serialized MBeans. This is not a significant limitation because ZenJMX can establish RMI
connections to localhost just as easily as it can establish RMI connections to remote hosts.
The JAVA_OPTS environment variable can be used to enable remote access to JVM MBeans. Set it as follows:
JAVA_OPTS="-Dcom.sun.management.jmxremote.port=12345
JAVA_OPTS="${JAVA_OPTS} -Dcom.sun.management.jmxremote.authenticate=false"
JAVA_OPTS="${JAVA_OPTS} -Dcom.sun.management.jmxremote.ssl=false"
export JAVA_OPTS
When starting an application pass the JAVA_OPTS variable as an argument to the JVM as follows:
java ${JAVA_OPTS} -classpath /path/to/application.jar com.yourcompany.Main
You can then use JConsole to connect to localhost:12345. Authentication can be configured by modifying the
java.security file as well as java.policy. There are lots of examples available on the Internet that can provide
guidance in how to achieve authenticated remote access to JVM MBeans.
10.3.2. Configure Zenoss with a Custom Data Source
Custom JMX Data Sources allow system administrators to monitor any attribute or operation result accessible
via a JMX call. ZenJMX creates a JMX Data Source and allows you to provide Object information, as well as
authentication settings, and attribute/operation information. Determining which object and attribute names, as
well as which operations to invoke, is the key to customizing ZenJMX.
1. Navigate to the device or device class in the Zenoss web interface.
2. Click the page menu, then select More → Templates.
3. Create a performance template by selecting Add Template from the page menu.
4. Enter an identifier for the template (such as JVM Values) and then click OK to create it.
25
Java 2 Platform Standard Edition (J2E)
5. Click on the newly created template JVM Values.
6. Select Add DataSource... from the Data Sources table menu.
7. Enter a name for the data source (Heap Memory), select JMX as the type, and then click OK.
8. The Data Source page appears.
Change options as needed.
Option
Description
JMX Management Port
This is not necessarily the same as the listen port for your server.
Object Name
The Object Name is also referred to as the MBean name. Enter
java.lang:type=Memory
Attribute Name
Enter HeapMemoryUsage
Table 10.2. Memory Head Example ZenJMX Data Source Options
9. Click Save to save your changes.
10. Add data points named committed, max, and used.
a. Select Add DataPoint... from the DataPoints table menu.
b. Provide the name of the data point (ie one of committed, max, or used) and then click on the Add button.
c. As the default GAUGE is suitable for these data points, click on the Save to save the data point.
d. Click on your browser's back button to return to the template screen and add the next data point. Note
that you will need to refresh the browser screen in order to see the newly added data point.
11. Add graphs that reference these new data points. See the Zenoss Administration Guide for more details.
12. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
Please review Section 10.5, “Using JConsole to Query a JMX Agent” to learn how to determine the object name,
attribute name, and data points that might be interesting in your application.
10.4. Monitor Values in TabularData and CompositeData Objects
The Attribute Path input value on the ZenJMX data source allows you to monitor values nested in the TabularData
and CompositeData complex open data objects. Using this value you can specify a path to traverse and index
into these complex data structures.
If the result of traversing and extracting a value out of the nested open data is a single numeric value then it is
automatically mapped to the datapoint in the data source. However, if the value from the open data is another
open data object then the data point names from the datasource are used as indexes or keys to map values
out of the open data.
The input value is a dot-separated string that represents a path through the object. Non-bracketed values are
keys into CompositeData. Bracketed values are indexes into TabularData.
For TabularData indexes with more than one value, use a comma-separated list with no spaces (for example,
[key1,key2]).
To specify a column name (needed only when the table has more than two columns) use curly brackets after
the table index.
Example
To get the used Tenured Generation memory after the last garbage collection from the Garbage Collector
MBean, set the Attribute Name on the datasource to lastGcInfo. Set the Attribute Path to:
26
Java 2 Platform Standard Edition (J2E)
memoryUsageAfterGc.[Tenured Gen].{value}.used
The key memoryUsageAfterGc is evaluated against the CompositeData returned from the lastGcInfo attribute.
The evaluation results in a TabularData object. Then, the [Tenured Gen] index is evaluated against the TableData, which returns a row in the table.
Since a row in the table can contain multiple columns, the key value (in curly brackets) is used to pick a column in
the row. Lastly, the key used is evaluated against the CompositeData in the column to return the memory value.
In this example, since the index being used for the tabular data is not a multi-value index and so the column
name is optional. The Attribute Path can be written as:
memoryUsageAfterGc.[Tenured Gen].used
10.5. Using JConsole to Query a JMX Agent
JConsole is a tool built into the JDK that allows system administrators to query a JMX Agent and examine the
MBeans deployed within the server. JConsole also allows administrators to view JVM summary information,
including the amount of time the JVM has been running, how many threads are active, how much memory is
currently used by the heap, how many classes are currently loaded, and how much physical memory exists
on the machine.
JConsole also provides a graph that shows memory, thread, and class usage over time. The scale of the
graph can be adjusted so that a system administrator can examine a specific period of time, or can zoom out
to view a longer range picture of usage. Unfortunately, JConsole can only produce graphs that show usage
while JConsole was running. Administrators cannot look back in time to a point where the JVM was running
but JConsole was not monitoring the JVM.
Figure 10.1. JMX Heap Graph
27
Java 2 Platform Standard Edition (J2E)
The MBeans tab along the top of JConsole provides an interactive method for examining MBean values. After
clicking on the MBeans tab a panel will be displayed with a tree on the left hand side. The tree contains a
hierarchical list of all MBeans deployed in the JVM.
The standard JVM MBeans are all in the java.lang and java.util.logging packages. Application server specific
MBeans do not follow any standard naming pattern. Some vendors choose to use package names for their
MBean names while other vendors choose package-like names (but not fully qualified packages).
To get started expand the java.lang node in the Tree. This will expose several MBeans as well as additional
folders. Click on the Memory MBean and observe how the right hand side of the panel is populated with information about the Memory MBean.
Figure 10.2. Memory MBean
MBeans can contain attributes and operations. MBeans can also fire notifications to observers, but that's beyond the scope of this document. The attributes tab lists all of the attributes in the first column and their
values (or a clickable attribute type) in the second column. In the case of Memory the HeapMemoryUsage
is a Composite attribute, otherwise referred to as a "complex-value attribute" in Zenoss. Double click the
"javax.management.openmbean.CompositeDataSupport" type and you will see multiple attributes appear. The
show the amount of committed, maximum, and used memory sizes for the heap.
28
Java 2 Platform Standard Edition (J2E)
Figure 10.3. Memory MBean Expanded
The unique name of the MBean can be viewed by clicking on the Info tab. The first value is MBean Name. Its
value in the case of Memory is: "java.lang:type=Memory."
There is no standardized way to name MBeans; application server vendors name them differently.
You can also examine operation information by clicking on the Operations tab. These are methods that JConsole
can remotely invoke on an MBean that will result in some value being computed or some state changing in the
application. The Threading MBean has several operations that can be invoked that return information. Click on
the java.lang package and then click on the Threading operation. Lastly, click on the Operations tab. Methods
like "getThreadUserTime" are invocable.
29
Java 2 Platform Standard Edition (J2E)
Figure 10.4. Operations Tab
Test the "getThreadUserTime" method by changing the p0 parameter to 1 and clicking the "getThreadUserTime"
button. A dialog window will be raised that displays the amount of CPU user time thread #1 has used. Try
adjusting the parameter to different values to observe the different CPU times for the threads.
10.6. Daemons
Type
Name
Performance Collector
zenjmx
Table 10.3. Daemons
30
Chapter 11. Lightweight Directory Access
Protocol (LDAP) Response Time
11.1. About
ZenPacks.zenoss.LDAPMonitor monitors the response time of an LDAP server (in milliseconds).
11.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.LDAPMonitor
Table 11.1. LDAP Monitoring Prerequisites
11.3. Enable Monitoring
The LDAPServer template must be bound to the Device Class or Device you want to monitor.
1. Navigate to the device (or Device Class) that has an LDAP Server you want to monitor. (Add the device
if necessary.)
2. If applying changes to a device, select More → zProperties from the page menu.
If applying changes to a device class, click the zProperties tab.
3. Change the appropriate zProperties for your environment. Check with your LDAP administrator for more
information.
zProperty
Description
zLDAPBaseDN
The Base Distinguished Name for your LDAP server. Typically this is the organization's domain name (for example,
dc=foobar,dc=com)
zLDAPBindDN
The Distinguished Name to use for binding to the LDAP server,
if authentication is required
zLDAPBindPassword
The password to use for binding to the LDAP server, if authentication is required
Table 11.2. LDAPServer zProperties
4. Click Save to save your changes.
5. From the page menu, select More → Templates.
6. From the table menu, select Bind Templates to display the Bind Performance Templates dialog.
7. To add the LDAPServer template and retain other performance templates, hold down the control key while
clicking on the LDAPServer entry.
8. Click OK.
The LDAPServer template should now be displayed under the Performance Templates for Device.
9. Click on the LDAPServer template and change options as needed. Click Save to save your changes.
31
Lightweight Directory Access Protocol (LDAP) Response Time
Option
Description
Port
The port to connect to LDAP server (default 389)
Base Distinguished Name
Defaults to ${here/zLDAPBaseDN}
Bind Password
Defaults to ${here/zLDAPBindPassword}
Use SSL
Use SSL for the connection
Table 11.3. LDAPServer Basic Data Source Options
10. If your LDAP Servers require SSL or a custom port, then navigate to the LDAP Server template, choose the
ldap data source, and then change the Use SSL and Port fields as needed.
11. Validate your configuration by running zencommand and observing that the check_ldap or check_ldaps
command correctly connects to your LDAP server:
zencommand run -v10 -d yourdevicenamehere
12. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
11.4. Daemons
Type
Name
Performance Collector
zencommand
Table 11.4. Daemons
32
Chapter 12. MySQL Database
12.1. About
MySqlMonitor provides a method for pulling performance metrics from the MySQL database server directly into
Zenoss without requiring the use of an agent. This is accomplished by using the MySQL client library to connect
to the database remotely.
The following metrics are collected and graphed for MySQL server:
•
Command Statistics (SELECT, INSERT, UPDATE, DELETE)
•
Select Statistics (Scan, Range Check, Range Join, Full Join)
•
Handler Statistics (Keyed and Unkeyed Reads, Writes, Updates, Deletes)
•
Network Traffic (Received and Sent)
12.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.MySqlMonitor
Table 12.1. MySQL Prerequisites
12.3. Enable Monitoring
12.3.1. Authorize MySQL Performance Data Access
Follow these steps to set up your MySQL server to allow Zenoss to read performance data from the system
tables.
1. Connect to the MySQL database by using the MySQL client:
mysql -u root
Alternatively, if there is a MySQL root password:
mysql -u root -p
2. Create a user for Zenoss to use. The username "zenoss" is recommended.
mysql> CREATE USER zenoss IDENTIFIED BY 'zenossPassword';
Query OK, 0 rows affected (0.00 sec)
12.3.2. Zenoss
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → zProperties.
3. Edit the zMySqlRootPassword zProperty for the device or devices in Zenoss on which you want to monitor
MySQL.
4. Click Save to save your changes.
5. From the page menu, select More → Templates.
6. From the table menu, select Bind Templates to display the Bind Performance Templates dialog.
7. To add the MySQL template and retain other performance templates, hold down the control key while clicking
on the MySQL entry.
33
MySQL Database
8. Click OK.
The MySQL template should now be displayed under the Performance Templates for Device. You will now
be able to start collecting the MySQL server metrics from this device.
9. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
Pay particular attention to the MySQL Version 5+ setting in the data source. If you are monitoring prev5 installations of MySQL, then you must set this value to False. If you are monitoring pre-v5 and v5+
installations, then create two templates: one for MySQL installations earlier than v5 and another for those
after.
12.4. Daemons
Type
Name
Performance Collector
zencommand
Table 12.2. Daemons
34
Chapter 13. Network News Transport
Protocol (NNTP)
13.1. About
ZenPacks.zenoss.NNTPMonitor ZenPack monitors the response time of an NNTP server in milliseconds.
13.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.NNTPMonitor
Table 13.1. NNTP Prerequisites
13.3. Enable Monitoring
1. Navigate to the device in the Zenoss interface.
2. From the page menu, select More → Templates.
3. From the table menu, select Bind Templates to display the Bind Performance Templates dialog.
4. To add the NNTPMonitor template and retain other performance templates, hold down the control key while
clicking on the NNTPMonitor entry.
5. Click OK.
The NNTPMonitor template should now be displayed under the Performance Templates for Device.
6. Click on the NNTPMonitor template and change options as needed.
7. Validate your configuration by running zencommand and observing that the check_nntp or check_nntps
command correctly connects to your NNTP server:
zencommand run -v10 -d yourdevicenamehere
8. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
13.4. Daemons
Type
Name
Performance Collector
zencommand
Table 13.2. Daemons
35
Chapter 14. Network Time Protocol (NTP)
14.1. About
ZenPacks.zenoss.NtpMonitor monitors the offset between system time and a target NTP (Network Time Server)
server's time.
14.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.NtpMonitor
Table 14.1. NTP Prerequisites
14.3. Enable Monitoring
The NTPMonitor template must be bound to the device class or device you wish to monitor.
1. Navigate to the device (or device class) that has an NTP Server you want to monitor. (Add the device if
necessary.)
2. From the page menu, select More → Templates.
3. From the table menu, select Bind Templates to display the Bind Performance Templates dialog.
4. To add the NTPMonitor template and retain other performance templates, hold down the control key while
clicking on the NTPMonitor entry.
5. Click OK.
The NTPMonitor template should now be displayed under the Performance Templates for Device. You can
now start collecting the NTP server metrics from this device.
6. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
7. Choose the Templates options from the Server menu and then the Bind Template option, and bind the
NTPServer template to the device.
The next cycle of zencommand will collect offset data.
14.4. Daemons
Type
Name
Performance Collector
zencommand
Table 14.2. Daemons
36
Chapter 15. ONC-style Remote Procedure
Call (RPC)
15.1. About
ZenPacks.zenoss.RPCMonitor monitors the availability of an ONC RPC server.
15.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.RPCMonitor
Table 15.1. ONC RPC Prerequisites
15.3. Enable Monitoring
The RPCMonitor template must be bound to the device class or device you want to monitor.
1. Navigate to the device that has an RPC server that needs to be monitored. (Add the device if necessary.)
2. From the page menu, select More → zProperties.
3. Choose zProperties from the Server menu and set the appropriate RPC command to test in the zRPCCommand zProperty (for example, nfs or ypserv).
4. Click Save to save your changes.
5. From the table menu, select Bind Templates to display the Bind Performance Templates dialog.
6. To add the RPCServer template and retain other performance templates, hold down the control key while
clicking on the RPCServer entry.
7. Click OK.
The RPCServer template should now be displayed under the Performance Templates for Device. You can
now collect the RPCServer server metrics from this device.
8. If a specific port is being used, or the RPC PortMapper service is not available on the remote device, select
the RPCMonitor template and change the Port option as needed. The default is 0, which is a special value
that indicates to use the remote device's PortMapper.
9. Validate your configuration by running zencommand and observing that the check_rpc command correctly
connects to your RPC server:
zencommand run -v10 -d YourDeviceName
15.4. Daemons
Type
Name
Performance Collector
zencommand
Table 15.2. Daemons
37
Chapter 16. SSH Monitoring Example
16.1. About
The LinuxMonitor ZenPack demonstrates the new Secure Shell (SSH) features. This example ZenPack includes
functionality to model and monitor several types of device components for devices placed in the /Server/SSH/
Linux device class by running commands and parsing the output. Parsing of command output is performed on
the Zenoss server or on a distributed collector. The account used to monitor the device does not require root
access or special privileges.
This ZenPack is provided for developers as it provides some examples of how to create SSH performance
collecting plugins. See the Zenoss Developer's Guide for more information about the new SSH features.
16.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.4 or higher
Required ZenPacks
ZenPacks.zenoss.LinuxMonitor
Table 16.1. Linux SSH Monitoring Example Prerequisites
16.3. Set Linux Server Monitoring Credentials
All Linux servers must have a device entry in an organizer below the /Devices/Server/SSH/Linux device class.
The SSH monitoring feature will attempt to use key-based authentication before using a zProperties password value.
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, select More → zProperties from the page menu.
If applying changes to a device class, click the zProperties tab.
3. Verify the credentials for the service account.
Name
Description
zCommandUsername
Linux user with privileges to gather performance information.
zCommandPassword
Password for the above user.
Table 16.2. Linux zProperties
4. Click Save to save your changes.
16.4. Add a Linux Server
The following procedure assumes that the credentials have been set.
1. From the navigation bar, click on the Add Device item under the Management section.
2. Enter in the following information:
38
SSH Monitoring Example
Name
Description
Device Name
Linux host to model.
Device Class Path
/Server/SSH/Linux
Discovery Protocol
Set this to auto unless adding a device with a user name and
password different than found in the device class. If you set this
to none, then you must add the credentials (see Section 16.3,
“Set Linux Server Monitoring Credentials”) and then manually
model the device.
Table 16.3. Adding Linux device information
3. Click on the Add Device button to add the device.
16.5. Troubleshooting
To verify any queries, as well as any permissions or authentication issues, run the zensql.py command from
the command line. Here's an example against the MySQL database on a Zenoss server:
cd $ZENHOME/ZenPacks/*ZenSQLTx*/Z*/z*/Z*
./zensql.py -t mysql -H localhost -u zenoss -p zenoss -d events 'select \* from events.log;'
Queries completed successfully. | totalTime=54.5899868011
Single quotes (') are required around the SQL statement. Any wild card characters (such as *) must be
escaped, as shown in the previous example.
For the zensql.py command, the database types understood are shown in the following table.
Name
Database Type
mssql
MS SQL Server
sybase
Sybase
mysql
MySQL Server
Table 16.4. zensql.py Database Types
16.6. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zencommand
Table 16.5. Daemons
39
Chapter 17. Web Page Response Time
(HTTP)
17.1. About
ZenPacks.zenoss.HttpMonitor monitors connection response time to an HTTP server and determines whether
specific content exists on a Web page.
17.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.HttpMonitor
Table 17.1. HTTP Prerequisites
17.3. Enable Monitoring
1. Navigate to the device in the Zenoss interface.
2. From the table menu select the Bind Templates... item to display the Bind Performance Templates dialog.
3. To add the HttpMonitor template and retain other performance templates, hold down the control key while
clicking on the HttpMonitor entry.
Prior to Zenoss 2.4, this template was not available. If your Zenoss release is prior to Zenoss 2.4 you
must create the template, data source and graphs manually. See Zenoss Administration for more details
on these steps.
4. Click OK.
The HttpMonitor template should now be displayed under the Performance Templates for Device. You will
now be able to start collecting the web server metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
17.4. Check for a Specific URL or Specify Security Settings
1. Navigate to the device in the Zenoss Web interface.
2. Click the page menu, then select More → Templates.
3. If the button at the right-hand side of the template has the label Create Local Copy, then click on that button
to create a local copy. If you do not create a local copy your changes will affect all templates, not just the
template bound to this one device.
4. Click on the HttpMonitor template.
5. Click on the HttpMonitor data source from the Data Sources table menu.
6. Change data source options as needed. Click on the Save button to save your changes.
40
Web Page Response Time (HTTP)
Option
Description
Port
The port to connect to HTTP server (default 80).
Use SSL
Use SSL for the connection
Url
Address of the web page.
Basic Auth User
If the website requires credentials, specify the username here.
Basic Auth Password
Password for the user.
Redirect Behavior
If the web site returns an HTTP redirect, should the probe follow
the redirect or create an event? Possible event severities are
OK, Warning, and Critical.
Table 17.2. HTTPMonitor Content Checking Data Source Options
7. Click Save to save your changes.
17.5. Check for Specific Content on the Web Page
This procedure allows Zenoss to create an event if content at the web page does not match the expected output.
1. Navigate to the device in the Zenoss interface.
2. Click the page menu, then select More → Templates.
3. If the button at the right-hand side of the template has the label Create Local Copy, then click on that button
to create a local copy. If you don't create a local copy your changes will affect all templates, not just the
template bound to this one device.
4. Click on the HttpMonitor template.
5. Click on the HttpMonitor data source from the Data Sources table menu.
6. Change data source options as needed.
Option
Description
Regular Expression
A Python regular expression to match text in the web page.
Case Sensitive
Is the regular expression case-sensitive or not?
Invert Expression
If you would like to test to see if the web page does not contain
content matched by a regular expression, check this box.
Table 17.3. HTTPMonitor Content Checking Data Source Options
7. Click Save to save your changes.
17.6. Tuning for Site Responsiveness
1. Navigate to the device in the Zenoss interface.
2. Click the page menu, then select More → Templates.
3. If the button at the right-hand side of the template has the label Create Local Copy, then click on that button
to create a local copy. If you don't create a local copy your changes will affect all templates, not just the
template bound to this one device.
4. Click on the HTTPMonitor template and change options as needed.
41
Web Page Response Time (HTTP)
Option
Description
Timeout (seconds)
Seconds before connection times out (default: 60)
Cycle Time (seconds)
Number of seconds between collection cycles (default: 300 or
five minutes)
Table 17.4. HTTPMonitor Tunables Data Source Options
5. Click Save to save your changes.
17.7. Daemons
Type
Name
Performance Collector
zencommand
Table 17.5. Daemons
42
Part II. Enterprise ZenPacks
Chapter 18. AIX
18.1. About
The AixMonitor ZenPack enables Zenoss to use Secure Shell (SSH) to monitor AIX hosts. Zenoss models and
monitors devices placed in the /Server/SSH/AIX device class by running commands and parsing the output.
Parsing of command output is performed on the Zenoss server or on a distributed collector. The account used
to monitor the device does not require root access or special privileges.
Specifically, the AixMonitor ZenPack provides:
•
File system and process monitoring
•
Network interfaces and route modeling
•
CPU utilization information
•
Hardware information (memory, number of CPUs, machine serial numbers, model numbers)
•
OS information (OS level command style information)
•
LPP and RPM information (such as installed software)
18.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.4 or higher
Required ZenPacks
ZenPacks.zenoss.AixMonitor
AIX releases supported
5.3 and 6.1
Table 18.1. AIX Prerequisites
If using a distributed collector setup, SSH requires firewall access (default of port 22) from the collector to
the monitored server.
18.3. Add an AIX Server
The following procedure assumes that the credentials have been set.
1. From the navigation bar, select Add Device.
2. Enter the following information:
Name
Description
Device Name
AIX host to model
Device Class Path
/Server/SSH/AIX
Discovery Protocol
Set this to auto unless adding a device with username/password different than found in the device class. If you set this to
none, then you must add the credentials (see Section 18.4, “Set
AIX Server Monitoring Credentials”) and then manually model
the device.
Table 18.2. Adding AIX Device Information
3. Click Add Device to add the device.
18.4. Set AIX Server Monitoring Credentials
All AIX servers must have a device entry in an organizer below the /Devices/Server/SSH/AIX device class.
44
AIX
The SSH monitoring feature will attempt to use key-based authentication before using a zProperties password value.
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Verify the credentials for the service account to access the service.
Name
Description
zCommandUsername
AIX user with privileges to gather performance information
zCommandPassword
Password for the AIX user
Table 18.3. AIX zProperties
4. Click Save to save your changes.
18.5. Resolving CHANNEL_OPEN_FAILURE Issues
The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:
ERROR zen.SshClient CHANNEL_OPEN_FAILURE: Authentication failure
WARNING:zen.SshClient:Open of command failed (error code 1): open failed
If the sshd daemon's log file on the remote device is examined, it may report that the MAX_SESSIONS number
of connections has been exceeded and that it is denying the connection request. At least in the OpenSSH
daemons, this MAX_SESSIONS number is a compile-time option and cannot be reset in a configuration file.
In order to work around this limitation of the sshd daemon, use the zProperty zSshConcurrentSessions to control
the number of connections created by zencommand to the remote device.
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Apply an appropriate value for the maximum number of sessions.
Name
Description
zSshConcurrentSessions
Maximum number of sessions supported by the remote device's
MAX_SESSIONS parameter. Common values for AIX is 2 or 10.
Table 18.4. Concurrent SSH zProperties
4. Click Save to save your changes.
18.6. Resolving Command timed out Issues
The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:
WARNING:zen.zencommand:Command timed out on device device_name: command
If this occurs, it usually indicates that the remote device has taken too long in order to return results from the
commands. In order to increase the amount of time to allow devices to return results, change the zProperty
zCommandCommandTimeout to a larger value.
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
45
AIX
If applying changes to a device class, click on the zProperties tab.
3. Apply an appropriate value for the command timeout.
Name
Description
zCommandCommandTimeout
Time in seconds to wait for commands to complete on the remote device.
Table 18.5. SSH Timeout zProperties
4. Click Save to save your changes.
18.7. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zencommand
Table 18.6. Daemons
46
Chapter 19. Apache Tomcat Application
Server
19.1. About
TomcatMonitor is a ZenPack that allows System Administrators to monitor the Tomcat Application Server. Tomcat is a web application container that conforms to many parts of the J2EE Specification.
This ZenPack focuses on the metrics that Tomcat updates in its internal MBean container that is accessible via
the remote JMX API. These metrics focus on attributes that relate to the servicing of web pages and primarily
include thread pool size, CPU use, available file descriptors, JSP and servlet counts, and request counts.
TomcatMonitor places much emphasis on monitoring thread status because every web request is serviced in a
separate thread. Each thread requires file descriptors to be maintained, and thus those are monitored as well.
The amount of CPU time spent servicing each thread is also captured and reported.
TomcatMonitor also reports on the number of times JSPs and Servlets are reloaded. This metric can be useful in
highly dynamic sites where JSPs or Servlets change on the fly and need to be reloaded periodically. Monitoring
of this metric can lead to the identification of small "Reloading Storms" before they cause production outages.
The amount of time Tomcat spends servicing a request is also recorded. This extremely high level metric can
provide insight into downstream systems that are not monitored. If all the Tomcat resources are within normal
tolerances but processing time suddenly spikes it can be an indication that a back-end service (such as a
database or another web service) is misbehaving.
The following metrics can be collected and graphed:
•
Tomcat cache (accesses vs hits)
•
Daemon and User thread count
•
Overall CPU time
•
Global Request Traffic: bytes sent/received
•
Global Request Traffic: request count and error count
•
Global Request processing time
•
JSP/Servlet reload time
•
Servlet class loading and processing time
•
Servlet request and error count
The more extensive JBoss Application Server uses Tomcat as a Web Application engine to manage web
applications deployed inside enterprise applications within JBoss. As a result, the TomcatMonitor ZenPack
can be used to monitor Tomcat MBeans that are active within JBoss.
19.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenJMX,
ZenPacks.zenoss.TomcatMonitor
Table 19.1. Tomcat Prerequisites
47
Apache Tomcat Application Server
19.3. Enable Monitoring
19.3.1. Configuring Tomcat to Allow JMX Queries
Before running the Tomcat bin/start.sh script, run the following to allow unsecured queries against the Tomcat
server:
JAVA_OPTS="-Dcom.sun.management.jmxremote.port=12346"
JAVA_OPTS="${JAVA_OPTS} -Dcom.sun.management.jmxremote.authenticate=false"
JAVA_OPTS="${JAVA_OPTS} -Dcom.sun.management.jmxremote.ssl=false"
export JAVA_OPTS
The same JAVA_OPTS approach can be used to enable remote access to Tomcat MBeans. Set the JAVA_OPTS
variable as illustrated above and then execute the ./catalina.sh start command in the ${TOMCAT_HOME}/bin
directory.
Tomcat 6.0.14's catalina.sh does not process the stop command properly when the JAVA_OPTS variable is
set. We recommend using two separate shell scripts when troubleshooting JMX problems in Tomcat: one
for starting Tomcat (with the JAVA_OPTS variable set) and a different one for stopping Tomcat (where the
JAVA_OPTS variable is not set).
If you add the above lines to the to bin/setenv.sh (as seems to be the logical thing to do in catalina.sh to
get the environment variables set up), the bin/shutdown.sh script will get those same environment variables.
This will cause the shutdown.sh script to attempt to bind to the ports, fail, and then not stop Apache Tomcat.
19.3.2. Configuring Zenoss
All Apache Tomcat services must have a device entry under the /Devices/Server/Tomcat device class.
The zenjmx daemon must be configured and running. See Section 10.2.1, “Sun Java Runtime Environment
(JRE)” for more information about configuring the zenjmx daemon with the Sun JRE tools.
1. Navigate to the device or device class under the /Devices/Server/Tomcat device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
48
Apache Tomcat Application Server
Name
Description
zTomcatJ2EEApplicationName
Used to construct MBean names for a specific application deployed on Tomcat, typically used for JSP and Servlet statistics.
zTomcatJ2EEServerName
Used to construct MBean names for a specific application deployed on Tomcat, typically used for JSP and Servlet statistics.
zTomcatJmxManagementAuthenticate
This zProperty is deprecated.
zTomcatJmxManagementPassword
JMX password.
zTomcatJmxManagementPort
The port number used to gather JMX information.
zTomcatJmxManagementUsername
JMX username for authentication.
zTomcatListenHost
The hostname on which Tomcat is listening for web requests.
This is used to construct MBean names.
zTomcatListenPort
The Tomcat connector, which is a port and protocol (http, jk...)
that Tomcat is listening on. This is used to construct MBean
names that monitor bytes, error and requests on that connector.
zTomcatServletName
Specific Servlet name to monitor.
zTomcatServletUri
URI of Servlet to monitor.
zTomcatWebAppUri
URI path for a Tomcat web application. Used to construct
MBean names.
Table 19.2. Tomcat zProperties
4. Click Save to save your changes.
You will now be able to start collecting the Tomcat server metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
The out-of-the-box TomcatMonitor data source configuration has been defined at the macro level, but can be
configured to operate on a more granular basis. For example, the Servlet Reload Count applies to all servlets
in all web applications but it could be narrowed to be Servlet /submitOrder in web application "production
server".
19.4. Change the Amount of Data Collected and Graphed
1. Navigate to the device or device class under the /Devices/Server/Tomcat device class in the Zenoss web
interface.
2. Click the page menu, then select More → Templates.
3. From the table menu select the Bind Templates... item to display the Bind Performance Templates dialog.
4. To add other templates and retain existing performance templates, hold down the control key while clicking
on the original entries.
49
Apache Tomcat Application Server
Name
Description
Tomcat Cache
Cache information about a specific Web application deployed.
Tomcat Core
Core information about any Tomcat server: memory usage,
threads, uptime, etc.
Tomcat Global Request Processor
Connection information over a Tomcat connector: bytes, errors,
requests, etc.
Tomcat JSPS
Metrics about a specific JSP page.
Tomcat Servlet
Metrics about a specific Servlet.
Tomcat Thread Pool
Threadpool metrics measured per Tomcat connector.
Tomcat Web Module
Processing time metrics for a web module.
Table 19.3. Tomcat Templates
5. Click the OK button to save your changes.
19.5. Viewing Raw Data
See Section 10.5, “Using JConsole to Query a JMX Agent” for more information about how to investigate raw
data returned back from the application.
19.6. Daemons
Type
Name
Performance Collector
zenjmx
Table 19.4. Daemons
50
Chapter 20. BEA WebLogic Application
Server
20.1. About
WebLogicMonitor is a ZenPack that allows System Administrators to monitor a WebLogic Server. WebLogicMonitor uses the JMX Remote API and and accesses MBeans deployed within WebLogic that contain performance information about the components that are being managed. This performance information includes pool
sizes for data sources (JDBC), threads, connections (JCA), queues (JMS), servlets, JSPs, Enterprise Java
Beans (EJB), timer queues.
Throughput is also monitored when it is available. This metric is computed by WebLogic and is based on the
number of messages moving through a queue at any given time. The throughput metric gives a good picture
of the health of the messaging subsystem, which is commonly used throughout many enterprise applications.
Stateless, Stateful, and Entity EJB performance metrics are monitored, as are message driven bean performance.
Security realms are also monitored for potential denial of service attacks. This includes recording of authentication failures, broken out by valid accounts, invalid accounts, and accounts that are currently locked out. Application specific realms can be monitored by customizing the built in WebLogic default realm.
20.1.1. Overall Application Server Vitals
•
Number of total and active JMS connections and servers
•
Overall number of JTA transactions that are rolled back or abandoned
•
JTA transactions rolled back due to system, application, or resource issues
•
Number of JTA rollbacks that timeout
•
Active and committed JTA transaction count
•
Timer exceptions, executions, and scheduled triggers
•
User accounts that are locked and unlocked
•
Authentication failures against locked accounts and non-existent accounts
•
Total sockets opened, and the current number of open sockets
•
JVM Mark/Sweep and Copy garbage collector execution counts
•
Number of JVM daemon threads
•
JVM Heap/Non-Heap used and committed memory
20.1.2. Entity EJB, Message Driven Bean (MDB), and Session EJB Subsystem
Metrics
•
Rollback and commit count on a per-EJB basis
•
Bean pool accesses, cache hits, and cache misses
•
Number of Beans in use, idle, and destroyed
•
Number of activations and passivations
20.1.3. Data Pool (JDBC) metrics
•
Leaked, Total, and Active connections
•
Number of requests waiting for a connection
•
Number of reconnect failures
51
BEA WebLogic Application Server
20.1.4. Queue (JMS) Metrics
•
Bytes received, currently active, and pending in the queue
•
Number of queue consumers
•
Number of current, pending, and receives messages
20.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenJMX,
ZenPacks.zenoss.WebLogicMonitor
BEA WebLogic Versions
WebLogic 9.0 or higher
Table 20.1. BEA WebLogic Prerequisites
20.3. Enable Monitoring
20.3.1. Configuring WebLogic to Allow JMX Queries
If you have not set up a domain and server then run the startWLS.sh script located in the ${BEA_HOME}/wlserver_10.0/server/bin directory. If you don't have the Terminal I/O package installed you can set the JAVA_OPTIONS
variable to the following value:
JAVA_OPTIONS="-Dweblogic.management.allowPasswordEcho=true"
export JAVA_OPTIONS
Provide a user name and password to start WebLogic. Note that WebLogic requires a password that is at least
eight characters long. Wait for WebLogic to generate a configuration and start up. Shut down WebLogic and
restart it with remote JMX access enabled.
To enable remote JMX access set the following variable:
JAVA_OPTIONS="-Dcom.sun.management.jmxremote.port=12347"
JAVA_OPTIONS="${JAVA_OPTIONS} -Dcom.sun.management.jmxremote.authenticate=false"
JAVA_OPTIONS="${JAVA_OPTIONS} -Dcom.sun.management.jmxremote.ssl=false"
export JAVA_OPTIONS
Then re-run the ./startWLS.sh script. JConsole can then communicate with the server on port 12347.
20.3.2. Configuring Zenoss
All WebLogic services must have a device entry under the /Devices/Server/WebLogic device class.
The zenjmx daemon must be configured and running. See Section 10.2.1, “Sun Java Runtime Environment
(JRE)” for more information about configuring the zenjmx daemon with the Sun JRE tools.
1. Navigate to the device or device class under the /Devices/Server/WebLogic device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Edit the appropriate zProperties for the device(s).
52
BEA WebLogic Application Server
Name
Description
zWebLogicJmxManagementAuthenticate
This zProperty is deprecated
zWebLogicJmxManagementPassword
JMX password
zWebLogicJmxManagementPort
The port number used to gather JMX information
zWebLogicJmxManagementUsername
JMX username for authentication
Table 20.2. WebLogic zProperties
4. Click Save to save your changes.
You will now be able to start collecting the WebLogic server metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
The out-of-the-box WebLogic data source configuration has been defined at the macro level, but can be
configured to operate on a more granular basis. For example, the Servlet Reload Count applies to all servlets
in all web applications but it could be narrowed to be Servlet /submitOrder in web application "production
server".
20.4. Change the Amount of Data Collected and Graphed
1. Navigate to the device or device class under the /Devices/Server/WebLogic device class in the Zenoss web
interface.
2. Click the page menu, then select More → Templates.
3. From the table menu select the Bind Templates... item to display the Bind Performance Templates dialog.
4. To add other templates and retain existing performance templates, hold down the control key while clicking
on the original entries.
Name
Description
WebLogic Core
Core information about any WebLogic server, including memory
usage, threads, and uptime.
WebLogic JCA
WebLogic JMS
WebLogic JMS Destination
WebLogic JTA
WebLogic JTA Rollbacks
WebLogic JVM
WebLogic Thread Pool
Threadpool metrics measured per Tomcat connector
WebLogic Timer Service
WebLogic User Lockouts
Table 20.3. WebLogic Templates
5. Click the OK button to save your changes.
20.5. Viewing Raw Data
See the Section 10.5, “Using JConsole to Query a JMX Agent” section for more information about how to
investigate raw data returned back from the application.
53
BEA WebLogic Application Server
20.6. Monitor SSL-Proxied WebLogic Servers
If you are monitoring a web application running on a BEA WebLogic server you may find that the transaction
always fails with a code 550 regardless of how you configure the script. This could be a result of the WebLogic
server being behind an SSL proxy. When used in this configuration, WebLogic requires that a WL-Proxy-SSL
header be added to the request so that it knows to redirect to HTTPS instead of HTTP.
To support this extra header in your Zenoss Web transaction, you must make the following changes on the
script tab of your WebTx data source.
•
Remove any content from the Initial URL field.
•
Add the following to the beginning of the Script box.
add_extra_header WL-Proxy-SSL true
go
20.7. Daemons
Type
Name
Performance Collector
zenjmx
Table 20.4. Daemons
54
Chapter 21. BIG-IP Network Devices
21.1. About
The Zenoss BIG-IP network device monitoring feature monitors load balancer CPU and memory utilization. It
also tracks per-instance metrics for each load-balanced virtual server that is configured.
21.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.BigIPMonitor
Table 21.1. BIG-IP Prerequisites
21.3. Enable Monitoring
To add a device and enable BIG-IP monitoring on it:
1. From the Zenoss interface navigation area, select Add Device.
The Add Device page appears.
2. Enter a name for the device, and then select these values:
•
Discovery Protocol - Select none.
•
Device Class Path - Select /Network/BIG-IP.
3. Click Add Device.
4. Navigate to the newly created device. From the device page menu, select More > zProperties.
The zProperties Configuration page appears.
5. Change the values of these zProperties:
•
zSnmpCommunity - Enter the SNMP community string here.
•
zSnmpVer - Select v2c.
Figure 21.1. BIG-IP zProperties Selections
6. Click Save.
7. Model the device. To to this, select Manage > Model Device from the page menu.
Zenoss models the device. When modeling completes, you can view the device. After approximately fifteen
minutes, you can verify that the performance graphs (available from the Perf tab) are updating.
55
BIG-IP Network Devices
21.4. Viewing Virtual Servers
To view the virtual servers, select More → BIG-IP Details from the device page menu. Click a link in the table
to view additional information for each load-balanced server.
21.5. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 21.2. Daemons
56
Chapter 22. Brocade SAN Switches
22.1. About
BrocadeMonitor is a ZenPack that allows system administrators to monitor the Brocade Storage Area Network
(SAN) switches.
22.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.BrocadeMonitor
Table 22.1. Brocade Prerequisites
22.3. Enable Monitoring
22.3.1. Configuring Brocade Devices to Allow SNMP Queries
Configure the Brocade devices to allow SNMP queries from the Zenoss server, and send SNMP v1 or SNMP
v2 traps to the Zenoss server.
22.3.2. Configuring Zenoss
All Brocade devices must exist under the /Devices/Storage/Brocade device class.
1. Navigate to the device or device class under the /Devices/Storage/Brocade device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your storage administrators to determine the SNMP community permitted
zSnmpMonitorIgnore
This should be set to False
zSnmpPort
The default port is 161
zSnmpVer
This should be set to v2c
Table 22.2. Brocade zProperties
4. Click Save to save your changes. You will now be able to start collecting the Brocade switch metrics from
this device.
22.4. Viewing Fibre Channel Port Information
To view the virtual servers, select More → Brocade Details from the device page menu.
57
Brocade SAN Switches
22.5. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 22.3. Daemons
58
Chapter 23. CheckPoint Firewalls
23.1. About
The CheckPointMonitor ZenPack allows system administrators to monitor their CheckPoint Firewalls.
23.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.CheckPointMonitor
Table 23.1. CheckPoint Prerequisites
23.3. Enable Monitoring
23.3.1. Configuring CheckPoint Firewalls to Allow SNMP Queries
Configure the CheckPoint firewall to allow SNMP queries from the Zenoss server, and send SNMP v1 or SNMP
v2 traps to the Zenoss server.
23.3.2. Configuring Zenoss
All CheckPoint devices must exist under the /Devices/Network/Check Point device class.
1. Navigate to the device or device class under the /Devices/Network/Check Point device class in the Zenoss
web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your network administrators to determine the SNMP community permitted.
zSnmpMonitorIgnore
This should be set to False
zSnmpPort
The default port is 161
zSnmpVer
This should be set to v2c
Table 23.2. CheckPoint zProperties
4. Click Save to save your changes.
You will now be able to start collecting the CheckPoint firewall metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately fifteen
minutes you should see the graphs start to become populated with information.
23.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 23.3. Daemons
59
Chapter 24. Cisco Devices
24.1. About
The CiscoMonitor ZenPack allows you to monitor a variety of devices from Cisco Systems. Most Cisco devices
are well-supported by the standard capabilities of Zenoss. This ZenPack extends those basic capabilities to
support modeling and monitoring of characteristics specific to Cisco devices.
24.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.4 or higher
Required ZenPacks
ZenPacks.zenoss.CiscoMonitor
Table 24.1. Cisco Prerequisites
24.3. Enable Monitoring
Follow the steps in this section to configure your Cisco device and Zenoss for monitoring.
24.3.1. Configuring Cisco Devices to Allow SNMP Queries
Configure the Cisco device to allow SNMP queries from the Zenoss server, and send SNMP v1 or SNMP v2
traps to the Zenoss server.
24.3.2. Configuring Zenoss
All Cisco devices must be located in the /Devices/Network/Cisco device class.
1. Navigate to the device or device class (if configuring multiple devices) in the /Devices/Network/Cisco device
class in the Zenoss interface.
2. If applying changes to a device, click the page menu, and then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your network administrators to determine the SNMP community permitted.
zSnmpMonitorIgnore
Set to a value of False.
zSnmpPort
The default port is 161.
zSnmpVer
Set to a value of v2c.
Table 24.2. Cisco zProperties
4. Click Save to save your changes. Zenoss now will collect Cisco device metrics from the configured device
or devices.
5. Navigate to the Perf tab to see some place holders for graphs. After approximately 15 minutes, the graphs
will begin to be populated with information.
24.4. Forwarding Syslog Messages to Zenoss
For information about forwarding syslog messages from Cisco IOS routers and CatOS switches into Zenoss,
see Appendix C, "Syslog Device Preparation" in Zenoss Administration.
60
Cisco Devices
24.5. Extended Capabilities for Cisco Devices
24.5.1. IOS
You should place Cisco devices running IOS in the /Devices/Network/Cisco device class. This lets them benefit
from these extended monitoring capabilities:
•
Modeling of hardware serial number. This information can be found on the Status tab of Cisco IOS devices.
•
Monitoring of CPU and memory utilization. This information can be found on the Perf tab of Cisco IOS
devices.
•
Modeling and monitoring of IP-SLA (RTTMON). This information can be found by selecting More → Cisco
Details from Cisco IOS devices' menu.
•
Modeling of stacked switch modules. This information can be found by choosing More → Cisco Details from
Cisco IOS devices' menu.
61
Cisco Devices
24.5.2. CatOS
You should place Cisco Catalyst devices running CatOS in the /Network/Cisco/CatOS device class. The only
difference in this class is that the CPU and memory performance monitoring is done by using a different configuration. Otherwise, the devices are treated the same as IOS devices.
24.5.3. ASA, FWSM and PIX
You should place Cisco ASA, FWSM, and PIX devices in the /Network/Cisco/ASA device class. The only difference in this class is that the CPU and memory performance monitoring is done by using a different configuration.
Otherwise, the devices are treated the same as IOS devices.
Zenoss can encounter problems when querying Cisco PIX, ASA, and FWSM devices using SNMP. This is
because, by default, Zenoss tries to fit forty requests into a single SNMP packet when using SNMP v2c. This
improves performance and reduces network and processing overhead on Zenoss and the monitored device.
Common symptoms of this problem include:
•
DEBUG
level /Perf/Snmp events with a summary field of Error reading value for "???"
•
Missing performance graphs.
•
Errors similar to this that appear in the Cisco device log:
incoming SNMP request (? bytes) from IP address ?.?.?.? Port ? Interface
"inside" exceeds data buffer size, discarding this SNMP request.
24.5.4. Wireless LAN Controllers
You should place Cisco Wireless LAN Controllers in the /Network/Cisco/WLC device class. This lets them benefit
from the following extended monitoring capabilities:
•
Modeling of hardware model, serial number and operating system. This information can be found on the
Status tab of wireless LAN controller devices.
•
Modeling of individual access points controller by the wireless LAN controller. This information can be found
on the Wireless tab of wireless LAN controller devices.
62
Cisco Devices
24.5.5. ACE Load Balancers
You should place Cisco ACE (Application Control Engine) devices in the /Network/Cisco/ACE device class. This
lets them benefit from the following extended monitoring capabilities:
•
Modeling and monitoring of individual load balanced virtual servers. This information can be found by choosing More → Cisco Details from Cisco ACE devices' menu.
24.5.6. Telepresence Codecs
You should place Cisco Telepresence Codec devices in the /Network/Cisco/Codec device class. This lets them
benefit from the following extended monitoring capabilities:
•
Modeling of hardware model, serial number and operating system. This information can be found on the
Status tab of Telepresence Codec devices.
63
Cisco Devices
•
Modeling of all peripherals controlled by the codec. This information can be found on the Telepresence tab
of Telepresence Codec devices.
24.6. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 24.3. Daemons
64
Chapter 25. Device Access Control Lists
25.1. About
The Device Access Control List (ACL) Enterprise ZenPack (ZenDeviceACL) adds fine-grained security controls
to Zenoss. You can use this control to limit access to data, such as limiting access to certain departments within
a large organization, or limiting a customer of a service provider to see only his own data.
A user with limited access to objects also has a more limited view of features within the system. Most global
views, such as the network map, event console, and all types of class management, are not available. The
Device List is available, as are the device organizers Systems, Groups, and Locations. A limited set of reports
can also be accessed.
25.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenDeviceACL
Table 25.1. Device ACL Prerequisites
25.3. Key Concepts
25.3.1. Permissions and Roles
Actions in Zenoss are assigned permissions. For example, to access the device edit screen you must have the
“Change Device” permission. Permissions are not assigned directly to a user, but granted to roles, which are
then assigned to a user. A common example is the ZenUser role. Its primary permission is “View,” which grants
read-only access to all objects.
ZenManagers have additional permissions, such as “Change Device,” which grants users with this role access
to the device edit screen. When you assign a role to a user (using the Roles field on the Edit tab), it is assigned
globally. When creating a restricted user you may not want to give that user a global role.
For more information about Zenoss roles, refer to Zenoss Administration.
25.3.2. Administered Objects
Device ACLs provide limited control to various objects in the system. Administered objects are the same as
device organizers (groups, systems, locations, and devices). If access is granted to any device organizer, it
extends to all devices in that organizer.
To assign access to objects for a restricted user, you must be assigned the Manager or ZenManager role.
Zenoss grants access to objects by using the “Administered Objects” tab of a user or user group. To limit access,
you must not assign a “global” role to the user or group.
25.3.3. Users and Groups
Users and user groups work exactly as they would normally. See the chapter titled "Managing Users" in Zenoss
Administration for more information about managing users and groups.
25.3.4. Assigning Administered Object Access
For each user or group there is a tab called “Administered Objects." The menu has an "Add" item for each type
of administered object. Adding an object will bring up a dialog box with live search on the given type of object.
65
Device Access Control Lists
After adding an object, you can assign it to a role. Roles can be different for each object. For example, a user
or group might have the ZenUser role assigned to a particular device but the ZenManager role assigned to a
location organizer. If multiple roles are granted to a device though direct assignment and organizer assignment,
the resulting permissions will be additive. For the previously cited example, if the device is within the organizer
the user will inherit the ZenManager role on the device.
25.3.5. Restricted Screen Functionality
25.3.5.1. Dashboard
By default, the dashboard is configured with three portlets:
•
Object Watch List
•
Device Issues
•
Production State
These have content that are restricted to objects for a given user.
25.3.5.2. Device List
The device list is automatically filtered to devices of a restricted user, scoped to accessible devices. There are
no menu items available.
25.3.5.3. Device Organizers
Device organizers control groups of devices for a restricted user. Each device added to the group will be accessible to the user. Permissions are inherited through multiple tiers of a device organizer.
25.3.5.4. Reporting
Reports are limited to device reports and performance reports.
25.3.5.5. Viewing Events
A user in restricted mode does not have access to the global event console. The available events for the user
can be seen under his organizers.
25.4. Create a User Restricted to Specific Devices
1. As admin or any user account with Manager or ZenManager role, create a user named acltest. Set a password for the user.
2. From the user’s Edit tab, make sure that no role is assigned.
3. Select the user’s “Administered Objects” tab.
4. From, the menu, select the “Add Device…” item and add an existing device to that user.
The device’s role defaults to ZenUser.
5. Log out of your browser, or open a second browser and then log in as acltest.
6. Click on the “Device List”.
You should see only the device you assigned to acltest.
7. Navigate to the device and notice that the Edit tab is not available. This is because you are in read-only
mode for this device.
25.5. Create a Manager Restricted to Specific Devices
Following the previous example:
66
Device Access Control Lists
1. From the user's Edit tab, Change the acltest user’s role to “ZenManager." (You must do this as a user with
ZenManager global rights.)
2. Go back to the acltest user “Administered Objects” tab and set the role on the device to ZenManager.
3. As acltest, navigate to the device. You now have access to the Edit tab.
25.6. Adding Device Organizers
1. Go to the Groups root and create a group called “RestrictGroup."
2. Go to the acltest user’s Administered Objects tab and add the group to the user.
3. Logged in as acltest, notice that the Navigation menu has the Groups item. Group can be added to a user.
4. Place a device within this group and as acltest you should not only see the device within the group but also
in the device list
25.7. Restricted User Organizer Management
1. Assign the acltest user the ZenManager role on your restricted group.
2. As acltest, you can now add sub-organizers under the restricted group.
67
Chapter 26. Distributed Collector
26.1. About
Distributed Collector allows you to deploy additional performance collection and event monitoring daemons to
the Zenoss server or other servers. This allows you to:
•
Distribute processor, disk, and network load across multiple servers.
•
Collect performance and events from networks that cannot be reached by the Zenoss server.
•
Configure more than one set of monitoring settings, such as different cycle times for the zenperfsnmp daemon.
When you first install Distributed Collector, Zenoss is configured with one hub and one collector. A collector is
a set of collection daemons, on the Zenoss server or another server, that shares a common configuration. That
configuration contains values, such as number of seconds between SNMP collection cycles, default discovery
networks, and maximum number of zenprocess parallel jobs.
Each collector has its own copy of each of the Zenoss collection daemons. For example, Zenoss initially
contains collection daemons with names like zenperfsnmp, zenprocess, and zenping. If you create a new collector named My2ndCollector, then the system creates new daemons named My2ndCollector_zenperfsnmp,
My2ndCollector_zenprocess, and My2ndCollector_zenping.
You cannot delete the initial hub and collector set up by Distributed Collector (both named localhost).
26.1.1. Navigating Existing Collectors and Hubs
When you log in as the Zenoss admin user, the Navigation pane displays a link titled Collectors in the Management area. Click this link to go to the Collectors page, which lists existing hubs and collectors in hierarchical
form. Hubs are listed at the top level; collectors are nested below the hub to which they belong.
From this page, you can:
•
Add a hub
•
Delete a hub (which also deletes its associated collectors)
•
View and edit hub settings
The Daemons tab lists the copy of the ZenHub daemon that belongs to the collector. Links adjacent to the daemon
name allow you to view its log, and view and edit its configuration. Use the buttons to the right of the daemon
name to stop, start, and restart the daemon.
26.1.2. Restrictions and Requirements
•
Servers hosting remote hubs or collectors must be the same operating system and hardware architecture
as the Zenoss server. For example, if the Zenoss server is running RedHat Enterprise Linux v5 on Intel 32bit hardware, then hubs and collectors can be deployed only to other RHEL 5 32-bit servers.
•
By default, port 8789 must be open so that a distributed collector can communicate with ZenHub. (This can
differ if you have configured ZenHub to run on a different port.) For a remote ZenHub, port 3306 most be
open for MySQL communications, and port 8100 must be open for ZEO communications.
•
You must update all hubs and collectors after performing any of these functions on your master Zenoss
server:
•
Upgrade
•
Install patches
•
Install, upgrade, or remove ZenPacks
To update, navigate to the Reconfigure Collector option on the Overview collector page.
68
Distributed Collector
•
Zenoss is not compatible with Security-Enhanced Linux (SELinux) in enforcing mode. You must disable
enforcing mode for all platforms running the Zenoss daemons (Zenoss master, remote hubs, and remote
collectors).
To disable enforcing mode:
1. Edit the /etc/linux/config file.
2. Set the following line:
SELINUX=disabled
You also can disable enforcing mode temporarily (avoiding the need to reboot) with the command:
echo 0 > /selinux/enforce
For more information about SELinux, browse to http://en.wikipedia.org/wiki/SELinux, or to the SELinux home
page at http://www.nsa.gov/research/selinux/index.shtml.
For additional platform-specific information, refer to Section 26.1.5, “Platform Notes”.
26.1.3. Installation Notes
•
Make sure the Zenoss server's hostname is a fully qualified domain name.
•
Remember that collectors and hubs can be pushed only to servers with identical operating system versions
and hardware architecture.
•
When installing a remote hub, make sure that Event Manager > hostname has a fully qualified domain name
(preferred) or at least a numeric address that can be reached by any server with hubs deployed to it.
•
If you have any other firewalls on the Zenoss server, or on servers that host remote collectors or hubs, then
you should disable them.
26.1.4. Firewall Notes
Remote hubs need to communicate with the ZEO database on the Zenoss server on port 8100. Hubs also need
to communicate with the MySQL server, usually on the Zenoss server (see Event Manager > Hostname), and
on the port specified in Event Manager > Port (usually 3306.) Collectors communicate with their hub on the port
specified when the hub was created. See the ZenHub Port field on the hub's overview page.
26.1.5. Platform Notes
Software Appliance and Hardware Appliance
•
Hubs and collectors can be deployed only to other Zenoss software or hardware appliances.
•
You must stop Zenoss on an appliance before deploying a hub or collector to it.
•
You must set a password for the root user on an appliance before deploying a hub or collector to it.
•
When using appliances for the Zenoss server and remote server the user must shutdown Zenoss on the
remote server before creating hub or collectors on it. Otherwise, ZEO, Zope, and the standard Zenoss
daemons will run indefinitely on that server and will no longer be controllable via the zenoss script.
•
Do not use conary to update appliances being used as remote collectors or hubs.
26.1.6. Debugging
Hostname Configuration
The Zenoss server should have a properly configured hostname (preferably a fully qualified domain name). You
can check the hostname from the shell:
root# hostname
You also can check by using the Python function used by Zenoss:
69
Distributed Collector
root# python -c -import socket; socket.gethostname()'
26.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.4 or higher
Required ZenPacks
ZenPacks.zenoss.DistributedCollector
Table 26.1. Distributed Collector Prerequisites
26.3. Typical Usage Scenarios for Distributed Monitoring
Typical setup scenarios for using multiple hubs and collectors are:
•
ZeoDB - local hub - local collector
•
ZeoDB - local hub - remote collector
•
ZeoDB - local hub - multiple remote collectors
•
ZeoDB - multiple remote hubs - multiple remote collectors
The correct distributed strategy for your environment depends on network security restrictions, as well as scale.
Contact Zenoss Support if you are unsure which option best suits your enterprise.
26.3.1. ZeoDB - Local Hub - Local Collector
This setup requires only a single server, and is the most common Zenoss deployment type. You would most
likely use this configuration if you need to monitor fewer than 1000 devices, and your master Zenoss server has
direct network access to all of the monitored devices.
26.3.2. ZeoDB - Local Hub - Remote Collector
This setup requires two servers, and is the most basic distributed setup. The primary benefit of this configuration
over the local hub/local collector configuration is that the master server does no collection. This frees resources,
optimizing the server's ability to perform its central role of database server and Web interface.
26.3.3. ZeoDB - Local Hub - Multiple Remote Collectors
This is the most common distributed Zenoss configuration. Two reasons you might use this configuration are:
•
Scaling Zenoss to monitoring more than 1000 devices. Depending on the hardware of the collectors, it is
possible to monitor up to 1000 devices for each collector using this configuration.
•
Handling differing network security policies. Often, your master Zenoss server will not have access to all of
the devices you need to monitor. In this case you can set up a remote collector with the required network
access.
26.3.4. ZeoDB - Multiple Remote Hubs - Multiple Remote Collectors
This configuration is for large installations only. For cases in which you have more than five collectors, you
should consider deploying one or more hub servers to handle them.
26.4. Deploying Collectors
Use the information and steps in the following sections to deploy and manage collectors.
Before deploying a remote collector you must set up a remote server. For more information setup tasks,
refer to the chapter titled "Installing Distributed Collectors" in Zenoss Installation for Enterprise.
70
Distributed Collector
26.4.1. Prerequisite Tasks
All prerequisite tasks and conditions required to install Zenoss are also required by the machine that will be the
remote collector. Refer to Zenoss Installation for Enterprise for specific procedures to satisfy these conditions.
By default, only local access to the ZEO database is configured. Before adding a remote hub, you must edit the
$ZENHOME/etc/zeo.conf file to allow remote access.
In the file, change the line:
address localhost:8100
to
address 8100
26.4.2. Adding Collectors
To add a collector to a hub:
1. From the left navigation menu, select Collectors.
The main Collectors page appears, showing all of the hubs and collectors.
Figure 26.1. Main collectors page
2. Click the name of the hub where you want to add the collector.
The main page for this hub appears.
Figure 26.2. Main hub page
3. From the Zenoss Collectors table menu, choose Add Collector.
71
Distributed Collector
The Add Collector page appears.
26.4.2.1. Install Remotely (Root Password)
To install a remote collector, using a root password for access to the remote host:
1. Select the Install remotely option.
2. Select the root password option.
Figure 26.3. Install Remote Collector (Root Password)
3. Enter or change setup details:
Field Name
Description
Collector ID
Enter the name for the collector as it will be identified in Zenoss. This name will be used to prefix the Zenoss control scripts on the collector.
If the ID is coll1, then scripts will be named
coll1_zenperfsnmp.
Host
Enter the name of the host for the collector. This
must be a fully qualified domain name, IP address,
or resolvable hostname.
Root Password
Enter the password for the root user on the Host.
The root password is not stored; it is used to configure a pre-shared key between the main Zenoss
server and the remote collector.
Table 26.2. Add New Collector Fields
If you are creating another collector on the Zenoss server, enter the localhost rather than the IP address
of the Zenoss server.
4. Click Add Collector. The system displays log output from the creation of the new collector. When fully
configured (this may require several minutes), click the link at the bottom of the page to go to the overview
page for the new collector.
72
Distributed Collector
26.4.2.2. Install Remotely (Root SSH Keys)
To install a remote collector, using existing root SSH keys for access to the remote host:
1. Select the Install remotely option.
2. Select the root SSH keys option.
Figure 26.4. Install Remote Collector (Root SSH Keys)
3. Enter or change setup details:
Field Name
Description
Collector ID
Enter the name for the collector as it will be identified in Zenoss. This name will be used to prefix the Zenoss control scripts on the collector.
If the ID is coll1, then scripts will be named
coll1_zenperfsnmp.
Host
Enter the name of the host for the collector. This
must be a fully qualified domain name, IP address,
or resolvable hostname.
Table 26.3. Add New Collector Fields
If you are creating another collector on the Zenoss server, enter the localhost rather than the IP address
of the Zenoss server.
4. Click Add Collector. The system displays log output from the creation of the new collector. When fully
configured (this may require several minutes), click the link at the bottom of the page to go to the overview
page for the new collector.
26.4.2.3. Install Remotely (Zenoss SSH Keys)
If you choose to set up a collector using Zenoss SSH keys, Zenoss will attempt to install by using the zenoss
user. To successfully install a collector using these keys (without root access), these prerequisite conditions
must be met:
•
zenoss user SSH keys must be set up between the Zenoss server and the target.
•
You must be running the RPM distribution of Zenoss.
•
Zenoss core RPM must be installed on the target (remote) machine.
73
Distributed Collector
Tip: When installing the Zenoss RPM on the remote machine, do not start Zenoss.
Follow these steps to install a remote collector, using Zenoss SSH keys for access to the remote host.
For detailed steps for creating SSH keys, see the section titled "Setting Up SSH Keys for Distributed Collector."
1. Select the Install remotely option.
2. Select the zenoss SSH Keys option.
Figure 26.5. Install Remote Collector (Zenoss SSH Keys)
3. Enter or change setup details:
Field Name
Description
Collector ID
Enter the name for the collector as it will be identified in Zenoss. This name will be used to prefix the Zenoss control scripts on the collector.
If the ID is coll1, then scripts will be named
coll1_zenperfsnmp.
Host
Enter the name of the host for the collector. This
must be a fully qualified domain name, IP address,
or resolvable hostname.
Table 26.4. Add New Collector Fields
If you are creating another collector on the Zenoss server, enter the localhost rather than the IP address
of the Zenoss server.
4. Click Add Collector. The system displays log output from the creation of the new collector. When fully
configured (this may require several minutes), click the link at the bottom of the page to go to the overview
page for the new collector.
26.4.2.4. Install Locally
Follow these steps to install a local collector:
1. Select the Install locally option.
74
Distributed Collector
Figure 26.6. Install Remote Collector (Zenoss SSH Keys)
2. Enter or change setup details:
Field Name
Description
Collector ID
Enter the name for the collector as it will be identified in Zenoss. This name will be used to prefix the Zenoss control scripts on the collector.
If the ID is coll1, then scripts will be named
coll1_zenperfsnmp.
Table 26.5. Add New Collector Fields
3. Click Add Collector. The system displays log output from the creation of the new collector. When fully
configured (this may require several minutes), click the link at the bottom of the page to go to the overview
page for the new collector.
26.4.3. Deleting Collectors
When you delete a collector, its devices are left without an assigned collector. Zenoss recommends that you
reassign assigned devices prior to deleting a collector.
To delete a collector, click the name of the hub where the collector exists from the main collectors page. The
Hub overview page appears. From the list of Zenoss Collectors, select the collector you want to delete. From
the Zenoss Collectors table menu, select Delete Collector.
When you delete collectors using this Zenoss instance, they are not removed or "uninstalled" in any way from
the collector device. They continue to exist on the device until manually removed through the file system.
26.4.4. Updating a Hub or Collector
Any time you update your version of Zenoss or install additional ZenPacks, you must update any hubs or
collectors.
To update a hub or collector, navigate to the Overview page for the hub or collector, and then choose Update
Hub or Update Collector from the page menu. This copies the most recent Zenoss code and ZenPacks to the
server and restarts the daemons running there.
26.4.5. Backing Up Remote Collectors
Zenoss does not automatically back up remote collector performance data (RRD files). To back up this data,
set up a cron job on the remote collector. The cron job should invoke zenbackup with these options:
75
Distributed Collector
zenbackup --no-eventsdb --no-zodb
Old backup data is not automatically deleted; therefore, the backup solution you use to save the data should
remove the backup file when it is no longer needed.
Zenoss recommends that you avoid performing backups directly to NFS file systems. Because zenbackup
must restart Zenoss after a backup, a bad connection to an NFS server can prevent the remote collector
from starting.
26.5. Adding Devices to Collectors
Adding devices to collectors occurs when you add the device to Zenoss. When you click Add Device from the
left navigation menu you see the Add Device page.
Figure 26.7. Add Device Page
In the top right of the resulting page, you can see the Collector drop-down menu. Choose the collector you want
to use to collect the data for this device. The device then appears in the Device area for that collector. You can
access this page by choosing the Collectors item from the left navigation menu and then choosing the collector
from the resulting list. When you click on the name of the collector, the Overview page for the collector appears
and then in the Devices area at the bottom of the page you can see the Device list for this collector.
26.5.1. Moving Devices Between Collectors
You can move devices from one collector to another. To do this, use the Set Collector table menu item for any
Device view. These are:
•
Device List
•
Device Tree
•
Any of the Organizers device list
76
Distributed Collector
Follow these steps to move one or more devices to different collector:
1. From the navigation menu, select Device List.
The Device list appears.
2. Select one or more devices that you want to move to a different collector.
3. From the Device list table menu, select Set Collector.
The Set Collector dialog appears.
4. Select the collector from the list of options.
5. Click OK.
Zenoss moves the device or devices to the selected collector.
When a device is moved between collectors, the performance data is not moved. As a result, historical
data for the device may not appear in reports and graphs.
26.6. Managing the Collector Daemons
Collector daemon appears on the Zenoss Daemons page for each collector, and can be started, stopped and
restarted from there.
26.7. Deploying Hubs
In addition to collectors, Distributed Collector allows you to set up new hubs. A hub represents an instance of
the zenhub daemon, which is the daemon through which all collector daemons communicate with the object
database and event database. All collectors must belong to exactly one hub; however, a hub may have many
collectors associated with it. All hubs (and indirectly all collectors) refer to the same object and event databases.
Typically, only very large systems with more than five collectors or more than 1,500 devices will benefit from
multiple hubs.
Hubs are used to manage configuration data and pass it to the collectors. Hubs also take data from the collectors
and pass it to the ZeoDB. More hubs can be a more efficient way to manage larger deployments, as they help
distribute the computing resources when configuration changes are made. They further remove the potential for
configuration changes to be a bottleneck to gathering and processing data.
26.7.1. Configuring MySQL for Remote Hubs
Hubs on remote servers need access to the MySQL events database. This setting is the Hostname field in the
Connection Information section of the Event Manager page. By default this is set to localhost, but will not work
for remote hubs. Distributed collector attempts to set this field to the fully qualified domain name of the Zenoss
server when it is installed. If remote hubs appear to be having trouble connecting to MySQL or sending events,
then check the value in this field to make sure it can be reached from the server the hub is on.
Another aspect of remote hubs connecting to MySQL is privileges. For a hub to connect to the events database,
the user specified in the User Name field in Event Settings must be granted privileges to connect to MySQL
from the remote server. Distributed Collector attempts to grant these privileges any time a remote hub is created
or updated. If a remote hub is logging error messages that indicate it is not allowed to connect to MySQL from
the given host, then these privileges are likely not set up correctly. Granting of these privileges requires a fully
qualified domain name for the remote server.
Before adding a hub, ensure MySQL grants and permissions are set correctly.
The zenoss user needs the following privileges set to see if a remote connection is possible:
GRANT SELECT on mysql.user to zenoss@localhost IDENTIFIED BY "zenoss";
FLUSH PRIVILEGES;
In addition, a zenoss MySQL user is needed that can access the database by using the fully qualified domain
name of the zenoss installation:
77
Distributed Collector
GRANT ALL PRIVILEGES ON events.* to zenoss@'<FQDN>' IDENTIFIED BY "zenoss";
GRANT SELECT on mysql.user to zenoss@'<FQDN>' IDENTIFIED BY "zenoss";
FLUSH PRIVILEGES;
When you add the remote hub, you will see an error that indicates how to add a remote MySQL user for the hub
to be installed. To resolve this issue, do one of the following:
•
Open remote privileges to the ZEO database with:
GRANT ALL PRIVILEGES ON events.* to zenoss@'%' IDENTIFIED BY "zenoss";
FLUSH PRIVILEGES;
OR
•
Add a zenoss MySQL user for each remote hub:
GRANT ALL PRIVILEGES ON events.* to zenoss@'<ZENHUB FQDN>' IDENTIFIED BY "zenoss";
FLUSH PRIVILEGES;
26.7.2. Add a Hub
When installing a remote hub, you can select one of several options, using:
•
Root password to the remote host
•
Pre-existing root SSH keys
•
Zenoss SSH keys (use only for RPM installations)
To add a hub, from the main Collectors page, select Add Hub from the table menu.
The Add Hub page appears.
26.7.2.1. Install Remotely (Root Password)
To install a remote hub, using a root password for access to the remote host:
1. Select the root password option.
Figure 26.8. Install Remote Hub (Root Password)
78
Distributed Collector
2. Enter or change setup details:
•
Hub ID - Enter a name for the new hub. The name can be any unique combination of letters, digits,
and dashes.
•
Host - Enter the fully qualified domain name, IP address, or resolvable hostname of the server on which
the new hub will run.
•
Root Password - Enter the root user password for the server you specified in the Host field.
•
Port - Enter the port number on which the hub should listen for collectors. The default port is 8790.
•
Hub Password - Enter the hub password that the collectors will use to log in to this hub. The default
password is "zenoss."
•
XML RPC Port - Specify the port on which the hub should listen for xml-rpc requests from the collectors
or other API clients.
•
ZEO Host - Specify the server hosting the ZEO database (the object database). In most cases, this is
the IP address or hostname of the main Zenoss server.
3. Click Add Hub.
The system displays log output from the creation of the new hub. When fully configured (this may require
several minutes), click the link at the bottom of the page to go to the overview page for the new hub.
26.7.2.2. Install Remotely (Root SSH Keys)
To install a remote hub, using existing root SSH keys for access to the remote host:
1. Select the root SSH keys option.
Figure 26.9. Install Remote Hub (Root SSH Keys)
2. Enter or change setup details:
•
Hub ID - Enter a name for the new hub. The name can be any unique combination of letters, digits,
and dashes.
•
Host - Enter the fully qualified domain name, IP address, or resolvable hostname of the server on which
the new hub will run.
•
Port - Enter the port number on which the hub should listen for collectors. The default port is 8790.
79
Distributed Collector
•
Hub Password - Enter the hub password that the collectors will use to log in to this hub. The default
password is "zenoss."
•
XML RPC Port - Specify the port on which the hub should listen for xml-rpc requests from the collectors
or other API clients.
•
ZEO Host - Specify the server hosting the ZEO database (the object database). In most cases, this is
the IP address or hostname of the main Zenoss server.
3. Click Add Hub.
The system displays log output from the creation of the new hub. When fully configured (this may require
several minutes), click the link at the bottom of the page to go to the overview page for the new hub.
26.7.2.3. Install Remotely (Zenoss SSH Keys)
If you choose to set up a hub using Zenoss SSH keys, Zenoss will attempt to install by using the zenoss user.
To successfully install a hub using these keys (without root access), these prerequisite conditions must be met:
•
zenoss user SSH keys must be set up between the Zenoss server and the target. The target must have
a zenoss user.
•
ZENHOME directory must be present on the remote machine.
•
zensocket must be present on the remote machine, and the setuid bits must be set.
Tip: The best way to meet the prerequisite conditions is to install the Zenoss RPM on the remote machine. After
installation, do not start Zenoss.
Follow these steps to install a remote hub, using Zenoss SSH keys for access to the remote host.
For detailed steps for creating SSH keys, see the section titled "Setting Up SSH Keys for Distributed Collector."
1. Select the zenoss SSH keys option.
Figure 26.10. Install Remote Hub (Zenoss SSH Keys)
2. Enter or change setup details:
80
Distributed Collector
•
Hub ID - Enter a name for the new hub. The name can be any unique combination of letters, digits,
and dashes.
•
Host - Enter the fully qualified domain name, IP address, or resolvable hostname of the server on which
the new hub will run.
•
Port - Enter the port number on which the hub should listen for collectors. The default port is 8790.
•
Hub Password - Enter the hub password that the collectors will use to log in to this hub. The default
password is "zenoss."
•
XML RPC Port - Specify the port on which the hub should listen for xml-rpc requests from the collectors
or other API clients.
•
ZEO Host - Specify the server hosting the ZEO database (the object database). In most cases, this is
the IP address or hostname of the main Zenoss server.
3. Click Add Hub.
The system displays log output from the creation of the new hub. When fully configured (this may require
several minutes), click the link at the bottom of the page to go to the overview page for the new hub.
26.7.3. Setting Up SSH Keys for Distributed Collector
Follow these instructions to create SSH keys for use when setting up hubs and collectors.
These instructions assume you are using openssh. For more information, refer to the ssh-keygen man pages.
1. Use the following commands to generate an openssh RSA key pair for the zenoss user:
mkdir $HOME/.ssh
ssh-keygen -t rsa -f $HOME/.ssh/id_rsa -p "
2. Lock down the key pair:
chmod 700 $HOME/.ssh
chmod go-rwx $HOME/.ssh/*
3. Copy the generated public key $HOME/.ssh/id_rsa.pub file to the remote machine. On the remote machine,
add the public key to the authorized_keys file in the account the user wants to log in to by using the SSH key.
a. If $HOME/.ssh does not exist on the target machine, then create it with these commands:
mkdir ~/.ssh
chmod 700 ~/.ssh
b. Add the key:
cat id_rsa.pub >> $HOME/.ssh/authorized_keys
chmod 600 $HOME/.ssh/authorized_keys
You cannot use keys with a pass phrase with Zenoss.
81
Chapter 27. Enterprise Collector
27.1. About
The Zenoss Enterprise Collector ZenPack allows collector daemons to start and monitor devices, even if a
connection to ZenHub is not available when the daemon starts.
Enterprise Collector enables configuration caching for these collector daemons:
•
zenwin
•
zeneventlog
•
zenwinperf
•
zenprocess
Data and events are cached locally and are sent to ZenHub as needed after a connection is re-established.
Cached configuration data is stored in $ZENHOME/perf/Daemons/MonitorName/DaemonName-Suffix, where Suffix
is one of:
•
configs.db
•
properties.pickle
•
threshold-classes.pickle
•
thresholds.pickle
For example:
[zenoss@zenosst zenpacks]$ ls $ZENHOME/perf/Daemons/localhost/zeneventlog*
/opt/zenoss/perf/Daemons/localhost/zeneventlog-configs.db
/opt/zenoss/perf/Daemons/localhost/zeneventlog-properties.pickle
/opt/zenoss/perf/Daemons/localhost/zeneventlog-threshold-classes.pickle
/opt/zenoss/perf/Daemons/localhost/zeneventlog-thresholds.pickle
Each time a collector daemon successfully retrieves configuration information from ZenHub, it updates the
cached files. This happens at startup, and then every 20 minutes to 6 hours (depending on the daemon and
its configuration). A daemon must successfully connect once before it can use the cached files if ZenHub is
not available.
The cached files are considered transient, and can be deleted without harm to the system.
27.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.5 or higher
Table 27.1. Enterprise Collector Prerequisites
27.3. Enabling Enterprise Collector
After installing the Enterprise Collector ZenPack, restart Zenoss and all Zenoss daemons (including zenhub).
82
Chapter 28. Enterprise Linux
28.1. About
The EnterpriseLinux ZenPack extends the capabilities of the LinuxMonitor ZenPack and enables Zenoss to use
Secure Shell (SSH) to monitor Linux hosts. Zenoss models and monitors devices placed in the /Server/SSH/
Linux device class by running commands and parsing the output. Parsing of command output is performed on
the Zenoss server or on a distributed collector. The account used to monitor the device does not require root
access or special privileges for the default modeler plugins.
28.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.4 or higher
Required ZenPacks
ZenPacks.zenoss.LinuxMonitor,
ZenPacks.zenoss.EnterpriseLinux
Table 28.1. Enterprise Linux Prerequisites
If using a distributed collector setup, SSH requires firewall access (default of port 22) from the collector to
the monitored server.
28.3. Add a Linux Server
The following procedure assumes that the credentials have been set
1. From the navigation bar, click on the Add Device item under the Management section.
2. Enter in the following information:
Name
Description
Device Name
Linux host to model
Device Class Path
/Server/SSH/Linux
Discovery Protocol
Set this to auto unless adding a device with username/password different than found in the device class. If you set this
to none, then you will need to add the credentials (see Section 28.4, “Set Linux Server Monitoring Credentials”) and then
manually model the device.
Table 28.2. Adding Linux device information
3. Click on the Add Device button to add the device.
28.4. Set Linux Server Monitoring Credentials
All Linux servers must have a device entry in an organizer below the /Devices/Server/SSH/Linux device class.
The SSH monitoring feature will attempt to use key-based authentication before using a zProperties password value.
1. Navigate to the device or device class in the Zenoss web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Verify the credentials for the service account to access the service.
83
Enterprise Linux
Name
Description
zCommandUsername
Linux user with privileges to gather performance information.
zCommandPassword
Password for the above user.
Table 28.3. Linux zProperties
4. Click Save to save your changes.
28.5. Resolving CHANNEL_OPEN_FAILURE Issues
The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:
ERROR zen.SshClient CHANNEL_OPEN_FAILURE: Authentication failure
WARNING:zen.SshClient:Open of command failed (error code 1): open failed
If the sshd daemon's log file on the remote device is examined, it may report that the MAX_SESSIONS number
of connections has been exceeded and that it is denying the connection request. At least in the OpenSSH
daemons, this MAX_SESSIONS number is a compile-time option and cannot be reset in a configuration file.
In order to work around this limitation of the sshd daemon, use the zProperty zSshConcurrentSessions to control
the number of connections created by zencommand to the remote device.
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Apply an appropriate value for the maximum number of sessions.
Name
Description
zSshConcurrentSessions
Maximum number of sessions supported by the remote device's
MAX_SESSIONS parameter. A common value for Linux is 10.
Table 28.4. Concurrent SSH zProperties
4. Click Save to save your changes.
28.6. Resolving Command timed out Issues
The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:
WARNING:zen.zencommand:Command timed out on device device_name: command
If this occurs, it usually indicates that the remote device has taken too long in order to return results from the
commands. In order to increase the amount of time to allow devices to return results, change the zProperty
zCommandCommandTimeout to a larger value.
1. Navigate to the device or device class in the Zenoss web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Apply an appropriate value for the command timeout.
Name
Description
zCommandCommandTimeout
Time in seconds to wait for commands to complete on the remote device.
Table 28.5. SSH Timeout zProperties
4. Click Save to save your changes.
84
Enterprise Linux
28.7. DMIDECODE Modeler Plugin
This plugin allows you to collect and model detailed hardware and kernel information on your Linux devices.
Since the dmidecode command requires root privileges, it needs to be run with something like sudo. Sample
entries required on the sudoers file on each remote device are:
Cmnd_Alias DMIDECODE = /usr/sbin/dmidecode
## Allows members of the zenoss group to gather modeling information
Defaults:zenoss !requiretty
%zenoss ALL = (ALL) NOPASSWD: DMIDECODE
To use this plugin, add it to the list of collector plugins for the device or device class, and then remodel. For
more information on working with Zenoss plugins, refer to Zenoss Administration.
28.8. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zencommand
Table 28.6. Daemons
85
Chapter 29. Enterprise Reports
29.1. About
The EnterpriseReports ZenPack adds new reports to the standard Zenoss reports. Available reports include:
•
95th Percentile
•
Alert Rule Email Addresses
•
Defined Thresholds
•
Event Time to Resolution
•
Interface Volume
•
Maintenance Windows
•
Organizer Availability
•
User Event Activity
•
Users Group Membership
To access Enterprise reports, navigate in the interface to Enterprise Reports in the Reports section.
29.1.1. 95th Percentile
The 95th Percentile report provides details about all network interfaces in the system, sorted by highest utilization.
95th percentile is a widely used mathematical calculation that evaluates the regular and sustained utilization
of a network connection. The 95th percentile method more closely reflects the needed capacity of the link in
question than other methods (such as mean or maximum rate).
This report is useful for network capacity planning and billing for either average or 95th percentile bandwidth
utilization.
Figure 29.1. 95th Percentile Report
You can filter this report by device name. Enter a complete or partial name (using * (asterisk) for matching), and
then click Update to filter the report.
86
Enterprise Reports
To change the reporting time period, enter Start and End dates (or click Select to select dates from a calendar).
Click Update to refresh the report.
29.1.2. Alert Rule Email Addresses
The Alert Rule Email Addresses report displays all alert rules and the email addresses to which alerts are sent.
This report is useful when reviewing which users receive certain types of system alerts.
29.1.3. Defined Thresholds
The Defined Thresholds report provides details about all thresholds defined in the system. The report links to
the target of each threshold. The target can be a device class, individual device, or individual component.
This report is useful for administering the system. You can use it to quickly identify which threshold events can
occur within the system, and the severity of those events.
Figure 29.2. Defined Thresholds Report
29.1.4. Event Time to Resolution
The Event Time to Resolution report shows, for each user, the total time taken to acknowledge or clear events.
Results are organized by event severity.
This report is helpful for tracking response time SLAs in a NOC-type environment.
29.1.5. Interface Volume
The Interface Volume report shows network interface volume. It reports on all network interfaces in the system,
sorted by highest utilization. Volume is defined as the total number of bytes transferred during a specific reporting
period.
This report is useful for determining billing on total bandwidth consumption.
87
Enterprise Reports
Figure 29.3. Interface Volume Report
To change the reporting time period, enter Start and End dates (or click Select to select dates from a calendar).
Click Update to refresh the report.
29.1.6. Maintenance Windows
The Maintenance Windows report shows all defined windows that are active during a selected time period.
Figure 29.4. Maintenance Windows
To change the reporting time period, enter Start and End dates (or click Select to select dates from a calendar).
Click Update to refresh the report.
29.1.7. Organizer Availability
Provides the availability percentage of all network organizers in the system. This report can be filtered by organizer, event class, component, and date.
You can report on the availability of device classes, locations, systems, or groups within a defined time frame.
This report offers two reporting modes:
•
Averaged - Defines the organizer as available for the average availability time for all devices contained in it.
•
Coalesced - Defines the organizer as available only if all devices are available during a certain time period.
Two modes of operation: Averaged - defines the organizer as available for the average availability time for all the
devices contained within it. Coalesced - defines availability of the organizer as the available only if all devices
are available during a certain time period.
29.1.8. User Event Activity
Reports the total number of events acknowledged and cleared, on a per-user basis, during the reporting period.
This report is helpful for tracking operator activity in a NOC-type environment.
88
Enterprise Reports
29.1.9. Users Group Membership
Shows all users and the groups to which they belong.
29.2. Viewing Enterprise Reports
After installing the EnterpriseReports ZenPack, you can access Enterprise reports:
1. From the Zenoss interface, click Reports in the navigation menu.
2. In the Reports lists, click Enterprise Reports.
29.3. Prerequisites
Prerequisite
Restriction
Zenoss version
Zenoss version 2.2 or higher
Zenoss Product
Zenoss Enterprise
Required ZenPacks
ZenPacks.zenoss.EnterpriseReports
Table 29.1. Enterprise Reports Prerequisites
89
Chapter 30. Enterprise Security
30.1. About
The EnterpriseSecurity ZenPack enhances Zenoss security by enabling password encryption. Zenoss stores
the passwords it uses to remotely access hosts in a Zope Object Database (ZODB). After enabling this feature,
these passwords are encrypted according to the Advanced Encryption Standard (AES), with 256-bit key sizes.
By using the password encryption feature, you can help prevent an attacker from accessing your managed
systems if he gains access to a backup copy of your ZODB.
30.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.5 or higher
Required ZenPacks
EnterpriseSecurity
Table 30.1. Enterprise Security Prerequisites
30.3. Enabling Password Encryption
To enable password encryption, install the ZenPack. No other action is required to enable this feature. After
ZenPack installation, password encryption is always enabled.
To test that password encryption is functioning correctly, use grep to search the Data.fs file for the value of one
of the password zProperties. For example, if you set zCommandPassword to a value of wobet51, you can check
that passwords are encrypted by using this command on the Zenoss server:
strings $ZENHOME/var/Data.fs | grep wobet51
If the Enterprise Security ZenPack is installed, this command will not return results.
90
Chapter 31. Foundry Device
31.1. About
The FoundryMonitor ZenPack models specific details on Foundry devices, including:
•
DRAM
•
Serial Number
•
Processor
•
Product type
This ZenPack monitors memory utilization, as well as CPU utilization averages for 1 minute, 1 second, and 5
seconds.
It also includes all Foundry traps to ensure proper decoding of those traps through zentrap.
31.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.4 or higher
Required ZenPacks
ZenPacks.zenoss.FoundryMonitor
Table 31.1. Foundry Prerequisites
31.3. Configuring Zenoss
All Foundry devices must exist in the /Devices/Network/Foundry device class.
Follow these steps to configure Zenoss:
1. In the Zenoss interface, navigate to the device or device class (if configuring multiple devices) in the /
Devices/Network/Foundry device class.
2. If applying changes to a device, select the page menu, and then select More → zProperties.
If applying changes to a device class, select the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your network administrators to determine the SNMP community permitted.
zSnmpMonitorIgnore
Set to a value of False.
zSnmpPort
The default port is 161.
zSnmpVer
Set to a value of v2c.
Table 31.2. Foundry zProperties
4. Click Save to save your changes. Zenoss now will begin collecting Foundry device metrics from this device.
5. Navigate to the Perf tab to see placeholders for graphs. After approximately 15 minutes the graphs start
to become populated with information.
91
Foundry Device
31.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Traps
zentrap
Table 31.3. Daemons
92
Chapter 32. JBoss Application Server
32.1. About
the JBossMonitor ZenPack that system administrators to monitor JBoss Application Servers. JBossMonitor uses
the JMX Remote API and accesses MBeans deployed within JBoss that contain performance information about
the components that are being managed.
The collected performance information includes: pool sizes for data sources (JDBC), Enterprise Java Beans
(EJBs), message queues (JMS), threads, servlets, JSPs, and classloaders. Cache information is also accessible, providing system administrators insight into the number of hits (or misses) their cache policy has produced.
The ZenPack also aggregates individual performance metrics into higher level concepts that provide a picture
of the performance of the application. Cache hits and misses are combined on the same graph to provide an
overall picture of cache performance. Likewise, queue metrics are combined to show the number of messages
currently on the queue, being processed, and being placed on the queue. Queue subscribers and publishers
are also graphed.
Each of the individual performance metrics can be trended and predicted, and thresholds can be explicitly defined. Both the predicted thresholds and explicit thresholds inform system administrators of potential future problems before they occur. Since so much of J2EE involves "managed resources", the ability to monitor pool sizes
and alert administrators prior to resources being exhausted is extremely valuable and can reduce the likelihood
of a fatal outage caused by resource depletion.
Most of the metrics that are collected in JBossMonitor represent combinations of individual component metrics.
For example, the Thread Pool metric represents all threads in all pools. It is possible to configure JBossMonitor
to perform at higher granularity and have it monitor a Thread Pool with a particular name. However, since these
names are application specific we have chosen to configure JBossMonitor to collect at a rather coarse-grained
level by default. The installer is highly encouraged to customize and configure!
One particular performance template that requires end-user configuration involves Servlets. If a site to be monitored is revenue generating, and credit card submissions from the website are handled via a back-end servlet,
it may be critically important to monitor the resources made available by the JBoss container to the servlet container. If the number of free spaces in the servlet pool dwindles to zero it could prevent your application from
making a sale.
The following are the collected metrics for JBoss servers:
•
Active Threads
•
JMS Message cache memory usage
•
JMS Message hits/misses
•
JMS Topic/Destination queue size
•
Java heap memory usage
•
JCA commit, rollback, and transaction count
•
JCA Connection pool in-use connections and available connections
•
JCA connections created/destroyed
•
JCA total connections
•
JGroups cluster messages sent/received
•
JGroups cluster bytes sent/received
•
MBean creation/removal count
•
MBean messages processed count
93
JBoss Application Server
32.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenJMX,
ZenPacks.zenoss.JBossMonitor
Table 32.1. JBoss Prerequisites
32.3. Enable Monitoring
32.3.1. Configuring JBoss to Allow JMX Queries
JBoss uses the JAVA_OPTS approach for enabling remote access to beans. However, it requires some additional
properties. To set up your JAVA_OPTS for use in JBoss see the following code segment:
JAVA_OPTS="-Dcom.sun.management.jmxremote.port=12345"
JAVA_OPTS="${JAVA_OPTS} -Dcom.sun.management.jmxremote.authenticate=false"
JAVA_OPTS="${JAVA_OPTS} -Dcom.sun.management.jmxremote.ssl=false"
JAVA_OPTS="${JAVA_OPTS} -Djboss.platform.mbeanserver"
JAVA_OPTS="${JAVA_OPTS} -Djavax.management.builder.initial=org.jboss.system\
.server.jmx.MBeanServerBuilderImpl"
export JAVA_OPTS
When you start JBoss via the run.sh you must also pass the "-b 0.0.0.0" argument:
cd ${JBOSS_HOME}/bin
./run.sh -b 0.0.0.0
JMX actually uses two separate ports for MBean access: one is used for initial connection handling and authentication, and the other is used for RMI access. During the handshake between a JMX Client and the JMX
Agent the agent tells the client the IP address and port number for the RMI registry. By default JBoss sets the
IP address to 127.0.0.1. This works when the JMX client and the JMX agent reside on the same device, but it
won't work in a distributed environment.
By passing the "-b 0.0.0.0" argument you instruct JBoss to bind to all available network ports, and this results
in the JMX Agent's handshaking logic using a network reachable address when informing clients of the RMI
registry hostname and port.
32.3.2. Configuring Zenoss
All JBoss services must have a device entry under the /Devices/Server/JBoss device class.
The zenjmx daemon must be configured and running. See Section 10.2.1, “Sun Java Runtime Environment
(JRE)” for more information about configuring the zenjmx daemon with the Sun JRE tools.
1. Navigate to the device or device class under the /Devices/Server/JBoss device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
94
JBoss Application Server
Name
Description
zJBossJmxManagementAuthenticate
This zProperty is deprecated.
zJBossJmxManagementPassword
JMX password
zJBossJmxManagementPort
The port number used to gather JMX information
zJBossJmxManagementUsername
JMX username for authentication
Table 32.2. JBoss zProperties
4. Click Save to save your changes.
You will now be able to start collecting the JBoss server metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
The out-of-the-box JBoss data source configuration has been defined at the macro level, but can be configured to operate on a more granular basis. For example, the Servlet Reload Count applies to all servlets in all
web applications but it could be narrowed to be Servlet /submitOrder in web application "production server".
32.4. Change the Amount of Data Collected and Graphed
1. Navigate to the device or device class under the /Devices/Server/JBoss device class in the Zenoss web
interface.
2. Click the page menu, then select More → Templates.
3. From the table menu select the Bind Templates... item to display the Bind Performance Templates dialog.
4. To add other templates and retain existing performance templates, hold down the control key while clicking
on the original entries.
Name
Description
JBoss Core
Core information about any JBoss server, including memory usage, threads, and uptime.
JBoss JCA Connection Pool
JBoss JGroups Channel
JBoss JMS Cache
JBoss JMS Destination
JBoss JMS Topic
JBoss Message Driven EJB
Table 32.3. JBoss Templates
5. Click the OK button to save your changes.
32.5. Viewing Raw Data
See the Section 10.5, “Using JConsole to Query a JMX Agent” section for more information about how to
investigate raw data returned back from the application.
32.6. Daemons
Type
Name
Performance Collector
zenjmx
Table 32.4. Daemons
95
Chapter 33. Juniper Devices
33.1. About
The JuniperMonitor ZenPack allows system administrators to monitor their Juniper devices.
33.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.JuniperMonitor
Table 33.1. Juniper Prerequisites
33.3. Enable Monitoring
33.3.1. Configuring Juniper Devices to Allow SNMP Queries
Configure the Juniper device to allow SNMP queries from the Zenoss server, and send SNMP v1 or SNMP v2
traps to the Zenoss server.
33.3.2. Configuring Zenoss
All Juniper devices must exist under the /Devices/Network/Juniper device class.
1. Navigate to the device or device class under the /Devices/Network/Juniper device class in the Zenoss
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your network administrators to determine the SNMP community permitted.
zSnmpMonitorIgnore
This should be set to False
zSnmpPort
The default port is 161.
zSnmpVer
This should be set to v2c
Table 33.2. Juniper zProperties
4. Click Save to save your changes. You will now be able to start collecting the Juniper device metrics from
this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
33.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 33.3. Daemons
96
Chapter 34. LDAP Authentication
34.1. About
The LDAPAuthenticator Enterprise ZenPack allows Zenoss to use your existing LDAP authentication infrastructure (such as Active Directory or OpenLDAP) to enable single sign-on to the Zenoss Web interface. For example,
you can reuse the user management tools with which you are familiar to enable your Windows users to use their
Windows credentials to authenticate to the Zenoss interface. This saves you from having to manually create
user accounts and separately maintain passwords.
The benefits of using a service like LDAP to maintain user accounts and privileges include:
•
Does not require users to remember yet another password. This decreases support and maintenance requirements.
•
Allows centralized management of each user's privileges. This enables easier security auditing and SOX
reporting.
Authentication logging is stored in the $ZENHOME/log/event.log file.
34.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.LDAPAuthenticator
Table 34.1. LDAP Authentication Prerequisites
34.2.1. LDAP Configuration Information
Before configuring LDAP authentication, you must gather the following information from your LDAP or Active
Directory administrator. Here is a list of the required information:
•
Hostname or IP address of an Active Directory global catalog server. (Active Directory authentication only)
•
Hostname or IP address of an LDAP server. (other LDAP server authentication only)
•
User's base Distinguished Name (DN). For example, if your domain was ad.zenoss.com, then your user's
base DN might be:
cn=users,dc=ad,dc=zenoss,dc=com
•
Manager DN. This is the DN (distinguished name) of a user in the domain administrators group. An example
that follows the user's base DN is:
cn=Administrator,cn=users,dc=ad,dc=zenoss,dc=com
•
Optional: Active Directory groups to map to Zenoss roles. You can choose to control user roles within the
Zenoss Web interface using Active Directory groups instead of controlling the roles directly from within
Zenoss. If you do choose to do this you should create the following groups within Active Directory.
•
Zenoss Managers
•
Zenoss Users
Zenoss recommends that you make sure that your LDAP server requires at least four successive failures to
lock an account. Due to authentication design, each login to Zenoss goes through three different Web pages.
Each one of these pages requests a user authentication, which ends up making a single call to the LDAP
backend. Thus, if the user makes one mistake and the LDAP server locks the account on three successive
failures, the user's account will be locked even though he specified the password once.
97
LDAP Authentication
34.3. Limitations
You cannot use LDAP SSL on CentOS4 or the Zenoss Appliance.
34.4. Authenticating with Microsoft Active Directory
34.4.1. Adding the Authentication Plugin
To add the plugin, you must access the ZMI (Zope Management Interface). This allows raw access to the Zope
application server and its configured objects. These steps show how to add the ActiveDirectory Multi Plugin
with its default settings.
1. Browse to this URL:
http://YourZenossInstallation:8080/zport/acl_users/manage
2. Choose the ActiveDirectory Multi Plugin plugin, and then click Add.
3. Complete the form with your credentials and paths:
Name
Description
ID
Enter adPlugin.
Title
Enter a title, or leave blank.
LDAP Server[:port]
Specify the address of the global catalog server from the prerequisites section. It should either be the resolvable hostname
or IP address of the global catalog server followed by :3268 Example: ad1.zenoss.com:3268
If using SSL, the name must be specified.
Read-only
Select this option.
Users Base DN
Use the value obtained from your AD administrator.
Group storage
Groups not stored on LDAP server.
Groups Base DN
Use the value obtained from your AD administrator.
Manager DN
Use the value obtained from your AD administrator.
Password
Use the value obtained from your AD administrator.
Table 34.2. Active Directory Multi Plugin Configuration
4. Click Add to save your changes.
34.4.2. Configuring Plugin Settings
The default plugin settings need some customizations.
1. Browse to this URL:
http://yourzenossinstallation:8080/zport/acl_users/adPlugin/manage
2. Check the following boxes:
•
Authentication
•
Properties
•
User_Enumeration
•
Roles ([Select only if a default role other than Anonymous is desired.])
•
Role_Enumeration ([Select only if a default role other than Anonymous is desired.])
3. Click Update to save your changes.
98
LDAP Authentication
4. Click Contents tab.
5. Click acl_users folder.
6. Set the following:
Name
Description
User ID Attribute
Windows Login Name (sAMAccountName)
RDN Attribute
Windows Login Name (sAMAccountName)
Table 34.3. Active Directory acl_users Folder Customizations
7. Click Apply Changes to save your changes.
8. Click LDAP Schema tab.
9. In the Add LDAP schema item section, set the following:
Name
Description
LDAP Attribute Name
mail
Friendly Name
Email Address
Multi-valued
No
Map to Name
email
Table 34.4. Active Directory Schema Item Configuration
10. Click Apply Changes to save your changes.
11. Click Add to save your changes.
34.4.3. Enabling Group to Role Mapping
You can optionally control your users' roles within Zenoss by using the Active Directory groups. If you choose
not to do this, you can control their access by setting their roles within the user management section of the
Zenoss Web interface. If you choose to use Active Directory groups, you should use the following steps.
1. Browse to this URL:
http://yourzenossinstallation:8080/zport/acl_users/manage
2. Put a check in Roles and click Update.
3. Click Properties tab.
4. Change the groupid_attr to: cn.
5. Click Save Changes to save your changes.
6. Click Contents tab.
7. Click acl_users folder.
8. Set the following:
Name
Description
Group storage
Groups stored on LDAP server
Group mapping
Manually map LDAP groups to Zope roles
Table 34.5. Active Directory Group to Role Configuration
9. Click Apply Changes to save your changes.
10. Click Groups tab.
11. Scroll to the bottom of the page and in the Add LDAP group to Zope role mapping section:
a. Choose Zenoss Managers on the left and Manager on the right.
99
LDAP Authentication
b. Click Add.
c. Choose Zenoss Users on the left and ZenUser on the right.
d. Click Add.
e. Click Apply Changes to save your changes.
34.4.4. Verifying Connectivity and Credentials Outside of Zenoss
Verify your credential information is valid from the Zenoss server by using the ldapsearch command. To install
this command, use the following for RPM-based systems:
# yum -y install openldap-clients
For the appliance, use the command:
# conary update openldap-clients
as the zenoss user on the Zenoss server:
ldapsearch -LLL -x -b 'BaseDN' -D 'Bind DN' -W -H ldap://LDAP_server-name \
"sAMAccountName=*" member
34.5. Authenticating with other LDAP Servers
1. Browse to this URL:
http://yourzenossinstallation:8080/zport/acl_users/manage
2. Choose the LDAP Multi Plugin plugin, and then click Add.
3. Complete the form with your LDAP credentials and paths:
Name
Description
ID
Enter ldapAuthentication.
Title
Enter a title or leave blank.
LDAP Server[:port]
Specify the name or IP address of the LDAP server. The default port is 389, and the default port for SSL is 636, so the port
doesn't need to be specified if using the defaults. If using SSL,
the name must be specified.
Default User Roles
Set to ZenUser. If this is set as blank, LDAP users will not be
able to log in.
Table 34.6. LDAP Multi Plugin Configuration
4. Click Add to save your changes.
5. Click plugins in the list of objects.
6. Click the Authentication Plugins link.
7. Move your ldapAuthentication plugin to the list of active plugins.
34.6. Optimizing Authentication with a Cache
Once you have configured third-party authentication, you should enable caching. Without a cache of LDAP
responses, your Zenoss server must repeatedly query the configured LDAP server or servers for user, group and
authentication information. The following steps describe the process of setting up caching of LDAP responses.
1. Log in to Zenoss as a user with the Manager role.
2. Navigate to /zport/acl_users/manage in the Web interface. Do this by replacing the end of your URL within
the Zenoss Web interface.
100
LDAP Authentication
3. Choose RAM Cache Manager from the list of options at top-right.
Figure 34.1. Add RAM CAche
4. Set the Id to RAMCache, and then click Add.
5. Click the new RAMCache added to the list to configure it.
a. Erase AUTHENTICATED_USER from the REQUEST variables field.
b. Click Save Changes.
6. Click acl_users in the breadcrumbs to go back to the acl_users folder.
Figure 34.2. acl_users Breadcrumbs
7. Click the Cache tab.
8. Select RAMCache from the Cache this object using list, and then click Save Changes.
9. Click the Contents tab.
10. Click the adPlugin or ldapAuthentication plugin, and then click the Cache tab.
11. Select RAMCache from the list and click Save Changes.
34.7. Configuring Local Authentication as a Fallback
You can use local authentication as a fallback in the event that the LDAP server is unreachable. The local
authentication plugin is called userManager.
1. Go to http://yourzenoss:8080/zport/acl_users/manage to access the ZMI.
2. Click on plugins from the list.
3. Click on the Authentication Plugins link.
4. Make sure your LDAP plugin is the first in the list on the right and that userManager is below it.
5. Users who require local fallback authentication must have local passwords setup. This can be done from
the normal user preferences in the Zenoss interface.
101
Chapter 35. Mail Transactions
35.1. About
The ZenMailTx ZenPack allows you to monitor round-trip email delivery.
35.1.1. Events
There are several situations for which ZenMailTx will create events. The component will be zenmailtx, the
eventGroup will be mail and the eventClass will be /Status. These situations are:
•
The SMTP server name or the POP server name cannot be resolved.
•
The SMTP server or the POP server is down or unavailable.
•
The timeout (specified on the Data Source tab) is exceeded for the SMTP or POP server.
•
Authentication (if specified) with the SMTP or POP server fails.
•
A threshold defined for one of the data points in this data source is exceeded. Thresholds are defined in the
performance template that contains the data source.
Once an email has successfully made a trip back and forth, a clear event is created that clears any failure events.
35.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenMailTx
Table 35.1. Mail Transactions Prerequisites
35.3. Enable Monitoring
1. Navigate to the device in the Zenoss Web interface.
2. Click the page menu, and then select More → Templates.
3. Select Add Template from the page menu.
4. Enter an identifier for the template (such as ZenMailTx), and then click OK to create the template.
5. Click the newly created ZenMailTx template.
6. Select Add Datasource from the Data Sources table menu.
7. Enter a name for the data source (MailTx), select MAILTX as the type, and then click OK.
8. Change options as needed.
Option
Description
To Address
The e-mail address that will appear in the From: field in the generated e-mail.
From Address
The e-mail address where the generated e-mail should be sent.
SMTP Host
The e-mail server where the e-mail should be sent.
POP Host
The POP server from which the test e-mail will be received.
Table 35.2. Mail Transactions Basic Data Source Options
Any of the MAILTX fields can take TAL expressions, including the password fields.
9. Click Save to save your changes.
102
Mail Transactions
10. Navigate to the Perf tab and you should see some place holders for graphs. After approximately 15 minutes
you should see the graphs begin populating with information.
35.4. Daemons
Type
Name
Performance Collector
zenmailtx
Table 35.3. Daemons
103
Chapter 36. MS Active Directory
36.1. About
The ActiveDirectory ZenPack allows you to monitor Microsoft Active Directory authentication metrics.
This ZenPack creates a device class for Microsoft Active Directory with appropriate priorities. It also creates a
Windows Service class and IP Service class for Active Directory-related services with monitoring enabled.
Use the Active Directory ZenPack to monitor these metrics:
•
DS Client Binds/Sec
•
DS Directory Reads/Sec, Searches/Sec and Writes/Sec
•
DS Monitor List Size
•
DS Name Cache Hit Rate
•
DS Notify Queue Size
•
DS Search Sub-operations/Sec
•
DS Server Binds/Sec, Server Name Translations/Sec
•
DS Threads In Use
•
KDC AS Requests, TGS Requests
•
Kerberos Authentications
•
LDAP Active Threads
•
LDAP Bind Time
•
LDAP Client Sessions
•
LDAP New / New SSL and Closed Connections/Sec
•
LDAP Searches/Sec, Writes/Sec
•
LDAP Successful Binds
•
LDAP UDP Operations/Sec
•
NTLM Authentications
36.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenWinPerf,
ZenPacks.zenoss.ActiveDirectory
Table 36.1. Active Directory Monitoring Prerequisites
36.3. Enable Monitoring
All Active Directory services must have a device entry under the /Devices/Server/Windows/Active Directory
device class. In addition, verify that your Zenoss Windows service account has access to the Active Directory
service.
1. Navigate to the device or device class under the /Devices/Server/Windows/Active Directory device class
in the Zenoss web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
104
MS Active Directory
If applying changes to a device class, click on the zProperties tab.
3. Verify the credentials for the service account to access the service.
Name
Description
zWinUser
Windows user with privileges to gather performance information.
zWinPassword
Password for the above user.
Table 36.2. Active Directory zProperties
4. Click Save to save your changes.
You will now be able to start collecting the Active Directory server metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
36.4. Daemons
Type
Name
Performance Collector
zenwinperf
Table 36.3. Daemons
105
Chapter 37. MS Exchange
37.1. About
The MS Exchange ZenPack is an application monitoring ZenPack that monitors Microsoft Exchange and its
related services. The ZenPack enables users to view graphs based on MS Exchange Performance Counters
and to monitor processes related to MS Exchange.
37.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenWinPerf, ZenPacks.zenoss.MSExchange
Table 37.1. MS Exchange Prerequisites
37.3. Enable Monitoring
All MS Exchange services must have a device entry under the /Devices/Server/Windows/MSExchange device
class. In addition, verify that your Zenoss Windows service account has access to the MS Exchange service.
1. Navigate to the device or device class in the Zenoss web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Verify the credentials for the service account to access the service.
Name
Description
zWinUser
Windows user with privileges to gather performance information.
zWinPassword
Password for the above user.
Table 37.2. MS Exchange zProperties
4. Click Save to save your changes.
You will now be able to start collecting the MS Exchange server metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
37.4. Daemons
Type
Name
Performance Collector
zenwinperf
Table 37.3. Daemons
106
Chapter 38. Microsoft Internet Information
Services (IIS)
38.1. About
The IISMonitor ZenPack collects key metrics from Microsoft IIS. The metrics are collected using Windows Perfmon and does not require an agent to be installed on the IIS server.
•
Connections Attempts
•
Throughput (Bytes & Files)
•
Requests (GET, HEAD, POST, CGI, ISAPI)
•
Standard: GET, HEAD, POST, CGI, ISAPI
•
WebDAV: PUT, COPY, MOVE, DELETE, OPTIONS, PROPFIND, PROPPATCH, MKCOL
•
Other: SEARCH, TRACE, LOCK, UNLOCK
38.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenWinPerf, ZenPacks.zenoss.IISMonitor
Table 38.1. MS IIS Prerequisites
38.3. Enable Monitoring
All IIS servers must have a device entry in an organizer below the /Devices/Server/Windows device class. In
addition, verify that your Zenoss Windows service account has access to the IIS service.
1. Navigate to the device or device class in the Zenoss web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Verify the credentials for the service account to access the service.
Name
Description
zWinUser
Windows user with privileges to gather performance information.
zWinPassword
Password for the above user.
Table 38.2. IIS zProperties
4. Click Save to save your changes.
You will now be able to start collecting the IIS server metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
107
Microsoft Internet Information Services (IIS)
38.4. Daemons
Type
Name
Performance Collector
zenwinperf
Table 38.3. Daemons
108
Chapter 39. Microsoft SQL Server
39.1. About
The MSSQLServer ZenPack monitors Microsoft SQL Server and its related services. The ZenPack enables
users to view graphs based on Microsoft SQL Server Performance Counters and to monitor processes related
to SQL Server.
39.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenWinPerf,
ZenPacks.zenoss.MSSQLServer
Table 39.1. MS SQL Server Prerequisites
39.3. Enable Monitoring
All MS SQL Server services must have a device entry under the /Devices/Server/Windows/MSSQLServer device
class. In addition, verify that your Zenoss Windows service account has access to the MS SQL Server service.
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, and then select More → zProperties.
If applying changes to a device class, click the zProperties tab.
3. Verify the credentials for the service account to access the service.
Name
Description
zWinUser
Windows user with privileges to gather performance information.
zWinPassword
Password for the above user.
Table 39.2. MS SQL Server zProperties
4. Click Save to save your changes.
You will now be able to start collecting the MS SQL Server server metrics from this device.
5. Navigate to the Perf tab to see placeholders for graphs. After approximately 15 minutes, the graphs start
to become populated with information.
39.4. Collecting Information from Non-Default Microsoft SQL
Server Instances
The default Microsoft SQL Sever instance is SQLServer. The performance template delivered with the
MSSQLServer ZenPack uses this default instance to gather performance metrics. If you use a non-default SQL
Server instance, then Zenoss does not automatically find and gather information about it.
To enable Zenoss to monitor a non-default instance, you must copy and modify the performance template:
1. Navigate to the MSSQLServer performance template. This template is located in one of these device classes:
•
/Devices/Server/Windows/WMI/MSSQLServer
109
Microsoft SQL Server
•
/Devices/Server/Windows/MSSQLServer
2. Select the Templates tab.
3. Select the MSSQLServer performance template, and then select Copy Template from the table menu.
4. Select the device class to create the copy. If this is the same device class as the template, then the copy
is named "copy_of_MSSQLServer."
5. Click the new performance template, and update its description to reflect the database instance name.
6. For each of the data sources in the Data Source table, perform these steps:
a. Click the data source to edit it.
b. In the Perf Counter field, change the text "\SQLServer:" to "\MyInstance:" (where MyInstance is the
name of the Microsoft SQL Server database instance name.
c. Click Save.
d. Click the breadcrumb to return to the performance template page.
After completing the template, bind it to the devices or device classes that will use it:
1. Navigate to the device or device class that will use the new template.
2. For a device, select More > Templates from the page menu. (If a device class, select the Templates tab.)
3. Select Bind Templates from the page menu.
4. To add the new template, Shift+Click the performance template, and then click OK.
5. Remodel all devices that use the new performance template.
39.5. Daemons
Type
Name
Performance Collector
zenwinperf
Table 39.3. Daemons
110
Chapter 40. Multi-Realm IP Networks
40.1. About
The Multi-Realm IP ZenPack functionality extends core modeling, monitoring, and event management in Zenoss
to allow for overlapping IP spaces. With this ZenPack, Zenoss can prefix a realm identifier to the IP addresses
on a given network to differentiate these addresses in Zenoss.
There are two primary use cases for using multi-realm IP management.
•
A large company that manages multiple locations that have the same network spaces defined across these
multiple locations and as a result have created multiple overlapping IP spaces and Zenoss needs a way to
identify each separate IP space in the system.
•
Service Providers responsible for monitoring multiple customers where the customers have created independent networks and IP spaces that are unique to their location, but not unique to the Service Provider.
The essential workflow for creating and using IP Realms is that first you need to create the IP realms and
then associate these realms with a collector. The associations between IP Realms and actual devices is made
automatically by the device's association with the collector. All devices on a collector are associated with the
realm for that collector.
The Multi-Realm IP ZenPack is available only by separate download from the Zenoss Support site.
After downloading the ZenPack, you must install it manually. In the Zenoss interface, go to Settings > Zenpacks > Install Zenpack.
40.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.DistributedCollector,
ZenPacks.zenoss.MultiRealmIP
Table 40.1. Multi-realm Prerequisites
40.3. Example System
The diagram below lays out an example setup. It has a central Zenoss server in the 10.10.10.0/24 network. The
network local to the Zenoss server is considered the default network within the system. The default network is
treated exactly the same as a Zenoss system without Multi-Realm IP ZenPack installed.
There are two other networks shown (r1 and r2) which are behind a firewall and have the same IP space
192.168.0.0/24. Each realm has a distributed collector located within it. The collector can be accessed from the
Zenoss server using a IP translation from the firewall to map the address accessible from in front of the firewall
to an address behind the firewall. Remote collectors in a multi-realm setup must be accessible from the central
server using SSH.
111
Multi-Realm IP Networks
Figure 40.1. Example IP Realm
40.4. System Setup
Let's setup Zenoss following the example system described above.
If you don't have overlapping IP space this example can be created using collectors within the same network.
To create the example, add a machine multiple times once per collector, making sure to change the name
of the device as it is added. The result is similar to a real realm setup.
Under multi-realm IP networks, device names must be unique even though the IP addresses will overlap.
40.4.1. Adding Realms
1. Navigate to the /Networks root.
2. On its default page you will now see a table above sub-networks where realms will be listed. Add the realms
r1 and r2.
112
Multi-Realm IP Networks
Figure 40.2. Adding an IP Realm
40.4.2. Adding Collectors to Realms
1. Now add the two collectors that are installed in each realm.
113
Multi-Realm IP Networks
Figure 40.3. Adding a Distributed Collector with an IP Realm
Distributed collectors now have an IP Realm field on their configuration screen set each collector to the
appropriate realm that we configured above.
2. Change each collector so that it is in the correct realm.
114
Multi-Realm IP Networks
Figure 40.4. Changing a Distributed Collector's IP Realm
40.4.3. Adding Devices to Realms
1. Now we are ready to add devices to the system. As mentioned above, adding the same device to the system
twice can simulate a multi-realm setup. Add a device called A.test making sure that when it is added the
collector is set to one of the remote collectors, and not localhost.
115
Multi-Realm IP Networks
Figure 40.5. Adding a Device with a Distributed Collector
2. Now rename the device.
3. Add the device a second time using your other collector, again not localhost.
4. After the device is loaded navigate to the OS tab and follow the network link on one of the interfaces. Notice
that the network has been created underneath the realm created earlier. This configuration is at the heart
of multi-realm, as networks are discovered they are created within each realm.
116
Multi-Realm IP Networks
Figure 40.6. Viewing Devices in Realms
Monitoring is now happening on each representation of the device from the different collectors in different
overlapping realms.
As another test try searching by IP from the top-level search. Two devices will be returned -- one within each
realm.
40.5. Notes
•
If an event contains the unique name of a device then it is straight-forward to assign it to the proper device.
If only the IP address is sent the event will be assigned by looking up the IP within the context of the realm.
•
If a device is moved between realms it must be remodeled so that its IPs are placed in the proper location.
•
The Network Map only supports the display the default realm.
117
Chapter 41. NetApp Filers
41.1. About
NetAppMonitor provides additional modeling and monitoring for NetApp devices. NFS, CIFS and HTTP operations per second are collected as well as file system and snapshot utilization information. Hardware model and
operating system revision asset information is modeled.
Asset information:
•
Hardware Model
•
Operating System Revision
Device metrics:
•
Network bits/sec: Send and Received
•
Operations/sec: NFS, CIFS and HTTP
File system metrics:
•
File system utilization (90% threshold)
•
Snapshot utilization (120% threshold)
41.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.NetAppMonitor
Table 41.1. NetApp Prerequisites
41.3. Enable Monitoring
41.3.1. Configuring NetApp Devices to Allow SNMP Queries
Configure the NetApp devices to allow SNMP queries from the Zenoss server, and send SNMP v1 or SNMP
v2 traps to the Zenoss server.
41.3.2. Configuring Zenoss
All NetApp devices must exist under the /Devices/Storage/Filer device class.
1. Navigate to the device or device class under the /Devices/Storage/Filer device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your storage administrators to determine the SNMP community permitted.
zSnmpPort
The default port is 161.
zSnmpVer
This should be set to v2c
Table 41.2. NetApp zProperties
118
NetApp Filers
4. Click Save to save your changes. You will now be able to start collecting the NetApp metrics from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
41.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 41.3. Daemons
119
Chapter 42. NetScreen Devices
42.1. About
NetScreenMonitor is a ZenPack that allows System Administrators to monitor their NetScreen devices.
42.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.NetScreenMonitor
Table 42.1. NetScreen Prerequisites
42.3. Enable Monitoring
42.3.1. Configuring NetScreen Devices to Allow SNMP Queries
Configure the NetScreen device to allow SNMP queries from the Zenoss server, and send SNMP v1 or SNMP
v2 traps to the Zenoss server.
42.3.2. Configuring Zenoss
All NetScreen devices must exist under the /Devices/Network/NetScreen device class.
1. Navigate to the device or device class under the /Devices/Network/NetScreen device class in the Zenoss
web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your network administrators to determine the SNMP community permitted.
zSnmpMonitorIgnore
This should be set to False
zSnmpPort
The default port is 161.
zSnmpVer
This should be set to v2c
Table 42.2. NetScreen zProperties
4. Click Save to save your changes. You will now be able to start collecting the NetScreen device metrics
from this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
42.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 42.3. Daemons
120
Chapter 43. Nortel Devices
43.1. About
The NortelMonitor ZenPack allows system administrators to monitor their Nortel devices.
43.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.NortelMonitor
Table 43.1. Nortel Prerequisites
43.3. Enable Monitoring
43.3.1. Configuring Nortel Devices to Allow SNMP Queries
Configure the Nortel device to allow SNMP queries from the Zenoss server, and send SNMP v1 or SNMP v2
traps to the Zenoss server.
43.3.2. Configuring Zenoss
All Nortel devices must exist under the /Devices/Network/Nortel device class.
1. Navigate to the device or device class under the /Devices/Network/Nortel device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zSnmpCommunity
Consult with your network administrators to determine the SNMP community permitted.
zSnmpMonitorIgnore
This should be set to False
zSnmpPort
The default port is 161.
zSnmpVer
This should be set to v2c
Table 43.2. Nortel zProperties
4. Click Save to save your changes. You will now be able to start collecting the Nortel device metrics from
this device.
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
43.4. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zenperfsnmp
Table 43.3. Daemons
121
Chapter 44. Oracle
44.1. About
The Oracle Monitoring ZenPack (DatabaseMonitor) monitors an Oracle database server. The ZenPack enables
users to view graphs based on interface from Oracle performance tables.
44.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.DatabaseMonitor
Table 44.1. Oracle Prerequisites
The Oracle ZenPack (ZenPacks.zenoss.DatabaseMonitor) is not available at the Enterprise Download site
by default for legal reasons. It is also not included in the Enterprise ZenPacks RPM file.
Oracle requires each user to complete a license agreement prior to receiving this ZenPack. Upon completion,
Zenoss Support will enable the ZenPack. You will be notified via a new case in the Zenoss Support Portal
when the ZenPack is available. This ZenPack will be located in the zenpacks directory at the Enterprise
Download site as both a 32-bit and a 64-bit version.
After downloading the ZenPack, you must install it manually. In the Zenoss interface, go to Settings > Zenpacks > Install Zenpack.
44.3. Enable Monitoring
44.3.1. Authorize Oracle Performance Data Access
For each Oracle instance to be monitored, create an Oracle user that has read privileges to the v$statname
and v$sysstat tables. These virtual tables contain the information that Zenoss uses in order to report on Oracle
performance.
44.3.2. Configure Zenoss
All Oracle services must have a device entry under the /Devices/Server/Oracle device class.
1. Navigate to the device or device class under the /Devices/Server/Oracle device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
Name
Description
zOracleUser
Username with access to the virtual tables.
zOraclePassword
Password for the above user.
zOracleInstance
The Oracle SID to monitor.
Table 44.2. Oracle zProperties
4. Click Save to save your changes.
You will now be able to start collecting the Oracle server metrics from this device.
122
Oracle
5. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
44.4. Monitor Multiple SIDs without DNS Aliases
If you want to monitor multiple Oracle instances on the same host, then additional data sources on the host
will be required.
1. Navigate to the device in the Zenoss interface.
2. Click the page menu, then select More → Templates.
3. Open a new browser window or tab from the CommonOraclePerformance template. We will be using this
new tab to copy information from the original data source.
4. In the original browser window, click on the CommonOraclePerformance template.
5. Click on the getOracleMetrics Data Source.
6. In the new browser window or tab, select the Add Datasource... item.
7. In the dialog box, provide a new Data Source name and specify a COMMAND type. Click OK to create the
new data source.
8. Copy the information from the getOracleMetrics data source into your newly created data source. These
new data sources will look the same as the one that already exists, but with hard-coded SID details.
9. Create new graphs for each of the new data sources and data points.
44.5. Monitor Multiple SIDs with DNS Aliases
For environments with a larger number of Oracle databases, one strategy that works well is to associate a DNS
alias (CNAME) with each Oracle instance. For example, if the Oracle instance is named ERPPROD, then add a
DNS alias like oracle_erpprod (DNS is case-insensitive). If this is done, and the DNS alias is used rather than
the actual hostname (such as in tnsnames.ora or Oracle naming service) then all services can refer to the same
hostname. When the database is moved to another server all applications (including Zenoss) will be able to
continue to use that same hostname.
If the above strategy is followed, the procedure for adding Oracle instances becomes adding new devices for
each SID, regardless of the physical device where the Oracle SID is running on.
1. From the navigation bar, click on the Add Device item under the Management section.
2. Enter in the following information:
Name
Description
Device Name
The DNS alias name of the SID (eg oracle_erpprod).
Device Class Path
A path under /Server/Oracle
Discovery Protocol
Set this to none.
Table 44.3. Adding Oracle SIDs with DNS Aliases
3. Click on the Add Device button to add the device.
4. Click on the new device.
5. Edit the appropriate zProperties for the device(s).
Name
Description
zOracleUser
Username with access to the virtual tables.
zOraclePassword
Password for the above user.
zOracleInstance
The Oracle SID to monitor (eg ERPPROD).
Table 44.4. Oracle zProperties
123
Oracle
6. Click Save to save your changes.
44.6. Daemons
Type
Name
Performance Collector
zencommand
Table 44.5. Daemons
124
Chapter 45. Predictive Thresholding
45.1. About
The ZenHoltWinters ZenPack adds the ability to create threshold events when a device exceeds cyclical predicted values. The Holt-Winters exponential smoothing algorithm is used for this prediction.
For more information on RRD and Holt-Winters, see the rrdcreate command for more information.
Zenoss relies on the existence of Holt-Winters RRAs within an RRD file. After adding Holt-Winters thresholds
the RRD files will need to be re-created so that the new configuration can occur. You will have to remove
any existing RRD files so that new files can be created.
Removing RRD files will remove all historical information associated with these RRD files.
45.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenHoltWinters
Table 45.1. Trap Forwarding Prerequisites
45.3. Add a Predictive Threshold
1. Navigate to the template that you desire to modify.
2. In the template, from the Thresholds table menu, select Add Threshold.
3. Provide a name for the new threshold and select the HoltWintersFailure threshold type.
4. Choose the Data Source to which the threshold should be applied.
5. Specify the parameters for the prediction engine.
Name
Description
Rows
The number of points to use for predictive purposes.
Alpha
A number from 0 to 1 that controls how quickly the model
adapts to unexpected values.
Beta
A number from 0 to 1 that controls how quickly the model
adapts to changes in unexpected rates changes.
Season
The number of primary data points in a season. Note that Rows
must be at least as large as Season.
Table 45.2. Predictive Threshold Data Source Threshold Options
6. Click Save to save your changes.
7. Remove the RRD file or files that correspond to the data source selected in a previous step.
cd $ZENHOME/perf/Devices
rm device_names/DataSource_DataPoint.rrd
Removing the RRD files does result in a loss of historical information.
125
Chapter 46. RANCID Integration
46.1. About
The RANCIDIntegrator ZenPack allows integration between the popular RANCID configuration management
tool and Zenoss. The integration points between the tools are:
•
Zenoss will build the router.db file for RANCID. This allows for the centralization of administration activities
and reduces the duplication of effort normally required to maintain the two tools.
•
Implementation of this feature is as easy as adding a cron job to execute $ZENHOME/bin/zenrancid to
update the router.db file.
•
Zenoss will automatically run RANCID's rancid-runm tool on a single device in response to a ciscoConfigManEvent SNMP trap being sent from the device to Zenoss. Cisco devices will send this trap whenever
their configuration is changed. This allows for real-time capturing of router configuration changes in your
CVS repository.
The RANCID integrator is dependent on a connection to the Zope server, hence it can run only on the Zenoss
master and as such works only with managed resources on the master.
46.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.RANCIDIntegrator
Table 46.1. RANCID Prerequisites
46.3. Enable Integration
46.3.1. Configure Cisco Devices to Send Traps
To implement this feature you must configure your Cisco devices to send their SNMP traps to the Zenoss server.
Link from Cisco device status pages to the most recent configuration stored in your CVS repository via viewvc.
46.3.2. Configure RANCID Update Information in Zenoss
1. Navigate to the device in the Zenoss interface.
2. Click the page menu, then select More → zProperties.
3. Edit the appropriate zProperties for the device.
Name
Description
zRancidRoot
File system directory where RANCID is installed. It may be NFS
mounted from the RANCID server. Default is /opt/rancid
zRancidUrl
Base URL to viewvc
zRancidGroup
RANCID group attribute. Controls what router.db file the device is written to. Can be set at the device class or device level.
Default is router on the /Network/Router/Cisco class
zRancidType
RANCID type attribute. Controls what device type is written to
the router.db file. Can be set at the device class or device level. Default is cisco on the /Network/Router/Cisco
Table 46.2. RANCID zProperties
126
RANCID Integration
4. Click Save to save your changes.
127
Chapter 47. Remedy Ticket Creation
47.1. About
The RemedyIntegrator ZenPack provides a way for Zenoss to automatically open tickets in your Remedy system
when specific events occur. The cases are opened by Zenoss sending a specially-formatted email to the Remedy
service's email receiver.
47.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.RemedyIntegrator
Table 47.1. Remedy Ticket Creation Prerequisites
47.3. Enable Ticket Creation
Have your Remedy administrator create the template email that is needed to have events enter into the appropriate workflow.
1. From the navigation bar, click on the Settings item.
2. Click on the Users tab.
3. Click on the Remedy user.
4. Change the email address to the email address from which your Remedy service receives email.
5. Go to the Alerting Rules tab of the Remedy user.
6. Click on the Open Ticket alerting rule to edit it.
7. Set the Enabled field to True and adjust the event filter to your requirements.
8. Click on the Message tab and modify the Zenoss e-mail message with the necessary information from the
template e-mail. Lines that will require modification for all sites are:
•
Server: remedy.yourdomain.com
•
Login: remedyUsername
•
Password: remedyPassword
9. Click Save to save your changes.
47.4. Send Test Tickets
To create test events that will match your rule and create tickets in Remedy, navigate to the Events item from
the navigation bar and then select Add Event... from the page menu.
47.5. Daemons
Type
Name
Event Forwarder
zenactions
Table 47.2. Daemons
128
Chapter 48. SNMP Trap Forwarding
48.1. About
Zenoss can be configured to forward events matching specified criteria to other SNMP trap receivers. You may
want to do this if you have another system that would benefit from the event information that Zenoss collects.
This ZenPack is available only by separate download from the Zenoss Support site. After downloading the
ZenPack, you must install it manually. In the Zenoss interface, go to Settings > Zenpacks > Install Zenpack.
48.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.TrapForwarder
Table 48.1. Trap Forwarding Prerequisites
48.3. Enable Event Forwarding
48.3.1. Import Zenoss MIB onto the Remote Receiver
The MIB file ZENOSS-MIB.txt is found at the base directory within the TrapForwarder distribution. Import this MIB
into the event management system that you plan to forward to events to so that the SNMP traps that Zenoss will
generate can be properly interpreted. Consult the documentation for the remote SNMP manager for instructions.
48.3.2. Configure Zenoss to Send Events as Traps
1. From the navigation bar, click on Settings.
2. Click the Daemons tab.
3. Look for the trapforwarder daemon on the left-hand side and then click on the edit config button.
4. Specify the following properties that are expected by your remote SNMP trap receiver.
Name
Description
community
SNMP community name sent in each trap
trapsink
hostname or IP address of the remote SNMP trap receiver
Required ZenPacks
ZenPacks.zenoss.TrapForwarder
Table 48.2. trapforwarder Configuration File Options
5. Click Save to save your changes.
6. Click the Daemons tab and look for the trapforwarder daemon on the left-hand side and then click on the
Start button.
7. From the navigation bar, click on Event Manager.
8. Click the Commands tab.
9. Choose the events you want to forward, based on the example already setup called SNMP Trap. Click into
it to edit.
The example is setup to forward all new events from production devices with a severity of warning or greater.
You may want to limit this further.
10. Once configuration of the rule is complete, click on the Enabled field and set it to True.
129
SNMP Trap Forwarding
11. Click Save to save your changes.
48.4. Send Test Events
To create test events that will match your rule, navigate to the Events item from the navigation bar and then
select Add Event... from the page menu.
48.5. Daemons
Type
Name
Event Forwarder
trapforwarder
Table 48.3. Daemons
130
Chapter 49. Solaris
49.1. About
The SolarisMonitor ZenPack enables Zenoss to use Secure Shell (SSH) to monitor Solaris hosts. Zenoss models and monitors devices placed in the /Server/SSH/Solaris device class by running commands and parsing
the output. Parsing of command output is performed on the Zenoss server (if using a local collector) or on a
distributed collector. The account used to monitor the device does not require root access or special privileges.
The SolarisMonitor ZenPack provides:
•
File system and process monitoring
•
Network interfaces and route modeling
•
CPU utilization information
•
Hardware information (memory, number of CPUs, and model numbers)
•
OS information (OS-level, command-style information)
•
Pkginfo information (such as installed software)
49.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.5 or higher
Required ZenPacks
ZenPacks.zenoss.SolarisMonitor
Solaris releases supported
OpenSolaris 5.11, Solaris 9 and 10
Table 49.1. Solaris Prerequisites
If using a distributed collector setup, SSH requires firewall access (by default, port 22) from the collector
to the monitored server.
49.3. Limitations
The SolarisMonitor ZenPack does not support monitoring in Solaris Zones or systems containing Solaris Zones.
(Implemented with Solaris 10, Solaris Zones act as isolated virtual servers within a single operating system
instance.)
49.4. Set Solaris Server Monitoring Credentials
All Solaris servers must have a device entry in an organizer below the /Devices/Server/SSH/Solaris device
class.
The SSH monitoring feature will attempt to use key-based authentication before using a zProperties password value.
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, select the zProperties tab.
3. Verify the credentials for the service account to access the service.
131
Solaris
Name
Description
zCommandUsername
Solaris user with privileges to gather performance
information
zCommandPassword
Password for the Solaris user
Table 49.2. Solaris zProperties
4. Click Save to save your changes.
49.5. Enable Monitoring
These steps assume that credentials have been set.
1. From the navigation bar, select Add Device.
2. Enter the following information:
Name
Description
Device Name
Solaris host to model
Device Class Path
/Server/SSH/Solaris
Discovery Protocol
Set this to auto unless adding a device with a username and
password different than found in the device class. If you set this
to none, then you must add the credentials (see Section 49.4,
“Set Solaris Server Monitoring Credentials”), and then manually
model the device.
Table 49.3. Adding Solaris Device Information
3. Click Add Device to add the device.
49.6. Resolving CHANNEL_OPEN_FAILURE Issues
The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:
ERROR zen.SshClient CHANNEL_OPEN_FAILURE: Authentication failure
WARNING:zen.SshClient:Open of command failed (error code 1): open failed
If the sshd daemon's log file on the remote device is examined, it may report that the MAX_SESSIONS number of
connections has been exceeded and that it is denying the connection request. In the OpenSSH daemons, this
MAX_SESSIONS number is a compile-time option and cannot be reset in a configuration file.
To work around this sshd daemon limitation, use the zProperty zSshConcurrentSessions to control the number
of connections created by zencommand to the remote device:
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, and then select More → zProperties.
If applying changes to a device class, select the zProperties tab.
3. Apply an appropriate value for the maximum number of sessions.
Name
Description
zSshConcurrentSessions
Maximum number of sessions supported by the remote device's
MAX_SESSIONS parameter. Common values for Solaris is 2 or 10.
Table 49.4. Concurrent SSH zProperties
4. Click Save to save your changes.
132
Solaris
49.7. Resolving Command time out Issues
The zencommand daemon's log file ($ZENHOME/collector/zencommand.log) may show messages stating:
WARNING:zen.zencommand:Command timed out on device device_name: command
If this occurs, it usually indicates that the remote device has taken too long to return results from the commands.
To increase the amount of time to allow devices to return results, change the zProperty zCommandCommandTimeout
to a larger value:
1. Navigate to the device or device class in the Zenoss interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, select the zProperties tab.
3. Apply an appropriate value for the command timeout.
Name
Description
zCommandCommandTimeout
Time in seconds to wait for commands to complete on the remote device.
Table 49.5. SSH Timeout zProperties
4. Click Save to save your changes.
49.8. Daemons
Type
Name
Modeler
zenmodeler
Performance Collector
zencommand
Table 49.6. Daemons
133
Chapter 50. SQL Transactions
50.1. About
The ZenSQLTx ZenPack allows you to test the availability and performance of MySQL, Sybase and Microsoft
SQL servers. It provides a SQL data source where user-defined SQL queries can be executed against a
database.
50.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenSQLTx
Table 50.1. SQL Transaction Prerequisites
50.3. Enable SQL Server Monitoring
Ensure that your Microsoft SQL Server authentication mode is set to "SQL Server and Windows Authentication
mode." For more information about this setting and how to change it, refer to:
http://msdn.microsoft.com/en-us/library/ms188670.aspx
1. Navigate to the device in the Zenoss Web interface.
2. Click the page menu, then select More → Templates.
3. Create a performance template by selecting Add Template from the page menu.
4. Enter an identifier for the template and then click OK to create it.
5. Click on the newly created template.
6. Select Add DataSource... from the Data Sources table menu.
7. Enter a name for the data source, select SQL as the type, and then click OK.
8. The Data Source page appears.
Change options as needed.
Option
Description
Database Type
Enter MS SQL
Host Name
Set the host name on which the database is located. This field
accepts a TALES expression, such as ${here/id} or ${here/
getManageIp}
Port
Set the port on which the database server is listening. If you do
not specify a port number, then the default port for the database
is used.
Database Name
Specify the name of the database (required).
User
Specify a user name with permission to connect to the
database and run queries.
Password
Specify the user password.
SQL Queries
Specify the SQL queries that this data source should execute.
A summary of MS SQL syntax is available in the documentation
accompanying the software.
Table 50.2. MS SQL Server Transactions Data Source Options
134
SQL Transactions
9. Click Save to save your changes.
Zenoss creates a data point that corresponds to the total query time in milliseconds.
10. Click Test to verify that the database connection can be completed, and that the data returned from the
queries are correct.
See the Administration Guide for more information about setting up thresholds and graphs. To create data points
that store the results of queries, see the section titled "Data Points."
50.4. Enable Sybase Server Monitoring
1. Navigate to the device in the Zenoss Web interface.
2. Click the page menu, then select More → Templates.
3. Create a performance template by selecting Add Template from the page menu.
4. Enter an identifier for the template, and then click OK to create it.
5. Click on the newly created template.
6. Select Add DataSource... from the Data Sources table menu.
7. Enter a name for the data source, select SQL as the type, and then click OK.
8. The Data Source page appears.
Change options as needed.
Option
Description
Database Type
Enter Sybase
Host Name
Set the host name on which the database is located. This field
accepts a TALES expression, such as ${here/id} or ${here/
getManageIp}
Port
Set the port on which the database server is listening. If you do
not specify a port number, then the default port for the database
is used.
Database Name
Specify the name of the database (required).
User
Specify a user name with permission to connect to the
database and run queries.
Password
Specify the user password.
SQL Queries
Specify the SQL queries that this data source should execute. A
summary of Sybase syntax is available at the Sybase Manuals
Web site.
Table 50.3. MySQL Server Transactions Data Source Options
9. Click on the Save button to save your changes.
Zenoss creates a data point that corresponds to the total query time in milliseconds.
10. Click Test to verify that the database connection can be completed, and that the data returned from the
queries are correct.
See the Administration Guide for more information about setting up thresholds and graphs. To create data points
that store the results of queries, see the section titled "Data Points."
50.5. Enable MySQL Server Monitoring
1. Navigate to the device in the Zenoss interface.
2. Click the page menu, then select More → Templates.
135
SQL Transactions
3. Create a performance template by selecting Add Template from the page menu.
4. Enter an identifier for the template and then click OK to create it.
5. Click on the newly created template.
6. Select Add DataSource from the Data Sources table menu.
7. Enter a name for the data source, select SQL as the type, and then click OK.
8. The Data Source page appears.
Change options as needed.
Option
Description
Database Type
Enter MySQL
Host Name
Set the host name on which the database is located. This field
accepts a TALES expression, such as ${here/id} or ${here/
getManageIp}
Port
Set the port on which the database server is listening. If you do
not specify a port number, then the default port for the database
is used.
Database Name
Specify the name of the database (required).
User
Specify a user name with permission to connect to the
database and run queries.
Password
Specify the user password.
SQL Queries
Specify the SQL queries that this data source should execute. A
summary of MySQL syntax is available at:
http://dev.mysql.com/doc/refman/5.0/en/sql-syntax.html
Table 50.4. MySQL Server Transactions Data Source Options
9. Click on the Save button to save your changes.
Zenoss creates a data point that corresponds to the total query time in milliseconds.
10. Click Test to verify that the database connection can be completed, and that the data returned from the
queries are correct.
See Zenoss Administration for more information about setting up thresholds and graphs. To create data points
that store the results of queries, see the section titled "Data Points."
50.6. Storing Query Results
If any data is retrieved from the database that can be interpreted as a number, that number can be used as a
data point. In select statements in which a column name is used, that column name becomes the name of the
data point. In select statements in which no column name is specified (for example, aggregate functions such
as count(*), sum(), or min()), the data point name returned is database-dependent:
•
MySQL - The column name can be controlled with an 'AS' clause in the query. If used, then the column name
is the "cleaned up" result of the 'AS' clause; otherwise, it uses the format: 'q' + query number (beginning
with 0) + '_' + column number in the query (beginning with 0).
•
All other databases - The column name uses the format: 'q' + query number (beginning with 0) + '_' + column
number in the query (beginning with 0).
Non-alphanumeric characters ([^za-zA-Z0-9_]) are removed from the column name to produce the data point
name. Any query results that cannot be interpreted as a number are ignored, and the query numbers will not
change.
For example, the queries:
136
SQL Transactions
select count(*) from Users;select UserName from Users; select count(*) * 4 from Users
return these results:
Queries completed successfully. | totalTime=2.13289260864 count=3.0 count4=12.0
To use multiple queries (such as in the preceding example), they must be separated with a semicolon.
This example demonstrates multiple results from a single query:
select count(*) as count1, count(*)-1001 from history;
and returns these results:
Queries completed successfully. | totalTime=72.6099014282 count1=99894.0 count1001=98893.0
Notes:
•
For SQL Server, use the format q*_* if no column name is found.
•
The SQL 'as' renaming capability can be used to control the name of the data point.
50.7. Daemons
Type
Name
Performance Collector
zencommand
Table 50.5. Daemons
137
Chapter 51. Sugar CRM
51.1. About
SugarCRMMonitor is a ZenPack that allows System Administrators to monitor their Sugar CRM services.
51.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.SugarCRMMonitor
Table 51.1. Sugar CRM Prerequisites
51.3. Enable Monitoring
51.3.1. Configuring Sugar CRM to Allow Queries
.
51.3.2. Configuring Zenoss
All SugarCRM devices must exist under the /Devices/Web/SugarCRM device class.
1. Navigate to the device or device class under the /Devices/Web/SugarCRM device class in the Zenoss web
interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device(s).
Name
Description
zSugarCRMBase
zSugarCRMPassword
Password for the zSugarCRMUsername user.
zSugarCRMTestAccount
zSugarCRMUsername
Username allowed to log into the Sugar CRM server.
Table 51.2. SugarCRM zProperties
4. Click Save to save your changes.
5. Click the page menu, then select More → Templates.
6. From the table menu select the Bind Templates... item to display the Bind Performance Templates dialog.
7. To add the SugarCRM template and retain other performance templates, hold down the control key while
clicking on the SugarCRM entry.
8. Click OK.
The SugarCRM template should now be displayed under the Performance Templates for Device. You will
now be able to start collecting the Sugar CRM metrics from this device.
9. Navigate to the Perf tab and you should see some placeholders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
138
Sugar CRM
51.4. Daemons
Type
Name
Performance Collector
zencommand
Table 51.3. Daemons
139
Chapter 52. VMware Virtual Hosts
52.1. About
With Zenoss, you can collect information to monitor your VMware infrastructure. By entering a single set of
connection parameters, you allow Zenoss to:
•
Obtain the names and properties of various entities in your VMware infrastructure
•
Monitor metrics collected by VMware
•
Retrieve VMware events
Zenoss extracts VMware information through the VMware Infrastructure (VI) SDK, VMware's SOAP interface to
its line of server virtualization products. The SDK can be accessed from an individual ESX server or vCenter
Server (previously, VirtualCenter Server) instance, which can return information about many ESX servers.
For more information about VMware infrastructure, see VMware's Introduction to VMware Infrastructure
52.1.1. VMware Events
VMware records a wide range of events that are available through the VI SDK. Zenoss extracts these events
and makes them available in the event console.
Figure 52.1. VMware Events (Event Console)
The device column shows the ID of the VMware entity with which the event is associated, unless the event is
specific to a guest VM. In that case, the device column shows the ID of the host, and the component column
displays the ID of the guest.
Zenoss maps the VMware event to the event class and assigns the event a severity level. The event class
appears in the eventClass column.
To see detailed event information and the original VMware event type, click the magnifying glass that appears
at the end of the event row.
140
VMware Virtual Hosts
Figure 52.2. VMware Events (Event Console) - View Details
The VMware event type is the value shown for eventGroup.
141
VMware Virtual Hosts
Figure 52.3. Event Details (Fields Tab)
The Details tab shows additional "raw" content from the VMware event.
142
VMware Virtual Hosts
Figure 52.4. Event Details (Details Tab)
52.1.1.1. Migration Events
When a VMotion guest migrates from one host to another, VMware records events to signal its progress. When
a VmMigrated event occurs, it is duplicated to become two events, which are mapped to the /VMware/Migration
event class in Zenoss. One event contains the originating host as the device; the other lists the destination host
as the device.
An Event Command (see the Commands tab on the Event Manager page) reacts to these events by remodeling
the two hosts and generating an updated view of the guests. The time required to produce updated guest lists
(from the time migration completes) is between 30 seconds and four minutes.
52.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenVMware
VMware VI API
Compatible with ESX Server 3.5, VirtualCenter Server 2.5, and
ESX Server 3i. It is not explicitly compatible with ESX Server
3.0.x or VirtualCenter 2.0.x, or any previous versions.
Table 52.1. VMware Prerequisites
If the time on the monitored VC/ESX server is too far from the time on the box where the zenvmwareperf
daemon is running, the daemon will not collect any data.
52.3. Enable Monitoring
Follow these steps to begin monitoring your VMware servers.
1. From the navigation bar, click on Devices.
143
VMware Virtual Hosts
2. In the Sub-Devices list, click VMware.
3. From the Page menu, select Manage > Add VMware infrastructure.
Figure 52.5. Add VMware Infrastructure
4. The Add VMware Infrastructure dialog appears.
Figure 52.6. Add VMware Infrastructure Dialog
5. Enter parameters to connect to the ESX server or vCenter Server that will provide monitoring capabilities.
•
ID -Enter a name for the infrastructure to be monitored.
•
Host - Enter the hostname of the server providing the VI SDK connections. This can be an individual
ESX server or the location of a vCenter Server instance.
•
Use SSL - Select this option if the connection should be made by using SSL encryption.
•
Username - Enter the user name used to authenticate.
•
Password - Enter the password used to authenticate.
•
Collector - Select the collector to use to retrieve information from the VI SDK endpoint.
6. Click OK.
144
VMware Virtual Hosts
Zenoss begins modeling the VMware infrastructure. It places the information in the device hierarchy under
/Devices/VMware/ID, where ID is the value of the ID field you entered during setup.
52.4. Viewing VMware Devices
Zenoss represents these VMware entities as devices:
•
Hosts (ESX servers)
•
Resource Pools
•
Data stores
•
Clusters
Each of these categories is represented as a device class under the newly created organizer. For example, if
the ID of an infrastructure is esxwin, then four device classes appear below /Devices/VMware/esxwin: Clusters,
Datastores, Hosts, and ResourcePools.
Figure 52.7. VMware Device Classes
If the SDK endpoint is an individual ESX server, then the Clusters organizer will be empty. (A VMware cluster
is a concept external to an individual host.)
52.5. Viewing Guest Virtual Machines
To view guest VMs on an ESX server:
1. Navigate to a device in the Hosts class.
2. Click the Guests tab.
The Virtual Guest Devices list appears.
145
VMware Virtual Hosts
Figure 52.8. Virtual Guest Devices
In the list, the first column contains a link to the guest component, named the same name as the VM. (This is
not necessarily the same as the VM hostname.) If the VM has been modeled elsewhere in Zenoss, then a link
to that device appears in the Managed Device column.
As shown in the previous figure, none of the VMs are being monitored in their "native" device classes. For
example, the guest named "ldap test box" is a Linux VM with the hostname "test-ldap-1.zenoss.loc." If you add
that device to /Devices/Server/Linux (by using the Add Device feature in the Left Navigation area), a link will
appear.
146
VMware Virtual Hosts
Figure 52.9. Virtual Guest Devices - Managed Device
Click the Name link to go to the Guest component status page, which shows the VM's relationships to other
VMware entities, and provides access to VMware-specific metrics and events.
Click the managed device link to go to the Device status page, which contains information about the device as
a separate Linux or Windows server. These two status pages link to each other.
52.6. Adding a Custom Metric
In Zenoss, metric-bearing VMware entities (such as Hosts, Guests, and Clusters) have associated templates.
These templates define which metrics are gathered. By default, only a subset is collected; however, you can
add more by adding data sources to the templates. Once created, you can then create custom graphs from
these data sources.
To create a custom data source:
1. Select the template to which you want to add the data source.
2. From the DataSources list of options, select Add Datasource.
The Add DataSource dialog appears.
147
VMware Virtual Hosts
Figure 52.10. Add Data Source
3. Select the VMware data source from the list of options.
4. Enter or select values to create the data source:
Event Key - Not used.
Severity - Not used.
Group, Counter, and Roll-up Type - VMware-specific data points are determined by this trio of strings. For
information about each of these metrics, see the chapter titled "Performance Counters Reference" in the
VI SDK Programming Guide .
Instance - Certain metrics are further specified by an instance name. For example, the metric whose Group/
Counter/Rollup Type triplet is Network/Network Data Receive Rate/average requires the name of the actual
interface for full specification. In Zenoss, this metric is represented by the data source nicRx on the template
VMwareNic. The VMwareNic template is bound to the individual host interfaces, each of whose ID is the
interface name. In this case, the instance name is ${here/instanceId}.
5. Click Save to save the new data source.
52.7. Moving VMware Devices Between Collectors
If you move a VMware device to a different collector, you must follow one of these procedures to force the
changes to take effect:
•
Restart the collector daemons. To do this, go to Settings > Daemons, and then click Restart in the row for
each of these daemons:
•
zenvmwaremodeler
•
zenvmwareperf
•
zenvmwareevents
148
VMware Virtual Hosts
Alternatively, as user zenoss, enter the following commands to stop and then restart these Zenoss
daemons:
zenvmwaremodeler restart
zenvmwareperf restart
zenvmwareevents restart
OR
•
Navigate to the page for the organizer that represents the VMware endpoint (for example, Devices/VMware,
myEndpoint), and then select Manage > Push changes from the page menu.
52.8. Daemons
Type
Name
Modeler
zenvmwaremodeler
Performance Collector
zenvmwareperf
Event Collector
zenvmwareevents
Table 52.2. Daemons
52.8.1. Tuning Options
These collector daemons offer options for tuning performance. Use them to control data amounts and the rate
at which data comes back to be modified.
•
zenvmwareperf
Option
Description
--callChunkSize=Value
Specifies the number of performance requests
to submit at the same time.
--callChunkSleep=Value
Specifies the time to sleep, in seconds, between performance requests.
Table 52.3. Daemons
•
zenvmwareevents
Option
Description
--eventChunkSize=Value
Specifies the number of events to gather at one
time.
--eventChunkSleep=Value
Specifies the time to sleep, in seconds, between event requests.
Table 52.4. Daemons
149
Chapter 53. WebSphere Application Server
53.1. About
The WebSphere monitoring feature allows Zenoss to monitor IBM WebSphere Application Servers (WAS).
53.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenWebTx 2.5 or higher,
ZenPacks.zenoss.WebsphereMonitor
Table 53.1. WebSphere Prerequisites
53.3. Enable Monitoring
53.3.1. Configure WAS for Monitoring
To successfully monitor WebSphere, you must have the Performance Monitoring Infrastructure (PMI) servlet
installed and enabled on your WebSphere instance. For more information, please see the IBM WebSphere
documentation.
53.3.2. Zenoss
1. Navigate to the device or device class in the Zenoss web interface.
2. If applying changes to a device, click the page menu, then select More → zProperties.
If applying changes to a device class, click on the zProperties tab.
3. Edit the appropriate zProperties for the device or devices.
zProperty
Description
zWebsphereURLPath
Path to the PMI servlet on a WebSphere instance.
The default value is the default path on a WebSphere installation:
wasPerTool/servlet/perfservlet
zWebsphereUser
Used for HTTP basic authentication. This field is not required,
and is empty by default.
zWebspherePassword
Used for HTTP basic authentication. This field is not required,
and is empty by default.
zWebsphereAuthRealm
Used for HTTP basic authentication. This field is not required,
and is empty by default.
zWebsphereServer
Used by the provided template to build the xpath queries for the
data to collect. You must supply a value for this field. There is
no default value.
zWebsphereNode
Used by the provided template to build the queries for the data
to collect. You must supply a value for this field.
Table 53.2. WebSphere zProperties
4. Click Save to save your changes.
150
WebSphere Application Server
5. Click the page menu, then select More → Templates.
6. From the table menu select the Bind Templates... item to display the Bind Performance Templates dialog.
7. To add the Websphere template and retain other performance templates, hold down the control key while
clicking on the Websphere entry.
8. Click OK.
The Websphere template should now be displayed under the Performance Templates for Device. You will
now be able to start collecting the WebSphere metrics from this device.
9. Navigate to the Perf tab and you should see some place holders for graphs. After approximately 15 minutes
you should see the graphs start to become populated with information.
53.4. Examples
Once the PMI module has been installed into WAS, you can generate the PMI XML file. You then can use this
file to complete the Performance template.
This example shows how to obtain the zProperties required for basic monitoring functionality. It further shows
how to add other metrics to be monitored.
You can generate the PMI XML file by browsing to this URL:
http://WASserver/wasPerfTool/servlet/perfservlet
This is the default WAS server location. The URL should match the zProperty setting used in the template.
where WASserver is the WAS server's host name or IP address.
The following example XML file results:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE PerformanceMonitor SYSTEM "/wasPerfTool/dtd/performancemonitor.dtd">
<PerformanceMonitor responseStatus="success" version="6.1.0.21">
<Node name="serverA">
<Server name="serverAB">
<Stat name="serverABC">
...
<Stat name="Dynamic Caching">
<Stat name="Object: ws/WSSecureMap">
<Stat name="Object Cache">
<Stat name="Counters">
<CountStatistic ID="21" count="0" lastSampleTime="1242827146039" name="HitsInMemoryCount" \
startTime="1242827146039" unit="N/A"/>
<CountStatistic ID="28" count="5" lastSampleTime="1243610826245" name="MissCount" \
startTime="1242827146039" unit="N/A"/>
</Stat>
</Stat>
</Stat>
</Stat>
...
</Stat>
</Server>
</Node>
</PerformanceMonitor>
In the previous example, zProperties settings are:
•
zWebsphereNode: serverA
•
zWebsphereServer: serverAB
You might want to add counters beyond the standard counters. For example, you might want to add the HitsInMemoryCount and MissCount counters (related to dynamic caching). To do this, you would add the following
twill commands to the Script tab of your WebSphere data source:
151
WebSphere Application Server
xpathextract HitsInMemoryCount '/PerformanceMonitor/Node[@name="${here/zWebsphereNode}"]/\
Server[@name="${here/zWebsphereServer}"]/Stat[@name="server"]/Stat[@name="Dynamic Caching"]/\
Stat[@name="Object: ws/WSSecureMap"]/Stat[@name="Object Cache"]/Stat[@name="Counters"]/\
CountStatistic[@name="HitsInMemoryCount"]/attribute::count' xpathextract MissCount \
'/PerformanceMonitor/Node[@name="${here/zWebsphereNode}"]/Server[@name="${here/zWebsphereServer}"]/\
Stat[@name="server"]/Stat[@name="Dynamic Caching"]/Stat[@name="Object: ws/WSSecureMap"]/\
Stat[@name="Object Cache"]/Stat[@name="Counters"]/CountStatistic[@name="MissCount"]/attribute::count'
After adding these commands, you would then add the data points for HitsInMemoryCount and MissCount, and
then add the data points to a graph.
53.5. Daemons
Type
Name
Performance Collector
zenwebtx
Table 53.3. Daemons
152
Chapter 54. Web-Based Synthetic
Transactions
54.1. About
The ZenWebTx ZenPack allows you to test the availability and performance of Web sites by performing some
of the same activities performed by your user community. You create one or more tests that mimic user actions
in a Web browser. Zenoss then performs these tests periodically, creating events when a test fails or exceeds
a time threshold.
Additionally, Zenoss can record data for each test run, such as:
•
Time required for the test to execute
•
Time taken for any portion of the test to complete
•
Values extracted from Web pages during the test
ZenWebTx uses a scripting language called Twill to describe the steps of a test. These steps include actions
such as:
•
Clicking a link
•
Completing form fields
•
Assertions, which check for the presence or absence of text on a page. In addition, you can extract data
from the Web page and record the numeric values that are a part of these patterns
•
Descriptions of data to collect during the test
You can write Twill commands manually. You also can use a Firefox add-on called TestGen4Web to record a
browser session that ZenWebTx then translates into Twill commands. The zenwebtx daemon processes the
Twill commands periodically, recording data and creating events as appropriate.
54.1.1. Data Points
Data produced by any Zenoss data source are called data points. WebTx data sources contain two default data
points:
•
totalTime – Number of seconds taken to complete the entire transaction.
•
success – Returns 1 (success) or 0 (failure), depending on whether or not the transaction succeeded.
You can create other data points by using the extract and printTimer twill commands, which output data values
when the twill commands are run. You must create new data points with the same name you used in those
commands to bring that data into Zenoss. For more information about the extract and printTimer twill commands,
refer to the appendix titled Appendix A, twill Commands Reference.
ZenWebTx supports using XPath queries to extract data from XML documents. For more information about this
feature, refer to the appendix in this guide titled Appendix A, twill Commands Reference.
54.1.2. Event Generation
There are several situations for which ZenWebTx will create events in Zenoss. These events use the component
and event class specified on the Data Source tab. These situations are:
•
ZenWebTx is unable to retrieve a page during the transaction.
•
One of the twill commands fails, such as finding text that does not exist or following a link that does not exist.
•
The timeout (specified on the Data Source tab) is exceeded.
153
Web-Based Synthetic Transactions
•
A threshold defined for one of the data points in this data source is exceeded. Thresholds are defined in the
performance template that contains the data source.
54.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenWebTx
Table 54.1. Web Transactions Prerequisites
54.3. Enable Monitoring
To create a WebTx data source:
1. From the data sources area, select Add DataSource from the table menu.
2. In the Create Data Source dialog, enter the name of the new data source, and then select the data source
type WebTx.
3. Click OK.
The Data Source tab appears.
4. Enter information or make selections to specify how and when this data source's Web transactions are
performed, and which data should be collected:
Option
Description
Name
Displays the name of the data source that you specified in the
Create Data Source dialog. This name is used in thresholds
and graph definitions to refer to the data collected by this data
source.
Source Type
Set to WebTx, indicating that this is a synthetic Web transaction
data source. You cannot edit this selection.
Enabled
Set to True (the default) to collect information from this data
source. You may want to set this value to False to disable data sources when developing the data source, or when making
changes to the Web application being tested.
Component
Any time the Web transaction fails, Zenoss generates an event.
Use this field to set the Component field of the generated event.
Event Class
Select the event class of the event generated by this data
source. Normally, this is set to /Status/Web (according to the
value set on the data source).
Timeout
Specify the number of seconds that zenwebtx will attempt to execute this data source's commands before it generates an error
event.
Cycle Time
Specify the number of seconds that zenwebtx will wait between
the start of one test run and the start of the next.
User Agent
Specify the text that zenwebtx will present to target Web sites to
identify itself.
Table 54.2. WebTx Data Source Options
5. Click Save to save the specified settings.
6. Click the Script tab. From here, you will specify the details of the transaction. Information here also helps
you debug twill commands when setting up the data source.
154
Web-Based Synthetic Transactions
Enter information or make selections:
Option
Description
Initial URL
Specify the URL of the page where the transaction will start.
This field frequently contains a TALES expression to refer to a
device's ID or IP address, such as http://${dev/id} or http://
${dev/manageIp}.
For more information on TALES expressions, refer to the Appendix in the Administratrion Guide titled TALES Expressions.
Initial User
Specify the user name for authentication.
Initial Password
Specify the user password for authentication.
Initial Authentication Realm
Specify the basic HTTP authentication realm.
TestDevice
Use this field to test and debug twill commands. Enter the ID of
a device, and then click Test Twill Commands to execute the
twill commands against the device. If you do not specify a device, then Zenoss will select a device for you.
Upload Recording
Upload a Web session recording generated by the Firefox
TestGen4Web add-on. Enter or browse to the recording location.
If you specify a file here, and then click Save, Zenoss translates
the file to twill commands and replaces the contents of the Twill
Commands field with the newly translated commands.
Twill Commands
Specify the number of seconds that zenwebtx will wait between
the start of one test run and the start of the next.
Enter twill commands that Zenoss will execute to produce values and events for the data source.
If you select this action, then the current contents of the Twill
Commands field is completely replaced. Zenoss does not save
the replaced information.
See the Section 54.4, “Creating twill Commands” section for
more information about twill commands.
Table 54.3. WebTx Script Settings
If you provide values for Initial User, Initial Password, and Initial Authentication Realm, Zenoss will use
these credentials before accessing the URL specified for Initial URL. All three (Initial User, Initial Password, and Initial Authentication Realm) must be present; otherwise, the values are ignored.
7. Click Save to save the data source.
54.4. Creating twill Commands
ZenWebTx uses a language called twill to specify the steps of a Web test. Each WebTx data source has a field
that contains the twill commands that describe a Web transaction. You can create this list of twill commands
manually, or you can record a session in a browser and use that as the basis for your data source.
Some twill commands specify an action, such as following a specific link on a page or entering data in a form
field. Other twill commands specify a test, such as searching for specific text on a page or making sure the title
does not contain specific text. The full range of available commands is described in the appendix Appendix A,
twill Commands Reference.
155
Web-Based Synthetic Transactions
54.4.1. Creating twill Commands from TestGen4Web
The TestGen4Web Firefox add-on allows you to record browser sessions. ZenWebTx can take these sessions
and convert them to twill, creating a starting point for developing ZenWebTx data sources.
Follow these general steps to record and convert a TestGen4Web session:
1. From the TestGen4Web toolbar in Firefox, use the Record and Stop buttons to record a session.
2. Use the Save button in the toolbar to save the session to a file.
3. From the Script page of a ZenWebTx data source in Zenoss, browse to and select your saved session.
4. Click Save to convert the TestGen4Web session to twill. The newly converted commands appear in the Twill
Commands field on the page, replacing any previous twill commands in that area.
54.4.2. Creating twill Commands Manually
Even if you use TestGen4Web to initially create twill commands, you will frequently want to edit these commands
manually to add data points or additional content checks. The Appendix A, twill Commands Reference describes
in detail the commands that you can use. The Test Twill Commands button on the Script page is helpful when
testing twill commands as you create or edit them.
You also can execute twill commands interactively by using the twill-sh program from the command line. This
program lets you enter commands one at a time and then inspect the pages that come back.
Invoke twill-sh with:
> PYTHONPATH=$ZENHOME/Products/ZenWebTx/lib
$ZENHOME/Products/ZenWebTx/bin/twill-sh
Within twill-sh, use the help command to list available commands and see a command descriptions. Of particular
interest are these commands:
•
showforms – Lists the forms on the page and the fields within each.
•
showlinks – Lists the links on the page.
•
show – Lists the source HTML from the page.
•
exit – Quits the twill-sh program.
Often the most convenient way to use twill-sh is to create a text file that contains your twill commands. You can
then specify that file on the command line when you invoke twill-sh. This lets you analyze problems that occur.
Invoke twill-sh with a text file as such:
> PYTHONPATH=$ZENHOME/Products/ZenWebTx/lib
$ZENHOME/Products/ZenWebTx/bin/twill-sh -i myTwillCommands.txt
The -i option instructs twill-sh to stay in the twill shell rather than exiting when it finishes running the commands
in the myTwillCommands.txt file.
54.5. Monitoring through Proxy Servers
ZenWebTx can access Web servers through HTTP proxy servers and non-authenticating HTTPS proxy servers.
To configure ZenWebTx to use a proxy, you must define the http_proxy and https_proxy environment variables.
1. Open the ~zenoss/.bashrc file.
2. Add the following lines:
export http_proxy=http://Address:Port/
export https_proxy=http://Address:Port/
156
Web-Based Synthetic Transactions
where Address is the address of your HTTP or HTTPS proxy server, and Port is the port on which your
proxy server listens.
54.5.1. Example Proxy Setup
HTTP and HTTPS proxies frequently listen on port 3128. If your proxy server is "my.proxyserver.loc" and it uses
port 3128, then add these two lines to the ~zenoss/.bashrc file:
export http_proxy=http://my.proxyserver.loc:3128/
export https_proxy=http://my.proxyserver.loc:3128/
54.5.2. Testing the Proxy Setup
You can test the proxy setup by using the twill-sh tool. twill-sh is an interpreter shell for the twill scripting language,
which is used to define WebTx data sources.
After setting up the proxy information in the ~zenoss/.bashrc file, follow these steps to test your setup:
1. Make sure http_proxy and https_proxy are defined in your current shell:
$ source ~zenoss/.bashrc
2. Launch the twill shell:
PYTHONPATH=$PYTHONPATH:\
$ZENHOME/ZenPacks/ZenPacks.zenoss.ZenWebTx/ZenPacks/zenoss/ZenWebTx/lib:\
$ZENHOME/ZenPacks/ZenPacks.zenoss.ZenWebTx/ZenPacks/zenoss/ZenWebTx/bin/twill-sh
3. Try to retrieve a URL through HTTP or HTTPS. For example, to retrieve the Zenoss home page, enter:
go http://www.zenoss.com
You should see a message similar to this:
current page: http://www.zenoss.com
If an error message appears, then your proxy may not be correctly configured in the ~zenoss/.bashrc file.
4. Exit the twill shell:
exit
54.6. Daemons
Type
Name
Performance Collector
zenwebtx
Table 54.4. Daemons
157
Chapter 55. Windows Performance
55.1. About
ZenWinPerf is a ZenPack that allows performance monitoring of Windows servers without an intermediary Windows server doing the data collection. ZenWinPerf provides the WinPerf Data Source, which uses a Windows
performance counter rather than an SNMP OID to specify the value to collect.
For more information on Windows Management Instrumentation (WMI), please see this Microsoft Technet Article.
Name
Description
zenwin
Watches Windows services and reports on status.
zeneventlog
Watches Windows Event Log and generates events.
zenwinperf
Collects Perfmon performance data.
zenmodeler
This models Windows devices and has both SNMP and WMI
support.
Table 55.1. Windows Monitoring Daemons
55.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.3 or higher
Required ZenPacks
ZenPacks.zenoss.WinModelerPlugins,
ZenPacks.zenoss.ZenWinPerf
Supported OS Versions
Windows XP, Windows 2000, Windows 2003, Windows Vista,
Windows 2008
Table 55.2. Windows Performance Monitoring Prerequisites
55.3. Enable Monitoring
55.3.1. Defining Windows Credentials
A connection to a Windows device cannot be established without a valid set of credentials. The zProperties
zWinUser and zWinPassword can be set per device or for an entire device class.
The user needs to be a member of the local administrators or of the domain administrators group unless
the steps in Section 55.8, “Configuring a Standalone Windows Device for a Non-Administrative Account”
are followed.
To set these zProperties:
1. Navigate to the device or device class (for example, /Device/Server/Windows) in the Zenoss interface.
2. Click the page menu, then select More → zProperties.
3.
Name
Description
zWinUser
Windows user with privileges to gather performance information. Like all Windows credentials, the domain should be specified in the zWinUser entry. Use .\username for an account that is
not in the domain but only on the local computer.
zWinPassword
Password for the above user.
Table 55.3. Windows Performance zProperties
158
Windows Performance
4. Click Save to save your changes.
55.3.2. Add Devices in Zenoss
The ZenWinPerf ZenPack includes a /Device/Server/Windows/WMI class that has several new device templates
bound. SNMP data collection is not used in this class..
A device can be moved to the /Device/Server/Windows/WMI class with the following procedure.
1. From the page menu, select the Manage → Change Class... menu item.
2. Select the /Device/Server/Windows/WMI class and then click on the OK button.
55.4. Monitor Other Performance Counters
To create your own WinPerf data sources follow these steps:
1. Navigate to either a new or an existing performance template and select New DataSource from the Data
Sources table menu.
2. Enter a name for the data source, select WinPerf as the type and click OK.
3. Enter a Windows performance counter in the Perf Counter field. See Windows Perfmon counters for more
details.
4. Click Save. Notice that a data point is created with the same name as the performance counter you selected.
5. If you wish you can test the counter by entering a device id in the Test Device field and clicking the Test
button.
55.5. Testing Connections from Windows
This procedure verifies that the username/password combination are correct, and that there is no firewall blocking the connection.
1. Run the wbemtest command.
2. Click on the Connect… button.
3. In the Namespace field, enter:
\\HOST\root\cimv2
4. Enter login information in the User and Password fields.
5. Click on the Query field.
6. Enter the following to return a dialog with a list of services on the device.
select * from win32_service
55.6. Testing Connections from Zenoss
This procedure verifies that the username/password combination are correct, and that there is no firewall blocking the connection. Since this is done from the Zenoss server, this test is a better approximation of how successful Zenoss will be in connecting to the Windows device.
As the zenoss user on the Zenoss server:
wmic -U 'user' //device 'select * from Win32_computerSystem'
The wmic command will then prompt you for the password.
This procedure is only valid for Zenoss 2.3 or greater.
159
Windows Performance
55.7. Modify Registry Settings for Firewalls in Secure Environments
This procedure is only applicable for environments with firewalls and so most users will not need this step.
DCOM dynamically allocates one port per process. You need to decide how many ports you want to allocate
to DCOM processes, which is equivalent to the number of simultaneous DCOM processes through the firewall.
You must open all of the UDP and TCP ports corresponding to the port numbers you choose. You also need to
open TCP/UDP 135, which is used for RPC End Point Mapping, among other things. In addition, you must edit
the registry to tell DCOM which ports you reserved. You do this with the HKEY_LOCAL_MACHINES\Software\Microsoft\Rpc\Internet registry key, which you will probably have to create.
To allow remote registry access for the performance data to be read, see Controlling remote Performance
Monitor access to Windows NT servers.
The following table shows the registry settings to restrict DCOMs port range to 10 ports.
Registry Key
Type
Setting
Ports
REG_MULTI_SZ
Range of port. Can be multiple lines
such as: 3001-3010 135
PortsInternetAvailable
REG_SZ
Y
UseInternetPorts
REG_SZ
Y
Table 55.4. Firewall and Registry Settings for DCOM
These registry settings must be established in addition to all firewall settings.
55.8. Configuring a Standalone Windows Device for a Non-Administrative Account
Monitoring Windows devices normally requires an account with administrator-level privileges. For the Zenoss
user who wants to use a non-administrative account, several additional configuration steps must be performed
on each Windows device, or by using a Group Policy.
Zenoss uses the Windows Management Instrumentation (WMI) feature to collect Event Log and Service information in the Core edition and modeling information when using the Enterprise edition. In the Enterprise edition,
the remote Windows registry API also is used to collect low-level performance monitor ("PerfMon") statistics.
Both of these Windows sub-systems use the Microsoft Remote Procedure Call (MS-RPC) interface to connect
to the Windows device and gather the appropriate information. MS-RPC handles the authentication on a perpacket or per-session basis, but ultimately the access granted is determined by the sub-systems involved with
serving the remote procedure calls.
1. If the Windows firewall is in use, modify it to allow Remote Administration access. This will open the MSRPC port and others as needed. Enter the following command at the command prompt:
netsh firewall set service RemoteAdmin enable
2. On Windows XP, Simple File Sharing must be disabled for machines that are not located within a Domain.
When this feature is enabled it causes all incoming MS-RPC connections to use the built-in Guest account,
rather than the account credentials specified in the incoming call. This option may be found by going to
Control Panel, opening the Folder Options applet and then choosing the View tab. In the Advanced Settings
list, navigate to the bottom until you see the Use simple file sharing (Recommended) option, and then disable
it.
160
Windows Performance
Figure 55.1. Windows XP Disable Simple File Sharing
3. Create a local account on the Windows device for monitoring. We assume in the remainder of these steps
that this account was named zenossmon but any valid account name can be used. Place the account only in
the Users group and not in the Power Users or Administrators groups. Optionally, create a new user group
for monitoring and use that group instead of the account in the remaining steps.
4. Give the zenossmon account DCOM access by running the dcomcnfg utility.
Figure 55.2. Component Services COM Security Settings
a. In the Component Services dialog box, expand Component Services, expand Computers, and then
right-click My Computer and click Properties .
b. In the My Computer Properties dialog box, click the COM Security tab.
c. Under Access Permissions, click Edit Limits. In the Access Permission dialog box, add the zenossmon
account to the list and ensure that the Remote Access checkbox is enabled, then click OK to close the
dialog.
d. Under Launch and Activation Permissions, click Edit Limits. In the Access Permission dialog box, add
the zenossmon account to the list and ensure that the Remote Launch and Remote Activation checkboxes
are enabled, then click OK to close the dialog.
161
Windows Performance
e. Click OK on the My Computer Properties dialog to save all changes.
5. Give the zenossmon account permissions to read the WMI namespace by using WMI Control.
Figure 55.3. WMI Control Properties
a. Open the Start menu and right-click on My Computer. Select Manage from the menu.
b. In the Computer Management dialog, expand the Services and Applications item and then right-click
on WMI Control.
c. In the WMI Control Properties dialog, click the Security tab.
d. Expand the Root namespace, select the CIMV2 namespace folder and then click Security.
e. In the Security for ROOT\CIMV2 dialog, add the zenossmon user to the list and ensure the Enable Account
and Remote Enable checkboxes are enabled, then click OK to close the dialog.
f.
In the WMI Control Properties dialog click OK to close the dialog and save all changes.
6. At this point in the process remote access to WMI should be enabled and functioning. Test it by running the
following command from the Zenoss server:
wmic -U '.\zenossmon' //myhostname 'SELECT Name FROM Win32_ComputerSystem'
If all is well this command should return the remote system name as the response. If there is any error,
carefully recheck the above steps to ensure all access has been properly granted.
7. To gather Windows performance data from PerfMon permissions on the winreg registry key must be granted
to our monitoring user by using regedit.
162
Windows Performance
Figure 55.4. regedit and the winreg Key
a. Run regedit.
b. Browse to the HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurePipeServers\winreg
key.
c. Right-click on the winreg key and choose Permissions.
d. Add the monitoring user to the permissions list and grant only Read permissions
8. Give the zenossmon account access to read the Windows Event Log.
Once the appropriate changes are made, test that Event Log access works with your zenossmon user. Run
the following from your Zenoss system:
wmic -U '.\zenossmon' //myhostname \
'SELECT Message FROM Win32_NTLogEvent WHERE LogFile="Application"'
9. If you are using SP1 or newer with Windows Server 2003, then you must allow non-administrative users to
access the service control manager to monitor services.
At a command prompt, run the following:
sc sdset SCMANAGER
D:(A;;CCLCRPRC;;;AU)(A;;CCLCRPWPRC;;;SY)(A;;KA;;;BA)S:(AU;FA;KA;;;WD)
(AU;OIIOFA;GA;;;WD)
The above command should be one line.
At this point you should be able to query Windows service status remotely by using the non-administrative
account. Test this by running the following command from your Zenoss system:
wmic -U '.\zenossmon' //myhostname 'SELECT Name FROM Win32_Service'
163
Windows Performance
55.9. Tuning Collector Daemon Performance
ZenWinPerf creates several zProperties that control its behavior. Values for the zProperties are initially set on
the /Devices device class. As with any zProperty, these values can be overridden in other device classes and
on individual devices themselves.
zProperty
Setting
zWinPerfCycleSeconds
This is how frequently (in seconds) zewinperf data sources are collected. By default this is set to 300
seconds.
Table 55.5. zenwinperf Daemon zProperties
164
Chapter 56. Xen Virtual Hosts
56.1. About
The ZenossVirtualHostMonitor ZenPack allows you to monitor Xen para-virtualized domains with Zenoss. This
ZenPack refers to a Virtual Machine Host as the one running on the bare metal, and Guest for those running
within the virtual hardware.
This ZenPack:
•
Extends Devices to support a relationship from Host to Guest.
•
Extends zenmodeler to find Guest OS's and add them to Virtual Hosts
•
Provides screens and templates for collecting and displaying resources allocated to Guest OSs
Type
Name
Modeler
zenmodeler
Performance Collector
zencommand
Table 56.1. Daemons
56.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenossVirtualHostMonitor
Table 56.2. Xen Virtual Hosts Prerequisites
56.3. Model Hosts and Guest
For each Xen server, follow this procedure:
1. Place an SSH key to your Xen server to allow the zenoss user from the Zenoss server to log in as root
without requiring further credentials.
2. Create the Xen server in the /Servers/Virtual Hosts/Xen device class.
If you have this server modeled already, remove the server and recreate it under the Xen device class.
DO NOT MOVE IT.
3. Select the Guest menu and ensure that the guest hosts were found during the modeling process.
165
Chapter 57. Zenoss Global Dashboard
57.1. About
The Zenoss Global Dashboard is a standalone Web server that collects event and heartbeat data from the
monitored Zenoss servers and aggregates them into a single view. Several portlets from the standard Zenoss
dashboard are available:
•
Device Issues - A list of all devices with serious events. The Server column displays the Zenoss server
that monitors that device.
•
Zenoss Sub-Systems - A list of monitored Zenoss instances. An event rainbow is displayed for each instance, showing a summary of active events.
•
Zenoss Issues - A list of heartbeat issues from monitored Zenoss instances. Refer to the Zenoss Administration Guide for instructions on how to handle these events.
ZenGlobe is a standalone Web server. It is not a ZenPack.
57.2. Prerequisites
Prerequisite
Restriction
Other requirements
The Python setuptools package is required.
Table 57.1. Zen Global Dashboard Prerequisites
57.3. Configuration
57.3.1. Install the ZenGlobe Web Server
Follow these steps to download and install the Zenoss Global Dashboard:
1. Download the latest version of the Zenoss Global Dashboard.
2. Extract the tarball and change to the created directory using the following commands:
tar xzf ZenGlobe-2.1.tar.gz
cd ZenGlobe-2.1
3. Install ZenGlobe.
sudo python setup.py install
4. Prior to starting up the first time, ZenGlobe needs to know the port it should bind to and the Zenoss instance
it should use for authentication. Run:
sudo zenglobe configure
Enter the port to which you want ZenGlobe to bind. Make sure you have nothing else listening at that port.
When asked, enter the hostname of a running Zenoss instance that you want ZenGlobe to use for authentication. You can change this setting later, but in order to log in to ZenGlobe the first time, you will need to
use the username and password of a user from this Zenoss instance. Anyone with a login to this instance
will be able to view the ZenGlobe dashboard, but only the admin user will be able to edit settings.
5. Start ZenGlobe using the command:
sudo zenglobe start
6. Check to make sure that ZenGlobe has started by accessing from your browser:
http://[ZenGlobe machine hostname]:[port]/
166
Zenoss Global Dashboard
You should now see a ZenGlobe login screen.
57.3.2. Configure Remote Zenoss for Monitoring
For security reasons, ZenGlobe must be configured to log in to the remote Zenoss instances from which it
gathers data. By default, this is set to be zenglobe:zenglobe; however, it is a good idea to reconfigure ZenGlobe
to use a more secure username and password combination.
1. In a browser, navigate to the Zenoss instance you wish to monitor, click Settings in the left navigation pane.
2. Select the Users tab.
3. From the table menu, select Add New User. Enter the username that you want ZenGlobe to use to log in to
all Zenoss instances (e.g. zenglobe). You may leave the Email field blank.
4. Click the OK button to save your changes.
57.3.3. Configure ZenGlobe to Monitor Remote Zenoss Instances
1. Log in to the Zenoss Global Dashboard as the admin user.
Only the admin user can modify ZenGlobe options.
2. Click the Configure... link in the top bar. The configuration box will slide down.
The options in this configuration box are as follows:
Name
Description
Zenoss Servers
The list of hostnames of the Zenoss instances ZenGlobe will
monitor.
Remote Login
The user name and password ZenGlobe will use to access the remote Zenoss instances. By default, it is set to
zenglobe:zenglobe. Follow the instructions in Section 57.3.2,
“Configure Remote Zenoss for Monitoring” to set up matching
users on each Zenoss instance to be monitored.
URL Template
The template ZenGlobe will use to build the URL by which it accesses monitored Zenoss instances. If you run your Zenoss instances on a different port, or serve them behind Apache with
rewritten URLs, you will need to update this value to reflect that
change.
Authentication Server
The Zenoss instance against which ZenGlobe authenticates.
You may also reset the port and authentication server using the
same command line option you used when initially configuring
ZenGlobe.
Table 57.2. Zen Global Dashboard Configuration Options
57.4. Viewing a Remote Zenoss Instance
The drop-down list on the extreme left of the top bar can be used to view monitored Zenoss instances from
within ZenGlobe. Select the hostname of an instance from the list and then log in to the remote instance. You
may return to the ZenGlobe dashboard at any time by selecting it from the same drop-down list.
57.5. Ending a Session
Click Logout in the top bar to end your ZenGlobe session.
167
Chapter 58. ZenOperator Role
58.1. About
The ZenOperatorRole ZenPack creates a new role (ZenOperator) suitable for use in Zenoss. For more information about using this role, please see the Zenoss Administration Guide section titled "Roles" in the chapter titled
"Managing Users."
58.2. Prerequisites
Prerequisite
Restriction
Zenoss Version
Zenoss Version 2.2 or higher
Required ZenPacks
ZenPacks.zenoss.ZenOperatorRole
Table 58.1. Zen Operator Role Prerequisites
168
Appendix A. twill Commands Reference
A.1. About
twill is the language used by ZenWebTx to simulate user actions in a Web browser and to test pages retrieved
by the simulation. The following sections list the twill commands available for use in ZenWebTx data sources.
For detailed information about ZenWebTx, see the chapter titled Chapter 54, Web-Based Synthetic Transactions.
Some twill commands produce text output (see the section titled Section A.4, “Display”). These commands do
not affect the execution of tests by ZenWebTx, and are useful in testing and debugging ZenWebTx data sources.
To see the output of commands that produce text output, click Test Twill Commands on the Script page of
a ZenWebTx data source.
Twill commands are divided among the following categories:
•
Browsing
•
Assertions
•
Display
•
Forms
•
Cookies
•
Debugging
•
Other commands
A.2. Browsing
•
go <URL> - Visit the given URL.
•
back - Return to the previous URL.
•
reload - Reload the current URL.
•
follow <link name> - Follow a link on the current page.
A.3. Assertions
•
code <code> - Assert that the last page loaded had this HTTP status. For example, ``code 200`` asserts
that the page loaded correctly.
•
find <regexp> - Assert that the page contains this regular expression.
•
notfind <regexp> - Assert that the page does not contain this regular expression.
•
url <regexp> - Assert that the current URL matches the given regexp.
•
title <regexp> - Assert that the title of this page matches this regular expression.
A.4. Display
•
echo <string> - Echo the string to the screen.
•
redirect_output <filename> - Append all Twill output to the given file.
•
reset_output - Display all output to the screen.
•
save_html [<filename>] - Save the current page's HTML to a file. If no filename is given, derive the filename
from the URL.
•
show - Show the current page's HTML.
169
twill Commands Reference
•
showlinks - Show all of the links on the current page.
•
showforms - Show all of the forms on the current page.
•
showhistory - Show the browser history.
A.5. Forms
•
submit *[<n>]* - Click the nth submit button, if given; otherwise, submit via the last submission button
clicked. If nothing is clicked, then use the first submit button on the form. See the section titled Details on
Form Handling for more information.
•
formvalue <formnum> <fieldname> <value> - Set the given field in the given form to the given value. For
read-only form widgets and controls, the click may be recorded for use by submit, but the value is not
changed unless the config command has changed the default behavior. See config and the section titled
"Details on Form Handling" for more information on the formvalue command.
For list widgets, you can use one of the following commands to select or de-select a particular value. To
select a value, enter the command in this format:
formvalue <formnum> <fieldname> +value
To de-select a value:
formvalue <formnum> <fieldname> -value
•
fv - Abbreviation for the formvalue command.
•
formaction <formnum> <action> - Change the form action URL to the given URL.
•
fa - abbreviation for the fa command.
•
formclear - Clear all values in the form.
•
formfile <formspec> <fieldspec> <filename> [ <content_type> ]* - attach a file to a file upload button by
filename.
A.6. Cookies
•
save_cookies <filename> - Save the current cookie jar to a file.
•
load_cookies <filename> - Replace the current cookie jar with the specified file contents.
•
clear_cookies - Clear all of the current cookies.
•
show_cookies - show all of the current cookies. Sometimes useful for debugging.
A.7. Debugging
debug <what> <level> - Turn on or off debugging/tracing for various functions.
Enter the command in the form:
debug <what> <level>
where <what> is one of these options:
•
HTTP - Show HTTP headers.
•
equiv-refresh - Test HTTP EQUIV-REFRESH headers.
•
twill - Show twill commands.
and <level> is 0 (for off) or 1 (for on).
A.8. Other Commands
•
tidy_ok - Check to see if the tidy command runs on this page without any errors or warnings.
170
twill Commands Reference
•
exit *[<code>]* - Exit with the given integer code, if specified. The value of <code> defaults to 0.
•
run <command> - Execute the specified Python command.
•
run file <file1> [ <file2> ... ]* - Execute the specified files.
•
agent - Set the browser's "User-agent" string.
•
sleep [<seconds>] - sleep the given number of seconds. Defaults to 1 second.
•
reset_browser - Reset the browser.
•
extend_with <module> - Import commands from the specified Python module. This acts like ``from <module> import *`` does in Python.
For example, a function ``fun`` in ``ext module`` would be available as ``fun``. See *examples/extend_example.py* for an example.
•
add_auth <realm> <uri> <user> <password> - Add HTTP Basic Authentication information for the given
realm/URL combination.
For example, “add_auth IdyllStuff http://www.idyll.org/ titus test” tells twill that a request from the authentication realm "IdyllStuff" under http://www.idyll.org/ should be answered with username 'titus', password 'test'.
If the 'with_default_realm' option is set to True, ignore 'realm'.
•
config [<key> [<value>]] - Show/set configuration options.
•
add_extra_headers <name> <value> - Add an extra HTTP header to each HTTP request.
•
show_extra_headers - Show the headers being added to each HTTP request.
•
clear_extra_headers - Clear the headers being added to each HTTP request.
A.9. Details on Form Handling
The formvalue (or fv) and submit commands rely on a certain amount of implicit cleverness to do their work.
In odd situations, it is difficult to determine which form field formvalue will choose based on your field name,
or which form and field submit is going to "click" on.
Example 1
Following is the pseudocode for how formvalue and submit determine which form to use (function
'twill.commands.browser.get_form')::
for each form on page:
if supplied regexp pattern matches the form name, select
if no form name, try converting to an integer N & using N-1 as
an index into the list or forms on the page (for example, form 1 is
the first form on the page).
Example 2
Following is the pseudocode for how formvalue and submit determine which form field to use (function
`twill.commands.browser.get_form_field`)::
search current form for control name with exact match to fieldname;
if single (unique) match, select.
if no match, convert fieldname into a number and use as an index, if
possible.
171
twill Commands Reference
if no match, search current form for control name with regexp match to fieldname;
if single (unique) match, select.
if *still* no match, look for exact matches to submit-button values.
if single (unique) match, select.
Example 3
Following is the pseudocode for `submit`::
if a form was _not_ previously selected by formvalue:
if there is only one form on the page, select it.
otherwise, fail.
if a field is not explicitly named:
if a submit button was "clicked" with formvalue, use it.
otherwise, use the first submit button on the form, if any.
otherwise:
find the field using the same rules as formvalue
finally, if a button has been picked, submit using it;
otherwise, submit without using a button
A.10. ZenWebTx Extensions to twill
ZenWebTx adds several commands to the standard twill vocabulary.
A.10.1. twilltiming
twilltiming sets timers in a set of twill commands. If you then define a data point for this timer, you can graph
and set thresholds on this timer value.
Use the following command to start a new timer:
startTimer myTimerName
and then, to output the value:
printTimer myTimerName
Timer values should be output only once. So, to output the time from the start of the script to more than one
point in the script, you must use more than one timer. For example:
startTimer wwwZenossCom
startTimer bothPages
go http://www.zenoss.com
printTimer wwwZenossCom
startTimer communityPage
follow "Community"
printTimer communityPage
printTimer bothPages
To use these timers in Zenoss, create data points with the same name as the timers. In this example you could
create data points named wwwZenossCom, communityPage, and bothPages. You can then use these data
points in Zenoss thresholds and graph definitions.
172
twill Commands Reference
A.10.2. twillextract
twillextract extracts numeric values from Web pages during the transaction. To use twillextract, use the following
command to match the given regular expression to the current page:
extract <dataName> <regularExpression>
The value 1 or 0 is assigned to dataName depending on whether the regular expression matched or not.
Additionally, you can use Python's regular expression substring-matching syntax to extract substrings of the
matched text. For example, http://www.zenoss.com contains a copyright notice near the bottom that looks like
"Copyright (c) 2005-2009 Zenoss, Inc." The following twill commands use a regular expression to grab the
second year from that notice:
go http://www.zenoss.com
extract copyright "(?P<firstYear>[0-9]*)-(?P<secondYear>[0-9]*) Zenoss, Inc."
is Python syntax for naming that particular part of the regular expression. The value extracted
from that part of the matching text is given the name from the extract command, then a dash, then the name from
the sub-pattern. In this example, copyright gets a value of 1 or 0 depending on whether the pattern was found on
the page or not, and copyright-firstYear and copyright-secondYear get the values extracted from the matched
text. To use these values in Zenoss you must create data points in the WebTx data source with the same
name as those you used in the extract command. In this case you would create data points named copyright,
copyright-firstYear and copyright-secondYear. You can then create graph definitions and thresholds for these
data points.
(?P<name>.....)
A.10.3. twillxpathextract
Zenoss uses the twillxpathextract command to extract numeric values from XML documents. To use twillxpathextract, add the following command to match and extract data using the given XPath expression:
xpathextract <dataName> <xpath>
where xpathextract is the command name, <dataName> is the name of the data point to which the value will
map, and <xpath> is the xpath used to retrieve the data.
When applied to an XML document, the XPath expression must return a numeric value. This value is then
assigned to the dataName data point.
A.10.4. ignorescripts
ignorescripts strips javascript from visited pages before they are processed by twill. Although twill ignores script
tags, it is possible for scripts to include strings that twill will interpret as HTML tags. Including the command
extend_with ignorescripts near the top of your twill commands will cause all script tags to be stripped, thereby
avoiding this issue.
173