Reporter on Alertix

Общие сведения

Mon, 01 Jan 0001 00:00:00 +0000

Модуль формирования отчетов (Reporter) осуществляет выполнение поисковых запросов в соответствии с заданными правилами и шаблонами и вывод полученных результатов в форматах электронных таблиц и электронных документов с использованием разметки (PDF).

Модуль отчетности представляет собой отдельный python-сервис в докер-контейнере, работающий на одном хосте с платформой на 5055 порту.

Платформа предоставляет возможность формирования отчетов 2 видов:

Аналитический - отчет в виде xlsx-файла о событиях, строится на основании изменяемого yaml-шаблона с использованием yaml-правил. Назначение отчета – ретроспективный ручной анализ значимых событий, выгрузка полей событий в табличном представлении. Допускается изменение правил и шаблона.

Загрузка логотипа и названия формирующего подразделения

Mon, 01 Jan 0001 00:00:00 +0000

Формируемые отчеты могут содержать логотип организации и название подразделения, выполняющего функции эксплуатации Платформы. Загрузка логотипа и названия подразделения доступна только администратору Платформы. Для добавления элементов бренда выберите операцию «Брендирование».

На открывшейся странице загрузите файл логотипа в формате PNG или JPG. Логотип должен иметь размеры не больше 170х70 пикселов. В поле «Подразделение» укажите построчно наименование подразделений оргструктуры. Примените изменения нажатием кнопки «Сохранить».

Рисунок 1.

Конфигурация параметров сервиса

Mon, 01 Jan 0001 00:00:00 +0000

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

В поле «Reporter URL» указан URL адрес расположения сервиса, заданный при его установке.

Установите уровень логирования событий о работе сервиса:

в положении «Выкл.» запущен уровень логирования Info – информационные уведомления;
в положении «Вкл.» запущен режим отладки Debug – отладочные события.

Рисунок 1.

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

Остановка, запуск и перезапуск сервиса Reporter

Mon, 01 Jan 0001 00:00:00 +0000

Остановка и запуск контейнера модуля формирования отчетов Reporter является задачей оператора. Для остановки контейнера служит блок «Остановка». При его выборе будет запущена задача остановки контейнера, результат которой будет отображен на экране (см. пример на рисунке).

Рисунок 1.

Для запуска или перезапуска контейнера выберите операцию «Запуск». Результат выполнения этой задачи будет отображен на экране (см. пример на рисунке).

Рисунок 2.

Удаление сервиса

Mon, 01 Jan 0001 00:00:00 +0000

Для удаления сервиса Reporter выберите операцию «Удаление» и нажмите кнопку «Удалить».

Рисунок 1.

Создается фоновая задача с именем: remove_<имя сервиса>_service_<доменное имя хоста>. Ход выполнения задачи можно наблюдать на странице «Задачи», доступной из раздела Мониторинг > Задачи.

В случае, если хост с компонентом недоступен, переведите переключатель Принудительное удаление в положение «Вкл.» и нажмите «Удалить».

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