Настройка продвинутых параметров

В этом разделе описано, как работать с продвинутыми настройками клики. В веб-интерфейсе они находятся в разделе Advanced settings. Полный список продвинутых настроек приведён в разделе Продвинутые настройки.

Продвинутые настройки включают в себя:

• конфигурирование запросов в рамках клики — блок Query settings;
• конфигурирование серверных настроек — блок ClickHouse config;
• конфигурирование YT‑части инстансов — блок YT config;
• выделение памяти — блок Instance memory;
• кеширование запросов — блок Sticky query distribution.

Query settings

Параметры из раздела Query settings — это подмножество настроек сессии ClickHouse, которые будут применены для всех запросов в рамках клики.

Чтобы изменить поведение запроса, переопределите значения параметров по умолчанию с помощью:

ClickHouse config

Для управления конфигурацией ClickHouse-части предназначена настройка Clickhouse config. Задайте её так, чтобы она соответствовала стандартной XML-конфигурации ClickHouse.

Правила преобразования XML-конфигурации ClickHouse в YSON-конфигурацию CHYT можно описать следующим образом:

• Любой не множественный по смыслу в конфигурации ClickHouse узел конфигурации является словарём (map).
• Множественный узел представлен списком (list).

<foo>42</foo>
<bar>qwe</bar>
<baz>
    <quux>3.14</quux>
</baz>
<baz></baz>
<baz>hi!</baz>

{
    foo = 42;
    bar = "qwe";
    baz = [
        {quux = 3.14};
        {};
        "hi!";
    ];
}

Опции конфига ClickHouse, которые могут оказаться удобны в CHYT

Основная опция — это dictionaries — конфигурация внешних словарей. Значением должен быть список конфигураций словарей.
Каждый словарь конфигурируется map'ом со следующими полями, сохраняющими смысл оригинальной конфигурации ClickHouse:

• name — имя внешнего словаря;
• source — источник данных для внешнего словаря;
• layout — представление внешнего словаря в памяти инстанса;
• structure — схема данных, хранящихся в словаре;
• lifetime — время жизни словаря.

Остальные опции можно найти в конфиге ClickHouse в репозитории.

Как изменить конфигурацию ClickHouse

YT config

YT-часть конфигурации инстанса задаётся в опции yt_config. Через эту опцию можно задать продвинутые настройки, которые не вынесены в отдельные опции спеклета.

Вы можете посмотреть список доступных параметров YT-конфигурации в разделе Конфигурация инстанса.

Как изменить конфигурацию YT

Instance memory

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

Распределение памяти в инстансе CHYT

На схеме показано, как распределяется память внутри инстанса CHYT: из каких объёмов складывается общий лимит и какие пороги определяют поведение системы при нехватке памяти.

Ниже описан каждый параметр схемы — объёмы памяти, которые входят в общий лимит инстанса, и пороги:

• MaxServerMemoryUsage — общий лимит на используемую память в рамках инстанса CHYT, суммарный объём, который включает:

  • Reader — объём памяти, который выделяется под кеши ридеров для предварительной загрузки и ускорения чтения данных;

  • Caches — условное обозначение на схеме объёма памяти под кеши, в который входят:

    • CompressedBlockCache — кеш сжатых блоков данных. Вмещает большие объёмы, поскольку данные хранятся в сжатом виде (поведение по умолчанию), но требует время на повторную распаковку. Используется при перечитывании больших блоков данных;
    • UncompressedBlockCache — кеш для несжатых блоков данных. Полезен при большом количестве последовательных запросов к одним и тем же данным, потому что экономит ресурсы не только на чтении, но и на распаковке данных;
    • ChunkMetaCache — кеш метаданных чанков. Чтение метаданных чанка предшествует любой операции чтения. Полезно при повторном чтении данных, позволяет экономить ресурсы на получении одних и тех же метаданных;

  • CH Memory — специальный объём памяти, зарезервированный для внутренних нужд ClickHouse;

  • Footprint — специальный резервный «запас» памяти, который нужен, чтобы процесс мог превысить пороги и суммарно не вызвать превышение критических значений;

• MemoryLimit — условная жёсткая граница на RSS (потребление памяти) инстанса CHYT, которая используется для категорий WatchdogOomWatermark и WatchdogOomWindowWatermark;

• WatchdogOomWatermark — некоторый добавочный объём памяти, используется в проверках, не случился ли OOM: сумма текущего значения RSS и WatchdogOomWatermark сравнивается с заданным MemoryLimit;

• WatchdogOomWindowWatermark — некоторый добавочный объём памяти, используется в проверках, не случился ли OOM. Проверка выполняется по следующему алгоритму:

  • вычисляется среднее значение RSS во временном окне Window (15 минут по умолчанию);
  • к рассчитанному значению добавляется WatchdogOomWindowWatermark;
  • сумма сравнивается с заданным MemoryLimit.

• ClickHouseWatermark — добавочный объём памяти, чтобы отделить MaxServerMemoryUsage от общего MemoryLimit.

Критические области значений RSS (потребления памяти)

На шкале RSS на схеме распределения памяти цифрами отмечены критические области значений, при достижении которых система прерывает процесс.

Если объём физической оперативной памяти процесса достигает интервала:

• 1 (среднее значение RSS в течение более 15 минут превышает нижнюю границу интервала WatchdogOomWindowWatermark) — инстанс выполняет плавное завершение работы (graceful shutdown): прекращает принимать новые запросы, ждёт завершения активных и выключается;
• 2 (среднее значение RSS превышает нижнюю границу порога ClickHouseWatermark) — ClickHouse прекращает выделение памяти под любые операции, система сообщает о нехватке памяти;
• 3 (RSS превышает нижнюю границу интервала WatchdogOomWatermark) — инстанс резко прекращает работу, активные запросы завершаются ошибкой;
• 4 (RSS превышает MemoryLimit) — YTsaurus удаляет инстанс.

Как задать пороги памяти

Рекомендуем использовать веб-интерфейс:

1. Откройте интерфейс клики, как описано в разделе Как перейти в интерфейс клики.

2. Нажмите кнопку в блоке Кнопки действий или Edit speclet на вкладке Speclet на Панели вкладок.

3. Выберите слева раздел Advanced.

4. Найдите раздел Instance memory.

5. В поле Use JSON syntax введите параметры и их значения в виде JSON конфигурации. В качестве шаблона можно использовать пример конфигурации:

   {
       "clickhouse": 10500000000,
       "chunk_meta_cache": 100000000,
       "compressed_cache": 4000000000,
       "uncompressed_cache": null,
       "reader": 500000000,
       "clickhouse_watermark": 10,
       "watchdog_oom_watermark": 0,
       "watchdog_oom_window_watermark": 0,
       "footprint": 2000000000
   }
   

6. Чтобы применить изменения, нажмите кнопку Confirm.

Sticky query distribution

Продвинутые опции Enable sticky query distribution и Query sticky group size управляют распределением запросов по инстансам с учётом кеширования.

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

По умолчанию запросы распределяются по инстансам в случайном порядке. Чтобы перенаправить запросы на инстансы, где они выполнялись ранее и где хранится их кеш, используют настройки:

• Enable sticky query distribution — опция включает распределение запросов по инстансам с учётом хешей этих запросов;
• Query sticky group size — опция задаёт размер группы инстансов, выбранных детерминированно по хешу запроса. Среди этих инстансов будет равномерно выбран координатор для исполнения запроса. Имеет смысл только при включённой опции Enable sticky query distribution.

Как включить перенаправление запросов на инстансы с кешем

Рекомендуем использовать веб-интерфейс:

1. Откройте интерфейс клики, как описано в разделе Как перейти в интерфейс клики.
2. Нажмите кнопку в блоке Кнопки действий или Edit speclet на вкладке Speclet на Панели вкладок.
3. Выберите слева раздел Advanced.
4. Найдите опцию Enable sticky query distribution и включите её.
5. Найдите опцию Query sticky group size и в поле введите число — размер группы инстансов. Запрос будет случайно направлен координатором на один из инстансов группы.
6. Чтобы применить изменения, нажмите кнопку Confirm.