Схемы шаблонов отчетов

id: уникальный идентификатор схемы шаблона отчета. Значение — пять групп из шестнадцатеричных цифр в формате 8-4-4-4-12, разделенных дефисом. Буквы — только строчные латинские. Формат значения: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. Должен быть уникальным в рамках коллектора.

name: название схемы шаблона отчета. Допустимы латинские буквы, цифры, символы подчеркивания, точки и дефисы.

description (опционально): краткое описание назначения шаблона отчета.

type: всегда указывается report_template_schema для элементов экспертизы данного типа.

version: версия схемы шаблона отчета согласно стандарту Semantic Versioning.

author: имя и контактные данные автора схемы шаблона отчета.

data_source: список источников данных, с которыми совместима схема шаблона отчета. Это поле используется для классификации и быстрого поиска элементов в системе.

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

Схема шаблона отчета с уникальным идентификатором 61f0c404-5cb3-11e7-907b-000000000000 предназначена для создания отчетов по метрикам системы и событиям.

Название схемы System Report Template описывает назначение шаблона.

Поле type указывает, что тип элемента экспертизы (report_template_schema).

Версия шаблона отчета задана как 1.0.0 в соответствии с правилами семантического версионирования.

Автором схемы является John Doe, чьи контактные данные указаны в поле author.

В поле data_source перечислены источники данных, совместимые с отчетом — Windows и Linux.

Теги system и report присвоены для облегчения поиска и классификации шаблона отчета в системе.

unit: единица времени, например, MINUTE, HOUR, DAY, MONTH.

value: числовое значение для выбранной единицы времени.

Поле storagePeriod задает временной интервал для сохранения данных, который равен 60 минутам. Это означает, что данные, собранные за последние 60 минут, будут включены в отчет.

hours: часы, в которые будет формироваться отчет (формат 0-23).

minutes: минуты для формирования отчета (формат 0-59).

seconds: секунды для формирования отчета (формат 0-59).

dayOfMonth: день месяца для формирования отчета (1-31 или * для ежедневного отчета).

dayOfWeek: день недели для формирования отчета (0-6, где 0 — это воскресенье).

month: месяц для формирования отчета (1-12 или * для ежемесячного отчета).

Отчет будет формироваться каждый день в 10:00:00 утра, так как hours установлено на "10", а minutes и seconds установлены на "0".

Поле dayOfMonth установлено на *, что означает формирование отчета каждый день месяца.

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

key: уникальный идентификатор переменной.

type: тип источника данных (допустимые значения: EVENT_STORAGE для хранилища событий, METRIC для метрик, ALERT для оповещений).

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

id: уникальный идентификатор виджета.

x, y: координаты виджета на сетке (x — позиция по горизонтали, y — по вертикали).

w, h: размеры виджета в ячейках (ширина w и высота h).

maxH, minH, minW: ограничения по минимальной и максимальной высоте и ширине.

Виджет с идентификатором WIDGET_KEY_1 размещен в позиции x: 0, y: 1, что означает его расположение в первой колонке и второй строке сетки шаблона отчета.

Размер виджета составляет 6 ячеек по ширине (w: 6) и 3 ячейки по высоте (h: 3).

Ограничения для виджета установлены: максимальная высота — 5 ячеек, минимальная высота — 3 ячейки, минимальная ширина — 6 ячеек.

id: уникальный идентификатор виджета.

name: название виджета.

description: краткое описание функциональности виджета.

autoUpdate: настройки автоматического обновления данных (единица времени и интервал).

last: временной период отображаемых данных (например, последний день или месяц).

variables: параметры запроса данных для виджета.

Виджет с идентификатором WIDGET_KEY_1 имеет название "Host DB RAM" и предназначен для отображения использования оперативной памяти базы данных.

Описание виджета указано в поле description как "Отображает текущее использование RAM базой данных".

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

Поле last указывает, что виджет будет отображать данные за последний день.

Источник данных для виджета — метрика (source: METRIC), с идентификатором метрики metricId: c9c9e971-7d45-48eb-9ed5-000000000000. Дополнительные параметры запроса определены как queryArguments: [], и шаг агрегации данных установлен на один день (step: ONE_DAY).

source: определяет источник данных для виджета (допустимые значения: METRIC, SEARCH, ALERT).

metricId: идентификатор метрики, данные которой отображаются.

step: интервал времени, за который агрегируются данные.

Виджет с идентификатором WIDGET_KEY_1 называется "CPU Usage" и предназначен для отображения текущей загрузки процессора системы.

Поле description содержит описание "Отображает использование CPU системы".

Виджет обновляется каждые 5 минут, что задано в поле autoUpdate (unit: MINUTE, value: 5).

Поле last указывает, что данные за последний час будут агрегироваться и отображаться на виджете (unit: HOUR, value: 1).

Источник данных для виджета определен в поле variables. Здесь указывается, что данные берутся из метрики (source: METRIC), с идентификатором метрики metricId: "c9c9e971-7d45-48eb-9ed5-000000000000", а интервал агрегации данных установлен на одну минуту (step: ONE_MINUTE).

chartType: тип графика (LINE_CHART, BAR_CHART, PIE_CHART, TABLE, TOTAL).

rql: запрос на языке RQL для получения данных.

nameMapping: сопоставление полей запроса с осями графика (например, x — время, y — количество).

Виджет с идентификатором WIDGET_KEY_2 называется "Event Storage Counter" и предназначен для отображения количества событий в хранилище.

Поле description содержит описание "Отображает количество событий в хранилище".

Виджет автоматически обновляется каждые 30 минут, что задано в поле autoUpdate (unit: MINUTE, value: 30).

Поле last указывает, что виджет будет отображать данные за последний месяц (unit: MONTH, value: 1).

В поле variables виджет использует источник данных типа SEARCH и тип графика LINE_CHART, что означает, что данные будут отображаться в виде линейного графика.

Запрос на языке RQL (rql) возвращает количество событий (cnt), сгруппированных по часам (toStartOfHour(timestamp)).

Поле nameMapping используется для сопоставления полей запроса с осями графика: поле ts отображается на оси x, а количество событий cnt — на оси y.

chartType: всегда имеет значение TABLE.

rql: запрос на языке RQL для получения данных, которые будут отображены в таблице.

nameMapping: сопоставление полей с колонками таблицы (например, timestamp, count).

Виджет с идентификатором WIDGET_KEY_3 называется "Event Table" и отображает события с указанием временных меток.

Поле description содержит описание "Отображает события с временными метками".

Виджет автоматически обновляется каждые 30 минут (autoUpdate с параметрами unit: MINUTE и value: 30).

Поле last указывает, что виджет будет отображать данные за последний день (unit: DAY, value: 1).

В поле variables указано, что виджет использует тип отображения данных TABLE (chartType: TABLE), а данные запрашиваются из источника типа SEARCH.

Запрос на языке RQL (rql) получает временные метки (timestamp) и количество событий (cnt), сгруппированных по времени.

Поле nameMapping сопоставляет поля запроса с колонками таблицы: поле timestamp отображается в колонке с временными метками, а поле cnt — в колонке с количеством событий.

source: всегда указывается ALERT.

kind: тип отображаемых оповещений (active, new, last, distributionByField, distributionByTime, total).

filter: опциональные фильтры для отображаемых оповещений (например, по уровню угрозы).

Виджет с идентификатором WIDGET_KEY_4 называется "Active Alerts" и предназначен для отображения активных оповещений в системе.

Поле description содержит описание "Отображает активные оповещения в системе").

Виджет обновляется каждую минуту (autoUpdate с параметрами unit: MINUTE, value: 1).

Поле last указывает, что виджет будет отображать оповещения за последний час (unit: HOUR, value: 1).

Источник данных для виджета — это оповещения (source: ALERT).

Поле kind указывает, что отображаются только активные оповещения (kind: active), без дополнительной фильтрации (параметры в active: {} не указаны).

chartType: всегда имеет значение TOTAL.

rql: запрос языке RQL для получения сводных данных.

nameMapping: сопоставление результата с отображаемым полем.

Виджет с идентификатором WIDGET_KEY_5 назван "Total Event Count" и отображает общее количество событий.

Поле description содержит описание "Отображает общее количество событий".

Виджет автоматически обновляется каждые 30 минут (autoUpdate с параметрами unit: MINUTE и value: 30).

Поле last указывает, что виджет будет отображать данные за последний месяц (unit: MONTH, value: 1).

Источник данных — хранилище событий (source: SEARCH), тип виджета — сводный (chartType: TOTAL).

Запрос на языке RQL (rql) возвращает общее количество событий в хранилище (SELECT count(id) as cnt FROM event_storage).

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