Работа с запусками

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

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

О запусках

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

В систему можно добавлять следующие сущности, обеспечивающие автоматизацию процессов:

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

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

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

Статусы запуска

Статусы запуска
Статус	Индикатор	Описание статуса
Выполнен	Зеленый	Плейбук выполнен.
В очереди ожидания	Синий	Плейбук находится в очереди ожидания на выполнение в воркере.
Согласован	Желтый	Пользователь согласовал запрос. Выполнение плейбука возобновлено.
В процессе	—	Плейбук выполняется.
Ошибка	Красный	Плейбук не выполнился или завершился с ошибкой.
Остановлен	Серый	Принудительная остановка выполнения плейбука.
На согласовании	Синий	Схема выполняемого плейбука содержит модуль `approval`, требующий согласования дальнейшего выполнения плейбука. Система отправила пользователю запрос на согласование. Выполнение плейбука приостановлено и будет продолжено после того, как пользователь согласует запрос.
Не согласован	Желтый	Пользователь отклонил запрос на согласование. Выполнение плейбука остановлено.
Истекло время согласования	Желтый	У плейбука истекло время ожидания резолюции.
Истекло время ожидания	Желтый	Схема выполняемого плейбука содержит модуль `userinput`, требующий ввода данных для дальнейшего выполнения плейбука. Данные не были введены в течение указанного интервала времени. Выполнение плейбука остановлено.
Ввод отклонен	Желтый	Схема выполняемого плейбука содержит модуль `userinput`, требующий ввода данных для дальнейшего выполнения плейбука. Пользователь отклонил выполнение действия в форме ввода данных. Выполнение плейбука остановлено.

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

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

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

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

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

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

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

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

Работа с запуском

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

триггер типа Расписание. Триггером является расписание.
триггер типа Событие. Триггером является наступление определенного события.
триггер типа Вебхук. Триггером является получение вебхука.

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

Добавление запуска
Просмотр запуска
Остановка запуска
Повторное выполнение запуска
Копирование ссылки запуска в буфер обмена

Добавление запуска

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

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

Перейдите в раздел Запуски.
Нажмите на кнопку Запустить (). Отобразится форма добавления запуска.
Выберите тип элементов экспертизы для запуска — Скрипт или Плейбук.

Для выбора доступны скрипты и плейбуки со статусом Включен.

Добавьте запускаемый элемент:

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

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

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

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

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

Укажите параметры запуска в блоке Настройки:

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

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

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

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

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

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

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

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

Если в скрипте или плейбуке выбрана схема конфигурации, система автоматически предлагает для выбора конфигурации, созданные на основе этой схемы.
Для аргументов типа file размер загруженного файла должен быть не больше 100 МБ.

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

Просмотр запуска

Чтобы просмотреть запуск:

Перейдите в раздел Запуски. Система отобразит сведения обо всех запусках.
Нажмите на строку запуска в списке. Система отобразит в правой части экрана карточку с подробной информацией.

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

Карточка запуска содержит следующие вкладки:

Информация — основная информация о запуске.
Статистика — список элементов плейбука со статусами.
Артефакты — артефакты, созданные плейбуком или скриптом, используемым для запуска.

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

На вкладке Информация отображаются основные сведения о запуске:

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

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

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

Вкладка Статистика

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

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

Статус — статус элемента и цветовой индикатор:

Статусы элементов
Статус	Индикатор	Описание статуса
Выполнен	Зеленый	Задание выполнено без ошибок.
В процессе	—	Задание выполняется.
Ошибка	Красный	Задание не выполнилось или завершилось с ошибкой.
Согласован	Зеленый	Пользователь согласовал запрос. Выполнение задания возобновлено.
На согласовании	Синий	Схема выполняемого плейбука содержит модуль `approval`, требующий согласования дальнейшего выполнения. Система отправила пользователю запрос на согласование. Выполнение задания приостановлено и будет продолжено после того, как пользователь согласует запрос.
Не согласован	Желтый	Пользователь отклонил запрос на согласование. Выполнение задания остановлено.
Истекло время согласования	Желтый	У задания истекло время ожидания резолюции.

Вкладка Артефакты

Вкладка Артефакты содержит артефакты, сформированные скриптом или плейбуком. Список артефактов представлен в виде таблицы со следующими столбцами:

Файл — имя и расширение артефакта.
Элемент плейбука (только для плейбука) — элемент плейбука, в результате выполнения которого сформирован артефакт.
Размер — размер артефакта.

После таблицы указано общее количество и суммарный размер артефактов.

Чтобы просмотреть информацию об артефакте, наведите курсор на иконку file слева от имени файла. Система отобразит окно со следующими полями:

Путь — путь к файлу.
Название — имя и расширение артефакта.
Размер — размер артефакта.
Создан — дата и время создания артефакта.
Доступен до — дата и время, когда артефакт станет недоступным.

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

Артефакты с истекшим сроком доступности не попадут в архив для скачивания.

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

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

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

Остановка запуска

Чтобы остановить запуск:

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

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

Копирование ссылки запуска в буфер обмена

Чтобы скопировать ссылку запуска:

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

Работа с логами запуска

Состояние каждой задачи от момента запуска до завершения автоматически логируется. Просмотра логов доступен через пользовательский интерфейс в карточке запуска.

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

Просмотр логов
Копирование логов запуска
Скачивание логов запуска

Просмотр логов

Чтобы просмотреть логи запуска:

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

Чтобы просмотреть логи конкретного элемента плейбука:

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

В заголовке окна отображается название плейбука или скрипта.

+ В списке логов выводится список событий с датой и временем. Если в скрипте или плейбуке есть входные параметры типа file, отображаются сведения об операциях с файлами:

статус — success или failed;
идентификатор файла;
имя пользователя, инициировавшего операцию.

Копирование логов запуска

Чтобы скопировать записи журнала логов запуска:

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

Скачивание логов запуска

Чтобы скачать файл журнала логов запуска:

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

Была ли полезна эта страница?