The MySQL Enterprise user: These are the credentials you use to log in to the MySQL Enterprise web site. You will need them in order to acquire the Advisor files and receive updates and, if necessary, acquire a product key.

The MySQL user: For Monitor Agents to report the status of a MySQL server they must have privileges on that server. To perform all functions an agent must have SHOW DATABASES, REPLICATION CLIENT, SUPER, CREATE, and SELECT privileges. In short, the Monitor Agent needs to have read access to all data. Details about this account are given in Section 5.3.1, “Creating a MySQL User Account for the Monitor Agent”.

The Repository user: This user is the only user in the user table in the mysql database in the bundled MySQL server. To avoid confusion with monitored MySQL servers, this server is referred to throughout this document as the repository. The repository user can log in from localhost using the password specified during installation and has all privileges on all databases. These credentials are used to create the repository and its tables and to record data in them. During installation the default value for the user name for this role is service_manager. No default password is specified. You can use these credentials to manage the repository from the command line or when using a program such as MySQL Administrator.

During installation the file configuration_report.txt is created. Reference this file for the credentials of the repository manager. After the MySQL Enterprise Service Manager is installed, look for this file in the following directories:

The Root user: This user is the administrator of the dashboard. The first time you log in to the dashboard you must log in as this user. The default user name for this user is admin. There is no default password for this user.

The Agent user: The Monitor Agent needs to report the status of the MySQL server it is monitoring. For this reason it needs to log in to the dashboard. The default user name for this user is agent. There is no default password for this user.

All installations of the Service Manager install the Tomcat and MySQL applications using the same basic set of parameters. The defaults provided by the installation process are designed to be unique so that they do not interfere with existing installations of either product. However, you should check these parameters before installation to ensure that you do not experience any problems.

The common parameters are divided into those applying to the location of the MySQL server, the Tomcat server, and the connection properties for the MySQL server (Repository Configuration):

The information that you configure during installation is recorded within the configuration_report.txt file within the installation directory for the Service Manager.

On Windows, the installation modes are win32 and unattended only. unattended mode is especially useful if you are doing multiple installations. For more information on this topic see Section 5.4, “Unattended Installation”.

To install the Service Manager on Windows, find the executable file named mysqlmonitor-version-windows-installer.exe (where version represents the three-part version number).

For instructions on starting the MySQL Enterprise Monitor services under Windows, see Section 5.2.5, “Starting/Stopping the MySQL Enterprise Monitor Service on Windows”.

On Mac OS X there are three installation modes osx, text, and unattended. For more information on this topic see Section 5.4, “Unattended Installation”. The text mode installation for Mac OS X is identical to text installation under Unix. For text mode installation instructions see Section 5.2.4, “Service Manager Installation on Unix”.

Installing the MySQL Enterprise Service Manager on Mac OS X requires an existing installation of Java. The minimum required version is 1.5.0_7. If this version is not installed on your machine you can download it from Apple. This version of Java requires Mac OS X version 10.4.5 as a minimum, so you may need to upgrade your operating system in order to install it.

For reasons of backwards compatibility, Mac OS X is usually installed with multiple versions of Java. When installing in osx mode, version 1.5.0_7 must be the default version. Upon installation, Java 1.5.0_7 sets itself as the default so this is usually not a problem.

If you have changed the default you can reset it or you may install the MySQL Enterprise Service Manager in text mode, setting the environment variables to point to the correct version of Java. To install in text mode, find the installbuilder file in the Contents/MacOS directory immediately below the mysqlmonitor-version-osx-installer.app directory. Installing the MySQL Enterprise Service Manager in text mode is identical to the procedure described in Section 5.2.4, “Service Manager Installation on Unix” with the minor differences noted above.

To install using the GUI (osx) installation, follow these instructions:

Your installation is now complete. To continue with the configuration of MySQL Enterprise Service Manager, see Section 5.2.7, “MySQL Enterprise Service Manager Configuration Settings and Advisor Installation”.

To install the Service Manager find the file named mysqlmonitor-version-installer.bin (where version indicates the version number, the OS, and the architecture ). Ensure that this file is executable by typing:

shell> chmod +x mysqlmonitor-version-installer.bin

To install to the default directory (/opt/mysql/enterprise/monitor), login as root. An unprivileged user installs to the /home/user_name/mysql/enterprise/monitor/ directory.

What follows describes installation from the command line. You can install the Service Manager graphically by running the installer from within a windows manager. In both cases, the steps are identical. You can also install the Service Manager in unattended mode. This is especially useful if you are doing multiple installations. For more information on this topic, see Section 5.4, “Unattended Installation”.

The Enterprise Dashboard does not start up automatically if you perform a text mode installation. For more information on starting and stopping MySQL Enterprise Service Manager, see Section 5.2.6, “Starting/Stopping the MySQL Enterprise Monitor Service on Unix and Mac OS X”.

You can choose to start up the MySQL Enterprise Service Manager on installation. The installed services are called:

You can stop or start the services from the Microsoft Management Console Services window. Look for the MySQL Enterprise Tomcat and the MySQL Enterprise MySQL entries.

To start or stop a service, right-click it and choose from the options in the pop-up menu.

There is also a menu entry for starting and stopping the services. Navigate to the Program, MySQL, MySQL Enterprise Monitor, Services entry to stop or start the services.

You can also stop or start a service from the command line. To start the Tomcat service type:

shell> sc start MySQLEnterpriseTomcat

or:

shell> net start MySQLEnterpriseTomcat

To stop this service type:

shell> sc stop MySQLEnterpriseTomcat

or:

shell> net stop MySQLEnterpriseTomcat

In similar fashion, you may stop or start the MySQL server from the command line. The service name is MySQLEnterpriseMySQL.

You may also start, stop, and restart a specific service or both services using the mysqlmonitorctl.bat file. To execute this file, go to the command line and navigate to the C:\Program Files\MySQL\Enterprise\Monitor directory. Typing mysqlmonitorctl.bat help produces the following output:

usage: mysqlmonitorctl.bat help
       mysqlmonitorctl.bat (start|stop|restart|install|uninstall)
       mysqlmonitorctl.bat (start|stop|restart) tomcat
       mysqlmonitorctl.bat (start|stop|restart) mysql

help       - this screen
start      - start the service(s)
stop       - stop the service(s)
restart    - restart or start the service(s)
install    - install the service(s)
uninstall  - uninstall the service(s)

To stop a specific service, pass the argument tomcat or mysql in addition to the status change argument. If you wish to change the status of both services, do not specify a service name. You may also uninstall the services using this batch file.

Configuration of the dashboard begins immediately after the Service Manager is installed. To continue a Windows installation skip the next section and go to Section 5.2.7, “MySQL Enterprise Service Manager Configuration Settings and Advisor Installation”.

The services incorporated into the MySQL Enterprise Service Manager are:

Should you need to stop, start, or restart the MySQL Enterprise Service Manager call the mysqlmonitorctl.sh file located in the /opt/mysql/enterprise/monitor/ directory on Unix or the /Applications/mysql/enterprise/monitor/ on Mac OS X. To see all the available options navigate to the appropriate directory and type:

shell> /opt/mysql/enterprise/monitor/mysqlmonitorctl.sh help

Executing this script produces the following output:

usage: ./mysqlmonitorctl.sh help
./mysqlmonitorctl.sh (start|stop|status|restart)
./mysqlmonitorctl.sh (start|stop|status|restart) mysql
./mysqlmonitorctl.sh (start|stop|status|restart) tomcat

help       - this screen
start      - start the service(s)
stop       - stop  the service(s)
restart    - restart or start the service(s)
status     - report the status of the service

Using this script you can stop, start, or restart all the Service Manager components. To do this make a call to mysqlmonitorctl.sh start from your start-up script.

To start the service:

shell> ./mysqlmonitorctl.sh start
./mysqlmonitorctl.sh : mysql  started
nohup: redirecting stderr to stdout
Starting mysqld daemon with databases from /opt/mysql/enterprise/monitor/mysql/data/
Using CATALINA_BASE:   /opt/mysql/enterprise/monitor/apache-tomcat
Using CATALINA_HOME:   /opt/mysql/enterprise/monitor/apache-tomcat
Using CATALINA_TMPDIR: /opt/mysql/enterprise/monitor/apache-tomcat/temp
Using JRE_HOME:       /opt/mysql/enterprise/monitor/java

If you try to start the service and it is already running, you are warned that the services are already running:

shell> ./mysqlmonitorctl.sh start
./mysqlmonitorctl.sh : mysql  (pid 18403) already running
./mysqlmonitorctl.sh : tomcat  (pid 18480) already running

To stop the service:

shell> ./mysqlmonitorctl.sh stop
Using CATALINA_BASE:   /Applications/mysql/enterprise/monitor/apache-tomcat
Using CATALINA_HOME:   /Applications/mysql/enterprise/monitor/apache-tomcat
Using CATALINA_TMPDIR: /Applications/mysql/enterprise/monitor/apache-tomcat/temp
Using JRE_HOME:       /System/Library/Frameworks/JavaVM.framework/Versions/1.5.0/Home
Stopping tomcat service .. [ OK ]
STOPPING server from pid file /Applications/mysql/enterprise/monitor/mysql/data/mysqld.pid
090209 15:37:09  mysqld ended

The restart command is equivalent to executing a stop and then start operation.

This script can also be used to check the status of the Tomcat web server or the MySQL repository.

shell> ./mysqlmonitorctl.sh status
MySQL Network MySQL is running
MySQL Network Tomcat is running

Configuration of the dashboard begins immediately after the MySQL Enterprise Service Manager is installed.

The Enterprise Dashboard is the web-based interface to the Service Manager so the procedure for starting the dashboard is identical for all platforms. From the dashboard you can configure the settings necessary for receiving updates from MySQL Enterprise and for the initial installation of the Advisors.

If you installed the Service Manager using a graphical interface, you have the option of launching the dashboard on the final installation screen (as long as the Launch MySQL Enterprise Monitor Now checkbox is checked).

Otherwise, you can view the dashboard by typing http://localhost:18080/Auth.action into the address bar of your web browser. If you are unsure of the host name and port to use, check the configuration_report.txt file.

Under Windows it is also possible to open the dashboard by choosing the MySQL menu item and finding the MySQL Enterprise Monitor entry. Under this entry choose Start Service Manager.

5.2.7.1. Initial Dashboard Log-In

If this is the first time that you have attempted to log in to the dashboard you should see a screen similar to the following:

Figure 5.10. MySQL Enterprise Monitor: Initial Dashboard Log-In

Use this screen to perform the following tasks:

• Install the Advisors

• Set up your MySQL Enterprise credentials

• Create a user name and password for the dashboard administrator

• Create a user name and password for the Monitor Agent

If you have been provided with a MySQL Enterprise Product Key and an Advisors file click the Browse button and locate these files. The advisor file is named, AdvisorScript-version.jar and the product key, Subscription-level_date.xml. If you do not allow Internet access from the dashboard you must install the advisors in this way. It is strongly recommended that you install the Advisors at this point, but you may do so later. For instructions on doing this see, Section 5.2.7.3, “Installing, Updating or Upgrading Advisors After Initial Login”. If the product key that you provide is invalid, a notification appears and you cannot import the advisors.

Note

If you are activating the MySQL Enterprise Monitor using a product key, do not enter your MySQL credentials; entering both produces an error message.

If you have Internet access from the dashboard, activate MySQL Enterprise Monitor by supplying your MySQL Enterprise credentials. Enter your email address as the MySQL Enterprise Login and enter and confirm your MySQL Enterprise password. If you specify incorrect credentials, you receive the error message, “Unable to connect to verify credentials.”

In the Create Administrator section of this screen, enter credentials for the dashboard administrator. This creates the root user described in Section 5.1.3, “Users Created on First Log-in”. Record the user name and password as these credentials are required for any future login.

In the Configure Agent Credentials section of this screen enter the credentials for the agent. This is the agent user also described in Section 5.1.3, “Users Created on First Log-in”. The agent must log in to report its findings. Record the agent's credentials; this information is required when installing the agent.

When all the settings have been specified, click the complete setup button. If you log in successfully, you should see a message displaying the number of graphs and advisors that have been imported. This number varies depending upon your subscription level.

If importation of the advisor files fails, you see the message:

Unable to import Advisor Jar. You may download the jar
manually from the Enterprise Portal and import it from the 'Check For Updates' page.

In this case you may download the advisor file from the Enterprise website and install it as described in Section 5.2.7.3, “Installing, Updating or Upgrading Advisors After Initial Login”.

The MySQL Enterprise Agent requires a user configured within each MySQL instance that is being monitored with suitable privileges to collect information about the server, including variable names, replication, and storage engine status information. The agent installer can create a suitable user for you during installation if you supply the installer with a user/password for a user with suitable credentials (such as the root user). The account information is used only during the installation to perform the user creation. If you want to use this option, you can skip this section.

If you do not supply the root user information to the installer, you can create a user manually within your MySQL server and provide these credentials as the agent user/password combination during installation. The privileges required for this user account vary depending on the information you gather using the MySQL Enterprise Agent. The following privileges allow the Monitor Agent to perform its assigned duties without limitation:

For example, the following GRANT statement gives the agent the required SELECT, REPLICATION CLIENT, SHOW DATABASES and SUPER rights:

GRANT SELECT, REPLICATION CLIENT, SHOW DATABASES, SUPER, PROCESS
  ON *.*
  TO  'mysqluser'@'localhost'
  IDENTIFIED BY 'agent_password';

For security reasons, you might limit the CREATE and INSERT privileges to the agent so that it can only create tables within the mysql database:

GRANT CREATE, INSERT
  ON mysql.*
  TO  'mysqluser'@'localhost'
  IDENTIFIED BY 'agent_password';

To enable replication discovery to work, grant the SELECT privilege on the mysql.inventory table for each user with replication privileges on the corresponding replication master. This is required to let the MySQL Enterprise Agent read the replication master UUID. For example:

GRANT SELECT
  ON mysql.inventory
  TO  'replicationuser'@'%'
  IDENTIFIED BY 'replication_password';

If the agent is unable to access the information from the table, a warning containing this information is written to the agent log.

In a typical configuration, the agent runs on the same machine as the MySQL server it is monitoring, so the host name is localhost. However, this changes if the agent is running on a machine other than the one that hosts the monitored MySQL server. In this case, change localhost to the appropriate value. For more information about remote monitoring see Section 5.3.7, “Configuring an Agent to Monitor a Remote MySQL Server”.

To install the MySQL Enterprise Agent on Windows, double-click the mysqlmonitoragent-version-windows-installer.exe (where version indicates the three-part version number) installer.

You may also install the Monitor Agent in unattended mode. This is especially useful if you are doing multiple installations. For more information on this topic see, Section 5.4, “Unattended Installation”.

Once the Monitor Agent is installed, it needs to be started. For information on how to start and stop the Agent, see Section 5.3.5.1, “Starting/Stopping the Agent on Windows”.

To install the MySQL Enterprise Agent on Mac OS X, decompress the mysqlmonitoragent-version-installer.app.zip and then run the mysqlenterpriseagent-version-installer application.

Once the Monitor Agent is installed, it needs to be started. For information on how to start and stop the Agent, see Section 5.3.5.2, “Starting/Stopping the Agent on Mac OS X”.

As a prerequisite for installing the MySQL Enterprise Agent on Linux systems you must have the Linux Standards Base (LSB) initialization functions installed.

shell> rpm -qa | grep -i lsb
redhat-lsb-3.1-19.fc8.x86_64

shell> dpkg -l|grep -i lsb
ii  lsb-base                                   3.2-20ubuntu4                     
    Linux Standard Base 3.2 init script function
ii  lsb-release                                3.2-20ubuntu4
    Linux Standard Base version reporting utilit

To install the agent navigate to the directory that contains the file, mysqlmonitoragent-version-installer.bin (where version indicates the three-part version number, the OS, and the architecture). Ensure that this file is executable by typing:

shell> chmod +x mysqlmonitoragent-version-installer.bin

To install to the default directory (/opt/mysql/enterprise/agent) you need to be logged in as root. Installing as an unprivileged user installs to the /home/user_name/mysql/enterprise/agent directory.

What follows describes installation from the command line. You may install the Monitor Agent graphically by running the installer from within a windows manager. In both cases the steps are identical. You may also install the Monitor Agent in unattended mode. This is especially useful if you are doing multiple installations. For more information on this topic see Section 5.4, “Unattended Installation”.

Begin installation from the command line by typing:

shell> ./mysqlmonitoragent-version-installer.bin --mode text

The various options are shown in what follows. Default values are indicated by square brackets; to select them press Enter. Otherwise enter a value of your choosing.

For information on starting the agent, see Section 5.3.5.3, “Starting/Stopping the Agent on Unix”.

The MySQL Enterprise Agent can be started and stopped at any time. When not running, information about the current status of your server is not available, and MySQL Enterprise Service Manager provides a warning if an agent and the MySQL server that it monitors is unavailable.

shell> sc start MySQLEnterpriseMonitorAgent

shell> net start MySQLEnterpriseMonitorAgent

shell> sc stop MySQLEnterpriseMonitorAgent

shell> net stop MySQLEnterpriseMonitorAgent

shell> ./mysql-monitor-agent start

shell> ./mysql-monitor-agent stop

shell> kill -TERM PID

shell> ./mysql-monitor-agent status

shell> tail /Applications/mysql/enterprise/agent/log/mysql-monitor-agent.log

Usage: ./mysql-monitor-agent {start|stop|restart|status} [ini-file-name]

shell> ./mysql-monitor-agent start /Applications/mysql/enterprise/agent/etc/new-mysql-monitor-agent.ini

shell> /opt/mysql/enterprise/agent/etc/init.d/mysql-monitor-agent start

shell> /home/<user name>/mysql/enterprise/agent/etc/init.d/mysql-monitor-agent start

shell> ./mysql-monitor-agent stop

shell> kill -TERM PID

shell> ./mysql-monitor-agent status

shell> tail /opt/mysql/enterprise/agent/log/mysql-monitor-agent.log

Usage: ./mysql-monitor-agent {start|stop|restart|status} [ini-file-name]

shell> ./mysql-monitor-agent start /opt/mysql/enterprise/agent/etc/new-mysql-monitor-agent.ini

You can monitor multiple MySQL servers (either on the same machine, or across different machines) using two different methods:

Using a Single Agent Instance

To use a single agent to monitor multiple instances, you can create additional directories and configuration files within the instances directory for the agent. For example, you can see the default structure of the agent configuration directory:

./init.d
./init.d/mysql-monitor-agent
./instances
./instances/agent
./instances/agent/agent-instance.ini
./mysql-monitor-agent.ini

Within the instances directory, you can add further directories, one for each monitored server. Each additional directory must have a suitable agent-instance.ini file containing the connection information for the new MySQL server instance. For example, the following structure demonstrates an agent monitoring four MySQL servers:

./init.d
./init.d/mysql-monitor-agent
./instances
./instances/agent
./instances/agent/agent-instance.ini
./instances/mysql2
./instances/mysql2/agent-instance.ini
./instances/mysql-rep
./instances/mysql-rep/agent-instance.ini
./instances/mysql-backup
./instances/mysql-backup/agent-instance.ini
./mysql-monitor-agent.ini

To add another MySQL monitored server, follow these steps:

Using Multiple Agent Instances

To use multiple agents to monitor multiple MySQL servers you need to create a new configuration structure for both the agent and the MySQL server instances you need to monitor, including the binaries and configuration files, and then update the configuration to set the corresponding parameters to monitor the new server. Using this method lets you enable query analysis by redirecting requests to the target server using the built-in proxy service within the agent.

For example, the directory structure below shows the configuration directory for two agents monitoring a single MySQL server each:

./init.d
./init.d/mysql-monitor-agent
./instances
./instances/agent
./instances/agent/agent-instance.ini
./instances-second/agent
./instances-second/agent/agent-instance.ini
./mysql-monitor-agent.ini
./mysql-second-agent.ini

The mysql-monitor-agent.ini file contains the configuration for the first agent, with the MySQL servers monitored defined within the instances directory. The mysql-second-agent.ini file contains the configuration information for the second agent, with the MySQL servers monitor defined within the instances-second directory.

To set up multiple agents:

Typically, the agent runs on the same machine as the MySQL server it is monitoring. Fortunately, this is not a requirement. If you want to monitor a MySQL server running on an operating system for which there is no agent available, you can install the agent on a machine other than the one hosting the MySQL server.

The process for installing an agent to monitor a MySQL server on a remote machine is identical to the process described in Section 5.3, “Monitor Agent Installation”. Follow the directions given there, being careful to specify the correct IP address or host name for the MySQL Enterprise Service Manager and likewise for the MySQL server—since the agent is not running on the same machine as the MySQL server, it cannot be the default, localhost.

Don't forget that the agent must be given rights to log in to the MySQL server from a host other than localhost and that the port used by the MySQL server, typically 3306 must be open for remote access. For more information about the database credentials required by agents see, Section 5.3.1, “Creating a MySQL User Account for the Monitor Agent”.

The agent also needs to be able to log in to the MySQL Enterprise Service Manager, typically using port 18080, so ensure that the appropriate port is open.

If you run an SSH server on the machine that hosts the MySQL Enterprise Service Manager and an SSH client on the machine that hosts the agent, you can create an SSH tunnel so that the agent can bypass your firewall. First, you need to make an adjustment to the hostname value specified in the [mysql-proxy] section of the .ini file. (For more information about the contents and location of the .ini file see Section C.2.1, “MySQL Enterprise Agent Configurable Options”.) Stop the agent and change the hostname value as shown in the following:

hostname = http://agent_name:password@localhost:18080/heartbeat

Replace the agent_name and password with suitable values. Likewise replace port 18080 if you are not running the dashboard on this port. Use localhost for the host name, since the agent is connecting through an SSH tunnel.

Next, execute the following command on the machine where the agent is running:

shell> ssh -L 18080:Dashboard_Host:18080 -l user_name -N Dashboard_Host

When prompted, enter the password for user_name.

If you are not running the MySQL Enterprise Service Manager on port 18080, substitute the appropriate port number. Likewise, replace Dashboard_Host with the correct value. user_name represents a valid operating system user on the machine that hosts the MySQL Enterprise Service Manager.

Be sure to restart the agent so that the new value for the hostname takes effect. For instructions on restarting the agent see:

For MySQL Enterprise Monitor to operate correctly, each agent must have a unique UUID in order to uniquely identify the agent with the MySQL Enterprise Service Manager.

Go to the Agent installation directory and enter the following command:

shell> bin/mysql-proxy --plugins=agent --agent-generate-uuid

This should display a line similar to the following:

ee9296d7-f7cd-4fee-8b26-ead884ebf398

Paste this line into the [mysql-proxy] section of the mysql-monitor-agent.ini file for the agent-uuid parameter:

[mysql-proxy]
...
agent-uuid=ee9296d7-f7cd-4fee-8b26-ead884ebf398

In Windows, go to the command line and change to the MySQL Enterprise Agent installation directory and update the UUID by executing:

C:\> cd C:\Program Files\MySQL\Enterprise\Agent
C:\> mysql-monitor-agent -uf mysql-monitor-agent.ini 

This updates the configuration file directly with the new UUID.

The first step in troubleshooting the agent is finding out whether it is running or not. To do this see:

Some additional tips are noted below:

The basic process for performing an unattended installation is the same for both the MySQL Enterprise Agent and MySQL Enterprise Service Manager installers, with the only difference being the options supported by each installer. For information on the options for MySQL Enterprise Service Manager, see Section 5.4.2, “MySQL Enterprise Service Manager Options”; for information on the options for MySQL Enterprise Agent, see Section 5.4.3, “MySQL Enterprise Agent Options”.

There are two methods for installation, you can either specify the option on the command line, or use an options file that details the options and their values that you want to be used during installation.

For example, using the command-line method you could install the MySQL Enterprise Agent using:

shell> mysqlmonitoragent-version-linux-glibc2.3-x86-64bit-installer.bin
   --installdir /data0/mysql/agent
   --mysqlhost 127.0.0.1 --mysqlport 3306 --mysqluser agent --mysqlpassword mysql --checkmysqlhost yes
   --managerhost localhost --managerport 48080 --agentuser AGENTUSER --agentpassword PASSWORD
   --proxyport 44044 --mode unattended --enableproxy 1
   --createaccount 1 --rootuser ROOTUSER --rootpassword PASSWORD

For unattended installation using an option file, you must create a text file that contains the definition for the installation. For this example, the file will be named options.server.txt. An example of the options configuration file is shown below:

debugtrace=/opt/mysql/enterprise/install.debugtrace.monitor.log
mode=unattended
installdir=/opt/mysql/enterprise/monitor
tomcatport=8080
tomcatshutdownport=8005
tomcatsslport=8443
adminpassword=myadminpassword
dbport=3300

This file identifies a directory and file name for a log file, sets the mode to unattended, and uses the installdir option to specify an installation directory.

Ensure that the monitor installer file and the options file are in the same directory, you can start the unattended installation from the command line.

On Windows within a command shell:

C:\> mysqlmonitor-version-windows-installer.bin --optionfile options.server.txt

On Unix you would use a command-line of the form:

shell> mysqlmonitor-version-installer.bin --optionfile options.server.txt

On Mac OS X, you must locate the installerbuilder.sh within the installation package directory. For example:

shell> ./mysqlmonitoragent-version-osx-installer.app/Contents/MacOS/installbuilder.sh --optionfile options.server.txt

When installing MySQL Enterprise Agent, the same basic process can be followed using the MySQL Enterprise Agent installer and the corresponding agent options.

As a minimum for the MySQL Enterprise Agent installation, you must specify the mode (if not specified at the command line), mysqluser, installdir, mysqlpassword, and agentpassword options. Create a file containing these values and use it with the optionfile option for unattended agent installation.

The options for the installation for MySQL Enterprise Service Manager are detailed below. The MySQL Enterprise Service Manager supports using a bundled MySQL server, or a separate MySQL server provided by the user. If you are using your own MySQL server, the server must be installed and running before installation. For more information, see Section 5.2.1, “Service Manager Installation Common Parameters”.

To view all the options available for an unattended agent installation, invoke the agent installer file passing in the help option. The available options are detailed in the table below.

From time to time there may be updates to the MySQL Enterprise Service Manager or the MySQL Enterprise Agent. This section describes how to perform an update for either of these components.

You cannot use the update installers to change to a different operating system or chip architecture. For example, you cannot update a 32-bit Linux installation to a 64-bit version using an update installer—in cases such as this you must do a fresh installation.

You also cannot use the upgrader if you have configured the MySQL server for the MySQL Enterprise Service Manager instance to be located away from the rest of the MySQL Enterprise Service Manager and installation directory.

The installation and configuration of MySQL Enterprise Agent must be standard before you start the installation. The update installer will not upgrade agents where you have changed or modified the filenames or directory layout of the installed agent, configuration files, or the startup files.

The name of the update file varies but it shows the target operating system and the version the update applies to. If a specific component is being updated it may also appear in the file name. For example, a file named mysqlenterprisemanager-2.2.0-windows-update-installer.exe would indicate a Windows update to MySQL Enterprise Service Manager version 2.2.0.

You may install an update in the same way that you initially installed the service manager or the agent; in win32 or unattended mode on Windows in gtk, text, xwindow, or unattended mode on Unix and in osx, text , or unattended mode on OS X.

Otherwise, updating is a fairly straightforward process. Run the installation file and choose the directory of your current installation and whether or not you wish to back up your current installation. The time required to complete the process varies depending upon the nature of the update.

If you chose to back up your current installation, a directory named backup will be created in the current installation directory. This directory will contain copies of the directory or directories that were replaced during the update. In cases where only specific files are replaced, the backup directory may contain only these files. If you are unhappy with the update simply overwrite the new files or directories with the originals found in the backup directory. Be sure to stop both the MySQL Enterprise Service Manager and MySQL Enterprise Agent before restoring the original files. You can delete or archive this directory when you are satisfied that the update was successful.

If you choose to back up your current installation, the installer checks that there is adequate disk space for your repository backup. If there is not enough space, you are given the option of choosing another location; you may also choose not to back up the repository.

To update your Advisors see, Section 5.2.7.3, “Installing, Updating or Upgrading Advisors After Initial Login”.

5.6.1.1. Upgrading from MySQL Enterprise Monitor 1.3 to 2.0

5.6.1.1.1. Upgrading to MySQL Enterprise Service Manager 2.0

5.6.1.1.2. Upgrading to MySQL Enterprise Agent 2.0

To upgrade your existing installation from MySQL Enterprise Monitor 1.3 to MySQL Enterprise Monitor 2.0, you need to upgrade both your MySQL Enterprise Service Manager and your MySQL Enterprise Agent on each machine that you are monitoring.

To perform the update process you must use an update installer. This ensures that your current configuration information is migrated to the new version of MySQL Enterprise Service Manager.

Before you start the migration, shutdown your MySQL Enterprise Service Manager and MySQL Enterprise Agent on each monitored host. Then install the updated MySQL Enterprise Service Manager application to migrate the configuration and data of the main application and repository. Once the new MySQL Enterprise Service Manager is running, you can start to update and migrate each agent.

For more information on upgrading your MySQL Enterprise Service Manager, see Section 5.6.1.1.1, “Upgrading to MySQL Enterprise Service Manager 2.0”. For more information on upgrading an MySQL Enterprise Agent, see Section 5.6.1.1.2, “Upgrading to MySQL Enterprise Agent 2.0”.

5.6.1.1.1. Upgrading to MySQL Enterprise Service Manager 2.0

Upgrading MySQL Enterprise Service Manager requires you to use on of the update installers. The update installer performs a number of operations during installation:

• A new database, required to support 2.0 functionality, is created.

• You core dashboard, user, and rule information is migrated from the old database to the new database.

• The core configuration parameters for the MySQL Enterprise Service Manager are migrated from MySQL Enterprise Monitor 1.3 are migrated to MySQL Enterprise Monitor 2.0.

The installation of the new software using the update installer follows this basic sequence:

1. Request the installation language.

2. Confirm the location of the current MySQL Enterprise Service Manager installation.

3. Specify whether you want to keep a copy of the old server, application, and database files.

4. Configure the Tomcat server settings, including whether the new server should support SSL connections from agents.

5. If requested, the application and database information is backed up and upgraded, before the new application is installed.

The installation process is consistent for all platforms. A sample of the process for Max OS X has been provided below:

1. Double-click the update installer. The update installer will have update in the file name. For example, mysqlmonitor-2.0.0.7101-osx-update-installer.app.

2. Confirm the language you want to use when installing the software.

   Figure 5.20. MySQL Enterprise Monitor: Server Update: Language Selection

   

   Click OK

3. You will be presented with an information screen showing the application you are installing. Click Next to continue.

4. Specify, or locate, the previous installation of MySQL Enterprise Service Manager. If you installed the server within the default location, the current version of the application should be located automatically.

   Figure 5.21. MySQL Enterprise Monitor: Server Update: Previous Installation

   

5. The installer can keep a backup copy of your existing application, including keeping a complete backup of the data stored within your MySQL Enterprise Monitor repository database.

   Figure 5.22. MySQL Enterprise Monitor: Server Update: Backup of Previous Installation

   

   Specify the location of the backup (default is to use the backup directory within your installation directory). Note that backing up the database in addition to the main application will increase the installation time as the files have to be copied. The larger the size of your repository data, the longer the installation process will take.

6. Specify the Tomcat Server options. The Tomcat Server Port is the default port you will use to access the MySQL Enterprise Dashboard. If you want to support agents using SSL to communicate to MySQL Enterprise Service Manager, you must check the Is SSL support required?

7. Confirm that you want to continue the installation. Once installation has started, the backup of you existing application (and database) will start, although the process may take some time. Wait until the process completes.

8. Once the process has completed you will be provided with a notification of the installation process, including how to uninstall the application if you want to do so in the future. If any errors occurred, they will be reported here.

   Figure 5.23. MySQL Enterprise Monitor: Server Update: Completed installing files

   

9. The installation has now completed. You can automatically start the MySQL Enterprise Service Manager and view the attached Readme file by ensuring the checkboxes on this page are selected.

10. You can now quit the installer.

Once the installation has completed, the first time you login to MySQL Enterprise Dashboard you will be asked to provide your login credentials, if they do not already exist in the server configuration, or to provide a copy of the Advisor jar suitable for your MySQL Enterprise Service Manager version.

Figure 5.24. MySQL Enterprise Monitor: Server Update: Final Setup

MySQL Enterprise Monitor has now been updated. You must update each of your agents to MySQL Enterprise Agent 2.0 to ensure that they are providing the correct information to MySQL Enterprise Service Manager

5.6.1.1.2. Upgrading to MySQL Enterprise Agent 2.0

To upgrade an agent you should use a update installer. This will migrate your configuration information, simplifying the upgrade process significantly.

Note

The agent log file, mysql-monitor-agent.log, if it exists, will be retained during the upgrade. A new log file, mysql-monitor-agent.log is used by MySQL Enterprise Agent 2.0.

The core sequence is the same on all platforms, the update process on Linux is shown below:

1. Start the update installer.

   shell> ./mysqlmonitoragent-2.0.0.7101-linux-glibc2.3-x86-32bit-update-installer.bin

   For MySQL Enterprise Agent 2.2 and higher, If you have multiple instances of MySQL Enterprise Agent installed, you can specify a unique name for the agent, which will be used to identify the agent startup script (in /etc/init.d and other configuration information. To specify the installation, use the --servicename=mysql-monitor-agent option.

2. Set the language for the installation process.

   Language Selection
   
   Please select the installation language
   [1] English
   [2] Japanese
   Please choose an option [1] :
   

3. Confirm or update the location of the installation directory of the previous version.

   ----------------------------------------------------------------------------
   Welcome to the setup wizard for the MySQL Enterprise Monitor Agent Update
   
   ----------------------------------------------------------------------------
   Please specify the directory that contains the previous installation of
   the MySQL Enterprise Monitor Agent
   
   Installation directory [/opt/mysql/enterprise/agent]:
       

4. Specify whether you want to create a backup of the current application and configuration information, and if so, where the backup directory should be created.

   ----------------------------------------------------------------------------
   Current installation backup
   
   Do you want to create a backup during the update process?
   
   Backup the current installation [Y/n]: Y
   
   
   Backup directory [/opt/mysql/enterprise/agent/patchbackup]:
   
         

5. You will be asked whether you want to enable the Query Analyzer. The Query Analyzer lets you monitor the execution statistics for individual queries executed through your MySQL servers. To enable, you must specify the proxy port, MySQL server and MySQL server port that you want to use. If you do not enable Query Analyzer now, you can enable it later. See Section 2.6, “The Query Analyzer Tab”.

   ----------------------------------------------------------------------------
   Query Analyzer Configuration
   
   MySQL Proxy enables query monitoring and analysis by listening on the port
   specified below for client connections that are then passed through to a
   backend MySQL database server. It is not needed for basic monitoring
   functionality, but is required for query monitoring and analysis.
   
   Visit the following URL for more information:
   https://enterprise.mysql.com/docs/monitor/2.0/en/mem-query-analyzer.html
   
   
   
   Enable Proxy (recommended) [Y/n]:
   
   
   Proxy Port [6446]:
   
   Backend Host: 127.0.0.1   (cannot be changed)
   
   Backend Port: 3306   (cannot be changed)
         

6. You are now ready to complete the installation. Confirm that you want to continue.

   ----------------------------------------------------------------------------
   Setup is now ready to begin installing MySQL Enterprise Monitor Agent Update on your computer.
   
   Do you want to continue? [Y/n]:
   
   ----------------------------------------------------------------------------
   Please wait while Setup installs MySQL Enterprise Monitor Agent Update on your computer.
   
    Installing
    0% ______________ 50% ______________ 100%
    #########################################
   
   ----------------------------------------------------------------------------
   Setup has finished installing MySQL Enterprise Monitor Agent Update on your computer.
   
   Restart MySQL Enterprise Monitor Agent now [Y/n]:
   
   View Readme File [Y/n]: n
         

Before connecting your MySQL Enterprise Agent to your MySQL server you must update the grants for the MySQL Enterprise Agent. Connect to the MySQL server and run this statement to update the required grants:

GRANT CREATE, INSERT
  ON mysql.*
  TO  'mysqluser'@'localhost'
  IDENTIFIED BY 'agent_password';

Replacing the mysqluser and agent_password parameters with the values used for connecting your agent to your MySQL server.

Once the update agent has communicated with the MySQL Enterprise Service Manager the core information about the agent and the MySQL server it is monitoring will be migrated to the new data format required by MySQL Enterprise Service Manager 2.0. To migrate the existing stored data, see Section B.6, “Migrating 1.3.x Historical Data to MySQL Enterprise Monitor 2.0”.

This section describes the best practices to employ when changing your MySQL Enterprise Monitor installation.

%server.reachable% == THRESHOLD

%server.reachable% == THRESHOLD  && CURTIME() NOT BETWEEN '22:00:00' AND '23:00:00'

Removing the MySQL Enterprise Service Manager

Remove the MySQL Enterprise Service Manager by going to the Control Panel and choosing Add or Remove Programs. Find the entry for MySQL Enterprise Monitor and remove it. During the uninstall process you will be given the option of saving existing data and log files. Choose this option if you plan to reinstall the MySQL Enterprise Monitor.

If you are not saving existing data, after MySQL Enterprise Service Manager has been removed you may delete the C:\Program Files\MySQL\Enterprise\Monitor directory.

If you added the Tomcat/Apache web server to the list of Windows firewall exceptions, remove this service by opening the Windows Firewall from the Control Panel. Choose the Exceptions tab and delete the Tomcat/Apache entry.

Removing MySQL Enterprise Monitor Services Only

When the MySQL Enterprise Service Manager is installed, the Tomcat/Apache and MySQL server services are started. It is possible to remove these services without also removing your MySQL Enterprise Service Manager installation. For more information about these services see, Section 5.2.5, “Starting/Stopping the MySQL Enterprise Monitor Service on Windows”.

Do this by finding the MySQL Enterprise Monitor menu option and choosing Services and then Uninstall MySQL Enterprise Monitor Services. This will remove all the services associated with MySQL Enterprise Service Manager.

You can confirm that these services have been removed by checking services in the Microsoft Management Console Services window.

If you wish to reinstall these services you can do this by using the Install MySQL Enterprise Monitor Services menu option.

It is also possible to remove services using the mysqlmonitorctl.bat file found in the C:\Program Files\MySQL\Enterprise\Monitor directory. To see the available options, go to the command line and type: myqlnetworkctrl help. This batch file is discussed in more detail in Section 5.2.5, “Starting/Stopping the MySQL Enterprise Monitor Service on Windows”.

Removing the Monitor Agent

To remove the Monitor Agent itself, open the Control Panel and choose Add or Remove Programs. Find the entry for MySQL Enterprise Monitor Agent and remove it. This will execute the uninstall program located in the C:\Program Files\MySQL\MySQL\Enterprise\Agent directory.

After removing the Monitor Agent you may also need to remove the directories, C:\Program Files\MySQL\Enterprise and C:\Program Files\MySQL\Enterprise\Agent.

Removing the Monitor Agent in this fashion will remove the default service. However, if you are running additional Monitor Agents as described in Section C.2.2, “MySQL Server (agent-instance.ini) Configuration”, you will have to remove those agents manually. See the next section for instructions on doing this.

Removing a Single Agent

If you are running more than one agent on the same machine and wish to remove only one of the agents, do not remove the MySQL Enterprise Monitor Agent entry from the Add or Remove Programs menu. To remove a single agent and leave other agents intact follow these steps:

It is best to stop the agent before removing it; for instructions on stopping an agent see, Section 5.3.5.1, “Starting/Stopping the Agent on Windows”.

You can confirm the location of the agent log files by checking the ini file. For more information on this topic see Section C.2.1, “MySQL Enterprise Agent Configurable Options”.

Go to the command line and remove the MySQL Enterprise Agent as a Windows service by typing:

shell> sc delete AgentName

You can confirm that the agent has been removed by checking the Microsoft Management Console Services window. There should no longer be an entry for the removed agent.

You should also remove or archive any log or configuration files associated with this agent. If you have installed any additional agents, remove them in the same fashion.

Removing the MySQL Enterprise Service Manager

To remove the MySQL Enterprise Service Manager, find the uninstall file in the /opt/mysql/enterprise/monitor directory.

Execute this file by typing:

shell> ./uninstall

During the uninstall process you will be given the option of saving existing data and log files. Choose this option if you plan to reinstall the MySQL Enterprise Monitor.

If you are not saving existing data, after uninstalling the MySQL Enterprise Service Manager you may remove the /opt/mysql/enterprise/monitor directory.

On Red Hat Enterprise Linux 4 and Fedora Core 4, the uninstall script may not stop the Tomcat server. Do this manually if necessary. To do this see, Section 5.2.6, “Starting/Stopping the MySQL Enterprise Monitor Service on Unix and Mac OS X”.

There may be other Java processes running on your system. Be careful not to accidentally stop them.

On some Unix platforms, including HP-UX, you may have to manually delete the uninstall application and the installation directory after you have execute the uninstall process.

Removing the Monitor Agent

Prior to removal of the Monitor Agent Service you should stop any agents. Do this by changing to the init.d directory and issuing the command, ./mysql-monitor-agent stop.

You will find the uninstall file in the /opt/mysql/enterprise/agent directory. Execute this file by navigating to this directory and typing:

shell> ./uninstall

After uninstalling the Monitor Agent you may remove the /opt/mysql/enterprise/agent directory.

Removing the Monitor Agent in this fashion will remove the default service, and all the configuration files for different instances.

Removing a Single Agent

If you are running more than one agent on the same machine and wish to remove only one of the agents, do not run the uninstall program. To remove a single agent and leave other agents intact follow these steps:

It is best to stop the agent before removing it; for instructions on stopping an agent see Section 5.3.5.3, “Starting/Stopping the Agent on Unix”.

You can confirm the location of the agent log files by checking the ini file. For more information on this topic see Section C.2.1, “MySQL Enterprise Agent Configurable Options”.

You may then remove the agent as a daemon by removing its entry in the init.d directory. You should also remove or archive any log or configuration files associated with this agent.

If you have installed any additional agents, remove them in the same fashion.

Removing the MySQL Enterprise Service Manager

To remove the MySQL Enterprise Service Manager, run the uninstall.app located in the /Applications/mysql/enterprise/monitor/ directory, or the root directory of your MySQL Enterprise Service Manager installation.

During the uninstall process you will be given the option of saving existing data and log files. Choose this option if you plan to reinstall the MySQL Enterprise Monitor.

If you are not saving existing data, after uninstalling the MySQL Enterprise Service Manager you may remove the /Applications/mysql/enterprise/monitor directory.

Removing the Monitor Agent

Prior to removal of the MySQL Enterprise Agent you should stop any agents. Do this by changing to the init.d directory and issuing the command:

shell> ./mysql-monitor-agent stop

Run the uninstall.app file located in the /Applications/mysql/enterprise/agent directory.

After uninstalling the MySQL Enterprise Agent you may remove the /Applications/mysql/enterprise/agent directory.

Removing the MySQL Enterprise Agent in this fashion will remove the default service, and all the configuration files for different instances.

Removing a Single Agent

If you are running more than one agent on the same machine and wish to remove only one of the agents, do not run the uninstall program.

To remove a single agent and leave other agents intact follow these steps:

It is best to stop the agent before removing it; for instructions on stopping an agent see Section 5.3.5.2, “Starting/Stopping the Agent on Mac OS X”.

You can confirm the location of the agent log files by checking the ini file. For more information on this topic see Section C.2.1, “MySQL Enterprise Agent Configurable Options”.

You may then remove the agent as a daemon by removing its entry in the init.d directory.

You should also remove or archive any log or configuration files associated with this agent.

If you have installed any additional agents, remove them in the same fashion.