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

ГЛОССАРИЙ#

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

Термин Описание, комментарий
Мониторинг Непрерывный процесс сбора и анализа информации о значении параметров состояния объекта с целью выявления их соответствия желаемому результату
Платформа Программная платформа Скала-Р
Программно-аппаратный комплекс (ПАК) Совокупность аппаратных компонентов (сервера, коммутаторы доступа и т. п.) и программного обеспечения, решающих прикладные задачи (машина баз данных, машина больших данных и т. д.)
Система мониторинга Модуль Мониторинга ПАК в составе Программной платформы Скала-Р
Объект мониторинга Ресурс ПАК, о котором агент собирает данные
Объект управления Компонент ядра модуля мониторинга
Плагин объекта управления Подключаемый программный компонент, позволяющий конфигурировать объекты управления, а также производить интеграцию со сторонними системами сбора метрик
Репозиторий ресурсов объектов управления Наборы графических информационных панелей, правил оповещений, исполняемый файлы агентов сбора данных
Модуль Управления кластером Модуль платформы, обеспечивающий управление и конфигурацию кластерного ПО ПАК
Модуль единой авторизации и разграничения прав доступа Модуль платформы, обеспечивающий авторизацию пользователей платформы и контролирующий возможность взаимодействия с ее компонентами в зависимости от роли пользователя
Пользовательский интерфейс Интерфейс, обеспечивающий передачу информации между пользователем и Модулем Мониторинга ПАК, а также просмотр информации об объектах мониторинга
Агент, агент сбора данных Процесс ОС, собирающий данные о соответствующем объекте мониторинга и предоставляющий к ним доступ по HTTP
Временной ряд Дискретное множество значений во времени определенного числового атрибута (параметра) объекта мониторинга
База данных временных рядов Система хранения простых значений, привязанных к определенным моментам времени
Метрика Временной ряд, который показывает изменение какой-либо величины во времени
Прореживание метрики Механизм архивирования исторических данных, агрегирующий значения метрики в соответствии с политикой прореживания
Визуализация Процесс презентации метрик в визуально удобном формате, что позволяет быстро и интуитивно интерпретировать данные
Информационная панель Интерактивная панель с наглядной визуализацией определенных процессов или состояний, представленных в виде таблиц, диаграмм, графиков
Эффект наблюдателя Воздействие системы мониторинга на наблюдаемые метрики
Оповещение Процедура отправки уведомления о срабатывании предупреждения
Уведомление Текстовое сообщение о предупреждении
Канал уведомления Информация о получателях и методах отправки оповещений
Правило оповещения Информация, определяющая действие по отношению к конкретному экземпляру предупреждения при его получении
Предупреждение Индикатор состояния соответствующей метрики, определяющий факт срабатывания правила предупреждения
Правило предупреждения Условие, применяемое к значению метрики и необходимое для срабатывания предупреждения
Сервер приложения Централизованный сервер, осуществляющий конфигурирование и управление ядром мониторинга и агентами сбора данных, реализацию бизнес-логики, а также взаимодействие с пользовательским интерфейсом
Ядро модуля мониторинга Совокупность взаимоувязанного ПО, обеспечивающего сбор, обработку, хранение и визуализацию информации, полученной от агентов, а так же оповещение о выходе значений метрик за допустимые пределы
База данных Объект сервиса СУБД, в котором пользователи создают таблицы, представления, хранимые процедуры. Обычно для каждого сервиса СУБД создаётся база данных по умолчанию (PostgreSQL), но может быть несколько баз данных.
СУБД Система Управления Базами Данных. Набор программ, позволяющий организовывать, контролировать и администрировать базы данных.
Системная база данных БД, предназначенная для хранения информации об объектах управления, конфигурации ПАК, ролевой модели доступа, конфигурации Модуля Мониторинга
AlertManager Стороннее ПО для организации уведомлений по определенным правилам с использованием различных каналов связи
Grafana Стороннее ПО, позволяющее отображать данные из Prometheus в виде графиков и диаграмм, организованных в информационные панели
VictoriaMetrics Стороннее ПО, отвечающее за сбор метрик от различных агентов и хранение их в БДВР
PromQL Язык запросов Prometheus

#

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

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

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

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

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

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

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

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

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

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

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

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

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

#

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

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

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

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

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

Тип реализующей ЭВМ: x86-64.

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

  • CPU: от 2 ядер;
  • RAM: от 16 Гб;
  • ROM: от 600 Гб SSD для системных компонент;
  • NET: от 1 Гб Ethernet.
  • Internet: доступ к сети, возможно через прокси-сервер, конфигурация используется как опция и используется в контурах, где имеется и разрешён доступ к внешней по отношению к контуру сети.

Операционная среда и общесистемные программные средства

Для установки и работы ПО «Скала^р Визион» требуется операционная система Альт Сервер версии 8.4.

Описание объектов#

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

Существует 4 основным вида ПАКа:

МХД.О

МХД.О - Машина хранения данных Скала^р МХД.О предназначена для создания горизонтально масштабируемого объектного хранилища, совместимого с Amazon S3.

В состав продукта входят:

  • Базовый модуль - Предназначен для реализации базового набора сервисов, необходимых для организации и функционирования хранилища S3.
  • Модули хранения - Устанавливаются в составе Базового модуля и обеспечивают физическое хранение объектов.
  • Модули коммутации и хранения - Подключаются к Базовому модулю для расширения емкости S3 хранилища.
  • Программное обеспечение - Развертывания, обновления и управления;  Балансировки нагрузки;  Распределенного дискового массива; S3 хранилища.

МБД.П

МБД.П - Машина баз данных Скала^р МБД.П предназначена для обработки хранения данных, специально предназначенный для работы СУБД PostgreSQL в высоконагруженных системах.

В состав продукта входят:

  • Вычислительный блок – состоит из Вычислительные узлы и СУБД Postgres Pro Enterprise. Необходим для обработки данных.
  • Блок сетевого взаимодействия – Для обеспечения доставки данных между устройствами.
  • Блок мониторинга и управления - Мониторинг и визуализация работы сети и оборудования, входящего в состав комплекса (Скала^р Мониторинг).
  • Блок резервного копирования – Предназначен создания копии данных на носителе, предназначенном для восстановления информации в оригинальном месте их расположения в случае их повреждения или разрушения.

МБД8

МБД8 - Машина баз данных Скала^р МБД8 предназначена для хранения и аналитической обработки данных. На сегодняшний день существует 5 типов машин:

  • хранилище слабоструктурированных и неструктурированных данных, модель Скала^р МБД.Х (ранее МБД8.АДХ)
  • аналитическая распределённая СУБД массивно-параллельной обработки, модель Скала^р МБД.Г (ранее МБД8.АДБ)
  • сверхбыстрая система распределённых вычислений в оперативной памяти, модель Скала^р МБД.Т (ранее МБД8.АДГ)
  • колоночная аналитическая СУБД, модель Скала^р МБД.КХ (ранее МБД8.АДКМ)
  • система потоковой обработки данных, модель Скала^р МБД.С (ранее МБД8.АДС)

В состав продукта входят:

  • ПО развертывания, обновления, управления и мониторинга
  • ПО для работы с большими данными
  • Сетевая инфраструктура

МВ.С

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

В состав продукта входят:

  • Серверы
  • Сеть
  • ПО виртуализации
  • ПО управления
  • Средства ИБ

#

ГРАФИЧЕСКИЙ WEB-ИНТЕРФЕЙС#

Интерфейс Визион состоит из следующих компонентов:

Раздел приложения (Стартовая страница)#

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

  1. Пример интерфейса стартовой страницы

Раздел «Дашборды»#

В разделе Дашбордов происходит переход в стороннее ПО «Grafana».

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

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

Раздел «Уведомления» содержит информацию о сработавших уведомлениях

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

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

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

  • Имя;
  • Источник;
  • Срабатывание;
  • Снятие;
  • Важность.

Список можно отфильтровать и сортировать.

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

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

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

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

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

  • Имя;
  • Описание;
  • Тип.

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

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

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

  • Имя;
  • Описание;
  • Детальное описание;
  • Выражение.

А также кнопку перехода в браузер метрик и добавление в избранное.

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

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

Содержит список оповещений

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

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

  • Имя;
  • Описание;
  • Последнее срабатывание;
  • Кол-во срабатываний;
  • Важность;
  • Активность.

С помощью кнопки «Добавить» открывается форма «Добавление правила оповещения» с помощью которой можно добавить новое правило оповещения.

  1. Форма Добавление правила оповещения"

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

  • Имя;
  • Описание;
  • Метрика;
  • Оператор;
  • Порог;
  • Период активности;
  • Важность;
  • Шаблон сообщения.

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

Раздел «Список получателей» содержит информацию о получателях и инструменты для работы с ними.

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

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

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

  • Получатель;
  • Канал;
  • Адрес.

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

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

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

  • Получатель;
  • Канал;
  • Адрес;
  • Группа, можно добавить в несколько групп.

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

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

Содержит список групп рассылки

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

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

  • Имя;
  • Описание.

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

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

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

  • Имя;
  • Детальное описание;
  • Метка;
  • Оператор;
  • Значение;
  • Получатель, можно отметить нескольких.

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

Статус Визиона отображает состояние Визиона, при нажатии открывает форму «Состояние компонентов.

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

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

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

В разделе «Настройки» находятся настройки интерфейса, позволяющие пользователю настроить интерфейс под себя.

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

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

Регистрация объекта мониторинга#

Для регистрации объекта мониторинга смотреть руководство администратора (п.2)

УПРАВЛЕНИЕ МОНИТОРИНГОМ#

Работа с аналитическими панелями#

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

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

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

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

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

После этого нажать кнопку «Добавить» откроется форма «Добавление метрики»

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

С помощью кнопки «Браузер метрики» можно открыть браузер метрики в котором можно посмотреть график временных рядов.

Если выражение заполнено неверно появится сообщение об ошибки

  1. Пример сообщения с ошибкой

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

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

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

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

  1. Контекстное меню списка метрик
Удаление метрики#

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

  1. Форма «Удаление»
Редактирование метрики#

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

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

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

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

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

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

В обзоре метрики можно узнать информацию о метрике.

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

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

Для добавления нового правила оповещения можно использовать несколько варинатов правило оповещения можно добавить сражу при создании метрики (п.6.2.1) или добавить на существующую метрику с помощью контекстного меню (п.6.2.2.3). Также можно зайти в подраздел «Правила оповещения» и нажать кнопку «Добавить» при любом варианте открывается форма «Добавление правила оповщения»

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

Необходимо заполнить все поля и нажать кнопку «Сохранить»

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

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

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

Работа с получателями#

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

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

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

Необходимо заполнить все поля. В поле группа можно отметить несколько групп

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

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

  1. Контекстное меню списка получателей
Удаление получателя#

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

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

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

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

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

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

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

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

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

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

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

Настройки#

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

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

  • Шрифт
  • Тему
  • Часовой пояс

РЕШЕНИЕ ПРОБЛЕМ#

Логирование#

Компоненты «Скала^р Визион» выводят отладочную информацию, содержащую сведения о своей работе, в системный журнал в бинарные файлы компонента journal и могут быть просмотрены с помощью команды:

journalctl -fu <название_компонента>

Узнать объём имеющихся на текущий момент логов можно с помощью команды:

journalctl –disk-usage

Рекомендованный способ обработки ошибок#

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

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