События
Это системный контекст, который предоставляет доступ к различным данным и операциям, связанным с управлением событиями. Он не отображается в видимой части контекстного дерева.
Уникальные действия
[?]
Удалить истекшие события
Удаляет истекшие события из истории событий.
Тип действия: | |
Имя действия: | removeExpired |
Права доступа: | Доступно на уровне с правами доступа для Инженеров. |
Действия, относящиеся к переменным
[?]
Подтвердить тревогу
Это действие доступно для:
Переменной активного экземпляра любого контекста тревоги
Переменной активных тревог любого контекста сервера
Это действие позволяет подтвердить событие тревоги, которое было выбрано в таблице активных экземпляров или активных тревог. Оно предлагает оператору сначала ввести текст подтверждения.
Имя действия: | acknowledgeAlert |
Неинтерактивный режим: | не поддерживается |
Права доступа: | Доступны на уровне прав доступа Отсутствует |
Дополнительная информация |
Информация о контексте
Тип контекста: события
Имя контекста: события
Описание контекста: события
Путь контекста: события
Контекстная маска: события
Права доступа к контексту
[?]
Уровень | Описание |
Отсутствует | Нет доступа. |
Наблюдатель | Доступ к истории событий. |
Оператор | Подтверждение событий. |
Менеджер | Удаление событий. |
Инженер | Массовое удаление событий. Удаление просроченных событий. |
Администратор | Все операции. |
Общие переменные (свойства)
[?]
У данного контекста нет общих переменных (свойств).
Общие функции
[?]
Подтвердить событие
Добавляет новое подтверждение в событие.
Имя функции: | acknowledge | ||
Права доступа: | Доступно на уровне с правами доступа для Оператора. | ||
Записи ввода: | 1 | ||
Формат ввода: | Имя | Тип | Описание |
|---|---|---|---|
context | Строка | Контекст события для подтверждения. | |
name | Строка | Имя события для подтверждения. | |
id | Длинное | ID события для подтверждения. | |
ack | Строка | Текст подтверждения. | |
author | Строка | Автор подтверждения (факультативное поле, используется username активного пользователя, если автор не был задан). Это простое текстовое поле, поэтому его не следует считать проверяемым (auditable) (должно быть всегда точным). | |
Записи вывода: | 0 | ||
Формат вывода: | нет | ||
Обогатить событие
Добавляет новое обогащение к событию.
Имя функции: | enrich | ||
Права доступа: | Доступно на уровне с правами доступа для Инженера. | ||
Записи ввода: | 1 | ||
Формат ввода: | Имя | Тип | Описание |
|---|---|---|---|
context | Строка | Контекст события для подтверждения. | |
name | Строка | Имя события для подтверждения. | |
id | Длинное | Идентификатор события для подтверждения. | |
enrichmentName | Строка | Имя обогащения. Может содержать только английские буквы, цифры и подчеркивания. | |
enrichmentValue | Строка | Строка значения обогащения. Цифры, даты и другие типы обогащений должны быть закодированы в строки с использованием метода, предпочтительного для инструментов, которые должны будут позже анализировать это обогащение. | |
Записи вывода: | 0 | ||
Формат вывода: | Отсутствует | ||
Обновить событие
Изменяет одно событие, произошедшее в прошлом, не вызывая нового события. Выражение (expression) оценивается в заданном контексте (context) и должно возвращать таблицу данных, отформатированную как экземпляр события. Полученная таблица данных используется для обновления экземпляра события, по id в хранилище , при этом права доступа для этого экземпляра события не изменяются. Событие, полученное по id, предоставляется в качестве таблицы данных по умолчанию для данного выражения. Указанные context и name должны точно совпадать с context и name указанного id события.
Имя функции: | update | |||||
Права доступа: | Доступно на уровне с правами доступа для Менеджера. | |||||
Записи ввода: | 1 | |||||
Формат ввода: | Имя | Тип | Описание | |||
context | Строка | Контекст, в котором произошло событие. | ||||
name | Строка | Имя события. | ||||
id | Длинное | Идентификатор события. | ||||
expression | Строка | Текст выражения, используемого для обновления события. В результате выполнения выражения должна получиться таблица данных с тем же форматом, что и таблица данных по умолчанию. | ||||
Среда вычисления выражения: | ||||||
Контекст, в котором произошло событие. | ||||||
Таблица данных события. | ||||||
0 | ||||||
Имя | Тип | Описание | ||||
id | Длинное | Уникальный идентификатор события. | ||||
context | Строка | Полный путь к контексту события. | ||||
event | Строка | Имя события. | ||||
level | Целое | Уровень события. | ||||
time | Дата | Временная метка события. | ||||
acknowledgements | Таблица данных | Таблица подтверждений события. | ||||
enrichments | Таблица данных | Таблица обогащений события. | ||||
Записи вывода: | 0 | |||||
Формат вывода: | Отсутствует | |||||
Удалить событие
Навсегда удаляет событие из истории событий.
Имя функции: | delete | ||
Права доступа: | Доступно на уровне с правами доступа для Менеджера. | ||
Записи ввода: | 0...не ограничено | ||
Формат ввода: | Имя | Тип | Описание |
|---|---|---|---|
context | Строка | Путь контекста события, в котором произвошло событие. | |
name | Строка | Имя события. | |
id | Длинное | Идентификатор события. | |
Записи вывода: | 0 | ||
Формат вывода: | нет | ||
Удалить истекшие события
Удаляет все истекшие события из истории событий. Обратите внимание, что обычно все истекшие события автоматически удаляетAggreGate Server при периодическом выполнении этой функции.
Имя функции: | removeExpired |
Права доступа: | Доступно на уровне с правами доступа для Инженера. |
Записи ввода: | 0 |
Формат ввода: | нет |
Записи вывода: | 0 |
Формат вывода: | нет |
Получить историю события
Возвращает историю определенного события. См. действие Просмотреть историю событий.
Имя функции: | get | |||||
Права доступа: | Доступно на уровне с правами доступа для Наблюдателя. | |||||
Записи ввода: | 1 | |||||
Формат ввода: | Имя | Тип | Описание | |||
mask | Строка | Контекстная маска, определяющая ряд контекстов, из которых необходимо выбрать события. | ||||
event | Строка | Имя события. | ||||
filter | Строка | Текст выражения для фильтрации событий или NULL для отключения фильтрации. Используйте свойство limit при фильтрации, чтобы уменьшить потребление памяти сервером. | ||||
Среда вычисления выражения: | ||||||
Контекст, в котором произошло событие. | ||||||
Таблица данных события. | ||||||
0 | ||||||
Имя | Тип | Описание | ||||
id | Длинное | Уникальный идентификатор события. | ||||
context | Строка | Полный путь к контексту события. | ||||
event | Строка | Имя события. | ||||
level | Целое | Уровень события. | ||||
time | Дата | Временная метка события. | ||||
acknowledgements | Таблица данных | Таблица подтверждений события. | ||||
enrichments | Таблица данных | Таблица обогащений события. | ||||
fromDate | Дата | Временная метка, используемая для выбора только тех событий, которые произошли после определенной даты. Если значение NULL, будут выбраны все события. | ||||
toDate | Дата | Временная метка, используемая для выбора только тех событий, которые произошли до определенной даты. Если значение NULL, будут выбраны все события. | ||||
dataAsTable | Булевое | Это скрытое поле. Если оно равно false (по умолчанию), поле таблицы данных каждого события помещается в отдельное поле вывода функции. Если оно равно true, таблица данных каждого события помещается в отдельное поле (тип - Таблица данных) вывода функции. | ||||
sortField | Строка | Это скрытое поле. Оно определяет порядок сортировки событий:
| ||||
sortOrder | Булевое | Это скрытое поле. Оно определяет, должен ли использоваться восходящий порядок сортировки. | ||||
limit | Целое | Это скрытое поле. Оно определяет максимальное количество событий для загрузки или NULL для загрузки всех доступных событий. Эта опция не совместима с фильтрацией. | ||||
additionalCriteria | Таблица данных | Это скрытое поле. Определяет дополнительные критерии фильтрации уровня хранения. Подходит только для реляционных БД. | ||||
Имя | Тип | Описание | ||||
logical | Целое | Логическая операция:
| ||||
type | Целое | Тип фильтра:
| ||||
column | Строка | Имя столбца. | ||||
operation | Строка | Операция фильтрации. Доступны следующие операции:
| ||||
value | String | Значение столбца. | ||||
nested | Таблица данных | Определяет вложенное условие. | ||||
Записи вывода: | 0...не ограничено | |||||
Формат вывода: | Динамический | |||||
Имя | Тип | Описание | ||||
eId | Длинное | Идентификатор события (скрытое поле). | ||||
eCreationtime | Дата | Время создания события. | ||||
eExpirationtime | Дата | Время истечения события. | ||||
eContext | Строка | Путь контекста источника события. | ||||
eName | Строка | Имя типа события. | ||||
eLevel | Целое | Уровень события. | ||||
eCount | Целое | Количество событий (если подобные события были блокированы дедупликацией). | ||||
eAcknowledgements | Таблица данных | Подтверждения события. | ||||
eData | Таблица данных | Данные, специфичные для события. Это поле будет включено в вывод, только если включены настройки ввода dataAsTable. | ||||
* | * | Оставшиеся поля будут добавляться, только если выключены настройки ввода dataAsTable. Количество, имена, типы и другие параметры полей будут соответствовать тем, которые заявлены в определении событий. | ||||
Получить событие по идентификатору
Возвращает одно событие с определенным идентификатором.
Имя функции: | getById | ||
Права доступа: | Доступны на уровне с правами доступа для Наблюдателя | ||
Записи ввода: | 1 | ||
Формат ввода: | Имя | Тип | Описание |
|---|---|---|---|
context | Строка | Контекст события. | |
event | Строка | Имя типа события. | |
id | Длинное | Идентификатор события. | |
dataAsTable | Булевое | Это скрытое поле. Если оно равно false (по умолчанию), каждое поле таблицы данных события помещается в отдельное поле вывода функции. Если равно true, каждая таблица данных события помещается в одно поле (тип - Таблица данных) вывода функции. | |
Записи вывода: | 1 | ||
Формат вывода: | Динамический: | ||
Имя | Тип | Описание | |
eId | Длинное | Идентификатор события (скрытое поле). | |
eCreationtime | Дата | Время создания события. | |
eExpirationtime | Дата | Время истечения события. | |
eContext | Строка | Путь контекста источника события. | |
eName | Строка | Имя типа события. | |
eLevel | Целое | Уровень события. | |
eCount | Целое | Количество событий (если подобные события блокировались дедупликацией). | |
eAcknowledgements | Таблица данных | Подтверждения события. | |
eData | Таблица данных | Данные, специфичные для события. Это поле будет включено в вывод, только если включены настройки ввода dataAsTable. | |
* | * | Оставшиеся поля будут добавляться, только если выключены настройки ввода dataAsTable. Количество, имена, типы и другие параметры полей будут соответствовать тем, которые заявлены в определении событий. | |
Удалить события
Удаляет события из истории событий.
Имя функции: | massDelete | ||
Права доступа: | Доступно на уровне с правами доступа для Инженера. | ||
Записи ввода: | 1 | ||
Формат ввода: | Имя | Тип | Описание |
|---|---|---|---|
mask | Строка | Контекстная маска, определяющая ряд контекстов, из которых необходимо удалить события. | |
event | Строка | Имя события. | |
startDate | Дата | Nullable (Нет данных). Если задано, удаляются только те события, которые возникают после startDate. | |
endDate | Дата | Nullable (Нет данных). Если задано, удаляются только те события, которые возникли до endDate. | |
Записи вывода: | 0 | ||
Формат вывода: | нет | ||
Общие события
[?]
Общие события: info (информация)