Работа с триггерами

Данный раздел описывает процесс работы с триггерами определенных элементов экспертизы в системе. Работа осуществляется в разделе Автоматизация → Триггеры веб-интерфейса системы.

Раздел доступен администраторам, пользователям, которые имеют соответствующее разрешение в составе своих ролей, а также учетным записям со статусом Суперадминистратор.

О триггерах

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

В системе можно задать два типа триггеров:

Расписание — триггер, в котором условием запуска скрипта или плейбука являются параметры расписания.
Событие триггера — триггер, в котором условием запуска скрипта или плейбука является наступление определенного события.

Интерфейс раздела

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

Кнопка Создать () позволяет создать новый триггер. По этой кнопке открывается форма создания триггера.
Поле Поиск предназначено для быстрого поиска триггеров в отображаемом списке.
Кнопка Фильтр позволяет настроить критерии фильтрации триггеров. В параметрах фильтрации доступны опции для установки Типа и Статуса искомых элементов.

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

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

Название — название триггера.
Тип триггера — тип события, инициирующего запуск скрипта или плейбука (Расписание, Создание сущности, Изменение сущности, Удаление сущности).
Детали — сведения о расписании или событии, инициирующих запуск скрипта или плейбука.
- Для расписания отображается cron-выражение, заданное в параметрах триггера.
- Для события может отображаться следующая информация:
  - название события, которое происходит с сущностью (создание, изменение, удаление);
  - название Пользовательский — если пользователь самостоятельно определяет событие, которое послужит триггером.
Статус — текущий статус триггера (Включен или Выключен).
Группа воркеров — теги воркеров, используемых при запуске плейбука или скрипта.
- Если хотя бы один воркер с этим тегом находится в статусе Включен, отображается зеленый индикатор.
- Если все воркеры с этим тегом находятся в статусе Выключен или Ошибка, отображается серый индикатор.
Плейбук/Скрипт — название плейбука или скрипта, запускаемого при выполнении условий триггера.
Дата создания — дата и время создания триггера.
Дата изменения — дата и время изменения триггера.

При работе с таблицей триггеров доступны следующие операции:

Поиск триггеров по полям Название и Плейбук/Скрипт.
Фильтрация триггеров по полям Тип триггера и Статус. Тип триггера и статус выбираются из выпадающих списков.
Сортировка триггеров по полям Название, Тип триггера, Статус, Дата создания и Дата изменения.

Работа с триггером

Доступные операции над триггером:

Создание триггера
Просмотр триггера
Включение и выключение триггера
Изменение триггера
Удаление триггера

Создание триггера

Создание триггера типа "Расписание"

Чтобы создать триггер типа "Расписание":

Перейдите в раздел Автоматизация → Триггеры.
Нажмите на кнопку Создать (). Отобразится окно создания триггера.

Добавьте элемент экспертизы. Для этого:

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

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

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

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

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

Укажите параметры запуска:

В блоке Настройки:

В поле Название экспертизы отображается элемент экспертизы, который будет запущен. Чтобы просмотреть элемент в отдельной вкладке, нажмите на кнопку Открыть.
Выберите из выпадающего списка ID тенанта, в котором будет выполнен запуск.

По умолчанию в параметрах отображается текущий тенант, в котором работает пользователь.

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

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

По умолчанию поле имеет значение all. В этом случае для запуска будет использоваться любой из доступных воркеров.

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

В блоке Триггер выберите тип триггера для расписания и укажите параметры расписания, определяющего запуск триггера:
- В выпадающем списке Тип выберите значение Расписание.
- Название — название события триггера.
- Описание — описание события триггера.
- Cron-выражение — выражение, использующее синтаксис CRON и задающее время запуска.
  
  Используются следующие символы:
  - "*" — любое значение;
  - "," — разделитель списка значений;
  - "-" — диапазон значений;
  - "/" — значение шага.
    
    Примеры настроек Cron-выражения
    
    Запускать каждые 20 минут с 8 до 18 с понедельника по пятницу:
    
    0 */20 8-18 * * 1-5
    
    Запускать 1 января, 1 апреля, 1 июля и 1 октября в 2:00:00:
    
    0 0 2 1 1,4,7,10 *
    
    Ознакомьтесь с подробным описанием синтаксиса CRON.
- Часовой пояс — сведения о часовом поясе, для которого настраивается расписание. По умолчанию отображается часовой пояс системы.
- Повторы запуска при ошибке
  
  Значение в этом поле определяет, в каком режиме система будет запускать скрипт по этому триггеру — один раз или с повторением. В режиме повторения в случае выявления ошибок при запуске скрипт будет запускаться указанное количество раз и с указанным интервалом.
  
  В выпадающем списке доступны значения:
  - Без повторов — скрипт по триггеру будет запущен только один раз. Значение отображается по умолчанию.
  - Постоянно — скрипт по триггеру будет запускаться повторно в соответствии с параметрами повторного запуска.
    
    Если вам нужно, чтобы в случае ошибки запуска скрипта система пыталась запустить скрипт повторно, выберите из выпадающего списка значение Постоянно и укажите параметры повторного запуска:
  - Количество попыток — максимальное количество попыток запуска скрипта.
  - Повторять через — интервал между попытками запуска скрипта.
  - Единицы измерения — единицы измерения интервала запуска скрипта (сек., мин., ч., дн.).
- Окончание действия расписания — дата и время окончания действия расписания. В выпадающем списке доступны значения:
  - Нет конечной даты — расписание действует всегда (значение установлено по умолчанию).
  - По дате — расписание действует до указанной даты.

Нажмите на кнопку Запустить ( play ). Триггер будет запущен. Система отобразит соответствующее уведомление.

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

Создание триггера типа "Событие триггера"

Чтобы создать триггер типа "Событие триггера":

Перейдите в раздел Автоматизация → Триггеры.
Нажмите на кнопку Создать (). Отобразится окно создания триггера.

Добавьте элемент экспертизы. Для этого:

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

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

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

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

Укажите параметры запуска:

В блоке Настройки:

В поле Название экспертизы отображается элемент экспертизы, который будет запущен. Чтобы просмотреть элемент в отдельной вкладке, нажмите на кнопку Открыть.
Выберите из выпадающего списка ID тенанта, в котором будет выполнен запуск.

По умолчанию в параметрах отображается текущий тенант, в котором работает пользователь.

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

В блоке Триггер выберите тип триггера для события и укажите параметры события, наступление которого инициирует действие триггера:
- В выпадающем списке Тип выберите значение Событие триггера.
- Название — название события триггера.
- Описание — описание события триггера (опционально).
- Тип события триггера — тип события триггера.
  
  Доступные типы:
  - Создание объекта;
  - Изменение объекта;
  - Удаление объекта;
  - Пользовательский — событие, которое послужит триггером, задается пользователем.
    
    Если выбран тип Пользовательский, укажите модуль, который создает события триггера, и событие, при наступлении которого произойдет запуск плейбука или скрипта.
    
    Список событий, которые можно использовать как триггер, доступен в хранилище событий аудита.
    
    Чтобы отобразить список событий и узнать модуль и название нужного события:
    
    Перейдите в раздел Поиск основного меню системы.
    
    Выберите хранилище событий аудита из списка хранилищ в верхней части экрана. Система отобразит список событий аудита в хранилище.
    
    Выберите из списка требуемое событие. Название модуля события указано в колонке moduleKey, а название события — в колонке eventType. Эти данные необходимо указать в форме создания триггера типа Пользовательский.
    
    Если выбран любой другой тип события, выберите из списка Домен домен, в котором должно наступить событие, а затем из списка Сущность выберите сущность, для которой создается действие триггера.
- Повторы запуска при ошибке — это поле определяет, в каком режиме система будет запускать скрипт по триггеру — один раз или с повторением. В режиме повторения в случае выявления ошибок при запуске скрипт будет запускаться указанное количество раз и с указанным интервалом.
  
  В выпадающем списке доступны значения:
  - Без повторов — скрипт по триггеру будет запущен только один раз. Значение отображается по умолчанию.
  - Постоянно — скрипт по триггеру будет запускаться повторно в соответствии с параметрами повторного запуска.
    
    Если вам нужно, чтобы в случае ошибки запуска скрипта система пыталась запустить скрипт повторно, выберите из выпадающего списка значение Постоянно и укажите параметры повторного запуска:
    
    Количество попыток — максимальное количество попыток запуска скрипта.
    
    Повторять через — интервал между попытками запуска скрипта.
    
    Единицы измерения — единицы измерения интервала запуска скрипта (сек., мин., ч., дн.).

Нажмите на кнопку Запустить ( play ). Триггер будет запущен. Система отобразит соответствующее уведомление.

Просмотр триггера

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

Перейдите в раздел Автоматизация → Триггеры. Система отобразит сведения об имеющихся триггерах.
Нажмите на строку триггера в списке. Система отобразит справа карточку с подробной информацией об этом триггере.

Название триггера отображается в верхней части карточки. Справа от названия расположены кнопки для изменения ( edit ) и удаления ( trash ) триггера.

Карточка триггера содержит вкладки:

Информация — основные сведения о триггере.
Запуски — информация о запусках триггера.

Вкладка Информация

Вкладка Информация содержит следующие поля:

ID тенанта — ID тенанта, в котором был добавлен триггер.
Название — название триггера.
Описание — описание триггера.
Тип события — тип события, инициирующего запуск скрипта или плейбука (Расписание, Создание сущности, Изменение сущности, Удаление сущности).
Группа воркеров — теги воркеров, используемых при запуске скрипта или плейбука.
- Если хотя бы один воркер с этим тегом находится в статусе Включен, отображается зеленый индикатор.
- Если все воркеры с этим тегом находятся в статусе Выключен или Ошибка, отображается серый индикатор.
Плейбук/скрипт — название плейбука или скрипта, запуск которого инициируется триггером.
ID интеграции — идентификатор интеграции, позволяющий получить сведения о запуске для использования в скриптах и плейбуках. Эти сведения содержатся в специальном хранилище данных о запусках.

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

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

Ниже отображаются текущие настройки триггера:

Для типа триггера Расписание в карточке отображаются настройки расписания.
Для типа триггера Событие триггера в карточке отображаются настройки события.

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

Вкладка Запуски

Вкладка Запуски содержит таблицу с информацией о запусках текущего триггера, в случае, если запуски были. Данные о запуске хранятся 30 дней с момента запуска. Таблица содержит следующие столбцы:

Время старта — дата и время запуска триггера.
Время выполнения — время, затраченное на выполнение запуска.
Статус — статус запуска.

Сортировка списка запусков может осуществляться по следующим столбцам:

Время запуска.
Статус.

Включение и выключение триггера

Чтобы включить триггер:

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

Чтобы выключить триггер:

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

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

Изменение триггера

Чтобы изменить триггер:

Перейдите в раздел Автоматизация → Триггеры. Система отобразит сведения об имеющихся триггерах.
Нажмите на строку триггера в списке. Система отобразит справа карточку с подробной информацией об этом триггере.
Нажмите на кнопку Изменить () в верхней части карточки триггера. Отобразится окно настроек триггера.
Внесите изменения в требуемые поля триггера.
Нажмите на кнопку Сохранить. Измененные данные триггера будут сохранены.

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

Сохранить позволяет сохранить измененные параметры триггера.
Отменить позволяет отменить изменение параметров триггера и удалить введенные значения из полей.

Удаление триггера

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