Documentation Home
MySQL Utilities 1.5 Manual
Related Documentation Download this Manual
PDF (US Ltr) - 1.5Mb
PDF (A4) - 1.5Mb
HTML Download (TGZ) - 289.5Kb
HTML Download (Zip) - 301.7Kb


8.2.3.3 Configuration File Sections

The MySQL Fabric configuration file contains all the information necessary to run the MySQL Fabric utility. In addition, it serves as a configuration file for the utilities from within MySQL Fabric.

Each section has one or more variables defined that provide key information to the MySQL Fabric system libraries.

Note

The [client] section was removed in MySQL Fabric 1.5.5. Instead, use the restore_user, restore_password, backup_user, and backup_password under the [servers] section to configure users for the backup and restore utilities, such as mysqldump and the mysql client.

8.2.3.3.1 Section DEFAULT

The DEFAULT section contains information on the installation paths for MySQL Fabric. This section is generated as part of the installation and should normally not be modified.

prefix

The installation prefix used when installing the mysql.fabric package and the binaries.

sysconfdir

The location of the system configuration files. Normally located in the etc directory under the directory given in prefix, but in some situations this might be different.

logdir

Configures the directory where log files are located by default. Normally, the logging URL contains the absolute path, but in the event that the path is relative, it is relative to this directory.

8.2.3.3.2 Section storage

This section contains information that the MySQL Fabric node uses for the connection to the backing store. For more information on the backing store, see Section 8.6, “Backing Store”.

address

This is the address of the backing store in the form host:port. The port is optional and if not provided, defaults to 3306.

user

User name to use when connecting to the backing store.

password

The password to use when connecting to the backing store. If no password option is in the configuration file, a password is required on the terminal when the MySQL Fabric node is started. Although it is possible to set an empty password by not providing a value to the option, it is not recommended.

database

The database where the tables containing information about the MySQL Fabric farm is stored, typically fabric.

auth_plugin

The authentication plugin to use when connecting to the backing store. This option is passed to the connector when connecting to the backing store. For more information on authentication plugins, see Connector/Python Connection Arguments.

connection_timeout

Timeout for the connection to the backing store, in seconds. This option is passed to the connector when connecting to the backing store. This is the maximum amount of time that MySQL Fabric waits for access to the backing store to complete before aborting. For more information on authentication plugins, see Connector/Python Connection Arguments.

connection_attempts

The number of attempts to reconnect to the backing store before giving up. This is the maximum number of times MySQL Fabric attempts to create a connection to the backing store before aborting. The default is 0 retries.

connection_delay

The delay between attempts to connect to the backing store in seconds. The default is 0 seconds.

8.2.3.3.3 Section servers

This section contains information that MySQL Fabric uses to connect to the servers being managed.

Note

The backup_user, backup_password, restore_user, and restore_password options were added in MySQL Fabric 1.5.5.

user

User name to use when connecting to the managed server.

password

Password to use when connecting to the managed servers.

backup_user

User name to use when backing up the MySQL server.

backup_password

Password to use when backing up the MySQL servers with the backup_user user.

restore_user

User name to use when restoring the MySQL server.

restore_password

Password to use when restoring the MySQL servers with the restore_user user.

unreachable_timeout

Used for the connection timeout when checking faulty servers, or servers that are new to the farm. Hence, for servers that can potentially be unreachable. Defaults to 5, can be a value between 1-60.

8.2.3.3.4 Section protocol.xmlrpc

This section contains information about how the client connects to a MySQL Fabric node and configuration parameters for the XML-RPC protocol on the server.

address

Host and port of XML-RPC server. The host is only used by the client when connecting to the MySQL Fabric node, but the port is used by the server when starting the protocol server and by the client when reading how to connect to the XML-RPC server. The port number is typically 32274, and the host is typically localhost.

threads

Number of threads that the XML-RPC server uses for processing requests. This determines the number of concurrent requests that MySQL Fabric accepts.

user

User that the client uses to connect to the XML-RPC server.

password

Password used when the client connects to the server. If no password is provided, the client requests a password on the command-line.

disable_authentication

Whether to disable authentication or not. Disabling authentication can be useful when experimenting in a closed environment, it is not recommended for normal usage. Alternatives are yes or no and are case-insensitive.

realm

The realm (as defined in RFC 2617) the XML-RPC server identifies as when authenticating.

ssl_ca

Path to a file containing a list of trusted SSL certification authorities (CAs).

ssl_cert

The name of the SSL certificate file to use for establishing a secure connection.

ssl_key

The name of the SSL key file to use for establishing a secure connection.

8.2.3.3.5 Section protocol.mysql

This section contains information about how the client connects to a MySQL Fabric node using the MySQL Client/Server protocol.

address

Host and port of a MySQL Fabric node. The port number is typically 32275, and the host is typically localhost.

user

User that the client uses to connect to the MySQL Fabric node.

password

Password used when the client connects to the MySQL Fabric node. If no password is provided, the client requests a password on the command-line.

disable_authentication

Whether to disable authentication or not. Disabling authentication can be useful when experimenting in a closed environment, it is not recommended for normal usage. Alternatives are yes or no and are case-insensitive.

ssl_ca

Path to a file containing a list of trusted SSL certification authorities (CAs).

ssl_cert

The name of the SSL certificate file to use for establishing a secure connection.

ssl_key

The name of the SSL key file to use for establishing a secure connection.

8.2.3.3.6 Section executor

This section contains parameters to configure the executor. The executor executes procedures in a serial order, which guarantees that requests do not conflict. The requests received are mapped to procedures which can be executed directly or scheduled through the executor. Procedures scheduled through the executor are processed within the context of threads spawned by the executor. Usually, read operations are immediately executed by the XML-RPC session thread and write operations are scheduled and executed through the executor.

executors

The number of executor threads that the executor uses when processing requests.

working_directory

The directory Fabric uses by default to store files. If the option is not found, the working directory is the directory from where the process was launched.

Note

This option was added in Fabric 1.5.7.

8.2.3.3.7 Section logging

MySQL Fabric logs information about its activities to the standard output when started as a regular process. However, when started as a daemon, it writes information to a file configured by the the option Fabric URL used for logging.

level

The log level to use when generating the log. Acceptable values are CRITICAL, ERROR, WARNING, INFO, and DEBUG. The default is INFO.

url

The URL to use for logging. Supported protocols are currently file and syslog. The file protocol creates a rotating file handler, while the syslog protocol logs messages using the system logger syslogd .

The file handler accepts either a relative path or an absolute path. If a relative path is provided, it is relative to Configure default log directory.

The syslog handler accepts either a path (for example syslog:///dev/log) or a hostname and an optional port (for example, syslog://localhost:555, and syslog://my.example.com). If no port is provided, it defaults to 541, which is the default port for the syslog daemon.

8.2.3.3.8 Section sharding

To perform operations such as moving and splitting shards, MySQL Fabric relies on the mysqldump and mysql client programs. These programs can be installed in different locations and if they are not in the path for the MySQL Fabric node, this section configures where they can be found.

mysqldump_program

Path to the mysqldump program.

mysqlclient_program

Path to the mysql program.

8.2.3.3.9 Section statistics

Connectors and other external entities log any errors while accessing servers so that MySQL Fabric can monitor server health and act accordingly. For example, MySQL Fabric promotes a new master after receiving notifications from the number of clients configured in notification_clients) within the time interval configured in notification_interval. If a server is considered unstable but it is not a master, it is simply marked as faulty. To avoid making the system unstable, a new master can only be automatically promoted after the failover_interval has been elapsed since the last promotion. In order to ease the adoption of MySQL Fabric, a built-in failure detector is provided. If the failure detector is enabled to monitor a group, a new master is promoted after 3 failed successive attempts to access the current master within the time interval configured in failover_interval. The failure detection routine tries to connect to servers in a group and uses the value configured in detection_timeout as timeout.

prune_time

How often the internal event log is pruned, in seconds and also the age of events in the event log that is used to present statistics.

notifications

Number of issues before the server is considered unstable.

notification_clients

Number of different sources that should report issues on a server before it is considered unstable.

notification_interval

Amount of time in seconds that is used when deciding if a server is unstable. Issues older than this are not considered when deciding.

failover_interval

Minimum time in seconds between subsequent automatic promotions. This parameter is used to prevent the system entering a sequence of promotions that could disable the system.

detections

Number of successive failed attempts to contact the server after which the built-in failure detector considers the server unstable.

detection_timeout

Timeout in seconds used when contacting the server. If the server does not respond within this time period, it is recorded as a failed attempt to contact the server.

prune_time

Maximum age in seconds for reported issues in the error log. Issues older than this are removed from the error log.

8.2.3.3.10 Section failure_tracking

This section contains parameters for the failure management system.

notifications

The notification threshold. If more than this number of notifications arrive in the notification interval and the number of distinct notification clients are over the notification client threshold, the server is considered dead and failover is triggered.

notification_clients

The number of distinct notification clients that need to report. If more than this number of distinct notification clients are over the notification client threshold and the number of notifications above the notification threshold arrive in the notification interval, the server is considered dead and failover is triggered.

notification_interval

The notification interval in seconds. Only notifications arriving within this time frame can trigger a failover.

failover_interval

The minimum interval between failover operations in seconds. In order to avoid making the system unstable, failover operations are not triggered unless at least this much time has expired since the last failover.

detections

This parameter is for the built-in failure detector. If more than this number of failures to contact the server occurs during the detection interval, the server is considered unstable and a failover is triggered.

detection_interval

This parameter configures the detection interval for the built-in failure detector, in seconds.

detection_timeout

This parameter configures the detection timeout used when attempting to contact the servers in the group.

prune_time

This is the maximum age of events in the failure detector's error log and is also the interval for how often the error log is pruned.

8.2.3.3.11 Section connector

Connectors that are MySQL Fabric-aware contact MySQL Fabric to fetch information on groups, shards, and servers, and then cache the results locally for a time period to improve performance. This section contains configuration parameters passed to the connectors.

ttl

The Time To Live (TTL), measured in seconds, is passed together with other information to the connector. This is used by the connector to invalidate the caches, and reload them from a MySQL Fabric node, after the TTL has expired.


User Comments
Sign Up Login You must be logged in to post a comment.