The mysql-monitor-agent.ini
files 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.
You can see a sample of the configuration file below:
# 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.
#
# Refer to the documentation for more detailed information and
# instructions.
#
# Version: 20080718_230416_r7011
[mysql-proxy]
plugins=proxy,agent
agent-mgmt-hostname = http://agent:password@monitor-server:18080/heartbeat
mysqld-instance-dir= etc/instances
agent-item-files = share/mysql-proxy/items/quan.lua,share/mysql-proxy/items/items-mysql-monitor.xml
proxy-address=:6446
proxy-backend-addresses = 127.0.0.1:3306
proxy-lua-script = share/mysql-proxy/quan.lua
agent-uuid = 8770ead5-3632-4b29-a413-4a7c92437e26
log-file = mysql-monitor-agent.log
pid-file=/Applications/mysql/enterprise/agent/mysql-monitor-agent.pid
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:
plugins
— configures the plugins to
be used by the agent. When monitoring servers you must have
the agent
plugin configured. If you want
to support Query Analyzer then you must also have the
proxy
module enabled. Plugins should be
specified as a comma separated list of plugin names.
If you selected to support Query Analyzer during
installation of the agent, the default value will be
proxy,agent
. If you disabled Query
Analysis during installation, the default value will be
agent
.
log-level
— sets the logging level
of the agent. The default level is
critical
.
Valid values for log-level
are as
follows:
debug
— provides detailed
information about what the agent is doing and the
information being provided by the agent to the
MySQL Enterprise Service Manager.
critical
— lists critical
messages highlighting problems with the agent.
error
— lists error messages.
warning
— provides only warning
messages generated by the agent.
message
— provides information
about the agent and basic processing information.
info
— provides messages used
for informational purposes.
Be careful when setting the log-level
to debug
. Doing this will rapidly
increase the size of your
mysql-monitor-agent.log
file. To
avoid disk space problems, put the log files on a
different drive from your MySQL server and the
MySQL Enterprise Dashboard.
It is strongly recommended that you use a
log-level
of
critical
or error
in
a production server. Use the higher-levels to provide more
detailed information only for debugging problems with your
agent.
Under Windows, if you restart the agent from the command
line after setting the log-level
to
debug
, extensive debug information is
displayed to the console as well as to the log file.
agent-mgmt-hostname
— sets the URL
to use when reporting information. This value will be
automatically set to your MySQL Enterprise Service Manager during
installation.
mysqld-instance-dir
— sets the
directory where the configuration files that specify the
MySQL servers to be monitored can be located.
agent-item-files
— sets the
information that is provided up to the MySQL Enterprise Service Manager when
the agent is reporting status information. You should leave
this item with the default setting of the
share/mysql-proxy/items/quan.lua
(which
provides Query Analyzer data) and
share/mysql-proxy/items/items-mysql-monitor.xml
(which provides the core agent monitoring data).
proxy-address
— sets the address
and/or port number for the proxy to listen to for
connections. 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.
The default value is 6446. If you want to support a different local host name/IP address and port, specify the host name and the port number, separated by a colon.
proxy-backend-addresses
— sets the
host name and port number to be used when communicating the
backend MySQL server when employing query analyzer. This is
the MySQL server where packets from the client are sent when
communicating with the proxy on the host name/port set by
the proxy-address
.
proxy-lua-script
— sets the Lua
script to be used by the proxy when forwarding queries. To
use Query Analyzer, this parameter should be set to
share/mysql-proxy/quan.lua
. This is the
default value.
agent-uuid
— sets the UUID
(Universally Unique ID) of the agent. This value should be
unique for all agents communicating with the same server, as
the UUID is used to uniquely ID the agent within
MySQL Enterprise Service Manager
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 leavig this configuration
property blank.
log-file
— sets the location of the
log file used to record information about the agent when it
is running. 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.
pid-file
— sets the location of the
file used to record the Process ID of the agent. This is
used by the script that shuts down the agent to identify the
process to be shutdown. The default value is the
mysql-monitor-agent.pid
file within the
base installation directory as created by the agent
installer.