MySQL Enterprise Monitor 4.0.1 Manual

Abstract

This manual documents the MySQL Enterprise Monitor version 4.0.1.

For notes detailing the changes in each release, see the MySQL Enterprise Monitor 4.0 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-11-30 (revision: 7044)


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
2.1 A New Design
2.2 Improved Monitoring of MySQL NDB Cluster 7.5
2.3 User Statistics Report
2.4 Improved Scalability
II Installing MySQL Enterprise Monitor
3 Prerequisites
3.1 Installer Files
3.2 Prerequisites
3.2.1 System Requirements
3.2.2 Supported Platforms
3.2.3 Requirements for Monitoring
3.2.4 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 MySQL Enterprise Monitor
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 Configuring MySQL Enterprise Service Manager
14 Configuring MySQL Enterprise Service Manager
15 User Interface
15.1 Initial Log-In
15.2 Setting the Timezone and Locale
15.3 Menus and Toolbars
15.3.1 Target Selection
15.3.2 Navigation Menus
15.3.3 User Menu
15.3.4 Status Summary
15.3.5 System and User-defined Filters
15.4 What's New
16 Global Settings
16.1 Server Locale
16.2 Server Hostname
16.3 Customize MySQL Server Name
16.4 Data Purge Behavior
16.5 My Oracle Support Credentials
16.6 HTTP Proxy Settings
16.7 External Authentication
17 Manage Instances
17.1 Manage Instances Controls
17.2 Monitored Instance Details
17.3 Adding Instances
17.3.1 Adding a MySQL Instance
17.3.2 Adding Multiple MySQL Instances
17.4 Monitoring Amazon RDS
17.5 Filtering MySQL Instances
18 Managing Groups of Instances
19 Advisors
19.1 Manage Advisors Page
19.2 Advisor Types
19.3 Advisor Thresholds
19.4 Advisor Schedules
20 Expression-Based Advisor Reference
20.1 Administration Advisors
20.2 Agent Advisors
20.3 Availability Advisors
20.4 NDB Cluster Advisors
20.5 Memory Usage Advisors
20.6 Monitoring and Support Services Advisors
20.7 Operating System Advisors
20.8 Performance Advisors
20.9 Replication Advisors
20.10 Schema Advisors
20.11 Security Advisors
21 GUI-Based Advisor Reference
21.1 Agent Health Advisor
21.2 MySQL Enterprise Backup Health Advisor
21.3 MySQL Process Discovery Advisor
21.4 Duplicate Host Identity
21.5 Duplicate MySQL Server UUID
21.6 sys Schema Install Advisor
21.7 CPU Utilization Advisor
21.8 Filesystem Free Space Advisor
21.9 MySQL Process
21.10 Query Analysis Advisors
21.11 Group Replication Advisors
21.12 Security Advisors
21.13 NDB Cluster GUI Advisors
22 Event Handlers
22.1 Event Handlers
22.1.1 Event Handlers
22.1.2 Event Handlers Page
22.2 Creating Event Handlers
22.2.1 Event Action Log
22.2.2 Suspending an Event Handler
23 Access Control
23.1 Users and Roles
23.2 Permissions
23.3 Monitored Assets Permissions
23.3.1 Server Group & MySQL NDB Cluster
23.3.2 MySQL Instances
23.3.3 MySQL NDB Cluster Permissions
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
IV Using MySQL Enterprise Monitor
25 Overview
25.1 Overview Sparkline Graphs
25.2 Database Availability
25.3 General Database Statistics
26 Events
26.1 Events
27 Enterprise Backup Dashboard
27.1 Backup Overview
27.2 Backup Details
28 Replication Dashboard
28.1 Replication Overview
28.2 Replication Dashboard Tabs
28.3 Replication Logging
29 Topology
30 Reports and Graphs
30.1 All Timeseries Graphs
30.1.1 Graph Controls
30.1.2 Graph Types
30.1.3 Timeseries Data Aggregation
30.2 Database File I/O and Lock Waits
30.2.1 sys Schema
30.2.2 Database File I/O Graphs and Reports
30.2.3 Lock Waits Report
30.3 Processes Report
30.4 Table Statistics
30.5 User Statistics
30.6 InnoDB Buffer Pool Usage
30.7 NDB Cluster Memory Usage
31 Customizing MySQL Enterprise Monitor
31.1 Creating Advisors and Rules
31.1.1 Creating Advisors
31.1.2 Overview of Graph Creation
31.1.3 Overview of Advisor Creation
31.1.4 Variables
31.1.5 Thresholds
31.1.6 Using Strings
31.1.7 Wiki Format
31.1.8 Creating a New Advisor: An Example
31.1.9 Creating a New Graph: An Example
31.2 Custom Data Collection
31.2.1 Custom.xml
31.2.2 Queries
31.2.3 Data Collection Attributes
31.3 Event Notification Blackout Periods
31.3.1 Scripting Blackouts
V Using the Query Analyzer
32 Using the Query Analyzer
32.1 Providing Query Analyzer Data
32.1.1 Using the MySQL Performance Schema
32.2 Query Response Time index (QRTi)
32.3 Query Analyzer User Interface
32.3.1 Detailed Query Information
32.3.2 Using Graphs to Identify Queries
32.3.3 Filtering Query Analyzer Data
32.3.4 Query Analyzer Settings
32.3.5 Exporting Query Information
VI 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
15.1 Initial setup for the MySQL Enterprise Monitor User Interface
15.2 Target Selectors
15.3 Status Summary
16.1 Server Hostname
16.2 Customize MySQL Server Name
16.3 Data Purge Behavior
16.4 My Oracle Support Credentials
16.5 HTTP Proxy Settings
16.6 External Authentication Settings: LDAP
17.1 Add Instance Connection Settings
17.2 Add Instance Encryption Settings
17.3 Add Instance Advanced Settings
17.4 MySQL Instance Filter
18.1 Group Management Page
18.2 Group Assets Tab
19.1 Manage 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
21.1 Agent Health - General
21.2 Agent Health - General
21.3 Agent Health - Backlog
21.4 CPU Usage
21.5 CPU Outliers
21.6 Filesystem - General
21.7 Filesystem - Estimated Full Capacity
21.8 Filesystem - Percentage of Space
21.9 Filesystem - Percentage Used in Time Range
21.10 Group Replication Configuration Advisor
21.11 Group Replication Status Advisor
21.12 Group Replication Status Advisor
21.13 Group Replication Status Advisor
22.1 Event Handlers section
22.2 Email Notification Groups section
22.3 Create Group Dialog
22.4 Email Settings section
22.5 SNMP Settings section
22.6 Create Event Handler Dialog
23.1 Core Monitored Assets
23.2 Monitoring Services Permissions
24.1 Hybrid Permission Set Overview
24.2 Strict Permission Set Grouped
25.1 Global Overview
25.2 Global Overview Default Sparklines
25.3 MySQL InnoDB Cluster Default Sparklines
25.4 MySQL Instance Overview Default Sparklines
25.5 Customize Overview Sparkline Graphs
26.1 Events Page with Filter
27.1 Backup Details
28.1 Replication Overview
28.2 Replication Topology Statistics
29.1 Replication Topology Graph
29.2 Group Replication Single Group Topology
29.3 Group Replication Multiple Group Topology
29.4 NDB Cluster Topology
29.5 NDB Cluster Topology - Management Node
29.6 NDB Cluster Topology - API Node
29.7 NDB Cluster Topology - Data Node
30.1 Optimizing Graph Data Status
30.2 Database File I/O By File
30.3 Database File I/O By Wait Type Report
30.4 Database File I/O By Wait Type Graphs
30.5 Database File I/O By Thread
30.6 Processes Report
30.7 Table Statistics Report - Table View
30.8 Table Statistics Report - Tree View
30.9 User Statistics Report - Table View
30.10 User Statistics Report - Tree View
30.11 NDB Cluster Memory Usage Report - Table View
30.12 NDB Cluster Memory Usage Report - Tree View
32.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
16.1 Server Hostname Controls
16.2 Customize
16.3 External Authentication
16.4 LDAP Authentication
16.5 Active Directory Authentication
17.1 Bad Connection List
17.2 Unreachable Agents
17.3 Unmonitored MySQL Instances
17.4 MySQL Instance Details
17.5 Connection Settings Tab
17.6 Encryption Settings Tab
17.7 Advanced Settings
17.8 MySQL Instance Filter
19.1 Manage Advisors Page Controls
19.2 Advisor Information Listing
19.3 Advisor Edit Menu Controls
19.4 Advisor Filter Controls
21.1 MySQL Process Discovery Advisor Controls
21.2 NDB Cluster Memory Usage Advisor Controls
21.3 NDB Cluster Status Advisor Controls
22.1 Event Handlers Controls
22.2 Email Notification Groups Controls
22.3 Email Settings Controls
22.4 SNMP Settings Controls
22.5 Create Event Handler 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
26.1 Events Filter Controls
26.2 Events List Columns
26.3 Event State Icons
28.1 Group Status Columns
30.1 Timeseries Graph Filter
31.1 Formatting with Wiki Markup
31.2 Custom Data Collection Class Elements
31.3 Attribute Elements
32.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