MySQL Enterprise Monitor 4.0.13 Manual

Abstract

This manual documents MySQL Enterprise Monitor version 4.0.13.

For notes detailing the changes in each release, see the MySQL Enterprise Monitor 4.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-09-30 (revision: 8203)


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
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 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.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 Managing Groups of Instances
17 Advisors
17.1 Manage Advisors Page
17.2 Advisor Types
17.3 Advisor Thresholds
17.4 Advisor Schedules
18 Expression-Based Advisor Reference
18.1 Administration Advisors
18.2 Agent Advisors
18.3 Availability Advisors
18.4 NDB Cluster Advisors
18.5 Memory Usage Advisors
18.6 Monitoring and Support Services Advisors
18.7 Operating System Advisors
18.8 Performance Advisors
18.9 Replication Advisors
18.10 Schema Advisors
18.11 Security Advisors
19 GUI-Based Advisor Reference
19.1 Agent Health Advisor
19.2 MySQL Enterprise Backup Health Advisor
19.3 MySQL Process Discovery Advisor
19.4 Duplicate Host Identity
19.5 Duplicate MySQL Server UUID
19.6 sys Schema Install Advisor
19.7 CPU Utilization Advisor
19.8 Filesystem Free Space Advisor
19.9 MySQL Process
19.10 Query Analysis Advisors
19.11 Group Replication Advisors
19.12 Security Advisors
19.13 NDB Cluster GUI Advisors
20 Event Handlers
20.1 Event Handlers
20.1.1 Event Handlers
20.1.2 Event Handlers Page
20.2 Creating Event Handlers
20.2.1 Event Action Log
20.2.2 Suspending an Event Handler
21 Access Control
21.1 Users and Roles
21.2 Permissions
21.3 Monitored Assets Permissions
21.3.1 Server Group & MySQL NDB Cluster
21.3.2 MySQL Instances
21.3.3 MySQL NDB Cluster Permissions
21.4 Monitoring Services
21.5 MySQL Enterprise Monitor
21.6 Default Users and Roles
21.7 Creating Users and Roles
22 Access Control - Best Practices
22.1 Open Permission Sets
22.2 Strict Permission Set
IV Using MySQL Enterprise Monitor
23 Overview
23.1 Overview Sparkline Graphs
23.2 Database Availability
23.3 General Database Statistics
24 Events
24.1 Events
25 Enterprise Backup Dashboard
25.1 Backup Overview
25.2 Backup Details
26 Replication Dashboard
26.1 Replication Overview
26.2 Replication Dashboard Tabs
26.3 Replication Logging
27 Topology
28 Reports and Graphs
28.1 All Timeseries Graphs
28.1.1 Graph Controls
28.1.2 Graph Types
28.1.3 Timeseries Data Aggregation
28.2 Database File I/O and Lock Waits
28.2.1 sys Schema
28.2.2 Database File I/O Graphs and Reports
28.2.3 Lock Waits Report
28.3 Processes Report
28.4 Table Statistics
28.5 User Statistics
28.6 InnoDB Buffer Pool Usage
28.7 NDB Cluster Memory Usage
29 Customizing MySQL Enterprise Monitor
29.1 Creating Advisors and Rules
29.1.1 Creating Advisors
29.1.2 Overview of Graph Creation
29.1.3 Overview of Advisor Creation
29.1.4 Variables
29.1.5 Thresholds
29.1.6 Using Strings
29.1.7 Wiki Format
29.1.8 Creating a New Advisor: An Example
29.1.9 Creating a New Graph: An Example
29.2 Custom Data Collection
29.2.1 Custom.xml
29.2.2 Queries
29.2.3 Data Collection Attributes
29.3 Event Notification Blackout Periods
29.3.1 Scripting Blackouts
V Using the Query Analyzer
30 Using the Query Analyzer
30.1 Providing Query Analyzer Data
30.1.1 Using the MySQL Performance Schema
30.2 Query Response Time index (QRTi)
30.3 Query Analyzer User Interface
30.3.1 Detailed Query Information
30.3.2 Using Graphs to Identify Queries
30.3.3 Filtering Query Analyzer Data
30.3.4 Query Analyzer Settings
30.3.5 Exporting Query Information
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
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 Group Management Page
16.2 Group Assets Tab
17.1 Manage Advisors Page
17.2 Advisor Menu Control
17.3 Advisor Pop-up Menu
17.4 Advisor Filter Controls
17.5 Agent Health - General
17.6 Threshold Definitions Example
19.1 Agent Health - General
19.2 Agent Health - General
19.3 Agent Health - Backlog
19.4 CPU Usage
19.5 CPU Outliers
19.6 Filesystem - General
19.7 Filesystem - Estimated Full Capacity
19.8 Filesystem - Percentage of Space
19.9 Filesystem - Percentage Used in Time Range
19.10 Group Replication Configuration Advisor
19.11 Group Replication Status Advisor
19.12 Group Replication Status Advisor
19.13 Group Replication Status Advisor
20.1 Event Handlers section
20.2 Email Notification Groups section
20.3 Create Group Dialog
20.4 Email Settings section
20.5 SNMP Settings section
20.6 Create Event Handler Dialog
20.7 Event Action Log
20.8 Event Action Log Expanded
21.1 Core Monitored Assets
21.2 Monitoring Services Permissions
22.1 Strict Permission Set Overview
22.2 Strict Permission Set Grouped
23.1 Global Overview
23.2 Global Overview Default Sparklines
23.3 MySQL InnoDB Cluster Default Sparklines
23.4 MySQL Instance Overview Default Sparklines
23.5 Customize Overview Sparkline Graphs
24.1 Events Page with Filter
25.1 Backup Details
26.1 Replication Overview
26.2 Replication Statistics tab
27.1 Replication Topology Graph
27.2 Group Replication Single Group Topology
27.3 Group Replication Multiple Group Topology
27.4 NDB Cluster Topology
27.5 NDB Cluster Topology - Management Node
27.6 NDB Cluster Topology - API Node
27.7 NDB Cluster Topology - Data Node
28.1 Optimizing Graph Data Status
28.2 Database File I/O By File
28.3 Database File I/O By Wait Type Report
28.4 Database File I/O By Wait Type Graphs
28.5 Database File I/O By Thread
28.6 Processes Report
28.7 Table Statistics Report - Table View
28.8 Table Statistics Report - Treemap View
28.9 User Statistics Report - Table View
28.10 User Statistics Report - Tree View
28.11 NDB Cluster Memory Usage Report - Table View
28.12 NDB Cluster Memory Usage Report - Tree View
30.1 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 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
17.1 Manage Advisors Page Controls
17.2 Advisor Information Listing
17.3 Advisor Edit Menu Controls
17.4 Advisor Filter Controls
19.1 MySQL Process Discovery Advisor Controls
19.2 NDB Cluster Memory Usage Advisor Controls
19.3 NDB Cluster Status Advisor Controls
20.1 Event Handlers Controls
20.2 Email Notification Groups List Controls
20.3 Create Group Controls
20.4 Email Settings Controls
20.5 SNMP Settings Controls
20.6 Create Event Handler Controls
22.1 Manager Role Definition
22.2 DBA Role Definition
22.3 System-Wide Role Definition
22.4 Development Group Role Definition
22.5 Production Group Role Definition
24.1 Events Filter Controls
24.2 Events List Columns
24.3 Event State Icons
26.1 Group Status Columns
28.1 Timeseries Graph Filter
29.1 Formatting with Wiki Markup
29.2 Custom Data Collection Class Elements
29.3 Attribute Elements
30.1 QRTi Value Definitions
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