MySQL Enterprise Monitor 3.1.4 Manual

Abstract

This manual documents the MySQL Enterprise Monitor version 3.1.4.

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: 2016-08-15 (revision: 6577)


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
III Using MySQL Enterprise Monitor
13 User Interface
13.1 Initial Log-In
13.2 Setting the Timezone and Locale
13.3 Menus and Toolbars
13.3.1 Main Menus
13.3.2 Status Summary
14 Overview
14.1 Database Statistics
14.2 Overview Graphs
14.3 General Database Statistics
14.4 Group Overview Configuration
15 MySQL Instances Dashboard
15.1 MySQL Instance Dashboard UI
15.2 MySQL Instance Details
15.3 Adding Instances
15.3.1 Adding a MySQL Instance
15.3.2 Adding Multiple MySQL Instances
15.4 Filtering MySQL Instances
16 Managing Groups of Instances
17 Replication Dashboard
18 Reports and Graphs
18.1 All Timeseries Graphs
18.1.1 Graph Controls
18.1.2 Graph Types
18.2 Database File I/O and Lock Waits
18.2.1 sys Schema
18.2.2 Database File I/O Graphs and Reports
18.2.3 Lock Waits Report
18.3 InnoDB Buffer Pool Usage
19 Advisors
19.1 Advisors Page
19.2 Advisor Types
19.3 Advisor Thresholds
19.4 Advisor Schedules
20 Events and Event Handling
20.1 Events
20.2 Event Handling
20.2.1 Event Handlers
20.2.2 Event Handling Page
20.3 Creating Event Handlers
20.3.1 Event Action Log
20.3.2 Suspending an Event Handler
21 Expression-Based Advisor Reference
21.1 Administration Advisors
21.2 Agent Advisors
21.3 Availability Advisors
21.4 Cluster Advisors
21.5 Memory Usage Advisors
21.6 Monitoring and Support Services Advisors
21.7 Operating System Advisors
21.8 Performance Advisors
21.9 Replication Advisors
21.10 Schema Advisors
21.11 Security Advisors
22 GUI-Based Advisor Reference
22.1 Agent Health Advisor
22.2 MySQL Enterprise Backup Health Advisor
22.3 MySQL Process Discovery Advisor
22.4 Duplicate MySQL Server UUID
22.5 HTTP Server KeyStore's Certificate About to Expire
22.6 sys Schema Install Advisor
22.7 CPU Utilization Advisor
22.8 Filesystem Free Space Advisor
22.9 MySQL Process
22.10 Query Analysis Advisors
22.11 Security Advisors
23 Access Control
23.1 Users and Roles
23.2 Permissions
23.3 Monitored Assets Permissions
23.3.1 Server Group
23.3.2 MySQL Instances
23.4 Monitoring Services
23.5 MySQL Enterprise Monitor
23.6 Default Users and Roles
23.7 Creating Users and Roles
24 Access Control - Best Practices
24.1 Open Permission Sets
24.2 Strict Permission Set
25 Global Settings
25.1 Server Locale
25.2 Server Hostname
25.3 Customize MySQL Server Name
25.4 Data Purge Behavior
25.5 My Oracle Support Credentials
25.6 HTTP Proxy Settings
25.7 External Authentication
26 Customizing MySQL Enterprise Monitor
26.1 Creating Advisors and Rules
26.1.1 Creating Advisors
26.1.2 Overview of Graph Creation
26.1.3 Overview of Advisor Creation
26.1.4 Variables
26.1.5 Thresholds
26.1.6 Using Strings
26.1.7 Wiki Format
26.1.8 Creating a New Advisor: An Example
26.1.9 Creating a New Graph: An Example
26.2 Custom Data Collection
26.2.1 Custom.xml
26.2.2 Queries
26.2.3 Data Collection Attributes
26.3 Event Notification Blackout Periods
26.3.1 Scripting Blackouts
IV Using the Query Analyzer
27 Using the Query Analyzer
27.1 Providing Query Analyzer Data
27.1.1 Using the MySQL Performance Schema
27.2 Query Response Time index (QRTi)
27.3 Query Analyzer User Interface
27.3.1 Getting Detailed Query Information
27.3.2 Using Graphs to Identify Queries
27.3.3 Filtering Query Analyzer Data
27.3.4 Query Analyzer Settings
27.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
13.1 Initial setup for the MySQL Enterprise Monitor User Interface
13.2 Status Summary
14.1 Overview Dashboard
14.2 Group Overview Filter Configuration
15.1 Add Instance Connection Settings
15.2 Add Instance Encryption Settings
15.3 Add Instance Advanced Settings
15.4 MySQL Instance Filter
16.1 Group Management Page
18.1 Database File I/O By File
18.2 Database File I/O By Wait Type Report
18.3 Database File I/O By Wait Type Graphs
18.4 Database File I/O By Thread
19.1 Advisors Page
19.2 Advisor Menu Control
19.3 Advisor Pop-up Menu
19.4 Advisor Pop-up Menu
19.5 Agent Health - General
19.6 Threshold Definitions Example
20.1 Events Page with Filter
20.2 Event Handlers section
20.3 Email Notification Groups section
20.4 Create Group Dialog
20.5 Email Settings section
20.6 SNMP Settings section
22.1 Agent Health - General
22.2 Agent Health - General
22.3 Agent Health - Backlog
22.4 CPU Usage
22.5 CPU Outliers
22.6 Filesystem - General
22.7 Filesystem - Estimated Full Capacity
22.8 Filesystem - Percentage of Space
22.9 Filesystem - Percentage Used in Time Range
23.1 Core Monitored Assets
23.2 Monitoring Services Permissions
24.1 Hybrid Permission Set Overview
24.2 Strict Permission Set Grouped
25.1 Server Hostname
25.2 Customize MySQL Server Name
25.3 Data Purge Behavior
25.4 My Oracle Support Credentials
25.5 HTTP Proxy Settings
25.6 External Authentication Settings: LDAP
27.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
14.1 Group Overview Filter Configuration
15.1 Bad Connection List
15.2 Unreachable Agents List
15.3 Unmonitored MySQL Instances List
15.4 MySQL Instance Details Columns
15.5 Connection Settings Tab
15.6 Encryption Settings Tab
15.7 Advanced Settings
15.8 MySQL Instance Filter
18.1 Timeseries Graph Filter
19.1 Advisor Page Controls
19.2 Advisor Information Listing
19.3 Advisor Edit Menu Controls
19.4 Advisor Filter Controls
20.1 Events Filter Controls
20.2 Events List Columns
20.3 Event Handler List Controls
20.4 Email Notification Groups Controls
20.5 Email Settings Controls
20.6 SNMP Settings Controls
20.7 Create Event Handler Controls
22.1 MySQL Process Discovery Controls
24.1 Manager Role Definition
24.2 DBA Role Definition
24.3 System-Wide Role Definition
24.4 Development Group Role Definition
24.5 Production Group Role Definition
25.1 Customize
25.2 Customize
25.3 External Authentication
25.4 LDAP Authentication
25.5 Active Directory Authentication
26.1 MySQL Enterprise Monitor: Wiki Formatting
26.2 Custom Data Collection Class Elements
26.3 Attribute Elements
27.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