Очистка журналов запусков задач

Содержание раздела
  1. URL
  2. Заголовки запроса
    1. [ x-request-id ]
  3. Тело запроса
  4. Ограничения
  5. Примеры cURL-запросов
    1. Полная очистка одного журнала запусков
    2. Очистка журнала запусков с сохранением последних 10 записей
    3. Полная очистка всех журналов запусков
    4. Очистка всех журналов запусков с сохранением последних 5 записей

Доступны DELETE-методы для очистки журналов запусков задач планировщика:

Журналы запусков очищаются для активных и неактивных задач. Удаляются только записи о завершенных запусках; текущий запуск не затрагивается и будет добавлен в журнал после своего завершения.

Действия при очистке зависят от значения keepLog, как показано в таблице ниже.

Объект Частичная очистка
(keepLog > 0)
Полная очистка
(keepLog = 0, по умолчанию)
Записи журнала запусков Удаляются все, кроме последних keepLog записей Удаляются все записи
Нумерация запусков runNumber Сохраняется Сохраняется
Поля lastRun* выполняемой задачи (lastRunStatus = running) Сохраняются, так как запуск еще не завершен Сохраняются, так как запуск еще не завершен
Поля lastRun* задачи, не выполняемой сейчас Сохраняются Обнуляются (как если бы задача еще ни разу не выполнялась)

Аналогичный процесс запускается автоматически, если настроен в конфигурации с помощью параметров SCHEDULER_LOG_TRUNCATE_PERIOD_MS и SCHEDULER_LOG_MAX_SIZE.

Чтобы удалить задачу вместе с ее журналом запусков, используйте DELETE-метод /scheduler/jobs/{job}.

URL

  • {baseUrl}/api/v1/scheduler/jobs/{job}/log[?keepLog={number}] — очистка журнала запусков задачи {job};
  • {baseUrl}/api/v1/scheduler/log[?keepLog={number}] — очистка журналов запусков всех задач окружения.

Параметры:

  • baseUrl — адрес ноды Prostore, состоящий из IP-адреса или доменного имени и номера порта;
  • job — имя задачи, для которой очищается журнал запусков;
  • keepLog — количество последних записей, оставляемых в журнале запусков при очистке:
    • 0 (по умолчанию) — удаляются все записи;
    • <N> (где N > 0) — остаются записи о последних N завершенных запусках.

Заголовки запроса

[ x-request-id ]

Задает уникальный идентификатор HTTP-запроса. Если не указан, система генерирует UUID-значение и возвращает его в качестве идентификатора в ответе.

Тело запроса

Тело запроса отсутствует.

Ограничения

  • Удаляется информация только о завершенных запусках.
  • Нумерация запусков runNumber не обнуляется.

Примеры cURL-запросов

Полная очистка одного журнала запусков

curl -X 'DELETE' \
  'http://localhost:9090/api/v1/scheduler/jobs/matview_db_sync/log' \
  -H 'x-request-id: 0d7c3e91-6b48-4f52-a83d-1e94b0c527f6'

Очистка журнала запусков с сохранением последних 10 записей

curl -X 'DELETE' \
  'http://localhost:9090/api/v1/scheduler/jobs/matview_db_sync/log?keepLog=10' \
  -H 'x-request-id: 4e2f8a05-c1b7-4d63-902e-58a3d6f10b74'

Полная очистка всех журналов запусков

curl -X 'DELETE' \
  'http://localhost:9090/api/v1/scheduler/log' \
  -H 'x-request-id: 8a15cd72-b409-4e61-93fa-5d0c81e627b3'

Очистка всех журналов запусков с сохранением последних 5 записей

curl -X 'DELETE' \
  'http://localhost:9090/api/v1/scheduler/log?keepLog=5' \
  -H 'x-request-id: 27b6e0d4-3f19-4a85-bc72-e05914d8a3f6'