Важно: Данный раздел актуален для Платформы данных On-Premise.
Раздел содержит описания настроек сервера, которые не могут изменяться на уровне сессии или запроса.
Рассмотренные настройки хранятся в файле config.xml сервера RT.WideStore.
Прочие настройки описаны в разделе «Настройки».
Перед изучением настроек ознакомьтесь с разделом Конфигурационные файлы, обратите внимание на использование подстановок (атрибуты incl и optional).
Интервал (в секундах) перезагрузки встроенных словарей.
RT.WideStore перезагружает встроенные словари с заданным интервалом. Это позволяет править словари «на лету» без перезапуска сервера.
Значение по умолчанию - 3600.
Пример:
<builtin_dictionaries_reload_interval>3600</builtin_dictionaries_reload_interval>Настройки компрессии данных.
ВНИМАНИЕ:
Лучше не использовать, если вы только начали работать с RT.WideStore.
Общий вид конфигурации:
<compression>
<case>
<min_part_size>...</min_part_size>
<min_part_size_ratio>...</min_part_size_ratio>
<method>...</method>
<level>...</level>
</case>
...
</compression>Поля блока <case>:
min_part_size - Минимальный размер части таблицы.min_part_size_ratio - Отношение размера минимальной части таблицы к полному размеру таблицы.method - Метод сжатия. Возможные значения: lz4, lz4hc, zstd,deflate_qpl.level – Уровень сжатия. См. Кодеки.Можно сконфигурировать несколько разделов <case>.
RT.WideStore проверяет условия для min_part_size и min_part_size_ratio и выполнит те блоки case, для которых условия совпали.
case, RT.WideStore использует первый совпавший блок условий.Если ни один <case> не подходит, то RT.WideStore применит алгоритм сжатия lz4.
Пример:
<compression incl="clickhouse_compression">
<case>
<min_part_size>10000000000</min_part_size>
<min_part_size_ratio>0.01</min_part_size_ratio>
<method>zstd</method>
<level>1</level>
</case>
</compression>Настраивает команду для получения ключа, используемого кодеками шифрования. Ключ (или несколько ключей) должен быть записан в переменные окружения или установлен в конфигурационном файле.
Ключи могут быть представлены в шестнадцатеричной или строковой форме. Их длина должна быть равна 16 байтам.
Пример:
Загрузка из файла конфигурации:
<encryption_codecs>
<aes_128_gcm_siv>
<key>12345567812345678</key>
</aes_128_gcm_siv>
</encryption_codecs>
Примечание:
Хранение ключей в конфигурационном файле не рекомендовано. Это не безопасно. Вы можете переместить ключи в отдельный файл на секретном диске и сделать symlink к этому конфигурационному файлу в папке `config.d/`.
Загрузка из файла конфигурации, когда ключ представлен в шестнадцатеричной форме:
<encryption_codecs>
<aes_128_gcm_siv>
<key_hex>00112233445566778899aabbccddeeff</key_hex>
</aes_128_gcm_siv>
</encryption_codecs>Загрузка ключа из переменной окружения:
<encryption_codecs>
<aes_128_gcm_siv>
<key_hex from_env="ENVVAR"></key_hex>
</aes_128_gcm_siv>
</encryption_codecs>Параметр current_key_id устанавливает текущий ключ для шифрования, и все указанные ключи можно использовать для расшифровки.
Все эти методы могут быть применены для нескольких ключей:
<encryption_codecs>
<aes_128_gcm_siv>
<key_hex id="0">00112233445566778899aabbccddeeff</key_hex>
<key_hex id="1" from_env="ENVVAR"></key_hex>
<current_key_id>1</current_key_id>
</aes_128_gcm_siv>
</encryption_codecs>Параметр current_key_id указывает текущий ключ для шифрования.
Также пользователь может добавить одноразовое случайное число длинной 12 байт (по умолчанию шифрование и дешифровка будут использовать одноразовое число длинной 12 байт, заполненное нулями):
<encryption_codecs>
<aes_128_gcm_siv>
<nonce>012345678910</nonce>
</aes_128_gcm_siv>
</encryption_codecs>Одноразовое число также может быть представлено в шестнадцатеричной форме:
<encryption_codecs>
<aes_128_gcm_siv>
<nonce_hex>abcdefabcdef</nonce_hex>
</aes_128_gcm_siv>
</encryption_codecs>Всё вышеперечисленное также применимо для алгоритма aes_256_gcm_siv (но ключ должен быть длиной 32 байта).
Список префиксов для пользовательских настроек. Префиксы должны перечисляться через запятую.
Пример:
<custom_settings_prefixes>custom_</custom_settings_prefixes>См. также:
Задает мягкое ограничение для размера файла дампа памяти.
Возможные значения:
Значение по умолчанию: 1073741824 (1 ГБ).
ПРИМЕЧАНИЕ:
Жесткое ограничение настраивается с помощью системных инструментов.
Пример:
<core_dump>
<size_limit>1073741824</size_limit>
</core_dump>Устанавливает задержку перед удалением табличных данных, в секундах. Если запрос имеет идентификатор SYNC, эта настройка игнорируется.
Значение по умолчанию: 480 (8 минут).
База данных по умолчанию.
Перечень баз данных можно получить запросом SHOW DATABASES.
Пример:
<default_database>default</default_database>Профиль настроек по умолчанию.
Профили настроек находятся в файле, указанном в параметре user_config.
Пример:
<default_profile>default</default_profile>Путь к таблице в ZooKeeper.
Пример:
<default_replica_path>/clickhouse/tables/{uuid}/{shard}</default_replica_path>Имя реплики в ZooKeeper.
Пример:
<default_replica_name>{replica}</default_replica_name>Путь к конфигурации внешних словарей.
Путь:
Смотрите также «Внешние словари».
Пример:
<dictionaries_config>*_dictionary.xml</dictionaries_config>Путь к файлу конфигурации для исполняемых пользовательских функций.
Путь:
Смотрите также “Исполняемые пользовательские функции”.
Пример:
<user_defined_executable_functions_config>*_function.xml</user_defined_executable_functions_config>Отложенная загрузка словарей.
Если true, то каждый словарь создаётся при первом использовании. Если словарь не удалось создать, то вызов функции, использующей словарь, сгенерирует исключение.
Если false, то все словари создаются при старте сервера, если словарь или словари создаются слишком долго или создаются с ошибкой, то сервер загружается без этих словарей и продолжает попытки создать эти словари.
По умолчанию - true.
Пример:
<dictionaries_lazy_load>true</dictionaries_lazy_load>Путь к каталогу со схемами для входных данных. Например со схемами для формата CapnProto.
Пример:
<!-- Directory containing schema files for various input formats. -->
<format_schema_path>format_schemas/</format_schema_path>Отправка данных в Graphite.
Настройки:
Можно определить несколько секций <graphite>, например, для передачи различных данных с различной частотой.
Пример:
<graphite>
<host>localhost</host>
<port>42000</port>
<timeout>0.1</timeout>
<interval>60</interval>
<root_path>one_min</root_path>
<metrics>true</metrics>
<events>true</events>
<events_cumulative>false</events_cumulative>
<asynchronous_metrics>true</asynchronous_metrics>
</graphite>Настройка прореживания данных для Graphite.
Подробнее читайте в разделе GraphiteMergeTree.
Пример:
<graphite_rollup_example>
<default>
<function>max</function>
<retention>
<age>0</age>
<precision>60</precision>
</retention>
<retention>
<age>3600</age>
<precision>300</precision>
</retention>
<retention>
<age>86400</age>
<precision>3600</precision>
</retention>
</default>
</graphite_rollup_example>Порт для обращений к серверу по протоколу HTTP(s).
Если указан https_port, то требуется конфигурирование openSSL.
Если указан http_port, то настройка openSSL игнорируется, даже если она задана.
Пример:
<https_port>9999</https_port>Страница, показываемая по умолчанию, при обращении к HTTP(s) серверу RT.WideStore. Значение по умолчанию «Ok.» (с переводом строки на конце).
Пример:
Показывает https://tabix.io/ при обращении к http://localhost:http_port.
<http_server_default_response>
<![CDATA[<html ng-app="SMI2"><head><base href="http://ui.tabix.io/"></head><body><div ui-view="" class="content-ui"></div><script src="http://loader.tabix.io/master.js"></script></body></html>]]>
</http_server_default_response>Срок действия HSTS в секундах. Значение по умолчанию 0 (HSTS выключен). Для включения HSTS задайте положительное число. Срок действия HSTS будет равен введенному числу.
Пример:
<hsts_max_age>600000</hsts_max_age>Путь к файлу с подстановками.
Подробности смотрите в разделе «Конфигурационные файлы».
Пример:
<include_from>/etc/metrica.xml</include_from>Ограничение по хостам, для обмена между серверами RT.WideStore. Если используется Keeper, то такое же ограничение будет применяться к обмену данными между различными экземплярами Keeper. Значение по умолчанию совпадает со значением параметра listen_host
Примеры:
<interserver_listen_host>::ffff:a00:1</interserver_listen_host>
<interserver_listen_host>10.0.0.1</interserver_listen_host>Порт для обмена между серверами RT.WideStore.
Пример:
<interserver_http_port>9009</interserver_http_port>Имя хоста, которое могут использовать другие серверы для обращения к этому хосту.
Если не указано, то определяется аналогично команде hostname -f.
Удобно использовать, чтобы отвязаться от конкретного сетевого интерфейса.
Пример:
<interserver_http_host>example.yandex.ru</interserver_http_host>Порт для обмена данными между репликами RT.WideStore по протоколу HTTPS.
Пример:
<interserver_https_port>9010</interserver_https_port>Имя хоста, которое могут использовать другие реплики для обращения к нему по протоколу HTTPS.
Пример:
<interserver_https_host>example.yandex.ru</interserver_https_host>Имя пользователя и пароль, использующиеся для подключения к другим серверам при репликации движками Replicated*. Сервер использует эти же учетные данные при аутентификации других реплик. Поэтому настройки interserver_http_credentials должны быть заданы одинаковыми для всех реплик кластера.
По умолчанию, если секция interserver_http_credentials не задана в конфигурации, аутентификация при репликации не используется.
Примечание:
Настройки `interserver_http_credentials` не относятся к конфигурации учетных данных клиента RT.WideStore.
Примечание:
Учетные данные в `interserver_http_credentials` являются общими для репликации по `HTTP` и `HTTPS`.
Раздел содержит следующие параметры:
user — имя пользователя.password — пароль.allow_empty — если true, то другие реплики могут подключаться без аутентификации, даже если учетные данные заданы. Если false, то подключение без аутентификации не допускается. Значение по умолчанию: false.old — секция содержит старые значения user и password, которые используются в процессе изменения учетных данных. Можно указывать несколько секций old.Изменение учетных данных
RT.WideStore поддерживает динамическое изменение учетных данных. При этом не требуется одновременно останавливать все реплики, чтобы обновить конфигурацию. Изменение учетных данных выполняется за несколько шагов.
Чтобы включить аутентификацию, установите interserver_http_credentials.allow_empty в значение true и задайте учетные данные. С такой конфигурацией разрешены подключения как с аутентификацией, так и без нее.
<interserver_http_credentials>
<user>admin</user>
<password>111</password>
<allow_empty>true</allow_empty>
</interserver_http_credentials>После конфигурации всех реплик установите allow_empty в значение false или удалите эту настройку. Это сделает аутентификацию с новыми учетными данными обязательной.
Чтобы изменить учетные данные, перенесите имя пользователя и пароль в секцию interserver_http_credentials.old и укажите новые значения для user и password. Сервер будет использовать новые учетные данные при подключении к другим репликам и при этом будет разрешать подключения как с новыми, так и со старыми учетными данными.
<interserver_http_credentials>
<user>admin</user>
<password>222</password>
<old>
<user>admin</user>
<password>111</password>
</old>
<old>
<user>temp</user>
<password>000</password>
</old>
</interserver_http_credentials>Когда новые учетные данные обновятся на всех репликах, старые учетные данные можно удалить из конфигурации.
Время в секундах, в течение которого RT.WideStore ожидает входящих запросов прежде чем закрыть соединение. Значение по умолчанию: 10 секунд.
Пример:
<keep_alive_timeout>10</keep_alive_timeout>Ограничение по хостам, с которых может прийти запрос. Если необходимо, чтобы сервер отвечал всем, то надо указать ::.
Примеры:
<listen_host>::1</listen_host><listen_host>127.0.0.1</listen_host>Бэклог (размер очереди соединений, ожидающих принятия) прослушивающего сокета.
Значение по умолчанию: 4096 (как в linux 5.4+).
Обычно это значение незачем менять по следующим причинам:
Так что даже если у вас TcpExtListenOverflows (из nstat) ненулевой и растет для сервера RT.WideStore, это не повод увеличивать значение по умолчанию, поскольку:
Пример:
<listen_backlog>4096</listen_backlog>Настройки логирования.
Ключи:
level - Уровень логирования. Допустимые значения: trace, debug, information, warning, error.log - Файл лога. Содержит все записи согласно level.errorlog - Файл лога ошибок.size - Размер файла. Действует для log и errorlog. Как только файл достиг размера size, RT.WideStore архивирует и переименовывает его, а на его месте создает новый файл лога.count - Количество заархивированных файлов логов, которые сохраняет RT.WideStore.Пример:
<logger>
<level>trace</level>
<log>/var/log/clickhouse-server/clickhouse-server.log</log>
<errorlog>/var/log/clickhouse-server/clickhouse-server.err.log</errorlog>
<size>1000M</size>
<count>10</count>
</logger>Также, существует поддержка записи в syslog. Пример настроек:
<logger>
<use_syslog>1</use_syslog>
<syslog>
<address>syslog.remote:10514</address>
<hostname>myhost.local</hostname>
<facility>LOG_LOCAL6</facility>
<format>syslog</format>
</syslog>
</logger>Ключи для syslog:
LOG_USER, LOG_DAEMON, LOG_LOCAL3 и прочие). Значения по умолчанию: при указанном address - LOG_USER, иначе - LOG_DAEMONbsd и syslogНастройки для отправки сообщений о сбоях в команду разработчиков ядра RT.WideStore через Sentry. Включение этих настроек, особенно в pre-production среде, может дать очень ценную информацию и поможет развитию RT.WideStore.
Сервер на котором включены данные настройки должен иметь доступ в Интернет по протоколу IPv4 (на момент написания документации IPv6 не поддерживается публичным облаком Sentry) для правильной работы данной функциональности.
Ключи:
enabled – Булевый флаг чтобы включить функциональность, по умолчанию false. Установите true чтобы разрешить отправку отчетов о сбоях.endpoint – Вы можете переопределить URL на который будут отсылаться отчеты об ошибках и использовать собственную инсталляцию Sentry. Используйте URL синтаксис Sentry DSN.anonymize - Запретить отсылку имени хоста сервера в отчете о сбое.http_proxy - Настройка HTTP proxy для отсылки отчетов о сбоях.debug - Настроить клиентскую библиотеку Sentry в debug режим.tmp_path - Путь в файловой системе для временного хранения состояния отчетов о сбоях перед отправкой на сервер Sentry.environment - Произвольное название среды, в которой запущен сервер RT.WideStore, которое будет упомянуто в каждом отчете от сбое. По умолчанию имеет значение test или prod в зависимости от версии RT.WideStore.Рекомендованные настройки
<send_crash_reports>
<enabled>true</enabled>
</send_crash_reports>Подстановки параметров реплицируемых таблиц.
Можно не указывать, если реплицируемые таблицы не используются.
Подробнее смотрите в разделе Создание реплицируемых таблиц.
Пример:
<macros incl="macros" optional="true" />Приблизительный размер (в байтах) кэша засечек, используемых движками таблиц семейства MergeTree.
Кэш общий для сервера, память выделяется по мере необходимости.
Пример:
<mark_cache_size>5368709120</mark_cache_size>Ограничивает объём оперативной памяти, используемой сервером RT.WideStore. Настройка может быть задана только для профиля default.
Возможные значения:
Значение по умолчанию: 0.
Дополнительная информация
Значение по умолчанию для max_server_memory_usage рассчитывается как memory_amount * max_server_memory_usage_to_ram_ratio.
См. также:
Определяет долю оперативной памяти, доступную для использования сервером RT.WideStore. Если сервер попытается использовать больше, предоставляемый ему объём памяти будет ограничен до расчётного значения.
Возможные значения:
Значение по умолчанию: 0.9.
Использование
На серверах с небольшим объёмом оперативной памяти и файла подкачки может потребоваться установить настройку max_server_memory_usage_to_ram_ratio в значение, большее 1.
Пример:
<max_server_memory_usage_to_ram_ratio>0.9</max_server_memory_usage_to_ram_ratio>См. также:
Определяет максимальное количество одновременно обрабатываемых запросов, связанных с таблицей семейства MergeTree. Запросы также могут быть ограничены настройками: max_concurrent_insert_queries, max_concurrent_select_queries, max_concurrent_queries_for_user, max_concurrent_queries_for_all_users, min_marks_to_honor_max_concurrent_queries.
ПРИМЕЧАНИЕ:
Параметры этих настроек могут быть изменены во время выполнения запросов и вступят в силу немедленно. Запросы, которые уже запущены, выполнятся без изменений.
Возможные значения:
Значение по умолчанию: 100.
Пример:
<max_concurrent_queries>100</max_concurrent_queries>Определяет максимальное количество одновременных INSERT запросов.
ПРИМЕЧАНИЕ:
Параметры этих настроек могут быть изменены во время выполнения запросов и вступят в силу немедленно. Запросы, которые уже запущены, выполнятся без изменений.
Возможные значения:
Значение по умолчанию: 0.
Пример:
<max_concurrent_insert_queries>100</max_concurrent_insert_queries>Определяет максимальное количество одновременных SELECT запросов.
ПРИМЕЧАНИЕ:
Параметры этих настроек могут быть изменены во время выполнения запросов и вступят в силу немедленно. Запросы, которые уже запущены, выполнятся без изменений.
Возможные значения:
Значение по умолчанию: 0.
Пример:
<max_concurrent_select_queries>100</max_concurrent_select_queries>Определяет максимальное количество одновременно обрабатываемых запросов, связанных с таблицей семейства MergeTree, для пользователя.
Возможные значения:
Значение по умолчанию: 0.
Пример:
<max_concurrent_queries_for_user>5</max_concurrent_queries_for_user>Если значение этой настройки меньше или равно текущему количеству одновременно обрабатываемых запросов, то будет сгенерировано исключение.
Пример: max_concurrent_queries_for_all_users установлен на 99 для всех пользователей. Чтобы выполнять запросы даже когда сервер перегружен, администратор баз данных устанавливает для себя значение настройки на 100.
Изменение настройки для одного запроса или пользователя не влияет на другие запросы.
Возможные значения:
Значение по умолчанию: 0.
Пример:
<max_concurrent_queries_for_all_users>99</max_concurrent_queries_for_all_users>Смотрите также:
Определяет минимальное количество засечек, считываемых запросом для применения настройки max_concurrent_queries.
Возможные значения:
Пример:
<min_marks_to_honor_max_concurrent_queries>10</min_marks_to_honor_max_concurrent_queries>Максимальное количество входящих соединений.
Пример:
<max_connections>4096</max_connections>Максимальное количество открытых файлов.
По умолчанию - maximum.
Рекомендуется использовать в Mac OS X, поскольку функция getrlimit() возвращает некорректное значение.
Пример:
<max_open_files>262144</max_open_files>Ограничение на удаление таблиц.
Если размер таблицы семейства MergeTree превышает max_table_size_to_drop (в байтах), то ее нельзя удалить запросом DROP.
Если таблицу все же необходимо удалить, не перезапуская при этом сервер RT.WideStore, то необходимо создать файл <clickhouse-path>/flags/force_drop_table и выполнить запрос DROP.
Значение по умолчанию - 50GB.
Значение 0 означает, что можно удалять все таблицы без ограничений.
Пример:
<max_table_size_to_drop>0</max_table_size_to_drop>RT.WideStore использует потоки из глобального пула потоков для обработки запросов. Если в пуле нет свободных потоков, то в нем создается еще один. Параметр max_thread_pool_size ограничивает максимальное количество потоков в пуле.
Возможные значения:
Значение по умолчанию: 10000.
Пример:
<max_thread_pool_size>12000</max_thread_pool_size>Если в глобальном пуле потоков количество свободных потоков больше, чем задано параметром max_thread_pool_free_size, то RT.WideStore освобождает ресурсы, занятые некоторыми потоками. В таком случае размер пула уменьшается. При необходимости потоки будут созданы заново.
Возможные значения:
Значение по умолчанию: 1000.
Пример:
<max_thread_pool_free_size>1200</max_thread_pool_free_size>Максимальное количество задач, которые запланированы для выполнения в глобальном пуле потоков. При увеличении этого параметра возрастает использование памяти. Рекомендуется, чтобы значение этого параметра совпадало со значением параметра max_thread_pool_size.
Возможные значения:
Значение по умолчанию: 10000.
Пример:
<thread_pool_queue_size>12000</thread_pool_queue_size>Задает количество потоков для выполнения фонового сброса данных в таблицах с движком Buffer.
Допустимые значения:
Значение по умолчанию: 16.
Задает количество потоков для фоновых перемещений кусков между дисками. Работает для таблиц с движком MergeTree.
Допустимые значения:
Значение по умолчанию: 8.
Задает количество потоков для выполнения фоновых задач. Работает для реплицируемых таблиц, стримов в Kafka и обновления IP адресов у записей во внутреннем DNS кеше.
Допустимые значения:
Значение по умолчанию: 128.
Задает количество потоков для скачивания кусков данных для реплицируемых таблиц. Для использования в продакшене с частыми небольшими вставками или медленным кластером ZooKeeper рекомендуется использовать значение по умолчанию.
Допустимые значения:
Значение по умолчанию: 8.
Задает количество потоков для выполнения фоновых задач. Работает для таблиц с движком Distributed.
Допустимые значения:
Значение по умолчанию: 16.
Задает количество потоков для фонового потокового вывода сообщений.
Допустимые значения:
Значение по умолчанию: 16.
Смотрите также:
Тонкая настройка таблиц семейства MergeTree.
Подробнее смотрите в заголовочном файле MergeTreeSettings.h.
Пример:
<merge_tree>
<max_suspicious_broken_parts>5</max_suspicious_broken_parts>
</merge_tree>Эта настройка включена по умолчанию. Если это не так, вы можете включить ее сами.
Включение
Чтобы вручную включить сбор истории метрик в таблице system.metric_log, создайте /etc/clickhouse-server/config.d/metric_log.xml следующего содержания:
<clickhouse>
<metric_log>
<database>system</database>
<table>metric_log</table>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
<collect_interval_milliseconds>1000</collect_interval_milliseconds>
</metric_log>
</clickhouse>Выключение
Чтобы отключить настройку metric_log , создайте файл /etc/clickhouse-server/config.d/disable_metric_log.xml следующего содержания:
<clickhouse>
<metric_log remove="1" />
</clickhouse>Тонкая настройка таблиц в ReplicatedMergeTree.
Эта настройка имеет более высокий приоритет.
Подробнее смотрите в заголовочном файле MergeTreeSettings.h.
Пример:
<replicated_merge_tree>
<max_suspicious_broken_parts>5</max_suspicious_broken_parts>
</replicated_merge_tree>Настройки клиента/сервера SSL.
Поддержку SSL обеспечивает библиотека libpoco. Описание интерфейса находится в файле SSLManager.h
Ключи настроек сервера/клиента:
privateKeyFile содержит сертификат.none, relaxed, strict, once.true, false. |ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH.sessionIdContext. Допустимые значения: true, false.SSL_MAX_SSL_SESSION_ID_LENGTH. Рекомендуется к использованию всегда, поскольку позволяет избежать проблем как в случае, если сервер кеширует сессию, так и если клиент затребовал кеширование. По умолчанию ${application.name}.true, false.true, false.true, false.true, false.<privateKeyPassphraseHandler>, <name>KeyFileHandler</name>, <options><password>test</password></options>, </privateKeyPassphraseHandler>.<invalidCertificateHandler> <name>ConsoleCertificateHandler</name> </invalidCertificateHandler>.Пример настройки:
<openSSL>
<server>
<!-- openssl req -subj "/CN=localhost" -new -newkey rsa:2048 -days 365 -nodes -x509 -keyout /etc/clickhouse-server/server.key -out /etc/clickhouse-server/server.crt -->
<certificateFile>/etc/clickhouse-server/server.crt</certificateFile>
<privateKeyFile>/etc/clickhouse-server/server.key</privateKeyFile>
<!-- openssl dhparam -out /etc/clickhouse-server/dhparam.pem 4096 -->
<dhParamsFile>/etc/clickhouse-server/dhparam.pem</dhParamsFile>
<verificationMode>none</verificationMode>
<loadDefaultCAFile>true</loadDefaultCAFile>
<cacheSessions>true</cacheSessions>
<disableProtocols>sslv2,sslv3</disableProtocols>
<preferServerCiphers>true</preferServerCiphers>
</server>
<client>
<loadDefaultCAFile>true</loadDefaultCAFile>
<cacheSessions>true</cacheSessions>
<disableProtocols>sslv2,sslv3</disableProtocols>
<preferServerCiphers>true</preferServerCiphers>
<!-- Use for self-signed: <verificationMode>none</verificationMode> -->
<invalidCertificateHandler>
<!-- Use for self-signed: <name>AcceptCertificateHandler</name> -->
<name>RejectCertificateHandler</name>
</invalidCertificateHandler>
</client>
</openSSL>Логирование событий, связанных с данными типа MergeTree. Например, события добавления или мержа данных. Лог можно использовать для симуляции алгоритмов слияния, чтобы сравнивать их характеристики. Также, можно визуализировать процесс слияния.
Запросы логируются не в отдельный файл, а в таблицу system.part_log. Вы можете изменить название этой таблицы в параметре table (см. ниже).
При настройке логирования используются следующие параметры:
database — имя базы данных;table — имя таблицы;partition_by — устанавливает произвольный ключ партиционирования. Нельзя использовать если используется engineengine - устанавливает настройки MergeTree Engine для системной таблицы. Нельзя использовать если используется partition_by.flush_interval_milliseconds — период сброса данных из буфера в памяти в таблицу.Пример:
<part_log>
<database>system</database>
<table>part_log</table>
<partition_by>toMonday(event_date)</partition_by>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
</part_log>Путь к каталогу с данными.
ОБРАТИТЕ ВНИМАНИЕ:
Завершающий слеш обязателен.
Пример:
<path>/var/lib/clickhouse/</path>Опубликовать данные о метриках, для сбора с помощью системы мониторинга Prometheus.
Настройки:
endpoint – путь по которому будет осуществляться экспорт данных метрик по HTTP протоколу для сбора с помощью prometheus. Должен начинаться с ‘/’.port – порт по которому будет доступен endpoint для сбора метрик.metrics – флаг для экспорта текущих значений метрик из таблицы system.metrics.events – флаг для экспорта текущих значений метрик из таблицы system.events.asynchronous_metrics – флаг для экспорта текущих значений значения метрик из таблицы system.asynchronous_metrics.Пример:
<prometheus>
<endpoint>/metrics</endpoint>
<port>8001</port>
<metrics>true</metrics>
<events>true</events>
<asynchronous_metrics>true</asynchronous_metrics>
</prometheus>Настройка логирования запросов, принятых с настройкой log_queries=1.
Запросы логируются не в отдельный файл, а в системную таблицу system.query_log. Вы можете изменить название этой таблицы в параметре table (см. ниже).
При настройке логирования используются следующие параметры:
database — имя базы данных;table — имя таблицы, куда будет записываться лог;partition_by — устанавливает произвольный ключ партиционирования. Нельзя использовать если используется engineengine - устанавливает настройки MergeTree Engine для системной таблицы. Нельзя использовать если используется partition_by.flush_interval_milliseconds — период сброса данных из буфера в памяти в таблицу.Если таблица не существует, то RT.WideStore создаст её. Если структура журнала запросов изменилась при обновлении сервера RT.WideStore, то таблица со старой структурой переименовывается, а новая таблица создается автоматически.
Пример:
<query_log>
<database>system</database>
<table>query_log</table>
<engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
</query_log>Настройка логирования потоков выполнения запросов, принятых с настройкой log_query_threads=1.
Запросы логируются не в отдельный файл, а в системную таблицу system.query_thread_log. Вы можете изменить название этой таблицы в параметре table (см. ниже).
При настройке логирования используются следующие параметры:
database — имя базы данных;table — имя таблицы, куда будет записываться лог;partition_by — устанавливает произвольный ключ партиционирования. Нельзя использовать если используется engineengine - устанавливает настройки MergeTree Engine для системной таблицы. Нельзя использовать если используется partition_by.flush_interval_milliseconds — период сброса данных из буфера в памяти в таблицу.Если таблица не существует, то RT.WideStore создаст её. Если структура журнала запросов изменилась при обновлении сервера RT.WideStore, то таблица со старой структурой переименовывается, а новая таблица создается автоматически.
Пример:
<query_thread_log>
<database>system</database>
<table>query_thread_log</table>
<partition_by>toMonday(event_date)</partition_by>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
</query_thread_log>Настройки логирования информации о зависимых представлениях (materialized, live и т.п.) в запросах принятых с настройкой log_query_views=1.
Запросы логируются в таблице system.query_views_log. Вы можете изменить название этой таблицы в параметре table (см. ниже).
При настройке логирования используются следующие параметры:
database – имя базы данных.table – имя системной таблицы, где будут логироваться запросы.partition_by — устанавливает произвольный ключ партиционирования. Нельзя использовать, если задан параметр engine.engine — устанавливает настройки MergeTree Engine для системной таблицы. Нельзя использовать, если задан параметр partition_by.flush_interval_milliseconds — период сброса данных из буфера в памяти в таблицу.Если таблица не существует, то RT.WideStore создаст её. Если структура журнала запросов изменилась при обновлении сервера RT.WideStore, то таблица со старой структурой переименовывается, а новая таблица создается автоматически.
Пример:
<query_views_log>
<database>system</database>
<table>query_views_log</table>
<partition_by>toYYYYMM(event_date)</partition_by>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
</query_views_log>Настройка логирования текстовых сообщений в системную таблицу text_log.
Параметры:
level — Максимальный уровень сообщения (по умолчанию Trace) которое будет сохранено в таблице.database — имя базы данных для хранения таблицы.table — имя таблицы, куда будут записываться текстовые сообщения.partition_by — устанавливает произвольный ключ партиционирования. Нельзя использовать если используется engineengine - устанавливает настройки MergeTree Engine для системной таблицы. Нельзя использовать если используется partition_by.flush_interval_milliseconds — период сброса данных из буфера в памяти в таблицу.Пример:
<clickhouse>
<text_log>
<level>notice</level>
<database>system</database>
<table>text_log</table>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
<!-- <partition_by>event_date</partition_by> -->
<engine>Engine = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_date + INTERVAL 30 day</engine>
</text_log>
</clickhouse>Настройки для trace_log system table operation.
Parameters:
database — Database for storing a table.table — Table name.partition_by — устанавливает произвольный ключ партиционирования. Нельзя использовать если используется engineengine - устанавливает настройки MergeTree Engine для системной таблицы. Нельзя использовать если используется partition_by.flush_interval_milliseconds — Interval for flushing data from the buffer in memory to the table.По умолчанию файл настроек сервера config.xml содержит следующие настройки:
<trace_log>
<database>system</database>
<table>trace_log</table>
<partition_by>toYYYYMM(event_date)</partition_by>
<flush_interval_milliseconds>7500</flush_interval_milliseconds>
</trace_log>Правила, основанные на регулярных выражениях, которые будут применены для всех запросов, а также для всех сообщений перед сохранением их в лог на сервере, system.query_log, system.text_log, system.processes таблицы, а также в логах, отсылаемых клиенту. Это позволяет предотвратить утечку конфиденциальных данных из SQL запросов (такие как имена, электронные письма, личные идентификаторы или номера кредитных карт) в логи.
Пример
<query_masking_rules>
<rule>
<name>hide SSN</name>
<regexp>(^|\D)\d{3}-\d{2}-\d{4}($|\D)</regexp>
<replace>000-00-0000</replace>
</rule>
</query_masking_rules>Параметры конфигурации:
name - имя правила (необязательно)regexp - совместимое с RE2 регулярное выражение (обязательное)replace - строка замены для конфиденциальных данных (опционально, по умолчанию - шесть звездочек)Правила маскировки применяются ко всему запросу (для предотвращения утечки конфиденциальных данных из неправильно оформленных / не интерпретируемых запросов).
system.events таблица содержит счетчик QueryMaskingRulesMatch который считает общее кол-во совпадений правил маскировки.
Для распределенных запросов каждый сервер должен быть сконфигурирован отдельно, иначе, подзапросы, переданные на другие узлы, будут сохраняться без маскировки.
Конфигурация кластеров, которые использует движок таблиц Distributed и табличная функция cluster.
Пример:
<remote_servers incl="clickhouse_remote_servers" />Значение атрибута incl смотрите в разделе «Конфигурационные файлы».
Смотрите также:
Временная зона сервера.
Указывается идентификатором IANA в виде часового пояса UTC или географического положения (например, Africa/Abidjan).
Временная зона необходима при преобразованиях между форматами String и DateTime, которые возникают при выводе полей DateTime в текстовый формат (на экран или в файл) и при получении DateTime из строки. Также, временная зона используется в функциях, которые работают со временем и датой, если они не получили временную зону в параметрах вызова.
Пример:
<timezone>Europe/Moscow</timezone>Порт для взаимодействия с клиентами по протоколу TCP.
Пример:
<tcp_port>9000</tcp_port>TCP порт для защищённого обмена данными с клиентами. Используйте с настройкой OpenSSL.
Возможные значения
Положительное целое число.
Значение по умолчанию
<tcp_port_secure>9440</tcp_port_secure>Порт для взаимодействия с клиентами по протоколу MySQL.
Возможные значения
Положительное целое.
Пример:
<mysql_port>9004</mysql_port>Путь ко временным данным для обработки больших запросов.
ОБРАТИТЕ ВНИМАНИЕ:
Завершающий слеш обязателен.
Пример:
<tmp_path>/var/lib/clickhouse/tmp/</tmp_path>Политика из storage_configuration для хранения временных файлов.
Если политика не задана, используется tmp_path. В противном случае tmp_path игнорируется.
ПРИМЕЧАНИЕ:
move_factorигнорируется.keep_free_space_bytesигнорируется.max_data_part_size_bytesигнорируется.- В данной политике должен быть ровно один том, содержащий только локальный диски.
Размер кеша (в байтах) для несжатых данных, используемых движками таблиц семейства MergeTree.
Кеш единый для сервера. Память выделяется по требованию. Кеш используется в том случае, если включена опция use_uncompressed_cache.
Несжатый кеш выгодно использовать для очень коротких запросов в отдельных случаях.
Пример:
<uncompressed_cache_size>8589934592</uncompressed_cache_size>Каталог с пользовательскими файлами. Используется в табличной функции file().
Пример:
<user_files_path>/var/lib/clickhouse/user_files/</user_files_path>Каталог с файлами пользовательских скриптов. Используется для исполняемых пользовательских функций Executable User Defined Functions.
Пример:
<user_scripts_path>/var/lib/clickhouse/user_scripts/</user_scripts_path>Каталог с определенными пользователем файлами. Используется для пользовательских SQL функций SQL User Defined Functions.
Пример:
<user_defined_path>/var/lib/clickhouse/user_defined/</user_defined_path>Путь к файлу, который содержит:
Пример:
<users_config>users.xml</users_config>Содержит параметры, позволяющие RT.WideStore взаимодействовать с кластером ZooKeeper.
RT.WideStore использует ZooKeeper для хранения метаданных о репликах при использовании реплицированных таблиц. Если реплицированные таблицы не используются, этот раздел параметров может отсутствовать.
Раздел содержит следующие параметры:
node — адрес ноды (сервера) ZooKeeper. Можно сконфигурировать несколько нод.
Например:
<node index="1">
<host>example_host</host>
<port>2181</port>
</node>
Примечание:
Атрибут `index` задает порядок опроса нод при попытках подключиться к кластеру ZooKeeper.
session_timeout_ms — максимальный таймаут клиентской сессии в миллисекундах.operation_timeout_ms — максимальный таймаут для одной операции в миллисекундах.root — znode, который используется как корневой для всех znode, которые использует сервер RT.WideStore. Необязательный.identity — пользователь и пароль, которые может потребовать ZooKeeper для доступа к запрошенным znode. Необязательный.Пример конфигурации:
<zookeeper>
<node>
<host>example1</host>
<port>2181</port>
</node>
<node>
<host>example2</host>
<port>2181</port>
</node>
<session_timeout_ms>30000</session_timeout_ms>
<operation_timeout_ms>10000</operation_timeout_ms>
<!-- Optional. Chroot suffix. Should exist. -->
<root>/path/to/zookeeper/node</root>
<!-- Optional. Zookeeper digest ACL string. -->
<identity>user:password</identity>
</zookeeper>Смотрите также:
Способ хранения заголовков кусков данных в ZooKeeper.
Параметр применяется только к семейству таблиц MergeTree. Его можно установить:
Глобально в разделе merge_tree файла config.xml.
RT.WideStore использует этот параметр для всех таблиц на сервере. Вы можете изменить настройку в любое время. Существующие таблицы изменяют свое поведение при изменении параметра.
Для каждой отдельной таблицы.
При создании таблицы укажите соответствующую настройку движка. Поведение существующей таблицы с установленным параметром не изменяется даже при изменении глобального параметра.
Возможные значения:
Если use_minimalistic_part_header_in_zookeeper = 1, то реплицированные таблицы хранят заголовки кусков данных в компактном виде, используя только одну znode. Если таблица содержит много столбцов, этот метод хранения значительно уменьшает объём данных, хранящихся в Zookeeper.
Внимание:
После того как вы установили `use_minimalistic_part_header_in_zookeeper = 1`, невозможно откатить RT.WideStore до версии, которая не поддерживает этот параметр. Будьте осторожны при обновлении RT.WideStore на серверах в кластере. Не обновляйте все серверы сразу. Безопаснее проверять новые версии RT.WideStore в тестовой среде или только на некоторых серверах кластера. Заголовки частей данных, ранее сохранённые с этим параметром, не могут быть восстановлены в их предыдущем (некомпактном) представлении.
Значение по умолчанию: 0.
Отключает внутренний кеш DNS записей. Используется при эксплуатации RT.WideStore в системах с часто меняющейся инфраструктурой, таких как Kubernetes.
Значение по умолчанию: 0.
Период обновления IP адресов у записей во внутреннем DNS кеше RT.WideStore (в секундах). Обновление выполняется асинхронно, отдельным системным потоком.
Значение по умолчанию: 15.
Смотрите также:
Управление запуском распределенных ddl запросов (CREATE, DROP, ALTER, RENAME) в кластере. Работает только если разрешена работа с ZooKeeper.
Пример:
<distributed_ddl>
<!-- Путь в ZooKeeper для очереди содержащей DDL запросы -->
<path>/clickhouse/task_queue/ddl</path>
<!-- Настройки из этого профиля будут использованы для запуска DDL запросов -->
<profile>default</profile>
<!-- Контроль того как много ON CLUSTER запросов могут исполняться одновременно. -->
<pool_size>1</pool_size>
<!-- Настройки очистки (активные задачи в очереди не будут удаляться) -->
<!-- Время TTL для задач в секундах (по умолчанию 1 week) -->
<task_max_lifetime>604800</task_max_lifetime>
<!-- Как часто будет запускаться очистка данных (в секундах) -->
<cleanup_delay_period>60</cleanup_delay_period>
<!-- Как много задач может быть в очереди -->
<max_tasks_in_queue>1000</max_tasks_in_queue>
</distributed_ddl>Путь к каталогу, где сервер RT.WideStore хранит конфигурации пользователей и ролей, созданные командами SQL.
Значение по умолчанию: /var/lib/clickhouse/access/.
Смотрите также:
Секция конфигурационного файла,которая содержит настройки:
Если эта секция определена, путь из users_config и access_control_path не используется.
Секция user_directories может содержать любое количество элементов, порядок расположения элементов обозначает их приоритет (чем выше элемент, тем выше приоритет).
Примеры:
<user_directories>
<users_xml>
<path>/etc/clickhouse-server/users.xml</path>
</users_xml>
<local_directory>
<path>/var/lib/clickhouse/access/</path>
</local_directory>
</user_directories>Пользователи, роли, политики доступа к строкам, квоты и профили могут храниться в ZooKeeper:
<user_directories>
<users_xml>
<path>/etc/clickhouse-server/users.xml</path>
</users_xml>
<replicated>
<zookeeper_path>/clickhouse/access/</zookeeper_path>
</replicated>
</user_directories>Также вы можете добавить секции memory — означает хранение информации только в памяти, без записи на диск, и ldap — означает хранения информации на LDAP-сервере.
Чтобы добавить LDAP-сервер в качестве удаленного каталога пользователей, которые не определены локально, определите один раздел ldap со следующими параметрами:
server — имя одного из LDAP-серверов, определенных в секции ldap_servers конфигурационного файла. Этот параметр является необязательным и может быть пустым.roles — раздел со списком локально определенных ролей, которые будут назначены каждому пользователю, полученному с LDAP-сервера. Если роли не заданы, пользователь не сможет выполнять никаких действий после аутентификации. Если какая-либо из перечисленных ролей не определена локально во время проверки подлинности, попытка проверки подлинности завершится неудачей, как если бы предоставленный пароль был неверным.Пример:
<ldap>
<server>my_ldap_server</server>
<roles>
<my_local_role1 />
<my_local_role2 />
</roles>
</ldap>Задает размер памяти (в байтах) для трассировки стека на каждом шаге выделения максимума памяти. Данные хранятся в системной таблице system.trace_log с query_id, равным пустой строке.
Возможные значения:
Значение по умолчанию: 4194304.
Позволяет собирать случайные выделения и освобождения памяти и записывать их в системную таблицу system.trace_log с trace_type, равным MemorySample, с указанной вероятностью. Вероятность касается каждого выделения или освобождения памяти, независимо от размера выделения. Обратите внимание, что выборка происходит только тогда, когда объем неотслеживаемой памяти превышает лимит неотслеживаемой памяти (значение по умолчанию: 4 MiB). Значение настройки может быть уменьшено, если значение настройки total_memory_profiler_step уменьшено. Вы можете установить значение настройки total_memory_profiler_step, равным 1, для особой детализованной выборки.
Возможные значения:
system.trace_log отключена.Значение по умолчанию: 0.
Задает размер кеша (в байтах) для сопоставленных файлов. Эта настройка позволяет избежать частых открытых/mmap/munmap/закрытых вызовов (очень дорогостоящие из-за последующих ошибок страниц) и повторного использования сопоставления из нескольких потоков и запросов. Значение настройки — это количество сопоставленных областей (обычно равно количеству сопоставленных файлов). Объем данных в сопоставленных файлах можно отслеживать в системных таблицах system.metrics, system.metric_log по метрикам MMappedFiles и MMappedFileBytes, в таблицах system.asynchronous_metrics, system.asynchronous_metrics_log по метрике MMapCacheCells, а также в system.events, system.processes, system.query_log, system.query_thread_log, system.query_views_log по событиям CreatedReadBufferMMap, CreatedReadBufferMMapFailed, MMappedFileCacheHits, MMappedFileCacheMisses. Обратите внимание, что объем данных в сопоставленных файлах не потребляет память напрямую и не учитывается в запросе или использовании памяти сервера, поскольку эта память может быть удалена аналогично кешу страниц ОС. Кеш удаляется (т.е. файлы закрываются) автоматически при удалении старых кусков в таблицах семейства MergeTree, также его можно удалить вручную с помощью запроса SYSTEM DROP MMAP CACHE.
Возможные значения:
Значение по умолчанию: 1000.
Задает размер кеша (в байтах) для скомпилированных выражений.
Возможные значения:
Значение по умолчанию: 134217728.
Задает размер кеша (в элементах) для скомпилированных выражений.
Возможные значения:
Значение по умолчанию: 10000.