MySQL Enterprise Monitor 2.1 Manual

Copyright © 2006, 2010, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates. MySQL is a trademark of Oracle Corporation and/or its affiliates, and shall not be used without Oracle's express written authorization. Other names may be trademarks of their respective owners.

This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this material is subject to the terms and conditions of your Oracle Software License and Service Agreement, which has been executed and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle or as specifically provided below. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

This documentation is NOT distributed under a GPL license. Use of this documentation is subject to the following terms:

You may create a printed copy of this documentation solely for your own personal use. Conversion to other formats is allowed as long as the actual content is not altered or edited in any way. You shall not publish or distribute this documentation in any form or on any media, except if you distribute the documentation in a manner similar to how Oracle disseminates it (that is, electronically for download on a Web site with the software) or on a CD-ROM or similar medium, provided however that the documentation is disseminated together with the software on the same medium. Any other use, such as any dissemination of printed copies or use of this documentation, in whole or in part, in another publication, requires the prior written consent from an authorized representative of Oracle. Oracle and/or its affiliates reserve any and all rights to this documentation not expressly granted above.

For more information on the terms of this license, for details on how the MySQL documentation is built and produced, or if you are interested in doing a translation, please visit MySQL Contact & Questions.

For additional licensing information, including licenses for libraries used by MySQL products, see Preface and Notes.

If you want help with using MySQL, please visit either the MySQL Forums or MySQL Mailing Lists where you can discuss your issues with other MySQL users.

For additional documentation on MySQL products, including translations of the documentation into other languages, and downloadable versions in variety of formats, including HTML and PDF formats, see the MySQL Documentation Library.

Abstract

This manual documents the MySQL Enterprise Monitor version 2.1.

Document generated on: 2010-11-03 (revision: 23545)


Table of Contents

Preface and Notes
1. Introduction to MySQL Enterprise Monitor
1.1. Overview of the Service
1.1.1. The Service Architecture
1.1.2. Service Features
1.1.3. Security
1.2. Conventions Used in This Document
2. Installation and Upgrades
2.1. User Roles
2.1.1. Existing Users
2.1.2. User Created During Installation
2.1.3. Users Created on First Log-in
2.2. Service Manager Installation
2.2.1. Service Manager Installation Common Parameters
2.2.2. Service Manager Installation on Windows
2.2.3. Service Manager Installation on Mac OS X
2.2.4. Service Manager Installation on Unix
2.2.5. Starting/Stopping the MySQL Enterprise Monitor Service on Windows
2.2.6. Starting/Stopping the MySQL Enterprise Monitor Service on Unix and Mac OS X
2.2.7. MySQL Enterprise Service Manager Configuration Settings and Advisor Installation
2.3. Monitor Agent Installation
2.3.1. Creating a MySQL User Account for the Monitor Agent
2.3.2. Installing the Agent on Microsoft Windows
2.3.3. Installing the Agent on Mac OS X
2.3.4. Installing the Monitor Agent on Unix
2.3.5. Starting/Stopping the MySQL Enterprise Monitor Agent
2.3.6. Advanced Agent Configuration
2.3.7. Troubleshooting the Agent
2.4. Unattended Installation
2.4.1. Command-Line Options
2.4.2. Unattended Windows Installation
2.4.3. Unattended Unix and Mac OS X Installation
2.4.4. Starting the Services
2.5. Post-Installation Considerations
2.6. Upgrading, Re-Installing or Changing Your Installation
2.6.1. Upgrading MySQL Enterprise Monitor
2.6.2. Reinstalling MySQL Enterprise Monitor
2.6.3. Changing Your MySQL Enterprise Monitor Installation
2.7. Uninstalling the MySQL Enterprise Monitor
2.7.1. Removing the MySQL Enterprise Monitor: Windows
2.7.2. Removing the MySQL Enterprise Monitor: Unix
2.7.3. Removing the MySQL Enterprise Monitor Mac OS X
3. MySQL Enterprise Dashboard
3.1. The Server Tree
3.2. The Server Graphs and Critical Events
3.3. The Heat Chart
4. The What's New Page
4.1. Setting What's New Configuration
5. The Settings Page
5.1. Global Settings
5.2. User Preferences
5.3. Manage Servers
5.3.1. Renaming a Server
5.3.2. Grouping Servers
5.3.3. Removing a Server From the Dashboard
5.4. Managing Users
5.5. Manage Notification Groups
5.6. Logs
5.7. The Product Information Screen
5.7.1. Subscription Warning
6. The Advisors Page
6.1. Installing and Updating Advisors
6.2. Scheduling Rules
6.2.1. Heat Chart Notifications
6.3. Editing Built-in Rules
6.4. Creating Advisors and Rules
6.4.1. Creating Advisors
6.4.2. Overview of Rule Creation
6.4.3. Variables
6.4.4. Thresholds
6.4.5. Using Strings
6.4.6. Wiki Format
6.4.7. Creating a New Rule: An Example
6.5. Creating a Custom Data Collection Item
6.5.1. Modifying the Custom Data Item XML File
6.6. Disabling and Unscheduling Rules
6.7. Advisor Blackout Periods
6.7.1. Scripting Blackouts
7. The Events Page
7.1. Closing an Event
7.2. Notification of Events
8. The Graphs Page
8.1. Displaying Graphs
8.2. Setting an Interval
8.3. Setting a Time Span
9. The Query Analyzer Page
9.1. Enabling Query Analyzer
9.1.1. Enabling Query Analyzer by Changing the MySQL Client Application
9.1.2. Enabling Query Analyzer by Changing MySQL Server
9.2. Getting Detailed Query Information
9.3. Using Graphs to Identify Queries
9.4. Filtering Query Analyzer Data
9.5. Using Query Analyzer Data
9.6. Troubleshooting Query Analyzer
9.7. Query Analyzer Settings
10. The Replication Page
10.1. Replication Page Details
A. Licenses for Third-Party Components
A.1. Apache Commons Collections License
A.2. Apache Commons DBCP License
A.3. Apache Commons Digester License
A.4. Apache Commons FileUpload License
A.5. Apache Commons IO License
A.6. Apache Commons Lang License
A.7. Apache Commons Logging License
A.8. Apache Commons Pool License
A.9. Apache Commons Validator License
A.10. Apache License Version 2.0, January 2004
A.11. Apache log4j License
A.12. Apache Tomcat License
A.13. ASM License
A.14. cURL (libcurl) License
A.15. JDOM Project License
A.16. jQuery License
A.17. jQuery UI License
A.18. libevent License
A.19. LPeg Library License
A.20. LuaFileSystem Library License
A.21. OpenSSL v0.9.8o and Later License
A.22. Spring Framework License
A.23. StringTemplate Template Engine License
A.24. zlib License
B. MySQL Enterprise Monitor Frequently Asked Questions
C. Files Associated with The MySQL Enterprise Monitor
C.1. Log Files for the MySQL Enterprise Service Manager
C.2. Monitor Agent and Service Manager Installation Log Files
C.3. Agent Log and PID Files
C.4. The Management Information Base (MIB) File
C.5. The config.properties File
D. Error codes
E. MySQL Enterprise Monitor Change History
E.1. Changes in MySQL Enterprise Monitor 2.1.2 (26 May 2010)
E.2. Changes in MySQL Enterprise Monitor 2.1.1 (10 February 2010)
E.3. Changes in MySQL Enterprise Monitor 2.1.0 (08 September 2009)
F. MySQL Enterprise Monitor Reference
F.1. MySQL Enterprise Monitor Limitations
F.2. Supported Browsers
F.3. Installation Requirements
F.4. Creating a new SSL KeyStore
F.5. Choosing Suitable MySQL Enterprise Service Manager Hardware Configurations
F.6. MySQL Enterprise Monitor Agent Reference
F.7. Configuring Tomcat Parameters
F.8. Backing up MySQL Enterprise Service Manager
F.9. Migrating 1.3.x Historical Data to MySQL Enterprise Monitor 2.0
F.10. Regular MySQL Enterprise Monitor Maintenance
F.11. Advisor/Graph Reference
F.11.1. Advisors
F.11.2. Graph Definition Reference
G. Data Collection Items

List of Figures

1.1. MySQL Enterprise Monitor Architecture
2.1. MySQL Enterprise Monitor: Installing Monitor on Windows: Language Selection
2.2. MySQL Enterprise Monitor: Installing Monitor on Windows: Installation Directory
2.3. MySQL Enterprise Monitor: Installing Monitor on Windows: Tomcat Server Options
2.4. MySQL Enterprise Monitor: Installing Monitor on Windows: Repository Configuration
2.5. MySQL Enterprise Monitor: Installing Monitor on OS X: Language Selection
2.6. MySQL Enterprise Monitor: Installing Monitor on OS X: Java Selection
2.7. MySQL Enterprise Monitor: Installing Monitor on OS X: Installation Directory
2.8. MySQL Enterprise Monitor: Installing Monitor on OS X: Tomcat Server Options
2.9. MySQL Enterprise Monitor: Installing Monitor on OS X: Repository Configuration
2.10. MySQL Enterprise Monitor: Initial Dashboard Log-In
2.11. MySQL Enterprise Monitor: Outgoing Email Settings
2.12. MySQL Enterprise Monitor: Installing Agent on Windows: Language Selection
2.13. MySQL Enterprise Monitor: Installing Agent on Windows: Installation Directory
2.14. MySQL Enterprise Monitor: Installing Agent on Windows: Monitored Database Information
2.15. MySQL Enterprise Monitor: Installing Agent on Windows: Query Analyzer Configuration
2.16. MySQL Enterprise Monitor: Installing Agent on Windows: MySQL Enterprise Service Manager Options
2.17. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Language Selection
2.18. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Installation Directory
2.19. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information
2.20. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information
2.21. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Query Analyzer Configuration
2.22. MySQL Enterprise Monitor: Installing Agent on Mac OS X: MySQL Enterprise Service Manager Options
2.23. MySQL Enterprise Monitor: Server Update: Language Selection
2.24. MySQL Enterprise Monitor: Server Update: Previous Installation
2.25. MySQL Enterprise Monitor: Server Update: Backup of Previous Installation
2.26. MySQL Enterprise Monitor: Server Update: Completed installing files
2.27. MySQL Enterprise Monitor: Server Update: Final Setup
3.1. MySQL Enterprise Dashboard: The Graphs Screen
3.2. MySQL Enterprise Dashboard: The Heat Chart
3.3. MySQL Enterprise Dashboard: The Heat Chart Legend
4.1. The What's New Tab
4.2. What's New Configuration
5.1. MySQL Enterprise Dashboard: Settings
5.2. MySQL Enterprise Dashboard: User Preferences
5.3. MySQL Enterprise Dashboard: Manage Servers
5.4. MySQL Enterprise Dashboard: Server Renaming
5.5. MySQL Enterprise Dashboard: Manage Users
5.6. MySQL Enterprise Dashboard: Manage Notification Groups
5.7. MySQL Enterprise Dashboard: Edit Notification Groups
5.8. MySQL Enterprise Dashboard: Logs
6.1. MySQL Enterprise Dashboard: Scheduling Dialog
6.2. MySQL Enterprise Dashboard: Editing Rules
7.1. MySQL Enterprise Dashboard: Events Screen
9.1. MySQL Enterprise Dashboard: Query Analyzer
9.2. MySQL Enterprise Dashboard: Standard Agent/Monitor Topology
9.3. MySQL Enterprise Dashboard: Query Analyzer Agent/Monitor Topology
9.4. MySQL Enterprise Dashboard: Canonical Query Tab for a Query
9.5. MySQL Enterprise Dashboard: Example Query Tab for a Query
9.6. MySQL Enterprise Dashboard: Explain Query Tab for a Query
9.7. MySQL Enterprise Dashboard: Correlated Graphs
9.8. MySQL Enterprise Dashboard: Query Analyzer Configuration
10.1. MySQL Enterprise Dashboard: Replication Groups
F.1. MySQL Enterprise Monitor: Historical Data Migration Availability
F.2. MySQL Enterprise Monitor: Confirming Historical Data Migration
F.3. MySQL Enterprise Monitor: Historical Data Migration Progress

List of Tables

6.1. MySQL Enterprise Monitor: Wiki Formatting
C.1. MySQL Enterprise Monitor: Log File Locations: Windows
C.2. MySQL Enterprise Monitor: Log File Locations: Unix
C.3. MySQL Enterprise Monitor: Log File Locations: Mac OS X
C.4. MySQL Enterprise Monitor: MIB File Locations
C.5. MySQL Enterprise Monitor: The config.properties File
D.1. MySQL Enterprise Dashboard: GUI Error Codes and Messages
D.2. MySQL Enterprise Monitor: Server Codes and Messages
F.1. mysql-monitor-agent Help Options
F.2. mysql-monitor-agent Admin Options
F.3. mysql-monitor-agent Agent Options
F.4. mysql-monitor-agent Monitor Options
F.5. mysql-monitor-agent Proxy Options
F.6. mysql-monitor-agent Application Options
G.1. MySQL Monitor Data Items