MySQL Enterprise Monitor 8.0.21 Manual

Abstract

This manual documents MySQL Enterprise Monitor version 8.0.21.

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

For legal information, including licensing information, see the Preface and Legal Notices.

For help with using MySQL, please visit the MySQL Forums, where you can discuss your issues with other MySQL users.

Document generated on: 2020-08-13 (revision: 8165)


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
2 What's New
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 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 UNIX-like Platforms
5.4 Monitoring Agent Graphical Installation Wizard
5.5 Starting/Stopping 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 Backup the Repository
7.4 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 Uninstalling MySQL Enterprise Monitor
11.1 Windows Platforms
11.2 Mac OS Platforms
11.3 Unattended Uninstallations
III Configuring MySQL Enterprise Service Manager
12 Configuring MySQL Enterprise Service Manager
13 User Interface
13.1 Initial Log-In
13.2 Setting the Timezone and Locale
13.3 Menus and Toolbars
13.3.1 Target Selection
13.3.2 Navigation Menus
13.3.3 User Menu
13.3.4 Status Summary
13.3.5 System and User-defined Filters
13.3.6 Configuration Views
13.4 What's New
14 Global Settings
14.1 Server Locale
14.2 Server Hostname
14.3 Customize MySQL Server Name
14.4 Data Purge Behavior
14.5 My Oracle Support Credentials
14.6 HTTP Proxy Settings
14.7 External Authentication
15 Manage Instances
15.1 Manage Instances Controls
15.2 Monitored Instance Details
15.3 Adding Instances
15.3.1 Adding a MySQL Instance
15.3.2 Adding Multiple MySQL Instances
15.4 Monitoring Amazon RDS
15.5 Filtering MySQL Instances
16 Asset Management
16.1 Agents View
16.2 Hosts View
16.3 NDB Clusters View
16.4 Deleting Assets
16.5 Deleting Assets from the Command Line
17 Managing Groups of Instances
18 Advisors
18.1 Manage Advisors Page
18.2 Advisor Types
18.3 Advisor Thresholds
18.4 Advisor Schedules
19 Expression-Based Advisor Reference
19.1 Administration Advisors
19.2 Agent Advisors
19.3 Availability Advisors
19.4 NDB Cluster Advisors
19.5 Memory Usage Advisors
19.6 Monitoring and Support Services Advisors
19.7 Operating System Advisors
19.8 Performance Advisors
19.9 Replication Advisors
19.10 Schema Advisors
19.11 Security Advisors
20 GUI-Based Advisor Reference
20.1 Agent Health Advisor
20.2 MySQL Enterprise Backup Health Advisor
20.3 MySQL Process Discovery Advisor
20.4 Duplicate Host Identity
20.5 Duplicate MySQL Server UUID
20.6 sys Schema Install Advisor
20.7 CPU Utilization Advisor
20.8 Filesystem Free Space Advisor
20.9 MySQL Process
20.10 Query Analysis Advisors
20.11 Group Replication Advisors
20.12 Security Advisors
20.13 NDB Cluster GUI Advisors
21 Event Handlers
21.1 Event Handlers
21.1.1 Event Handlers
21.1.2 Event Handlers Page
21.2 Creating Event Handlers
21.2.1 Event Action Log
21.2.2 Suspending an Event Handler
22 Access Control
22.1 Users and Roles
22.2 Permissions
22.3 Monitored Assets Permissions
22.3.1 Server Group & MySQL NDB Cluster
22.3.2 MySQL Instances
22.3.3 MySQL NDB Cluster Permissions
22.4 Monitoring Services
22.5 MySQL Enterprise Monitor
22.6 Default Users and Roles
22.7 Creating Users and Roles
23 Access Control - Best Practices
23.1 Open Permission Sets
23.2 Strict Permission Set
IV Using MySQL Enterprise Monitor
24 Overview
24.1 Overview Sparkline Graphs
24.2 Database Availability
24.3 General Database Statistics
25 Events
25.1 Events
26 Enterprise Backup Dashboard
26.1 Backup Overview
26.2 Backup Details
27 Replication Dashboard
27.1 Replication Overview
27.2 Replication Dashboard Tabs
27.3 Replication Logging
28 Topology
29 Reports and Graphs
29.1 All Timeseries Graphs
29.1.1 Graph Controls
29.1.2 Graph Types
29.1.3 Timeseries Data Aggregation
29.2 Database File I/O and Lock Waits
29.2.1 sys Schema
29.2.2 Database File I/O Graphs and Reports
29.2.3 Lock Waits Report
29.3 Processes Report
29.4 Table Statistics
29.5 User Statistics
29.6 Memory Usage Report
29.7 InnoDB Buffer Pool Usage
29.8 NDB Cluster Memory Usage
30 Customizing MySQL Enterprise Monitor
30.1 Creating Advisors and Rules
30.1.1 Creating Advisors
30.1.2 Overview of Graph Creation
30.1.3 Overview of Advisor Creation
30.1.4 Variables
30.1.5 Thresholds
30.1.6 Using Strings
30.1.7 Wiki Format
30.1.8 Creating a New Advisor: An Example
30.1.9 Creating a New Graph: An Example
30.2 Custom Data Collection
30.2.1 Custom.xml
30.2.2 Queries
30.2.3 Data Collection Attributes
30.3 Event Notification Blackout Periods
30.3.1 Scripting Blackouts
V Using the Query Analyzer
31 Query Analyzer View
31.1 Providing Query Analyzer Data
31.1.1 Using the MySQL Performance Schema
31.2 Query Response Time index (QRTi)
31.3 Query Analyzer User Interface
31.4 Detailed Query Information
31.5 Query Analyzer Configuration View
VI Appendices
A MySQL Enterprise Monitor Component Reference
A.1 MySQL Enterprise Service Manager Reference
A.1.1 MySQL Enterprise Service Manager Log Files
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
2.1 Default Query Analyzer View
2.2 Agents View
2.3 Agent Details View
2.4 Hosts View
2.5 Host Details View
2.6 NDB Clusters View
2.7 NDB Clusters Detail View
2.8 Delete Confirmation for MySQL Instance
13.1 Welcome to MySQL Enterprise Monitor page
13.2 Target Selectors
13.3 Status Summary
14.1 Server Hostname
14.2 Customize MySQL Server Name
14.3 Data Purge Behavior
14.4 My Oracle Support Credentials
14.5 HTTP Proxy Settings
14.6 External Authentication Settings: LDAP
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 Agents View
16.2 Agent Details View
16.3 Hosts View
16.4 Host Details View
16.5 NDB Clusters View
16.6 NDB Clusters View
16.7 Delete Confirmation for MySQL Instance
16.8 Delete Confirmation for MySQL Instance and related Host
17.1 Group Management Page
17.2 Group Assets Tab
18.1 Manage Advisors Page
18.2 Advisor Menu Control
18.3 Advisor Pop-up Menu
18.4 Advisor Filter Controls
18.5 Agent Health - General
18.6 Threshold Definitions Example
20.1 Agent Health - General
20.2 Agent Health - General
20.3 Agent Health - Backlog
20.4 CPU Usage
20.5 CPU Outliers
20.6 Filesystem - General
20.7 Filesystem - Estimated Full Capacity
20.8 Filesystem - Percentage of Space
20.9 Filesystem - Percentage Used in Time Range
20.10 Group Replication Configuration Advisor
20.11 Group Replication Status Advisor
20.12 Group Replication Status Advisor
20.13 Group Replication Status Advisor
21.1 Event Handlers section
21.2 Email Notification Groups section
21.3 Create Group Dialog
21.4 Email Settings section
21.5 SNMP Settings section
21.6 Create Event Handler Dialog
21.7 Event Action Log
21.8 Event Action Log Expanded
22.1 Core Monitored Assets
22.2 Monitoring Services Permissions
23.1 Strict Permission Set Overview
23.2 Strict Permission Set Grouped
24.1 Global Overview
24.2 Global Overview Default Sparklines
24.3 MySQL InnoDB Cluster Default Sparklines
24.4 MySQL Instance Overview Default Sparklines
24.5 Customize Overview Sparkline Graphs
25.1 Events Page with Filter
26.1 Backup Details
27.1 Replication Overview
27.2 Replication Statistics tab
28.1 Replication Topology Graph
28.2 Group Replication Single Group Topology
28.3 Group Replication Multiple Group Topology
28.4 NDB Cluster Topology
28.5 NDB Cluster Topology - Management Node
28.6 NDB Cluster Topology - API Node
28.7 NDB Cluster Topology - Data Node
29.1 Optimizing Graph Data Status
29.2 Database File I/O By File
29.3 Database File I/O By Wait Type Report
29.4 Database File I/O By Wait Type Graphs
29.5 Database File I/O By Thread
29.6 Processes Report
29.7 Table Statistics Report - Table View
29.8 Table Statistics Report - Treemap View
29.9 User Statistics Report - Table View
29.10 User Statistics Report - Tree View
29.11 Memory Usage Report - Table View
29.12 Memory Usage Report - Tree View
29.13 NDB Cluster Memory Usage Report - Table View
29.14 NDB Cluster Memory Usage Report - Tree View
31.1 Default Query Analyzer View
31.2 Normalized Queries and Statistics
31.3 Statement Detail Graphs
31.4 Example Statements Distribution Chart
31.5 Example Statement and Details
31.6 Example EXPLAIN
31.7 Configuration View
31.8 Graph View
31.9 Filter View
31.10 Sort View
31.11 Data View

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 Uninstaller Options
14.1 Server Hostname Controls
14.2 Customize
14.3 External Authentication
14.4 LDAP Authentication
14.5 Active Directory Authentication
15.1 Bad Connection List
15.2 Unreachable Agents
15.3 Unmonitored MySQL Instances
15.4 MySQL Instance Details
15.5 Connection Settings Tab
15.6 Encryption Settings Tab
15.7 Advanced Settings
15.8 MySQL Instance Filter
18.1 Manage Advisors Page Controls
18.2 Advisor Information Listing
18.3 Advisor Edit Menu Controls
18.4 Advisor Filter Controls
20.1 MySQL Process Discovery Advisor Controls
20.2 NDB Cluster Memory Usage Advisor Controls
20.3 NDB Cluster Status Advisor Controls
21.1 Event Handlers Controls
21.2 Email Notification Groups List Controls
21.3 Create Group Controls
21.4 Email Settings Controls
21.5 SNMP Settings Controls
21.6 Create Event Handler Controls
23.1 Manager Role Definition
23.2 DBA Role Definition
23.3 System-Wide Role Definition
23.4 Development Group Role Definition
23.5 Production Group Role Definition
25.1 Events Filter Controls
25.2 Events List Columns
25.3 Event State Icons
27.1 Group Status Columns
29.1 Timeseries Graph Filter
30.1 Formatting with Wiki Markup
30.2 Custom Data Collection Class Elements
30.3 Attribute Elements
31.1 QRTi Value Definitions
31.2 Controls of the default Query Analyzer view
A.1 MySQL Enterprise Service Manager Log File Locations
A.2 Default Location of MIB Files
A.3 Default Location of config.properties File
A.4 Optional config.properties Values