Отчеты

Вы можете настроить регулярное формирование отчетов о состоянии процессов и объектов в KUMA.

Отчеты формируются с помощью шаблонов отчетов. Шаблоны отчетов находятся в разделе Отчеты на вкладке Шаблоны.

Сформированные отчеты хранятся в разделе Отчеты на вкладке Сформированные отчеты.

Чтобы сохранять сформированные отчеты в форматах HTML и PDF необходимо установить требуемые пакеты на устройстве с Ядром KUMA.

При развертывании KUMA в отказоустойчивом варианте временная зона сервера Ядра KUMA и время в браузере пользователя могут различаться. Это различие проявляется в расхождении времени, которое проставляется в отчетах, сформированных по расписанию, и данных, которые пользователь может экспортировать из виджетов. Чтобы избежать расхождения, рекомендуется настроить расписание формирования отчетов с учетом разницы временной зоны пользователей и временем UTC.

Шаблон отчета

Шаблоны отчетов используются для указания условий и данных, на основе которых будет сформирован отчет, а также для настройки периода формированияотчетов. Пользователи с ролью Главного администратора, Администратора тенанта, Аналитика второго уровня и Аналитика первого уровня( могут создавать, изменять и удалять шаблоны отчетов. Отчеты, сформированные с использованием шаблонов отчетов, отображаются на вкладке Сформированные отчеты.

Шаблоны отчетов доступны на вкладке Шаблоны раздела Отчеты, где отображается таблица существующих шаблонов. В таблице представлена следующая информация:

• Название – название шаблона отчетов.

  Вы можете отсортировать шаблоны отчетов, нажав на значок сортировки в заголовке столбца и выбрав По возрастанию или По убыванию.

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

  При поиске шаблонов отчетов используются регулярные выражения.

• Тенант – название тенанта, которому принадлежит шаблон отчета.
• Последнее обновление – дата и время последнего обновления шаблона отчета.

  Вы можете отсортировать таблицу по этому столбцу, нажав на значок сортировки в заголовке столбца и выбрав По возрастанию или По убыванию.

• Создал – имя пользователя, создавшего шаблон отчета.
• Описание – информация о шаблоне отчета, которую вы можете добавить при необходимости.
• Теги – теги для поиска шаблона отчета. Вы можете искать шаблоны отчетов, нажав на значок сортировки в заголовке столбца, указав значение для поиска в поле Поиск или выбрав теги с помощью флажков.
• Расписание – периодичность, с которой отчеты должны формироваться по созданным шаблонам. Если расписание отчета не настроено, отображается значение выключено.
• Последний отчет – дата и время формирования последнего отчета по шаблону отчета.
• Название пакета – название пакета инструментов, предназначенного для обработки событий.
• Отправить по электронной почте – метка о настроенном уведомлении пользователей по почте о сформированных отчетах.

При необходимости вы можете настроить отображение столбцов в таблице, нажав на значок шестеренки .

После выбора шаблона отчета в списке вы можете нажать на значок меню , чтобы открыть раскрывающийся список с доступными действиями:

• Показать зависимости – используйте это действие, чтобы открыть окно графа зависимостей для выбранного шаблона отчета. При необходимости в окне графа можно скачать данные о зависимостях в формате SVG и настроить фильтры для показа зависимостей на графе.
• Показать историю версий – используйте это действие, чтобы посмотреть историю версий интересующего вас шаблона отчета. При необходимости в открывшейся боковой панели вы можете сравнить версии между собой и восстановить ранее использованную версию.
• Запустить отчет – используйте это действие, чтобы сформировать отчет. Созданные отчеты отображаются на вкладке Сформированные отчеты.
• Показать все сформированные отчеты – используйте это действие, чтобы посмотреть список всех отчетов, сформированных по выбранному шаблону отчета. При необходимости вы можете сохранить выбранный отчет в одном из поддерживаемых форматов или удалить отчет.
• Изменить расписание – используйте это действие, чтобы настроить расписание для формирования отчетов и определить пользователей, которые должны получать уведомления по электронной почте о сформированных отчетах.

Вы также можете посмотреть доступный вам список шаблонов отчетов в разделе Ресурсы → Список. Для этого требуется выбрать Шаблон отчетов в столбце Тип ресурса.

Создание шаблона отчета

Развернуть всё | Свернуть всё

Чтобы создать шаблон отчета:

1. Откройте веб-интерфейс KUMA и выберите раздел Отчеты → Шаблоны.
2. Нажмите на кнопку Новый шаблон.

   Откроется окно Новый шаблон отчета.

3. В раскрывающемся списке Тенанты выберите один или несколько тенантов, которым будет принадлежать создаваемый макет.
4. В раскрывающемся списке Период выберите период времени, по которому требуется аналитика:
   • Сегодня (это значение выбрано по умолчанию)
   • На этой неделе
   • В этом месяце
   • В течение периода – получать аналитику за выбранный период времени.

     Верхняя граница периода не включается в определяемый с ее помощью отрезок времени. Это означает, что, например, для получения аналитики за сутки следует настроить период День1, 00:00:00 – День 2, 00:00:00, а не День 1, 00:00:00 – День 1, 23:59:59.

   • Другой – получать аналитику за последние N дней/недель/месяцев/лет.
5. В поле Срок хранения укажите, на протяжении какого времени следует хранить сформированные по этому шаблону отчеты.
6. В поле Название шаблона введите уникальное название шаблона отчета. Должно содержать от 1 до 128 символов в кодировке Unicode.

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

   Для виджетов с типами графиков Круговая диаграмма, Столбчатая диаграмма, Линейная диаграмма, Счетчик и Календарная диаграмма существуют следующие ограничения:

   • В запросах SELECT можно использовать поля расширенной схемы событий с типами Строка, Число и Число с плавающей точкой.
   • В запросах WHERE можно использовать поля расширенной схемы событий со всеми типами (Строка, Число, Число с плавающей точкой, Массив строк, Массив чисел и Массив чисел с плавающей точкой).

   Для виджетов с типом графика Таблица в запросах SELECT можно использовать поля расширенной схемы событий со всеми типами (Строка, Число, Число с плавающей точкой, Массив строк, Массив чисел и Массив чисел с плавающей точкой).

   Вы можете выполнять следующие действия с виджетами:

   • Добавлять виджеты.

     Чтобы добавить виджет:

     1. В раскрывающемся списке Добавить виджет выберите требуемый виджет.

        Откроется окно с параметрами виджета. С помощью кнопки Предварительный просмотр можно увидеть, как будет выглядеть настраиваемый виджет на макете.

     2. Настройте параметры виджета и нажмите Добавить.
   • Редактировать виджеты.

     Чтобы отредактировать виджет:

     1. Наведите указатель мыши на нужный виджет и нажмите на появляющийся значок шестеренки ().
     2. В раскрывающемся списке выберите значение Изменить.

        Откроется окно с параметрами виджета. С помощью кнопки Предварительный просмотр можно увидеть, как будет выглядеть настраиваемый виджет на макете.

     3. Измените параметры виджета и нажмите Сохранить.

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

7. При необходимости можно поменять логотип шаблона отчетов с помощью кнопки Загрузить логотип.

   Если нажать на кнопку Загрузить логотип, открывается окно загрузки, в котором можно указать файл изображения для логотипа. Изображение должно быть файлом .jpg, .png или .gif размером не более 3 МБ.

   Добавленный логотип будет отображаться в отчете вместо логотипа KUMA.

8. При необходимости установите флажок Отображать данные по КИИ, чтобы в виджетах макета в том числе отображались данные об активах, алертах и инцидентах, имеющих отношение к критической информационной инфраструктуре (КИИ). При этом такие макеты будут доступы для просмотра только пользователям, в параметрах которых установлен флажок Доступ к объектам КИИ.

   Если флажок не установить, в виджетах макета не будут отображаться данные об активах, алертах и инцидентах, относящихся к КИИ, даже если у пользователя есть доступ к объектам КИИ.

9. Нажмите Сохранить.

Новый шаблон отчета создан и отображается в вкладке Отчеты → Шаблоны веб-интерфейса KUMA. Вы можете сформировать этот отчет вручную. Если вы хотите, чтобы отчеты создавались автоматически, требуется настроить расписание.

Настройка расписания отчетов

Чтобы настроить расписание отчетов:

1. Откройте веб-интерфейс KUMA и выберите раздел Отчеты → Шаблоны.
2. В таблице со списком шаблонов отчета выберите шаблон отчета и нажмите на значок меню .
3. В раскрывающемся списке выберите Изменить расписание.

   Откроется окно Изменить расписание.

4. Если вы хотите, чтобы отчет формировался регулярно:
   1. Включите переключатель Отправлять отчет по расписанию.
   2. В группе параметров Повторять каждый укажите периодичность формирования отчетов.

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

   3. В поле Время укажите время, когда должен быть сформирован отчет.
   4. В раскрывающемся списке Часовой пояс выберите часовой пояс для определения времени отправки отчета.
5. В блоке Параметры уведомлений укажите следующие параметры:
   1. В раскрывающемся списке Шаблон уведомления выберите форму уведомления, которое будет направляться пользователю по расписанию.
   2. В группе настроек Отправить нажмите Добавить.
   3. В открывшемся окне добавьте группу пользователей для отправки отчета и выберите нужный вам формат. Для этого выполните следующие действия:
      • В раскрывающемся списке Адреса электронной почты выберите адреса электронной почты получателей отчета.
      • В раскрывающемся списке Формат выберите формат для направления отчета. Для выбора доступны следующие форматы: HTML, PDF,
        CSV, разделенный CSV

        

        Отчет в формате CSV содержит все виджеты в одном файле.

        Разделенный CSV позволяет выгрузить отдельные виджеты в отдельные файлы и объединить эти файлы в архив для дальнейшей рассылки по указанным адресам электронной почты.

        

        Отчет в формате CSV содержит все виджеты в одном файле.

        Разделенный CSV позволяет выгрузить отдельные виджеты в отдельные файлы и объединить эти файлы в архив для дальнейшей рассылки по указанным адресам электронной почты.

        

        Отчет в формате CSV содержит все виджеты в одном файле.

        Разделенный CSV позволяет выгрузить отдельные виджеты в отдельные файлы и объединить эти файлы в архив для дальнейшей рассылки по указанным адресам электронной почты.

        ,Excel.

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

      Отчеты будут отправлены по указанным адресам каждый раз, когда вы сформируете отчет вручную или KUMA сформирует отчет автоматически по расписанию.

      Чтобы сформированные отчеты можно было отправлять по электронной почте, нужно настроить SMTP-соединение.

      Если получатели, которым отчет пришел на электронную почту, являются пользователями KUMA, они смогут скачать отчет или просмотреть отчет по ссылкам из письма. Если получатели не являются пользователями KUMA, переход по ссылкам будет доступен, но авторизоваться в KUMA получатели не смогут, поэтому им будут доступны только вложения.

      Мы рекомендуем просматривать отчеты в формате HTML по ссылкам в веб-интерфейсе, поскольку при некоторых значениях разрешения экрана HTML-отчет из вложения может отображаться некорректно.

      Вы можете отправить письмо без вложений, тогда получателям будут доступны отчеты только по ссылкам и только с авторизацией в KUMA, без ограничений по ролям или тенантам.

   4. Нажмите Добавить.
6. Нажмите Сохранить.

Расписание отчетов настроено.

Изменение шаблона отчета

Чтобы изменить шаблон отчета:

1. Откройте веб-интерфейс KUMA и перейдите в один из следующих разделов:
   • Отчеты → Шаблоны.
   • Ресурсы → Список. Если вы выбрали этот раздел, для удобства отображения объектов вы можете выбрать Шаблон отчетов в столбце таблицы Тип ресурса.
2. В зависимости от выбранного раздела выполните одно из следующих действий:
   • В разделе Отчеты → Шаблоны нажмите нажмите имя шаблона отчетов в таблице со списком шаблонов отчетов.
   • В разделе Ресурсы → Список нажмите на значок изменения параметров рядом с именем шаблона отчетов в списке ресурсов.

   Откроется окно Изменить шаблон.

   Это окно также можно открыть на вкладке Отчеты → Сформированные отчеты, выбрав существующий отчет и нажав на кнопку Изменить шаблон.

3. Внесите необходимые изменения:
   • Измените название шаблона отчета.
   • Измените список тенантов, которые передают данные для отчета.
   • Нажмите на кнопку Параметры для изменения временного периода для получения аналитических данных, срок хранения, теги и описание шаблона отчета.
   • Нажмите на кнопку Добавить виджет для добавления виджета в шаблон отчета.
   • Нажмите на значок меню для просмотра списка отчетов, сформированных по этому шаблону, или для удаления шаблона отчета.
   • Измените логотип отчета, загрузив его по ссылке Загрузите файл. Если в шаблоне уже есть логотип, его предварительно потребуется удалить.
   • Измените расположение виджетов, перетаскивая их.
   • Измените размер виджетов с помощью значка растяжения, который появляется при наведении указателя мыши на виджет.
   • С помощью значка меню на виджете измените параметры виджетов, создайте копии виджетов, удалите виджеты или загрузите данные виджетов в формате CSV.
4. Нажмите Сохранить.

Шаблон отчета изменен и отображается на вкладках Отчеты → Шаблоны и Ресурсы → Список веб-интерфейса KUMA.

Копирование шаблона отчета

Чтобы создать копию шаблона отчета:

1. Откройте веб-интерфейс KUMA и перейдите в один из следующих разделов:
   • Отчеты → Шаблоны.
   • Ресурсы → Список. Если вы выбрали этот раздел, для удобства отображения объектов вы можете выбрать Шаблон отчетов в столбце таблицы Тип ресурса.
2. В таблице выберите шаблон отчета и нажмите на кнопку Дублировать, расположенную над таблицей.
3. В открывшемся окне укажите название шаблона отчета. При копировании шаблона отчета в названии отчета появляется упоминание о копировании.
4. В раскрывающемся списке Тенант шаблона выберите тенанты, которым будет принадлежать копируемый шаблон отчета.
5. В раскрывающемся списке Собирать данные от тенантов выберите один или несколько тенантов, данные из которых будут представлены в шаблоне отчета.
6. При необходимости измените следующие параметры:
   • Период формирования отчета.
   • Срок хранения отчета.
   • Теги шаблона отчета.
   • Описание шаблона отчета.
   • Формирование данных в отчете с учетом КИИ.
7. Нажмите Сохранить.

Копия шаблона отчета создана и отображается на вкладках Отчеты → Шаблоны и Ресурсы → Список веб-интерфейса KUMA.

Удаление шаблона отчета

Чтобы удалить шаблон отчета:

1. Откройте веб-интерфейс KUMA и перейдите в один из следующих разделов:
   • Отчеты → Шаблоны.
   • Ресурсы → Список. Если вы выбрали этот раздел, для удобства отображения объектов вы можете выбрать Шаблон отчетов в столбце таблицы Тип ресурса.
2. В таблице шаблонов отчетов с помощью флажка выберите шаблон отчета и нажмите на кнопку Удалить, расположенную над таблицей.

   Откроется окно подтверждения.

3. Выполните одно из следующих действий:
   • Если вы хотите удалить только шаблон отчета, нажмите на кнопку Удалить.
   • Если вы хотите удалить шаблон отчета и все отчеты, сформированные с помощью этого шаблона, нажмите Удалить с отчетами.

   Шаблон отчета удален.

Сформированные отчеты

Все отчеты формируются с помощью шаблонов отчетов. Сформированные отчеты доступны на вкладке Сформированные отчеты в разделе Отчеты и отображаются в таблице, где представлена следующая информация:

• Название – название шаблона отчетов.

  Вы можете отсортировать шаблоны отчетов, нажав на значок сортировки в заголовке столбца и выбрав По возрастанию или По убыванию.

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

• Период – период времени, за который была извлечена аналитика отчета.
• Последний отчет – дата и время формирования последнего отчета.

  Вы можете отсортировать таблицу по этому столбцу, нажав на значок сортировки в заголовке столбца и выбрав По возрастанию или По убыванию.

• Тенант – название тенанта, которому принадлежит отчет.
• Пользователь – имя пользователя, который сформировал отчет вручную. Если отчет был сформирован по расписанию, значение будет пустым. Если отчет был сформирован в версии KUMA ниже 2.1, значение будет пустым.

При необходимости вы можете настроить отображение столбцов в таблице, нажав на значок шестеренки .

После выбора отчета в списке сформированных отчетов вы можете выполнить следующие действия с отчетами:

• Создать отчет.
• Открыть и просмотреть отчет.
• Сохранить сформированный отчет в нужном формате. Доступные форматы: HTML, PDF, CSV, разделенный CSV, Excel. По умолчанию во всех форматах выводится 250 строк. Максимальное количество строк, которые могут отображаться в таблицах в форматах PDF и HTML равно 500. Если вы хотите выводить в отчет более 500 строк, задайте в SQL-запросе желаемое значение параметра LIMIT и сохраните отчет в формате CSV.
• Настроить параметры шаблона отчета.
• Удалить отчет.

Просмотр отчетов

Чтобы просмотреть отчет:

1. Откройте веб-интерфейс KUMA и выберите раздел Отчеты → Сформированные отчеты.
2. В таблице отчетов нажмите на название сформированного отчета.

   Откроется окно с виджетами, отображающими аналитику отчетов. Если виджет отображает данные о событиях, алертах, инцидентах, активных листах и контекстных таблицах при нажатии на его заголовок открывается соответствующий раздел веб-интерфейса KUMA с активным фильтром и/или поисковым запросом, с помощью которых отображаются данные из виджета. К виджетам применяются значения по умолчанию.

   Если вы хотите просмотреть полные данные, выгрузите отчет в формате CSV с указанными параметрами из запроса.

3. При необходимости сохраните отчет в выбранном формате с помощью кнопки Сохранить как.

Создание отчетов

Вы можете создать отчет вручную или настроить расписание, чтобы отчеты создавались автоматически.

Чтобы создать отчет вручную:

1. Откройте веб-интерфейс KUMA и перейдите в раздел Отчеты.
2. Выполните один из следующих вариантов действий:
   1. На вкладке Сформированные отчеты выполните следующие действия:
      • С помощью флажка выберите отчет в таблице со списком отчетов.
      • Нажмите на кнопку Сформировать отчет, расположенную над таблицей.
   2. На вкладке Шаблоны выполните следующие действия:
      • С помощью флажка выберите отчет в таблице со списком шаблонов отчета.
      • Нажмите на значок меню и выберите в раскрывающемся списке Сформировать отчет.

В течение 15 секунд отчет будет создан и помещен на вкладку Отчеты → Сформированные отчеты.

Вы также можете настроить расписание отчетов для автоматического формирования отчетов.

Сохранение отчетов

Чтобы сохранить отчет в нужном формате:

1. Откройте веб-интерфейс KUMA и выберите раздел Отчеты → Сформированные отчеты.
2. С помощью флажка выберите сформированный отчет в таблице со списком сформированных отчетов.
3. В раскрывающемся списке Сохранить как, расположенном над таблицей, выберите нужный формат: HTML, PDF, CSV, разделенный CSV, Excel.

   Отчет сохраняется в папку загрузки, настроенную в вашем браузере.

Отчет также можно сохранить в выбранном формате при просмотре.

Удаление отчетов

Чтобы удалить отчет:

1. Откройте веб-интерфейс KUMA и выберите раздел Отчеты → Сформированные отчеты.
2. В таблице со списком сформированных отчетов выберите отчет.
3. Нажмите на кнопку Удалить, расположенную над таблицей.

   Откроется окно подтверждения.

4. Нажмите Удалить.

   Выбранный отчет удален.