Chapter 15 MySQL Instances Dashboard
Prev |  | Next

## Chapter 15 MySQL Instances Dashboard

The MySQL Instances dashboard presents information on the current connection status of all monitored instances. It also presents information on unsuccessful connections, uncontactable agents, and MySQL instances which are not yet monitored.

The MySQL Instances Dashboard contains the following:

- MySQL Instance Details: this list is displayed by default. It lists all the currently monitored instances. If there is a problem with a connection to one of those instances, it is highlighted in red.

  For more information, see Section 15.2, “MySQL Instance Details”.

- Unreachable Agents: displayed only if a previously contactable agent is no longer contactable.

  For more information, see Unreachable Agents.

- Bad MySQL Connections: displayed if misconfigured connections exist.

  For more information, see Bad Connection Configurations.

- Unmonitored MySQL Instances: lists the number of MySQL instances which are available, but currently unmonitored by MySQL Enterprise Monitor.

  For more information, see Unmonitored MySQL Instances.

## 15.1 MySQL Instance Dashboard UI

This section describes the MySQL Instances Dashboard.

### Alert Buttons

The alert buttons list the number of problematic instances, connections, and agents in your implementation. If a problem exists, they are displayed on the top-right side of the dashboard.

Note

These buttons depend on the permissions defined for the user. If the permission MySQL Instances is set to Read-Only, the buttons are visible, but inactive, and it is not possible to open the associated lists.

- Unmonitored MySQL Instances: lists the number of MySQL instances which are available, but currently unmonitored by MySQL Enterprise Monitor. Click to open the Unmonitored MySQL Instances list. See Unmonitored MySQL Instances for more information.

- Bad MySQL Connections: displays the number of misconfigured connections to MySQL instances. Click to open the Bad Connection Configurations list. See Bad Connection Configurations for more information.

- Unreachable Agents: lists the number of agents which are currently uncontactable. Click to open the Unreachable Agents list. See Unreachable Agents for more information.

### Bad Connection Configurations

This section lists the connection configurations which are unable to establish a connection with the MySQL instance.

Table 15.1 Bad Connection List

Name | Description
--- | ---
Agent Host | Lists the hostname of the monitoring agent.
Connection Details | Lists the IP address defined in the connection string.
Last Error Date | Date and time of the last occurrence of this error.
Error Details | Cause of the error.

If the bad connection results from a misconfiguration, select Edit Connection from the drop-down menu. The connection configuration window is displayed, enabling you to review and edit the connection.

To delete the bad configuration, select Delete Connection from the drop-down menu.

### Unreachable Agents

This section lists the agents which are configured, and were communicating with the Service Manager, but cannot be contacted.

Table 15.2 Unreachable Agents List

Name | Description
--- | ---
Agent | Hostname of the server on which the agent is installed.
State | State of the agent. For example, if the agent is shut down properly, it signals the Service Manager that it is shutting down, and the state is displayed as SHUTDOWN. If the agent did not shutdown properly, if its host shutdown unexpectedly, or due to a network fault, the state displayed is TIMEDOUT.
Last Seen | Time and date at which the agent last contacted the Service Manager.
Version | Agent version.
UUID | The unique identifier of the agent.
Agent Directory | Agent installation directory.

### Unmonitored MySQL Instances

This section lists the running MySQL instances which have been detected but not added to the system. You can monitor, ignore, or cancel these connections if pending.

To begin monitoring one, or more, of the unmonitored instances, select them using the checkboxes and click Monitor Instances. For more information on adding connections, see Section 15.3.1, “Adding a MySQL Instance”.

To ignore instances, make your selection and click Ignore Instances. A checkbox, Display n ignored instances is displayed, where n is the number of instances ignored. To undo the ignore, and display the instance, check the Display n ignored instances checkbox, select the instance and click Show Instance.

If no unmonitored instances are present, the ignored instances are listed instead.

Important

If an ignored instance is uninstalled, the ignored instance is removed from the list of unmonitored instances.

To cancel a pending connection, select the pending connection and click Cancel Pending Connections.

Table 15.3 Unmonitored MySQL Instances List

Name | Description
--- | ---
Host | The server on which the running MySQL instance was discovered.
Connecting | Whether a connection is being attempted with the instance.
Port/Socket | Port or socket on which the MySQL instance is listening.
Process ID | The process ID of the running instance.
Process User: Group | ID of the user and group.
Process Arguments | The arguments with which the instance was started.

## 15.2 MySQL Instance Details

The MySQL Instance Details section lists all the instances currently monitored by this installation and enables you to delete and edit instance configuration.

### Editing Instances

To edit an instance, do the following:

- Select an instance by selecting the checkbox on the left of the instance name.

- Click Edit Instances. The Edit Instances dialog is displayed.

  The Edit Instances window is identical to the Add Instance Connection window described in Section 15.3.1, “Adding a MySQL Instance”, with the exception of the first tab, Instance Details.

When editing an individual instance, the Instance Details tab enables you to edit the instance Display Name and add notes on the instance. For example, if the instance name is MySQLServer001, and ThisIsMyServer is added in the Display Name field, ThisIsMyServer is displayed in the MySQL Instance Details list, and everywhere else the instance name is used.

If you add a note, a note icon is displayed in the Notes column for that instance.

### Deleting Instances

To delete an instance, or multiple instances, select the instance(s) and click Delete Instances, or select Delete Instance from the instance-specific drop-down menu.

### Columns

The following columns are available:

Table 15.4 MySQL Instance Details Columns

Name | Description
--- | ---
Instance | The instance names, in their assigned Groups. If no groups are defined, all MySQL instances are contained by the All group. The checkbox enables you to select all instances.
Notes | Displays a note icon, if a note was defined on the Instance Details tab. If a note was defined, hover the cursor over the note icon. The note is displayed as a tooltip.
Versions: MySQL | Displays the version of the monitored MySQL instance.
Versions: Agent | Displays the version of the monitoring agent.
Versions: Operating System | Displays the type and version of operating system on which the MySQL instance is installed.
Port | Displays the configured MySQL port.
Data Dir | Displays the configured data directory of the MySQL installation.

### Group and Instance Context Menu

Note

The menu items listed in this section depend on the permissions defined. If you do not have the required permissions, some or all of these menu items may be inactive.

The group-level context menu contains the following:

- Support Diagnostics: Opens the Support Diagnostics page. This enables you to generate a set of reports which you can send to MySQL Support as an attachment to a reported issue. This report can take several minutes to generate. The reports archive also includes a SQL dump of the Advisor Schedules, Inventory and Configuration schemas.

The instance-level menu contains the following:

- Edit Instance: opens the Edit Instance dialog.

- Delete Instance: deletes the instance from the MySQL Enterprise Service Manager.

  Important

  It is not possible to delete the MySQL Enterprise Monitor repository from the list. If you delete it, it is automatically restored to the list.

- Refresh Inventory: forces an inventory of the selected instance.

- Support Diagnostics: opens the Support Diagnostics dialog. This enables you to generate a set of reports which you can send to MySQL Support as an attachment to a reported issue. This report can take several minutes to generate. The reports archive also includes a SQL dump of the Advisor Schedules, Inventory and Configuration schemas.

  Important

  The Configuration schema may contain login credentials. However, these credentials are encrypted using keys which are not stored in the repository and are not included in the Support Diagnostics report.

  Important

  Generating a diagnostic report is an expensive operation, the Diagnostics Report report is cached for six hours. All requests within this six hour time period will pull (download) this cached report. A request after this period triggers generation of a new report.

- Enable Event Handler Blackout: stops all Event Handlers associated with the selected instance. Events continue to be generated and advisors continue evaluating the data collected by the agent monitoring the selected host, but all event handlers are suspended for the selected instance.

## 15.3 Adding Instances

This section describes how to add MySQL Instances to MySQL Enterprise Monitor. The following topics are described:

- Section 15.3.1, “Adding a MySQL Instance”

- Section 15.3.2, “Adding Multiple MySQL Instances”

Note

These buttons depend on the permissions defined for the user. If the permission MySQL Instances is set to Read-Only, the buttons are visible, but inactive, and it is not possible to add instances.

To add instances, the permission MySQL Instances must be set to Administer.

See Chapter 23, Access Control for more information.

### 15.3.1 Adding a MySQL Instance

This section describes how to monitor a MySQL instance.

#### Connection Settings

The Connection Settings tab

Figure 15.1 Add Instance Connection Settings

Table 15.5 Connection Settings Tab

Name | Description
--- | ---
Monitor From | Select an Agent from the list of Agents to monitor this MySQL database Instance. It is recommend installing one Agent per Host and using that Agent to monitor all its MySQL Instances. Set up the Agent as a local connection by specifying TCP/IP and an Instance Address of 127.0.0.1, or use a socket file. If there is no local Agent on the Host and you are unable to install one, use the built-in or another Agent to monitor remotely. Note If the instance is monitored remotely, it is not possible to retrieve any information on the host. To monitor a host, an agent must be installed on that host.
Connect Using | Select TCP/IP or a socket to connect to the instance. Socket connections can only be used for an Agent that is installed on the same machine as the target instance, and do not work with instances running on Windows.
Instance Address and Port | The IP address, or valid hostname, and port number the instance is listening on. If the host/agent chosen is local to this instance, you should use 127.0.0.1 here.
Admin User and Password | The root user, or user with the privileges defined in Creating the Admin User and the password.
Auto-Create Less Privileged Users | Choose Yes to create the General and Limited users on the MySQL instance. You must add a user name and password for both. For more information on these users, see Section 5.2, “Creating MySQL User Accounts for the Monitor Agent”. Choose No if you intend to use the Admin user for all data collection. Note It is strongly recommend to use the General and Limited user.
General User and Password | Add a user name and password for the General User.
Limited User and Password | Add a user name and password for the Limited User.

#### Encryption Settings

Figure 15.2 Add Instance Encryption Settings

Table 15.6 Encryption Settings Tab

Name | Description
--- | ---
Require Encryption | Defines whether the connection uses TLS for security.
Allow Self-Signed Certificates | Specifies whether the connection permits self-signed certificates.
CA Certificate | Paste the CA certificate's contents here. Note This is not required if you are using a self-signed certificate.

#### Advanced Settings

Figure 15.3 Add Instance Advanced Settings

Table 15.7 Advanced Settings

Name | Description
--- | ---
Discover Replication Topologies | Specifies whether the agent attempts to discover if the instance is part of a replication group and discover the other members of that replication group. When performing replication topology discovery, the agent attempts to read the slave's master.info, and use the stored credentials to log in to the master to read its inventory table and retrieve the master's UUID. If set to No, no replication discovery is attempted.
MySQL Identity Source | Choose the mechanism used to generate a unique identity for the MySQL instance if one does not already exist. Default: uses either the `server_uuid` variable if present, or generates a random new UUID Host Plus Datadir generates a hash of the host identity and the path to the MySQL instances data directory to create a unique identity. Note Host Plus Datadir can be used only if the agent is running on the same host as the MySQL instance for this connection.
Inventory Table Schema | When the Agent connects to the MySQL Instance, it creates an inventory table, if one does not already exist, and stores two rows within it: a generated Instance UUID, and the host ID. By default this is created within the `mysql` database. On shared hosts or cloud environments this may not be accessible to the Agent user; provide a database name to override where the inventory table is created.
Connection Timeout | Connection timeout, in milliseconds, used by the JDBC driver.
Socket Timeout | Socket timeout, in milliseconds, used by the JDBC driver.

#### Group Settings

Enter the groups to which you want to add the instance. It is also possible to define new groups in this field.

Note

To add groups, you must have the Server Group permission set to Read-Only, at least.

To create new groups, you must have the New Group Creation permission set to Administer.

### 15.3.2 Adding Multiple MySQL Instances

The Add Bulk MySQL Instances tabs are identical to those used to add a single instance, with the exception of the Instance Address field, which is replaced by the Connection Endpoints field in the bulk version. To add multiple MySQL instances, add the comma-separated list of MySQL addresses to the Connection Endpoints field in the format of `Hostname:PortNumber`.

To add the instances successfully, you must ensure the user credentials, encryption settings, and so on, are identical across all instances added.

## 15.4 Filtering MySQL Instances

To search for specific instances, click the filter icon. The MySQL Instance Details filter is displayed.

Figure 15.4 MySQL Instance Filter

Table 15.8 MySQL Instance Filter

Name | Description
--- | ---
Server Name | Search on full or partial name of the server.
Server UUID | Search on the UUID of the server.
Server ID | Search on the `server_id`.
Query Analyzer | Search for servers on which the Query Analyzer is enabled, or not.
MySQL Version | Search for specific MySQL version numbers.
Agent Version | Search for specific MySQL Enterprise Monitor Agent version numbers.
Operating System | Search on the Operating Systems on which the server is installed.

The Agent Version and MySQL Version fields support the use of range operators (>, < =), enabling you to define ranges of versions to filter on. For example, setting MySQL Version to `<=5.1` returns all MySQL instances older than MySQL 5.1.

Note

Filtering on MySQL or Agent version uses a regular expression which does not support the use of partial version numbers, such as "5.". 5 or 5.6 return a result, if such versions are in use, but a partial version returns an error.

Prev | Up | Next
Chapter 14 Overview | Home | Chapter 16 Managing Groups of Instances