Утилита config_editor

config_editor — утилита с псевдографическим текстовым интерфейсом, предназначенная для просмотра и изменения параметров подсистемы мониторинга, хранящихся в etcd.

Исполняемый файл утилиты располагается по пути /opt/skala-r/vision/tools/config_editor.

По умолчанию для подключения к etcd утилита использует учётные данные, указанные в файле /opt/skala-r/etc/vision/server/vision_core/etcd.yml. Чтобы использовать другой файл с учётными данными, при запуске утилиты укажите полный путь к нему в значении аргумента --common.config.file.

Вкладки

Вкладка Префиксы etcd Описание

Параметры системы мониторинга

/vision/config/

Редактирование конфигурации Сервера подсистемы мониторинга

Конфиги сервисов

/vision/services/

Просмотр сгенерированных конфигураций компонентов

Секреты

/vision/secrets

Редактирование секретов

Версия

/vision/version

Просмотр сведений о версии подсистемы мониторинга

Управление в интерфейсе

config_editor управляется с клавиатуры. В левой части окна выводится дерево ключей выбранной вкладки, в правой — значение выделенного ключа.

Клавиша Действие

?

Показать или скрыть справку по клавишам

Tab, Shift+Tab

Перейти к следующей или предыдущей вкладке

↑, k

Перейти к предыдущему элементу выбранного раздела

↓, j

Перейти к следующему элементу выбранного раздела

←, h

Перейти к родительскому элементу

→, l

Перейти к дочерним элементам

Пробел

Развернуть или свернуть узел дерева

e, Enter

Редактировать значение ключа

n

Создать ключ

d

Удалить ключ

u

Отменить изменения выделенного ключа

r

Обновить данные из etcd, не сбрасывая несохранённые изменения

s

Сохранить изменения

q

Выйти из config_editor

Изменённые, новые и удалённые ключи отмечаются в дереве метками [изм], [нов] и [уд] соответственно.

Пока изменения не сохранены, в правом верхнем углу окна выводится надпись несохранённые изменения.

Редактирование ключей

Для изменения значений config_editor использует редактор, указанный в переменной окружения EDITOR. Если она не задана, используется редактор vi.

Чтобы отменить изменения ключа, нажмите u.

Для редактирования ключей с префиксом /vision/secrets необходимо, чтобы утилита ansible-vault размещалась в одном из каталогов, перечисленных в значении переменной окружения PATH.

Сохранение конфигурации

Изменения при редактировании, создании и удалении ключей накапливаются до сохранения.

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

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

  • --core.endpoint — адрес Сервера подсистемы мониторинга;

  • --core.check-path — путь к маршруту проверки конфигурации;

  • --core.reload-path — путь к маршруту перезапуска конфигурации;

  • --core.skip-check — пропуск шага проверки;

  • --core.skip-reload — пропуск шага перезапуска.

Параметры запуска

--common.config.file

Путь к YAML-файлу с параметрами подключения к etcd.

По умолчанию используется файл, подготовленный при настройке vision_core: /opt/skala-r/etc/vision/server/vision_core/etcd.yml. В типовых сценариях отдельный файл создавать не нужно.

Поддерживаемые ключи:

  • ca_file — путь к корневому сертификату;

  • cert_file — путь к TLS-сертификату клиента;

  • host — адреса узлов etcd-кластера;

  • key_file — путь к приватному TLS-ключу клиента;

  • password — зашифрованный пароль пользователя etcd;

  • port — порт для клиентских подключений;

  • user — имя пользователя в etcd.

Пример заполнения etcd.yml
host: ["127.0.0.1"]
port: 2379
user: vision
password: '********'
key_file: /root/client.key
cert_file: /root/client.crt
ca_file: /root/ca.crt
--common.scrape-timeout

Период ожидания запроса метрик в секундах.

Значение по умолчанию: 10.

--common.timeout

Период ожидания выполнения запросов.

Значение по умолчанию: 10s.

--component.shutdown-timeout

Длительность периода ожидания при плавном завершении работы компонента.

Значение по умолчанию: 15s.

--core.check-path

Путь к маршруту проверки конфигурации на Сервере подсистемы мониторинга.

Значение по умолчанию: /vision/api/v1/config/check.

--core.endpoint

Адрес Сервера подсистемы мониторинга.

Значение по умолчанию: 127.0.0.1:8088.

--core.reload-path

Путь к маршруту перезапуска конфигурации на Сервере подсистемы мониторинга.

Значение по умолчанию: /vision/api/v1/config/reload.

--core.skip-check

Пропуск проверки конфигурации Сервером подсистемы мониторинга.

Значение по умолчанию: false.

--core.skip-reload

Пропуск перезапуска конфигурации Сервером подсистемы мониторинга.

Значение по умолчанию: false.

--logging.filePath

Путь к файлу записи логов.

Значение по умолчанию: config_editor.log.

--logging.flags

Вывод установленных флагов при запуске.

Значение по умолчанию: false.

--logging.flags-table

Вывод флагов компонента в виде таблицы.

Значение по умолчанию: false.

--logging.level

Уровень логирования. Возможные значения в порядке уменьшения подробности вывода:

  • DEBUG;

  • INFO;

  • WARN;

  • ERROR;

  • CRITICAL.

Значение по умолчанию: INFO.

--version

Вывод версии компонента.

Значение по умолчанию: false.