MySQL Enterprise Monitor 3.0.13 Manual

Abstract

This manual documents the MySQL Enterprise Monitor version 3.0.13.

For legal information, see the Legal Notice.

Document generated on: 2014-07-18 (revision: 4909)


Table of Contents

Preface and Legal Notices
I Getting Started with MySQL Enterprise Monitor
1 MySQL Enterprise Monitor Introduction and Architecture
1.1 MySQL Enterprise Service Manager
1.2 MySQL Enterprise Monitor User Interface
1.3 Advisors
1.4 Monitored MySQL Server
1.5 MySQL Enterprise Agent
1.5.1 MySQL Enterprise Monitor Agent Basic Architecture
2 What's new in MySQL Enterprise Monitor 3.0?
II Installing MySQL Enterprise Monitor
3 Installation Prerequisites
3.1 Prerequisites
3.1.1 System Requirements
3.1.2 Supported Platforms
3.1.3 MySQL Enterprise Monitor Repository
3.2 Credentials Needed for Installation
3.2.1 Existing Users
3.2.2 Users Created During Installation
3.2.3 Users Created on First Log-in
3.2.4 Installing SSL Certificates
4 Service Manager Installation
4.1 Service Manager Installation Common Parameters
4.2 HTTP Connection Timeout
4.3 Installing the Service Manager on Unix and Linux
4.4 Installing the Service Manager on Windows
4.5 Installing the Service Manager on Mac OS X
4.6 Starting/Stopping the MySQL Enterprise Monitor Service on Unix and Mac OS X
4.7 Starting/Stopping the MySQL Enterprise Monitor Service on Windows
4.8 MySQL Enterprise Service Manager Configuration Settings and Advisor Installation
4.8.1 Initial Monitor UI Log-In
4.8.2 Setting the Timezone and Locale
5 Monitor Agent Installation
5.1 Creating MySQL User Accounts for the Monitor Agent
5.2 Java Considerations on Linux
5.3 Installing the Monitor Agent on Unix and Linux
5.4 Installing the Agent on Microsoft Windows
5.5 Installing the Agent on Mac OS X
5.6 Considerations When Monitoring On A Cloud
5.7 Starting/Stopping the MySQL Enterprise Monitor Agent
5.7.1 Starting/Stopping the Agent on Windows
5.7.2 Starting/Stopping the Agent on Mac OS X
5.7.3 Starting/Stopping the Agent on Unix
5.7.4 sql_mode
5.8 Monitoring Multiple MySQL Servers
5.9 Configuring an Agent to Monitor a Remote MySQL Server
5.10 Monitoring Outside the Firewall with an SSH Tunnel
5.11 Troubleshooting the Agent
6 Post-installation Considerations
7 Upgrading, Re-Installing or Changing Your Installation
7.1 General considerations when upgrading MySQL Enterprise Monitor
7.2 Guide for Upgrading to MySQL Enterprise Monitor 3.0
7.3 Changing Your MySQL Enterprise Monitor Installation
7.3.1 Upgrading the Monitored MySQL Server
7.3.2 Temporarily Suspending the Agent
7.4 Upgrading an Existing 3.0.x Installation
8 Unattended Installation Reference
8.1 Unattended Installation
8.1.1 Performing an Unattended Installation
8.1.2 MySQL Enterprise Service Manager Options
8.1.3 MySQL Enterprise Monitor Agent Options
9 Performance Tuning MySQL Enterprise Monitor
10 Uninstalling the MySQL Enterprise Monitor
10.1 Removing the MySQL Enterprise Monitor: Windows
10.2 Removing the MySQL Enterprise Monitor: Unix
10.3 Removing the MySQL Enterprise Monitor Mac OS X
III Using MySQL Enterprise Monitor
11 The User Interface
11.1 General
11.1.1 Status Summary
11.1.2 Asset Selector
11.2 The Query Analyzer
11.3 What's New
12 The Dashboards
12.1 Introduction
12.2 Overview
12.3 Replication
12.4 MySQL Instances
13 Settings
13.1 Global Settings
13.2 Manage Users
13.3 Logs
13.4 User Preferences
13.5 Diagnostics Report
14 Reports and Graphs
14.1 All Timeseries Graphs
14.2 InnoDB Buffer Pool Usage Graphs
15 Events
15.1 Closing an Event
15.2 Notification of Events
16 Event Handling
16.1 Event Handlers
17 Advisors Configuration
18 Expression-Based Advisor Reference
18.1 Administration Advisors
18.2 Agent Advisors
18.3 Availability Advisors
18.4 Cluster Advisors
18.5 Memory Usage Advisors
18.6 Monitoring and Support Services Advisors
18.7 Operating System Advisors
18.8 Performance Advisors
18.9 Replication Advisors
18.10 Schema Advisors
18.11 Security Advisors
19 GUI-Based Advisor Reference
19.1 Agent Health Advisor
19.2 MySQL Enterprise Backup Health Advisor
19.3 MySQL Process Discovery Advisor
19.4 Duplicate MySQL Server UUID
19.5 CPU Utilization Advisor
19.6 Filesystem Free Space Advisor
19.7 Query Analysis Advisors
20 Customizing MySQL Enterprise Monitor
20.1 Customizing Groups
20.2 Creating Advisors and Rules
20.2.1 Creating Advisors
20.2.2 Overview of Graph Creation
20.2.3 Overview of Advisor Creation
20.2.4 Variables
20.2.5 Thresholds
20.2.6 Using Strings
20.2.7 Wiki Format
20.2.8 Creating a New Advisor: An Example
20.2.9 Creating a New Graph: An Example
20.3 Custom Data Collection
20.3.1 Custom.xml
20.3.2 Queries
20.3.3 Data Collection Attributes
20.4 Event Notification Blackout Periods
20.4.1 Scripting Blackouts
IV Using the Query Analyzer
21 Using the Query Analyzer
21.1 Providing Query Analyzer Data
21.1.1 Using the MySQL Performance Schema
21.1.2 Using the MySQL Enterprise Plugin for Connector/J
21.1.3 Using the MySQL Enterprise Plugin for Connector/PHP
21.1.4 Using the MySQL Enterprise Plugin for Connector/Net
21.1.5 Using the 2.3 MySQL Enterprise Agent Aggregator
21.1.6 Using the 2.3 Agent Proxy
21.2 Query Response Time index (QRTi)
21.3 Query Analyzer User Interface
21.3.1 Getting Detailed Query Information
21.3.2 Using Graphs to Identify Queries
21.3.3 Filtering Query Analyzer Data
21.3.4 Query Analyzer Settings
21.3.5 Exporting Query Information
V Appendices
A MySQL Enterprise Monitor Frequently Asked Questions
B Managing the Inventory
B.1 The Inventory Page
B.2 Using the Inventory Page
C MySQL Enterprise Monitor General Reference
C.1 MySQL Enterprise Monitor Limitations
C.2 Supported Browsers
C.3 Configuring Tomcat Parameters
C.4 Backing up MySQL Enterprise Service Manager
C.5 Regular MySQL Enterprise Monitor Maintenance
D MySQL Enterprise Monitor Component Reference
D.1 MySQL Enterprise Service Manager Reference
D.1.1 Configuring Tomcat Parameters
D.1.2 Creating a new SSL KeyStore
D.1.3 Log Files for the MySQL Enterprise Service Manager
D.1.4 The Management Information Base (MIB) File
D.1.5 The config.properties file
D.1.6 Using The Service Monitor Repository Configuration Script
D.2 MySQL Enterprise Monitor Agent Reference
D.2.1 MySQL Enterprise Monitor Agent Configurable Options
D.2.2 Agent Log Files
D.2.3 Using The Agent Configuration Script
E Error codes
F Files associated with configuring, debugging, and using MySQL Enterprise Monitor
G Data Collection Items
H MySQL Enterprise Monitor Change History
H.1 Changes in MySQL Enterprise Monitor 3.0.13 (2014-07-18)
H.2 Changes in MySQL Enterprise Monitor 3.0.12 (2014-06-30)
H.3 Changes in MySQL Enterprise Monitor 3.0.11 (2014-05-30)
H.4 Changes in MySQL Enterprise Monitor 3.0.10 (2014-04-30)
H.5 Changes in MySQL Enterprise Monitor 3.0.9 (2014-04-11)
H.6 Changes in MySQL Enterprise Monitor 3.0.8 (2014-04-02)
H.7 Changes in MySQL Enterprise Monitor 3.0.7 (2014-02-28)
H.8 Changes in MySQL Enterprise Monitor 3.0.6 (2014-02-03)
H.9 Changes in MySQL Enterprise Monitor 3.0.5 (2013-12-26)
H.10 Changes in MySQL Enterprise Monitor 3.0.4 (2013-12-05)
H.11 Changes in MySQL Enterprise Monitor 3.0.3 (2013-11-01)
H.12 Changes in MySQL Enterprise Monitor 3.0.2 (2013-10-03)
H.13 Changes in MySQL Enterprise Monitor 3.0.1 (2013-09-21)
H.14 Changes in MySQL Enterprise Monitor 3.0.0 (2013-09-03)
I Licenses for Third-Party Components
I.1 Ant-Contrib License
I.2 ANTLR 2 License
I.3 ANTLR 3 License
I.4 Apache Commons BeanUtils v1.6 License
I.5 Apache Commons BeanUtils v1.7.0 and Later License
I.6 Apache Commons Chain
I.7 Apache Commons Codec
I.8 Apache Commons Collections License
I.9 Apache Commons Daemon
I.10 Apache Commons DBCP License
I.11 Apache Commons Digester License
I.12 Apache Commons Exec
I.13 Apache Commons FileUpload License
I.14 Apache Commons HttpClient
I.15 Apache Commons IO License
I.16 Apache Commons Lang License
I.17 Apache Commons Logging License
I.18 Apache Commons Math License
I.19 Apache Commons Pool License
I.20 Apache Commons Validator License
I.21 Apache HttpComponents HttpClient License
I.22 Apache HttpComponents HttpCore License
I.23 Apache Jakarta ORO License
I.24 Apache JAMES Mime4J License
I.25 Apache License Version 2.0, January 2004
I.26 Apache log4j License
I.27 Apache MINA License
I.28 Apache MINA SSHD License
I.29 Apache Portable Runtime (APR) License
I.30 Apache Struts License
I.31 Apache Tiles
I.32 Apache Tomcat License
I.33 Apache Tomcat Native Library License
I.34 ASM License
I.35 canvg License
I.36 Chardin.js License
I.37 Chosen License
I.38 Code Generation Library License
I.39 Common Public License
I.40 cURL (libcurl) License
I.41 D3 License
I.42 DataTables ColReorderWithResize License
I.43 DataTables ColViz License
I.44 DataTables License
I.45 DOM4J License
I.46 Dropdown Check List License
I.47 dtoa.c License
I.48 Editline Library (libedit) License
I.49 Ehcache License
I.50 EZMorph License
I.51 Felix Framework Distribution
I.52 FindGTest.cmake License
I.53 Fred Fish's Dbug Library License
I.54 FreeMarker License
I.55 getarg License
I.56 gettext-js License
I.57 GLib License (for MySQL Enterprise Monitor)
I.58 GNU General Public License Version 2.0, June 1991
I.59 GNU Lesser General Public License Version 2, June 1991
I.60 GNU Lesser General Public License Version 2.1, February 1999
I.61 GNU Libtool License
I.62 GObject License
I.63 Google Controlling Master Thread I/O Rate Patch License
I.64 Google Perftools (TCMalloc utility) License
I.65 Google Protocol Buffers License
I.66 Google SMP Patch License
I.67 Guava (Google Core Libraries for Java) License
I.68 Harvest License
I.69 Hibernate Annotations License
I.70 Hibernate Commons Annotations License
I.71 Hibernate License
I.72 html2canvas License
I.73 Jackson License
I.74 Java Secure Channel (JSch)
I.75 Java SNMP License
I.76 Javassist License
I.77 Javolution License
I.78 JCommon License
I.79 JDOM Project License
I.80 JFreeChart License
I.81 JLine
I.82 JOpt Simple License
I.83 jQuery Form Example Plugin License
I.84 jQuery License
I.85 jQuery Sparklines Plugin License
I.86 jQuery Templates Plugin License
I.87 jQuery UI License
I.88 JSON-lib License
I.89 json2.js License
I.90 jsTree License
I.91 JUNG License
I.92 junixsocket License
I.93 JZlib License
I.94 LGI License
I.95 lib_sql.cc License
I.96 libevent License
I.97 Libffi License
I.98 libiconv License
I.99 libintl License
I.100 Libxml2 License
I.101 Linux-PAM License
I.102 LPeg Library License
I.103 Lua (liblua) License
I.104 LuaFileSystem Library License
I.105 MarkdownPapers License
I.106 md5 (Message-Digest Algorithm 5) License
I.107 memcached License
I.108 MIT License
I.109 Moment License
I.110 Moment-Timezone License
I.111 Mustache.java License
I.112 nt_servc (Windows NT Service class library) License
I.113 OGNL (Object-Graph Navigation Language) License
I.114 OpenPAM License
I.115 OpenSSL v1.0 License
I.116 PCRE License
I.117 Percona Multiple I/O Threads Patch License
I.118 PersistJS License
I.119 PNG Behavior License
I.120 PxtoEM License
I.121 Quartz Scheduler License
I.122 Radeox RE
I.123 RegEX-Spencer Library License
I.124 RFC 3174 - US Secure Hash Algorithm 1 (SHA1) License
I.125 RGBColor License
I.126 Richard A. O'Keefe String Library License
I.127 Rickshaw License
I.128 ROME License
I.129 SHA-1 in C License
I.130 Simple Logging Facade for Java (SLF4J) License
I.131 SNMP4J License
I.132 Spring Framework License
I.133 StackBlur License
I.134 StringTemplate Template Engine License
I.135 TEA License
I.136 XWork License
I.137 zlib License
MySQL Enterprise Monitor Glossary
Index

List of Figures

1.1 MySQL Enterprise Monitor Architecture
1.2 The MySQL Enterprise Service Manager Architecture
4.1 MySQL Enterprise Monitor: Installing Monitor on Windows: Tomcat Server Options
4.2 MySQL Enterprise Monitor: Installing Monitor on Windows: Bundled Repository Configuration
4.3 MySQL Enterprise Monitor: Installing Monitor on OS X: Tomcat Server Options
4.4 MySQL Enterprise Monitor: Installing Monitor on OS X: Repository Configuration
4.5 MySQL Enterprise Monitor: First-time setup for the MySQL Enterprise Monitor User Interface
5.1 MySQL Enterprise Monitor: Installing Agent on Windows: Host options
5.2 MySQL Enterprise Monitor: Installing Agent on Windows: Agent Authentication
5.3 MySQL Enterprise Monitor: Installing Agent on Windows: Monitored Database Information
5.4 MySQL Enterprise Monitor: Installing Agent on Windows: Additional Agent Users
5.5 MySQL Enterprise Monitor: Agent Monitoring Options
5.6 MySQL Enterprise Monitor: Install as a service
5.7 MySQL Enterprise Monitor: Installing Agent on Mac OS X: MySQL Enterprise Service Manager Options
5.8 MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information (TCIP)
5.9 MySQL Enterprise Monitor: Installing Agent on Mac OS X: Monitored Database Information (Socket)
5.10 MySQL Enterprise Monitor: Installing Agent on OS X: Additional Agent Users
9.1 Performance Tuning Memory: MEM Built-in Agent
11.1 A Status Summary Example
11.2 Asset Selector: Problematic Assets
11.3 The What's New Page
11.4 What's New Configuration
12.1 Group Overview Configuration
12.2 MySQL Enterprise Monitor User Interface: Problematic hosts
12.3 MySQL Instances: Overview
12.4 MySQL Instances: Add MySQL Instance
12.5 MySQL Instances: Add Bulk MySQL Instances
12.6 MySQL Instances: Cancel Pending Connections
12.7 MySQL Instances: Adding Multiple Discovered Processes
12.8 MySQL Instances: Bad Connection Error
12.9 MySQL Instances: A connection showing up as bad and good
12.10 MySQL Instances: No Connection
12.11 MySQL Instances: Connection timeout
12.12 MySQL Instances: Group Context Menu
13.1 MySQL Enterprise Monitor User Interface Settings: Server Locale
13.2 MySQL Enterprise Monitor User Interface Settings: Server Hostname
13.3 MySQL Enterprise Monitor User Interface Settings: Data Purge
13.4 MySQL Enterprise Monitor User Interface Settings: My Oracle Support Credentials
13.5 MySQL Enterprise Monitor User Interface Settings: HTTP Proxy Settings
13.6 MySQL Enterprise Monitor User Interface Settings: Customize MySQL server name
13.7 MySQL Enterprise Monitor User Interface: Manage Users
13.8 MySQL Enterprise Monitor User Interface: Logs
13.9 MySQL Enterprise Monitor User Interface: User Preferences
15.1 MySQL Enterprise Monitor User Interface: Events Screen with Search enabled
16.1 Creating an Email Notification Group
16.2 Creating an Event Handler
17.1 MySQL Enterprise Monitor User Interface: Advisors
17.2 MySQL Enterprise Monitor User Interface: Edit Selected Advisors: Parameters
17.3 MySQL Enterprise Monitor User Interface: Edit Selected Advisors: Schedule
17.4 MySQL Enterprise Monitor User Interface: Advisors: Override Configuration
17.5 MySQL Enterprise Monitor User Interface: Advisors: Disable Configuration
19.1 Agent Health - General
19.2 Agent Health - General
19.3 Agent Health - Backlog
19.4 CPU Usage
19.5 CPU Outliers
19.6 Filesystem - General
19.7 Filesystem - Estimated Full Capacity
19.8 Filesystem - Percentage of Space
19.9 Filesystem - Percentage Used in Time Range
20.1 Manage Instances example
20.2 Creating a New Advisor
21.1 MySQL Enterprise Monitor Architecture using Query Analyzer Directly from Connector
21.2 MySQL Enterprise Monitor Architecture using Query Analyzer with the 2.3 Aggregator
21.3 The MySQL Enterprise Monitor Architecture when using aggregator and agent services for the same MySQL Server
21.4 Standard 2.3 Agent/Monitor Topology
21.5 Query Analyzer 2.3 Agent/Monitor Topology
21.6 MySQL Enterprise Monitor User Interface: Query Analyzer
21.7 MySQL Enterprise Monitor User Interface: Canonical Query Tab for a Query
21.8 MySQL Enterprise Monitor User Interface: Example Query Tab for a Query
21.9 MySQL Enterprise Monitor User Interface: Explain Query Tab for a Query
21.10 Graphs Tab for a Query
21.11 MySQL Enterprise Monitor User Interface: Correlated Graphs
21.12 MySQL Enterprise Monitor User Interface: Query Analyzer Filter Options
21.13 MySQL Enterprise Monitor User Interface: Query Analyzer Configuration

List of Tables

3.1 Disk space Required
3.2 Supported Platforms
3.3 Default Root Path ($INSTALL_ROOT)
3.4 SSL Configuration Options For The Agent's bootstrap.properties
8.1 MySQL Enterprise Service Manager Installer Options
8.2 MySQL Enterprise Monitor Agent Installer Options
9.1 Apache Tomcat configuration file location (default)
9.2 MEM repository configuration file location (default)
9.3 MEM repository configuration tool location (default)
9.4 MEM repository configuration tool location (default)
12.1 Group Overview Configuration
19.1 MySQL Process Discovery Controls
20.1 MySQL Enterprise Monitor: Wiki Formatting
20.2 Custom Data Collection Class Elements
20.3 Attribute Elements
21.1 Query Analyzer Feeding Solution Comparison
21.2 Query Analyzer Connector/J Summary
21.3 MySQL Monitor Plugin for Connector/J Options
21.4 MySQL Monitor Plugin for Connector/J SSL Options
21.5 MySQL Enterprise Plugin for Connector/PHP Summary
21.6 MySQL Enterprise Plugin for Connector/PHP Options
21.7 Query Analyzer Connector/Net Summary
21.8 2.3 mysql-monitor-agent Aggregator Options
21.9 QRTi value definitions
D.1 MySQL Enterprise Monitor: Log File Locations: Windows
D.2 MySQL Enterprise Monitor: Log File Locations: Unix
D.3 MySQL Enterprise Monitor: Log File Locations: Mac OS X
D.4 MySQL Enterprise Monitor: MIB File Locations
D.5 MySQL Enterprise Monitor: Default path of the config.properties File
D.6 Optional config.properties values
D.7 MEM Repository Configuration Tool Location (default)
D.8 MEM Agent Configuration Tool Location (default)
E.1 MySQL Enterprise Dashboard: GUI Error Codes and Messages
E.2 MySQL Enterprise Monitor: Server Codes and Messages
G.1 MySQL Monitor Data Items