MySQL Enterprise Monitor 2.2 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.2.

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


Table of Contents

Preface and Notes
1. MySQL Enterprise Monitor Introduction and Architecture
1.1. MySQL Enterprise Service Manager
1.2. MySQL Enterprise Dashboard
1.3. MySQL Enterprise Advisor Collections
1.4. Monitored MySQL Server
1.5. MySQL Enterprise Agent
1.5.1. MySQL Enterprise Agent Basic Architecture
1.5.2. MySQL Enterprise Agent Proxy Service Architecture
2. Using and Configuring MySQL Enterprise Dashboard
2.1. MySQL Enterprise Dashboard
2.2. The Monitor Tab
2.2.1. The Server Graphs and Critical Events
2.2.2. The Heat Chart
2.3. The Advisors Tab
2.3.1. Installing and Updating Advisors
2.3.2. Scheduling Rules
2.3.3. Editing Built-in Rules
2.4. The Events Tab
2.4.1. Closing an Event
2.4.2. Notification of Events
2.5. The Graphs Tab
2.5.1. Displaying Graphs
2.5.2. Setting an Interval
2.5.3. Setting a Time Span
2.6. The Query Analyzer Tab
2.7. The Replication Tab
2.7.1. Replication Page Details
2.8. The Settings Tab
2.8.1. Global Settings
2.8.2. User Preferences
2.8.3. Manage Servers
2.8.4. Managing Users
2.8.5. Manage Notification Groups
2.8.6. Logs
2.8.7. Product Information
2.8.8. Import/Export
2.9. The What's New Tab
2.9.1. Setting What's New Configuration
3. Using the Query Analyzer
3.1. Providing Query Analyzer Data
3.1.1. Using the MySQL Enterprise Plugin for Connector/J
3.1.2. Using the MySQL Enterprise Plugin for Connector/NET
3.1.3. Using the Agent Proxy
3.2. Query Analyzer User Interface
3.2.1. Getting Detailed Query Information
3.2.2. Using Graphs to Identify Queries
3.2.3. Query Analyzer Settings
3.2.4. Filtering Query Analyzer Data
3.3. Troubleshooting Query Analyzer
4. Customizing MySQL Enterprise Monitor
4.1. Creating Advisors and Rules
4.1.1. Creating Advisors
4.1.2. Overview of Rule Creation
4.1.3. Variables
4.1.4. Thresholds
4.1.5. Using Strings
4.1.6. Wiki Format
4.1.7. Creating a New Rule: An Example
4.1.8. Creating a Custom Data Collection Item
4.2. Customizing Standard Advisors
4.3. Disabling and Unscheduling Rules
4.4. Advisor Blackout Periods
4.4.1. Scripting Blackouts
5. MySQL Enterprise Monitor Installation Reference
5.1. User Roles
5.1.1. Existing Users
5.1.2. User Created During Installation
5.1.3. Users Created on First Log-in
5.2. Service Manager Installation
5.2.1. Service Manager Installation Common Parameters
5.2.2. Service Manager Installation on Windows
5.2.3. Service Manager Installation on Mac OS X
5.2.4. Service Manager Installation on Unix
5.2.5. Starting/Stopping the MySQL Enterprise Monitor Service on Windows
5.2.6. Starting/Stopping the MySQL Enterprise Monitor Service on Unix and Mac OS X
5.2.7. MySQL Enterprise Service Manager Configuration Settings and Advisor Installation
5.3. Monitor Agent Installation
5.3.1. Creating a MySQL User Account for the Monitor Agent
5.3.2. Installing the Agent on Microsoft Windows
5.3.3. Installing the Agent on Mac OS X
5.3.4. Installing the Monitor Agent on Unix
5.3.5. Starting/Stopping the MySQL Enterprise Agent
5.3.6. Monitoring Multiple MySQL Servers
5.3.7. Configuring an Agent to Monitor a Remote MySQL Server
5.3.8. Monitoring Outside the Firewall with an SSH Tunnel
5.3.9. Generating a new UUID
5.3.10. Troubleshooting the Agent
5.4. Unattended Installation
5.4.1. Performing an Unattended Installation
5.4.2. MySQL Enterprise Service Manager Options
5.4.3. MySQL Enterprise Agent Options
5.5. Post-Installation Considerations
5.6. Upgrading, Re-Installing or Changing Your Installation
5.6.1. Upgrading MySQL Enterprise Monitor
5.6.2. Changing Your MySQL Enterprise Monitor Installation
5.7. Uninstalling the MySQL Enterprise Monitor
5.7.1. Removing the MySQL Enterprise Monitor: Windows
5.7.2. Removing the MySQL Enterprise Monitor: Unix
5.7.3. Removing the MySQL Enterprise Monitor Mac OS X
A. Licenses for Third-Party Components
A.1. Apache Commons BeanUtils
A.2. Apache Commons Codec
A.3. Apache Commons Collections
A.4. Apache Commons DBCP
A.5. Apache Commons Digester
A.6. Apache Commons Exec
A.7. Apache Commons FileUpload
A.8. Apache Commons HttpClient
A.9. Apache Commons IO
A.10. Apache Commons Lang
A.11. Apache Commons Logging
A.12. Apache Commons Pool
A.13. Apache Commons Validator
A.14. Apache HttpComponents HttpClient
A.15. Apache HttpComponents HttpCore
A.16. Apache JAMES Mime4J
A.17. Apache License Version 2.0, January 2004
A.18. Apache log4j
A.19. Apache Tomcat
A.20. ASM
A.21. cURL (libcurl) License
A.22. JDOM Project
A.23. jQuery
A.24. jQuery UI
A.25. libevent License
A.26. LPeg Library License
A.27. LuaFileSystem Library License
A.28. OpenSSL v0.9.8o and later
A.29. Spring Framework
A.30. zlib License
B. MySQL Enterprise Monitor General Reference
B.1. MySQL Enterprise Monitor Limitations
B.2. Supported Browsers
B.3. Installation Requirements
B.4. Configuring Tomcat Parameters
B.5. Backing up MySQL Enterprise Service Manager
B.6. Migrating 1.3.x Historical Data to MySQL Enterprise Monitor 2.0
B.7. Improving Disk Space Usage with Purge in 2.1 and 2.2
B.8. Regular MySQL Enterprise Monitor Maintenance
B.9. Advisor/Graph Reference
B.9.1. Advisors
B.9.2. Graph Definition Reference
C. MySQL Enterprise Monitor Component Reference
C.1. MySQL Enterprise Service Manager Reference
C.1.1. Configuring Tomcat Parameters
C.1.2. Creating a new SSL KeyStore
C.1.3. Log Files for the MySQL Enterprise Service Manager
C.1.4. The Management Information Base (MIB) File
C.1.5. The config.properties File
C.2. MySQL Enterprise Agent Reference
C.2.1. MySQL Enterprise Agent Configurable Options
C.2.2. MySQL Server (agent-instance.ini) Configuration
C.2.3. Agent Log and pid Files
D. Data Collection Items
E. Error codes
F. MySQL Enterprise Monitor Frequently Asked Questions
G. MySQL Enterprise Monitor Change History
G.1. Changes in MySQL Enterprise Monitor 2.2.3 (8 September 2010)
G.2. Changes in MySQL Enterprise Monitor 2.2.2 (15 July 2010)
G.3. Changes in MySQL Enterprise Monitor 2.2.1 (26 May 2010)
G.4. Changes in MySQL Enterprise Monitor 2.2.0 (5 May 2010)

List of Figures

1.1. MySQL Enterprise Monitor Architecture
1.2. The MySQL Enterprise Service Manager Architecture
1.3. The MySQL Enterprise Monitor Architecture when using proxy and agent services for the same MySQL Server
2.1. MySQL Enterprise Dashboard: The Graphs Screen
2.2. MySQL Enterprise Dashboard: The Heat Chart
2.3. MySQL Enterprise Dashboard: The Heat Chart Legend
2.4. MySQL Enterprise Dashboard: Scheduling Dialog
2.5. MySQL Enterprise Dashboard: Editing Rules
2.6. MySQL Enterprise Dashboard: Events Screen
2.7. MySQL Enterprise Dashboard: Query Analyzer
2.8. MySQL Enterprise Dashboard: Replication Groups
2.9. MySQL Enterprise Dashboard Settings: Outgoing Email
2.10. MySQL Enterprise Dashboard Settings: SNMP Traps
2.11. MySQL Enterprise Dashboard Settings: Server Locale
2.12. MySQL Enterprise Dashboard Settings: Server Hostname
2.13. MySQL Enterprise Dashboard Settings: Data Purge
2.14. MySQL Enterprise Dashboard Settings: Remote Server Inventory Schedule
2.15. MySQL Enterprise Dashboard Settings: MySQL Enterprise Credentials
2.16. MySQL Enterprise Dashboard Settings: HTTP Proxy Settings
2.17. MySQL Enterprise Dashboard Settings: Product Key
2.18. MySQL Enterprise Dashboard Settings: Advisor Bundle
2.19. MySQL Enterprise Dashboard Settings: LDAP Authentication
2.20. MySQL Enterprise Dashboard: User Preferences
2.21. MySQL Enterprise Dashboard: Manage Servers
2.22. MySQL Enterprise Dashboard: Server/Group Pop-up
2.23. MySQL Enterprise Dashboard: Server Renaming
2.24. MySQL Enterprise Dashboard: Manage Users
2.25. MySQL Enterprise Dashboard: Manage Notification Groups
2.26. MySQL Enterprise Dashboard: Edit Notification Group
2.27. MySQL Enterprise Dashboard: Logs
2.28. The What's New Tab
2.29. What's New Configuration
3.1. MySQL Enterprise Monitor Architecture using Query Analyzer with Proxy
3.2. MySQL Enterprise Monitor Architecture using Query Analyzer Directly from Connector
3.3. MySQL Enterprise Dashboard: Standard Agent/Monitor Topology
3.4. MySQL Enterprise Dashboard: Query Analyzer Agent/Monitor Topology
3.5. MySQL Enterprise Dashboard: Query Analyzer
3.6. MySQL Enterprise Dashboard: Canonical Query Tab for a Query
3.7. MySQL Enterprise Dashboard: Example Query Tab for a Query
3.8. MySQL Enterprise Dashboard: Explain Query Tab for a Query
3.9. MySQL Enterprise Dashboard: Graphs Tab for a Query
3.10. MySQL Enterprise Dashboard: Correlated Graphs
3.11. MySQL Enterprise Dashboard: Query Analyzer Configuration
3.12. MySQL Enterprise Dashboard: Query Analyzer Filter Options
5.1. MySQL Enterprise Monitor: Installing Monitor on Windows: Language Selection
5.2. MySQL Enterprise Monitor: Installing Monitor on Windows: Installation Directory
5.3. MySQL Enterprise Monitor: Installing Monitor on Windows: Tomcat Server Options
5.4. MySQL Enterprise Monitor: Installing Monitor on Windows: Repository Configuration
5.5. MySQL Enterprise Monitor: Installing Monitor on OS X: Language Selection
5.6. MySQL Enterprise Monitor: Installing Monitor on OS X: Java Selection
5.7. MySQL Enterprise Monitor: Installing Monitor on OS X: Installation Directory
5.8. MySQL Enterprise Monitor: Installing Monitor on OS X: Tomcat Server Options
5.9. MySQL Enterprise Monitor: Installing Monitor on OS X: Repository Configuration
5.10. MySQL Enterprise Monitor: Initial Dashboard Log-In
5.11. MySQL Enterprise Monitor: Installing Agent on Windows: Language Selection
5.12. MySQL Enterprise Monitor: Installing Agent on Windows: Installation Directory
5.13. MySQL Enterprise Monitor: Installing Agent on Windows: Monitored Database Information
5.14. MySQL Enterprise Monitor: Installing Agent on Windows: MySQL Enterprise Service Manager Options
5.15. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Language Selection
5.16. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Installation Directory
5.17. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information
5.18. MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information
5.19. MySQL Enterprise Monitor: Installing Agent on Mac OS X: MySQL Enterprise Service Manager Options
5.20. MySQL Enterprise Monitor: Server Update: Language Selection
5.21. MySQL Enterprise Monitor: Server Update: Previous Installation
5.22. MySQL Enterprise Monitor: Server Update: Backup of Previous Installation
5.23. MySQL Enterprise Monitor: Server Update: Completed installing files
5.24. MySQL Enterprise Monitor: Server Update: Final Setup
B.1. MySQL Enterprise Monitor: Historical Data Migration Availability
B.2. MySQL Enterprise Monitor: Confirming Historical Data Migration
B.3. MySQL Enterprise Monitor: Historical Data Migration Progress

List of Tables

3.1. Query Analyzer Feeding Solution Comparison
3.2. Query Analyzer Connector/J Summary
3.3. MySQL Monitor Plugin for Connector/J Options
3.4. MySQL Monitor Plugin for Connector/J SSL Options
3.5. Query Analyzer Connector/NET Summary
4.1. MySQL Enterprise Monitor: Wiki Formatting
5.1. MySQL Enterprise Service Manager Installer Options
5.2. MySQL Enterprise Agent Installer Options
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
C.6. mysql-monitor-agent Help Options
C.7. mysql-monitor-agent Admin Options
C.8. mysql-monitor-agent Agent Options
C.9. mysql-monitor-agent Monitor Options
C.10. mysql-monitor-agent Proxy Options
C.11. mysql-monitor-agent Application Options
D.1. MySQL Monitor Data Items
E.1. MySQL Enterprise Dashboard: GUI Error Codes and Messages
E.2. MySQL Enterprise Monitor: Server Codes and Messages