MySQL Enterprise Monitor 3.3.6 Manual

Abstract

This manual documents the MySQL Enterprise Monitor version 3.3.6.

For notes detailing the changes in each release, see the MySQL Enterprise Monitor 3.3 Release Notes.

For legal information, see the Legal Notice.

For 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.

Licensing information.  This product may include third-party software, used under license. See this document for licensing information, including licensing information relating to third-party software that may be included in this release of MySQL Enterprise Monitor.

Document generated on: 2017-10-13 (revision: 7024)


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 Monitor Component Overview
1.2 MySQL Enterprise Monitor Agent
1.3 MySQL Enterprise Service Manager
1.4 MySQL Enterprise Monitor Proxy and Aggregator
2 What's New in 3.3
2.1 Enterprise Backup Dashboard
2.2 System and User-Defined Filters
II Installing MySQL Enterprise Monitor
3 Installation Prerequisites
3.1 Installer Files
3.2 Prerequisites
3.2.1 System Requirements
3.2.2 Supported Platforms
3.2.3 MySQL Enterprise Monitor Repository
3.3 Credentials Required for Installation
3.3.1 Existing Users
3.3.2 Users Created During Installation
3.3.3 Users Created on First Log-in
3.4 Supported Browsers
4 Service Manager Installation
4.1 MySQL Enterprise Monitor Installation Types
4.2 MySQL Enterprise Service Manager Graphical Installation Wizard
4.3 Text-Based Installation
4.4 Starting/Stopping the MySQL Enterprise Monitor Services
4.5 MySQL Enterprise Service Manager Configuration Settings
5 Monitor Agent Installation
5.1 General Agent Related Notes
5.2 Creating MySQL User Accounts for the Monitor Agent
5.3 Java Considerations on Linux
5.4 Monitoring Agent Graphical Installation Wizard
5.5 Starting/Stopping the MySQL Enterprise Monitor Agent
5.5.1 Starting/Stopping the Agent on Windows
5.5.2 Starting/Stopping the Agent on Mac OS X
5.5.3 Starting/Stopping the Agent on Unix
5.5.4 sql_mode
5.6 Monitoring Multiple MySQL Servers
5.7 Configuring an Agent to Monitor a Remote MySQL Server
5.8 Monitoring Outside the Firewall with an SSH Tunnel
5.9 HTTP Connection Timeout
5.10 Troubleshooting the Agent
5.11 Agent Backlog
6 Upgrading MySQL Enterprise Monitor Installations
6.1 General considerations when upgrading MySQL Enterprise Monitor
6.2 Upgrading to MySQL Enterprise Monitor 3.3
6.3 Restoring from Backup
7 Post-installation Considerations
7.1 General Considerations
7.2 Installing SSL Certificates
7.3 Changing an SSH Host Key
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
9.1 Tuning Memory
9.2 Tuning CPU
9.3 Tuning Apache Tomcat Threads
9.4 Tuning Agent Memory Requirements
10 Configuration Utilities
10.1 Service Manager Configuration Utilities
10.2 Agent Configuration Utility
11 Proxy and Aggregator Installation
11.1 Proxy Aggregator Architecture
11.2 Prerequisites
11.3 Installing the Proxy and Aggregator
11.4 Graphical Installation Wizard
11.5 Text-Based Installation
11.6 Unattended Installation
11.7 Starting and Stopping the Proxy and Aggregator
11.8 Configuration Options
12 Configuring Connectors
12.1 Using the MySQL Enterprise Plugin for Connector/PHP
12.2 Using the MySQL Enterprise Plugin for Connector/J
12.3 Using the MySQL Enterprise Plugin for Connector/Net
13 Uninstalling MySQL Enterprise Monitor
13.1 Windows Platforms
13.2 UNIX Platforms
13.3 Mac OS Platforms
13.4 Unattended Uninstallations
III Using MySQL Enterprise Monitor
14 User Interface
14.1 Initial Log-In
14.2 Setting the Timezone and Locale
14.3 Menus and Toolbars
14.3.1 Main Menus
14.3.2 Status Summary
14.3.3 System and User-defined Filters
15 Overview
15.1 Database Statistics
15.2 Overview Graphs
15.3 General Database Statistics
15.4 Group Overview Configuration
16 MySQL Instances Dashboard
16.1 MySQL Instance Dashboard UI
16.2 MySQL Instance Details
16.3 Adding Instances
16.3.1 Adding a MySQL Instance
16.3.2 Adding Multiple MySQL Instances
16.4 Monitoring Amazon RDS
16.5 Filtering MySQL Instances
17 Managing Groups of Instances
18 Enterprise Backup Dashboard
18.1 Backup Overview
18.2 Backup Details
19 Replication Dashboard
19.1 Replication Group Overview
19.2 Replication Dashboard Tabs
19.3 Replication Logging
20 Reports and Graphs
20.1 All Timeseries Graphs
20.1.1 Graph Controls
20.1.2 Graph Types
20.2 Database File I/O and Lock Waits
20.2.1 sys Schema
20.2.2 Database File I/O Graphs and Reports
20.2.3 Lock Waits Report
20.3 Processes Report
20.4 InnoDB Buffer Pool Usage
21 Advisors
21.1 Advisors Page
21.2 Advisor Types
21.3 Advisor Thresholds
21.4 Advisor Schedules
22 Events and Event Handlers
22.1 Events
22.2 Event Handlers
22.2.1 Event Handlers
22.2.2 Event Handlers Page
22.3 Creating Event Handlers
22.3.1 Event Action Log
22.3.2 Suspending an Event Handler
23 Expression-Based Advisor Reference
23.1 Administration Advisors
23.2 Agent Advisors
23.3 Availability Advisors
23.4 Cluster Advisors
23.5 Memory Usage Advisors
23.6 Monitoring and Support Services Advisors
23.7 Operating System Advisors
23.8 Performance Advisors
23.9 Replication Advisors
23.10 Schema Advisors
23.11 Security Advisors
24 GUI-Based Advisor Reference
24.1 Agent Health Advisor
24.2 MySQL Enterprise Backup Health Advisor
24.3 MySQL Process Discovery Advisor
24.4 Duplicate Host Identity
24.5 Duplicate MySQL Server UUID
24.6 sys Schema Install Advisor
24.7 CPU Utilization Advisor
24.8 Filesystem Free Space Advisor
24.9 MySQL Process
24.10 Query Analysis Advisors
24.11 Security Advisors
25 Access Control
25.1 Users and Roles
25.2 Permissions
25.3 Monitored Assets Permissions
25.3.1 Server Group
25.3.2 MySQL Instances
25.4 Monitoring Services
25.5 MySQL Enterprise Monitor
25.6 Default Users and Roles
25.7 Creating Users and Roles
26 Access Control - Best Practices
26.1 Open Permission Sets
26.2 Strict Permission Set
27 Global Settings
27.1 Server Locale
27.2 Server Hostname
27.3 Customize MySQL Server Name
27.4 Data Purge Behavior
27.5 My Oracle Support Credentials
27.6 HTTP Proxy Settings
27.7 External Authentication
28 Customizing MySQL Enterprise Monitor
28.1 Creating Advisors and Rules
28.1.1 Creating Advisors
28.1.2 Overview of Graph Creation
28.1.3 Overview of Advisor Creation
28.1.4 Variables
28.1.5 Thresholds
28.1.6 Using Strings
28.1.7 Wiki Format
28.1.8 Creating a New Advisor: An Example
28.1.9 Creating a New Graph: An Example
28.2 Custom Data Collection
28.2.1 Custom.xml
28.2.2 Queries
28.2.3 Data Collection Attributes
28.3 Event Notification Blackout Periods
28.3.1 Scripting Blackouts
IV Using the Query Analyzer
29 Using the Query Analyzer
29.1 Providing Query Analyzer Data
29.1.1 Using the MySQL Performance Schema
29.2 Query Response Time index (QRTi)
29.3 Query Analyzer User Interface
29.3.1 Getting Detailed Query Information
29.3.2 Using Graphs to Identify Queries
29.3.3 Filtering Query Analyzer Data
29.3.4 Query Analyzer Settings
29.3.5 Exporting Query Information
V Appendices
A MySQL Enterprise Monitor Component Reference
A.1 MySQL Enterprise Service Manager Reference
A.1.1 Log Files for the MySQL Enterprise Service Manager
A.1.2 The Management Information Base (MIB) File
A.1.3 The config.properties file
A.2 MySQL Enterprise Monitor Agent Reference
A.2.1 Agent Log Files
B Managing the Inventory
B.1 The Inventory Page
B.2 Using the Inventory Page
C MySQL Enterprise Monitor Frequently Asked Questions
D MySQL Enterprise Monitor Support
D.1 Diagnostics Report
MySQL Enterprise Monitor Glossary
Index

List of Figures

1.1 MySQL Enterprise Monitor Architecture
1.2 MySQL Enterprise Monitor Agentless Architecture
11.1 MySQL Enterprise Monitor Proxy and Aggregator Architecture
12.1 Plug-in for PHP and Aggregator Architecture
12.2 Connector Plug-in Architecture
12.3 Connector Plug-in Architecture
14.1 Initial setup for the MySQL Enterprise Monitor User Interface
14.2 Status Summary
15.1 Overview Dashboard
15.2 Group Overview Filter Configuration
16.1 Add Instance Connection Settings
16.2 Add Instance Encryption Settings
16.3 Add Instance Advanced Settings
16.4 MySQL Instance Filter
17.1 Group Management Page
18.1 Backup Details
19.1 Replication Overview
19.2 Replication Topology Graph
19.3 Replication Group Statistics
20.1 Database File I/O By File
20.2 Database File I/O By Wait Type Report
20.3 Database File I/O By Wait Type Graphs
20.4 Database File I/O By Thread
20.5 Processes Report
21.1 Advisors Page
21.2 Advisor Menu Control
21.3 Advisor Pop-up Menu
21.4 Advisor Pop-up Menu
21.5 Agent Health - General
21.6 Threshold Definitions Example
22.1 Events Page with Filter
22.2 Event Handlers section
22.3 Email Notification Groups section
22.4 Create Group Dialog
22.5 Email Settings section
22.6 SNMP Settings section
24.1 Agent Health - General
24.2 Agent Health - General
24.3 Agent Health - Backlog
24.4 CPU Usage
24.5 CPU Outliers
24.6 Filesystem - General
24.7 Filesystem - Estimated Full Capacity
24.8 Filesystem - Percentage of Space
24.9 Filesystem - Percentage Used in Time Range
25.1 Core Monitored Assets
25.2 Monitoring Services Permissions
26.1 Hybrid Permission Set Overview
26.2 Strict Permission Set Grouped
27.1 Server Hostname
27.2 Customize MySQL Server Name
27.3 Data Purge Behavior
27.4 My Oracle Support Credentials
27.5 HTTP Proxy Settings
27.6 External Authentication Settings: LDAP
29.1 MySQL Enterprise Monitor User Interface: Query Analyzer

List of Tables

3.1 Required Disk Space
4.1 Installation Parameters
7.1 Agent SSL Configuration Options
8.1 MySQL Enterprise Service Manager Installer Options
8.2 MySQL Enterprise Monitor Agent Installer Options
9.1 Apache Tomcat Environment File Location (default)
9.2 Installation Parameters
9.3 MySQL Enterprise Service Manager repository configuration file location (default)
9.4 Configuration utility location (default)
9.5 Apache Tomcat configuration file location (default)
10.1 Default Location of Agent Configuration Utility
10.2 Service Manager Configuration Utilities
10.3 Service Manager Certificate Utilities
10.4 Default Location of Agent Configuration Utility
10.5 Agent Connection Utility
10.6 MySQL Enterprise Monitor Agent Configuration Utility
11.1 MySQL Enterprise Monitor Proxy and Aggregator Installer Options
11.2 Proxy and Aggregator Help Options
11.3 Proxy and Aggregator Command Line Options
11.4 aggr-module Options
11.5 proxy-module Options
12.1 Connector/PHP Properties
12.2 MySQL Plug-in for Connector/J Properties
12.3 MySQL Plug-in for Connector/J SSL Properties
13.1 MySQL Enterprise Monitor Uninstaller Options
15.1 Group Overview Filter Configuration
16.1 Bad Connection List
16.2 Unreachable Agents
16.3 Unmonitored MySQL Instances
16.4 MySQL Instance Details
16.5 Connection Settings Tab
16.6 Encryption Settings Tab
16.7 Advanced Settings
16.8 MySQL Instance Filter
19.1 Group Status Columns
20.1 Timeseries Graph Filter
21.1 Advisor Page Controls
21.2 Advisor Information Listing
21.3 Advisor Edit Menu Controls
21.4 Advisor Filter Controls
22.1 Events Filter Controls
22.2 Events List Columns
22.3 Event State Icons
22.4 Event Handlers Controls
22.5 Email Notification Groups Controls
22.6 Email Settings Controls
22.7 SNMP Settings Controls
22.8 Create Event Handler Controls
24.1 MySQL Process Discovery Advisor Controls
26.1 Manager Role Definition
26.2 DBA Role Definition
26.3 System-Wide Role Definition
26.4 Development Group Role Definition
26.5 Production Group Role Definition
27.1 Server HostName Controls
27.2 Customize
27.3 External Authentication
27.4 LDAP Authentication
27.5 Active Directory Authentication
28.1 Formatting with Wiki Markup
28.2 Custom Data Collection Class Elements
28.3 Attribute Elements
29.1 QRTi Value Definitions
A.1 MySQL Enterprise Service Manager Log File Locations
A.2
A.3 Default Location of config.properties File
A.4 Optional config.properties values