Состояние компонентов

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

  • osmax-core,

  • osmax-provisioner

  • osmax-ira-guacamole-client,

    оперативно реагировать на нештатные ситуации и анализировать их причины.

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

  • метрики состояния здоровья;

    • самодиагностика (SelfCheck) экземпляра компонента;

    • доступность (HealthCheck) интеграций экземпляра компонента с общесистемными сервисами;

  • бизнес-метрики для функциональных показателей. Только из экземпляров компонента osmax-core.

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

См. подробнее в разделе «Настройки наблюдаемых компонентов для передачи значений метрик в osmax-observer».

Системные показатели

Системные показатели предназначены для наблюдения за состоянием:

  • самодиагностики (SelfCheck) экземпляра компонента;

  • доступности (HealthCheck) интеграций экземпляра компонента с общесистемными сервисами.

Статусная модель

  • Стабильно — данные для показателя поступают и содержат информацию о доступности интеграции;

  • Ошибка — за заданный в настройке период (параметр: актуальность данных) не поступило данных метрик по показателю от наблюдаемого компонента или данные поступили и содержат информацию о недоступности интеграции.

Перечень системных показателей

Код показателя Проверяемая интеграция Наименование показателя Способ получения значения для метрики показателя

osmax-core

osmax-core-selfcheck-01

Самодиагностика osmax-core

Самодиагностика osmax-core

Всегда возвращается 1.0 (штатное функционирование) экземпляра osmax-core

osmax-core-db-01

БД PostgreSQL для osmax-core

Интеграция с БД PostgreSQL

Анализируется значение предустановленной во фреймворке функции проверки здоровья

"name": "Database connections health check"

Формируется фреймворком через конечную точку /q/health

osmax-core-kafka-01

Apache Kafka

Интеграция с Kafka

Анализируется значение предустановленной во фреймворке функции проверки здоровья

"name": "SmallRye Reactive Messaging - readiness check"

Кумулятивно по всем топикам

osmax-core-s3-salt-01

S3-совместимое хранилище

Интеграция с S3-бакетом salt-bucket

Анализируется значение предустановленной во фреймворке функции проверки здоровья

"name": "Salt S3 connection health check"

Кумулятивно для бакетов:

  • salt-bucket;

  • script-bucket

osmax-core-s3-multimedia-01

S3-совместимое хранилище

Интеграция с S3-бакетом multimedia-bucket

Анализируется значение предустановленной во фреймворке функции проверки здоровья

"name": "Multimedia S3 connection health check"

Кумулятивно для бакетов:

  • multimedia-bucket;

  • script-bucket

osmax-core-ldap-01

LDAP

Интеграция с LDAP

По настройкам интеграции osmax-core с LDAP выполняется запрос на установление соединения с источниками данных LDAP

osmax-core-osmax-ira-guacamole-client-01

Шлюз УД (osmax-ira-guacamole-client)

Интеграция со шлюзом УД (osmax-ira-guacamole-client)

Выполняется проверка доступности HTTP-запросом в специальную диагностическую конечную точку /health сервиса osmax-ira-guacamole-client. Адрес сервиса osmax-ira-guacamole-client задан в файле osmax-core/application.properties в параметре quarkus.rest-client.remote-access.url=http://…​

osmax-provisoner

osmax-provisioner-selfcheck-01

Самодиагностика osmax-provisioner

Самодиагностика osmax-provisioner

Всегда возвращается 1.0 (штатное функционирование) экземпляра osmax-provisioner

osmax-provisioner-permissions-service-01

osmax-core

Интеграция с osmax-core

Выполняется HTTP-запрос к API osmax-core на получение привилегий специального (для проверки привилегий) системного пользователя

osmax-provisioner-db-01

БД PostgreSQL для osmax-provisioner

Интеграция с БД PostgreSQL

Анализируется значение предустановленной во фреймворке функции проверки здоровья

"name": "Database connections health check"

Формируется фреймворком через конечную точку /q/health

osmax-provisioner-repository-01

Репозиторий установочных пакетов для osmax-provisioner

Интеграция с репозиторием для сборки образов

В конфигурационных файлах osmax-provisioner указаны настройки URL для скачивания артефактов процесса установки:

  • ipxeLkrn;

  • isohdpxfBin;

  • isolinuxBin;

  • ldlinuxC32;

  • menuC32;

  • ipxeX86-64Efi.

Для каждого из них выполняется проверка доступности HTTP-запросом в URL

osmax-provisioner-kafka-01

Apache Kafka

Интеграция с Apache Kafka a

Анализируется значение предустановленной во фреймворке функции проверки здоровья

…​. "name": "SmallRye Reactive Messaging - readiness check" …​.

Кумулятивно по всем топикам

osmax-provisioner-s3-01

S3-совместимое хранилище

Интеграция с S3-совместимым хранилищем

Анализируется значение предустановленной во фреймворке функции проверки здоровья

"name": "S3 connectivity health check"

Шлюз УД (osmax-ira-guacamole-client)

osmax-ira-guacamole-client-selfcheck-01

Самодиагностика osmax-ira-guacamole-client

Самодиагностика osmax-ira-guacamole-client

Всегда возвращается 1.0 (штатное функционирование) экземпляра osmax-ira-guacamole-client

osmax-ira-guacamole-client-jdbc-01

БД PostgreSQL для Шлюза УД guacamole_db

Интеграция с JDBC

Выполняется запрос "SELECT 1" в Postgres DB для Шлюза УД

osmax-ira-guacamole-client-guacd-01

guacamole-server

Интеграция с guacamole-server

Проверка с помощью Handshake Guacamole protocol

osmax-ira-guacamole-client-ldap-01

LDAP

Интеграция с LDAP

По настройкам интеграции osmax-ira-guacamole-client с LDAP выполняется запрос на получение конфигурации LDAP-сервера

Функциональные показатели

Функциональные показатели формируются только для компонента osmax-core.

Статусная модель

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

  • Предупреждение — данные для показателя поступают, полученные значения имеют отклонение от значения, заданного в параметре смены статуса для данного показателя;

  • Ошибка — за заданный в настройке период (параметр: актуальность данных) не поступило данных метрик по показателю от наблюдаемого компонента.

Перечень функциональных показателей

Код показателя Наименование показателя Описание показателя Правило формирования значения метрики (задается в osmax-core) Рекомендуемое значение смены статуса (задается в osmax-observer) Наименование метрики, публикуемой osmax-core

osmax-core-minions-online

Процент устройств в сети

Отображает процент устройств со статусом в сети. Рассматриваются только устройства с установленным агентом (minion)

Текущее количество устройств на момент формирования метрики, удовлетворяющих условию: со статусом в сети на момент формирования метрики

Меньше 80%.

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-minions-online|osmax-core

  • osmax.core.minions.online

  • osmax.core.machines.with.minions.total

osmax-core-minions-offline

Процент устройств не в сети

Отображает процент устройств не в сети. Рассматриваются только устройства с установленным агентом (minion)

Текущее количество устройств на момент формирования метрики, удовлетворяющих условию: со статусом не в сети на момент формирования метрики

Больше 20%.

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-minions-offline|osmax-core

  • osmax.core.minions.offline

  • osmax.core.machines.with.minions.total

osmax-core-machines-total

Общее количество устройств

Общее количество устройств, зарегистрированных в Осмакс, включая устройства с не установленным агентом (minion)

Текущее количество устройств на момент формирования метрики, удовлетворяющих условию:

  • установлен миньон;

  • не установлен миньон

Меньше 1. Отображается для справки, смена статуса не требуется.

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-machines-total|osmax-core

osmax.core.machines.total

osmax-core-machines-minion

Количество устройств с установленным агентом (minion)

Общее количество устройств с установленным миньоном

Текущее количество устройств на момент формирования метрики, удовлетворяющих условию: установлен агент (minion)

Меньше 1.

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

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-machines-total|osmax-core

osmax.core.machines.with.minions.total

osmax-core-configurations-not-used

Неиспользуемые конфигурации

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

На момент формирования метрики вычисляется количество конфигураций, удовлетворяющих условию:

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

  • прошло более двух недель с момента приостановки последнего назначения (учитывая все версии этой конфигурации);

  • не учитываются конфигурации, предназначенные для ПО «Магазин приложений»

Больше 0 (Не используемых конфигураций за период) Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-configurations-not-used|osmax-core

osmax.core.unused.configurations

osmax-core-minions-assignment-waiting

Процент устройств, ожидающих применения конфигурации

Процентное отношение (ожидает/назначено):

  • количества агентов (minions) с активным статусом, на которые не применяются назначенные конфигурации и находятся в статусе ожидает применения;

  • к назначениям конфигураций на агенты (minions);

  • за наблюдаемый период

На момент формирования метрики вычисляется количество агентов (minions), удовлетворяющих условию:

  1. Агент (minion) активен на момент вычисления данных для метрики.

  2. Нна агент (minion) назначены конфигурации за наблюдаемый промежуток времени.

  3. Наблюдаемый промежуток времени — это последние N часов с момента вычисления показателя, за исключением последних M часов. Задается в параметрах вычисления метрики.

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

  5. Учитываются все конфигурации, для которых возможно назначение для применения.

  6. Заказы ПО через «Магазин приложений» не учитываются.

Параметры вычисления метрики задаются в БД osmax-core в таблице app_config:

  1. Последние N часов с момента вычисления показателя. Код параметра metric.settings.minions-assignment.include.interval.hours. Значение по умолчанию: 24 (часа).

  2. Исключить из наблюдения последние M часов. Код параметра metric.settings.minions-assignment.exclude.interval.hours

Больше 10% (конфигураций ожидает применения за период).

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-minions-assignment-waiting|osmax-core

osmax.core.minions.assignment.waiting.percentage

osmax-core-minions-assignment-error

Процент устройств с ошибкой применения конфигурации

Процентное отношение (ошибка /назначено):

  • количества агентов (minions) с активным статусом, на которые не применяются назначенные конфигурации и находятся в статусе ошибка применения;

  • к назначениям конфигураций на агенты (minions);

  • за наблюдаемый период

На момент формирования метрики вычисляется количество агентов (minions), удовлетворяющих условию:

  1. Аагент (minion) активен на момент вычисления данных для метрики.

  2. На агент (minion) назначены конфигурации за наблюдаемый промежуток времени;

  3. Наблюдаемый промежуток времени — это последние N часов с момента вычисления показателя, за исключением последних M часов. Задается в параметрах вычисления метрики.

  4. Конфигурации находятся в статусе ошибка применения на момент вычисления данных для метрики.

  5. Учитываются все конфигурации, для которых возможно назначение для применения.

  6. Заказы ПО через «Магазин приложений» не учитываются.

Параметры вычисления метрики задаются в БД osmax-core в таблице app_config:

  1. Последние N часов с момента вычисления показателя. Код параметра metric.settings.minions-assignment.include.interval.hours. Значение по умолчанию 24 (часа).

  2. Исключить из наблюдения последние M часов. Код параметра metric.settings.minions-assignment.exclude.interval.hours

Больше 10% (конфигураций в статусе "ошибка применения" за период).

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-minions-assignment-error|osmax-core

osmax.core.minions.assignment.error.percentage

osmax-core-minions-assignment-success-percentage

Процент успешного применения конфигураций в КА

Процент успешного применения конфигураций (применено / должно быть применено) за наблюдаемый период

На момент формирования метрики вычисляется процент успешного применения конфигураций к устройствам (применено / назначено для применения), среднее по всем существующим применениям конфигураций за наблюдаемый промежуток времени, согласно условиям:

  1. Наблюдаемый промежуток времени — это последние N часов с момента вычисления показателя, за исключением последних M часов.

  2. Задается в параметрах вычисления метрики.

  3. Применено означает: агент (minion) получил назначенную конфигурацию, применил ее, вернул ответ об успешном применении и для этого применения конфигурации к агенту (minion) зарегистрирован успешный статус применения в БД osmax-core.

  4. Учитываются все конфигурации, для которых возможно назначение для применения.

  5. Учитываются только те конфигурации, которые применяются к агентам (minions) с активным статусом.

Параметры вычисления метрики задаются в БД osmax-core в таблице app_config:

  1. Последние N часов с момента вычисления показателя. Код параметра metric.settings.minions-assignment.include.interval.hours. Значение по умолчанию 24 (часа).

  2. Исключить из наблюдения последние M часов. Код параметра metric.settings.minions-assignment.exclude.interval.hours. Значение по умолчанию 6 (часов)

Меньше 40%.

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-minions-assignment-success-percentage|osmax-core

osmax.core.minions.assignment.success.percentage

osmax-core-configurations-orders-applied

Процент успеха установки/удаления ПО в «Магазине приложений»

Процентное соотношение успешной установки/удаления ПО в «Магазине приложений» (применено/ошибка)

На момент формирования метрики вычисляется текущее значение для:

  • общее количество успешно выполненных операций (заказов);

  • общее количество операций (заказов) установки/удаления ПО в «Магазине приложений»;

  • из значений метрик вычисляется процентное отношение

Меньше 40%.

Задается в БД osmax-observer в таблице settings в параметре

metric.osmax-core-configurations-orders-applied/osmax-core

  • osmax.core.orders.completed;

Просмотр показателей состояния компонентов

Для просмотра списка показателей функционирования компонент, их значений и текущих статусов:

На боковой панели главной страницы выберите пункт Состояние компонентов. На экране отобразится список показателей функционирования компонент, сгруппированный по атрибутам:

  • компонент;

  • тип показателя: системный/функциональный.

observer all components

Для каждого показателя отображается его текущее значение и статус в виде графического символа. Для значения показателя отображаются дата и время его актуализации. Для статуса отображаются дата и время его последнего изменения.

observer buisines components

Список показателей может быть отфильтрован по атрибутам:

  • компонент;

  • тип группы показателей: системный/функциональный;

  • наименование показателя с выбором из списка (наименование показателя — код);

  • статус показателя.

    observer system components
    observer filter 2

Для просмотра подробной информации по показателю:

  1. Выберите показатель.

  2. Кликните по символу с вопросом в правом конце строки показателя. Откроется модальное окно просмотра подробностей по показателю, в котором отображены:

    • для функциональных показателей:

      • текущий статус показателя;

      • значение параметра смены статуса;

      • статистика по показателю за периоды. Значение соответствует каждому периоду — среднее значение показателя за период.

        observer buisines detail

    • для системных показателей:

      • имя хоста, на котором запущен экземпляр компонента;

      • наличие ошибок по показателю за периоды. Значение соответствующее каждому периоду означает:

        • Нет - ошибок за период не было;

        • Есть - была одна или более ошибок за период.

          observer system detail

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

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