MySQL Enterprise Monitor 3.1.7 Manual

Abstract

This manual documents the MySQL Enterprise Monitor version 3.1.7.

For notes detailing the changes in each release, see the MySQL Enterprise Monitor 3.1 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-05-15 (revision: 6906)


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.1
2.1 Security
2.2 Performance Tuning
2.3 Usability
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.1.x
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
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 Replication Dashboard
19 Reports and Graphs
19.1 All Timeseries Graphs
19.1.1 Graph Controls
19.1.2 Graph Types
19.2 Database File I/O and Lock Waits
19.2.1 sys Schema
19.2.2 Database File I/O Graphs and Reports
19.2.3 Lock Waits Report
19.3 InnoDB Buffer Pool Usage
20 Advisors
20.1 Advisors Page
20.2 Advisor Types
20.3 Advisor Thresholds
20.4 Advisor Schedules
21 Events and Event Handlers
21.1 Events
21.2 Event Handlers
21.2.1 Event Handlers
21.2.2 Event Handlers Page
21.3 Creating Event Handlers
21.3.1 Event Action Log
21.3.2 Suspending an Event Handler
22 Expression-Based Advisor Reference
22.1 Administration Advisors
22.2 Agent Advisors
22.3 Availability Advisors
22.4 Cluster Advisors
22.5 Memory Usage Advisors
22.6 Monitoring and Support Services Advisors
22.7 Operating System Advisors
22.8 Performance Advisors
22.9 Replication Advisors
22.10 Schema Advisors
22.11 Security Advisors
23 GUI-Based Advisor Reference
23.1 Agent Health Advisor
23.2 MySQL Enterprise Backup Health Advisor
23.3 MySQL Process Discovery Advisor
23.4 Duplicate MySQL Server UUID
23.5 HTTP Server KeyStore's Certificate About to Expire
23.6 sys Schema Install Advisor
23.7 CPU Utilization Advisor
23.8 Filesystem Free Space Advisor
23.9 MySQL Process
23.10 Query Analysis Advisors
23.11 Security Advisors
24 Access Control
24.1 Users and Roles
24.2 Permissions
24.3 Monitored Assets Permissions
24.3.1 Server Group
24.3.2 MySQL Instances
24.4 Monitoring Services
24.5 MySQL Enterprise Monitor
24.6 Default Users and Roles
24.7 Creating Users and Roles
25 Access Control - Best Practices
25.1 Open Permission Sets
25.2 Strict Permission Set
26 Global Settings
26.1 Server Locale
26.2 Server Hostname
26.3 Customize MySQL Server Name
26.4 Data Purge Behavior
26.5 My Oracle Support Credentials
26.6 HTTP Proxy Settings
26.7 External Authentication
27 Customizing MySQL Enterprise Monitor
27.1 Creating Advisors and Rules
27.1.1 Creating Advisors
27.1.2 Overview of Graph Creation
27.1.3 Overview of Advisor Creation
27.1.4 Variables
27.1.5 Thresholds
27.1.6 Using Strings
27.1.7 Wiki Format
27.1.8 Creating a New Advisor: An Example
27.1.9 Creating a New Graph: An Example
27.2 Custom Data Collection
27.2.1 Custom.xml
27.2.2 Queries
27.2.3 Data Collection Attributes
27.3 Event Notification Blackout Periods
27.3.1 Scripting Blackouts
IV Using the Query Analyzer
28 Using the Query Analyzer
28.1 Providing Query Analyzer Data
28.1.1 Using the MySQL Performance Schema
28.2 Query Response Time index (QRTi)
28.3 Query Analyzer User Interface
28.3.1 Getting Detailed Query Information
28.3.2 Using Graphs to Identify Queries
28.3.3 Filtering Query Analyzer Data
28.3.4 Query Analyzer Settings
28.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
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 Plugin for PHP and Aggregator Architecture
12.2 Connector Plugin Architecture
12.3 Connector Plugin 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
19.1 Database File I/O By File
19.2 Database File I/O By Wait Type Report
19.3 Database File I/O By Wait Type Graphs
19.4 Database File I/O By Thread
20.1 Advisors Page
20.2 Advisor Menu Control
20.3 Advisor Pop-up Menu
20.4 Advisor Pop-up Menu
20.5 Agent Health - General
20.6 Threshold Definitions Example
21.1 Events Page with Filter
21.2 Event Handlers section
21.3 Email Notification Groups section
21.4 Create Group Dialog
21.5 Email Settings section
21.6 SNMP Settings section
23.1 Agent Health - General
23.2 Agent Health - General
23.3 Agent Health - Backlog
23.4 CPU Usage
23.5 CPU Outliers
23.6 Filesystem - General
23.7 Filesystem - Estimated Full Capacity
23.8 Filesystem - Percentage of Space
23.9 Filesystem - Percentage Used in Time Range
24.1 Core Monitored Assets
24.2 Monitoring Services Permissions
25.1 Hybrid Permission Set Overview
25.2 Strict Permission Set Grouped
26.1 Server Hostname
26.2 Customize MySQL Server Name
26.3 Data Purge Behavior
26.4 My Oracle Support Credentials
26.5 HTTP Proxy Settings
26.6 External Authentication Settings: LDAP
28.1 MySQL Enterprise Monitor User Interface: Query Analyzer

List of Tables

3.1 Disk space Required
4.1 Installation Parameters
7.1 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 Installation Parameters
9.3 MEM repository configuration file location (default)
9.4 MEM repository configuration tool location (default)
9.5 MEM repository configuration tool location (default)
10.1 MEM Repository Configuration Tool Location (default)
10.2 Service Manager Config Utilities
10.3 Service Manager Certificate Utilities
10.4 MEM Agent Configuration Tool Location (default)
10.5 Agent Connection Utility
10.6 Agent Configuration Utility
11.1 MySQL Enterprise Monitor Proxy and Aggregator Installer Options
11.2 Proxy and Aggregator Help Options
11.3 Application Options
11.4 aggr-module Options
11.5 proxy-module Options
12.1 Connector/PHP Properties
12.2 MySQL Plugin for Connector/J Properties
12.3 MySQL Plugin 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 List
16.3 Unmonitored MySQL Instances List
16.4 MySQL Instance Details Columns
16.5 Connection Settings Tab
16.6 Encryption Settings Tab
16.7 Advanced Settings
16.8 MySQL Instance Filter
19.1 Timeseries Graph Filter
20.1 Advisor Page Controls
20.2 Advisor Information Listing
20.3 Advisor Edit Menu Controls
20.4 Advisor Filter Controls
21.1 Events Filter Controls
21.2 Events List Columns
21.3 Event Handler List Controls
21.4 Email Notification Groups Controls
21.5 Email Settings Controls
21.6 SNMP Settings Controls
21.7 Create Event Handler Controls
23.1 MySQL Process Discovery Controls
25.1 Manager Role Definition
25.2 DBA Role Definition
25.3 System-Wide Role Definition
25.4 Development Group Role Definition
25.5 Production Group Role Definition
26.1 Customize
26.2 Customize
26.3 External Authentication
26.4 LDAP Authentication
26.5 Active Directory Authentication
27.1 MySQL Enterprise Monitor: Wiki Formatting
27.2 Custom Data Collection Class Elements
27.3 Attribute Elements
28.1 QRTi value definitions
A.1 MySQL Enterprise Monitor: Log File Locations
A.2 MySQL Enterprise Monitor: MIB File Locations
A.3 MySQL Enterprise Monitor: Default path of the config.properties File
A.4 Optional config.properties values