C.2.1 MySQL Enterprise Monitor Agent Configurable Options

The mysql-monitor-agent.ini file contains the base configuration information for the MySQL Enterprise Monitor Agent. The file sets the core information about the supported functionality for the entire agent. Its format is shown in the following example:

# WARNING - The UUID defined below must be unique for each agent.
#
# To use this INI file as a template for configuring additional
# agents, do not simply copy and start a new agent without first
# modifying the UUID and adjusting other parameters as necessary.
#
# WARNING - If you are upgrading from a previous 1.x release, please
# note that we have changed the contents of the agent INI file and
# split the contents across two files:
#
#   <installdir>/etc/mysql-monitor-agent.ini              - this file
#   <installdir>/etc/instances/mysql/agent-instance.ini   - new file
#
# Refer to the documentation for more detailed information and
# instructions.
# 
# Version: 2.3.9.2137

[mysql-proxy]

# Common Parameters
plugins    = proxy,agent,aggr
keepalive = true

log-file = mysql-monitor-agent.log
pid-file = /opt/mysql/enterprise/agent/mysql-monitor-agent.pid

# Agent Parameters
agent-mgmt-hostname = http://localhost:18080/heartbeat
agent-mgmt-username = agent
agent-mgmt-password = foo
agent-item-files    = share/mysql-monitor-agent/items/quan.lua, share/mysql-monitor-agent/items/items-mysql-monitor.xml, share/mysql-monitor-agent/items/items-mysql-cluster.xml, share/mysql-monitor-agent/items/custom.xml
agent-uuid          = 68b4892c-1310-4f07-8924-3a8b3c0e850b
mysqld-instance-dir = etc/instances

# Aggregator Parameters
aggr-address     = :14000
aggr-lua-script  = lib/mysql-aggregator/lua/aggr.lua
aggr-mem-baseurl = http://localhost:18080/v2/rest

# Proxy Parameters
proxy-address           = :6446
proxy-backend-addresses = 127.0.0.1:3306
proxy-lua-script        = lib/mysql-monitor-agent/lua/quan.lua
Note

Do not copy the agent configuration information from one machine to another without changing the agent-uuid. Each agent instance must have a unique agent id.

The main configuration information must be located within the [mysql-proxy] section of the configuration file. The main configurable parameters within this file are:

File names in configuration files

The MySQL Enterprise Monitor configuration files use the glib file parser to parse settings that define file names. This means that leading and trailing whitespace is stripped. The following escape characters are allowed: \r, \n, \t, \s, \\, and \.

The MySQL Enterprise Monitor Agent supports the following configurable options:

Table C.7 mysql-monitor-agent Help Options

FormatOption FileDescription
--help-admin Show options for the admin-module
--help-agent Show agent options
--help-all Show all help options
--help-monitor Show monitor options
--help-proxy Show options for the proxy-module

Table C.8 mysql-monitor-agent Admin Options

FormatOption FileDescription
--admin-addressadmin-addressDefines the listening address and port for the admin module
--admin-lua-scriptadmin-lua-scriptScript to execute by the admin module
--admin-passwordadmin-passwordPassword for authentication for admin module
--admin-usernameadmin-usernameUsername for authentication for admin module
--proxy-addressproxy-addressListening address:port of the proxy server

Table C.9 mysql-monitor-agent Agent Options

FormatOption FileDescriptionIntroduced
--agent-backlog-timeoutagent-backlog-timeoutMaximum time in seconds that the agent keeps data when it cannot communicate with the Service Manager 
--agent-collector-pluginsagent-collector-pluginsLoad the specified collector plugins 
--agent-connect-timeoutagent-connect-timeoutThe timeout for the agent to connect to the MySQL server 
--agent-DNS-cachetimeoutagent-DNS-cachetimeoutThe timeout for cache operations 
--agent-force-uncorkingagent-force-uncorkingForcibly turn off corking (randomization of data collection intervals) 
--agent-generate-uuidagent-generate-uuidGenerate a UUID for use with the agent-uuid 
--agent-heartbeat-intervalagent-heartbeat-intervalThe interval for generating heartbeat operations 
--agent-host-idagent-host-idThe host ID for the agent 
--agent-host-id-commandlineagent-host-id-commandlineThe command to use to generate the agent host id 
--agent-hostnameagent-hostnameHostname of the agent host 
--agent-IP-versionagent-IP-versionIP version (4 or 6) to force 
--agent-item-filesagent-item-filesList of data items for additional collections 
--agent-master-uuid-discoveryagent-master-uuid-discoveryDisable the use of the master_uuid for topology discovery 
--agent-max-response-sizeagent-max-response-sizeMaximum response size for agent data 
--agent-mgmt-hostnameagent-mgmt-hostnameURL of the management server 
--agent-mgmt-passwordagent-mgmt-passwordPassword for the management server 
--agent-mgmt-usernameagent-mgmt-usernameUser name with the management server 
--agent-net-timeoutagent-net-timeoutThe timeout for the agent for established connections to the MySQL server 
--agent-report-network-fsagent-report-network-fsEnable data collection for networked file systems 
--agent-report-offsetagent-report-offsetSet the second after the minute when the data is sent to the server 
--agent-run-os-testsagent-run-os-testsRun the operating system tests and shutdown 
--agent-ssh-keygen-attemptsagent-ssh-keygen-attemptsNumber of attempts that the agent should retry, for a failed ssh-keygen2.3.10
--agent-ssh-keygen-retryagent-ssh-keygen-retryTime interval (in seconds) between attempts for a failed ssh-keygen attempt2.3.10
--agent-sync-attemptsagent-sync-attemptsSynchronize the attempts to connect at resync 
--agent-track-allocagent-track-allocEnable the tracking of the allocation sizes 
--agent-uuidagent-uuidUUID of this agent 
--mysqld-instance-dirmysqld-instance-dirLocation of the MySQL instance configuration (mysql.cnf/mysql.ini) files 

Table C.10 mysql-monitor-agent Monitor Options

FormatOption FileDescription
--monitor-intervalmonitor-intervalInterval for executing queries against the backend
--monitor-lua-scriptmonitor-lua-scriptScript filename for the monitor
--monitor-passwordmonitor-passwordSet the password for the monitored MySQL Server
--monitor-usernamemonitor-usernameSet the username for the monitored MySQL Server

Table C.11 mysql-monitor-agent Proxy Options

FormatOption FileDescriptionIntroduced
--no-proxyno-proxyDon't start the proxy module 
--proxy-backend-addressesproxy-backend-addressesAddress:port of the remote MySQL server 
--proxy-connect-timeoutproxy-connect-timeoutDefines the default timeout, for proxy connection operations2.3.10
--proxy-fix-bug-25371proxy-fix-bug-25371Enable the fix for Bug #25371 (for mysqld > 2.0.0.12) for older libmysql versions 
--proxy-lua-scriptproxy-lua-scriptFilename for Lua script for proxy operations 
--proxy-pool-no-change-userproxy-pool-no-change-userDon't use the protocol CHANGE_USER to reset the connection when coming from the connection pool 
--proxy-read-only-backend-addressesproxy-read-only-backend-addressesAddress:port of the remote MySQL server (read-only) 
--proxy-read-timeoutproxy-read-timeoutDefines the default timeout, for proxy read operations2.3.10
--proxy-skip-profilingproxy-skip-profilingDisabled profiling of queries 
--proxy-write-timeoutproxy-write-timeoutDefines the default timeout, for proxy write operations2.3.10

Table C.12 mysql-monitor-agent Aggregator Options

FormatOption FileDescriptionIntroduced
--aggr-addressaggr-addressListening address:port combination2.3.0
--aggr-flush-intervalaggr-flush-intervalThe interval in seconds between flushes of query data to the MySQL Enterprise Service Manager2.3.0
--aggr-lua-scriptaggr-lua-scriptPath to the Lua script2.3.0
--aggr-max-request-body-sizeaggr-max-request-body-sizeLimits the maximum size of requests sent to the Aggregator, to avoid potential out-of-memory errors2.3.8
--aggr-mem-baseurlaggr-mem-baseurlBase URL of the server2.3.0
--aggr-ssl-addressaggr-ssl-addressListening port:address combination for SSL connections2.3.0
--aggr-ssl-ca-fileaggr-ssl-ca-fileCA certificate file2.3.0
--aggr-ssl-cert-fileaggr-ssl-cert-fileServer certificate (PEM)2.3.0
--aggr-ssl-ciphersaggr-ssl-ciphersSupported ciphers for SSL2.3.0
--aggr-test-modeaggr-test-modeStart the aggregator in test mode2.3.0

Table C.13 mysql-monitor-agent Application Options

FormatOption FileDescription
--basedirbasedirSpecify the base directory to prepend to paths in the config
--daemondaemonStart in daemon-mode
--defaults-filedefaults-fileSpecify the configuration file
--keepalivekeepaliveTry to restart the proxy if a crash occurs
--log-backtrace-on-crashlog-backtrace-on-crashTry to invoke the debug and generate a backtrace on crash
--log-filelog-fileSpecify the file for logging error messages
--log-levellog-levelLogging level
--log-use-sysloglog-use-syslogLog errors to syslog
--lua-cpathlua-cpathSet the LUA_CPATH
--lua-pathlua-pathSet the LUA_PATH
--max-open-filesmax-open-filesSpecify the maximum number of open files to support
--pid-filepid-filePID file to store the process ID (when in daemon mode)
--plugin-dirplugin-dirPath to the plugin files
--pluginspluginsList of plugins to load
--useruserSpecify the user to use when running mysql-monitor-agent
--verbose-shutdownverbose-shutdownReport shutdown in the logs regardless of log level
--versionversionShow the version information