Руководство пользователя

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

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

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

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

Область применения#

Основным предназначением ПО «Скала^р Визион» является предоставление возможности контроля жизненного цикла ПАК (машин) производства Скала^р, обслуживаемых персоналом, к квалификации которого не предъявляется серьёзных требований. Осуществляется процесс мониторинга программных компонент ПАК, сбор информации о количестве и составе управляемых объектов, метрик. Обеспечиваются оповещения при сбоях работы объектов мониторинга.

Лингвистическое обеспечение#

Основной язык в настроенных панелях отображения метрик, уведомлений, графической информации – русский (пользовательский).

Дополнительный язык в интерфейсах всех подсистем – английский (пользовательский).

Обеспечение защиты информации#

Взаимодействие между компонентами Визиона реализовано через TLS и Basic Auth.

Авторизация и полномочия пользователя в Визион и Grafana#

Если аутентификация в Визион через внешнего провайдера отключена, пользователи имеют полный доступ. Рекомендуется использовать ролевую модель разграничения прав доступа.

В случае использования ролевой модели доступа в Визион и Grafana пользователь должен иметь учётную запись в провайдере аутентификации и авторизации и назначенную роль (роли), на основе которых будут определяться полномочия пользователя в указанных системах.

Информация, отображаемая на страницах Визион и Grafana (доступные разделы, список оповещений, дашборды и т. п.) зависит от полномочий, назначенных ролям пользователя.

Если функция аутентификации пользователей включена, то при входе в Визион произойдёт переадресация на страницу входа.

В случае авторизации через Keycloak:

В случае авторизации через Avanpost:

В случае успешной аутентификации и авторизации пользователь попадает на стартовую страницу Визион.

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

Назначение и условия применения#

Виды деятельности, функции и классы решаемых задач#

Основные функции ПО «Скала^р Визион»:

  • Сбор данных о конфигурации элементов ПАК (машин).
  • Сбор данных, отображение, мониторинг элементов программного обеспечения, активных компонентов модулей ПАК, служебных сервисов и сервисов баз данных.
  • Конфигурирование метрик мониторинга, настройка уведомлений.
  • Конфигурирование графического отображения на информационных панелях в виде графиков, отдельных значений, диаграмм, таблиц.
  • Хранение метрик с возможностью настройки глубины хранения и управления жизненным циклом хранимых данных.
  • Отображение в пользовательском графическом интерфейсе данных о состоянии объектов мониторинга.
  • Контроль изменений объектов мониторинга в режиме, близком к реальному времени.
  • Мониторинг сервисов, специфичных для различных типов ПАК.

Общие принципы работы с интерфейсом#

Большинство разделов графического интерфейса устроены единообразно, и к ним применимы одни и те же принципы использования.

Навигация#

Для перехода между разделами используйте панель навигации. Она размещена слева.

На некоторых страницах возможна навигация с помощью «хлебных крошек». Эта панель размещается в верхней части страницы и содержит ссылки для перехода в разделы, родительские по отношению к выбранному.

Просмотр записей#

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

Для сброса всех фильтров используйте кнопку Сбросить все фильтры.

Некоторые таблицы позволяют управлять видимостью своих столбцов. Для этого:

  1. Нажмите кнопку в виде шестерёнки в правом верхнем углу.

  2. Измените состояние флагов, управляющих видимостью столбцов.

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

Создание записей#

Для создания новых записей:

  1. Перейдите в соответствующий раздел и нажмите кнопку Добавить.

    Откроется диалоговое окно с формой для ввода данных.

  2. Заполните форму.

    Особенности заполнения отдельных форм описаны ниже.

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

Контекстное меню#

В некоторых разделах доступна кнопка ⋮. Нажатие на неё приводит к отображению контекстного меню.

Редактирование записей#

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

  1. В строке с нужной записью нажмите кнопку вызова контекстного меню и выберите Редактировать.

    Откроется диалоговое окно с формой редактирования записи.

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

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

Системные записи редактировать нельзя.

Удаление записей#

Чтобы удалить одну запись:

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

  2. Подтвердите удаление записи.

Чтобы удалить несколько записей:

  1. С помощью флагов выберите ненужные записи.

  2. На панели инструментов нажмите кнопку с изображением мусорной корзины (Удалить).

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

Особенности удаления отдельных типов записей описаны ниже.

Системные записи удалить нельзя.

Стартовая страница#

Стартовая страница Визион имеет вид:

Здесь:

  1. Кнопка управления порядком сортировки активных уведомлений.

  2. Переключатели видимости уведомлений с соответствующим уровнем критичности.

  3. Уровень критичности уведомления.

  4. Ссылка для перехода в раздел Уведомления на странице администрирования.

  5. Счётчики количества уведомлений каждого уровня критичности суммарно по всем зарегистрированным ПАК.

  6. Панель Уведомления.

  7. Счётчики количества ПАК, находящихся, соответственно, в критичном, проблемном или доступном состояниях.

  8. Панель Состояние машин.

  9. Логотип.

  10. Главное меню.

  11. Панель Контур.

  12. Кнопка-аватар активного пользователя. Нажатие на кнопку приводит к отображению меню со списком назначенных пользователю ролей и пунктом Выйти.

  13. Поле управления фильтром по типу ПАК.

  14. Панель ПАК.

  15. Ссылки для перехода на страницы ПО ПАК.

  16. Счётчики количества уведомлений для ПАК.

  17. Количество коммутаторов в составе ПАК.

  18. Количество серверов в составе ПАК.

  19. Имя ПАК.

  20. Тип ПАК.

  21. Кнопка Статистика уведомлений.

Статистика уведомлений#

Страница отображает статистику уведомлений за выбранный период. Для изменения длительности периода используйте кнопки рядом с фильтром по типу ПАК.

Страница состоит из нескольких панелей:

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

    Нажатие на кнопку приводит к переходу в раздел Уведомления на странице администрирования. При этом активируется соответствующий фильтр.

  • Активные уведомления — история возникновения уведомлений.

    Нажатие на запись приводит к переходу в раздел Уведомления на странице администрирования. При этом открывается панель Обзор уведомления, предоставляющая подробную информацию об уведомлении.

  • Топ причин — три правила оповещения с наибольшим количеством срабатываний.

    Нажатие на запись приводит к переходу в раздел Уведомления на странице администрирования. При этом записи фильтруются по названию правила.

Группы панелей По важности, По ПАК и По категориям уведомлений содержат по две панели:

  • Статистика возникновения — таблица распределения событий во времени с группировкой по уровням критичности, ПАК или категориям уведомлений соответственно. Чем темнее цвет квадрата, тем больше событий с произошло в этот период.

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

  • Срок решения — индикаторы, показывающие среднее время реакции на оповещения. Чем темнее цвет, тем больше времени понадобилось на устранение инцидента.

Страница администрирования#

При успешной авторизации пользователь попадает на главную страницу администрирования Визион.

Здесь:

  1. Кнопка управления видимостью панели навигации.

  2. Индикатор статуса мониторинга.

  3. Кнопка переключения видимости вложенных пунктов.

  4. Пункт навигации, имеющий подпункты.

  5. Активный пункт навигации.

  6. Счётчик уведомлений.

  7. Панель навигации.

  8. Логотип системы.

  9. Панель Контур.

  10. Кнопка перехода на главную страницу.

  11. Поле Поиск.

  12. Родительский элемент.

  13. Дочерние элементы.

  14. Кнопка вызова контекстного меню.

  15. Контекстное меню.

  16. Панель вкладок.

  17. Активная вкладка.

В зависимости от назначенных пользователю ролей количество и состав элементов могут изменяться.

Уведомления#

Страница состоит из панели инструментов и таблицы.

Панель содержит следующие элементы управления:

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

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

  • Выпадающий список для фильтрации уведомлений по категориям.

  • Кнопки-переключатели, управляющие видимостью уведомлений с соответствующим уровнем критичности.

  • Кнопка сброса фильтров.

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

Таблица уведомлений состоит из следующих колонок:

  • Возникло — дата и время регистрации события в системе мониторинга.

  • Закрыто — дата и время снятия актуальности события в системе мониторинга.

  • Длительность:

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

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

  • ПАК — имя ПАК.

  • Узел — имя узла.

  • Имя правила — название правила оповещения, выполнение которого привело к созданию оповещения.

Объекты#

Для доступа к разделу требуется роль Администратор объектной модели.

Раздел Объекты предназначен для постановки объектов Контура на мониторинг, установки и настройки агентов мониторинга на узлах, контроля их состояния, управления объектами мониторинга.

Предусловия#

Для работы с данным разделом Визион должен быть развёрнут и настроен на ландшафте наблюдаемой инфраструктуры. Данная функция выполняется инженерами развёртывания и описывается в Руководстве администратора.

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

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

Ограничения#

Визион – система мониторинга машин Скала^р. Данное ПО является неотделимой частью машин Скала^р и корректная работа гарантирована только на ПАК Скала^р.

Объекты, отображаемые в ПО Визион, соответствуют физическим и виртуальным объектам машин Скала^р. Они показывают состав Контура и фактическое расположение объектов (при наличии таких объектов в контуре и их постановке на мониторинг) в соответствии с их типом.

Типы объектов, предварительно заведённые в системе, соответствуют типам объектов Скала^р. В Визион используются следующие типы объектов:

  • ПАК;

  • Модуль;

  • Узел;

  • Виртуальная машина (ВМ);

  • Коммутатор.

Пример отображения объектов:

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

Важно
Метрики начинают собираться по объектам после ввода информации об объектах, а также после развёртывания и конфигурирования агентов. Точкой отсчета начала сбора метрик считается корректная конфигурация и установка плагинов.

Типы объектов#

  • ПАК

    Логический тип объекта, соответствующий совокупности аппаратных компонентов и программного обеспечения, решающих прикладные задачи. У объектов типа «ПАК» предусмотрено контекстное меню, позволяющее выполнять дополнительные действия.

  • Модуль

    Структурный элемент Машины, выполняющий определённый набор функций в соответствии с его назначением. Модуль является единым и неделимым элементом спецификации, содержит набор аппаратных узлов и программного обеспечения. Типы модулей в Визионе соответствуют типам модулей, поставляемым в машинах Скала^р. При работе с формами Создание ПАК и Редактирование ПАК доступны модули, которые соответствуют выбранному типу ПАК.

  • Узел

    Аппаратный компонент Машины, на котором работает специализированное ПО, выполняет определённую задачу в составе Модуля.

  • Коммутатор

    Аппаратный компонент Машины, на котором работает специализированное ПО, выполняет определённую задачу в составе Модуля.

  • Виртуальная машина

    Компонент Машины, на котором работает специализированное ПО, выполняет определённую задачу в составе Модуля.

Объекты#

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

  • Метрики — информация о метриках объекта данного типа.

  • Уведомления — список уведомлений по выбранному объекту.

  • Обзор — состав объектов, включённых в выбранный ПАК, и их параметры размещения.

  • Агенты метрик:

    • Расположение – объект, на котором расположен агент.

    • Тип – тип агента.

    • Статус – статус установки агента.

    Доступны действия:

    • Инсталлировать для агентов в статусе Не установлен.

    • Переустановить.

    • Деинсталлировать для агентов в статусе Установлен.

    • Удалить из БД.

  • Агенты логов — вкладка аналогична Агенты метрик, но предназначена для работы с агентами логов.

  • Плагины — информация о плагинах и их статусе.

    Вкладка содержит следующую информацию:

    • Имя – название плагина.

    • Расположение – объект, на котором расположен агент.

    • Статус – статус плагина.

    Доступны действия:

    • Инсталлировать для плагинов в статусе Не установлен.

    • Конфигурировать.

    • Деинсталлировать.

    • Переустановить для плагинов в статусе Ошибка.

    • Удалить из БД.

    На этой же вкладке находится кнопка Клонирование плагинов.

Метрики#

Раздел Настройки → Метрики содержит информацию о добавленных пользователем и системных метриках (метрики, собираемые экспортерами в необработанном виде, поставляемые вместе с Визионом по умолчанию).

Список содержит следующую информацию о метриках:

  • Имя – системное название метрики, задаётся для настроек других связанных сущностей, например, правил оповещений.

  • Детальное описание – подробное описание метрики.

  • Тип – тип метрики в зависимости от поставки:

    • Системная — метрика входит в состав дистрибутива. Такую метрику нельзя изменить или удалить.

    • Пользовательская — метрика создана вручную.

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

Создание и редактирование#

Для создания и редактирования метрик типа SQL скрипт и Bash скрипт необходимы роли администратора мониторинга (vsn_config) и администратора объектной модели (obj_model).

Особенности заполнения формы:

  • Тип метрики — тип создаваемой метрики.

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

  • Имя — название метрики.

    • Поле обязательное для заполнения.

    • Длина от 5 до 100 знаков.

    • Допустимые символы: буквы английского алфавита в верхнем и нижнем регистрах, цифры, символ нижнего подчеркивания.

    • Название метрики должно быть уникальным.

    • Названия пользовательских метрик должны начинаться с префикса usr_.

  • Детальное описание – детальное описание метрики.

    • Поле обязательное для заполнения.

    • Длина от 3 до 500 любых знаков.

  • Тип объекта – список объектов, для которых на вкладке Метрики будет отображаться данная метрика.

  • Выражение PromQL — валидный PromQL-запрос.

    Поле доступно только для метрик типа PromQL.

  • Выражение LogsQL — валидный LogsQL-запрос.

    Поле доступно только для метрик типа LogsQL.

  • Выражение

    Если выбран тип метрики SQL скрипт, в этом поле опишите структуру YAML, содержащую мета-информацию о базе данных и SQL-запрос для выборки из неё данных, пригодных для хранения в формате временного ряда, например:

    type: counter
help: 'Data base role'
values: [role]
query: "select pg_is_in_recovery()::int as role"";

    В данном примере производится проверка, находится ли БД в состоянии восстановления. Данный запрос имеет следующие параметры:

    • type – тип метрики;

    • help – описание;

    • values – название таблицы;

    • query – тело запроса.

    Если выбран тип метрики Bash скрипт, в этом поле опишите структуру YAML, содержащую правила, по которым формируются метки и значения временных рядов. В рамках одной метрики возможно описание нескольких временных рядов. У одного временного ряда может быть задано несколько меток. Возможно определить метки, которые будут применены ко всем временным рядам (в рамках данной метрики) или только к конкретному временному ряду.

    Метки описываются в формате название: значение.

    Описание тегов, используемых в YAML-структуре:

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

    • static_labels — раздел для статических меток-строк.

    • series — раздел для описания временных рядов.

    • series.value — значение временного ряда, которое формируется как результат выполнения команды или скрипта.

    • series.static_value — статическое значение — число.

    Пример YAML-структуры:

    labels:
  user: whoami
series:
  - value: ps -ax | wc | awk '{print $1}'
    static_labels:
      label1: lab1
  - static_value: 10
    static_labels:
      label1: lab2

    В данном примере в разделе labels определена метка user, которая будет присутствовать у всех временных рядов данной метрики. Значением метки будет результат выполнения команды whoami (в нашем случае vision_bash_exporter — логин пользователя, от имени которого запускается Bash-команда).

    В разделе series описаны два временных ряда:

    Значения первого временного ряда будут формироваться как результат выполнения команды:

    ps -ax | wc | awk '{print $1}'

    Значения второго временного ряда — число 10.

    Для первого временного ряда определена статическая метка label1 со значением lab1, а для второго временного ряда статическая метка label1 со значением lab2.

  • Узлы — выберите узлы, с которых будет собираться метрика. Допускается создать несколько метрик, собираемых с одного и того же узла. Отключение сбора одной из метрик не влияет на сбор остальных метрик.

    Узел доступен для выбора, если на него установлен необходимый плагин и есть связь.

    Узел недоступен для выбора, если плагин не установлен, либо связь с узлом потеряна.

    Выберите узлы, с которых будет собираться описанная метрика.

    Метрику типа SQL скрипт можно собирать не только с серверов, но и ВМ, при условии, что на неё установлен плагин sql_exporter.

Удаление#

Вместе с метрикой будут удалены использующие её правила оповещения.

Для удаления метрик типа SQL скрипт и Bash скрипт необходимы роли администратора мониторинга (vsn_config) и администратора объектной модели (obj_model).

Диагностика полноты сбора данных#

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

  • Статус — действующий статус метрики. Он рассчитывается за период, равный удвоенному периоду скрепинга, и обозначается цветом:

    • красный — данные за выбранный период отсутствуют;

    • жёлтый — во временном ряде отсутствует более 10% значений, которые должны быть собраны за выбранный период;

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

  • Метрика — название метрики.

  • Значение — последнее значение временного ряда.

  • Job — источник значений метрики.

  • Instance — узел с которого собрана метрика.

  • src_type — тип метрики.

Настройка сбора метрик sql_exporter и bash_exporter#

Для пользовательских метрик, собираемых sql_exporter и bash_exporter, доступна функция остановки сбора.

Чтобы остановить сбор метрики, не удаляя саму метрику:

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

  2. На панели Контур выберите нужный ПАК.

  3. Выберите вкладку Плагины.

  4. В контекстном меню плагинов sql_exporter или bash_exporter выберите пункт Настройка сбора метрик.

  5. В секции Метрики измените состояние флагов на нужное.

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

Экспорт и импорт метрик#

Для экспорта и импорта метрик требуется роль Администратор мониторинга.

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

Экспорт метрик#

Для экспорта метрик:

  1. На панели навигации выберите Настройки → Метрики.

  2. С помощью флагов выберите нужные пользовательские метрики.

  3. В правом верхнем углу нажмите кнопку со стрелкой вверх (Экспортировать).

  4. В диалоговом окне Экспорт метрик нажмите кнопку Экспортировать.

    При необходимости установите флаг Экспортировать связанные метрики. В этом случае вместе с выбранными метриками также будут экспортированы связанные метрики. Эта настройка может быть полезна, если метрика рассчитывается на основе других пользовательских метрик.

Импорт метрик#

Для импорта метрик:

  1. На панели навигации выберите Настройки → Метрики.

  2. В правом верхнем углу нажмите кнопку со стрелкой вниз (Импортировать).

  3. В диалоговом окне Импорт метрик и правил оповещения добавьте файл формата YAML с описанием метрик.

    Используйте для этого кнопку Добавить файл или метод «Drag-and-Drop».

  4. Нажмите кнопку Импортировать.

  5. В окне Импорт метрик и правил оповещения с помощью флагов выберите необходимые метрики и нажмите кнопку Проверить и импортировать.

  6. Если проверка пройдёт успешно, окно Импорт метрик и правил оповещения будет закрыто, появится сообщение Импорт выполнен успешно.

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

Правила оповещения#

Раздел Настройки → Правила оповещения содержит информацию о правилах оповещения.

Таблица правил оповещения состоит из следующих колонок:

  • Имя – тип и название правила.

    • SYS — системное правило (поставляется вместе с Визион).

    • USR — пользовательское правило.

  • Описание — описание правила.

  • Категории — категория, к которой относится правило.

  • Тип ПАК — название ПАК, к которому относится правило.

  • Выражение — выражение, при истинности которого срабатывает правило.

  • Количество срабатываний — количество срабатываний данного правила.

  • Последнее срабатывание — время фиксации последнего срабатывания правила.

  • Тип правила — тип запроса, на основе которого формируется правило оповещения.

  • Метрики — список метрик, используемых правилом оповещения.

  • Период активности — длительность периода времени, в течение которого должны выполняться условия срабатывания оповещения. Если длительность периода меньше указанного значения, событие не считается наступившим, и оповещение не отправляется.

  • Детальное описание — шаблон сообщения, отправляемого администратору Визион при срабатывании правила.

  • Активно — переключатели, управляющие активностью правила. Если правило неактивно, Визион не использует его.

  • Кнопки вызова контекстного меню.

Добавление и редактирование#

Особенности заполнения формы:

  • Имя — название правила.

    • Поле обязательное для заполнения.

    • Длина от 3-х до 100 символов.

    • Допустимые символы: буквы в верхнем и нижнем регистрах, цифры, нижнее подчёркивание, дефис -, точка ., запятая ,, процент %, круглые скобки ( и ), слеш /.

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

  • Описание — краткое описание правила.

  • Правило — группа полей для ввода условий срабатывания правила.

    Группа полей доступна только при создании правил для метрик.

    Переключатели управляют тем, как несколько условий сочетаются между собой:

    • И — должны быть выполнены все условия одновременно.

    • ИЛИ — должно быть выполнено хотя бы одно из условий.

    • Выражение PromQL — в этом случае нужно будет ввести выражение PromQL вручную.

    Если выбраны значения И или ИЛИ, с помощью кнопки Добавить условие добавьте необходимые условия срабатывания правила:

    • Метрика — метрика из существующего списка.

    • Оператор — оператор сравнения.

    • Порог — значение, с которым сравнивается метрика.

  • Период активности — период, в течение которого должно выполняться условие срабатывания.

    • Поле обязательное для заполнения.

    • Длина от 1 до 255 символов.

    • Значением является период времени, например:

      • 1d — 1 день (24 часа);

      • 1h30m — 1 час 30 минут;

      • 5m — 5 минут;

      • 10s — 10 секунд;

      • 0s — ожидание не требуется, оповещение должно быть отправлено сразу же.

  • Выражение LogSQL — поле ввода выражения LogSQL.

    Это поле доступно только при создании правила для логов.

  • Важность — уровень критичности.

  • Категории — список категорий, к которым относится правило. Используется администратором для разграничения доступа к оповещениям.

  • Тип ПАК — список типов ПАК, к которым применяется правило оповещения.

  • Детальное описание — подробное описание правила, например, причина его создания. Здесь же можно указать метки, на основе которых администратор может настроить разграничение доступа пользователей к правилам оповещения.

    Чтобы добавить метку:

    1. Введите знак #. В позиции курсора появится выпадающий список, сформированный из меток, использованных за последние 24 часа.

    2. Выберите нужную метку. Если нужной метки нет в списке, введите её название вручную.

Клонирование#

Клонирование позволяет создать новое правило на основе уже имеющегося. Далее уже существующее правило называется правилом-источником.

Чтобы клонировать правило оповещения:

  1. В строке с правилом-источником нажмите кнопку вызова контекстного меню и выберите пункт Клонировать.

    Откроется диалоговое окно Добавление правила оповещения. Поля формы будут заполнены данными из правила-источника.

  2. При необходимости внесите изменения в данные.

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

Экспорт и импорт#

Для импорта и экспорта правил оповещения требуется роль Администратор мониторинга.

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

Экспорт и импорт правил оповещения осуществляется на странице Настройки → Правила оповещения аналогично экспорту и импорту метрик.

Конструктор выражений#

Раздел Настройки → Конструктор выражений — это инструмент для анализа метрик в графическом виде. Под графиком формируется таблица с описанием временных рядов, их метки и значения.

Конструктор выражений содержит следующие элементы управления:

  • Начало — дата и время начала периода наблюдения.

  • Конец — дата и время окончания периода наблюдения.

  • Кнопка Настройки графика.

  • Выражение – поле для ввода запроса на языке PromQL.

  • Кнопка Добавить выражение.

  • График временных рядов. Появляется после добавления хотя бы одного выражения.

Настройки конструктора выражений#

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

Диалоговое окно Настройки графика состоит из нескольких сворачиваемых панелей:

  • Основные настройки:

    • Существующие метрики

      Если этот переключатель выключен, конструктор позволяет ввести выражение PromQL вручную.

      Если этот переключатель включен, вместо поля Выражение в конструкторе запросов выводится выпадающий список Метрика.

    • Автоматически определять шаг — переключатель, управляющий автоматическим расчётом шага временной шкалы графика.

  • Настройки панели:

    • Название – поле для ввода подписи панели.

    • Положение названия — переключатель, позволяющий выбрать положение названия на панели.

  • Всплывающие подсказки:

    • Следовать за курсором — если этот переключатель включен, при активации панель подсказки будет расположена около курсора при наведении на график.

    • Режим всплывающих подсказок — переключатель, позволяющий выбрать режим отображения подсказок.

  • Легенда:

    • Видимость – если этот переключатель включен, рядом с графиком выводится легенда.

    • Положение легенды — переключатель положения легенды.

    • Выравнивание легенды — переключатель выравнивания содержимого легенды.

  • Ось:

    • Метка – подпись горизонтальной оси.

    • Показать линии сетки – переключатель видимости линий сетки.

  • Стили графиков:

    • Стиль отображения – переключатель стиля графика.

    • Линейная интерполяция — алгоритм сглаживания линии графика.

    • Ширина линий — регулятор ширины линии графика.

    • Стиль линий – переключатель, управляющий внешним видом линий.

    • Соединение нулевых значений – если этот переключатель включен, все нулевые значения на графике будут объединены в одно.

  • Пороги:

    • Значение – первое значение.

    • Значение 2 – второе значение.

    • Текст – подпись порогового значения на графике.

    • Стиль отображения – внешний вид порогового значения, сплошная линия или с разрывами.

    • Цвет текста, Цвет линии, Цвет фона, Цвет заливки — цвета соответствующих элементов отображения порогового значения.

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

Список получателей#

Раздел Настройки → Список получателей содержит список получателей уведомлений и инструменты для работы с ними.

Таблица получателей содержит следующие колонки:

  • Флаги для выбора нескольких записей.

  • Получатель — название получателя уведомлений.

  • Адрес — адрес получателя, например, электронная почта или IP-адрес SNMP-шлюза.

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

    • Авто — получатель добавлен автоматически.

    • Ручное — получатель добавлен вручную.

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

  • Кнопка вызова контекстного меню.

При нажатии на строку открывается диалоговое окно Обзор получателя.

Получатель SNMP-шлюз — системный, его нельзя отредактировать или удалить.

Добавление и изменение#

Особенности заполнения формы:

  • Получатель — имя получателя.

    • Поле обязательное для заполнения.

    • Длина от 3-х до 100 знаков включительно.

    • Допустимые символы: буквы английского и русского алфавитов в верхнем и нижнем регистрах, цифры, нижнее подчеркивание _, дефис -, пробел, запятая ,, точка ., процент %, круглые скобки ( и ).

    • Имя получателя должно быть уникальным.

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

  • E-mail — адрес электронной почты для отправки писем с уведомлениями.

    Это поле доступно, если выбран канал E-mail.

  • URL — URL для отправки Web-hook.

    Это поле доступно, если выбран канал Webhook.

  • Группы рассылки — группы рассылки, в которые необходимо включить получателя.

Группы рассылки#

Используйте группы рассылки для формирования списков получателей уведомлений об определённых событиях. Только получателям из соответствующей группы будут отправлены уведомления.

Таблица групп рассылки состоит из следующих колонок:

  • Флаги для выбора нескольких записей.

  • Имя — название группы рассылки.

  • Описание — описание группы рассылки, например, цель её создания.

  • Добавление — способ, которым была создана группа.

    • Авто — группа рассылки создана автоматически. Её нельзя изменить или удалить.

    • Ручное — группа создана вручную.

  • Кнопки вызова контекстного меню.

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

Добавление и редактирование#

Особенности заполнения формы:

  • Имя — название группы рассылки.

    • Поле обязательное для заполнения.

    • Длина от 3-х до 100 знаков включительно.

    • Допустимые символы: буквы английского и русского алфавитов в верхнем и нижнем регистрах, цифры, нижнее подчеркивание _, дефис -, пробел, точка ., запятая ,, процент %, слеш /, круглые скобки ( и ).

    • Название должно быть уникальным.

  • Описание — описание группы рассылки, например, цель её создания или особенности использования.

    • Поле обязательное для заполнения.

    • Длина от 3-х до 500 знаков включительно.

  • Условия — список условий, при выполнении которых получателям отправляется уведомление.

    • Метка — название метки, присваиваемое экспортером при сборе метрики, описывающие её характеристики.

    • Оператор – оператор сравнения значения метки с заданным значением. Возможно только сравнение на равенство = и неравенство !=.

    • Значение — значение, с которым сравнивается метка.

    • Получатели — список получателей.

Настройки отправки#

Раздел Настройки → Настройки отправки состоит из трёх вкладок:

  • Параметры отправки.

  • SMTP.

  • Внешний Alertmanager.

Параметры отправки#

Вкладка содержит настройки параметров отправки уведомлений:

  • group_wait (s) — период ожидания в секундах с момента регистрации события перед отправкой уведомления о нём.

  • group_interval (s) — период ожидания в секундах с перед повторной отправкой уведомлений о событиях.

  • repeat_interval (s) — период ожидания в секундах перед повторной отправкой уведомлений о необработанных событиях.

  • group_by — список меток, по которым группируются уведомления. Если несколько событий объединены одной меткой, вместо множества уведомлений будет отправлено одно, но со списком всех событий.

SMTP#

Вкладка SMTP содержит параметры подключения к почтовому серверу.

  • Хост — IP-адрес или доменное имя SMTP-сервера.

  • Порт — номер порта, который слушает STMP-сервер.

  • TLS — если этот переключатель включен, для защиты подключения будет использоваться протокол TLS.

  • Отправитель — почтовый адрес, с которого будет отправлено письмо.

  • Без авторизации

    • Если этот флаг включен, подключение к SMTP-серверу выполняется без авторизации.

    • Если этот флаг выключен, на форме отображаются поля Логин и Пароль для ввода учётных данных пользователя SMTP-сервера.

  • Основной адрес получателя – почтовый адрес, на который письма отправляются в любом случае, даже если на соответствующие оповещения никто не подписан.

Кнопка Отправить тестовое письмо позволяет проверить подключение к STMP-серверу. Нажмите её, и Визион отправит на основной адрес получателя письмо. Если на этапе отправки будут ошибки, Визион отобразит информацию о них.

Внешний Alertmanager#

Визион может отправлять уведомления о событиях во внешний AlertManager.

  1. Переведите переключатель Внешняя интеграция во включенное положение.

  2. Заполните форму:

    • Адрес — URL внешнего AlertManager.

    • TLS — если этот переключатель включен, для защиты подключения будет использоваться протокол TLS, а на форме появятся дополнительные поля:

      • Файл центра сертификации — полный путь к сертификату удостоверяющего центра (CA) на сервере подсистемы мониторинга.

      • Приватный ключ — полный путь к приватному ключу сертификата на сервере подсистемы мониторинга.

      • Имя сервера — доменное имя, которое передаётся серверу при установлении TLS-соединения, чтобы он мог выбрать правильный сертификат.

      • Пропустить проверку сертификата — пропуск проверки сертификата при подключении к серверу.

    • Способ авторизации — выберите способ авторизации во внешнем AlertManager:

      • Без авторизации — если внешний AlertManager не требует авторизации.

      • Basic Auth — если авторизация выполняется по имени пользователя и паролю. При выборе этого значения на форме появляются дополнительные поля Имя пользователя и Пароль.

      • Bearer Token — если авторизация выполняется по токену. При выборе этого значения на форме появляется дополнительное поле Токен.

      • OAuth2 — при выборе этого значения на форме появляются поля для ввода учётных данных авторизации OAuth2:

        • Идентификатор клиента.

        • Секрет.

        • Адрес токена.

        • Области — названия областей. Значения указывайте одной строкой через точку с запятой.

        • Параметры — список прав доступа, который будет запрашиваться при авторизации. Значение указывайте в формате JSON.

Безопасность#

Для доступа к разделу необходима роль Администратор ИБ.

Ролевая модель#

Раздел используется для управления пользовательскими ролями.

В столбце Объект выводятся раскрываемые списки полномочий. Названия остальных столбцов — это названия пользовательских ролей.

Чтобы добавить роль:

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

    Откроется диалоговое окно Добавление роли.

  2. Введите название роли. Оно должно быть уникальным.

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

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

  4. Поставьте нужные флаги на пересечениях нового столбца со строками полномочий.

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

Токены доступа#

Раздел доступен только пользователям с ролью Администратора ИБ.

Чтобы добавить токен:

  1. В поле Введите имя токена введите название токена.

  2. Нажмите кнопку Сгенерировать.

  3. Сохраните содержимое токена в надёжном месте — оно показывается только один раз.

Статус мониторинга#

Этот пункт меню навигации состоит из индикатора и названия.

Индикатор показывает текущее состояние компонентов Визион:

  • Красный крест — в работе хотя бы одного компонента будут обнаружены проблемы.

  • Зелёная галочка — все компоненты работают нормально.

Нажатие на пункт навигации приводит к открытию диалогового окна Состояние компонентов. В нём отображается таблица компонентов и их текущий статус.

О программе#

Раздел состоит из трёх вкладок:

  • Системные.

  • Резервная копия.

  • Уведомления.

Системные#

Эта вкладка содержит два блока:

  • Настройки — выбор темы оформления: светлая, тёмная и системная (на основе данных, переданных браузером).

  • О программе — таблица версий компонентов.

Резервная копия#

Эта вкладка используется для создания резервных копий конфигурации Визион и её восстановления.

Уведомления#

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

  • Яркая индикация новых уведомлений — если этот переключатель находится во включенном положении, становятся доступны настройки звука и анимации уведомлений для различных уровней важности.

  • Индикация новых уведомлений при входе — если этот переключатель включен, при авторизации и переходе на главную страницу будет выведено уведомление о новых событиях.