--help

Show available help options.

--help-all

Show all help options.

--help-admin

Show options for the admin-module.

--help-proxy

Show options for the proxy-module.

--help-monitor

Show options for the monitor module.

--help-agent

Show options for the agent module.

--admin-address=host:port

Specify the host name (or IP address) and port for the administration port. The default is localhost:4041.

--admin-lua-script=script

Specify the script to use for the administration module for the proxy.

--admin-password=pass

Define the password to use to authenticate users wanting to connect to the administration module of mysql-monitor-agent. The administration module uses the MySQL protocol to request a username and password for connections.

--admin-username=user

Define the username to use to authenticate users wanting to connect to the administration module of mysql-monitor-agent. The default username is root. The administration module uses the MySQL protocol to request a username and password for connections.

--agent-collector-plugins=user

A comma-separated list of the plugins to be used and loaded by the agent and used to provide collector items.

When monitoring servers you must have the agent plugin configured. To support Query Analyzer, you must also have the proxy module enabled. Plugins should be specified as a comma separated list of plugin names.

If you enabled Query Analyzer during installation of the agent, the default value is proxy,agent. If you disabled Query Analyzer during installation, the default value is agent.

--agent-connect-timeout=seconds

The timeout for the agent to connect to the MySQL server before a failure is reported.

--agent-DNS-cachetimeout=seconds

The timeout for caching the IP address of a given DNS name. By default, the operating system caching of the address is used and no caching in the agent is performed at all. If you specify -1, caching is enabled and never times out. Any other positive value specifies the timeout value. If you specify this option in the mysql-monitor-agent.ini configuration file, the value is preserved during an upgrade install.

--agent-net-timeout=seconds

The timeout for the agent to get a response from a MySQL server to which it is already connected before the failure is reported.

--agent-report-network-fs

Enables data collection for network file systems. The reporting of network file system information is disabled because the latency in determining and reporting the information can delay the collection and reporting of other information. You must manually enable collection if you need or use advisor and graphs that perform custom data collection on networked file systems.

--agent-force-uncorking

Forcibly turn off the corking of responses sent to MySQL Enterprise Service Manager. The corking mechanism tries to randomize the reporting interval of data sent up to the server to prevent flooding the server with information.

You can combine this option with the ---agent-report-offset to specify the offset when data is reported to the server. For more information, see agent-report-offset.

The frequency of collecting the data is not modified by this setting.

--agent-generate-uuid

Regenerates a UUID for the agent. You can use this to generate a new UUID if you have copied configuration information for an agent from one machine to another. To use:

shell> /opt/mysql/enterprise/agent/bin/mysql-monitor-agent --agent-generate-uuid
ee9296d7-f7cd-4fee-8b26-ead884ebf398
2009-03-05 11:49:37: (critical) shutting down normally

For more information, see Section 5.3.6, “Monitoring Multiple MySQL Servers”.

--agent-heartbeat-interval=#

Specify the heartbeat interval. The agent sends heartbeat messages to MySQL Enterprise Service Manager to indicate that it is alive and still running and monitoring servers. The MySQL Enterprise Service Manager uses this information to help identify when an agent is available or not.

--agent-host-id=HOSTID

Define the agent host ID. The host ID should be a unique identifier for the host on which the agent is running, and is different to the agent UUID. You can override the host ID for use within HA environments where you have two identical agent configurations, one on a live server, and one on a backup server to be brought into use if the primary server fails. The host ID is used to identify the host by the server, and during failover you want the host ID to remain constant as you monitor either the original or failover (replacement) server.

--agent-ip-version=VERSION

Specify the IP version to be used and supported by MySQL Enterprise Agent. By default, the agent supports both IPv4 and IPv6, or you can specify the version by specifying 4 or 6. If you specify this option in the mysql-monitor-agent.ini configuration file, the value is preserved during an upgrade install.

--host-id-commandline

Specify the command line to generate the host ID. By default, the host ID is generated by using a variety of methods configured for a specific platform, including using SSH keys and embedded host ID information. You can replace this with an alternative command-line

--agent-hostname

Override the automatically determined hostname. You can use this to specify an alternate hostname for the agent. This can be useful if your host has multiple hostnames and you want the machine identified by a specific hostname.

--agent-item-files

A comma-separated list of the item files used to load data items that are then collected and sent to MySQL Enterprise Service Manager. For more information, see Section 4.1.10, “Creating a Custom Data Collection Item”.

The default value includes share/mysql-monitor-agent/items/quan.lua (which provides Query Analyzer data) and share/mysql-monitor-agent/items/items-mysql-monitor.xml (which provides the core agent monitoring data).

--agent-max-response-size

Specify the maximum size of the response packet sent to MySQL Enterprise Service Manager.

--agent-ssh-keygen-attempts

Number of attempts that the agent should retry, for a failed ssh-keygen.

--agent-ssh-keygen-retry

Time interval (in seconds) between attempts for a failed ssh-keygen attempt.

--agent-master-uuid-discovery

By default, the MySQL Enterprise Agent uses the UUID of the replication master to aid in identifying the replication topology. Setting this option to false prevents the agent from accessing the master.info and using the UUID obtained from the replication master. Instead, the hostname and port information is used to determine the topology and match the instance and master information.

--agent-mgmt-hostname

Set the URL of the MySQL Enterprise Service Manager where collected data is sent. The URL should include the username and password for the agents, for example: http://agent:password@memserver:18080/heartbeat.

--agent-mgmt-username

The username to be used when communicating with MySQL Enterprise Service Manager.

--agent-mgmt-password

The password to be used when communicating with MySQL Enterprise Service Manager.

--agent-report-offset

The offset, in seconds, past the minute when data is sent up to MySQL Enterprise Service Manager. You can use this to harmonize or synchronize agent report across multiple machines, which can improve performance.

For example, if you set --agent-report-offset=15, then data is reported at 15 seconds past each minute. For example, at 12:00:15, 12:01:15, and so on.

--agent-run-os-tests

Runs the internal operating system tests, and then exits. Using this option generates a large body of information about the various operating system information that can be collected about the host. You can use this to determine whether the agent is collecting the right amount, quantity and quality of information to the server.

The following truncated example shows the format of the output:

2010-01-22 16:15:45: (critical) MySQL Monitor Agent 2.2.1.1138 started.
sigar-test-all.c.128 ():
  pid = 1353
sigar-test-all.c.110 ():
  mem.ram = 6080,
  mem.total = 6374154240,
  mem.used = 3356090368,
  mem.free = 3018063872,
  mem.actual_free = 3018063872,
  mem.actual_used = 3356090368
sigar-test-all.c.143 ():
  swap.total = 28523896832,
  swap.used = 710623232,
  swap.free = 27813273600
sigar-test-all.c.169 ():
  cpu.user = 24544920,
  cpu.sys = 136764840,
  cpu.nice = 0,
  cpu.idle = 1234759920,
  cpu.wait = 0,
  cpu.total = 349015500
sigar-test-all.c.194 ():
[0]
  cpu.user = 8516770,
  cpu.sys = 56838970,
  cpu.nice = 0,
  cpu.idle = 283667220,
  cpu.wait = 0,
  cpu.total = 349022960
[1]
  cpu.user = 6130420,
  cpu.sys = 12671090,
  cpu.nice = 0,
...

--agent-sync-attempts

Attempt to synchronize with the server during the resynchronization.

--track-alloc

Track the memory allocation in the various modules of the agent to help monitor the memory usage.

--agent-uuid

Specify the agent UUID. A UUID is automatically generated for each agent during installation, with the UUID automatically added to the configuration. You can generate a new UUID using the agent-generate-uuid command line option.

If you are setting up multiple hosts and copying the configuration between hosts, make sure that the agent-uuid is unique. You can have the agent create a new UUID by leaving this configuration property blank.

--basedir

Specify a base directory that is prepended to all other filename configuration options. Use an absolute (not relative) directory name, otherwise mysql-monitor-agent generates an error during startup.

--defaults-file

Specify a file to use as the file with configuration information. If not specified, configuration options are only taken from the command line.

--event-threads=#

Specify the number of event threads reserved to handle incoming requests.

--keepalive

Creates an angel process surrounding the main mysql-monitor-agent that attempts to restart the true mysql-monitor-agent process in the event a crash or other failure.

If the agent stops unexpectedly, the angel revives the agent.

An expected shutdown is:

If the angel receives one of SIGHIP, SIGTERM, or SIGINT signals, the signal is forwarded to the agent to initiate shutdown.

--agent-backlog-timeout=VALUE

The time in seconds that data is kept by the agent if the agent is unable to communicate with MySQL Enterprise Service Manager. Once the agent reconnects, the data is sent up to MySQL Enterprise Service Manager. Data older than the specified value is discarded. The default value is 600 seconds.

--aggr-address=host:port

Specify the listening hostname, port, or both for the MySQL Enterprise Agent Aggregator.

--log-backtrace-on-crash

Logs the backtrace to the error log and tries to initialize the debugger in the event of a failure.

--aggr-lua-script=SCRIPT

Specify the script to be used for MySQL Enterprise Agent Aggregator operations.

--aggr-max-request-body-size=bytes

Limits the maximum size of requests sent to the Aggregator, to avoid potential out-of-memory errors on the system running the Agent (and its Aggregator component).

--aggr-mem-baseurl=URL

Base URL of the MySQL Enterprise Service Manager to be used when sending aggregated queries collected from client plugins.

--aggr-ssl-address=host:port

The listening hostname, port, or both to be used when listening for SSL connections.

--aggr-ssl-ca-file=FILENAME

The CA chain file to be used for SSL communication.

--aggr-ssl-cert-file=FILENAME

The server certificate for the MySQL Enterprise Agent Aggregator. This should be in the form of a PEM file, consisting of a combination of the private key and the signing certificate.

--aggr-ssl-ciphers=STRING

List of the ciphers to be used for secure communication using SSL.

--aggr-test-mode

Start MySQL Enterprise Agent Aggregator in test mode.

--log-file=filename

Specify the name of a file to be used to record log information. If you do not specify a full path name, then the log file location is considered to be relative to the installation directory of the agent.

--log-level=level

The log level used when outputting error messages. Messages of that level (or lower) are output. For example, message also outputs info, warning, and error messages.

--log-use-syslog

Causes errors to be sent to the syslog (Unix/Linux only).

--lua-cpath=path

Specify the LUA_CPATH to be used when loading compiled modules or libraries for Lua scripts.

--lua-path=path

Specify the LUA_CPATH to be used when loading modules for Lua.

--max-open-files=#

The maximum number of open files and sockets supported by the mysql-monitor-agent process. Increase the value if required to run particular scripts.

--monitor-interval=#

Execute queries against the backends at this interval. The default is 1.

--monitor-lua-script=SCRIPT

Filename of the Lua script to use for the monitor module.

--monitor-password=PASS

The password for the monitoring user account.

--monitor-username=USER

The username for the monitoring user account.

--mysqld-instance-dir=PATH

The path to the configuration files for the MySQL instance.

--agent-IP-version=VER

Explicitly sets the IP version to be used for addressing. By default, the agent uses either version. Set the value by specifying 4 (for IPv4) or 6 (for IPv6).

--aggr-flush-interval=seconds

The interval at which queries are flushed to the MySQL Enterprise Service Manager. The default value is 60.

--no-proxy

Disable the proxy module.

--plugin-dir=path

The directory to use when loading plugins for mysql-monitor-agent.

--plugins=plugin,...

A comma-separated list of the plugins to be loaded.

--proxy-address=host:port

The listening host name (or IP address) and port of the proxy service. The default is :6446 (all IPs on port 6446). The setting is used when employing Query Analysis as the address/port that you must configure your application to use in place of your normal MySQL server. By default this item is set during installation.

--proxy-read-only-backend-addresses=host:port

The listening host name (or IP address) and port of the proxy server for read-only connections. The default is for this information not to be set.

--proxy-backend-addresses=host:port

The host name (or IP address) and port of the MySQL server to connect to. You can specify multiple backend servers by supplying multiple options. Clients are connected to each backend server in round-robin fashion. For example, if you specify two servers A and B, the first client connection goes to server A; the second client connection goes to server B; and the third client connection goes to server A.

--proxy-pool-no-change-user

Disables the use of the MySQL protocol CHANGE_USER when re-using a connection from the pool of connections specified by the backend-addresses list.

--proxy-skip-profiling

disables profiling of queries (tracking time statistics). The default is for tracking to be enabled.

--proxy-fix-bug-25371

Gets round an issue when connecting to a MySQL server later than 5.1.12 when using a MySQL client library of any earlier version.

--proxy-lua-script=file

Specify the Lua script file to be loaded. Note that the script file is not physically loaded and parsed until a connection is made. Also note that the specified Lua script is reloaded for each connection; if the content of the Lua script changes while mysql-monitor-agent is running, the updated content is automatically used when a new connection is made. To use Query Analyzer, set this parameter to share/mysql-monitor-agent/quan.lua. This is the default value.

--proxy-connect-timeout=seconds

The timeout value, for proxy connection operations.

--proxy-read-timeout=seconds

The timeout value, for proxy read operations.

--proxy-write-timeout=seconds

The timeout value, for proxy write operations.

--daemon

Starts the proxy in daemon mode.

--pid-file=file

Sets the name of the file that stores the process ID. This is used by the script that shuts down the agent to identify the process to be shut down. The default value is the mysql-monitor-agent.pid file within the base installation directory as created by the agent

--user=user

Run mysql-monitor-agent as the specified user.

--version

Show the version number.

--verbose-shutdown

By default, agent shutdown messages are only logged if you have set log-level to message or higher. You can force shutdown messages to be reported regardless of the log level using this option.