Установка компонента Kintsugi agent (DBDA) (опциональный)#
Цель выполнения#
Установка компонента Kintsugi agent (DBDA) необходима в случае, если необходимо получать метрики хоста (CPU, память) и обнаруживать установленные СУБД (PostgreSQL) на том же хосте, где установлен агент.
Последовательность действий#
Установка компонента Kintsugi agent (DBDA) делится на этапы:
Ручная установка#
Для установки Kintsugi agent (DBDA) выполните следующие шаги из-под привилегированного пользователя:
Распакуйте содержимое архива
kgagent-std.tar.gz:unzip /path/to/standard/DBDA-bin-X.X.X-XX_std-distrib.zip && \ tar -xvf /path/to/standard/package/bh/kgagent-std.tar.gzСкопируйте пакет
kgagent-X.X.X-XX.x86_64.rpmна хост с наблюдаемой БД и выполните его установку:rpm -i /path/to/standard/kgagent-X.X.X-XX.x86_64.rpmЕсли используются самоподписанные сертификаты, скопируйте сертификаты agent.crt и root_cert.crt из
/path/to/standard/package/conf/conf/secrets/sslна хост с наблюдаемой БД в директорию/etc/kgagent.Выполните конфигурацию компонента kgagent:
Запустив
/etc/kgagent/configure.shи ответив на вопросы мастера установки:sudo /etc/kgagent/configure.sh Enter path to kgagent client certificate [kgagent.crt]: /Абсолютный/путь/к/agent.crt Enter path to root certificate [ca.crt]: /Абсолютный/путь/к/root_cert.crt Enter kintsugi host address [kintsugi.localhost]: ДОМЕН-ИЛИ-IP-АДРЕС-KINTSUGIВручную в файле
/etc/kgagent/config.yaml:Название
Значение
Описание
certificate.inmemory.path_to_client_cert/etc/kgagent/agent.crtПуть до файла сертификата
agent.crtcertificate.inmemory.path_to_root_cert/etc/kgagent/root_cert.crtПуть до файла сертификата удостоверяющего центра
auth.base_urlhttps://<KINTSUGI_ADDRESS>URL аутентификации
auth.api_path/Путь к ресурсу аутентификации
auth.header_client_certx-forwarded-client-certЗаголовок запроса с сертификатом технического пользователя
uploader.host<KINTSUGI_ADDRESS>Адрес хоста загрузки метрик
uploader.port443Порт хоста загрузки метрик
uploader.endpoint/agents/streamEndpoint для загрузки метрик
uploader.ssl_enabledtrueРежим работы SSL
metadata.hosts<OBSERVED_DB_HOST>Перечень адресов хостов наблюдаемых БД
luavm.entry_point/etc/kgagent/plugins/init.luaПуть к основному Lua-приложению, с которого начинается выполнение
luavm.std_libs["", "math", "string", "table", "io", "os", "package", "debug", "channel", "kgsys"]Список стандартных библиотек Lua, доступных в виртуальной машине. Пустая строка - базовые функции (
_G)luavm.memory_limit512Максимальный объем памяти (в МБ), выделяемый для Lua-машины
luavm.execution_timeout_sec300Максимальное время выполнения скрипта в секундах
luavm.path/etc/kgagent/pluginsДополнительные пути поиска Lua-приложению (аналог
package.path)Примечание
Для запуска компонента kgagent из конфигурации по умолчанию необходимо исключить конфигурацию внешнего хранилища секретов certificate.secman.
Выполните запуск компонента kgagent:
systemctl start kgagentУбедитесь, что запуск прошел штатно и журнал событий не содержит ошибок:
systemctl status kgagent journalctl -u kgagentВыполните вход в веб-интерфейс Kintsugi (DBCM) и на вкладке Метрики создайте объект мониторинга для заданной БД.
На дашборде Метрики отобразится информация по собранным метрикам хоста.
Настройка интеграций#
Настройка интеграции с системой управления секретами#
Для интеграции Kintsugi agent (DBDA) c HashiCorp Vault/Secret Management System (далее – SecMan) определите следующие параметры в файле /etc/kgagent/config.yml:
Параметр |
Пример |
Обязательный к заполнению параметр (Да / Нет) |
Описание |
|---|---|---|---|
|
|
Да |
Адрес хоста SecMan |
|
|
Да |
Путь к KV-хранилищу SecMan |
|
|
Да |
Пространство имен SecMan |
|
|
Да |
Цепочка доверенных удостоверяющих центров для установления безопасного соединения с SecMan |
|
|
Да |
Имя объекта, хранящего данные о сертификатах ТУЗ |
|
|
Да |
Имя объекта, хранящего данные о персональном сертификате ТУЗ |
|
|
Да |
Имя объекта, хранящего данные о цепочке доверенных удостоверяющих центров, для установления безопасного соединения с Kintsugi (DBCM) |
|
|
Да |
Адрес аутентификации Kintsugi agent в сервисе SecMan |
|
|
Да |
Идентификатор роли для аутентификации в сервисе SecMan |
|
|
Да |
Путь до файла с упакованным токеном. При старте сервиса из этого файла считывается упакованный токен для получения |
|
|
Да |
Ключ JSON-объекта, по которому будет получено значение токена |
|
|
Нет |
Время жизни упакованного токена в SecMan. Поддерживаемый формат: |
|
|
Нет |
Минимальное значение интервала обновления упакованного токена. Поддерживаемый формат: |
|
|
Нет |
Максимальное значение интервала обновления упакованного токена. Поддерживаемый формат: |
Настройка интеграции Kintsugi agent (DBDA) с системой Kintsugi (DBCM)#
Для настройки интеграции Kintsugi agent (DBDA) с системой Kintsugi (DBCM) определите следующие параметры в файле /etc/kgagent/config.yml:
Параметр |
Пример |
Обязательный к заполнению параметр (Да / Нет) |
Описание |
|---|---|---|---|
|
|
Нет |
Максимальное время (в секундах) ожидания штатного завершения работы подсистемы сервиса |
|
|
Нет |
Период (в секундах) проверки жизни подсистем сервиса |
|
|
Нет |
Максимальное время (в секундах), в течение которого сервис ожидает подтверждения работоспособности его подсистем |
|
|
Нет |
Максимальное время (в секундах) ожидания штатного завершения работы всего сервиса |
|
|
Да |
Путь к файлу персонального сертификата технической учетной записи (ТУЗ). Параметр используется при отсутствии интеграции с сервисом SecMan |
|
|
Да |
Путь к файлу цепочки сертификатов удостоверяющих центров. Параметр используется при отсутствии интеграции с сервисом SecMan |
|
|
Да |
Базовый URL для аутентификации Kintsugi agent в сервисе Kintsugi (DBCM) |
|
|
Да |
Точка подключения для аутентификации в сервисе Kintsugi (DBCM) |
|
|
Да |
Заголовок, содержащий данные об общем сертификате авторизации ТУЗ в сервисе Kintsugi (DBCM) |
|
|
Да |
Адрес хоста для отправки данных о метриках |
|
|
Да |
Порт agentway |
|
|
Да |
Адрес для отправки данных о метриках |
|
|
Нет |
Использование защищенного соединения с agentway |
|
|
Нет |
Период проверки WebSocket-соединения с agentway |
|
|
Нет |
Время ожидания ответа от agentway при проверке WebSocket-соединения |
|
|
Нет |
Минимальное значение (в секундах) попытки подключения к agentway |
|
|
Нет |
Максимальное значение (в секундах) попытки подключения к agentway |
|
|
Нет |
Период отправки собранной информации о БД |
|
|
Нет |
Период отправки собранных метрик |
|
|
Нет |
Максимальное количество сообщений, которое может быть сохранено одновременно в канале сообщений агента |
|
|
Нет |
Максимальное количество сообщений от agentway, которое может быть сохранено одновременно в канале системных сообщений |
|
|
Да |
Режим запуска скрипта поиска файлов СУБД PostgreSQL на хосте |
|
|
Да |
Команда запуска скрипта поиска файлов СУБД PostgreSQL на хосте |
|
|
Нет |
Размер буфера для сбора информации о БД |
|
|
Нет |
Период сбора информации о БД |
|
|
Да |
Уровень логирования |
|
|
Да |
Включение / отключение отправки логов в Fluent Bit |
|
|
Да |
Имя / IP-адрес хоста для сбора данных о метриках |
|
|
Нет |
Настройка таймзоны |
|
|
Да |
Путь до директории, где расположены логи PostgreSQL |
|
|
Да |
Формат строки логов. Значение необходимо взять из |
|
|
Нет |
Периодичность вывода общей статистики о доступном интервале данных лог-файлов в лог приложения |
|
|
Нет |
Периодичность освобождения ресурсов чтения лог-файлов (ридеров) |
|
|
Нет |
Периодичность запуска основного цикла обработки логов |
Проверка результата#
Для валидации установки Kintsugi agent (DBDA) убедитесь, что:
Выполнена установка Kintsugi agent (DBDA) на хосте с наблюдаемыми БД.
Выполнена интеграция Kintsugi agent (DBDA) с системой управления секретами.
Выполнена интеграция Kintsugi agent (DBDA) с системой Kintsugi (DBCM).