MySQL Enterprise Monitor 2.3.18 Manual

Abstract

This manual documents the MySQL Enterprise Monitor version 2.3.18.

For legal information, see the Legal Notice.

Document generated on: 2014-09-13 (revision: 5083)


Table of Contents

Preface and Legal Notices
1 MySQL Enterprise Monitor Introduction and Architecture
1.1 MySQL Enterprise Service Manager
1.2 MySQL Enterprise Monitor User Interface
1.3 MySQL Enterprise Advisors Collections
1.4 Monitored MySQL Server
1.5 MySQL Enterprise Monitor Agent
1.5.1 MySQL Enterprise Monitor Agent Basic Architecture
1.5.2 MySQL Enterprise Monitor Agent Proxy Service Architecture
1.5.3 MySQL Enterprise Monitor Agent Aggregator Service Architecture
2 Using and Configuring MySQL Enterprise Monitor User Interface
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.5.4 Exporting Graph Images and Data
2.6 The Query Analyzer Tab
2.7 The Replication Tab
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
2.10 Performance Tuning MySQL Enterprise Monitor User Interface for Large Installations
2.11 Troubleshooting the MySQL Enterprise Monitor User Interface
2.11.1 Diagnosing MySQL Enterprise Monitor User Interface Problems
2.11.2 Known MySQL Enterprise Monitor User Interface Problems and Workarounds
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/PHP
3.1.3 Using the MySQL Enterprise Plugin for Connector/Net
3.1.4 Using the MySQL Enterprise Agent Aggregator
3.1.5 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.2.5 Exporting Query Information
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 Graph Creation
4.1.3 Overview of Rule Creation
4.1.4 Variables
4.1.5 Thresholds
4.1.6 Using Strings
4.1.7 Wiki Format
4.1.8 Creating a New Rule: An Example
4.1.9 Creating a New Graph: An Example
4.1.10 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 Installation Reference
5.1 Credentials Needed for Installation
5.1.1 Existing Users
5.1.2 Users Created During Installation
5.1.3 Users Created on First Log-in
5.2 Installing the Service Manager
5.2.1 Service Manager Installation Common Parameters
5.2.2 Installing the Service Manager on Unix and Linux
5.2.3 Installing the Service Manager on Windows
5.2.4 Installing the Service Manager on Mac OS X
5.2.5 Starting/Stopping the MySQL Enterprise Monitor Service on Unix and Mac OS X
5.2.6 Starting/Stopping the MySQL Enterprise Monitor Service on Windows
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 Monitor Agent on Unix and Linux
5.3.3 Installing the Agent on Microsoft Windows
5.3.4 Installing the Agent on Mac OS X
5.3.5 Starting/Stopping the MySQL Enterprise Monitor 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 Monitor Agent Options
5.5 Postinstallation 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 Ant-Contrib License
A.2 ANTLR 2 License
A.3 ANTLR 3 License
A.4 Apache Commons BeanUtils v1.6 License
A.5 Apache Commons BeanUtils v1.7.0 and Later License
A.6 Apache Commons Chain
A.7 Apache Commons Codec
A.8 Apache Commons Collections License
A.9 Apache Commons DBCP License
A.10 Apache Commons Digester License
A.11 Apache Commons Exec
A.12 Apache Commons FileUpload License
A.13 Apache Commons HttpClient
A.14 Apache Commons IO License
A.15 Apache Commons Lang License
A.16 Apache Commons Logging License
A.17 Apache Commons Math License
A.18 Apache Commons Pool License
A.19 Apache Commons Validator License
A.20 Apache HttpComponents HttpClient License
A.21 Apache HttpComponents HttpCore License
A.22 Apache Jakarta ORO License
A.23 Apache JAMES Mime4J License
A.24 Apache License Version 2.0, January 2004
A.25 Apache log4j License
A.26 Apache Portable Runtime (APR) License
A.27 Apache Struts License
A.28 Apache Tiles
A.29 Apache Tomcat
A.30 Apache Tomcat Native Library License
A.31 ASM License
A.32 Code Generation Library License
A.33 cURL (libcurl) License
A.34 DOM4J License
A.35 Dropdown Check List License
A.36 dtoa.c License
A.37 Editline Library (libedit) License
A.38 Ehcache License
A.39 EZMorph License
A.40 FindGTest.cmake License
A.41 Fred Fish's Dbug Library License
A.42 FreeMarker License
A.43 getarg License
A.44 GLib License (for MySQL Enterprise Monitor)
A.45 GNU General Public License Version 2.0, June 1991
A.46 GNU Lesser General Public License Version 2.1, February 1999
A.47 GNU Libtool License
A.48 Google Controlling Master Thread I/O Rate Patch License
A.49 Google Perftools (TCMalloc utility) License
A.50 Google SMP Patch License
A.51 Guava (Google Core Libraries for Java) License
A.52 Hibernate Annotations License
A.53 Hibernate Commons Annotations License
A.54 Hibernate License
A.55 Java SNMP License
A.56 Javassist License
A.57 JCommon License
A.58 JDOM Project License
A.59 JFreeChart License
A.60 jQuery Form Example Plugin License
A.61 jQuery License
A.62 jQuery UI License
A.63 JSON-lib License
A.64 lib_sql.cc License
A.65 libevent License
A.66 Libffi License
A.67 libiconv License
A.68 libintl License
A.69 Libxml2 License
A.70 Linux-PAM License
A.71 LPeg Library License
A.72 Lua (liblua) License
A.73 LuaFileSystem Library License
A.74 md5 (Message-Digest Algorithm 5) License
A.75 nt_servc (Windows NT Service class library) License
A.76 OGNL (Object-Graph Navigation Language) License
A.77 OpenPAM License
A.78 OpenSSL v1.0 License
A.79 PCRE License
A.80 Percona Multiple I/O Threads Patch License
A.81 PersistJS License
A.82 PNG Behavior License
A.83 PxtoEM License
A.84 Radeox RE
A.85 RegEX-Spencer Library License
A.86 RFC 3174 - US Secure Hash Algorithm 1 (SHA1) License
A.87 Richard A. O'Keefe String Library License
A.88 ROME License
A.89 SHA-1 in C License
A.90 Simple Logging Facade for Java (SLF4J) License
A.91 SNMP4J License
A.92 Spring Framework License
A.93 StringTemplate Template Engine License
A.94 TEA License
A.95 XWork License
A.96 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 Monitor Agent Reference
C.2.1 MySQL Enterprise Monitor 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 Files associated with configuring, debugging, and using MySQL Enterprise Monitor
H MySQL Enterprise Monitor Change History
H.1 Changes in MySQL Enterprise Monitor 2.3.18 (2014-07-10)
H.2 Changes in MySQL Enterprise Monitor 2.3.17 (2014-05-21)
H.3 Changes in MySQL Enterprise Monitor 2.3.16 (2014-04-17)
H.4 Changes in MySQL Enterprise Monitor 2.3.15 (2014-01-09)
H.5 Changes in MySQL Enterprise Monitor 2.3.14 (2013-09-09)
H.6 Changes in MySQL Enterprise Monitor 2.3.13 (2013-02-19)
H.7 Changes in MySQL Enterprise Monitor 2.3.12 (2012-09-19)
H.8 Changes in MySQL Enterprise Monitor 2.3.11 (2012-07-05)
H.9 Changes in MySQL Enterprise Monitor 2.3.10 (2012-04-27)
H.10 Changes in MySQL Enterprise Monitor 2.3.9 (2012-01-31)
H.11 Changes in MySQL Enterprise Monitor 2.3.8 (2011-12-02)
H.12 Changes in MySQL Enterprise Monitor 2.3.7 (2011-09-29)
H.13 Changes in MySQL Enterprise Monitor 2.3.6 (2011-09-06)
H.14 Changes in MySQL Enterprise Monitor 2.3.5 (2011-07-01)
H.15 Changes in MySQL Enterprise Monitor 2.3.4 (2011-05-25)
H.16 Changes in MySQL Enterprise Monitor 2.3.3 (2011-04-15)
H.17 Changes in MySQL Enterprise Monitor 2.3.2 (2011-03-01)
H.18 Changes in MySQL Enterprise Monitor 2.3.1 (2010-12-15)
H.19 Changes in MySQL Enterprise Monitor 2.3.0 (2010-11-01)
MySQL Enterprise Monitor Glossary
Index

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
1.4 The MySQL Enterprise Monitor Architecture when using aggregator and agent services for the same MySQL Server
2.1 MySQL Enterprise Monitor User Interface: The Graphs Screen
2.2 MySQL Enterprise Monitor User Interface: The Heat Chart
2.3 MySQL Enterprise Monitor User Interface: The Heat Chart Legend
2.4 MySQL Enterprise Monitor User Interface: Scheduling Dialog
2.5 MySQL Enterprise Monitor User Interface: Editing Rules
2.6 MySQL Enterprise Monitor User Interface: Events Screen
2.7 MySQL Enterprise Monitor User Interface: Query Analyzer
2.8 MySQL Enterprise Monitor User Interface: Replication Groups
2.9 MySQL Enterprise Monitor User Interface Settings: Outgoing Email
2.10 MySQL Enterprise Monitor User Interface Settings: SNMP Traps
2.11 MySQL Enterprise Monitor User Interface Settings: Server Locale
2.12 MySQL Enterprise Monitor User Interface Settings: Server Hostname
2.13 MySQL Enterprise Monitor User Interface Settings: Data Purge
2.14 MySQL Enterprise Monitor User Interface Settings: Remote Server Inventory Schedule
2.15 MySQL Enterprise Monitor User Interface Settings: My Oracle Support Credentials
2.16 MySQL Enterprise Monitor User Interface Settings: HTTP Proxy Settings
2.17 MySQL Enterprise Monitor User Interface Settings: Advisor Bundle
2.18 MySQL Enterprise Monitor User Interface Settings: LDAP Authentication
2.19 MySQL Enterprise Monitor User Interface Settings: Customize MySQL server name
2.20 MySQL Enterprise Monitor User Interface: User Preferences
2.21 MySQL Enterprise Monitor User Interface: Manage Servers
2.22 MySQL Enterprise Monitor User Interface: Server/Group Pop-up
2.23 MySQL Enterprise Monitor User Interface: Server Renaming
2.24 MySQL Enterprise Monitor User Interface: Manage Users
2.25 MySQL Enterprise Monitor User Interface: Manage Notification Groups
2.26 MySQL Enterprise Monitor User Interface: Edit Notification Group
2.27 MySQL Enterprise Monitor User Interface: 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 Monitor Architecture using Query Analyzer with Aggregator
3.4 The MySQL Enterprise Monitor Architecture using aggregator and agent services for the same MySQL Server
3.5 MySQL Enterprise Monitor User Interface: Standard Agent/Monitor Topology
3.6 MySQL Enterprise Monitor User Interface: Query Analyzer Agent/Monitor Topology
3.7 MySQL Enterprise Monitor User Interface: Query Analyzer
3.8 MySQL Enterprise Monitor User Interface: Canonical Query Tab for a Query
3.9 MySQL Enterprise Monitor User Interface: Example Query Tab for a Query
3.10 MySQL Enterprise Monitor User Interface: Explain Query Tab for a Query
3.11 MySQL Enterprise Monitor User Interface: Graphs Tab for a Query
3.12 MySQL Enterprise Monitor User Interface: Correlated Graphs
3.13 MySQL Enterprise Monitor User Interface: Query Analyzer Configuration
3.14 MySQL Enterprise Monitor User Interface: Query Analyzer Filter Options
5.1 MySQL Enterprise Monitor: Installing Monitor on Windows: Tomcat Server Options
5.2 MySQL Enterprise Monitor: Installing Monitor on Windows: Repository Configuration
5.3 MySQL Enterprise Monitor: Installing Monitor on OS X: Java Selection
5.4 MySQL Enterprise Monitor: Installing Monitor on OS X: Tomcat Server Options
5.5 MySQL Enterprise Monitor: Installing Monitor on OS X: Repository Configuration
5.6 MySQL Enterprise Monitor: Initial Dashboard Log-In
5.7 MySQL Enterprise Monitor: Installing Agent on Windows: Monitored Database Information
5.8 MySQL Enterprise Monitor: Installing Agent on Windows: MySQL Enterprise Service Manager Options
5.9 MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information
5.10 MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information
5.11 MySQL Enterprise Monitor: Installing Agent on Mac OS X: MySQL Enterprise Service Manager Options
5.12 MySQL Enterprise Monitor: Installing Agent on Mac OS X: As a service
5.13 MySQL Enterprise Monitor: Server Update: Previous Installation
5.14 MySQL Enterprise Monitor: Server Update: Backup of Previous Installation
5.15 MySQL Enterprise Monitor: Server Update: Completed installing files
5.16 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 MySQL Enterprise Plugin for Connector/PHP Summary
3.6 MySQL Enterprise Plugin for Connector/PHP Options
3.7 Query Analyzer Connector/Net Summary
3.8 mysql-monitor-agent Aggregator Options
4.1 MySQL Enterprise Monitor: Wiki Formatting
5.1 MySQL Enterprise Service Manager Installer Options
5.2 MySQL Enterprise Monitor 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: Default path of the config.properties File
C.6 Optional config.properties values
C.7 mysql-monitor-agent Help Options
C.8 mysql-monitor-agent Admin Options
C.9 mysql-monitor-agent Agent Options
C.10 mysql-monitor-agent Monitor Options
C.11 mysql-monitor-agent Proxy Options
C.12 mysql-monitor-agent Aggregator Options
C.13 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