Создание набора ресурсов для хранилища
Сервис хранилища в веб-интерфейсе KUMA создается на основе набора ресурсов для хранилища.
Чтобы создать набор ресурсов для хранилища в веб-интерфейсе KUMA:
- В веб-интерфейсе KUMA в разделе Ресурсы → Хранилища нажмите Добавить хранилище.
Откроется окно Создание хранилища.
- На вкладке Основные параметры в поле Название хранилища введите уникальное имя создаваемого сервиса. Имя должно содержать от 1 до 128 символов в кодировке Unicode.
- В раскрывающемся списке Тенант выберите тенант, которому будет принадлежать хранилище.
- В раскрывающемся списке Теги выберите теги для создаваемого набора ресурсов.
В списке отображаются все доступные теги, созданные в тенанте ресурса и тенанте Shared. Вы может найти тег в списке, начав вводить его название в поле. Если тега, который вы ввели, не существует, вы можете нажать Enter или Добавить, чтобы создать его.
- В поле Описание можно добавить описание сервиса: до 256 символов в кодировке Unicode.
- В поле Варианты условий хранения выберите для хранилища условие хранения событий в кластере ClickHouse, при выполнении которого события будут переноситься на диски холодного хранения или удаляться, если холодное хранение не настроено или настроено неверно. Условие будет применено к пространству по умолчанию и к событиям из удаленных пространств.
По умолчанию ClickHouse перемещает события на диски холодного хранения или удаляет их, если заполнено более 97% хранилища. В KUMA при создании хранилища также используется дополнительное условие хранения 365 дней. Вы можете настроить пользовательские условия хранения для более устойчивой работы хранилища.
Чтобы задать условие хранения, выполните одно из следующих действий:
- Если вы хотите ограничить срок хранения событий, в раскрывающемся списке выберите Дни и в поле укажите максимальный срок хранения событий в днях в кластере горячего хранилища ClickHouse.
По истечении указанного срока события будут автоматически перенесены на диски холодного хранения или удалены из кластера ClickHouse, начиная с партиций за самую старую дату. Минимальное значение – 1. Значение по умолчанию – 365.
- Если вы хотите ограничить максимальный размер хранилища, в раскрывающемся списке выберите ГБ и в поле укажите максимальный размер хранилища в гигабайтах.
Когда размер хранилища достигнет указанного значения, события будут автоматически перенесены на диски холодного хранения или удалены из кластера ClickHouse, начиная с партиций за самую старую дату. Минимальное значение и значение по умолчанию – 1.
- Если вы хотите ограничить размер хранилища относительно объема диска, который доступен хранилищу (по данным VictoriaMetrics), в раскрывающемся списке выберите Проценты и в поле укажите максимальный размер хранилища в процентах от доступного объема диска. В этом случае условие также может сработать при уменьшении доступного хранилищу объема диска.
Когда размер хранилища достигнет указанной доли от доступного ему размера диска, события будут автоматически перенесены на диски холодного хранения или удалены из кластера ClickHouse, начиная с партиций за самую старую дату. Допустимые значения – от 1 до 95. Значение по умолчанию – 80. Если вы хотите использовать проценты для всех пространств хранилища, сумма процентов в условиях всех пространств не может превышать 95, но рекомендуется указывать ограничение не более 90% включительно для всего хранилища или для отдельных пространств.
Мы не рекомендуем указывать малые значения процентов, так как в этом случае возрастает вероятность потери данных в хранилище.
Для хранилища [ООТВ] Storage по умолчанию установлен срок хранения событий 2 дня. Если вы хотите использовать это хранилище, при необходимости вы можете изменить для него условие хранения событий.
- Если вы хотите ограничить срок хранения событий, в раскрывающемся списке выберите Дни и в поле укажите максимальный срок хранения событий в днях в кластере горячего хранилища ClickHouse.
- Если вы хотите использовать дополнительное условие хранения, нажмите на кнопку Добавить условие хранения и укажите дополнительное условие хранения, как описано в пункте 6.
Вы можете добавить не более двух условий и сочетать только условия следующих типов:
- дни и размер хранилища в ГБ;
- дни и размер хранилища в процентах.
Если вы хотите удалить условие хранения, нажмите на значок крестика возле этого условия.
- В поле Срок хранения событий аудита укажите, в течение какого количества дней вы хотите хранить события аудита. Минимальное значение и значение по умолчанию:
365
. - При необходимости холодного хранения данных введите сроки хранения событий:
- Время хранения событий – общая длительность хранения событий в KUMA с момента поступления, в днях. По истечении указанного срока события будут автоматически удалены с диска холодного хранения. Значение по умолчанию – 0.
Время хранения событий рассчитывается как сумма времени хранения событий в кластере горячего хранилища ClickHouse до наступления условия, заданного в параметре Варианты условий хранения, и времени хранения событий на диске холодного хранения. После наступления одного из условий хранения партиция данных за самую старую дату перемещается на диск холодного хранения и находится там до истечения времени хранения событий в KUMA.
В зависимости от заданного условия хранения время хранения будет следующим:
- Если вы задали условие хранения в днях, значение параметра Время хранения событий должно быть строго больше количества дней, указанного в условии хранения. Вы можете рассчитать срок холодного хранения событий как Время хранения событий минус количество дней, указанное в параметре Варианты условий хранения.
Если вы не хотите хранить события на диске холодного хранения, в параметре Время хранения событий вы можете указать такое же количество дней, как в условии хранения.
- Если вы задали условие хранения в размере диска (точном или в процентах), минимальное значение параметра Время хранения событий – 1. Срок холодного хранения событий будет рассчитан как Время хранения событий минус количество дней с поступления события до момента выполнения условия и заполнения раздела диска, но до выполнения условия невозможно рассчитать точный срок. В этом случае рекомендуется указывать относительно большое значение параметра Время хранения событий, чтобы избежать удаления событий.
Если вы не хотите хранить события на диске холодного хранения, в параметре Время хранения событий вы можете указать значение 0.
- Если вы задали условие хранения в днях, значение параметра Время хранения событий должно быть строго больше количества дней, указанного в условии хранения. Вы можете рассчитать срок холодного хранения событий как Время хранения событий минус количество дней, указанное в параметре Варианты условий хранения.
- Срок холодного хранения событий аудита – количество дней хранения событий аудита. Минимальное значение – 0.
Параметры Время хранения событий и Срок холодного хранения событий аудита становятся доступны, только после того как вы добавили хотя бы один диск холодного хранения.
- Время хранения событий – общая длительность хранения событий в KUMA с момента поступления, в днях. По истечении указанного срока события будут автоматически удалены с диска холодного хранения. Значение по умолчанию – 0.
- При необходимости изменения параметров ClickHouse в поле Переопределение параметров ClickHouse вставьте строки c параметрами из XML-файла конфигурации ClickHouse /opt/kaspersky/kuma/clickhouse/cfg/config.xml. Указание корневых элементов <yandex>, </yandex> не требуется. Переданные в поле параметры конфигурации будут использоваться вместо параметров по умолчанию.
Пример:
<merge_tree>
<parts_to_delay_insert>600</parts_to_delay_insert>
<parts_to_throw_insert>1100</parts_to_throw_insert>
</merge_tree>
- С помощью переключателя Отладка укажите, будет ли включено логирование ресурса. Если вы хотите для всех компонентов KUMA регистрировать в журнале только ошибки, выключите отладку. Если вы хотите получать детализированные данные в журналах, включите отладку.
- При необходимости в разделе Узлы кластера ClickHouse добавьте в хранилище узлы кластера ClickHouse.
Узлов может быть несколько. Узлы можно добавить с помощью кнопки Добавить узел и удалить, нажав на значок крестика в блоке нужного узла.
Доступные параметры:
- В поле FQDN укажите полное доменное имя добавляемого узла. Например,
kuma-storage-cluster1-server1.example.com
.
- В поле FQDN укажите полное доменное имя добавляемого узла. Например,
- При необходимости в разделе Пространства добавьте в хранилище пространства, по которым вы хотите распределять хранимые события.
Пространств может быть несколько. Пространства можно добавить с помощью кнопки Добавить пространство и удалить, нажав на значок крестика в блоке нужного пространства.
Доступные параметры:
- В поле Название укажите название пространства: от 1 до 128 символов в кодировке Unicode.
- В поле Варианты условий хранения выберите для пространства условие хранения событий в кластере ClickHouse, при выполнении которого события будут переноситься на диски холодного хранения или удаляться, если холодное хранение не настроено или настроено неверно. В KUMA при добавлении пространства используется условие хранения 365 дней.
Чтобы задать условие хранения для пространства, выполните одно из следующих действий:
- Если вы хотите ограничить срок хранения событий, в раскрывающемся списке выберите Дни и в поле укажите максимальный срок хранения событий в днях в кластере горячего хранилища ClickHouse.
По истечении указанного срока события будут автоматически перенесены на диски холодного хранения или удалены из кластера ClickHouse, начиная с партиций за самую старую дату. Минимальное значение – 1. Значение по умолчанию – 365.
- Если вы хотите ограничить максимальный размер пространства хранилища, в раскрывающемся списке выберите ГБ и в поле укажите максимальный размер пространства в гигабайтах.
Когда размер пространства достигнет указанного значения, события будут автоматически перенесены на диски холодного хранения или удалены из кластера ClickHouse, начиная с партиций за самую старую дату. Минимальное значение и значение по умолчанию – 1.
- Если вы хотите ограничить размер пространства хранилища относительно объема диска, который доступен хранилищу (по данным VictoriaMetrics), в раскрывающемся списке выберите Проценты и в поле укажите максимальный размер пространства в процентах от объема диска, доступного хранилищу. В этом случае условие также может сработать при уменьшении доступного хранилищу объема диска.
Когда размер пространства достигнет указанной доли от объема диска, доступного хранилищу, события будут автоматически перенесены на диски холодного хранения или удалены из кластера ClickHouse, начиная с партиций за самую старую дату. Допустимые значения – от 1 до 95. Значение по умолчанию – 80. Если вы хотите использовать проценты для всех пространств хранилища, сумма процентов в условиях всех пространств не может превышать 95, но рекомендуется указывать ограничение не более 90% включительно для всего хранилища или для отдельных пространств.
Мы не рекомендуем указывать малые значения процентов, так как в этом случае возрастает вероятность потери данных в хранилище.
При использовании размера в качестве условия хранения требуется следить, чтобы суммарный размер пространств, указанный в условиях хранения не превышал физический размер хранилища, иначе при запуске сервиса отобразится ошибка.
В условиях хранения с ограничением размера для всех пространствах хранилища используйте одинаковые единицы изменения (только в гигабайтах или только в процентах). Иначе, если для одного пространства условие задано в процентах, а для другого в гигабайтах, хранилище может переполниться из-за несоответствия значений и данные будут потеряны.
- Если вы хотите ограничить срок хранения событий, в раскрывающемся списке выберите Дни и в поле укажите максимальный срок хранения событий в днях в кластере горячего хранилища ClickHouse.
- При необходимости сделать пространство неактивным в случае, если оно устарело и больше не является актуальным, установите флажок Только для чтения.
В этом случае новые события больше не будут попадать в пространство. Чтобы снова сделать пространство активным, снимите флажок Только для чтения. По умолчанию флажок снят.
- При необходимости в поле Время хранения событий укажите общую длительность хранения событий в KUMA с момента поступления, в днях. По истечении указанного срока события будут автоматически удалены с диска холодного хранения. Значение по умолчанию – 0.
Время хранения событий рассчитывается как сумма времени хранения событий в кластере горячего хранилища ClickHouse до наступления условия, заданного в параметре Варианты условий хранения, и времени хранения событий на диске холодного хранения. После наступления одного из условий хранения партиция данных за самую старую дату перемещается на диск холодного хранения и находится там до истечения времени хранения событий в KUMA.
В зависимости от заданного условия хранения время хранения будет следующим:
- Если вы задали условие хранения в днях, значение параметра Время хранения событий должно быть строго больше количества дней, указанного в условии хранения. Срок холодного хранения событий будет рассчитан как Время хранения событий минус количество дней, указанное в параметре Варианты условий хранения.
Если вы не хотите хранить события из этого пространства на диске холодного хранения, в параметре Время хранения событий вы можете указать такое же количество дней, как в условии хранения.
- Если вы задали условие хранения в размере диска (точном или в процентах), минимальное значение параметра Время хранения событий – 1. Срок холодного хранения событий будет рассчитан как Время хранения событий минус количество дней с поступления события до момента выполнения условия и заполнения раздела диска, но до выполнения условия невозможно рассчитать точный срок. В этом случае рекомендуется указывать относительно большое значение параметра Время хранения событий, чтобы избежать удаления событий.
Если вы не хотите хранить события из этого пространства на диске холодного хранения, в параметре Время хранения событий вы можете указать значение 0.
Параметр Время хранения событий становится доступен, только после того как вы добавили хотя бы один диск холодного хранения.
- Если вы задали условие хранения в днях, значение параметра Время хранения событий должно быть строго больше количества дней, указанного в условии хранения. Срок холодного хранения событий будет рассчитан как Время хранения событий минус количество дней, указанное в параметре Варианты условий хранения.
- В разделе Параметры фильтра можно задать условия определения событий, которые будут помещаться в это пространство. Чтобы создать фильтр, в раскрывающемся списке Фильтр выберите существующий фильтр или Создать.
После создания сервиса пространства можно просматривать и удалять в параметрах набора ресурсов хранилища.
Нет необходимости создавать отдельное пространство для событий аудита. События этого типа (Type=4) автоматически помещаются в отдельное пространство Audit со сроком хранения не менее 365 дней, которое недоступно для редактирования или удаления из веб-интерфейса KUMA.
- При необходимости в разделе Диски холодного хранения добавьте в хранилище диски, на которые вы хотите переносить события на длительное хранение из кластера ClickHouse.
Дисков может быть несколько. Диски можно добавить с помощью кнопки Добавить диск и удалить с помощью кнопки Удалить диск.
Доступные параметры:
- В раскрывающемся списке Полное доменное имя выберите тип доменного имени подключаемого диска:
- Локальный – для дисков, смонтированных в операционной системе как директории.
- HDFS – для дисков распределенной файловой системы Hadoop Distributed File System.
- В поле Название укажите название диска. Название должно содержать от 1 до 128 символов в кодировке Unicode.
- Если в качестве типа доменного имени диска вы выбрали Локальный, в поле Путь введите абсолютный путь директории смонтированного локального диска. Путь должен начинаться и оканчиваться символом "/".
- Если в качестве типа доменного имени диска вы выбрали HDFS, в поле Устройство введите путь к HDFS. Например:
hdfs://hdfs1:9000/clickhouse/
.
- В раскрывающемся списке Полное доменное имя выберите тип доменного имени подключаемого диска:
- Перейдите на вкладку Дополнительные параметры и заполните следующие поля:
- В поле Размер буфера укажите размер буфера в байтах, при достижении которого следует передать события в базу. Значение по умолчанию — 64 МБ. Максимального значения нет. Если на виртуальной машине меньше свободной памяти, чем заданное значение Размер буфера, KUMA установит ограничение в 128 МБ.
Если ожидаемый трафик на сервис хранилища будет больше 1 Гбит/сек, рекомендуется изменить значение параметра Размер буфера в байтах в соответствии с известным вам значением и указать значение параметра Интервал очистки буфера равное 2.
Значение параметра Размер буфера можно определить опытным путем. Если на метрике хранилища Insert QPS показатель превышает 1 и видно, что копится очередь запросов, воспользуйтесь рекомендациями по расчету и корректировке значения параметра Размер буфера, приведенными в статье Просмотр метрик KUMA в разделе Insert QPS.
- В поле Интервал очистки буфера укажите интервал в секундах, в течение которого KUMA будет ждать заполнения буфера. Если буфер не заполнен, но указанное время прошло, KUMA передает события в базу. Значение по умолчанию 1 с.
- В поле Ограничение размера дискового буфера укажите значение в байтах. Дисковый буфер используется для временного размещения тех событий, которые не удалось отправить для дальнейшей обработки или хранения. Если выделенное под дисковый буфер дисковое пространство исчерпано, события ротируются по следующему правилу: новые события замещают самые старые события, записанные в буфер. Значение по умолчанию: 10 ГБ.
- С помощью переключателя Дисковый буфер включите или выключите использование дискового буфера. По умолчанию дисковый буфер включен.
- С помощью переключателя Запись в локальную таблицу базы данных включите или выключите запись в локальную таблицу базы данных. По умолчанию запись выключена.
Если вы включите запись, она будет выполняться только на том узле, на котором установлено хранилище. Рекомендуется использовать эту функцию только при условии, что у вас настроена балансировка на коллекторе и/или корреляторе: в коллекторе и/или корреляторе на шаге 6. Маршрутизация в разделе Дополнительные настройки в поле Политика выбора URL установлено значение По очереди.
Если вы выключите запись, данные распределяются по шардам кластера.
- При необходимости с помощью переключателя Отладка включите логирование операций сервиса.
- Переключатель Периодическое создание дампа используется по запросу технической поддержки для генерации отчетов по потреблению ресурсов (cpu, ram и т.д.) в виде дампов.
- В поле Настройки дампа вы можете указать параметры создания дампа. Порядок заполнения этого поля уточняйте у технической поддержки.
- В поле Размер буфера укажите размер буфера в байтах, при достижении которого следует передать события в базу. Значение по умолчанию — 64 МБ. Максимального значения нет. Если на виртуальной машине меньше свободной памяти, чем заданное значение Размер буфера, KUMA установит ограничение в 128 МБ.
Набор ресурсов для хранилища создан и отображается в разделе Ресурсы → Хранилища. Теперь можно создать сервис хранилища.