Kaspersky Symphony XDR: Open Single Management Platform
Виджет "Контекстные таблицы"

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

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

Вкладка Selectors:

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

Описание параметров

Параметр

Описание

График

Тип графика. Доступны следующие типы графиков:

  • Столбчатая диаграмма.
  • Круговая диаграмма.
  • Счетчик.
  • Таблица.

Тенант

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

Коррелятор

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

Контекстная таблица

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

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

Поле 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.

Особенности использования псевдонимов в 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.

Вкладка Действия:

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

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

Описание параметров

Параметр

Описание

Минимальное значение Y и Максимальное значение Y

Масштаб оси Y.

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

Минимальное значение X и Максимальное значение X

Масштаб оси X.

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

Вкладка wrench:

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

Описание параметров

Параметры

Описание

Название

Название веб-виджета.

Описание

Описание веб-виджета.

Цвет

Цвет отображения информации:

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

Горизонтальный

Использование горизонтальной гистограммы вместо вертикальной.

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

Итоговые значения

Суммы значений.

Легенда

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

Пустые значения в легенде

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