MySQL Enterprise Monitor 8.0.37 Manual

Abstract

This manual documents MySQL Enterprise Monitor version 8.0.37.

End of Life Announcement.  MySQL Enterprise Monitor will be end of life and deprecated with obsolescence as of January 1, 2025. For additional information, see Chapter 1, MySQL Enterprise Monitor: End of Life Notice

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: 2024-03-06 (revision: 8592)


Table of Contents

Preface and Legal Notices
I Getting Started with MySQL Enterprise Monitor
1 MySQL Enterprise Monitor: End of Life Notice
2 MySQL Enterprise Monitor Introduction and Architecture
2.1 MySQL Enterprise Monitor Component Overview
2.2 MySQL Enterprise Monitor Agent
2.3 MySQL Enterprise Service Manager
3 What's New
II Installing MySQL Enterprise Monitor
4 Prerequisites
4.1 Installer Files
4.2 Prerequisites
4.2.1 System Requirements
4.2.2 Supported Platforms
4.2.3 Requirements for Monitoring
4.2.4 MySQL Enterprise Monitor Repository
4.3 Credentials Required for Installation
4.3.1 Existing Users
4.3.2 Users Created During Installation
4.3.3 Users Created on First Log-in
4.4 Supported Browsers
5 Service Manager Installation
5.1 MySQL Enterprise Monitor Installation Types
5.2 MySQL Enterprise Service Manager Graphical Installation Wizard
5.3 Text-Based Installation
5.4 Starting/Stopping MySQL Enterprise Monitor Services
5.5 MySQL Enterprise Service Manager Configuration Settings
6 Monitor Agent Installation
6.1 General Agent Related Notes
6.2 Creating MySQL User Accounts for the Monitor Agent
6.3 Java Considerations on UNIX-like Platforms
6.4 Monitoring Agent Graphical Installation Wizard
6.5 Starting/Stopping MySQL Enterprise Monitor Agent
6.5.1 Starting/Stopping the Agent on Windows
6.5.2 Starting/Stopping the Agent on macOS
6.5.3 Starting/Stopping the Agent on Unix
6.5.4 sql_mode
6.6 Monitoring Multiple MySQL Servers
6.7 Configuring an Agent to Monitor a Remote MySQL Server
6.8 Monitoring Outside the Firewall with an SSH Tunnel
6.9 HTTP Connection Timeout
6.10 Troubleshooting the Agent
6.11 Agent Backlog
7 Upgrading MySQL Enterprise Monitor Installations
7.1 General considerations when upgrading MySQL Enterprise Monitor
7.2 Upgrading MySQL Enterprise Monitor
7.3 Restoring from Backup
8 Post-installation Considerations
8.1 General Considerations
8.2 Installing SSL Certificates
8.3 Backup the Repository
8.4 Changing an SSH Host Key
9 Unattended Installation Reference
9.1 Unattended Installation
9.1.1 Performing an Unattended Installation
9.1.2 MySQL Enterprise Service Manager Options
9.1.3 MySQL Enterprise Monitor Agent Options
10 Performance Tuning MySQL Enterprise Monitor
10.1 Tuning Memory
10.2 Tuning CPU
10.3 Tuning Apache Tomcat Threads
10.4 Tuning Agent Memory Requirements
11 Configuration Utilities
11.1 Service Manager Configuration Utilities
11.2 Agent Configuration Utility
12 Uninstalling MySQL Enterprise Monitor
12.1 Windows Platforms
12.2 macOS Platforms
12.3 Unattended Uninstallations
III Configuring MySQL Enterprise Service Manager
13 Configuring MySQL Enterprise Service Manager
14 User Interface
14.1 Initial Log-In
14.2 Setting the Timezone and Locale
14.3 Menus and Toolbars
14.3.1 Target Selection
14.3.2 Navigation Menus
14.3.3 User Menu
14.3.4 Status Summary
14.3.5 System and User-defined Filters
14.3.6 Configuration Views
15 Global Settings
15.1 Server Locale
15.2 Server Hostname
15.3 Customize MySQL Server Name
15.4 Data Purge Behavior
15.5 HTTP Proxy Settings
15.6 External Authentication
16 Manage Instances
16.1 Manage Instances Controls
16.2 Monitored 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 Asset Management
17.1 Agents View
17.2 Hosts View
17.3 NDB Clusters View
17.4 Deleting Assets
17.5 Deleting Assets from the Command Line
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 Memory Usage Report
30.7 InnoDB Buffer Pool Usage
30.8 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 Query Analyzer View
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.4 Detailed Query Information
32.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