Documentation Home
MySQL Enterprise Monitor 3.4 Manual
Related Documentation Download this Manual

11.7 Configuration Options

It is possible to run the Proxy, or Aggregator, or both, with specific options, using the following files installed in the bin directory of your installation:

  • mysql-monitor-aggregator

  • mysql-monitor-proxy

Note

On Windows platforms, these files are executables and have the exe extension. On Linux, UNIX and Mac platforms, they are shell scripts.

To view the options available, run either file with the --help option.

The help output is broken down into the following sections:

  • Help Options: lists the various help output options.

  • Application Options: lists the application options.

  • aggr-module: lists the Aggregator-specific options. Displayed only for the --help-all option.

  • proxy-module: lists the Proxy-specific options. Displayed only for the --help-all option.

The mysql-monitor-aggregator help displays the application and Proxy module help, only. The mysql-monitor-proxy help displays application, aggregator and proxy output.

The following table lists the Proxy and Aggregator help options:

Table 11.2 Proxy and Aggregator Help Options

Option Name Description

-h, --help

Lists the basic help options.

--help-all

Lists all available help options.

--help-aggr

Lists the Aggregator-specific help options.

--help-proxy

Lists the Proxy-specific help options. This option is only available on the mysql-monitor-proxy file.


The following table lists the Proxy and Aggregator command line options:

Table 11.3 Proxy and Aggregator Command Line Options

Option Name Description

-V, --version

Shows the version of the Proxy or Aggregator, depending on which file it is run with.

--defaults-file=<file>

Defines a configuration file to use. Similarly to running an unattended installation with an options file, this enables you to define all configuration changes as name-value pairs (without the -- prefix for each option) and call the file as needed.

--verbose-shutdown

Configures the application to always log the exit code on shutdown.

--daemon

Configures the application to run in daemon mode.

--user=<user>

Defines the specific user to run the Aggregator.

--basedir=<absolute path>

Defines the absolute path of the base directory which is prefixed to all relative paths in the configuration. If you define a relative path, an error is returned.

--pid-file=<file>

Defines the name of the PID file to use in the event the application is started in daemon mode.

--plugin-dir=<path>

Defines the path to the plugins.

--plugins-name=<name>

Defines the names of the plugins to load. On the command line, you can specify this value multiple time. In the configuration file, the option is entered once, followed by a comma-separated list of the required plugins.

--log-level=<string>

Defines the logging level. Possible values are critical (default value), error, warning, info, message, and debug.

--log-file=<filename>

Defines the name of the logfile.

--log-use-syslog

Configures the application to send all messages to the syslog. UNIX/Linux only.

--log-backtrace-on-crash

Configures the application to invoke the debugger in the event of a crash.

--keepalive

Configures the application to attempt a restart in the event of a crash. Not available on Microsoft Windows. When running as a service, the Proxy automatically restarts.

--max-open-files

Configures the maximum number of open files.

--event-threads

Configures the number of event-handling threads. Default value is 1.

--lua-path=<path>

Sets the LUA_PATH.

--lua-cpath=<path>

Sets the LUA_CPATH


The following table lists the Aggregator module command line options:

Table 11.4 aggr-module Options

Option Name Description

--aggr-address=<host:port>

Defines the address and listening port of the Aggregator. The default port value is 14000.

--aggr-lua-script=<filename>

Defines the path to the LUA script.

--aggr-mem-url=<url>

Defines the URL to the MySQL Enterprise Service Manager.

--aggr-mem-user=<string>

Defines the Agent username to use for communication with the MySQL Enterprise Service Manager.

--aggr-mem-password=<string>

Defines the Agent password to use for communication with the MySQL Enterprise Service Manager.

--aggr-ssl-address=<host:port>

Defines the address and listening port of the Aggregator for SSL connections to the Aggregator.

--aggr-ssl-cert-file=<filename>

Defines the PEM server certificate for the Aggregator.

--aggr-ssl-cs-file=<filename>

Defines the CA certificate for the Aggregator.

--aggr-ssl-ciphers=<string>

Defines the supported ciphers.

--aggr-test-mode

Start the Aggregator in test mode. This mode ignores the flush interval setting and aggregates queries until instructed to return the aggregated data by a HTTP REST interface. It returns a JSON result set of all the normalized queries and their aggregated data.

--aggr-flush-interval=<seconds>

Defines the interval, in seconds, at which the query data is flushed to the MySQL Enterprise Service Manager. The default value is 60 seconds.

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

Defines the maximum size of an HTTP request body. The default size is 1MB.


The following table lists the Proxy module command line options:

Table 11.5 proxy-module Options

Option Name Description

-P, --proxy-address=<host:port>

The address and listening port of the Proxy. Default port is 4040.

-r, --proxy-read-only-backend-addresses

The address and listening port of the remote, slave server. This is not set by default.

-b, --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 to server B and the third client connection to server A. When using this option on the command line, you can specify the option and the server multiple times to specify multiple backends.

When using this option in a configuration file, separate multiple servers with commas.

--proxy-skip-profiling

Disable query profiling (statistics time tracking). The default is for tracking to be enabled.

-s file_name, --proxy-lua-script=<file>

The Lua script file to be loaded. The script file is not 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 the Proxy is running, the updated content is automatically used when a new connection is made.

--no-proxy

Disables the Proxy module. By default, the Proxy is enabled.

--proxy-pool-no-change-user

Disable use of the MySQL protocol CHANGE_USER command when reusing a connection from the pool of connections specified by the proxy-backend-addresses list.

--proxy-connect-timeout

Defines the Proxy's connection timeout in seconds. Default value is 2.

--proxy-read-timeout

Defines the read timeout in seconds. Default is 8 hours.

--proxy-write-timeout

Defines the write timeout in seconds. Default is 8 hours.


These options, with the exception of the help, version and defaults-file options, are also used, as name=value pairs, in the ini files used to configure the Proxy and Aggregator services.

The configuration files are located in the etc directory of your installation.

  • mysql-monitor-proxy.ini: configures the Proxy and Aggregator. Use this file when both components are installed.

  • mysql-monitor-aggregator.ini: configures the Aggregator. Use this file when only the Aggregator is installed.


User Comments
User comments in this section are, as the name implies, provided by MySQL users. The MySQL documentation team is not responsible for, nor do they endorse, any of the information provided here.
Sign Up Login You must be logged in to post a comment.