--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.

--agent-force-uncorking

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

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 15.3.3.6.3, “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.

--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

--basedir

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 15.7.5, “Creating a Custom Data Collection Item”.

--agent-max-response-size

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

--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-run-os-tests

Runs the internal operating system tests, and then exits. Using this option will generate 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.

A truncated sample of the output is provided below:

2010-01-22 16:15:45: (critical) MySQL Monitor Agent 2.1.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 synchronise with the server during the resynchronization.

--basedir

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

--basedir

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.

--basedir

Specify a base directory that will be prepended to all other filename configuration options. The base name should be an absolute (not relative) directory. If you specify a relative directory, mysql-monitor-agent will generate 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 a process surrounding the main mysql-monitor-agent which will attempt to restart the true mysql-monitor-agent process in thr event a crash or other failure.

--log-backtrace-on-crash

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

--log-file=filename

Specify the name of a file to be used to record log information.

--log-file=filename

The log level to be used when outputting error messages. The specification will output that level (or lower) of a given error message. For example, message will also output 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. You may need to increase this with certain 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.

--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 server. The default is :6446 (all IPs on port 6446).

--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 will go to server A; the second client connection to server B and the third client connection to server A.

--proxy-pool-no-change-user

Disables the use of the MySQL protocol CHANGE_USER when reusing 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 then the updated content will automatically be used when a new connection is made.

--daemon

Starts the proxy in daemon mode.

--pid-file=file

Sets the name of the file to be used to store the process ID.

--user=user

Run mysql-monitor-agent as the specified user.

--version

Show the version number.