Руководство администратора

Общие сведения#

Наименование программы#

Полное наименование: Система мониторинга ПАК семейства Скала^р: ПО «Скала^р Визион».

Краткое наименование: Визион.

Конфигурация объектов мониторинга#

После развёртывания Визион.Сервер, необходимо ввести информацию об объектах мониторинга в систему. В консоли администратора мониторинга предусмотрен пользовательский интерфейс для настройки объектов. Алгоритм настройки выглядит следующим образом:

  1. Авторизуйтесь в веб-интерфейсе администратора Визион.

  2. На панели навигации выберите Объекты.

  3. В панели Контуры нажать кнопку ⋮, выбрать Добавить ПАК.

  4. Ввести информацию о ПАК.

  5. В случае отсутствия на добавляемом ПАК агентов Платформы, необходимо его развернуть в соответствии с разделом 6 настоящего Руководства.

  6. Перейти во вкладку Агенты метрик и нажать кнопку Сконфигурировать агенты.

  7. Нажать на иконку 🖉 и включить необходимые плагины.

  8. Перейти в пункт меню Конструктор выражений.

  9. Ввести выражение:

    up{_pak_id="<ИМЯ_ПАК>"}

  10. Проверить, что работают все сконфигурированные плагины.

    Плагин считается работающим, если в наличии временные ряды с меткой “job” и значениями имен агентов.

Подготовка к настройке#

Настройка возможна двумя способами:

  • Вручную.

    Перед настройкой этим способом убедитесь в наличии инсталляционной карты с соответствующим описанием ПАК, либо всех необходимых параметров и доступов для постановки объектов на мониторинг.

  • Экспорт данных в CSV-файлы.

    Этот способ предполагает экспорт конфигурации существующего ПАК в файлы формата CSV, их изменение и последующий импорт.

Добавление ПАК#

Чтобы добавить ПАК:

  1. Авторизуйтесь в интерфейсе администратора Визион.

  2. На панели навигации выберите Объекты.

  3. На панели Контур нажмите кнопку ⋮ и в открывшемся меню выберите Добавить ПАК.

  4. Заполните форму. Доступность некоторых полей зависит от типа добавляемого ПАК.

    • Настройка правил — если этот переключатель включен, после создания ПАК откроется окно, позволяющее включить правила оповещения по умолчанию.

    • Имя — уникальный идентификатор ПАК.

      Значение в этом поле нельзя изменить без переустановки.

    • Тип — выберите тип добавляемого ПАК в соответствии с поставкой.

    • Описание — необязательное поле с кратким описанием ПАК.

    • Модули — нажмите кнопку Добавить и укажите данные о модулях, из которых состоит ПАК:

      • Имя — идентификатор модуля.

        Значение в этом поле нельзя изменить без переустановки.

      • Тип — выберите тип модуля из списка.

        Список доступных типов модуля зависит от выбранного типа ПАК.

      • Описание — необязательное описание модуля.

    • Серверы — нажмите кнопку Добавить и укажите данные о серверах:

      • Имя — идентификатор сервера.

        Значение в этом поле нельзя изменить без переустановки.

      • Модуль — выберите модуль, к которому относится сервер. Список доступных модулей формируется из значений, введённых в блоке Модули.

      • Тип — выберите тип сервера. Список доступных значений зависит от типа модуля.

      • Адрес — IP-адрес или доменное имя узла для установки агента.

      • Адрес BMC — адрес, по которому будут производить опрос агенты мониторинга, расположенные на Визион.Прокси.

    • Виртуальные машины — нажмите кнопку Добавить и укажите данные о ВМ, входящих в состав ПАК, в том числе сервисных ВМ (Визион, Геном и т. д.):

      • Имя — идентификатор ВМ.

        Значение в этом поле нельзя изменить без переустановки.

      • Сервер — принадлежность ВМ к физическому узлу (серверу).

      • Адрес — IP-адрес ВМ.

    • Коммутаторы и СХД — нажмите кнопку Добавить и укажите данные о коммутаторах:

      • Имя — идентификатор коммутатора или СХД.

        Значение в этом поле нельзя изменить без переустановки.

      • Модуль — выберите модуль, к которому относится коммутатор или СХД.

        Список доступных модулей формируется из значений, введённых в блоке Модули.

      • Тип — выберите тип коммутатора или СХД.

        • Public — коммутатор для доступа к публичным сетям.

        • Management — коммутатор сети управления.

        • Interconnect — коммутатор сети Interconnect.

        • Storage (Tatlin) — СХД Tatlin.

        • Storage (MIND uStor) — СХД MIND uStor.

      • Адрес — IP-адрес коммутатора или СХД.

    • Ссылки на сервисы — нажмите кнопку Добавить и укажите данные о сервисах:

      • Сервис — тип сервиса.

      • URL префикс — схема доступа к сервису, HTTP или HTTPS.

      • Адрес — IP-адрес и порт сервиса.

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

      • URL суффикс — если сервис доступен по URL, укажите его в этом поле.

        Добавленные ссылки будут доступны в виде иконок на главной странице:

        Помимо ссылок, добавленных пользователем, на главной странице для каждого ПАК отображаются ссылки на дашборды Grafana. Они добавляются автоматически при установке Визион и не могут быть отредактированы или удалены пользователем. Они также не отображаются на формах Добавление ПАК и Редактирование ПАК.

  5. Нажмите кнопку Добавить.

  6. Если переключатель Настройка правил был во включенном положении, откроется окно Активация правил оповещения.

    1. В блоке Правила оповещения для ПАК выберите системные правила оповещения.

      Если для ПАК нет системных правил оповещения, раздел не будет доступен.

    2. В блоке Универсальные правила оповещения выберите универсальные правила оповещения, подходящие для всех типов ПАК.

    3. Нажмите кнопку Сохранить.

Редактирование ПАК#

Чтобы изменить ПАК:

  1. Авторизуйтесь в интерфейсе администратора Визион.

  2. На панели навигации выберите Объекты.

  3. На панели Контур найдите нужный ПАК и в строке с ним нажмите кнопку ⋮.

  4. В открывшемся меню выберите Редактировать.

  5. Внесите необходимые изменения.

    Поля формы Редактирование ПАК идентичны полям формы Добавление ПАК, за исключением того, что поле Имя недоступно для изменения.

  6. Нажмите кнопку Редактировать.

Импорт и экспорт настроек с использованием CSV-файлов#

Формы создания и редактирования ПАК позволяют экспортировать значения в CSV-файлы и импортировать их из них. Для этого используйте кнопки Экспортировать CSV-файл и Импортировать из CSV-файла, размещённые на одной линии с названием соответствующего блока настроек.

Дублирование ПАК#

Если требуется создать структуру ПАК, аналогичную уже существующей, воспользуйтесь функцией дублирования:

  1. На панели навигации выберите Объекты.

  2. На панели Контур в строке с нужным ПАК нажмите кнопку ⋮ и выберите пункт Дублировать.

  3. Заполните форму Дублирование ПАК и нажмите кнопку Добавить.

Установка агентов платформы#

  1. Сформируйте инвентори-файл для ПАК.

  2. В созданном инвентори-файле укажите учётные данные для доступа к узлам платформы.

    Вместо ===REPLACE=== укажите актуальные значения для следующих переменных:

    • ansible_user — название учётной записи для подключения к узлу по SSH;

    • ansible_ssh_pass — пароль учётной записи для подключения к узлу по SSH;

    • ansible_become_user — название учётной записи привилегированного пользователя, как правило root;

    • ansible_become_password пароль привилегированного пользователя;

    • vars — глобальные переменные инвентори-файла.

  3. Перейдите в директорию дистрибутива:

    cd /root/vision-distrib-<version>

  4. В конфигурационном файле ./plagent/_plagent_settings.yml укажите параметры установки агента Платформы.

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

  5. Запустите установщик setup.sh и выберите пункт Установка plagent.

  6. Выберите номер сформированного ранее инвентори-файла.

  7. По завершении установки удалите инвентори-файл.

Пример вывода при успешном развёртывании:

PLAY RECAP **************************************************************************************************************
PG-PRD-3-MDL-BD1-01-N-196  : ok=15   changed=6   unreachable=0   failed=0   skipped=0   rescued=0   ignored=0
PG-PRD-3-MDL-BD1-01-N-197  : ok=15   changed=6   unreachable=0   failed=0   skipped=0   rescued=0   ignored=0
PG-PRD-3-MDL-BD1-01-N-198  : ok=15   changed=6   unreachable=0   failed=0   skipped=0   rescued=0   ignored=0
PG-PRD-3-MDL-BS-01-N-199   : ok=15   changed=6   unreachable=0   failed=0   skipped=0   rescued=0   ignored=0
PG-PRD-3-MDL-BS-01-N-199-VM-GMN-192 : ok=15   changed=2   unreachable=0   failed=0   skipped=0   rescued=0   ignored=0
PG-PRD-3-MDL-BS-01-N-199-VM-SPR-191 : ok=15   changed=6   unreachable=0   failed=0   skipped=0   rescued=0   ignored=0
PG-PRD-3-MDL-BS-01-N-199-VM-VSN-200 : ok=14   changed=2   unreachable=0   failed=0   skipped=1   rescued=0   ignored=0

Так же в рамках автоматизации работы с агентами Платформы доступны некоторые сервисные команды.

Общий вид команд для их запуска:

ansible-playbook -i <INVENTORY_PATH> <PLAYBOOK>
ansible-playbook -i <INVENTORY_PATH> -l <HOST> <PLAYBOOK>

где

  • <INVENTORY_PATH> — путь к итоговому инвентори-файлу;

  • <PLAYBOOK> — выполняемое действие:

    • ./plagent/install.yml — установка;

    • ./plagent/status.yml — вывод статуса;

    • ./plagent/stop.yml — остановка;

    • ./plagent/restart.yml — перезапуск;

    • ./plagent/remove.yml — удаление.

  • <HOST> — имена узлов из инвентори-файла, для которых необходимо выполнить команду, например, server1.

Настройка агентов и установка Визион.Прокси#

Конфигурирование агентов метрик#

  1. Выберите вкладку Агенты метрик и нажмите кнопку Сконфигурировать агенты.

    Откроется форма настроек.

  2. В настройках укажите:

    • Расположение прокси-сервера Визиона. На выбранный узел будет установлен компонент Прокси-сервер Визиона, а также на нем требуется сконфигурировать плагины, которые обозначены типом «ВМ с прокси».

    • Расположение агентов: по умолчанию, в форме отобразятся все серверы и ВМ, которые были ранее указаны в списке объектов. Для корректного расположения, на серверах должны быть предварительно установлены агенты Платформы.

    • Плагины — состав конфигурационных файлов, содержащих в себе инструкции для настройки агентов и расстановки экспортеров. На данном шаге необходимо выбрать Плагины в соответствие с типом узла. Для узла, который будет выбран как Прокси, требуется выбрать плагины, реализующие сбор метрик снаружи относительно объекта мониторинга.

      Если в столбце Сервер/ВМ указано «ВМ с прокси», плагин рекомендуется разместить на ВМ, выбранную в качестве Прокси. Остальные плагины конфигурируются на усмотрение пользователя, в зависимости от расположения сервисов на узлах.

После расстановки всех агентов и нажатия кнопки Сохранить поменяются статусы агентов. В случае успеха будет указан статус Установлен. Если агент не будет настроен, отобразится статус Ошибка. Требуется проверить логи и сетевую связность между компонентами, а также наличие агента Платформы на всех узлах, за которыми требуется осуществлять мониторинг.

Конфигурирование плагинов#

Для конфигурирования плагинов в разделе Объекты выберите вкладку Плагины.

Для каждого плагина предусмотрен набор настроек, которые необходимо задать в контекстном меню Конфигурировать.

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

Перед добавлением убедитесь, что при установке плагина его порт не конфликтует с другим ПО.

После заполнения параметров происходит их применение и автоматическое конфигурирование.

Для проверки корректности настроек:

  1. Перейдите в пункт меню Конструктор выражений.

  2. Введите выражение:

    up{_pak_id="<ИМЯ_ПАК>"}

  3. Проверьте работоспособность всех сконфигурированных плагинов (в наличии временные ряды с именем метки job и значениями имен плагинов).

Описание доступных параметров и особенностей настройки см. в Справочнике плагинов .

Добавление и обновление плагинов#

Выполните следующие действия на виртуальной машине сервера Визиона:

  1. Распакуйте архив с новым или обновлённым плагином в директорию /opt/skala-r/vision, например:

    tar -xzf plugin_acrhive.tar.gz -C /opt/skala-r/vision

  2. Перезапустите сервис vision_core:

    systemctl restart vision_core.service

  3. Проверьте состояние сервиса vision_core:

    systemctl status vision_core.service

  4. Убедитесь, что в логе нет ошибок после перезапуска:

    journalctl -fu vision_core -n 20

Снятие ПАК с мониторинга (деинсталляция Визиона с узлов ПАК).#

Предупреждение
Данные действия необратимы. В процессе удаления будут деинсталлированы все агенты мониторинга, их плагины, а также Визион.Прокси.

  1. Авторизуйтесь в интерфейсе администратора Визион.

  2. На панели навигации выберите Объекты.

  3. На панели Контур выберите удаляемый ПАК.

  4. Нажмите кнопку ⋮ и выберите Удалить.

  5. Подтвердите удаление.