Инструкция по использованию платформы микросервисной задачевой распределённой системы

1. Главная страница управления распределением задач

Главная страница управления распределением задач включает три основных части: информация о распределителях, количество распределений и детали проектов, связанных с распределителем.

• Информация о распределителях: количество распределителей центра распределения;
• Количество распределений: историческое общее количество распределений задач Job центром распределения;
• Детали проектов, связанных с распределителем: общее количество групп проектов, связанных с центром распределения, общее количество задач Job.

1.1 Информация о распределителях

Нажмите на "информацию о распределителях", чтобы отобразить интерфейс деталей распределения ресурсов, как показано ниже: Каждый распределитель имеет три конкретных показателя:

1. Верхний порог задач: динамический порог нагрузки задач;
2. Количество выполняемых задач: текущее количество задач, выполняемых данным распределителем;
3. Предупредительный порог задач: когда количество задач, выполняемых распределителем, превышает предупредительный порог, отправляется электронное письмо администратору. При наведении указателя мыши на любой распределитель будет отображена эта информация. ### 1.2 Количество распределений Нажмите на "количество распределений", чтобы отобразить детали распределения распределителя, всего два графика:

• График трендов распределения распределителя
• Статистика состояния распределения задач

1.2.1 График трендов распределения распределителя

"График трендов распределения распределителя" представляет собой реальные данные статистики количества выполненных распределителями задач Job или Task, что позволяет легко наблюдать за состоянием распределения в течение некоторого периода времени.

• Выберите количество распределений задач Job или Task с помощью выпадающего списка;
• Установив временной диапазон, можно отобразить соответствующий график;
• Под графиком находятся конкретные экземпляры каждого распределителя, которые можно отображать или скрывать при клике.

1.2 Quantity of Distributions

Click on "quantity of distributions" to display the details of the distributor's distribution, a total of two graphs:

• Distribution trend chart
• Statistics of task distribution status

1.2.1 Distribution Trend Chart

The "distribution trend chart" represents real statistical data on the number of tasks Job or Task completed by distributors, allowing you to easily observe the state of distribution over some period of time.

• Select the quantity of job or task distributions using the drop-down list;
• By setting the time range, you can display the corresponding graph;
• Below the graph are specific instances of each distributor that can be displayed or hidden with a click.#### 1.2.2 Статистика состояния распределения задач "Статистика состояния распределения задач" представляет историческую информацию о распределении всех распределителей.
• Можно вывести аномальное и завершённое состояние задач Job или Task;
• После выбора временного интервала можно выбрать просмотр всей информации или информации о конкретном распределителе с помощью выпадающего списка;
• Можно выбрать просмотр информации о задачах Job или Task с помощью выпадающего списка;
• При клике на кнопки "аномальное" или "завершённое" под графиком можно отображать или скрывать соответствующие линии графика. ### 1.3 Детали проектов, связанных с распределителем Нажмите на "details of projects related to the distributor", чтобы отобразить детали проектов, связанных с платформой микросервисной задачевой распределенной системы, как показано ниже:
• jobGroup: название группы проектов, связанной с распределителем;
• Количество задач Job: количество задач Job, настроенных группой проектов;
• Количество задач Task: количество задач Task, автоматически или вручную настроенных группой проектов;
• Предупредительная почта: список контактов группы проектов. Это помогает администратору быстро получить представление о состоянии всех групп проектов, связанных с центром распределения.

2. Управление расписанием

Чтобы перейти в раздел управления расписанием, нажмите на Scheduling Management в левой панели. По умолчанию отображается страница с подробной информацией о распределении ресурсов, как показано ниже:

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

• тип: тип задачи Job, который может быть Cron или fixedRate
• значение типа Job: выражение Cron
• электронная почта для уведомлений: электронная почта, указанная для уведомлений данной задачи Job
• описание: описание функциональности задачи JobЭто позволяет администратору быстро получить информацию о захваченных задачах Job для каждого расписания.

Нажав на Management of Schedule в верхней части экрана, вы получите следующую страницу, которая делится на несколько разделов:

* Рабочие расписания: Эти расписания имеют возможность захватывать и распределять задачи Job. При выполнении операции "выключить" для определенного расписания, оно немедленно прекращает захватывать новые задачи Job; уже захваченные им задачи Job завершатся автоматически после выполнения, освобождая место для других расписаний. Выключенное расписание перемещается в список выключенных расписаний. Список рабочих расписаний предоставляет возможности для выключения и массового выключения расписаний;

• Выключенные расписания: Эти расписания все еще активны, но они больше не могут захватывать задачи Job или участвовать в распределении. При выполнении операции "включить" для таких расписаний, они переходят обратно в список рабочих расписаний и снова начинают иметь возможность захватывать и распределять задачи Job. Список выключенных расписаний предоставляет возможности для включения и массового включения расписаний;

• Отключенные расписания: Эти расписания больше не активны. Когда процесс выключенного расписания прекращает работу, оно автоматически перемещается в список отключенных расписаний. После того, как процесс отключенного расписания будет перезапущен, он автоматически переместится в список выключенных расписаний.Список отключенных расписаний также предоставляет возможности для удаления и массового удаления расписаний;

• Белый список IP адресов: Добавив определённый IP адрес в белый список, этот адрес получает права доступа ко всем экземплярам исполнителей. Белый список IP адресов предоставляет возможность массового удаления IP адресов, что приводит к автоматическому лишению этих адресов указанных прав доступа.## 3. Мониторинг расписания

Чтобы перейти в раздел мониторинга расписания, нажмите на Мониторинг расписания в левой панели. Откроется страница мониторинга расписания, как показано ниже:

• Пункт 1: представляет собой общее представление задач, которое включает количество задач в состоянии "готовность", "выполнение", "остановка" и "неудачная остановка". Также здесь представлены суммарные значения проектов, задач и задач Job.
• Пункт 2: введите название группы проектов для фильтрации по группам проектов;
• Пункт 3: общее представление мониторинга для определенной группы проектов, включающее количество активных задач Job, количество задач Job с неудачной остановкой, общее количество задач Job и детали списка задач Job.
• Пункт 4: Подробная информация о логах выполнения задачи, как показано ниже: Вы можете просмотреть подробную информацию о выполнении задачи с помощью деталей логов. Нажмите кнопку "Показать" в пункте 1, чтобы связаться с логами вызываемых задач, как показано ниже:

4. Управление задачами---

Нажмите на пункт Управление задачами в левой панели, чтобы открыть интерфейс управления задачами, как показано ниже: В интерфейсе управления задачами задачи группируются по проектам. Интерфейс предоставляет возможности конфигурирования, изменения и удаления задач. В этом интерфейсе задачи разделены на две части: одна часть использует компонент sia-task-hunter, который автоматически собирает задачи через стандартные аннотации; эти задачи нельзя изменять. Другая часть задач не использует компонент sia-task-hunter и добавляется пользователями вручную; эти задачи можно изменять и удалять.* Пункт 1: Просмотр списка проектов, к которым принадлежит задача. При нажатии на конкретный проект вы можете просмотреть список задач внутри этого проекта;

• Пункт 2: Добавление задачи;
• Пункт 3: Просмотр, изменение, проверка доступности и удаление задачи;
• Пункт 4: Список экземпляров исполнителей задачи;
• Пункт 5: Фильтрация по имени приложения (аналогично странице управления работами);
• Пункт 6: Фильтрация по имени задачи (аналогично странице управления работами);

4.1 Добавление задачиНажмите на пункт 2 "Добавить задачу", чтобы открыть интерфейс добавления задачи, как показано ниже:

• Проект: Обычные пользователи могут выбрать имя проекта из выпадающего списка. Администраторы могут ввести имя проекта вручную. Имя проекта может содержать только цифры, буквы, нижнее подчеркивание и дефис;
• Программа: Обычные пользователи могут выбрать имя программы из выпадающего списка. Администраторы могут ввести имя программы вручную. Имя программы может содержать только цифры, буквы, нижнее подчеркивание и дефис;
• HTTP_PATH: Должен начинаться со слеша /. Остальные символы могут быть английскими буквами, цифрами и нижним подчеркиванием. Путь не должен содержать обратного слеша \;
• Необходимость параметров: Этот флажок указывает, требуется ли параметризация для задачи;
• Описание: Обычно это описание бизнес-функциональности задачи;
• IP:PORT: Можно добавить несколько значений, повторения недопустимы. Каждое значение IP:PORT должно быть доступным (можно подключиться через TELNET). После каждого добавленного значения IP:PORT нажмите кнопку "Добавить". Если используется доменное имя, убедитесь, что оно доступно (можно PING).### 4.2 Просмотр

Нажмите "Просмотреть", чтобы узнать, используется ли эта задача какой-либо работой.

4.3 Изменение задачи

Нажмите "Изменить", чтобы открыть интерфейс изменения задачи, как показано ниже: Можно редактировать только следующие поля в задачах, добавленных вручную: Настройка параметров, Описание и IP:PORT.

4.4 Удаление задачи

Нажмите на кнопку Удалить, чтобы удалить задачу. Если задача используется в работе (job), то она не может быть удалена.

4.5 Соединяемость задачи

Нажмите на кнопку Соединяемость, чтобы перейти в интерфейс тестирования соединяемости, как показано ниже:

Соединяемость: Для задач, использующих компонент sia-task-hunter с автоматическим захватом через стандартные аннотации, sia-task-hunter добавляет контроль доступа. IP адреса, не входящие в этот список разрешений, не могут вызывать эту задачу. Чтобы проверить работоспособность задачи (только POST запросы) требуется выполнить тестирование в этом интерфейсе, поэтому его называют соединяемостью.

• Адрес тестирования: Кластер экземпляров исполнителей задачи, можно выбрать один из них для тестирования;
• Параметры тестирования: Входные параметры исполнителя задачи;
• Ответ: Ответ исполнителя задачи

Нажмите на кнопку Тестировать, просмотрите значение Ответ, чтобы протестировать соединяемость задачи ## Управление работами

Интерфейс управления работами предоставляет возможности для добавления, изменения, удаления и триггеров, связанных с работой.

5.1 Обзор страницы

Перейдите в интерфейс управления работами, нажав на левой панели Управление работами. Как показано на следующем рисунке:

• Определение 1: Название проекта: Представлены все проекты, к которым имеет доступ текущий пользователь (по умолчанию отображается проект, к которому принадлежит текущий пользователь). При выборе из выпадающего списка отображаются все проекты, к которым есть доступ, что позволяет фильтровать работы.
• Определение 2: Кнопка Добавить работу, которую можно использовать для создания новой работы.
• Определение 3: Информация о задаче, которая позволяет просматривать конфигурацию задач текущей работы; Просмотр состояния: при наведении курсора мыши отображается состояние выполнения текущей работы (состояние: остановлено / готовится / выполняется / прекращено внезапно).
• Определение 4: Действия, связанные с текущей работой; Конфигурирование задачи: Настройка задач для работы; Изменение работы: Изменение параметров работы; Действия состояния: Это кнопка с раскрывающимся списком действий, которые можно применять к текущей работе; Каскадное управление: Настройка отношений между различными работами.### 5.2 Создание новой работы Нажмите на кнопку Добавить работу, чтобы открыть следующее окно:

* Проект_группа: Выберите группу проекта, к которой относится работа. Обычно в списке представлены несколько групп проектов. По умолчанию выбирается случайная группа проекта, к которой имеет доступ текущий пользователь, но её можно изменить, выбрав нужную группу.

• Job_Key: Уникальный идентификатор задачи, начинающийся с префикса Job_Group; пользователи могут вводить свои собственные названия для идентификации этой задачи.
  • Тип задачи: Тип задачи; текущая версия поддерживает два типа.
    1. TRIGGER_TYPE_CRON (фиксированное время, последующий ввод CRON-выражения); ! user-handbook-cron
    2. TRIGGER_TYPE_FIXRATE: Представляет задачу, которая выполняется согласно установленному времени и может иметь общее количество выполнений и интервал между выполнениями. Если количество выполнений равно 0, это означает бесконечность. ! user-handbook-fixrate
  • Значение типа задачи: Введите подходящие значения параметров для различных типов задач.
• Предупреждающая электронная почта (префикс): При неудачной работе задачи или невозможности её расписания система автоматически отправляет письма для уведомления сторонних участников. Рекомендуется использовать электронную почту проектной группы или компании пользователя, но не рекомендуется использовать личные адреса электронной почты.Введите префикс предупреждающей электронной почты, используйте полные адреса при наличии нескольких адресов и разделите их запятой.
  • Description: Information about the task description; Правильно заполните вышеуказанную информацию, затем нажмите кнопку Add, чтобы подтвердить. Теперь выбранная задача будет отображаться.### 5.3 Изменение задачи Можно изменять тип задачи, значение типа, предупреждающую электронную почту, описание и т.д. Интерфейс такой же, как при создании новой задачи. Когда задача находится в состоянии выполнения, она не может быть изменена.

5.4 Настройка задачи

5.4.1 Добавление задачи

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

• Информация задачи: Левый список показывает информацию задачи, совместимую с правами доступа текущего пользователя; различные цвета используются для различения принадлежности к разным группам проектов. Вы можете выбрать нужные задачи путём перетаскивания, перетащив их в пустое пространство справа, что означает выбор данной задачи. Можно перетаскивать несколько задач. Верхнее текстовое поле предоставляет функцию фильтрации задач.

5.4.2 Удаление задачи

Нажмите кнопку удаления над значком задачи, чтобы удалить её.#### 5. 4. 3 Настройка зависимости задачи

• Конфигурация информации задачи: После того, как выбранные задачи были перетащены, вы можете настроить зависимость задачи путём соединения. Как показано ниже: Объяснение: (1) Начальная задача запускается при активации задачи. (2) Последующая задача запускается после завершения всех начальных задач. Если есть несколько начальных задач, то все они должны быть завершены перед запуском последующей задачи.

5. 4. 4 Настройка параметров выполнения задачи

• Настройка параметров выполнения задачи: после завершения конфигурации зависимостей для задачи Task, можно дополнительно настроить параметры выполнения каждой задачи. Нажмите кнопку "Редактировать" в красной рамке, чтобы открыть следующее окно:

• Тип параметра задачи: настройте источник параметров для задачи Task. Из-за того, что некоторые задачи используют тип параметров FROM_TASK, требуется указать, какая задача является источником этих параметров (должна быть одной из предыдущих задач).

• Значение параметра задачи: на основе типа параметра задачи настройте соответствующие параметры. (Если тип параметра выбран как FROM_UI, введите JSON-строку, которую может распарсить задача, максимальная длина — 255 символов). * Время ожидания выполнения (с): установите время ожидания выполнения задачи, измеряемое в секундах.

  • Стратегия выбора экземпляра задачи: поддерживаются две стратегии (1) Случайный выбор (случайный выбор экземпляра из списка доступных, то есть IP + порт); (2) Указание конкретного IP (указать конкретный экземпляр, затем выбрать его из списка доступных).
  • Стратегия при неудачном вызове задачи: поддерживаются четыре стратегии для настройки (1) Остановка (стратегия остановки, если вызов не удался, весь Job прекращается, дальнейшие задачи не выполняются); (2) Пропуск (стратегия пропуска, если вызов не удался, пропустить эту задачу и продолжить выполнение последующих задач); (3) Перенос (стратегия переноса, выбрать другой экземпляр этой задачи для выполнения, если это снова не удалится, использовать стратегию остановки); (4) Множественный перезапрос с переносом (стратегия множественного перезапроса с переносом, повторно запросить эту задачу несколько раз, если это снова не удалится, использовать стратегию переноса). После этого настройка информации задач Job будет завершена. Нажмите кнопку "Подтвердить", чтобы сохранить изменения. Для просмотра текущей зависимости между задачами нажмите кнопку "Информация задач" на странице управления Job.### 5. Каскадная конфигурация

• Каскадная конфигурация: конфигурация логической последовательности между различными заданиями (Job). Если существуют два задания (Task), имеющих логическую последовательность, а также необходимость учета временной зависимости между ними, используйте эту функцию для реализации. Оберните два независимых задания (Task) в два Job со своими уникальными временными параметрами. Затем настройте эти два Job в каскадном режиме.

Шестое. Расписание журнала

Нажмите на "Журнал расписаний" слева, чтобы перейти к странице журнала расписаний, как показано ниже: Лог-менеджмент предоставляет информацию о логах выполнения заданий (Jobs) с группировкой по проектным командам. Основные элементы одной записи лога включают:

• Статус выполнения: отображает результат выполнения задания;
• Время выполнения: время, когда планировщик запланировал выполнение задания;
• Время завершения выполнения: время окончания выполнения задания;
• Информация о планировщике: информация о конкретной реализации планировщика, которая выполнила задание;
• Информация о выполнении: детальная информация о выполнении задания.

Связь между логами выполнения заданий (Jobs) и связанных с ними заданий (Tasks) уже реализована. Логи по умолчанию хранятся семь дней.* Пункт 1: Нажмите выпадающий список, выберите имя группы, чтобы применить фильтрацию логов по группам;

• Пункт 2: Нажмите стрелку соединения, чтобы показать список логов выполнения задач для конкретной проектной команды;
• Пункт 3: Нажмите значок фильтрации, чтобы применить фильтрацию логов по ключу задачи (Job_Key);
• Пункт 4: Нажмите стрелку соединения, чтобы показать логи выполнения связанных задач (Tasks). Это обеспечивает связь между логами выполнения задач и связанных с ними задач, как показано ниже:

Ключевые элементы логов выполнения задач (Tasks) включают:

• Статус выполнения: отображает результат выполнения задачи;

• Время выполнения: время выполнения задачи;

• Информация о выполнении: информация о конкретной реализации исполнителя задачи и выходных данных;

• Завершение задачи (EndTask): Когда все связанные задачи успешно завершаются, автоматически выполняется система EndTask, что указывает на завершение выполнения задачи.