Appendix C. Files Associated with The MySQL Enterprise Monitor

Table of Contents

C.1. Log Files for the MySQL Enterprise Service Manager
C.2. Monitor Agent and Service Manager Installation Log Files
C.3. Agent Log and PID Files
C.4. The Management Information Base (MIB) File
C.5. The config.properties File
Note

MySQL Enterprise subscription, MySQL Enterprise Monitor, MySQL Replication Monitor, and MySQL Query Analyzer are only available to commercial customers. To learn more, see: http://www.mysql.com/products/enterprise/features.html.

This section details the files associated with the MySQL Enterprise Monitor and shows their default location.

C.1. Log Files for the MySQL Enterprise Service Manager

This section shows the location of the log and configuration files associated with the various components that make up the MySQL Enterprise Service Manager. These files can prove useful for debugging purposes.

All log files except catalina.out are rotated to ensure they do not grow beyond 10MB in size.

Table C.1. MySQL Enterprise Monitor: Log File Locations: Windows

ComponentFile Location
Apache/TomcatC:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\logs\catalina.out
RepositoryC:\Program Files\MySQL\Enterprise\Monitor\mysql\data
Configuration ReportC:\Program Files\MySQL\Enterprise\Monitor\configuration_report.txt
Service ManagerC:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\logs\mysql-monitor.log

Table C.2. MySQL Enterprise Monitor: Log File Locations: Unix

ComponentFile Location
Apache/Tomcat/opt/mysql/enterprise/monitor/apache-tomcat/logs/catalina.out
Repository/opt/mysql/enterprise/monitor/mysql/data
Configuration Report/opt/mysql/enterprise/monitor/configuration_report.txt
Service Manager/opt/mysql/enterprise/monitor/apache-tomcat/logs/mysql-monitor.log

Table C.3. MySQL Enterprise Monitor: Log File Locations: Mac OS X

ComponentFile Location
Apache/Tomcat/Applications/mysql/enterprise/monitor/apache-tomcat/logs/catalina.out
Repository/Applications/mysql/enterprise/monitor/mysql/data
Configuration Report/Applications/mysql/enterprise/monitor/configuration_report.txt
Service Manager/Applications/mysql/enterprise/monitor/apache-tomcat/logs/mysql-monitor.log

All of these logs are viewable within MySQL Enterprise Dashboard. For more information, see Section 5.6, “Logs”.

Note

The configuration_report.txt file contains the repository password in plain text. You may want to store this file in a secure location.

On all operating systems, the Apache/Tomcat, and Repository directories contain both access and error files.

C.2. Monitor Agent and Service Manager Installation Log Files

These log files are called bitrock_installer.log.

On Windows these files are stored in the temporary directory defined by the variable %TEMP%. To determine the value of %TEMP% on your system, type echo %TEMP% at the command line. Alternately, you may open the Run command window, enter %TEMP% and press OK. To find this file on Unix and Mac OS X check the value of the environment variable, $TMPDIR. If this variable is not defined, look in the /tmp directory.

If the file bitrock_installer.log already exists, a file called bitrock_installer_xxxx.log (where xxxx stands for an arbitrary series of numerals) will be created.

To determine if an installation file belongs to the Monitor Agent or the Service Manager you must open the file in a text editor.

C.3. Agent Log and PID Files

The locations of the agent log files are as follows:

  • Windows: C:\Program Files\MySQL\Enterprise\Agent\mysql-monitor-agent.log

  • Unix: /opt/mysql/enterprise/agent/mysql-monitor-agent.log

  • Mac OS X: /Applications/mysql/enterprise/agent/mysql-monitor-agent.log

On any platform, the location of the agent log file may be changed. You may also change the name of the log file. To confirm the location and the name, check the settings in the mysql-monitor-agent.ini file.

The maximum size of a log file may be limited to 2GB. If MySQL Enterprise Monitor Agent is unable to add information to the configured logfile, then information will instead be sent to the standard output.

Because the size of the log files can become quite large, you can use a tool such as logrotate (Unix/Linux) or logadm (Solaris) to automatically rotate the logs. For example, a sample logrotate definition is shown below:

/opt/mysql/enterprise/agent/mysql-monitor-agent.log {
    rotate 5
    daily
    minsize 1G
    postrotate
        /usr/bin/killall -HUP mysql-monitor-agent
    endscript
}

The above will rotate the log before it reaches 1GB in size, keeping up to 5 files at a time.

If you want to use your own system, you can copy the log file, flush the contents, and then send the SIGHUP signal to the agent process. On Windows, you need to shutdown, copy the log, and restart the agent.

The locations of the agent pid files are as follows:

  • Windows: C:\Program Files\MySQL\Enterprise\Agent\agent\mysql-monitor-agent.pid

  • Unix: /opt/mysql/enterprise/agent/mysql-monitor-agent.pid

  • Mac OS X: /Applications/mysql/enterprise/agent/mysql-monitor-agent.pid

On any platform, the location of the agent log file may be changed. You may also change the name of the log file. To confirm the location and the name, check the settings in the mysql-monitor-agent.ini file.

C.4. The Management Information Base (MIB) File

A MIB file is a requirement for using SNMP traps. A table showing the location of this file follows.

Table C.4. MySQL Enterprise Monitor: MIB File Locations

Operating SystemFile Location
WindowsC:\Program Files\MySQL\Enterprise\Monitor\support-files\MONITOR.MIB
Unix/opt/mysql/enterprise/monitor/support-files/MONITOR.MIB
Mac OS X/Applications/mysql/enterprise/monitor/support-files/MONITOR.MIB

C.5. The config.properties File

The repository user name and password are stored in in the config.properties file. A table showing the location of this file follows:

Table C.5. MySQL Enterprise Monitor: The config.properties File

Operating SystemFile Location
WindowsC:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\webapps\ROOT\WEB-INF
Unix/opt/mysql/enterprise/monitor/apache-tomcat/webapps/ROOT/WEB-INF
Mac OS X/Applications/mysql/enterprise/monitor/apache-tomcat/webapps/ROOT/WEB-INF

You should make sure that the file is secured at the file system level so that it cannot be read by anybody but the administrator or Enterprise monitor.