Руководство пользователя Визион
Документ Описание Ссылка на PDF
Руководство пользователя v1.5.2 PDF

1 ОБЩИЕ СВЕДЕНИЯ#

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Параметры конфигурации Визиона для работы с IAM-системами приведены в отдельных документах базы знаний .

2 НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ#

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

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

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

3 РАЗДЕЛЫ ВИЗИОН#

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

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

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

  • Верхнее меню
  • Табло со счётчиками проблем разного уровня критичности
  • Табло уведомлений с кнопкой “Статистика уведомлений” в правом верхнем углу
  • Список последних уведомлений по всем ПАКам Контура
  • Перечень ПАКов, входящих в Контур

Верхнее меню включает в себя следующие пункты:

  • Уведомления
  • Дашборды
  • Объекты
  • Настройки
  • Безопасность

Пункты верхнего меню позволяют перейти на соответствующие разделы “Страницы администрирования” (см. раздел 3.3)

Клик в любом месте строки ПАКа (кроме блока иконок) направляет пользователя на страницу уведомлений по данному ПАКу.

При нажатии на кнопку “Статистика уведомлений” осуществляется переход на страницу, описанную в разделе 3.2.

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

Со стартовой страницы, используя ссылку в блоке уведомлений, пользователь может перейти на страницу «Статистика уведомлений»:

На странице “Статистика уведомлений” отражены следующие блоки:

  • Верхнее меню (описано в разделе 3.1.1)
  • Счётчики по типам критичности уведомлений
  • Список последних уведомлений
  • Список наиболее частых причин возникновения уведомлений
  • Тепловая карта по важности, ПАКам и категориям алертов, отражающая количество уведомлений в разрезе по дням в виде цветовых индикаторов (чем темнее цвет, тем больше уведомлений)
    • При наведении курсора на тепловую карту, всплывает подсказка с интервалом дат, количеством срабатываний и ссылкой на список уведомлений
  • Блок со статистикой по времени реагирования на уведомления

При нажатии на колокольчик осуществляется переход на страницу уведомлений.

В правом верхнем углу можно выбрать период отражения данных: 30, 7, 3 и 1 день.

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

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

В боковом меню находятся следующие разделы:

Раздел Назначение
Уведомления Просмотр списка уведомлений Контура
Дашборды Переход в Grafana
Объекты Управление объектами Контура
Настройки - Метрики  Просмотр метрик, добавление пользовательских метрик
Настройки - Правила оповещения Настройка правил оповещения
Настройки - Конструктор выражений Настройка конструктора выражений, тестирование PromQL выражений
Настройки - Список получателей Настройка списка получателей рассылок
Настройки - Группы рассылки Настройка групп рассылки
Настройки - настройки SMTP Настройка SMTP подключения
Безопасность - Токены доступа Настройка токенов доступа для внешних систем
Безопасность - Ролевая модель Настройка ролевой модели
Статус Визиона Просмотр состояния сервисов Визион и Grafana
О программе Настройки пользовательского интерфейса

3.3.1 Раздел “Уведомления”#

Раздел «Уведомления» содержит список уведомлений мониторинга

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

  • Возникло – Время регистрации события в системе мониторинга;
  • Закрыто – Регистрация факта снятия актуальности события и его время в системе мониторинга
  • Длительность - для закрытых уведомлений интервал между временем возникновения и временем закрытия и для активных уведомлений интервал между временем возникновения и текущим моментом. Выражен в днях, часах, минутах и секундах;
  • ПАК - имя ПАК
  • узел - имя узла
  • Имя правила – имя, заданное пользователем при добавлении правила оповещения;

Важность уведомления подсвечивается цветом поля “Имя правила”:

  • critical красным цветом
  • warning желтым цветом
  • info синим цветом

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

Список уведомлений может быть отсортирован по возрастанию и убыванию с помощью нажатия на иконку сортировки, которая присутствует в заголовке каждой колонки списка:

Если сортировка по полю отсутствует, то иконка отображает две разнонаправленные стрелки. Если выбрана сортировка, то иконка меняет вид и стрелка указывает на порядок сортировки.

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

Над списком уведомлений расположены поле “Поиск” (1), быстрые фильтры - фильтр активности (2) и фильтр критичности (3) и переключатель режима автообновления (4):

С помощью поля “Поиск” пользователь может искать уведомления, значения полей которых содержат введенную подстроку. Поиск начинается с первого введенного символа и не требует нажатия клавиши “Ввод”. Поиск осуществляется по полям “ПАК”, “Узел” и “Имя правила”.

Фильтр активности позволяет отображать в списке “только активные уведомления”, “только закрытые уведомления”, “активные и закрытые уведомления” путем нажатия на иконки “!” и “v”. Если нажаты обе иконки или не нажаты обе иконки, то в список попадают и активные и закрытые уведомления.

Фильтр критичности позволяет фильтровать список в зависимости от важности уведомления (critical, info, warning). В случае, если выбраны или не выбраны все три уровня критичности, то в список попадут уведомления всех уровней критичности.

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

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

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

Правила фильтрации задаются в окне параметров фильтра, которое появляется после нажатия на иконку “воронка”. Описание параметров фильтров и примеры заполнения приведены в таблице:

Поле Описание фильтра Примеры
Возникло Задаются границы диапазона для времени возникномения уведомления - “Начало” и “Окончание”. Даты выбираются либо с помощью календаря, либо через заполнение поля с маской ввода ГГГГ.ММ.ДД ЧЧ.ММ (год, месяц, день, часы, минуты). Должно быть задано значение хотя бы для одного поля. 2024.10.22 11.10
Закрыто Задаются границы диапазона для времени закрытия уведомления - “Начало” и “Окончание”. Даты выбираются либо с помощью календаря, либо через заполнение поля с маской ввода ГГГГ.ММ.ДД ЧЧ.ММ (год, месяц, день, часы, минуты). Должно быть задано значение хотя бы для одного поля. 2024.11.22 10.09
Длительность Задаются границы для длительности “От” и “До” в формате последовательности пар <число><символ>, где <символ> кодирует размер временного интервала (d - дни, h - часы, m - минуты, s - секунды), а <число> определяет количество временных интервалов данного типа. Число может быть дробным для всех типов интервалов кроме секунд 2d 3h 4m 10s
ПАК Выбираются ПАКи в списке с помощью чек-боксов. Список скроллируется с помощью полосы прокрутки справа либо колесом мышки.
Узел Выбираются узлы в списке с помощью чек-боксов. Список скроллируется с помощью полосы прокрутки справа либо колесом мышки.
Имя правила Пользователь выбирает критерий “Содержит” или “Не содержит” и строку, которая должна содержаться или не содержаться в имени правила. Если выбрано два критерия, то они применяются по принципу логического “И” Если выбрано “Содержит” “CPU” и “Содержит” “load”, то отобразятся все уведомления в имени правила которых содержится и “CPU” и “load”

Фильтр применяется после нажатия “Применить” в окне параметров фильтра. Если требуется убрать фильтр, то необходимо нажать “Очистить”. Пример окна параметров фильтра:

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

Также из любого раздела Визион доступна информация о суммарном количестве активных уведомлений (значение счетчика уведомлений), которая отображается в заголовке вкладки в браузере и меню “Уведомления” в панели слева. Цвет иконки в меню “Уведомления” соответствует максимальному уровню критичности в списке уведомлений. Например, если в списке есть хотя бы одно уведомление с уровнем “critical”, то цвет будет красный, если “info” то синий, если “warning” то желтый. В случае, если количество активных уведомлений превышает 99, то в меню “Уведомления” будет выводиться “99+”.

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

3.3.2 Раздел “Объекты”#

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

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

Подробно работа с данным разделом описана в Руководстве Администратора .

3.3.2.1 Предусловия использования#

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

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

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

3.3.2.2 Ограничение использования#

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

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

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

  • ПАК
  • Модуль
  • Узел
  • Виртуальная машина (ВМ)
  • Коммутатор

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

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

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

Процесс настройки агентов описан в документе «Руководство администратора».

3.3.2.3 Типы объектов#
Тип Описание Правая панель (вкладки)
ПАК* Логический тип объекта, соответствующий совокупности аппаратных компонентов и программного обеспечения, решающих прикладные задачи. У объектов типа «ПАК» предусмотрено контекстное меню (по нажатию кнопки ⋮), позволяющее выполнять вспомогательные функции при работе с объектом типа «ПАК». “Метрики”, “Уведомления”, “Обзор”, “Агенты”, “Плагины”
Модуль Структурный элемент Машины, выполняющий определенный набор функций в соответствии с его назначением. Модуль является единым и неделимым элементом спецификации, содержит набор аппаратных узлов и программного обеспечения (ПО). Типы модулей в Визионе соответствуют типам модулей, поставляемых в машинах Скала^р. При работе с формами “Создание ПАК” и “Редактирование ПАК”, доступны модули, которые соответствуют избранному типу ПАК. “Метрики”, “Уведомления”
Узел Аппаратный компонент Машины, на котором работает специализированное ПО, выполняет определенную задачу в составе Модуля. “Метрики”, “Уведомления”
Коммутатор Аппаратный компонент Машины, на котором работает специализированное ПО, выполняет определенную задачу в составе Модуля. “Метрики”, “Уведомления”
ВМ Компонент Машины, на котором работает специализированное ПО, выполняет определенную задачу в составе Модуля. “Метрики”, “Уведомления”

*В Визионе 1.5.1 предусмотрены следующие типы ПАК:

  • Базовый (данный тип используется для нетиповых комплексов и при тестировании отдельных компонентов)
  • МБД.П
  • МБД.Г
  • МБД.КХ
  • МВ.ВК
  • МВ.ВРМ
  • МВ.Г
  • МВ.ДИ
  • МВ.С
  • МХД.Б
  • МХД.О
  • МХД.ДУ
  • Конструктор ПАК
  • МБД.С
  • МБД.Х
3.3.2.4 Объекты. Вкладки#

Вкладка «Метрики» содержит информацию о метриках данного типа объекта.

Вкладка «Уведомления» содержит список уведомлений по избранному объекту.

Вкладка «Обзор» (для объектов с типом “ПАК”) показывает состав объектов, включенных в состав выбранного ПАК, и их параметры размещения.

Вкладка «Агенты» показывает информацию о размещении агентов на узлах и статус инсталляции агентов.

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

  • Расположение – объект, где расположен агент;
  • Тип – тип агента;
  • Статус – статус установки агента.

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

  • Деинсталлировать (для каждого агента в статусе “Установлен”);
  • Сконфигурировать агенты (для всей группы агентов);

Вкладка «Плагины» содержит информацию о плагинах и их статусе инсталляции.

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

  • Имя – имя плагина;
  • Расположение – объект, где расположен агент;
  • Статус – статус плагина.

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

  • Конфигурировать;
  • Деинсталлировать;
  • Переустановить (при статусе «Ошибка»)

3.3.3 Раздел “Настройки - Метрики”#

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

Справочная информация по метрикам доступна в соответствующем разделе Базы знаний .

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

  • Имя – системное имя метрики, задается для настроек других связанных сущностей, например, правил оповещений;
  • Описание – описание метрики, заданное пользователем;
  • Тип – тип метрики в зависимости от поставки (с дистрибутива или создана пользователем).
3.3.3.1 Обзор метрики#

Для вызова формы «Обзор метрики» нужно нажать на строку в таблице «Список метрик».

В обзоре метрики представлена информация о метрике.

3.3.3.2 Добавление пользовательской метрики#

Добавление пользовательской метрики на основе “PromQL выражения”

Для добавления пользовательской метрики необходимо нажать на кнопку «Добавить», появляется форма «Добавление метрики».

Необходимо выбрать тип метрики “Выражение PromQL” и заполнить поля:

  • Имя – Системное имя метрики (Поле обязательное для заполнения, принимает от 5 до 100 символов, допустимы: буквы английского алфавита в верхнем и нижнем регистрах, цифры, символ нижнего подчеркивания, имя метрики должно быть уникальным, при создании пользователем начинается с префикса usr_);
  • Детальное описание – Детальное описание метрики, заданное пользователем (Поле обязательное для заполнения, принимает от 3 до 500 любых символов);
  • Тип объекта – Выбор типа(ов) объекта мониторинга. Этот выбор будет определять для какого объекта в объектной модели на вкладке “Метрики” будет отображаться данная метрика;
  • Выражение - Валидный PromQL запрос, заданный пользователем для дальнейшего использования (Поле принимает синтаксически валидный PromQL запрос).

При нажатии на кнопку “Добавить” метрика будет добавлена, при нажатии “Отмена” все внесенные изменения будут потеряны.

Добавление пользовательской метрики на основе “Bash выражения”

Особенность пользовательской метрики на основе “выражения bash” заключается в том, что выражение, прописанное в соответствующем поле, можно применить сразу на множество узлов (серверов).

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

Поля “Имя”, “Детальное описание”, “Тип объекта” заполняются также как в случае метрики на основе PromQL выражения.

Поле «Выражение» содержит yaml-структуру, состав которой определяется пользователем. В этой структуре описываются правила, по которым формируются метки и значения временных рядов. В рамках одной метрики возможно описание нескольких временных рядов. У одного временного ряда может быть задано несколько меток. Возможно определить метки, которые будут применены ко всем временным рядам (в рамках данной метрики) или только к конкретному временному ряду. Метки описываются в формате <название метки>: <значение метки>.

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

Тэг Описание
labels Раздел для меток, значение которых динамически формируется как результат выполнения команды или скрипта
static_labels Раздел для статических меткок - строк
series Раздел для описания временных рядов
- value Значение временного ряда, которое формируется как результат выполнения команды или скрипта
- static_value Статическое значение - число

Необходимо учитывать, что yaml-структура чувствительна к отступам.

Пример 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.

В поле «Серверы» окна “Добавление метрики” отображаются узлы, входящие в Контур. Они могут иметь следующие состояния:

  • Узел доступен для выбора - плагин установлен и с ним есть связь (имя сервера чёрное)
  • Узел не доступен для выбора – не установлен плагин, либо связь с ним утеряна (имя сервера серое)

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

При нажатии на кнопку “Добавить” метрика будет добавлена, при нажатии “Отмена” все внесенные изменения будут потеряны.

3.3.3.3 Работа с контекстным меню для метрики#

Для вызова контекстного меню нужно нажать на кнопку ⋮ которая находится в списке метрик, после этого откроется контекстное меню для работы с метриками. В случае, если метрика поставлена при развертывании дистрибутива (тип: Системная), действия по таким метрикам будут недоступны. Для метрик, созданных пользователем (тип: Пользовательская), будут доступны действия:

3.3.3.4 Редактирование метрики#

При нажатии на пункт «Редактировать» открывается форма «Редактирование метрики»

Внести необходимые изменения и нажать кнопку «Сохранить».

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

3.3.3.5 Удаление метрики#

Для удаления метрики нужно нажать на пункт «Удалить», в открывшейся форме подтвердить удаление.

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

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

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

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

  • Временной ряд
  • Значение (числовое значение, отражающее последнее значение временного ряда)
  • Статус

Поле «Статус» отражает полноту сбора данных в соответствии со следующей логикой:

  • Красный - данные отсутствуют за установленный период
  • Жёлтый - во временном ряде отсутствует более 10% значений от общего числа значений, которые должны находиться во временном ряде за установленный период
  • Зелёный - временной ряд содержит 100% значений, которые должны находиться во временном ряде за установленный период Установленный период – 2 периода скрепинга

3.3.4 Раздел “Настройки - Правила оповещения”#

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

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

  • Имя – системное имя, используется при добавлении правил оповещения и связывает созависимые сущности;
  • Последнее срабатывание - время фиксации последнего срабатывания правила;
  • Кол-во срабатываний - количество срабатываний данного правила;
  • Категория - категория алерта, задается на стадии добавления правила оповещения;
  • Важность - уровень значимости правила оповещения, заданный пользователем;
  • Активность - состояние правила оповещения (активно/неактивно).
    • Активно – Проверка выполнения условия включена
    • Неактивно – проверка выполнения условия отключена.

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

3.3.4.1 Обзор правила оповещения#

При нажатии на правило оповещения открывается форма «Обзор правила оповещения»

3.3.4.2 Добавление правила оповещения#

Для добавления правила оповещения необходимо нажать на кнопку «Добавить», появляется форма “Добавление правила оповещения”:

Форма «Добавление правила оповещения» содержит следующие поля:

  • Имя – Системное имя, используется при добавлении правил оповещения и связывает созависимые сущности (Поле обязательное для заполнения, принимает от 3-х до 100 символов, буквы в верхнем и нижнем регистрах, цифры, символ нижнего подчеркивания, символ тире, спецсимволы (.%/,()), имя правила оповещения должно быть уникальным);
  • Описание - Краткое описание правила;
  • Правило – Правило оповещения, состоящее из одного или нескольких условий (Добавление дополнительных условий происходит с помощью кнопки «Добавить условие»). Метод (операторы) объединения правил:
    • И – если выполняется все условия происходит срабатывание (В версии 1.4.1 не предусмотрено);
    • ИЛИ - если выполняется любое условие происходит срабатывание;
    • Выражение – позволяет ввести выражение на PromQl для правила оповещения;
  • Метрика - метрика, выбранная пользователем для формирования правила оповещения по ней;
  • Оператор - оператор сравнения, применяемый для сравнения значения метрики, записываемого в центральную базу данных Визиона, с заданным порогом;
  • Порог - пороговое значение для формирования оповещения (Поле обязательное для заполнения, поле принимает число - целое или с плавающей запятой)
  • Период активности - период, в течение которого должно выполняться выражение (условие срабатывания), для формирования оповещения (Поле обязательное для заполнения, поле принимает от 1 до 255 символов, пример “1d”, “1h30m”, “5m”, “10s”);
  • Важность - уровень значимости правила оповещения, задается пользователем;
  • Категории - метки для алертов, которые создаются, когда срабатывает правило и используются администратором для разграничения доступа к алертам. Подробнее - см. раздел Руководства Администратора
  • Детальное описание - Более подробное описание правила
3.3.4.3 Работа с контекстным меню для правил оповещения#

Для вызова контекстного меню нужно нажать на кнопку ⋮

3.3.4.4 Редактирование правила оповещения#

При нажатии на пункт «Редактировать» открывается форма «Редактирование правила оповещения».

Для правил оповещения, входящих в поставку Визион, пункт меню “Редактировать” недоступен.

Внести необходимые изменения и нажать кнопку «Сохранить».

3.3.4.5 Удаление правила оповещения#

Для удаления правил оповещения необходимо нажать на пункт «Удалить», в открывшейся форме подтвердить удаление.

Для правил оповещения, входящих в поставку Визион, пункт меню “Удалить” недоступен.

3.3.5 Раздел “Настройки - Конструктор выражений”#

Подраздел «Конструктор выражений» раздела “Настройки” - это инструмент для анализа метрики в графическом виде. Под графиком формируется таблица с описанием временных рядов: их лейблы (метки) и значения

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

  • Выражение – поле для ввода запроса на языке PromQL;
  • Начало – начальное время и дата начала периода наблюдения;
  • Конец – конечное время и дата окончания периода наблюдения отслеживания;
  • График - график временных рядов.
  • Настройки – настройки отображения стилей графиков
3.3.5.1 Настройки конструктора выражений#

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

Содержит следующие разделы:

  • Основные настройки
    • Переключатель «Существующие метрики» – переключает строку ввода выражения в режим выбора метрики Визиона;
    • Переключатель «Автоматический шаг» – определяет шаг временной шкалы на графике (для линейного типа);
  • Настройки панели
    • Поле «Название» – для ввода подписи панели;
    • Кнопка «Положение названия» – выбор положения названия на панели;
  • Всплывающие подсказки:
    • Переключатель «Следовать за курсором» – при активации панель подсказки будет расположена около курсора при наведении на график;
    • Кнопка «Режим всплывающих подсказок» – выбор режима подсказок (одно значение или все);
  • Легенда
    • Переключатель «Видимость» – при активации выводит легенду на панели графика;
    • Кнопка «Положение легенды» – выбор положения легенды на панели графика;
    • Кнопка «Выравнивание легенды» – выбор варианта выравнивания легенды
  • Ось
    • Поле «Метка» – для ввода подписи на горизонтальной оси;
    • Переключатель «Показать линии сетки» – при активации отображает сетку;
  • Стиль графиков
    • Кнопка «Стиль отображения» – выбор стиля отображения;
    • Кнопка «Линейная интерполяция» – выбор стиля графика линейного типа;
    • Кнопка выбора «Ширина линий» – выбор ширины линии графика;
    • Кнопка «Стиль линий» – выбор стиля линии графика;
    • Кнопка «Соединение нулевых значений» – активация соединения нулевых значений на графике;
  • Пороги
    • Поле «Значение» – ввод первого значения;
    • Поле «Значение 2» – ввод второго значения;
    • Поле «Текст» – выбор подписи порогового значения на графике;
    • Кнопка «Стиль отображения» – установка стиля отображения;
    • Всплывающий список «Цвет текста» – выбор цвета текста;
    • Всплывающий список «Цвет линии» – выбор цвета линий;
    • Всплывающий список «Цвет фона» – выбор цвета фона;
    • Всплывающий список «Цвет заливки» – выбор цвета заливки.

3.3.6 Раздел “Настройки - Список получателей”#

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

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

  • Получатель - имя получателя уведомлений, заданное пользователем;
  • Канал - ресурс пользователя для отправки уведомлений (почта, webhook);
  • Адрес - адрес ресурса пользователя для отправки уведомлений.
3.3.6.1 Обзор получателя#

При нажатии на получателя из списка открывается форма «Обзор получателя»

3.3.6.2 Добавление получателя#

Для добавления получателя уведомлений необходимо нажать на кнопку «Добавить», появляется форма «Добавление получателя»:

Форма «Добавление получателя» содержит следующие поля:

  • Получатель - имя получателя, заданное пользователем (поле обязательное для заполнения, принимает от 3-х до 100 символов, буквы английского и русского алфавитов в верхнем и нижнем регистрах, цифры, символ нижнего подчеркивания, символ тире, пробел, спецсимволы (.%/,()), имя получателя должно быть уникальным);
  • Канал - ресурс пользователя для отправки уведомлений (Email, webhook);
  • Адрес - адрес ресурса пользователя для отправки уведомлений (поле обязательное для заполнения. Поле принимает валидный адрес электронной почты, валидный IP-адрес);
  • Группа - добавление получателя уведомлений в группу(ы) рассылки.
3.3.6.3 Работа с контекстным меню списка получателей#

Для вызова контекстного меню нужно нажать на кнопку ⋮

3.3.6.4 Редактирование получателя уведомлений#

При нажатии на пункт «Редактировать» открывается форма «Редактирование получателя».

Внести необходимые изменения и нажать кнопку «Сохранить».

Редактирование системного получателя уведомлений “SNMP-шлюз” невозможно. При попытке сохранить изменения будет выведено сообщение об ошибке.

3.3.6.5 Удаление получателя уведомлений#

Для удаления получателя нужно нажать на пункт «Удалить», далее в открывшейся форме подтвердить удаление.

Удаление системного получателя уведомлений “SNMP-шлюз” невозможно. При попытке удаления будет выведено сообщение об ошибке.

3.3.7 Раздел “Настройки - Группы рассылки”#

Подраздел “Группы рассылки” раздела “Настройки” содержит информацию о группах рассылки и инструменты для работы с ними.

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

  • Имя – системное имя группы;
  • Описание - описание группы рассылки, заданное пользователем.
3.3.7.1 Обзор группы рассылки#

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

3.3.7.2 Добавление группы рассылки#

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

Форма «Добавление группы рассылки» содержит следующие поля:

  • Имя - имя группы, используемое для формирования для бизнес-логики (поле обязательное для заполнения, принимает от 3-х до 100 символов, буквы английского и русского алфавитов в верхнем и нижнем регистрах, цифры, символ нижнего подчеркивания, символ тире, пробел, спецсимволы (.%/,()), имя группы рассылки должно быть уникальным);
  • Детальное описание - описание группы рассылки, заданное пользователем (поле обязательное для заполнения, принимает от 3-х до 500 любых символов);
  • Блок задания условия получения уведомления:
    • Метка - имя метки, присваиваемое экспортером при сборе метрики, описывающие её характеристики;
    • Оператор – отношение между меткой метрики и ее значением, заданное пользователем;
    • Значение - список допустимых значений для данной метки;
    • Кнопка удаления – Удаляет заданные ранее условия
  • Получатель - выбранный получатель или получатели, которые войдут в состав группы рассылки
3.3.7.3 Работа с контекстным меню списка групп рассылки#

Для вызова контекстного меню нужно нажать на кнопку ⋮

3.3.7.4 Редактирование группы рассылки#

При нажатии на пункт «Редактировать» открывается форма «Редактирование группы рассылки»

Внести необходимые изменения и нажать кнопку «Сохранить».

3.3.7.5 Удаление группы рассылки#

Для удаления группы рассылки нужно нажать на пункт «Удалить», далее в открывшейся форме подтвердить удаление.

3.3.8 Раздел “Настройки - Настройки SMTP”#

Подраздел “Настройки SMTP” раздела “Настройки” содержит параметры настройки SMTP.

Содержит следующие поля настройки:

  • Хост – адрес почтового шлюза (IP/hostname);
  • Порт – номер порта;
  • TLS – активность TLS;
  • Отправитель – адрес Визиона, от лица кого отправлено письмо;
  • Логин – учетная запись Визиона;
  • Пароль – пароль от учетной записи;
  • Основной адрес получателя – почтовый адрес получателя уведомлений по-умолчанию (почта для уведомлений, на которые нет подписки конкретных пользователей).

3.3.9 Раздел “Безопасность - Ролевая модель”#

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

Работа с данным разделом описана в Руководстве Администратора .

3.3.10 Раздел “Безопасность - Токены доступа”#

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

Описание работы с токенами доступа приведено в документе .

3.3.11 Раздел “Статус Визиона”#

Просмотр состояния компонентов доступен при нажатии на кнопку «Статус Визиона».

3.3.12 Раздел “О Программе”#

Раздел настроек пользовательского интерфейса Визиона. Настройки сохраняются на клиентском рабочем месте.

В разделе можно изменить:

  • Шрифт
  • Тему

В разделе доступна информация о версии ПО «Скала^р Визион»

4 РАБОТА С Grafana#

Для работы с данным разделом воспользуйтесь документацией с сайта https://grafana.com/

4.1 Авторизация в Grafana#

Если в Визион настроена аутентификация через внешнего провайдера (например, Keycloak или Avanpost), то пользователь авторизуется один раз используя свою учетную запись в Визион. Полномочия пользователя в Grafana будут определяться полномочиями на дашборды, назначенные для его ролей в Визион.

В случае, если аутентификация через внешнего провайдера отключена, Grafana будет доступна, но пользователи смогут видеть только дашборд “ПАК - Состав (общий)”.

Стартовой страницей является дашборд «ПАК - Состав» (общий):

Если у роли есть полномочия на группу дашбордов “Главная”, то дополнительно будут доступны ссылки для перехода на эти дашборды.

4.2 Дашборды Grafana#

Для перехода в интерфейс ПО Grafana необходимо нажать на раздел «Дашборды» на стартовой странице.

4.3 Список дашбордов#

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

MBDS:

  • МБД.С - Сводная информация

Визион:

  • Визион – Состояние компонентов
  • Визион - Статус Grafana
  • Визион – Статус VictoriaMetrics
  • Визион – Статус Vmagent
  • Визион – Статус Vmalert

Главная:

  • systemd - Сводная информация
  • Визион - Отчет о ресурсах
  • ПАК - ВМС
  • ПАК – Сервер
  • ПАК – Сервер (подробно)
  • ПАК – Коммутатор
  • ПАК – Служебная ВМ
  • Процессы в системе - Сводная информация

МБД.Г:

  • МБД.Г - Сводная информация

МБД.КХ:

  • МБД.КХ - Сводная информация

МБД.П:

  • МБД.П - Cервер (подробно)
  • МБД.П - PostgreSQL
  • МБД.П - Агент Спектра
  • МБД.П - Аппаратное обеспечение
  • МБД.П - Виртуальные среды
  • МБД.П - Информация о кластере
  • МБД.П - Сводная информация
  • МБД.П - Сервер ВМ
  • МБД.П - Сервер
  • МБД.П - Сетевое оборудование
  • МБД.П - Состав по модулям
  • МБД.П - СУБД

МБД.Т:

  • МБД.Т - Сводная информация

МБД.Х:

  • МБД.Х - Сводная информация

МВ.ВК:

  • МВ.ВК - Ceph кластер
  • МВ.ВК - Брест Узлы
  • МВ.ВК - Брест кластер

МВ.С:

  • СУПВ – Обзор
  • ВРМ - Обзор

МХД.О:

  • МХД.О - HAProxy
  • МХД.О - Nginx
  • МХД.О - Кластер S3
  • МХД.О - Кластер хранения
  • МХД.О - Модуль компрессии
  • МХД.О - Сводная информация
  • МХД.О - Сервисы ОС

Утилизация ресурсов:

  • Отчет об утилизации ресурсов
  • Текущая утилизация

ПАК - Состав (общий)