Отчеты

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

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

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

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

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

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

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

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

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

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

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

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

• Расписание – периодичность, с которой отчеты должны формироваться по созданным шаблонам. Если расписание отчета не настроено, отображается значение выключено.
• Создал – имя пользователя, создавшего шаблон отчета.
• Последнее обновление – дата последнего обновления шаблона отчета.

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

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

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

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

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

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

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

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.
7. В раскрывающемся списке Добавить виджет выберите требуемый виджет и настройте его параметры. Вы можете добавить несколько виджетов. Виджеты можно перетаскивать по окну и изменять их размер с помощью кнопки , которая появляется при наведении указателя мыши на виджет.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   Откроется окно Параметры отчета.

3. Если вы хотите, чтобы отчет формировался регулярно:
   1. Включите переключатель Расписание.

      В группе настроек Повторять каждый задайте периодичность создания отчетов.

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

   2. В поле Время укажите время, когда должен быть сформирован отчет. Вы можете ввести значение вручную или с помощью значка часов.
4. Чтобы выбрать формат отчетов и указать адресатов для рассылки, настройте следующие параметры:
   1. В группе настроек Отправить нажмите Добавить.
   2. В открывшемся окне Добавление адресов электронной почты в разделе Группы пользователей нажмите Добавить группу.
   3. В появившемся поле укажите адрес электронной почты и нажмите Enter или щелкните вне поля ввода - адрес электронной почты будет добавлен. Можно добавить несколько адресов. Отчеты будут отправлены по указанным адресам каждый раз, когда вы сформируете отчет вручную или KUMA сформирует отчет автоматически по расписанию.

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

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

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

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

   4. В раскрывающемся списке выберите формат отчета для отправки. Доступные форматы: PDF, HTML,
      CSV, разделенный CSV

      

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

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

      

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

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

      

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

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

      , Excel.
5. Нажмите Сохранить.

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

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

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

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

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

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

3. Внесите необходимые изменения:
   • Измените список тенантов, которым принадлежит шаблон отчета.
   • Обновите период времени, за который вам требуется аналитика.
   • Добавьте виджеты

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

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

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

     2. Настройте параметры виджета и нажмите Добавить.
   • Измените расположение виджетов, перетаскивая их.
   • Измените размер виджетов с помощью кнопки , которая появляется при наведении указателя мыши на виджет.
   • Отредактируйте виджеты

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

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

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

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

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

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

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

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

   Откроется окно Новый шаблон отчета. Название виджета изменено на <Шаблон отчета> - копия.

3. Внесите необходимые изменения:
   • Измените список тенантов, которым принадлежит шаблон отчета.
   • Обновите период времени, за который вам требуется аналитика.
   • Добавьте виджеты

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

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

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

     2. Настройте параметры виджета и нажмите Добавить.
   • Измените расположение виджетов, перетаскивая их.
   • Измените размер виджетов с помощью кнопки , которая появляется при наведении указателя мыши на виджет.
   • Отредактируйте виджеты

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

   С помощью кнопки CSV данные, отображаемые на каждом виджете, можно скачать в формате CSV в кодировке UTF-8. Название скачиваемого файла имеет формат <название виджета>_<дата скачивания (ГГГГММДД)>_<время скачивания (ЧЧММСС)>.CSV.

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

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

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

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

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

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

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

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

Чтобы создавать отчеты автоматически, настройте расписание отчетов.

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

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

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

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

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

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

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

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

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

3. Нажмите ОК.