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

#

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2.2 Характеристики и конфигурация технических средств

Технические характеристики указаны в руководстве Администратора.

3 ОБЗОР РАЗДЕЛОВ#

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

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

Стартовая страница позволяет осуществить переход в:

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

3.2 Модуль администратора

Модуль администратора состоит из следующих разделов:

3.2.1 Страница авторизации

Если включена авторизация по OpenID-Connect, то при входе в Модуль администратора произойдет переадресация на окно авторизации.

Окно авторизации

3.2.2 Раздел «Уведомления»

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

Список уведомлений

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

  • Описание – Сообщение, заданное пользователем;
  • Источник – Компонент, на котором произошло срабатывание;
  • Срабатывание – Время регистрации события в системе мониторинга;
  • Снятие – Регистрация факта снятия актуальности события и его время в системе мониторинга
  • Важность – Уровень значимости правила оповещения, заданное пользователем.
  • Метки - Лейблы используются для поиска и для агрегации значения метрики и временных рядов.

3.2.3 Раздел «Конструктор выражений»

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

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

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

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

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

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

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

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

3.2.4 Раздел «Параметры»

3.2.4.1 Подраздел «Инсталляционная карта»

Пользовательский интерфейс, позволяющий в интерактивном режиме осуществить первичные настройки Визиона перед установкой агентов на узлы машины. Упрощает процесс составления пользователем файла inventory.yml.

Инсталляционная карта

3.2.4.2 Подраздел «Метрики»

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

Список метрик

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

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

3.2.4.2.1 Обзор метрики

Форма «Обзор метрики»

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

3.2.4.2.2 Форма «Добавление метрики»

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

Форма «Добавление метрики»

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

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

3.2.4.3 Подраздел «Правила оповещения»

Подраздел «Правила оповещения» содержит информацию о правилах оповещения и формы для работы с ними.

Список правил оповещения

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

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

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

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

Форма «Обзор правила оповещения»

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

3.2.4.3.2 Форма «Добавление правила оповещения»

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

Форма “Добавление правила оповещения”

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

  • Имя – Системное имя, используется при добавлении правил оповещения и связывает созависимые сущности (Поле обязательное для заполнения, принимает от 3-х до 100 символов, буквы в верхнем и нижнем регистрах, цифры, символ нижнего подчеркивания, символ тире, спецсимволы (.%/,()), имя правила оповещения должно быть уникальным);
  • Правило – Правило оповещения, состоящее из одного или нескольких условий (Добавление дополнительных условий происходит с помощью кнопки «Добавить условие»). Типы правил:
    • И – если выполняется все условия происходит срабатывание (В версии 1.1.1 не предусмотрено);
    • ИЛИ - если выполняется любое условие происходит срабатывание;
    • Выражение – позволяет ввести выражение на PromQl для правила оповещения;
  • Метрика - метрика, выбранная пользователем для формирования правила оповещения по ней;
  • Оператор - оператор сравнения, применяемый для сравнения значения метрики, записываемого в центральную базу данных Визиона, с заданным порогом;
  • Порог - пороговое значение для формирования оповещения (Поле обязательное для заполнения, поле принимает число - целое или с плавающей запятой)
  • Период активности - период, в течение которого должно выполняться выражение (условие срабатывания), для формирования оповещения (Поле обязательное для заполнения, поле принимает от 1 до 255 символов, пример “1d”, “1h30m”, “5m”, “10s”);
  • Важность - уровень значимости правила оповещения, задается пользователем;
  • Шаблон сообщения - детальное описание ситуации, используется в уведомлении пользователя (Поле обязательное для заполнения, принимает от 3-х до 500 любых символов). Для заполнения доступны маски ввода в формате Alertmanager, например: {{ $labels.instance }}. Примеры можно посмотреть на сайте, поле description: https://prometheus.io/docs/alerting/latest/notification_examples/

3.2.4.4 Подраздел «Список получателей»

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

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

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

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

3.2.4.4.1 Обзор получателя

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

Форма «Обзор получателя»

В обзоре получателя можно доступна информацию о получателе.

3.2.4.4.2 Форма «Добавление получателя»

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

Форма “Добавление получателя"

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

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

3.2.4.5 Подраздел «Группы рассылки»

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

Список групп рассылки

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

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

3.2.4.5.1 Обзор группы рассылки

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

Форма «Обзор группы рассылки»

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

3.2.4.5.2 Форма «Добавление группы рассылки»

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

Форма “Добавление группы рассылки”

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

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

3.2.4.6 Подраздел «Настройка SMTP»

Раздел «Настройка SMTP» содержит параметры настройки SMTP.

Настройка SMTP

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

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

3.2.5 Раздел «Статус Визиона»

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

Форма «Состояние компонентов»

3.2.6 Раздел «Настройки»

Раздел персональных настроек ПО Визион. Сохраняются на клиентском рабочем месте.

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

Раздел «Настройки»

3.3 Аналитические панели

Для работы с аналитическими панелями используется ПО Grafana.

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

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

3.3.1 Авторизация в Grafana

Окно авторизации Grafana.

Стартовой страницей является дашборд «Список узлов»

Стартовый дашборд «Список узлов»

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

Для просмотра списка дашбордов необходимо нажать «Dashboards», отобразится список разделов с дашбордами:

General:

  • Визион - Список узлов

Главная:

  • Визион - Информация об узле
  • Визион - Отчет о ресурсах
  • Визион - Статус Blackbox Exporter
  • Визион - Статус Grok Exporter
  • Визион - Статус IPMI Exporter
  • Визион - Статус SNMP
  • Визион - Статус коммутатора
  • Визион - Статус Grafana
  • Визион – Статус VictoriaMetrics
  • Визион – Статус Vmagent
  • Визион – Статус Vmalert

МБД.П:

  • Визион – Агент Спектра
  • МБД.П - Информация о кластере
  • МБД.П - Обзор БД PostgreSQL

МВ.ВК:

  • Визион - Ceph кластер
  • Визион - Брест Узлы
  • Визион - Брест кластер

МВ.С:

  • СУПВ – Обзор
  • Состояние ВРМ

МХД.О:

  • Acronis Storage CS details
  • Acronis Storage MDS details
  • Acronis Storage core cluster overview
  • Acronis Storage mountpoint details
  • Object Storage NS details
  • Object Storage OS details
  • Object Storage overview
  • S3 geo-replication overview
  • S3 overview

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

  • Визион - Метрики экспортера утилизации
  • Визион - Отчет об утилизации ресурсов
  • Визион - Утилизации дисков по модулям
  • Визион - Утилизация дисков по узлам

4 РЕГИСТРАЦИЯ И ВЕДЕНИЕ СПИСКА ОБЪЕКТОВ МОНИТОРИНГА#

4.1 Работа с инсталяционной картой

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

Для настройки элементов инсталляционной карты необходимо открыть раздел «Параметры» и открыть подраздел «Инсталляционная карта».

Подраздел «Инсталляционная карта»

Нажать на контекстное меню Контура, нажать на «Добавить ПАК»

Контекстное меню контура

Заполняем форму «Добавление ПАК», выбираем необходимые модули, указываем корректные названия.

Заполнение модуля

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

Форма «Добавление ПАК» после заполнения.

4.1.2 Работа с контекстным меню ПАК

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

Контекстное меню ПАК

4.1.2.1 Создание инвентори

При выборе пункта «Инвентори» файл конфигурации сохраняется на пользовательское устройство.

4.1.2.2 Дублирование

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

4.1.2.3 Удаление

Для удаления ПАК необходимо нажать кнопку «Удалить» и подтвердить удаление в форме «Удаление»

Форма «Удаление»

5 РАБОТА С МОДУЛЕМ АДМИНИСТРАТОРА#

5.1 Работа с метриками

5.1.1 Добавление метрики

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

Подраздел «Метрики»

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

Заполнить поля ввода валидными значениями и нажать на кнопку «Добавить», при заполнении формы предусмотрены интерактивные подсказки, если поля заполнены некорректно. Так же и во всех формах ПО «Скала^р Визион».

Форма «Добавление метрики»

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

Окно «Дальнейшие действия»

5.1.2 Работа с контекстным меню

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

ref2

Контекстное меню списка метрик

5.1.2.1 Удаление метрики

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

Форма «Удаление»

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

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

Форма «Редактирование метрики»

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

5.2 Работа с правилами оповещения

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

Для добавления нового правила оповещения предусмотрено два сценария:

- добавить сразу при добавлении метрики (п.6.1.1);

- зайти в подраздел «Правила оповещения» и нажать кнопку «Добавить».

Во всех вариантах открывается форма «Добавление правила оповщения».

Форма «Добавление правила оповещения»

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

5.2.2 Работа с контекстным меню

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

ref2

Контекстное меню списка правил оповещений

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

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

Форма «Удаление»

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

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

Форма «Редактирование правила оповещения»

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

5.3 Работа со списком получателей

5.3.1 Добавление получателя уведомлений

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

Форма «Добавление получателя»

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

5.3.2 Работа с контекстным меню списка получателей

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

ref3

Контекстное меню списка получателей

5.3.2.1 Удаление получателя

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

Форма «Удаление»

5.3.2.2 Редактирование получателя

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

Форма «Редактирование получателя»

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

5.4 Работа с группами рассылки

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

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

Форма «Добавление группы»

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

5.4.2 Работа с контекстным меню списка групп рассылки

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

ref3

Контекстное меню списка групп рассылки

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

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

Форма «Удаление»

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

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

Форма «Редактирование группы рассылки»

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

5.5 Настройки

Раздел «Настройки»

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

  • Шрифт
  • Тему

Так же в текущем разделе отображается информации о версии ПО Визион.

6 РАБОТА С АНАЛИТИЧЕСКИМИ ПАНЕЛЯМИ#

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