Appendix A MySQL Enterprise Monitor Component Reference
Prev |  | Next

## Appendix A MySQL Enterprise Monitor Component Reference

## A.1 MySQL Enterprise Service Manager Reference

### A.1.1 Log Files for the MySQL Enterprise Service Manager

This section shows the location of the log 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 A.1 MySQL Enterprise Monitor: Log File Locations

Component | File Location
--- | ---
Apache/Tomcat | \MySQL\Enterprise\Monitor\apache-tomcat\logs\catalina.out
Repository | \MySQL\Enterprise\Monitor\mysql\data
Configuration Report | \MySQL\Enterprise\Monitor\configuration_report.txt
Service Manager (General) | \MySQL\Enterprise\Monitor\apache-tomcat\logs\mysql-monitor.log
Service Manager (Full / Support) | \MySQL\Enterprise\Monitor\apache-tomcat\logs\mysql-monitor-full.log

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

### A.1.2 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 A.2 MySQL Enterprise Monitor: MIB File Locations

Operating System | File Location
--- | ---
Windows | C:\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

### A.1.3 The `config.properties` file

#### File location

The repository user name and encrypted password are stored in the `config.properties` file. The following table shows the location of this file on various operating systems:

Table A.3 MySQL Enterprise Monitor: Default path of the `config.properties` File

Operating System | File Location
--- | ---
Windows | C:\Program Files\MySQL\Enterprise\Monitor\apache-tomcat\webapps\ROOT\WEB-INF
Linux and Unix | /opt/mysql/enterprise/monitor/apache-tomcat/webapps/ROOT/WEB-INF
Mac OS X | /Applications/mysql/enterprise/monitor/apache-tomcat/webapps/ROOT/WEB-INF

Make sure that the file is secured at the filesystem level so that it cannot be read by anybody but the administrator, or MySQL Enterprise Monitor.

#### Usage

A generated `config.properties` file looks similar to:

    #SymmetricKey was auto generated.
    #Thu Aug 15 13:35:56 PDT 2013
    mysql.use_ssl=true
    mysql.user=service_manager
    mysql.port=13306
    key=8577667A79DF5275
    mysql.pass=BMcsacZdrMmM7mrnFExURHDuxp4C3hcrZyxcpC2QhiE\=
    mysql.verify_server_cert=false
    mysql.server=localhost
    mysql.db=mem

Note

The `mysql.pass` is encrypted.

The application has two connection pools, one to service agent traffic, and the other for the UI. You can configure them as one logical pool with a 85/15 (agent/ui) percentage split, and use "dbPool" as the pool name in the further settings. Or, you can configure each pool separately, where the pool names are "default" and "ui". Note that the names after the "." come verbatim from DBCP at http://commons.apache.org/proper/commons-dbcp/configuration.html.

Table A.4 Optional config.properties values

Property Name | Property Type | Default
--- | --- | ---
`data_collection_interval` | string | 00:01:00
`dbpool.default.initialSize` | integer | 20
`dbpool.default.maxActive` | integer | 70
`dbpool.default.maxIdle` | integer | 20
`dbpool.default.maxWaitMillis` | string | 30 seconds
`dbpool.default.minEvictableIdleTimeMillis` | string | 15 seconds
`dbpool.default.minIdle` | integer | 0
`dbpool.default.timeBetweenEvictionRunsMillis` | string | 5 seconds
`dbpool.ui.initialSize` | integer | 5
`dbpool.ui.maxActive` | integer | 15
`dbpool.ui.maxIdle` | integer | 5
`dbpool.ui.maxWaitMillis` | string | 30 seconds
`dbpool.ui.minEvictableIdleTimeMillis` | string | 15 seconds
`dbpool.ui.minIdle` | integer | 0
`dbpool.ui.timeBetweenEvictionRunsMillis` | string | 5 seconds
`internal_perf_enable` | boolean | false
`internal_perf_server_id` | integer |
`notify_thread_pool_size` | integer | 4
`quanal.collect` | string | 00:01:00
`supportReport.retention.minutes` | string | 6 hours
`ui.javascript.useClientSideStorage` | boolean | false

- `notify_thread_pool_size(4)`

  Permitted Values | Type | `integer`
  Default | `4`

  SMTP and SNMP notifications are sent asynchronously, this controls how many threads are used for this process.

- `thread_pool_size(8)`

  Permitted Values | Type | `integer`
  Default | `8`

  Used to handle background jobs.

- `data_collection_interval(00:01:00)`

  Permitted Values | Type | `string`
  Default | `00:01:00`

  Defaults to one minute, and is never less than one minute. May be set to a value larger than one minute by use of the data_collection_interval property, in hh::mm::ss interval format.

- `internal_perf_enable(false)`

  Permitted Values | Type | `boolean`
  Default | `false`

  Enables internal performance monitoring for MySQL Enterprise Monitor (requires deploying some graphs from the `resources/` directory).

- `internal_perf_server_id(false)`

  Permitted Values | Type | `integer`
  Default | ``

  If internal_perf_enable is set to true, and MySQL Enterprise Service Manager can not read `mysql.inventory`, then use this ID instead.

- `quanal.collect(00:01:00)`

  Permitted Values | Type | `string`
  Default | `00:01:00`

  The rate that the service manager asks for query analysis data from the agent and plugins. It is expressed using the hh:mm::ss interval format.

- `ui.javascript.useClientSideStorage(false)`

  Permitted Values | Type | `boolean`
  Default | `false`

  Use this instead of cookies to store UI state (not login, but graph selection, etc.) Generally only needed if using a broken proxy that truncates cookie length.

- `supportReport.retention.minutes(6 hours)`

  Permitted Values | Type | `string`
  Default | `6 hours`

  The length of time that MySQL Enterprise Monitor will retain the reports generated when using "Support diagnostics" from "Manage Servers".

- `dbpool.ui.initialSize(5)`

  Permitted Values | Type | `integer`
  Default | `5`

- `dbpool.ui.maxActive(15)`

  Permitted Values | Type | `integer`
  Default | `15`

- `dbpool.ui.minIdle(0)`

  Permitted Values | Type | `integer`
  Default | `0`

- `dbpool.ui.maxIdle(5)`

  Permitted Values | Type | `integer`
  Default | `5`

- `dbpool.ui.maxWaitMillis(30 seconds)`

  Permitted Values | Type | `string`
  Default | `30 seconds`

- `dbpool.ui.timeBetweenEvictionRunsMillis(5 seconds)`

  Permitted Values | Type | `string`
  Default | `5 seconds`

- `dbpool.ui.minEvictableIdleTimeMillis(15 seconds)`

  Permitted Values | Type | `string`
  Default | `15 seconds`

- `dbpool.default.initialSize(20)`

  Permitted Values | Type | `integer`
  Default | `20`

- `dbpool.default.maxActive(70)`

  Permitted Values | Type | `integer`
  Default | `70`

- `dbpool.default.minIdle(0)`

  Permitted Values | Type | `integer`
  Default | `0`

- `dbpool.default.maxIdle(5)`

  Permitted Values | Type | `integer`
  Default | `20`

- `dbpool.default.maxWaitMillis(30 seconds)`

  Permitted Values | Type | `string`
  Default | `30 seconds`

- `dbpool.default.timeBetweenEvictionRunsMillis(5 seconds)`

  Permitted Values | Type | `string`
  Default | `5 seconds`

- `dbpool.default.minEvictableIdleTimeMillis(15 seconds)`

  Permitted Values | Type | `string`
  Default | `15 seconds`

## A.2 MySQL Enterprise Monitor Agent Reference

The MySQL Enterprise Monitor Agent provides all of the information from a monitored MySQL server to MySQL Enterprise Service Manager.

The MySQL Enterprise Monitor Agent is configured through the MySQL Enterprise Monitor User Interface, and the bundled `agent.sh`/`agent.bat` script. Using these methods is recommended,

Note

In MEM versions before 3.0.0, the Agent was configured using the `mysql-monitor-agent.ini` and `agent-instance.ini` configuration files.

### A.2.1 Agent Log Files

The Agent has two log files. `mysql-monitor-agent.log` is the general log, and `mysql-monitor-agent-full.log` is the full log that also contains stack traces that are useful to the Support team.

The default path to the Agent log files are as follows:

- Windows Path: `C:\Program Files\MySQL\Enterprise\Agent\logs\`

- Linux Path: `/opt/mysql/enterprise/agent/logs/`

- Mac OS X Path: `/Applications/mysql/enterprise/agent/logs/`

The log files are managed with `log4j`, which is configured using `log4j.properties`. The Agent watches for changes every 60 seconds, and updates MySQL Enterprise Monitor accordingly. The default file location:

- Windows Path: `C:\Program Files\MySQL\Enterprise\Agent\etc\log4j.properties`

- Linux Path: `/opt/mysql/enterprise/agent/etc/log4j.properties`

- Mac OS X Path: `/Applications/mysql/enterprise/agent/etc/log4j.properties`

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

Because the log files can become large, you could rotate the logs by defining log4j options. For example, to implement a rotation of 10 x 10MB log files:

    log4j.appender.file.MaximumFileSize = 10MB
    log4j.appender.file.MaxBackupIndex = 10
    log4j.appender.file.Append = true

For additional information about log4j, read the log4j documentation at http://logging.apache.org/log4j/.

Prev | Up | Next
Part V Appendices | Home | Appendix B Managing the Inventory