Виджеты

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

• События – виджет для создания аналитики на основе событий.
• Активные листы – виджет для создания аналитики на основе активных листов корреляторов.
• Алерты – группа для аналитики алертов.

  В группу входят следующие виджеты:

  • Активные алерты – количество незакрытых алертов.
  • Активные алерты по тенантам – количество незакрытых алертов для каждого тенанта.
  • Алерты по тенантам – количество алертов всех статусов для каждого тенанта.
  • Неназначенные алерты – количество алертов со статусом Новый.
  • Алерты по исполнителю – количество алертов со статусом Назначен, сгруппированных по имени учетной записи.
  • Алерты по статусу – количество алертов со статусом Новый, Открыт, Назначен или Эскалирован, сгруппированных по статусу.
  • Алерты по уровню важности – количество незакрытых алертов, сгруппированных по уровню важности.
  • Алерты по правилу корреляции – количество незакрытых алертов, сгруппированных по правилам корреляции.
  • Последние алерты – таблица с информацией о последних 10 незакрытых алертах, принадлежащих выбранным в макете тенантам.
  • Распределение алертов – количество алертов, созданных в течение указанного для виджета периода.
• Активы – группа для аналитики активов из обработанных событий. В эту группу входят следующие виджеты:
  • Затронутые активы – таблица с информацией об уровне важности активов и количестве незакрытых алертов, с которыми они связаны.
  • Категории затронутых активов – категории активов, привязанных к незакрытым алертам.
  • Количество активов – количество активов, добавленных в KUMA.
  • Активы в инцидентах по тенантам – количество активов, связанных с незакрытыми инцидентами. Сгруппированы по тенантам.
  • Активы в алертах по тенантам – количество активов, связанных с незакрытыми алертами, Сгруппированы по тенантам.
• Инциденты – группа для аналитики инцидентов.

  В группу входят следующие виджеты:

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

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

• Пользователи – группа для аналитики о пользователях из обработанных событий. В группу входят следующие виджеты:
  • Пользователи в алертах – количество учетных записей, связанных с незакрытыми алертами.
  • Количество пользователей AD – количество учетных записей в Active Directory, полученных по LDAP в течение указанного для виджета периода.

В таблице событий, в области деталей событий, в окне алертов, а также в виджетах в качестве значений полей SourceAssetID, DestinationAssetID, DeviceAssetID, SourceAccountID, DestinationAccountID и ServiceID вместо идентификаторов отображаются названия активов, учетных записей или сервисов. При экспорте событий в файл идентификаторы сохраняются, однако в файл добавляются столбцы с названиями. Идентификаторы также отображаются при наведении указателя мыши на названия активов, учетных записей или сервисов.

Поиск по полям с идентификаторами возможен только с помощью идентификаторов.

Основные принципы работы с виджетами

Принцип отображения данных на виджете зависит от типа графика. В KUMA доступны следующие типы графиков:

• Круговая диаграмма ().
• Счетчик ().
• Таблица ().
• Столбчатая диаграмма ().
• Календарная диаграмма ().
• Линейная диаграмма.
• Сложенная столбчатая диаграмма.

Основные принципы работы со всеми виджетами

В левом верхнем углу виджетов отображается название виджета. По ссылке с названием виджета о событиях, алертах, инцидентах или активных листах вы можете перейти в соответствующий раздел веб-интерфейса KUMA.

Под названием виджета отображается список тенантов, для которых представлены данные.

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

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

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

Основные принципы работы с графиками типа "Круговая диаграмма"

Под списком тенантов отображается круговая диаграмма. Вы можете перейти в раздел веб-интерфейса KUMA с соответствующими данными, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете.

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

Основные принципы работы с графиками типа "Счетчик"

На графиках этого типа отображается сумма выбранных данных.

Основные принципы работы с графиками типа "Таблица"

На графиках этого типа данные отображаются в виде таблицы.

Основные принципы работы с графиками типа "Столбчатая диаграмма"

Под списком тенантов отображается столбчатая диаграмма. Вы можете перейти в раздел События веб-интерфейса KUMA, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете. Справа от диаграммы эти данные представлены в виде таблицы.

Основные принципы работы с графиками типа "Календарная диаграмма"

Под списком тенантов отображается календарная диаграмма. Вы можете перейти в раздел События веб-интерфейса KUMA с соответствующими данными, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете. Справа от диаграммы эти данные представлены в виде таблицы.

Основные принципы работы с графиками типа "Линейная диаграмма"

Под списком тенантов отображается линейная диаграмма. Вы можете перейти в раздел События веб-интерфейса KUMA с соответствующими данными, щелкнув левой кнопкой мыши по выбранному разделу диаграммы. Данные в разделе будут отсортированы в соответствии с фильтрами и/или поисковым запросом, указанным в виджете. Справа от диаграммы эти данные представлены в виде таблицы.

Особенности отображения данных в виджетах

Ограничение отображаемых данных

Для удобства восприятия информации в KUMA заданы ограничения на отображение данных в виджетах в зависимости от их типа:

• Круговая диаграмма – отображается не более 20 отсеков.
• Столбчатая диаграмма – отображается не более 40 столбцов.
• Таблица – отображается не более 500 записей.
• Календарная диаграмма – отображается не более 365 дней.

Данные, выходящие за указанные ограничения, отображаются в виджете в категории Остальное.

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

Суммирование данных

Формат отображения итоговой суммы данных на календарной, столбчатой и круговой диаграммах зависит от языка локализации:

• Английская локализация: порядки разделяются запятыми, дробная часть отделяется точкой.
• Русская локализация: порядки разделяются пробелами, дробная часть отделяется запятой.

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

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

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

1. Создайте макет или перейдите в режим редактирования выбранного макета.
2. Нажмите на кнопку Добавить виджет.
3. В раскрывшемся списке выберите тип виджета.

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

4. Задайте параметры виджета.
5. Если вы хотите просмотреть, как будут отображаться данные на виджете, нажмите на кнопку Предварительный просмотр.
6. Нажмите на кнопку Добавить.

Виджет отобразится на макете панели мониторинга.

Редактирование виджета

Чтобы изменить виджет:

1. В веб-интерфейсе KUMA выберите раздел Панель мониторинга.
2. Раскройте список в верхнем правом углу окна.
3. Наведите указатель мыши на требуемый макет.
4. Нажмите на значок карандаша ().

   Откроется окно Настройка макета.

5. На виджете, который вы хотите изменить, нажмите на значок шестеренки ().
6. Выберите Изменить.

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

7. Задайте параметры виджета.
8. Нажмите на кнопку Сохранить в окне параметров виджета.
9. Нажмите на кнопку Сохранить в окне Настройка макета.

Изменения виджета будут применены.

Удаление виджета

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

1. В веб-интерфейсе KUMA выберите раздел Панель мониторинга.
2. Раскройте список в верхнем правом углу окна.
3. Наведите указатель мыши на требуемый макет.
4. Нажмите на кнопку .

   Откроется окно Настройка макета.

5. На виджете, который вы хотите удалить, нажмите на кнопку .
6. Выберите Удалить.
7. В отобразившемся окне подтверждения нажмите на кнопку ОК.
8. Нажмите на кнопку Сохранить.

Виджет будет удален.

Параметры виджетов

Этот раздел содержит описание параметров всех доступных в KUMA виджетов.

Виджет "События"

Вы можете использовать виджет События для получения необходимой аналитики на основе SQL-запросов.

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

Вкладка :

• График – тип графика. Доступны следующие типы графиков:
  • Круговая диаграмма.
  • Столбчатая диаграмма.
  • Счетчик.
  • Линейная диаграмма.
  • Таблица.
  • Календарная диаграмма.

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

• Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
  • Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
  • 1 час – отображаются данные за предыдущий час.
  • 1 день – отображаются данные за предыдущий день.
  • 7 дней – отображаются данные за предыдущие 7 дней.
  • 30 дней – отображаются данные за предыдущие 30 дней.
  • В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.

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

• Показывать данные за предыдущий период – включение отображения данных сразу за два периода: за текущий и за предыдущий.
• Хранилище – хранилище, в котором выполняется поиск событий.
• Поле SQL-запроса () – запрос для фильтрации и поиска событий вручную. Вы можете составить запрос в конструкторе запросов, нажав на кнопку .

  Как создать запрос в конструкторе запросов

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

  1. Укажите значения для следующих параметров:
     1. SELECT – поля событий, которые следует возвращать. Количество доступных полей зависит от выбранного типа графика.
        • В раскрывающемся списке слева выберите поля событий, данные по которым должны отображаться на виджете.
        • Среднее поле показывает, для чего выбранное поле используется в виджете: metric (метрики) или value (значение).

          Если вы выбрали тип графика Таблица, в средних полях нужно указать названия столбцов, используя символы ANSII-ASCII.

        • В раскрывающемся списке справа вы можете выбрать операцию, которую следует произвести над данными:
          • count – подсчет событий. Эта операция доступна только для поля события ID. Используется по умолчанию для линейных, круговых и столбчатых диаграмм, а также для счетчиков. Является единственно возможным вариантом для календарных диаграмм.
          • max – максимальное значение поля события из выборки событий.
          • min – минимальное значение поля события из выборки событий.
          • avg – среднее значение поля события из выборки событий.
          • sum – сумма значений полей событий из выборки событий.
     2. SOURCE – тип источника данных. Для выбора доступно только значение events (события).
     3. WHERE – условия фильтрации событий.
        • В раскрывающемся списке слева выберите поле события, которое вы хотите использовать для фильтрации.
        • В среднем раскрывающемся списке выберите нужный оператор. Доступные операторы зависят от типа значения выбранного поля события.
        • В раскрывающемся списке справа введите значение условия. В зависимости от выбранного типа поля вам потребуется ввести значение вручную, выбрать его в раскрывающемся списке или выбрать в календаре.

        Вы можете добавить условия поиска, нажав на кнопку Добавить условие или удалить их, нажав на кнопку .

        Вы можете добавить группы условий, нажав на кнопку Добавить группу. По умолчанию группы условий добавляются с оператором AND, но при необходимости вы можете изменить значение. Доступные значения: AND, OR, NOT. Группы условий удаляются с помощью кнопки Удалить группу.

     4. GROUP BY – поля событий или псевдонимы, по которым следует группировать возвращаемые данные. Этот параметр недоступен для графиков типа Счетчик.
     5. ORDER BY – столбцы, по которым следует сортировать возвращаемые данные. Этот параметр недоступен для графиков следующих типов: Календарная диаграмма и Счетчик.
        • В раскрывающемся списке слева выберите значение, которое будет использоваться для сортировки.
        • В раскрывающемся списке справа выберите порядок сортировки: ASC  – по возрастанию, DESC  – по убыванию.
        • Для графиков типа Таблица можно добавить условия сортировки с помощью кнопки Добавить столбец.
     6. LIMIT – максимальное количество точек данных для виджета. Этот параметр недоступен для графиков типа Календарная диаграмма и Счетчик.
  2. Нажмите на кнопку Применить.

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

  

  Search condition parameters for the widget showing average bytes received per host

  Существуют следующие ограничения:

  • Псевдонимы metric и value в SQL-запросах недоступны для изменения для всех типов виджета с аналитикой по событиям, кроме таблиц.
  • Псевдонимы в виджетах типа Таблица могут содержать латинские и кириллические символы, а также пробелы. При использовании пробелов или кириллицы псевдоним необходимо выделять кавычками: "Псевдоним с пробелом", `Другой псевдоним`.
  • Не поддерживается использование SQL-запроса ARRAY JOIN.
  • При отображении данных за предыдущий период сортировка по параметру count(ID) может работать неправильно. Мы рекомендуем использовать сортировку по параметру metric. Например, SELECT count(ID) AS "metric", Name AS "value" FROM `events` GROUP BY Name ORDER BY metric ASC LIMIT 250.
  • В виджетах типа Счетчик для значений функции SELECT требуется указывать способ обработки данных: count, max, min, avg, sum.

Вкладка :

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

• Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
• Минимальное значение X и Максимальное значение X – масштаб оси X.

  На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.

• Толщина линии – толщина линии на графике. Поле отображается для типа графика "Линейная диаграмма".
• Размер указателя – размер указателя на графике. Поле отображается для типа графика "Линейная диаграмма".

Вкладка :

• Название – название виджета.
• Описание – описание виджета.
• Цвет – цвет отображения информации:
  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.
• Горизонтальный – использование горизонтальной гистограммы вместо вертикальной.

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

• Итоговые значения – суммы значений.
• Легенда – легенда для аналитики. По умолчанию переключатель включен.

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

• Десятичные знаки – количество десятичных знаков, до которых отображаемое значение должно быть округлено.
• Длительность отрезков периода (доступно для графика типа Календарная диаграмма) – длительность отрезков, на которые требуется делить период.

Виджет "Активные листы"

Вы можете использовать виджет Активные листы для получения аналитики на основе SQL-запросов.

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

Вкладка :

• График – тип графика. Доступны следующие типы графиков:
  • Столбчатая диаграмма.
  • Круговая диаграмма.
  • Счетчик.
  • Таблица.

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

• Коррелятор – название коррелятора, содержащего активный лист, по которому вы хотите получать данные.
• Активный лист – название активного листа, по которому вы хотите получать данные.

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

• Поле SQL-запроса – в этом поле вы можете ввести запрос для фильтрации и поиска данных активного листа вручную.

  Структура запроса аналогична той, которая используется при поиске событий.

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

  • Для функции FROM требуется указать значение `records`.
  • Если вы хотите получать данные по полям, названия которых содержат пробелы и символы кириллицы, в запросе такие названия требуется выделять кавычками:
    • в функции SELECT псевдонимы следует выделять двойными или косыми кавычками: "псевдоним", `другой псевдоним`;
    • в функции ORDER BY псевдонимы следует выделять косыми кавычками: `другой псевдоним`;
    • значения полей событий выделяются прямыми кавычками: WHERE DeviceProduct = 'Microsoft';

    Название полей событий выделять кавычками не требуется.

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

    Если значения полей активного листа могут содержать пробелы в конце или в начале, поиск по ним рекомендуется осуществлять с помощью функции LIKE '%значение поля%'.

  • Вы можете использовать в запросе служебные поля _key (поле с ключами записей активного листа) и _count (сколько раз эта запись была добавлена в активный лист), а также пользовательские поля.
  • Псевдонимы metric и value в SQL-запросах недоступны для изменения для всех типов виджета с аналитикой по активным листам, кроме таблиц.
  • Если в SQL-запросе используется функция преобразования даты и времени (например, fromUnixTimestamp64Milli) и при этом обрабатываемое поле не содержит даты и времени, в виджете будет отображаться ошибка. Чтобы избежать этого, используйте функции, которые могут обрабатывать нулевое значение. Пример: SELECT _key, fromUnixTimestamp64Milli(toInt64OrNull(DateTime)) as Date FROM `records` LIMIT 250.
  • Если задать большие значения для функции LIMIT, это может привести к ошибкам в работе браузера.
  • Если в качестве типа графика вы выбрали Счетчик, необходимо для значений функции SELECT указывать способ обработки данных: count, max, min, avg, sum.
  • Вы можете получать в виджете названия тенантов, а не их идентификаторы.

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

    1. Экспорт списка тенантов.
    2. Создание словаря типа Таблица и импорт в него полученного ранее списка тенантов.
    3. Добавление в корреляционное правило локальной переменной с функцией dict для распознания имени тенанта по идентификатору.

       Пример:

       • Переменная: TenantName
       • Значение: dict('<Название ранее созданного словаря с тенантами>', TenantID)
    4. Добавление в корреляционное правило действия над активными листами, с помощью которого значение ранее созданной переменной будет с помощью функции Установить записываться в активный лист в формате Ключ–Значение. В качестве ключа следует задать поле активного листа (например, Тенант), а в поле значения обратиться к ранее созданной переменной (например, $TenantName).

    В результате срабатывания этого правила в активный лист будет помещаться название тенанта, опознанного функцией dict по идентификатору среди словаря тенантов. При создании виджетов по активным листам можно получить название тенанта, обратившись к названию поля активного листа (в примере выше это Тенант).

    Описанный метод можно применять и к другим полям событий с идентификаторами.

  Особенности использования псевдонимов в SQL-функциях: и SELECT допустимо использовать двойные и косые кавычки: ", `.

  Если в качестве типа графика вы выбрали Счетчик, псевдонимы могут содержать латинские и кириллические символы, а также пробелы. При использовании пробелов или кириллицы псевдоним необходимо выделять кавычками: "Псевдоним с пробелом", `Другой псевдоним`.

  При отображении данных за предыдущий период сортировка по параметру count(ID) может работать некорректно. Рекомендуется использовать сортировку по параметру metric. Например, SELECT count(ID) AS "metric", Name AS "value" FROM `events` GROUP BY Name ORDER BY metric ASC LIMIT 250.

  Примеры запросов для получения аналитики по активным листам: SELECT * FROM `records` WHERE "Источник событий" = 'Екатеринбург' LIMIT 250 Запрос, который возвращает ключ активного листа с названием поля "Источник событий" и значением этого поля "Екатеринбург". SELECT count(_key) AS metric, Status AS value FROM `records` GROUP BY value ORDER BY metric DESC LIMIT 250 Запрос для круговой диаграммы, который возвращает количество ключей активного листа (агрегация count по полю _key) и все варианты значений пользовательского поля Status. В виджете отображается круговая диаграмма с общим количеством записей активного листа, пропорционально разделенным на количество вариантов значений поля Status. SELECT Name, Status, _count AS Number FROM `records` WHERE Description ILIKE '%ftp%' ORDER BY Name DESC LIMIT 250 Запрос для таблицы, которая возвращает значения пользовательских полей Name и Status, а также служебного поля _count у тех записей активного листа, в которых значения пользовательского поля Description соответствует запросу ILIKE '%ftp%'. В виджете отображается таблица со столбцами Status, Name и Number.

Вкладка :

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

• Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
• Минимальное значение X и Максимальное значение X – масштаб оси X.

  На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.

Вкладка :

• Название – название виджета.
• Описание – описание виджета.
• Цвет – цвет отображения информации:
  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.
• Горизонтальный – использование горизонтальной гистограммы вместо вертикальной.

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

• Итоговые значения – суммы значений.
• Легенда – легенда для аналитики. По умолчанию переключатель включен.

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

Виджет "Контекстные таблицы"

Вы можете использовать виджет Контекстные таблицы для получения аналитики на основе SQL-запросов.

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

Вкладка :

• График – тип графика. Доступны следующие типы графиков:
  • Столбчатая диаграмма.
  • Круговая диаграмма.
  • Счетчик.
  • Таблица.

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

• Коррелятор – название коррелятора, содержащего контекстную таблицу, по которой вы хотите получать данные.
• Контекстная таблица – название контекстной таблицы, по которой вы хотите получать данные.

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

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

  Структура запроса аналогична той, которая используется при поиске событий.

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

  • Для функции FROM требуется указать значение `records`.
  • Вы можете получить данных только по полям, указанным в схеме контекстной таблицы.
  • Вы можете использовать поддерживаемые функции ClickHouse.
  • Если вы хотите получать данные по полям, названия которых содержат пробелы и символы кириллицы, в запросе такие названия требуется выделять кавычками:
    • в функции SELECT псевдонимы следует выделять двойными или косыми кавычками: "<псевдоним>", `<другой псевдоним>`;
    • в функции ORDER BY псевдонимы следует выделять косыми кавычками: `<другой псевдоним>`;
    • значения полей событий выделяются прямыми кавычками: WHERE DeviceProduct = 'Microsoft';

    Название полей событий выделять кавычками не требуется.

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

    Если значения полей активного листа могут содержать пробелы в конце или в начале, поиск по ним рекомендуется осуществлять с помощью функции LIKE '%<значение поля>%'.

  • Вы можете использовать в запросе служебное поле _count (сколько раз эта запись была добавлена в контекстную таблицу), а также пользовательские поля.
  • Псевдонимы metric и value в SQL-запросах недоступны для изменения для всех типов виджета с аналитикой по активным листам, кроме таблиц.
  • Если в SQL-запросе используется функция преобразования даты и времени (например, fromUnixTimestamp64Milli) и при этом обрабатываемое поле не содержит даты и времени, в виджете будет отображаться ошибка. Чтобы избежать этого, используйте функции, которые могут обрабатывать нулевое значение. Пример: SELECT _key, fromUnixTimestamp64Milli(toInt64OrNull(DateTime)) as Date FROM `records` LIMIT 250.
  • Если задать большие значения для функции LIMIT, это может привести к ошибкам в работе браузера.
  • Если в качестве типа графика вы выбрали Счетчик, необходимо для значений функции SELECT указывать способ обработки данных: count, max, min, avg, sum.
  • Вы можете получать в виджете названия тенантов, а не их идентификаторы.

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

    1. Экспорт списка тенантов.
    2. Создание словаря типа Таблица и импорт в него полученного ранее списка тенантов.
    3. Добавление в корреляционное правило локальной переменной с функцией dict для распознания имени тенанта по идентификатору.

       Пример:

       • Переменная: TenantName
       • Значение: dict('<Название ранее созданного словаря с тенантами>', TenantID)
    4. Добавление в корреляционное правило действия над активными листами, с помощью которого значение ранее созданной переменной будет с помощью функции Установить записываться в активный лист в формате Ключ–Значение. В качестве ключа следует задать поле активного листа (например, Тенант), а в поле значения обратиться к ранее созданной переменной (например, $TenantName).

    В результате срабатывания этого правила в активный лист будет помещаться название тенанта, опознанного функцией dict по идентификатору среди словаря тенантов. При создании виджетов по активным листам можно получить название тенанта, обратившись к названию поля активного листа (в примере выше это Тенант).

    Описанный метод можно применять и к другим полям событий с идентификаторами.

  Особенности использования псевдонимов в SQL-функциях и SELECT: допустимо использовать двойные и косые кавычки: ", `.
  При использовании пробелов или кириллицы псевдоним необходимо выделять кавычками: "<Псевдоним с пробелом>", значения следует выделять прямыми одинарными кавычками: '<Значение с пробелом>'.
  При отображении данных за предыдущий период сортировка по параметру count(ID) может работать неправильно. Рекомендуется использовать сортировку по параметру metric. Например, SELECT count(ID) AS "metric", Name AS "value" FROM `events` GROUP BY Name ORDER BY metric ASC LIMIT 250.

  Примеры запросов для получения аналитики по активным листам: SELECT * FROM `records` WHERE "Источник событий" = 'Екатеринбург' LIMIT 250 Запрос, который возвращает ключ активного листа с названием поля "Источник событий" и значением этого поля "Екатеринбург". SELECT count(_key) AS metric, Status AS value FROM `records` GROUP BY value ORDER BY metric DESC LIMIT 250 Запрос для круговой диаграммы, который возвращает количество ключей активного листа (агрегация count по полю _key) и все варианты значений пользовательского поля Status. В виджете отображается круговая диаграмма с общим количеством записей активного листа, пропорционально разделенным на количество вариантов значений поля Status. SELECT Name, Status, _count AS Number FROM `records` WHERE Description ILIKE '%ftp%' ORDER BY Name DESC LIMIT 250 Запрос для таблицы, которая возвращает значения пользовательских полей Name и Status, а также служебного поля _count у тех записей активного листа, в которых значения пользовательского поля Description соответствует запросу ILIKE '%ftp%'. В виджете отображается таблица со столбцами Status, Name и Number.

Вкладка :

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

• Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
• Минимальное значение X и Максимальное значение X – масштаб оси X.
• На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.

Вкладка :

• Название – название виджета.
• Описание – описание виджета.
• Цвет – цвет отображения информации:
  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.
• Горизонтальный – использование горизонтальной гистограммы вместо вертикальной.

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

• Итоговые значения – суммы значений.
• Легенда – легенда для аналитики. По умолчанию переключатель включен.

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

Другие виджеты

В этом разделе описываются параметры всех виджетов, кроме виджетов События и Активные листы.

Набор параметров, доступных для виджета, зависит от типа графика, который отображается на виджете. В KUMA доступны следующие типы графиков:

• Круговая диаграмма ().
• Счетчик ().
• Таблица ().
• Столбчатая диаграмма ().
• Календарная диаграмма ().
• Линейная диаграмма.
• Сложенная столбчатая диаграмма.

Параметры для круговых диаграмм

• Название – название виджета.
• Описание – описание виджета.

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

• Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
  • Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
  • 1 час – отображаются данные за предыдущий час.
  • 1 день – отображаются данные за предыдущий день.
  • 7 дней – отображаются данные за предыдущие 7 дней.
  • 30 дней – отображаются данные за предыдущие 30 дней.
  • В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.

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

• Итоговые значения – суммы значений.
• Легенда – легенда для аналитики. По умолчанию переключатель включен.

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

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

Параметры для счетчиков

• Название – название виджета.
• Описание – описание виджета.

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

• Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
  • Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
  • 1 час – отображаются данные за предыдущий час.
  • 1 день – отображаются данные за предыдущий день.
  • 7 дней – отображаются данные за предыдущие 7 дней.
  • 30 дней – отображаются данные за предыдущие 30 дней.
  • В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.

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

Параметры для таблиц

• Название – название виджета.
• Описание – описание виджета.

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

• Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
  • Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
  • 1 час – отображаются данные за предыдущий час.
  • 1 день – отображаются данные за предыдущий день.
  • 7 дней – отображаются данные за предыдущие 7 дней.
  • 30 дней – отображаются данные за предыдущие 30 дней.
  • В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.

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

• Показывать данные за предыдущий период – включение отображения данных сразу текущий и предыдущий периоды.
• Цвет – цвет отображения информации:
  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.
• Десятичные знаки – количество десятичных знаков, до которых отображаемое значение должно быть округлено.

Параметры для столбчатых и календарных диаграмм

Вкладка :

• Минимальное значение Y и Максимальное значение Y – масштаб оси Y.
• Минимальное значение X и Максимальное значение X – масштаб оси X.

  На осях графиков могут отображаться отрицательные значения. Это связано с масштабированием графиков на виджете и может быть исправлено выставлением нуля в качестве минимальных значений графиков вместо Авто.

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

Вкладка :

• Название – название виджета.
• Описание – описание виджета.

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

• Период – период, за который отображаются данные на виджете. Доступны следующие периоды:
  • Как на макете – отображаются данные за период, выбранный для макета. Значение по умолчанию.
  • 1 час – отображаются данные за предыдущий час.
  • 1 день – отображаются данные за предыдущий день.
  • 7 дней – отображаются данные за предыдущие 7 дней.
  • 30 дней – отображаются данные за предыдущие 30 дней.
  • В течение периода – отображаются данные за выбранный период времени. При выборе этого варианта в открывшемся календаре выберите дату начала и окончания периода и нажмите Применить фильтр. Формат даты и времени зависит от настроек вашей операционной системы. При необходимости вы можете изменить значения даты вручную.

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

• Показывать данные за предыдущий период – включение отображения данных сразу за два периода: за текущий и за предыдущий.
• Цвет – цвет отображения информации:
  • по умолчанию – цвет шрифта, который используется в вашем браузере по умолчанию;
  • зеленый;
  • красный;
  • синий;
  • желтый.
• Горизонтальный – использование горизонтальной гистограммы вместо вертикальной. При включении этого параметра вся имеющаяся информация будет отражена в заданном размере виджета. Если данных много, вы можете увеличить размер виджета для их оптимального отображения.
• Итоговые значения – суммы значений.
• Легенда – легенда для аналитики. По умолчанию переключатель включен.

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

• Длительность отрезков периода (доступно для графика типа Календарная диаграмма) – длительность отрезков, на которые требуется делить период.

Отображение названий тенантов в виджетах типа "Активный лист"

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

Процесс настройки состоит из следующих этапов:

1. Экспорт списка тенантов.
2. Создание словаря типа Таблица.
3. Импорт списка тенантов, полученного на шаге 1, в словарь, созданный на шаге 2 этой инструкции.
4. Добавление в корреляционное правило локальной переменной с функцией dict для распознания имени тенанта по идентификатору.

   Пример:

   • Переменная: TenantName.
   • Значение: dict('<Название ранее созданного словаря с тенантами>', TenantID).
5. Добавление в корреляционное правило действия Установить, с помощью которого значение ранее созданной переменной будет записываться в активный лист в формате <ключ> – <значение>. В качестве ключа следует задать поле активного листа (например, Тенант), а в поле значения указать переменную (например, $TenantName).

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