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

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

Настройка периодичности выгрузки значений метрик в топик Kafka из экземпляров наблюдаемых компонентов

Параметры задаются в файле application.properties для каждого экземпляра наблюдаемого компонента. Для компонента osmax-ira-guacamole-client — в файле guacamole.properties.

Запись каждой метрики, необходимой для получения значений функциональных показателей, происходит периодически в топик Kafka osmax-observer.metrics.

Периодичность выгрузки значений метрик в топик Kafka (osmax.micrometer.export.kafka.step) задается в конфигурационном файле сервиса для каждого экземпляра и применяется после перезапуска.

Пример: параметры настройки экземпляра компонента для передачи значений метрик в osmax-observer
## Observability
osmax.micrometer.export.kafka.enabled=true                                 // Признак включения публикации метрик в топик Kafka
mp.messaging.outgoing.kafka-meter-registry.topic=osmax-observer.metrics    // Наименование топика Kafka для выгрузки значений метрик
osmax.micrometer.export.kafka.step=60s                                     // Как часто выгружать значения метрик в топик Kafka

Для компонента osmax-ira-guacamole-client требуется включить дополнительную опцию:

observability-enabled: true

Регистрация новых экземпляров компонентов

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

Для того чтобы показатели нового экземпляра компонента отображались в интерфейсе «Кабинет администратора», для этого экземпляра выполните настройку согласно пункту «Настройка периодичности выгрузки значений метрик в топик Kafka из экземпляров наблюдаемых компонент».

После этого формируемые новым экземпляром компонента метрики будут доставляться в osmax-observer.

Если osmax-observer при анализе поступающих из топика Kafka данных обнаруживает имя экземпляра компонента, не зарегистрированное в справочнике экземпляров компонентов, то имя этого экземпляра добавляется в справочник экземпляров. В интерфейсе «Кабинет администратора» для этого экземпляра будут отображаться системные показатели.

Управление перечнем экземпляров наблюдаемых компонентов

Справочник компонентов и их экземпляров (instance) не изменяется пользователем:

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

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

Если osmax-observer при анализе поступающих из топика Kafka данных обнаруживает имя экземпляра компонента, не зарегистрированное в cправочнике экземпляров компонентов, то имя этого экземпляра добавляется в справочник экземпляров. В интерфейсе «Кабинет администратора» для этого экземпляра будут отображаться системные показатели.

Удаление экземпляра компонента

Если экземпляр компонента перестал функционировать, то в интерфейсе «Кабинет администратора» для этого экземпляра статусы системных показателей будут иметь значение «Ошибка». Если наблюдение за остановленным и удаленным экземпляром компонента более не требуется, то этот экземпляр компонента необходимо удалить из справочника экземпляров компонентов и таблицы с подготовленными показателями при помощи инструментов работы с СУБД с использованием SQL-запроса.

SQL-запрос на удаление экземпляра компонента
-- Database: osmax_observer

DO $$

  DECLARE
    v_component TEXT := 'код компонента';
    v_instance TEXT  := 'имя экземпляра компонента';

BEGIN

    DELETE
    FROM    osmax_observer.instances
    WHERE
    component_code= v_component
    AND
    name = v_instance;

    DELETE
    FROM    osmax_observer.metric_values
    WHERE
    component_code= v_component
    AND
    component_instance = v_instance;

END $$;

Перед выполнением SQL-запроса задайте значения переменных v_component и v_instance.