access_mode

Определяет, как MySQL Router обрабатывает запросы только для чтения и чтения/записи. Если включено, запросы только для чтения направляются на серверы только для чтения, а запросы чтения/записи — на серверы чтения/записи. См. Раздел 3.5, «Разделение чтения/записи».

wait_for_my_writes

Запросы только для чтения ожидают последнюю записанную транзакцию.

См. Раздел 3.5, «Разделение чтения/записи».

wait_for_my_writes_timeout

Максимальное время ожидания в секундах, пока назначение read_only применит записанную транзакцию, прежде чем вернуться к назначению read_write.

См. Раздел 3.5, «Разделение чтения/записи».

router_require_enforce

Если включено, MySQL Router извлекает значения, определенные в атрибуте router_requires пользователя в таблице.

Атрибут должен иметь следующий формат:

        {router_require: {value}}
      

Возможные значения:

event_source_name

Только для платформ Microsoft Windows. Определяет имя службы, используемое MySQL Router, когда он запущен как служба в Microsoft Windows. Это позволяет различать службы при запуске нескольких экземпляров MySQL Router и их сообщения в журнале событий.

Например:

[DEFAULT]
event_source_name = MySQLRouterService

logging_folder

Путь к каталогу файлов журнала MySQL Router. Файл журнала называется mysqlrouter.log, и он либо создается, либо к нему добавляется информация, если этот файл уже существует.

Установка logging_folder в пустое значение отправляет сообщения на консоль (stdout).

Пример, отправляющий журналы в /var/log/mysqlrouter/mysqlrouter.log:

[DEFAULT]
logging_folder = /var/log/mysqlrouter

Когда используется параметр загрузки --directory, созданный конфигурационный файл устанавливает его в $directory/log/.

plugin_folder

Путь к плагинам MySQL Router. Эта папка должна совпадать с каталогом установки MySQL Router. Вам следует устанавливать это только в случае пользовательской установки, где плагины находятся не в стандартном месте установки.

Значение по умолчанию: /usr/local/lib/mysqlrouter

runtime_folder

Путь к файлам времени выполнения MySQL Router.

Значение по умолчанию: /run/mysqlrouter

master-key-writer

Скрипт, который считывает главный ключ из STDIN. Устанавливается с помощью параметра загрузки командной строки --master-key-writer.

master-key-reader

Скрипт, который возвращает главный ключ в STDOUT. Устанавливается с помощью параметра загрузки командной строки --master-key-reader.

config_folder

Путь к конфигурационным файлам MySQL Router.

Значение по умолчанию: /usr/local/etc/mysqlrouter

sinks

Приемник(и) (различные методы ведения журнала), в которые отправляется определенный уровень журнала.

Поддерживаемые значения приемника: consolelog, filelog, eventlog (в Windows) и syslog (в системах на основе Unix). Используйте список, разделенный запятыми, чтобы определить несколько значений.

Значение по умолчанию: filelog, если параметр logging_folder не пуст в разделе "[DEFAULT]", иначе consolelog.

Например, чтобы настроить регистратор для использования файла, консоли и журнала событий, каждый из которых использует уровень журнала отладки, настроенный в разделе [logger]:

[logger]
level=debug
sinks=consolelog,eventlog,filelog

keyring_path

Указывает на расположение файла keyring.

Системная загрузка не добавляет этот параметр в сгенерированный конфигурационный файл и предполагает, что файл keyring находится в системном каталоге состояния времени выполнения. Если также используется --directory, то файл keyring хранится в каталоге состояния времени выполнения этого экземпляра, в run/ в указанном каталоге.

Если этот параметр не определен, используются системные пути по умолчанию.

Пример использования:

keyring_path = /opt/myrouter/data/keyring
master_key_path = /opt/myrouter/mysqlrouter.key

master_key_path

Расположение файла master key. Этот параметр позволяет автоматическое дешифрование, так как в противном случае его расположение запрашивается при запуске.

Если этот параметр не указан, используются системные пути по умолчанию.

Пример использования:

keyring_path = /opt/myrouter/data/keyring
master_key_path = /opt/myrouter/mysqlrouter.key

unknown_config_option

Определяет поведение MySQL Router при обработке неизвестных параметров конфигурации, таких как опечатки.

Поведение по умолчанию — предупреждение, а при загрузке оно определяется как ошибка в сгенерированном конфигурационном файле. Предупреждение регистрирует предупреждающее сообщение, но не останавливает работу, тогда как ошибка означает, что MySQL Router не может инициализироваться и завершает работу.

[DEFAULT]
unknown_config_option=warning

user (system)

Запустите mysqlrouter от имени пользователя с именем user_name или числовым идентификатором пользователя user_id. “Пользователь” в этом контексте относится к учетной записи входа в систему, а не к пользователю MySQL, указанному в таблицах прав доступа. Это также можно назначить во время выполнения с помощью параметра командной строки --user.

В Linux при установке Router с помощью официальных пакетов DEB или RPM создается локальный системный пользователь и группа с именем "mysqlrouter" на хосте, и MySQL Router запускается от имени этого пользователя по умолчанию. Эта учетная запись не имеет доступа к оболочке, а ее домашний каталог указывает на каталог, в котором хранится файл конфигурации по умолчанию.

Цель этого параметра — запуск MySQL Router от имени пользователя с ограниченными системными правами. Если пользователь не существует в системе или если предпринята попытка запустить Router от имени root, выводится сообщение об ошибке, и Router завершает работу.

MySQL Router может быть загружен и выполнен под любым пользователем операционной системы и не требует специальных привилегий, кроме прав чтения и записи в собственные файлы. К файлам, к которым он обращается, относятся плагины (чтение/выполнение), файл конфигурации, журналы, файлы сокетов домена UNIX (если включены) и многое другое.

По умолчанию файлы конфигурации и журналов записываются в общесистемное расположение, такое как /etc и /var/log. В качестве альтернативы, Router может быть загружен в собственный автономный каталог с помощью параметра --directory. Например:

$> sudo mysqlrouter --bootstrap localhost:3310 --directory /a/path/myrouter --user snoopy

В этом примере Router создает /a/path/myrouter и добавляет сюда все сгенерированные файлы и каталоги, и к ним имеет доступ только на запись системный пользователь snoopy. Кроме того, user определяется в сгенерированном конфигурационном файле /a/path/myrouter/mysqlrouter.conf:

[DEFAULT]
user=snoopy

ssl_ca

Путь к файлу SSL CA для проверки сертификата сервера при подключении к серверам метаданных.

Может быть опционально установлен с помощью параметра загрузки --ssl-ca.

ssl_capath

Путь к каталогу, содержащему файлы SSL CA для проверки сертификата сервера при подключении к серверам метаданных.

Может быть опционально установлен с помощью параметра загрузки --ssl-capath.

ssl_crl

Путь к файлу SSL CRL, который используется при подключении к серверам метаданных и проверке их сертификата SSL.

Может быть опционально установлен с помощью параметра загрузки --ssl-crl.

ssl_crlpath

Путь к каталогу, содержащему файлы SSL CRL, которые используются при подключении к серверам метаданных и проверке их сертификата SSL.

Может быть опционально установлен с помощью параметра загрузки --ssl-crlpath.

tls_version

Список версий TLS, разделенный запятыми, которые необходимо запросить, например, 'TLSv1.2,TLSv1.3', если включен SSL.

Может быть опционально установлен с помощью параметра загрузки --tls-version.

bind_address

Информация, связанная с дополнительным параметром bind_address:

Пример использования:

bind_address = 127.0.0.1:7001

bind_port

Необязательно, вы можете задать порт по умолчанию для bind_address с помощью bind_port. Если порт не настроен в bind_address, то bind_port является обязательным и используется.

Необязательно задайте эти значения, используя параметр запуска --conf-base-port.

Три примера ниже приводят к bind_address = 127.0.0.1:7001

[routing:example_1]
bind_port = 7001

[routing:example_2]
bind_port = 7001
bind_address = 127.0.0.1

[routing:example_3]
bind_address = 127.0.0.1:7001

socket

Сокеты включаются с помощью параметра socket, который можно указать с или без опций TCP bind_port и bind_address. Пример:

[routing]
socket = /tmp/mysqlrouter.sock
destinations = a.example.com:3306,b.example.com:3307

При запуске MySQL Router Router откажется от запуска, если файл сокета уже существует или в него нельзя записать.

Допустимы относительные пути, основанные на текущей рабочей директории, где запущен Router.

Router может одновременно прослушивать TCP сокеты и Unix-сокеты. Например, следующий пример конфигурации [routing] является допустимым и настраивает Router для прослушивания подключений как по localhost:1234, так и по /tmp/mysqlrouter.sock:

[routing:my_redirect]
bind_address = localhost:1234
socket = /tmp/mysqlrouter.sock
destinations = localhost:57121, localhost:57122, localhost:57123

protocol

Используется плагином маршрутизации при подключении к целевому серверу MySQL и может быть установлено на "classic" (по умолчанию) или "x" (протокол X).

Пример использования:

[routing:basic_failover]
bind_port = 7001
destinations = 10.20.200.1:33060, 10.20.200.2:33060
protocol = x

Параметр protocol также влияет на порт по умолчанию, используемый каждым целевым сервером. Если порт целевого сервера не настроен, то порт по умолчанию равен 3306 для "classic" (по умолчанию) или 33060 для "x" (протокол X).

pid_file

Устанавливает расположение файла PID. Это можно задать тремя способами (в порядке приоритета): параметром командной строки --pid-file, задав этот pid_file параметр в файле конфигурации Router или определив переменную окружения ROUTER_PID.

Если указан --bootstrap, то определения pid_file и ROUTER_PID игнорируются. Это отличается от параметра командной строки --pid-file, который приводит к ошибке Router.

Если --bootstrap не указан, то следующие причины приводят к ошибке Router: файл --pid-file уже существует, pid_file или ROUTER_PID заданы, но пусты, или Router не может записать файл PID.

connect_timeout

Значение таймаута, используемое MySQL Router при подключении к целевому серверу MySQL. Значение не может быть неограниченным, а некорректное значение приводит к ошибке конфигурации. Допустимый диапазон от 1 до 65536. Это значение следует держать низким.

Пример использования:

[routing]
connect_timeout = 5

Может быть задано при запуске с помощью --conf-set-option=routing.connect_timeout.

connect_timeout

Значение таймаута, используемое MySQL Router при подключении к метаданному серверу MySQL.

Пример использования:

[DEFAULT]
connect_timeout = 5

Может быть задано при запуске с помощью либо --connect-timeout, либо --conf-set-option=DEFAULT.connect_timeout.

read_timeout

Значение таймаута, используемое MySQL Router при чтении с метаданного сервера MySQL. Значение по умолчанию 30 секунд.

Пример использования:

[DEFAULT]
read_timeout = 30

destinations

Предоставляет информацию об хостах для установления подключений. Принимает либо список адресов целевых серверов через запятую, либо ссылку на кэш метаданных для InnoDB кластера.

Пример использования со списком конкретных хостов (статическая маршрутизация):

destinations = a.example.com,b.example.com,c.example.com

Пример использования с кэшем метаданных InnoDB кластера:

destinations=metadata-cache://mycluster/default?role=PRIMARY

Доступные URI параметры metadata-cache:

dynamic_state

Этот параметр отслеживает и хранит адреса активных серверов метаданных MySQL InnoDB Cluster и загружает их при перезапуске маршрутизатора. Эта функция активируется с помощью --bootstrap.

Инициализация определяет параметр dynamic_state в файле mysqlrouter.conf в разделе [DEFAULT]. Значение представляет собой путь к JSON-файлу с именем state.json, который создается после инициализации маршрутизатора. state.json инициализируется адресами серверов метаданных InnoDB Cluster и идентификатором группы репликации (group_replication_name, возвращаемый InnoDB Cluster); дополнительная информация добавляется и обновляется во время работы маршрутизатора.

Пример записи mysqlrouter.conf:

[DEFAULT]
dynamic_state=/opt/myrouter/data/state.json

Пример state.json, генерируемый --bootstrap:

{
    "metadata-cache": {
        "group-replication-id": "4b9e817a-0254-11e9-9cc0-080027bb5030",
        "cluster-metadata-servers": [
            "mysql://localhost:3310",
            "mysql://localhost:3320",
            "mysql://localhost:3330"
        ]
    },
    "version": "1.0.0"
}

routing_strategy

Стратегия маршрутизации определяет, как MySQL Router выбирает серверы MySQL для подключения.

Доступные стратегии:

Недоступные пункты назначения помещаются в карантин и пропускаются, и проверяются на доступность каждые error_quarantine_interval секунд. Все стратегии маршрутизации, кроме next-available, используют это поведение.

Значения по умолчанию и доступные комбинации role:

max_connections

Каждое маршрутизация может ограничивать количество маршрутов или соединений. Одним из возможных применений является предотвращение возможных атак типа «отказ в обслуживании» (DoS). Значение по умолчанию равно 512, а допустимый диапазон — от 1 до 65536.

Это аналогично переменной системы сервера.

[routing:mycluster_default_rw]
max_connections = 512

В качестве альтернативы, используйте более новый параметр конфигурации max_total_connections, который устанавливает одно значение для всех разделов маршрутизатора вместе.

Максимальное значение зависит как от ограничений опроса системы (или linux_epoll), так и от количества доступных ядер/потоков ЦП. См. также параметры конфигурации [IO] backend и threads.

Дополнительная установка max_connections в разделе [DEFAULT] устанавливает значение по умолчанию для каждого пункта назначения маршрутизации.

max_total_connections

Максимальное количество клиентских соединений, обрабатываемых маршрутизатором, чтобы предотвратить исчерпание дескрипторов файлов.

Это аналогично переменной системы сервера.

[DEFAULT]
max_total_connections = 512

Значение по умолчанию равно 512, и оно устанавливается в разделе [DEFAULT].

thread_stack_size

Размер стека, выделяемый для каждого потока. Он измеряется в килобайтах и по умолчанию равен 64.

[DEFAULT]
thread_stack_size=128

net_buffer_length

Устанавливает параметр сервера MySQL.

max_connect_errors

Значение по умолчанию равно 100, а допустимый диапазон — от 1 до 2^32 (4294967295, беззнаковое целое число).

Это аналогично переменной системы сервера.

Это может привести к небольшому снижению производительности, если приложение выполняет частые повторные подключения, поскольку MySQL Router пытается определить наличие ошибок, связанных с соединением.

Успешное соединение сбрасывает счетчик ошибок.

Каждое маршрутизация имеет свой собственный список заблокированных хостов. Заблокированные клиенты получают код ошибки сервера MySQL 1129 с немного другим сообщением об ошибке: «1129: Слишком много ошибок соединения от fail.example.com». Журналы Router содержат дополнительную информацию для заблокированных клиентов, например: INFO [...] 1 ошибка аутентификации для fail.example.com (максимум 100) WARNING [...] блокировка клиентского хоста fail.example.com

max_connect_errors = 100

client_connect_timeout

Это аналогично переменной серверной системы.

Значение по умолчанию равно 9, что на единицу меньше, чем значение по умолчанию для MySQL 5.7. Допустимый диапазон значений — от 2 до 31536000.

client_connect_timeout = 9

auth_cache_refresh_interval

Время (в секундах) между попытками обновления кэша авторизации. Значение по умолчанию — 2. Значение должно быть меньше, чем auth_cache_ttl, и больше, чем ttl, иначе маршрутизатор не запустится.

Этот параметр применяется, если параметр backend раздела http_auth_backend установлен в metadata_cache; это функция REST API маршрутизатора.

auth_cache_ttl

Время (в секундах), по истечении которого кэш становится недействительным, если он не обновляется. Значение по умолчанию — -1 (бесконечно). Значение должно быть больше, чем auth_cache_refresh_interval, и ttl, иначе маршрутизатор не запустится.

Этот параметр применяется, если параметр backend раздела http_auth_backend установлен в metadata_cache; это функция REST API маршрутизатора.

router_id

Идентификатор MySQL Router.

server_ssl_cert

Имя файла сертификата открытого ключа SSL в формате PEM. Он используется для обеспечения аутентификации на стороне сервера во время процесса загрузки.

server_ssl_key

Имя файла закрытого ключа SSL в формате PEM, используемого для шифрования соединений маршрутизатора с сервером. См. также Раздел 4.4, «Конфигурация TLS» .

server_ssl_curves

По умолчанию используется защищенный список кривых SSL. Отформатируйте эту строку как список имен кривых, разделенных двоеточием.

server_ssl_cipher

По умолчанию используется защищенный список шифров SSL. Отформатируйте эту строку как список имен шифров, разделенных двоеточием.

server_ssl_verify

Проверка сертификатов SSL, предоставляемых сервером маршрутизатору.

server_ssl_mode

Режим SSL-соединения, используемый при подключении между MySQL Router и сервером. См. также Раздел 4.4, «Конфигурация TLS» .

server_ssl_ca

Имя файла сертификата центра сертификации (ЦС) в формате PEM. Файл содержит список доверенных центров сертификации SSL. См. также Раздел 4.4, «Конфигурация TLS» .

server_ssl_capath

Имя каталога, содержащего доверенные файлы сертификатов центров сертификации SSL (ЦС) в формате PEM. См. также Раздел 4.4, «Конфигурация TLS» .

client_ssl_cert

Имя файла сертификата открытого ключа SSL в формате PEM. Он используется для обеспечения аутентификации на стороне клиента во время процесса загрузки.

Как и -client_ssl_key, этот параметр используется только во время загрузки, которая использует учетную запись root. Это полезно, когда учетная запись root была создана с REQUIRE X509, и поэтому для входа в систему как root требуется, чтобы клиент аутентифицировал себя.

server_ssl_crlpath

Путь к каталогу, содержащему файлы списка отзыва сертификатов в формате PEM. См. также Раздел 4.4, «Конфигурация TLS» .

server_ssl_crl

Путь к файлу, содержащему списки отзыва сертификатов в формате PEM. См. также Раздел 4.4, «TLS-настройка» .

client_ssl_key

Путь к файлу с закрытым ключом SSL в формате PEM, используемому для шифрования подключений «клиент-маршрутизатор». См. также Раздел 4.4, «TLS-настройка» .

client_ssl_dh_params

Имя файла параметров DH. Если указано и не пусто, то параметры DH из этого файла будут использоваться вместо внутренних параметров DH по умолчанию. Файл параметров DH должен быть в формате PEM.

client_ssl_curves

Допустимые кривые между клиентом и MySQL Router, по умолчанию используется безопасный список кривых SSL. Строка форматируется как список имён кривых, разделённых двоеточием.

client_ssl_cipher

Допустимые шифры между клиентом и MySQL Router, по умолчанию используется безопасный список шифров SSL. Строка форматируется как список имён шифров, разделённых двоеточием.

client_ssl_mode

Управляет обязательностью шифрования подключений от клиента к MySQL Router. См. также Раздел 4.4, «TLS-настройка» .

ssl_mode

Режим SSL для подключения к серверу метаданных MySQL. По умолчанию равен PREFERRED, если не задан.

При значении PREFERRED (по умолчанию) при запуске будет предупреждение, если SSL не используется и подключение к серверу метаданных не зашифровано.

Доступные значения: DISABLED, PREFERRED, REQUIRED, VERIFY_CA, и VERIFY_IDENTITY. Как и в клиенте mysql, регистр значения не важен.

Также есть параметр для запуска; см. --ssl-mode.

user (MySQL)

Сгенерированный пользователь MySQL с привилегиями для доступа к схеме метаданных сервера MySQL. Пароль этого пользователя сгенерирован автоматически и хранится в зашифрованном ключевом хранилище. По умолчанию ключ шифрования для этого хранилища хранится в защищённом файле главного ключа, который определён в конфигурационном файле. Чаще всего, этот пользователь и соответствующий пароль генерируются автоматически во время запуска. Связанные параметры командной строки: --force-password-validation и --password-retries. По умолчанию сгенерированный пароль проходит проверку на сложность STRONG.

Пароль полностью управляется Router и никогда не раскрывается, а хранится в локальной системе хранилищ ключей с использованием учётной записи операционной системы, под которой работает MySQL Router. Затем он может использоваться Router для подключения к InnoDB Cluster и получения текущей информации о топологии. Сессии между Router и сервером метаданных шифруются с помощью SSL по умолчанию.

Местоположение сгенерированных файлов хранилища ключей зависит от конфигурации запуска. При самодостаточных установках (когда используется --directory), оно хранится в run/ в каталоге самодостаточной установки. Для системных установок оно хранится в системном каталоге состояния во время работы, и этот путь специфичен для платформы. Дополнительную информацию см. в master_key_path и keyring_path

Этому пользователю назначены следующие привилегии:

Privileges needed by the Router account:

	On Metadata Server:

		SELECT ON mysql_innodb_cluster_metadata.*

	On Target Replica Sets:

		SELECT ON performance_schema.replication_group_members
		SELECT ON performance_schema.replication_group_member_stats

Сгенерированное имя пользователя имеет следующий шаблон: mysql_router_{router_id}_[0-9a-z]{7}, где {router_id} — числовой идентификатор маршрутизатора, а [0-9a-z]{7} — 7 случайных строчных буквенно-цифровых символов. Идентификатор маршрутизатора повторно используется, если он уже присутствует в mysqlrouter.conf, и его значение не может превышать 4294967295 (2^32-1).

metadata_cluster

Имя InnoDB Cluster.

use_gr_notifications

Включает уведомления о репликации групп. Когда эта функция включена, маршрутизатор асинхронно уведомляется о большинстве изменений кластера. Её можно включить вручную в mysqlrouter.conf или включить там же с помощью параметра командной строки --conf-use-gr-notifications во время загрузки.

Когда маршрутизатор получает любые из следующих уведомлений от Group Replication, он обновляет метаданные кластера:

Когда включена, функция уведомления Group Replication позволяет использовать более высокое значение ttl, поскольку обновления метаданных, выполняемые через интервалы ttl, становятся дополнительной защитой, а не основным средством поддержания актуальности информации о состоянии кластера. Когда отключена, рекомендуется использовать низкое значение ttl (например, 0,5 с, по умолчанию), чтобы избежать накладных расходов на повторное подключение к экземплярам и частый запрос изменений метаданных.

ttl

Время жизни (в секундах) информации в кэше метаданных.

Принимает целое или число с плавающей точкой. Шаг равен миллисекундам, где 0,001 эквивалентно одной миллисекунде. Точность усекается до поддерживаемого диапазона; например, TTL=0.0119 обрабатывается как 11 миллисекунд. Значение 0 означает, что модуль кэша метаданных постоянно запрашивает метаданные в цикле.

Значение должно быть меньше, чем auth_cache_refresh_interval и auth_cache_ttl, иначе маршрутизатор не запустится.

Единственным поддерживаемым десятичным разделителем является «.» (точка) независимо от локали, и поддерживается экспоненциальная запись, например TTL=1.6E-2.

destination

Направляет вывод консольного журнала в это устройство назначения; устанавливается в разделе [consolelog]. По умолчанию используется /dev/stderr, а пустое значение использует значение по умолчанию.

Доступные значения: /dev/stdout, /dev/stderr и /dev/null; или CON и NUL в Windows.

[DEFAULT]
logging_folder=

[consolelog]
destination=/dev/null

filename

Перенаправляет вывод журнала в определённый файл с именем filename, расположенный в каталоге logging_folder. Он должен быть определён как имя файла, а не путь к файлу, и работает как с разделами [logger], так и с [filelog].

Использование filename с [logger] для определения значения по умолчанию для раздела [filelog], а также изменяет файл журнала маршрутизатора с mysqlrouter.log на это новое значение.

[DEFAULT]
logging_folder=/path/to/logs/

[logger]
filename = router_error.log

Маршрутизатор не сообщает об ошибке, если filename установлен в [logger], но не используется ни один регистратор на основе файла.

Использование filename с [filelog]:

[DEFAULT]
logging_folder=/path/to/logs/

[filelog:a]
filename = a_router_error.log

[filelog:b]
filename = b_router_error.log

Если filename пуст или не установлен в [filelog], используется определение filename в [logger]; а если filename не установлен и в [logger], используется файл журнала по умолчанию (mysqlrouter.log).

Соответственно, перенаправление консольного вывода в /dev/null:

[DEFAULT]
logging_folder=

[consolelog]
destination=/dev/null

level

Используйте плагин logger для регистрации уведомлений, ошибок и информации для отладки. Доступные уровни журнала: DEBUG, NOTE, INFO (по умолчанию), WARNING, ERROR, SYSTEM и FATAL. Эти значения нечувствительны к регистру.

Уровень INFO отображает все информационные сообщения, предупреждения и сообщения об ошибках. Уровень DEBUG отображает дополнительную диагностическую информацию из кода маршрутизатора, включая успешные маршруты. SYSTEM включает сообщения, такие как сообщения о запуске.

[logger]
level = DEBUG

Поведение вывода зависит от параметра logging_folder. Установка logging_folder в папку сохраняет файл журнала с именем mysqlrouter.log в этой папке. Установка logging_folder в пустое значение или его отсутствие выводит журнал на консоль. Он устанавливается в разделе [DEFAULT].

Загрузка принимает конфигурационный файл с помощью --config и использует определение уровня журнала.

timestamp_precision

Точность метки времени журнала; доступные определения с примерами значений:

port

TCP-порт, прослушивающий HTTP-запросы; по умолчанию 8081.

bind_address

IP-адрес, привязанный к HTTP port; по умолчанию 0.0.0.0.

static_folder

Базовый каталог для запросов статических файлов; по умолчанию пустой. Пустое значение означает, что статические файлы не обслуживаются.

require_realm

Имя экземпляра [http_auth_realm].

ssl

Значение 1 включает SSL, а 0 отключает его. Требуются клиенты TLS, поддерживающие TLSv1.2 или более поздние версии. Это определяется в разделе [http_server].

ssl_cert

Имя файла сертификата и его цепочки сертификации в формате PEM; требуется, если ssl=1. Это определяется в разделе [http_server].

ssl_key

Имя файла ключа в формате PEM; требуется, если ssl=1. Это определяется в разделе [http_server].

ssl_cipher

Cipher-spec (см. список «ciphers» в openssl). По умолчанию используется разделенный запятыми список всех утвержденных шифров. Неизвестные шифры игнорируются без сообщений об ошибках. Возникает ошибка, если список шифров пуст и ssl=1. Это определяется в разделе [http_server].

ssl_dh_param

Прочитать параметр DH из этого файла в формате PEM. По умолчанию используется dh-param из RFC 5114, если ssl=1. Это определяется в разделе [http_server].

interval

Определяет частоту (в секундах), с которой MySQL Router отправляет сообщение keepalive ping. Общее количество пингов определяется параметром конфигурации runs.

[keepalive]
interval = 42
runs = 0

runs

Ограничивает количество интервалов, в течение которых MySQL Router отправляет сообщение keepalive ping. Установка значения 0 (по умолчанию) означает, что он выполняется до тех пор, пока MySQL Router не будет выключен. Частота определяется параметром interval.

[keepalive]
interval = 42
runs = 0

backend

Бэкэнд ввода-вывода, который обрабатывает асинхронные операции. Универсальный бэкэнд опроса доступен на всех платформах, в то время как каждая платформа может предоставлять альтернативные бэкэнды.

Доступные варианты: poll (все платформы) и linux_epoll (Linux). По умолчанию используется linux_epoll в Linux.

[io]
backend=linux_epoll
threads=32

threads

Количество потоков ввода-вывода, которые обрабатывают подключения.

По умолчанию 0 (использует все доступные ядра/потоки ЦП), но также принимает число от 1 до 1024. Во время выполнения система может ограничить верхний предел выше этого значения.

[io]
backend=linux_epoll
threads=32

connection_sharing_delay

Секунды ожидания, прежде чем неактивное серверное соединение станет доступно для повторного использования другим клиентским соединением.

См. Раздел 3.4, «Общий доступ к соединениям и повторное использование».

connection_sharing

Включать ли общий доступ к соединениям.

См. Раздел 3.4, «Общий доступ к соединениям и повторное использование».

idle_timeout

Количество секунд для хранения бездействующего соединения в пуле соединений перед его закрытием. Это значение устанавливается в разделе [connection_pool] и влияет на все маршруты в пуле соединений. По умолчанию равно 5, принимает значение от 1 до 4294967296.

max_idle_server_connections

Соединения, которые необходимо поддерживать открытыми в пуле соединений после отключения клиента; и устанавливается в разделе [connection_pool]. Значение по умолчанию равно 0, что отключает пул соединений.

client_ssl_session_cache_mode

Включает или отключает кэш для сеансов TLS клиент-роутер.

client_ssl_session_cache_size

Определяет максимальное количество кэшированных сеансов. Если добавление нового сеанса в кэш приводит к тому, что количество кэшированных сеансов превышает установленный максимум, самый старый кэшированный сеанс удаляется, чтобы разрешить кэширование самого нового.

client_ssl_session_cache_timeout

Определяет максимальное время, в секундах, в течение которого сеанс остается в кэше. Если время ожидания истекло, и этот сезон не используется повторно, сеанс удаляется из кэша, и соединение закрывается.

server_ssl_session_cache_mode

Включает или отключает кэш для сеансов TLS роутер-сервер.

server_ssl_session_cache_size

Определяет максимальное количество кэшированных сеансов. Если добавление нового сеанса в кэш приводит к тому, что количество кэшированных сеансов превышает установленный максимум, самый старый кэшированный сеанс удаляется, чтобы разрешить кэширование самого нового.

server_ssl_session_cache_timeout

Время в секундах до удаления сеансов TLS из кэша сеансов TLS сервера.

connect_retry_timeout

Если классическое соединение завершается неудачей с преходящей ошибкой, такой как max-connections reached, MySQL Router ожидает определенное количество секунд, прежде чем повторить попытку соединения. Попытка соединения повторяется в соответствии с определенной стратегией маршрутизации.

Если connect_retry_timeout не определено, по умолчанию используется 7 секунд. Если значение connect_retry_timeout определено за пределами допустимого диапазона значений, MySQL Router не запустится.

Если соединение завершается неудачей с преходящей ошибкой после успешной аутентификации, повторная попытка соединения возможна только в том случае, если соединение клиент-роутер зашифровано с помощью TLS или имеет открытый ключ.

backend

Имя раздела [http_auth_backend].

method

Метод HTTP-аутентификации; по умолчанию basic.

name

Имя области, представленное пользователю для аутентификации.

require

Требует, чтобы пользователь авторизовался через механизм аутентификации; по умолчанию значение valid-user, что включает эту проверку.

backend

Название реализации бэкенда; допустимые значения — file (по умолчанию) или metadata_cache.

[http_auth_backend:name]
backend=metadata_cache

[metadata_cache]
auth_cache_refresh_interval=2
auth_cache_ttl=-1

filename

Имя файла хранения бэкенда, относительно каталога data_folder.

cluster_type

Тип объекта AdminAPI, к которому был инициализирован маршрутизатор: InnoDB ReplicaSet (rs) или InnoDB Cluster (gr). Используйте 'gr' для кластеров.

Инициализация оценивает целевой экземпляр и устанавливает этот параметр соответствующим образом в сгенерированном конфигурационном файле.

error_quarantine_interval

Определяет интервал в секундах между проверками работоспособности изолированных целевых подключений. Если подключение возможно, целевой сервер удаляется из карантина и становится доступным.

Если задано недопустимое значение, MySQL Router не запускается, и об этом регистрируется ошибка.

Например:

        [destination_status]
         error_quarantine_threshold=5
         error_quarantine_interval=20
      

error_quarantine_threshold

Определяет порог последовательных неудачных попыток подключения к целевому серверу маршрутизации, прежде чем MySQL Router поместит этот сервер в карантин и прекратит его использование, пока он не будет освобождён механизмом карантина. Например, если установлено значение 5, целевой сервер помещается в карантин после 5 неудачных попыток подключения.

Если задано недопустимое значение, MySQL Router не запускается, и об этом регистрируется ошибка.

Например:

        [destination_status]
         error_quarantine_threshold=5
         error_quarantine_interval=20