Zenoss Administration Guide

Table of Contents

1. Introduction

1. Zenoss Overview

1.1. The Zenoss Standard Model

1.2. Availability Monitoring in Zenoss

1.3. Zenoss Event Management System

1.4. Zenoss Performance Monitoring System

2. Detailed Architecture

1. Zenoss Detailed Architecture

2. User Layer

3. Data Layer

4. Collection and Control Services Layer

4.1. Automated Modeling Daemons

4.2. Availability Modeling Daemons

4.3. Event Collection Daemons

4.4. Performance Monitoring Daemons

4.5. Automated Response Daemons

3. Key Concepts

1. Classification

2. zProperties

3. Inheritance and Path Navigation

4. Zenoss Interface and Navigation

1. Zenoss Dashboard

2. Left Navigation Menu

2.1. Main Views

2.2. Classes

2.3. Browse By

2.3.1. Management Menu

2.3.2. Adding New Devices

2.3.3. Adding and Managing MIBS

2.3.4. Adding Additional Collectors and Scaling Zenoss

2.3.5. Editing Other Zenoss Settings

2.4. Hiding the Left Navigation Menu

3. Directory Path

4. Device/IP Search Box

5. User Information Area

6. Customizing Zenoss Dashboard Portlets

6.1. Devices Issues Portlet

6.1.1. Configuring the Device Issues Portlet

6.2. Top Level Organizers

6.2.1. Configuring the Top Level Organizer Portlet

6.3. Watch List Portlet

6.3.1. Configuring the Watch List Portlet

6.4. Google Maps Portlet

6.4.1. Configuring the Google Maps Portlet

6.5. Zenoss Issues Portlet

6.5.1. Configuring the Zenoss Issues Portlet

6.6. Production States Portlet

6.6.1. Configuring the Production States Portlet

7. Zenoss Network Map

8. "Menu-ized" Elements

8.1. Page Menus

8.2. Table Menus

5. User Management

1. About Zenoss User Accounts

2. Creating New User Accounts

3. Editing User Accounts

3.1. Setting User Passwords

3.2. Editing User Contact Information

3.3. Assigning Roles and Permissions to Users

3.4. Setting the Default User Level

3.5. Setting the Dashboard Timeout and Refresh Time

3.6. Specifying a Default Dashboard Organizer

3.7. Associating Objects in Zenoss with Specific Users

4. User Groups

6. Device Access Control Lists (ACLs) (Commercial)

1. About Device ACLs in Zenoss

2. Key Elements

2.1. Permissions and Roles

2.2. Administered Objects

2.3. Users and Groups

2.4. Assigning Administered Object Access

2.5. Portlet Access Control

3. Setup and Configuration Examples

3.1. Restricted User with ZenUser Role

3.2. Restricted User with ZenManager Role

3.3. Adding Device Organizers

3.4. Restricted User Organizer Management

3.5. Viewing Events

4. Detailed Restricted Screen Functionality

4.1. Dashboard

4.2. Device List

4.3. Device Organizers

4.4. Reporting

7. Email and Pager Settings

1. About Email and Pager Settings

2. Setting SMTP and SNPP Information

8. Organizers and Path Navigation in Zenoss

1. About Organizers and Path Navigation

2. Classes

2.1. Setting zProperties at the Class Level

2.2. Defining and Applying Templates at the Class Level

2.3. Creating New Classes

3. Systems

3.1. Adding, Moving and Nesting Systems

3.1.1. Moving the Sub-System

4. Groups

4.1. Adding Groups

4.1.1. Moving Groups

5. Locations

5.1. Google Maps Geographic View of Network Health

5.1.1. Overview

5.1.2. API Key

5.1.3. Setting an Address for a Location

5.1.4. Clearing the Google Maps Cache

5.1.5. Network Links

5.1.6. Google Maps Example

5.2. Adding, Moving, and Nesting Locations

5.2.1. Moving Sub-locations

6. Inheritance

7. Multiple Mix-In Inheritance and Performance (RRD) Template Binding

7.1. Template Binding Example 1

7.2. Template Binding Example 2

9. zProperties

1. About zProperties

2. Event zProperties

3. Device zProperties

4. Service zProperties

5. Process zProperties

6. Network zProperties

7. Manufacturer zProperties

10. Device Inventory and Configuration

1. What is Inventory and Configuration in Zenoss?

2. How Does Zenoss Model Devices?

3. The ZenModeler Daemon

4. Adding an Individual Device

5. Add an Individual Device with Context

6. Auto-Discovery of Devices

7. Device List

7.1. Managing Multiple Devices using the Device List

8. Individual Device Tabs

8.1. Device Status Tab

8.1.1. Device Status Tab Example

8.2. OS (Operating Systems) Tab

8.2.1. File System Monitoring

8.3. Hardware Tab

8.4. Software Tab

8.5. Events Tab

8.6. History Tab

8.7. Performance Tab

8.7.1. Graph Surfing

8.8. Edit Tab

8.9. Custom Tab

8.10. zProperties Tab

8.11. Templates Tab

8.12. Administration Tab

8.13. Collector Plugins tab

8.14. Modifications Tab

9. Searching For a Device By Name or IP Address

10. Editing Device Configurations

11. Managing Devices

11.1. Remodeling a Device

11.2. Changing the Device Class of a Device

11.3. Resetting Device Manage IP

11.4. Renaming a Device

11.5. Locking Device Configurations

11.6. Resetting the Device Community

11.7. Pushing Configuration Changes Back to the Zenoss System

11.8. Clearing Heartbeats

11.9. Deleting Devices From the System

12. Modeling Devices Using SNMP

12.1. Testing to See if a Device is Running SNMP

12.2. Modeling Remote Windows Devices Using SNMP

12.3. Modeling Remote Linux Devices Using SNMP

12.4. Modeling Cisco Devices Using SNMP

13. Modeling Using SSH/COMMAND

13.1. Using Device Class to Monitor Devices Using SSH

14. Modeling Devices Using PortScan

14.1. Using the /Server/Scan Device Class to Monitor with Portscan

15. Modeling Plugins

15.1. Getting a List of Modeling Plugins for a Device

16. Debugging the Modeling Process

17. Using zLinks to Add Custom Links to a Device Status Page

18. Dumping and Loading Devices Using XML Lists

11. Event Monitoring

1. About Event Monitoring In Zenoss

2. Event Concepts

2.1. Event Life Cycle

2.2. De-duplication

2.3. Begin-End Correlation

3. Zenoss Event Console

3.1. Viewing Event Details

4. Generating and Sending a Test Event

4.1. Sending Events from the Command Line

5. Event Classes

5.1. Creating a New Event Class

6. Event Manager Settings

6.1. Accessing Event Manager Settings

6.2. Changing Event Database Connection Information

6.3. Changing Cache Settings for the Event Manager

6.4. Change the Maintenance Settings for the Event Manager

7. Acknowledging Events

8. Moving Events To History

9. Clearing The Event History

10. Event Class Mapping

11. Applying Event and Device Context Using Event zProperties

12. Mapping Events Through the UI

13. Using Mappings to Correlate Events

14. Event Commands

14.1. Commands Tab

14.2. Create an Event Command Example

14.3. Test the Event Command

15. SNMP Traps and Event Transforms

15.1. SNMP Trap Mapping

15.2. Sending Test Traps

15.3. Transforming Events with Event Mappings

15.4. Event Transforms Based on Event Class

16. Custom Event Views

17. Use ZenMail and ZenPop to Turn Email Messages into Zenoss Events

17.1. ZenMail

17.2. ZenPop

17.3. How Zenoss Translates Various Message Elements to the Event

17.3.1. How Zenoss uses the FROM field

17.3.2. How Zenoss uses the TO Field

17.3.3. How Zenoss uses the SUBJECT Field

17.3.4. How Zenoss uses the Message Body

12. Availability Monitoring

1. Monitoring Topology with ZenPing

1.1. Controlling the Ping Cycle Time

1.2. Using the Predefined /Ping Device Class

2. Monitoring TCP Services

2.1. Zenstatus

2.2. Adding a Service To Monitor

2.3. Monitoring Status Service Status Information

2.4. Editing Service Information

2.5. Configuring Service zProperties

2.6. Using the Predefined /Server/Scan Device Class

2.7. Monitoring a Service Using a Service Class

3. Monitoring Processes

3.1. Adding Processes to Monitor

3.2. Configuring Process zProperties

13. Performance Monitoring

1. Performance Monitoring

2. Performance Templates

2.1. The Templates Page

3. Template Binding

4. Data Sources

5. Data Points

6. Thresholds

7. Graph Definitions

7.1. Graph Points

7.1.1. Data Point Graph Points

7.1.2. Threshold Graph Points

7.1.3. Custom Graph Points

7.2. Custom Graph Definition

7.3. Graph Commands

8. Changing the Order of the Graphs

9. Monitoring A File System and Changing a Threshold

14. Monitoring Devices Remotely via SSH

1. Monitoring Devices Remotely via SSH

1.1. Installing Zenoss Plugins on the Remote Machine

1.1.1. Zenoss Plugin Installation Technique: RPM

1.1.2. Zenoss Plugin Installation Technique: setuptools

1.1.3. Testing the Plugin Installation

1.1.4. Troubleshooting the Plugin Installation

1.1.5. Changing Zenoss to Monitor the Devices Remotely Using SSH

1.1.6. Using the Predefined /Server/Cmd Device Class

15. Monitoring Using ZenCommand

1. About ZenCommands

2. Example: Writing a ZenCommand (check_http example)

3. Collect Data from A ZenCommand

4. Plugin Format for ZenCommands

5. Testing ZenCommands

16. Monitoring Windows Devices

1. Device Preparation for Windows Devices

2. Setting Windows zProperties

3. Testing WMI on a Windows Server

4. Other Optional Windows Configuration Items

5. Modeling Services on Windows Devices

6. Collecting Windows Eventlog Events

7. Monitoring Windows Performance with SNMP-Informant

8. Running Commands on Windows Servers Using Winexe

17. Windows Performance Monitoring (Zenwinperf) (Commercial)

1. About Windows Performance Monitoring

2. Zenwinperf Daemon

2.1. ZenwinPerf zProperties

2.2. How to Create a WinPerf Data Source

2.3. Windows Performance Counters

3. /Device/Server/Windows/WMI Device Class

3.1. Device Templates

3.1.1. Device Template

3.1.2. File System Template

3.1.3. ethernetCsmacd Template

18. SNMP Monitoring

1. SNMP from the Command Line

19. Alerting Rules

1. Creating and Using Alerts

1.1. Setting SMTP Settings For Alerts

2. Creating a New Alerting Rule

2.1. Define and Enable This Alert

2.2. 1.1.1 Create the Content of the Alert Message

2.3. Create a Schedule for Sending the Alert

3. Escalation of Messaging in Zenoss

3.1. Creating an Alerting Hierarchy

4. Adding Delay and Schedules to Alerting Rules

20. UI Commands

1. About UI Commands

2. Defining UI Commands

2.1. UI Command Example: Echo Command

3. Running Commands from the Zenoss Web UI

4. Auto-Running Commands Based on Events

21. Production States and Maintenance Windows

1. About Production States and Maintenance Windows

2. Production States

2.1. Defining Production States for Devices

3. Maintenance Windows

3.1. Creating and Using Maintenance Windows

22. Reporting

1. About Reporting in Zenoss

2. Organizing Reports

3. Navigating and Sorting Report Results

4. Exporting Reports

4.1. Add An Export Button to a Report

5. Reports Included With Zenoss

5.1. Device Reports

5.2. Event Reports

5.3. Performance Reports

5.4. User Reports

6. Graph Reports

6.1. Creating a New Graph Report

6.2. Adding Graphs

6.3. Customizing Graph Text

6.4. Organizing Graphs

7. MultiGraph Reports

7.1. Creating A New MultiGraph Report

7.2. Collections

7.3. Graph Definitions

7.4. Graph Groups

7.5. Graph Order

8. Creating Custom Reports

8.1. Creating Custom Reports Using the ZMI

8.2. Create A Custom Device Report Example

9. Using Reports to Help Troubleshoot Zenoss Daemons

23. Advanced Zenoss Reports (Commercial)

1. Additional Reports

24. General Zenoss Administration

1. Working with Zenoss from the Command Line

2. Minimal Zenoss - ZEO and Zope

3. Checking the Version of Zenoss

4. Checking for Zenoss Updates

5. Starting and Stopping the Zenoss Daemons

6. Zenoss Daemon Commands and Options

6.1. Configuring Zenoss Daemons

6.2. General Options for All Daemons

6.3. zenhub Options

6.4. zenmodeler Options

6.5. zenperfsnmp Options

6.6. zenperfxmlrpc Options

6.7. zenprocess Options

6.8. zenping Options

6.9. zensyslog Options

6.10. zenstatus Options

6.11. zenactions Options

6.12. zentrap Options

6.13. zencommand Options

7. Troubleshooting Zenoss Daemons

8. Automatic Startup in Linux Environments

9. Using Zenoss with a Remote MySQL Instance

10. Loading and Registering MIBs with Zenoss

10.1. Resolving MIB Dependencies

25. Backup, Recovery and Maintenance

1. Backup and Restore

1.1. Backup Details

1.2. Backups Tab

1.3. Remote Backups

1.4. Restore Details

1.5. Periodic Backups

1.5.1. Pack ZEO Database

1.5.2. Log Rotate Script

1.5.3. Backing up the MySQL Event Backend

26. ZenPacks

1. Introduction to ZenPacks

1.1. Installing ZenPacks

1.1.1. Installing via the Command Line

1.1.2. Installing via the User Interface

1.1.3. Installing All Core ZenPacks via RPM

1.2. Creating a ZenPack

1.2.1. Packaging and Distributing Your ZenPack

1.3. Removing a ZenPack

2. Zenoss Core ZenPacks

2.1. ZenJMX ZenPack

2.1.1. About ZenJMX

2.1.2. JMX Background

2.1.3. ZenJMX Capabilities

2.1.4. Single Value Attribute Calls

2.1.5. Multi-Value Attribute Calls

2.1.6. Operation Calls

2.1.7. ZenJMX Behavior

2.1.8. Running the ZenJMX Daemon

2.1.9. Defining Custom JMX Data Sources

2.1.10. Enabling Remote JMX Access

2.1.11. Interrogating an JMX Agent via JConsole

2.1.12. Installing ZenJMX

2.2. ApacheMonitor ZenPack

2.3. DellMonitor ZenPack

2.4. HPMonitor ZenPack

2.5. MySqlMonitor ZenPack

2.6. NtpMonitor ZenPack

2.6.1. Components

2.6.2. DataSource Class Options

2.6.3. Example

2.7. LDAPMonitor ZenPack

2.7.1. Components

2.7.2. DataSource Class Options

2.7.3. Additional Configuration

2.7.4. Example

2.8. RPCMonitor ZenPack

2.8.1. Components

2.8.2. DataSource Class Options

2.8.3. Additional Configuration

2.8.4. Example

2.9. IRCMonitor ZenPack

2.9.1. Components

2.9.2. DataSource Class Options

2.9.3. Example

2.10. JabberMonitor ZenPack

2.10.1. Components

2.10.2. DataSource Class Options

2.10.3. Example

2.11. DigMonitor ZenPack

2.11.1. Components

2.11.2. DataSource Class Options

2.11.3. Example

2.12. FTPMonitor ZenPack

2.12.1. Components

2.12.2. Datasource Class Options

2.12.3. Example

2.13. NNTPMonitor ZenPack

2.13.1. Components

2.13.2. DataSource Class Options

2.13.3. Example

27. Zenoss Global Dashboard (ZenGlobe) (Commercial)

1. About Zenoss Global Dashboard (ZenGlobe)

2. Additional Requirements

3. Installation

3.1. Setting Up Users on Remote Zenoss Instances

4. Setup and Configuration

5. Using the Zenoss Global Dashboard

6. Viewing a Zenoss Instance from the Zenoss Global Dashboard

7. Logging out of ZenGlobe

28. Zenoss High Availability

1. Overview

2. Conventions

3. Prerequisites

4. Installation of Packages

5. Stopping Services

6. Setting up DRBD for File System Replication

7. Relocating Shared Data to the Replicated Disk

8. Setting up Heartbeat for Resource Migration

9. Setting up Heartbeat Resources

10. Troubleshooting

11. References

29. Distributed Monitoring (Commercial)

1. Distributed Monitoring Overview

1.1. Important Installation Notes

2. Typical Usage Scenarios for Distributed Monitoring

2.1. Scalability on the Local Device

2.2. Scalability Over Multiple Remote Devices

2.3. Collectors and or Hubs Set Up through a Firewall

2.4. Collection Over Multiple Overlapping IP Spaces

3. Adding A New Hub

3.1. Add An Existing Hub

4. Adding a New Collector to a Hub

4.1. Deleting Collectors

5. Adding Devices to Collectors

5.1. Moving Devices Between Collectors

30. Monitoring Virtual Host Machines (Commercial)

1. About Monitoring Virtual Host Monitoring

2. Using Zenoss Virtual Host Monitor

31. Predictive Thresholding (ZenHoltWinters) (Commercial)

1. About Predictive Thresholding

2. Using Predictive Thresholding

3. Customizing the Thresholds

32. Authentication Enterprise ZenPacks

1. Active Directory Authentication (Commercial)

1.1. About Active Directory Authentication

1.2. Active Directory Monitored Metrics

2. LDAP Authentication in Zenoss (Commercial)

2.1. About LDAP Authentication

2.2. Setting Up LDAP Authentication

33. Transaction Monitoring ZenPacks

1. Synthetic Transactions (Zenwebtx)(Commercial)

1.1. About Synthetic Transaction (Zenwebtx)

1.2. Overview

1.3. Creating a WebTx Data Source

1.4. Data Source Tab

1.5. Script Tab

1.6. Creating the Twill Commands

1.7. TestGen4Web

1.8. Manually Creating Twill Commands

1.9. Event Generation

1.10. Data Points

2. Mail Transactions Monitoring (ZenMailTx) (Commercial)

2.1. About Mail Transaction Monitoring

2.2. Creating a ZenMailTX Data Source

2.3. Zenmailtx daemon

3. SQL Transaction Monitoring (ZenSQLTx) (Commercial)

3.1. About SQL Transaction Monitoring

3.2. How To Create an SQL Data Source

34. Application Monitoring Enterprise ZenPacks

1. MS SQL Monitoring (MSSQLServer)(Commercial)

1.1. About MS SQL Transaction Monitoring

1.2. Installed Objects

1.2.1. Device Class

1.2.2. Event Class

1.2.3. WinServices

1.2.4. IpServices

1.2.5. Performance Templates

1.2.6. Datasources

1.2.7. Thresholds

1.3. Using the MSSQLServer ZenPack

2. MS Exchange Monitoring (MSExchange)(Commercial)

2.1. About MS Exchange Monitoring

2.2. Installed Objects

2.2.1. Device Classes

2.2.2. Event Classes

2.2.3. Event Class Keys

2.2.4. Alerting Rules

2.2.5. WinServices

2.2.6. IP Services

2.2.7. Performance Templates

2.2.8. Datasources

2.2.9. Thresholds

2.3. Performance Counters and Thresholds

2.4. Reports, Views & Dashboards

2.5. Using the the MSExchange ZenPack

3. IIS Monitoring (Commercial)

3.1. About IIS Monitoring

3.2. Setting up IIS Monitoring

4. JBoss Application Server Monitoring (Commercial)

4.1. About JBoss Application Server Monitoring

4.2. Overview

4.3. Collected Metrics for JBoss

4.4. Setting Up the JBoss ZenPack

5. WebLogic Application Server Monitoring (Commercial)

5.1. About WebLogic Application Server Monitoring

5.2. Weblogic Collected Metrics

5.2.1. Overall Application Server Vitals

5.2.2. Entity EJB, Message Driven Bean (MDB), and Session EJB Subsystem Metrics

5.2.3. Data Pool (JDBC) metrics

5.2.4. Queue (JMS) Metrics

6. Tomcat Application Server Monitoring (Commercial)

6.1. About Tomcat Application Server Monitoring

6.2. Collected Metrics for Tomcat

6.3. Tomcat Monitoring Setup

35. Integration Enterprise ZenPacks

1. Remedy Integration in Zenoss (Commercial)

1.1. About Remedy Integration

1.2. Setting Up Remedy Integration

2. RANCID Integration (Commercial)

2.1. About RANCID Integration

2.2. Setting Up RANCID Integration

A. Net-SNMP and Zenoss

1. Net-SNMP Configuration Settings

1.1. Community Information

1.2. System Contact Information

1.3. Extra Information

B. Event Database Dictionary

1. Event Database Dictionary

C. TALES Expressions

1. About TALES Expressions

2. TALES Device Attributes

3. TALES Event Attributes

D. Device Preparation

1. Net-SNMP

2. SNMP V3 Support

3. Forwarding Syslog Messages from UNIX/Linux Devices

4. Forwarding Syslog Messages from a Cisco IOS Router

4.1. Other Cisco Syslog Configurations

5. Forwarding Syslog Messages from a Cisco CatOS Switch

6. Forwarding Syslog Messages using Syslog-ng

E. ZenWebTx Twill Commands Reference

1. About Twill Commands

2. Browsing

3. Assertions

4. Display

5. Forms

6. Cookies

7. Debugging

8. Other Commands

9. Details on Form Handling

10. ZenWebTx Extensions to Twill

10.1. twilltiming

10.2. twillextract

10.3. ignorescripts

F. Basic Troubleshooting in Zenoss

1. How To Troubleshoot Zenoss Daemons

1.1. Identify the Problem

1.1.1. Check the logs

1.1.2. Get more information

1.1.3. Find out what the program is _really _ doing

1.2. Narrow the Problem

1.3. Look for Conflicts

1.4. Reproduce the Problem

1.5. Getting Help Solving the Problem

1.5.1. Search the Zenoss Forums

1.5.2. Report the Problem to Zenoss